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

node-role.kubernetes.io/* docs are wrong #48803

Open
sftim opened this issue Nov 22, 2024 · 7 comments
Open

node-role.kubernetes.io/* docs are wrong #48803

sftim opened this issue Nov 22, 2024 · 7 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/node Categorizes an issue or PR as relevant to SIG Node.

Comments

@sftim
Copy link
Contributor

sftim commented Nov 22, 2024

This is a Bug Report

Problem: Well-Known Labels, Annotations and Taints states that the only registered node role label is
node-role.kubernetes.io/control-plane.

Whilst that's true right now, we should have registered it as node-role.kubernetes.io/* where the * can be any node role.

Proposed Solution:
Update the docs:

  • mention that nodes have an optional node role, where the allowed characters are limited by the syntax rules for labels
  • update the list of well-known labels, annotations and taints

Pages to Update:

See kubernetes/kubernetes#127507

/sig architecture
/sig node
/priority backlog

@sftim sftim added the kind/bug Categorizes issue or PR as related to a bug. label Nov 22, 2024
@k8s-ci-robot k8s-ci-robot added sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/node Categorizes an issue or PR as relevant to SIG Node. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Nov 22, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Nov 22, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sftim
Copy link
Contributor Author

sftim commented Nov 22, 2024

Also relevant to aws/karpenter-provider-aws#1941 and the Karpenter-core equivalent issue (if there is one).

@sftim
Copy link
Contributor Author

sftim commented Nov 22, 2024

Just to make things a bit harder, there is also a taint node-role.kubernetes.io/control-plane. I don't know if that should also be node-role.kubernetes.io/*.

@utkarsh-singh1
Copy link
Contributor

Just to make things a bit harder, there is also a taint node-role.kubernetes.io/control-plane. I don't know if that should also be node-role.kubernetes.io/*.

I think that taint is for pods to make them not to schedule on control-plane.

@Aaina26
Copy link
Contributor

Aaina26 commented Nov 25, 2024

According to this comment kubernetes/kubernetes#127507 (comment), Node role node-role.kubernetes.io/master is no longer used by default by kubeadm. It is now replaced by node-role.kubernetes.io/control-plane. Maybe this section needs to be removed as well?

@sftim
Copy link
Contributor Author

sftim commented Nov 25, 2024

According to this comment kubernetes/kubernetes#127507 (comment), Node role node-role.kubernetes.io/master is no longer used by default by kubeadm. It is now replaced by node-role.kubernetes.io/control-plane. Maybe this section needs to be removed as well?

We need to redo the docs. We won't change them to not mention node-role.kubernetes.io/master at all; that would be unhelpful to readers.

@Aaina26
Copy link
Contributor

Aaina26 commented Nov 25, 2024

Okay. Got it! Just to confirm:

  1. We will add that the nodes have an optional node role to this page: https://kubernetes.io/docs/concepts/architecture/nodes/
  2. And for this page: https://kubernetes.io/docs/reference/labels-annotations-taints/ ,I suggest that we only change the examples to reflect node-role.kubernetes.io/*. The title can help readers identify that the Taint is for control-plane or master.

If this sounds good, I would like to work on this. Any additional suggestions are most welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/node Categorizes an issue or PR as relevant to SIG Node.
Projects
Status: Triage
Development

No branches or pull requests

4 participants