docs: Update l2-announcements policy example to be more realistic #27039
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the example policy for l2-announcements, the example was using a label selector that said: `role: worker`. While it is possible to add such a label, most people will not do that and want to rely on the existing `node-role.kubernetes.io/<role>` labels added by kubeadm and similar tools. If an inexperienced user copies and pastes our example without modifying the node label selector, it will likely not work. This commit updates the example to be more realistic. Signed-off-by: Dylan Reimerink <dylan.reimerink@isovalent.com>
dylandreimerink
added
area/documentation
|
/test |
|
Tests are not skipped or triggered for doc only change 😢, so I can't merge myself. Marking as ready-to-merge |
dylandreimerink
added
the
ready-to-merge
4 tasks
nbusseneau
added
backport-pending/1.14
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.14
in 1.14.0
joestringer
added
backport-done/1.14
maintainer-s-little-helper
bot
moved this from Backport pending to v1.14
to Backport done to v1.14
in 1.14.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the example policy for l2-announcements, the example was using a label selector that said:
role: worker. While it is possible to add such a label, most people will not do that and want to rely on the existingnode-role.kubernetes.io/<role>labels added by kubeadm and similar tools.If an inexperienced user copies and pastes our example without modifying the node label selector, it will likely not work. This commit updates the example to be more realistic.
Fixes: #26996