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

Clarify remark about object names wrt CRD #46263

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MikeSpreitzer
Copy link
Member

This PR clarifies the remark about the restrictions on the name of an object whose kind/resource is defined by a CRD.

Fixes #46262

Signed-off-by: Mike Spreitzer <mspreitz@us.ibm.com>
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign reylejano for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label May 8, 2024
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 8, 2024
@MikeSpreitzer
Copy link
Member Author

/cc @liggitt
/cc @sftim
@sttts

@k8s-ci-robot k8s-ci-robot requested review from liggitt and sftim May 8, 2024 04:28
Copy link

netlify bot commented May 8, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit b28ffc2
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/663aff420b673b00087de8e3
😎 Deploy Preview https://deploy-preview-46263--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -161,7 +161,7 @@ The [CustomResourceDefinition](/docs/tasks/extend-kubernetes/custom-resources/cu
API resource allows you to define custom resources.
Defining a CRD object creates a new custom resource with a name and schema that you specify.
The Kubernetes API serves and handles the storage of your custom resource.
The name of a CRD object must be a valid
The name of an object whose kind/resource is defined by a CRD must be a valid
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds to me that this paragraph focuses more on the CRD rather than the CRs created from the CRDs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I recommend:

  • revert this line
  • add some more text at the end of the paragraph that talks about restrictions on names of CRs, with a bit of a more verbose explanation about the difference between a CRD and the CRs you can create once a CRD is defined.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing doc on name of object of kind defined by CRD
4 participants