Clarify what setting .spec.os.name does in the Pod OS section#56537
Conversation
The section recommended setting .spec.os.name and then said the value does not affect scheduling, which read as a contradiction: it was not clear what setting the field actually does. Say that the kubelet refuses to run a Pod whose .spec.os.name does not match the node, so the recommendation and the scheduling caveat no longer appear to conflict. The kubelet behaviour is already documented under the kubernetes.io/os label, which links here for details. Also align the opening sentence with the Windows user guide, which describes the field in terms of the containers rather than the node.
kubernetes-prow
Bot
added
the
do-not-merge/work-in-progress
|
|
kubernetes-prow
Bot
added
the
language/en
kubernetes-prow
Bot
added
the
cncf-cla: no
|
Welcome @harjothkhara! |
kubernetes-prow
Bot
added
the
size/S
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
kubernetes-prow
Bot
added
cncf-cla: yes
kubernetes-prow
Bot
removed
the
do-not-merge/work-in-progress
lmktfy
left a comment
lmktfy
left a comment
There was a problem hiding this comment.
Nice improvement. Thanks for following our policy on AI use disclosure.
/lgtm
/approve
kubernetes-prow
Bot
added
the
lgtm
|
LGTM label has been added. DetailsGit tree hash: 0beddb7461cc5b6ea642fd267de313cf6d1ca0f9 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lmktfy The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubernetes-prow
Bot
added
the
approved
2 participants
Description
The Pod OS section tells you to set
.spec.os.name, then says the value does notaffect how the scheduler picks a node — without saying what setting it does do.
Read together, those two statements look like a contradiction, which is what
#55112 reports.
This adds the missing half: the kubelet refuses to run a Pod if
.spec.os.namedoes not match the operating system of the node. The scheduling sentence then reads
as a caveat rather than a contradiction, and the recommendation to set the field
stays as it is.
That kubelet behaviour is already documented under the
kubernetes.io/oslabel, which links to this section for more detail — so this page was the one place
not stating it.
The opening sentence now describes the operating system that the containers require,
matching how
content/en/docs/concepts/windows/user-guide.mdalready describes thefield. Checked
windows/intro.mdas well; no change needed there. Built locally withHugo 0.144.2 and checked the rendered section.
#55454 proposes a different fix for the same issue and has been inactive since April.
Its review feedback was that the recommendation to set
.spec.os.nameshould be kept,so this change keeps it — happy to close this one if its author picks that back up.
This PR was assisted by AI but human reviewed along the way.
Issue
Closes: #55112