Skip to content
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

Updated node roles in docs #49360

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Aaina26
Copy link
Contributor

@Aaina26 Aaina26 commented Jan 8, 2025

Fixes: #48803

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language labels Jan 8, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign salaxander for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 8, 2025
Copy link

netlify bot commented Jan 8, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 3aefd43
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/677e7bb196ae66000868ba1b
😎 Deploy Preview https://deploy-preview-49360--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Let's make sure to document the node-role.kubernetes.io/* node label too.

@@ -140,6 +140,8 @@ When you want to create Node objects manually, set the kubelet flag `--register-
You can modify Node objects regardless of the setting of `--register-node`.
For example, you can set labels on an existing Node or mark it unschedulable.

You can set optional node role for nodes by adding `node-role.kubernetes.io/<role>=` label to the node where characters of `<role>` are limited by the [syntax](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) rules of labels.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this look right?

Suggested change
You can set optional node role for nodes by adding `node-role.kubernetes.io/<role>=` label to the node where characters of `<role>` are limited by the [syntax](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) rules of labels.
You can set optional node role(s) for nodes by adding one or more `node-role.kubernetes.io/<role>: <role>` labels to the node
where the characters of `<role>` are limited by the
[syntax](/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) rules for labels.
Kubernetes ignores the label value for node roles; by convention, you set it to the same string you used
for the node role in the label key.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We ought to add an entry for node-role.kubernetes.io/* (as well as the specific control plane role).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

node-role.kubernetes.io/* docs are wrong
3 participants