Skip to content

Commit 4794351

Browse files
ybettank8s-ci-robot
authored andcommitted
Adding documentation for the versioned ready label on the nodes.
Users need an official API to determine if their kmod was upgraded to the newer version successfully when using the ordered-upgrade flow. Before this commit, we only had a label describing if a specific kmod is ready to be used or not but the same label was used for all versions. To prevent users from watching the ready label being removed and then re-appearing for the new kmod, we decided to add a new label with the kmod version in it. Signed-off-by: Yoni Bettan <[email protected]>
1 parent 9343f17 commit 4794351

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/mkdocs/documentation/ordered_upgrade.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ Steps 3, 4 and 5 are then unified into one step: update the
5050
`kmm.node.kubernetes.io/version-module.<module-namespace>.<module-name>` label value to new `$moduleVersion` as set in
5151
the `Module`.
5252

53+
### Indicator that the new version is ready to be used
54+
55+
The operator will label the node with a "version.ready" label to indicate that the new version of the kernel module is loaded
56+
and ready to be used:
57+
`kmm.node.kubernetes.io/<module-namespace>.<module-name>.version.ready=<module-version>`
58+
5359
## Implementation details
5460

5561
### Components

0 commit comments

Comments
 (0)