Open juliusl opened 2 months 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.
/language en
/sig docs
I think we should document this, but it belongs elsewhere. https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ is about the name
and uid
fields within object metadata only. This issue is about object status.
@sftim is the "qualified name" used elsewhere? Or is it specific to object status type naming? If the latter I agree but if the former, it might be beneficial to stick it in this section.
I cannot think of a better location for this concept.
I'd put the explanation in https://kubernetes.io/docs/reference/glossary/ and transclude (eg {{< glossary_definition prepend="Kubernetes also has a concept of a qualified name, which is" term_id="qualified-name" >}})
) it into the Object Names and IDs page.
I was having a really rough time trying to figure out where the rules were defined for the
type
property of aPodCondition
. I know underscores are allowed but I didn't find a rule in this part of the docs that mention that_
is allowed.Turns out this is the code that validates that property,
https://github.com/kubernetes/kubernetes/blob/abc056843c030ead11551e13171a4447701db24e/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L42
(via https://github.com/kubernetes/kubernetes/blob/abc056843c030ead11551e13171a4447701db24e/pkg/apis/core/validation/validation.go#L5390)
Which has a really nice explanation of what a qualified name is right above it,
It would be great if this information was included in this particular doc.