-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update migration handling for next version #2373
base: main
Are you sure you want to change the base?
Conversation
Note to self: Update public docs maintenance page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, really good that this is getting finally getting addressed as I know that the old system could be problematic if migrations steps did not end up in the proper release folder before a release was in progress. Left some comments, but overall I think it looks really good, have not tested the scripts yet however
- are run with the argument `execute` on upgrade and should return 1 on failure and 2 on successful internal rollback, | ||
- are rerun with the argument `rollback` on execute failure and should return 1 on failure. | ||
|
||
For prepare the init step is given. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe expand this part a bit.
For prepare the init step is given. | |
For the prepare part, a init step is always included in each migration which runs the `ck8s init` command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure how to rewrite it, because the hope is that we will have more and more persistent migration snippets, so it wont just be init and apply.
I want to remove it, or maybe just state that one should look for the current ones, and give init and apply as examples as a prepare and apply snippet respectively.
🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe have a link to the respective folders and then provide the init and apply snippets as examples, but I would not say this is blocking in any way
35b5692
to
60f907f
Compare
Warning
This is a public repository, ensure not to disclose:
What kind of PR is this?
Required: Mark one of the following that is applicable:
Optional: Mark one or more of the following that are applicable:
Important
Breaking changes should be marked
kind/admin-change
orkind/dev-change
depending on typeCritical security fixes should be marked with
kind/security
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, examplemigration/v0.44
.Hopefully this change in process will also be helpful to realise #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.
Information to reviewers
./migration/promote.sh v0.44
It is also re-runnable.
Checklist
NetworkPolicy Dashboard