clarify a comment on annotation key validation #109892
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
release-note-none
|
/retest |
k8s-ci-robot
added
triage/accepted
roycaihw
reviewed
May 12, 2022
| @@ -44,6 +44,7 @@ var BannedOwners = map[schema.GroupVersionKind]struct{}{ | |||
| func ValidateAnnotations(annotations map[string]string, fldPath *field.Path) field.ErrorList { | |||
| allErrs := field.ErrorList{} | |||
| for k := range annotations { | |||
| // Uppercase is valid for annotation key but not QualifiedName, convert it as lowercase | |||
There was a problem hiding this comment.
nit: IIUC, in particular, uppercase is invalid in a QualifiedName's prefix:
a.b/Cis a valid QualifiedNameA.b/Cis not
The metadata.annotation doc says "the prefix must be a DNS subdomain" which is a little unclear. DNS is case insensitive and can be normalized. While a QualifiedName is expected to have a lowercase (normalized) RFC 1123 subdomain prefix, today we allow uppercase in metadata.annotation's prefix.
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/assign @lavalamp |
lavalamp
reviewed
May 18, 2022
staging/src/k8s.io/apimachinery/pkg/api/validation/objectmeta.go
Outdated
Show resolved
Hide resolved
k8s-ci-robot
removed
the
lgtm
Update staging/src/k8s.io/apimachinery/pkg/api/validation/objectmeta.go Co-authored-by: Daniel Smith <dbsmith@google.com>
jlsong01
force-pushed
the
add_annotation_comments
branch
from
876c614
to
d0353e3
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jlsong01, lavalamp, roycaihw 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 |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind cleanup
/sig api-machinery
What this PR does / why we need it:
Clarify a comment on annotation key validation.
Since uppercase is valid for annotation key but not QualifiedName, it's better to clarify it for avoid confusion and code readability.
Which issue(s) this PR fixes:
Fixes #109459
Special notes for your reviewer:
None
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: