Add kubebuilder tags to Condition type #92660

damemi · 2020-06-30T18:58:57Z

What type of PR is this?
/kind api-change

What this PR does / why we need it:
This picks the changes from #92519 and adds kubebuilder validation tags for CRD generation

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Kubebuilder validation tags are set on metav1.Condition for CRD generation

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

related to kubernetes/enhancements#1623

damemi · 2020-06-30T18:59:05Z

/hold

deads2k · 2020-06-30T19:01:16Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

@@ -1367,28 +1368,39 @@ type Condition struct {
 	// Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
 	// useful (see .node.status.conditions), the ability to deconflict is important.
 	// +required
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Enum=Available;Progressing;Degraded


this is a regex in the validation code.

Yeah, I based this on the comment above the type. The validation code looks like it uses different regexes conditionally which I think is more complex than the regex marker can do alone

using an enum here is not correct... far more types than Available, Progressing, Degraded are supported

The regex validation seems to be conditional based on whether the type is qualified or not. I think that can be expressed like this:

(DNS1123_PATTERN/)?(QUALIFIED_NAME_PATTERN)

@liggitt Ah, I'm not great with complex regexes so I wasn't aware if it could handle conditionals

Since dns1123 pattern is dns1123LabelFmt + "(\\." + dns1123LabelFmt + ")*" and qualified name fmt is "(" + qnameCharFmt + qnameExtCharFmt + "*)?" + qnameCharFmt, I tried substituting these into (DNS1123_PATTERN/)?(QUALIFIED_NAME_PATTERN) (evaluated out). This ended up being pretty complex from what I can see, not sure if there's a good way to simplify it

fedebongio · 2020-06-30T20:16:13Z

/assign @liggitt @DirectXMan12

liggitt · 2020-07-01T15:32:33Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

 	Type string `json:"type" protobuf:"bytes,1,opt,name=type"`
 	// status of the condition, one of True, False, Unknown.
 	// +required
+	// +kubebuilder:validation:Required
 	Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"`


this is an appropriate place for an enum (True, False, Unknown)

liggitt · 2020-07-01T15:33:19Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

 	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"`
 	// lastTransitionTime is the last time the condition transitioned from one status to another.
 	// This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
 	// +required
+	// +kubebuilder:validation:Required


is there a time format or RFC3339 regex we can use here?

it looks like we can use type: string and format: date-time

sttts · 2020-07-02T14:59:03Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

+	// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+	// +required
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Pattern=^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])


this matches asdfasfas.sadf.asdfas/bla$'_%.

