-
Notifications
You must be signed in to change notification settings - Fork 14.7k
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
Resource name constraints (1) #19106
Conversation
Deploy preview for kubernetes-io-master-staging ready! Built with commit e7d6a34 https://deploy-preview-19106--kubernetes-io-master-staging.netlify.com |
content/en/docs/concepts/overview/working-with-objects/names.md
Outdated
Show resolved
Hide resolved
9032a91
to
82d6723
Compare
82d6723
to
1a1ea46
Compare
1a1ea46
to
2e89c05
Compare
@tengqm , I am reading through the updates. I just noticed that the title |
@@ -42,6 +69,7 @@ spec: | |||
- containerPort: 80 | |||
``` | |||
|
|||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another nit:
Is the Pod manifest a good example of naming conventions or could you provide some different examples of
Kubernetes resource names.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pod is the basic building block in Kubernetes, so I think keeping it here makes sense.
We can certainly provide more examples here or somewhere else but I don't see it necessary.
In follow-up PRs, there are references to these resource name constraints.
Em... that is not ideal. Changing either one may break the links or bookmarks people have. For example, if we change either one, the existing references to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tengqm - how about referring to https://tools.ietf.org/html/rfc2181#section-11 for the definition of DNS labels and names?
I think it's OK to risk breaking https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names as it's the first content heading. If it's important to preserve it, it's feasible to add an element to the page at pretty much the right place (eg just before the renamed heading), and set its |
We could rename the page to “Object Names and UIDs", then add a redirect to its new URL. |
4d6796c
to
bb0acc9
Compare
### DNS Label Names | ||
|
||
There are some resource names are required to conform to the DNS | ||
label standard as defined in [RFC 1123](https://tools.ietf.org/html/rfc1123). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tengqm , changes look good. One nit, reword line 42. What do you think about these changes:
Some resources require their names to conform to the DNS label standard ...
Some resource types require their names to follow the DNS label standard ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
bb0acc9
to
e7d6a34
Compare
/lgtm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, too!
/approve
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sftim The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
xref: #17969, #19099, #18746