compliantkubernetes-apps icon indicating copy to clipboard operation
compliantkubernetes-apps copied to clipboard

docs: Update migration handling for next version

Open aarnq opened this issue 1 year ago • 2 comments

[!warning] This is a public repository, ensure not to disclose:

  • [x] personal data beyond what is necessary for interacting with this pull request, nor
  • [x] business confidential information, such as customer names.

What kind of PR is this?

Required: Mark one of the following that is applicable:

  • [ ] kind/feature
  • [x] kind/improvement
  • [ ] kind/deprecation
  • [ ] kind/documentation
  • [ ] kind/clean-up
  • [ ] kind/bug
  • [ ] kind/other

Optional: Mark one or more of the following that are applicable:

[!important] Breaking changes should be marked kind/admin-change or kind/dev-change depending on type Critical security fixes should be marked with kind/security

  • [ ] kind/admin-change
  • [ ] kind/dev-change
  • [ ] kind/security
  • [ ] kind/adr

What does this PR do / why do we need this PR?

This implements the idea of change for migrations that was proposed before to combat the divergence around releases, and to simplify contribution. The idea is that the migration/main is the one under development, and during release it is promoted to the release series, example migration/v0.44.

Hopefully this change in process will also be helpful to realise https://github.com/elastisys/compliantkubernetes-apps/issues/2287, with reusable snippets naturally as we go.

~~This is in a POC phase, as I've implemented the change in migration structure, but yet to implement the handling in the bin scripts, as I want it to be finalised first. The process documents supporting migration contribution and release will also need more updates once completed.~~

Is implemented.

Information to reviewers

./migration/promote.sh v0.44 It is also re-runnable.

Checklist

  • [x] Proper commit message prefix on all commits
  • Change checks:
    • [ ] The change is transparent
    • [ ] The change is disruptive
    • [ ] The change requires no migration steps
    • [ ] The change requires migration steps
    • [ ] The change upgrades CRDs
    • [ ] The change updates the config and the schema
  • Documentation checks:
  • Metrics checks:
    • [ ] The metrics are still exposed and present in Grafana after the change
    • [ ] The metrics names didn't change (Grafana dashboards and Prometheus alerts are not affected)
    • [ ] The metrics names did change (Grafana dashboards and Prometheus alerts were fixed)
  • Logs checks:
    • [ ] The logs do not show any errors after the change
  • Pod Security Policy checks:
    • [ ] Any changed pod is covered by Pod Security Admission
    • [ ] Any changed pod is covered by Gatekeeper Pod Security Policies
    • [ ] The change does not cause any pods to be blocked by Pod Security Admission or Policies
  • Network Policy checks:
    • [ ] Any changed pod is covered by Network Policies
    • [ ] The change does not cause any dropped packets in the NetworkPolicy Dashboard
  • Audit checks:
    • [ ] The change does not cause any unnecessary Kubernetes audit events
    • [ ] The change requires changes to Kubernetes audit policy
  • Falco checks:
    • [ ] The change does not cause any alerts to be generated by Falco
  • Bug checks:
    • [ ] The bug fix is covered by regression tests

aarnq avatar Dec 18 '24 07:12 aarnq

Note to self: Update public docs maintenance page.

aarnq avatar Dec 18 '24 12:12 aarnq

This is fully ready now.

aarnq avatar Jan 07 '25 15:01 aarnq

Are you expecting to do more work on this, or this can be merged? @aarnq

lucianvlad avatar Sep 12 '25 14:09 lucianvlad

Are you expecting to do more work on this, or this can be merged? @aarnq

I'll see if I can merge it after the next release so we can start with a clean migration for it.

aarnq avatar Sep 15 '25 06:09 aarnq

Are you expecting to do more work on this, or this can be merged? @aarnq

I'll see if I can merge it after the next release so we can start with a clean migration for it.

Nice work! Release for apps v0.49.0 was completed this week and is now available here Feel free to fix the conflicts and merge this when you have the time for it .

lucianvlad avatar Oct 13 '25 12:10 lucianvlad