Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing doc on name of object of kind defined by CRD #46262

Closed
MikeSpreitzer opened this issue May 8, 2024 · 2 comments · Fixed by #46263
Closed

Confusing doc on name of object of kind defined by CRD #46262

MikeSpreitzer opened this issue May 8, 2024 · 2 comments · Fixed by #46263
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.

Comments

@MikeSpreitzer
Copy link
Member

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 says

The name of a CRD object must be a valid DNS subdomain name.

Since 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

@MikeSpreitzer MikeSpreitzer added the kind/bug Categorizes issue or PR as related to a bug. label May 8, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 8, 2024
@pranav-pandey0804
Copy link
Contributor

/sig docs
/language en

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. language/en Issues or PRs related to English language labels May 8, 2024
@sftim
Copy link
Contributor

sftim commented May 8, 2024

/triage accepted
/wg api-expression

Since a CRD is itself an object, I thought this was clearly talking about the name of the CRD itself

Yes, that's right. Both I and @tengqm confirm this; I'm an emeritus tech lead for SIG Docs, and @tengqm is a current tech lead.

(I temporarily forgot that I know that the name of the CRD itself is constrained to be ${resouce}.${apiGroup}).

(sic)

Would be good to add that detail to the page.

@k8s-ci-robot k8s-ci-robot added 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. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants