kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.59k stars 14.48k forks source link

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

Open sftim opened 6 days ago

sftim commented 6 days ago

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:

Pages to Update:

See https://github.com/kubernetes/kubernetes/issues/127507

/sig architecture /sig node /priority backlog

k8s-ci-robot commented 6 days ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
sftim commented 6 days ago

Also relevant to https://github.com/aws/karpenter-provider-aws/issues/1941 and the Karpenter-core equivalent issue (if there is one).

sftim commented 6 days ago

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 commented 4 days ago

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 commented 4 days ago

According to this comment https://github.com/kubernetes/kubernetes/issues/127507#issuecomment-2367039650, 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 commented 4 days ago

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 commented 4 days ago

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.