This is what I got manually expanding the regexes currently used by the validation function (#92660 (comment)) Did I miss something or write that out wrong?

deads2k · 2020-07-02T15:01:16Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MaxLength=1024
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:Pattern=`^[A-Za-z_][A-Za-z0-9_]*$`


this got expanded [A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

damemi · 2020-07-07T15:55:59Z

@deads2k @sttts think I addressed the comments here. There was some offline talk about trying to come up with a regex to match specifically non-zero rfc3339, is that still something we need or is a date-time format validation sufficient? (#92660 (comment))

damemi · 2020-07-07T18:34:39Z

/retest

deads2k · 2020-07-07T19:30:13Z

Can you rebase this on master please? You've got an old version of the validation PR

damemi · 2020-07-07T19:34:10Z

Can you rebase this on master please? You've got an old version of the validation PR

Ah I did rebase it on master, I needed to rebase it on your branch from the validation PR. Updated and squashed

deads2k · 2020-07-08T13:31:28Z

also make update. your generated code is out of date

damemi · 2020-07-08T14:22:04Z

@deads2k updated my commit and rebased on yours again

deads2k · 2020-07-08T14:33:13Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

 	Reason string `json:"reason" protobuf:"bytes,5,opt,name=reason"`
 	// message is a human readable message indicating details about the transition.
 	// This may be an empty string.
 	// +required
+	// +kubebuilder:validation:Required


we allow the message to be empty. See two lines up. The required bit is about serialization back to clients.

This looks correct to me. The value can be an empty string, but the field must be specified or openapi validation will complain ("message":"")

This looks correct to me. The value can be an empty string, but the field must be specified or openapi validation will complain ("message":"")

Found it in my live test. The CR validation doesn't give slice numbers, so I was looking at the wrong item.

deads2k · 2020-07-08T14:53:51Z

/lgtm

deads2k · 2020-07-08T16:11:32Z

/retest

smarterclayton · 2020-07-08T17:31:10Z

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto

+  // +kubebuilder:validation:Required
+  // +kubebuilder:validation:MaxLength=1024
+  // +kubebuilder:validation:MinLength=1
+  // +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`


Allowing commas. Not a fan....

Same for colon. Hrm... gonna have to think about this.

Allowing commas. Not a fan....

Matches the reality of the world I'm afraid. We have people interested in adopting now that have union reasons with delimiters

I guess since we said "machine readable" this is the world we live in.

k8s-ci-robot · 2020-07-08T18:07:45Z

@damemi: The following test failed, say /retest to rerun all failed tests:

Test name	Commit	Details	Rerun command
pull-kubernetes-e2e-kind-ipv6	95570fa684dd49b2c5787b93e7bd8f894b76b3d0	link	`/test pull-kubernetes-e2e-kind-ipv6`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

smarterclayton · 2020-07-08T18:29:34Z

/approve

k8s-ci-robot · 2020-07-08T18:30:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: damemi, smarterclayton

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:

~~staging/src/k8s.io/apimachinery/pkg/apis/OWNERS~~ [smarterclayton]

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

deads2k · 2020-07-08T19:21:20Z

/retest

deads2k · 2020-07-09T12:13:36Z

validation is finalized, removing hold.

fejta-bot · 2020-07-09T12:37:04Z

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

damemi · 2020-07-09T14:09:06Z

/label api-review

deads2k reviewed Jun 30, 2020

View reviewed changes

k8s-ci-robot requested review from logicalhan and thockin June 30, 2020 19:01

k8s-ci-robot assigned DirectXMan12 and liggitt Jun 30, 2020

liggitt reviewed Jul 1, 2020

View reviewed changes

sttts reviewed Jul 2, 2020

View reviewed changes

deads2k reviewed Jul 2, 2020

View reviewed changes

sttts reviewed Jul 2, 2020

View reviewed changes

staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go Outdated Show resolved Hide resolved

damemi force-pushed the condition-validation branch from 95570fa to 5588684 Compare July 7, 2020 17:11

damemi force-pushed the condition-validation branch from 5588684 to c70d777 Compare July 7, 2020 19:33

AndiLi99 mentioned this pull request Jul 7, 2020

[Flaky test] pull-kubernetes-conformance-kind-ipv6-parallel #92886

Closed

kikisdeliveryservice mentioned this pull request Jul 7, 2020

provide recommended .status.conditions schema kubernetes/enhancements#1623

Closed

damemi mentioned this pull request Jul 8, 2020

[wip] Use upstream Condition type (and validation) openshift/api#682

Closed

deads2k and others added 2 commits July 8, 2020 10:12

add validation for metav1 conditions

bd76293

Add kubebuilder validation tags to Condition type

9a32a70

damemi force-pushed the condition-validation branch from c70d777 to 9a32a70 Compare July 8, 2020 14:21

deads2k reviewed Jul 8, 2020

View reviewed changes

k8s-ci-robot assigned deads2k Jul 8, 2020

deads2k added this to the v1.19 milestone Jul 8, 2020

smarterclayton reviewed Jul 8, 2020

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2020

deads2k removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 9, 2020

deads2k added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Jul 9, 2020

k8s-ci-robot removed the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Jul 9, 2020

k8s-ci-robot added the api-review Categorizes an issue or PR as actively needing an API review. label Jul 9, 2020

k8s-ci-robot merged commit cada2eb into kubernetes:master Jul 9, 2020

github-actions bot mentioned this pull request Jul 14, 2020

Week Ending July 12, 2020 dev-obs/actus#193

Open

liggitt mentioned this pull request Aug 12, 2020

Set default value for protocol field of container port #91419

Closed

Add kubebuilder tags to Condition type #92660

Add kubebuilder tags to Condition type #92660

Conversation

damemi commented Jun 30, 2020 • edited Loading

damemi commented Jun 30, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedebongio commented Jun 30, 2020

Choose a reason for hiding this comment

liggitt Jul 1, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damemi commented Jul 7, 2020

damemi commented Jul 7, 2020

deads2k commented Jul 7, 2020

damemi commented Jul 7, 2020

deads2k commented Jul 8, 2020

damemi commented Jul 8, 2020

Choose a reason for hiding this comment

liggitt Jul 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deads2k commented Jul 8, 2020

deads2k commented Jul 8, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 8, 2020 • edited Loading

smarterclayton commented Jul 8, 2020

k8s-ci-robot commented Jul 8, 2020

deads2k commented Jul 8, 2020

deads2k commented Jul 9, 2020

fejta-bot commented Jul 9, 2020

damemi commented Jul 9, 2020

damemi commented Jun 30, 2020 •

edited

Loading

liggitt Jul 1, 2020 •

edited

Loading

liggitt Jul 8, 2020 •

edited

Loading

k8s-ci-robot commented Jul 8, 2020 •

edited

Loading