kubernetes / website

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

Unclear details around Nodes and `NetworkUnavailable: false` #42917

Open jayunit100 opened 1 year ago

jayunit100 commented 1 year ago

It appears https://kubernetes.io/docs/concepts/architecture/nodes/#condition (sorry i meant https://kubernetes.io/docs/reference/node/node-status/#condition)

is missing any mention of how the NetworkUnavailable condition = false should be interpretted.

IF this is an "official" API that we rely on then i think its ok to rely on it in the e2e tests. but if its not an officially supported standard, i think the e2e tests shouldnt force this field to be set to "False" in order to run.

i.e.

networkReady := isConditionUnset(&node, v1.NodeNetworkUnavailable) || IsConditionSetAsExpected(&node, v1.NodeNetworkUnavailable, false)

is relying on the definition of NodeNetworkUnavialable:false to mean something like "This node should not be thought of as , in any way , testable / usable for running pods".

However, this condition is just a vanity metric. You can easily have a node that does run pods, which simply doesnt have this attached metadata, and as a metric, its managed by third party libraries / cnis /etc... so K8s itself i dont think should really rely on it... unless we document it as w/ a strict definition.

Feel free to close if im just missing the docs and theres a better place to look this up . I do see its in the v1.Types ... but i think at the very least, we need it documented on https://kubernetes.io/docs/concepts/architecture/nodes/#condition if were going to keep relying on it.

sftim commented 1 year ago

I think the page to fix is https://kubernetes.io/docs/reference/node/node-status/#condition

All https://k8s.io/docs/concepts/architecture/nodes/#node-status needs to do is clearly signpost people to the reference page.

sftim commented 1 year ago

/sig node network

sftim commented 1 year ago

/language en

jayunit100 commented 1 year ago

yeah agree that page would be a good place to do it, but ...

we also need to disambiguate

jayunit100 commented 1 year ago

xref https://github.com/kubernetes/kubernetes/issues/120486 bc its a broader issue of disambiguation, talked w @aojea

sftim commented 12 months ago

/retitle Unclear details around Nodes and NetworkUnavailable: false

sftim commented 9 months ago

/triage accepted

letmerecall commented 8 months ago

/assign