Confusing doc on name of object of kind defined by CRD #46262
Labels
kind/bug
Categorizes issue or PR as related to a bug.
language/en
Issues or PRs related to English language
sig/docs
Categorizes an issue or PR as relevant to SIG Docs.
triage/accepted
Indicates an issue or PR is ready to be actively worked on.
wg/api-expression
Categorizes an issue or PR as relevant to WG API Expression.
This is a Bug Report
Problem:
I wondered what are the restrictions (if any) that Kubernetes imposes on the names of objects of a kind that gets defined by a CustomResourceDefinition. I am not talking about the name of the CRD itself. I tried to find this in the documentation, and couldn't. I asked on the
sig-api-machinery
channel on the Kubernetes Slack, and was referred to https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions . The text there saysSince a CRD is itself an object, I thought this was clearly talking about the name of the CRD itself (I temporarily forgot that I know that the name of the CRD itself is constrained to be
${resouce}.${apiGroup}
). But I was assured that this text is trying to talk about the objects whose kind is defined by the CRD.Proposed Solution:
Update the cited doc to be clearer.
Page to Update:
https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources
The text was updated successfully, but these errors were encountered: