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.

Sign up for GitHub

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

Jump to bottom

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

Open
sftim opened this issue Nov 22, 2024 · 8 comments · May be fixed by #49360
Open

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

sftim opened this issue Nov 22, 2024 · 8 comments · May be fixed by #49360
Assignees
@Aaina26
Labels
kind/bug Categorizes issue or PR as related to a bug. 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. triage/accepted Indicates an issue or PR is ready to be actively worked on.

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
@sftim
Copy link
Contributor Author

sftim commented Nov 22, 2024 •
edited
Loading

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

@sftim sftim mentioned this issue Nov 22, 2024
Open
@sftim
Copy link
Contributor Author

sftim commented Nov 22, 2024 •
edited
Loading

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 •
edited
Loading

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.

@sftim sftim mentioned this issue Dec 15, 2024
Open
@kannon92
Copy link
Contributor

@Aaina26 I think that sounds good. Please open up a PR for review.

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 20, 2024
@kannon92 kannon92 moved this from Triage to Triaged in SIG Node Bugs Dec 20, 2024
@Aaina26
Copy link
Contributor

Aaina26 commented Dec 23, 2024

Thank you @kannon92 for confirming. I'll raise a PR for this.
/assign

@Aaina26 Aaina26 linked a pull request Jan 8, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Aaina26 Aaina26

Labels
kind/bug Categorizes issue or PR as related to a bug. 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. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Node Bugs
Status: Triaged
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updated node roles in docs Aaina26/website
5 participants
@kannon92 @k8s-ci-robot @sftim @Aaina26 @utkarsh-singh1