k8s: clarify CRD schema versioning and its update process#12493
k8s: clarify CRD schema versioning and its update process#12493
Conversation
Add steps on and when the CRD validation version should be updated. Signed-off-by: André Martins <andre@cilium.io>
8f2c7ec to
e035d4c
Compare
joestringer
left a comment
There was a problem hiding this comment.
Thanks for clarifying these steps.
I'd like to minimize the extra steps during the release process if possible, couple of comments below towards that aim.
| | 1.6.0-rc1 | 1.14 | | ||
| +-----------------+----------------+ | ||
| | 1.6.0-rc2 | 1.14 | | ||
| +-----------------+----------------+ | ||
| | 1.6.0-rc3 | 1.14 | |
There was a problem hiding this comment.
It'd be nice if we can come up with a workflow that doesn't require us to update this doc as well whenever we create a new release. Could we group these by version instead, perhaps with a link to the relevant variable in the code to pkg.go.dev in case we forget to update?
But we shouldn't forget to update if we put clear instructions above the schema version definition to outline the expected steps, including "if you change the schema version, update this ____ docs page".
There was a problem hiding this comment.
From out-of-band discussion and the item below, it makes sense to increment the version for each release to provide a number space for potential bugfix bumps to the schema, like the one that provoked this PR.
We discussed that this table can be auto-generated to a separate file then imported directly into this page. This will resolve my concern around adding manual steps to the release process by automating it.
As per the discussions from #12493, we should not increment the v1.6 schema version to 1.16 as this would conflict with early v1.7 cycle versions. Fix it to 1.15.1 instead. The 1.16 version was never part of a released v1.6.x version of Cilium. Fixes: bd5bc5b ("Fix small CRD issue with toGroups") Signed-off-by: Joe Stringer <joe@cilium.io>
|
@aanm by the way, this will definitely not backport cleanly to 1.6 as not all of those release maintenance docs exist on the older branches. Also, I don't think we'll want to backport the schema changes will we? |
joestringer
left a comment
There was a problem hiding this comment.
We should address #12493 (comment) first.
As per the discussions from #12493, we should not increment the v1.6 schema version to 1.16 as this would conflict with early v1.7 cycle versions. Fix it to 1.15.1 instead. The 1.16 version was never part of a released v1.6.x version of Cilium. Fixes: bd5bc5b ("Fix small CRD issue with toGroups") Signed-off-by: Joe Stringer <joe@cilium.io>
|
1.7 backported in #12622 |
|
retest-net-next |
|
retest-4.9 |
|
retest-4.19 |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
This issue has not seen any activity since it was marked stale. Closing. |
Add steps how and when the CRD validation version should be updated.
Signed-off-by: André Martins andre@cilium.io