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.

Sign up for GitHub

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

Jump to bottom

✨ Add XValidation CRD marker for KEP-2876 support. #653

Merged
merged 1 commit into from
Feb 12, 2022
Merged

✨ Add XValidation CRD marker for KEP-2876 support. #653

merged 1 commit into from
Feb 12, 2022

Conversation

benluddy
Copy link
Contributor

This allows generation of the x-kubernetes-validations extension for
expression-based validation rules.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 28, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @benluddy!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @benluddy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 28, 2022
@benluddy benluddy force-pushed the xvalidations-crd-marker branch from 0c468a9 to 7e083a3 Compare January 31, 2022 14:51
@benluddy benluddy marked this pull request as ready for review January 31, 2022 14:52
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 31, 2022
@k8s-ci-robot k8s-ci-robot requested a review from mengqiy January 31, 2022 14:52
@joelanford
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 31, 2022
@joelanford
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jan 31, 2022
@benluddy
Add XValidations CRD marker for KEP-2876 support.
b0d2867 
This allows generation of the x-kubernetes-validations extension for
expression-based validation rules.
@benluddy benluddy force-pushed the xvalidations-crd-marker branch from 7e083a3 to b0d2867 Compare February 4, 2022 16:25
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Feb 4, 2022
@benluddy benluddy changed the title ✨ Add XValidations CRD marker for KEP-2876 support. ✨ Add XValidation CRD marker for KEP-2876 support. Feb 4, 2022
@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

@benluddy: PR needs rebase.

👍

alvaroaleman
alvaroaleman reviewed Feb 11, 2022
View reviewed changes
pkg/crd/testdata/cronjob_types.go

// Test of the expression-based validation rule marker, with optional message.
// +kubebuilder:validation:XValidation:rule="self.size() % 2 == 0",message="must have even length"
// +kubebuilder:validation:XValidation:rule="true"
Copy link
Member

Choose a reason for hiding this comment

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

Is there any way for us to check if the rule contains a valid expression?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It might be practical to check that the expression is at least syntactically valid at generation time, but that would mean taking a dependency on a CEL parser.

The validity of a given expression depends simultaneously on the structure of the CEL expression itself and on where it sits within the schema, so it's complex enough that I'd be wary of rejecting a CRD at generation time that the API would have accepted.

Maybe we can revisit this question once x-k8s-validations graduates to beta (~1.25)?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, by "valid expression" I meant syntastically valid, if it is also semantically valid is likely hard to tell and probably error prone. Deferring for now sgtm.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, benluddy

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 11, 2022
@alvaroaleman
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 12, 2022
@k8s-ci-robot k8s-ci-robot merged commit 99e7fbc into kubernetes-sigs:master Feb 12, 2022
soggiest added a commit to soggiest/controller-tools that referenced this pull request Jan 11, 2024
@soggiest
Updates:
0db3e8a 
* CRD Markers to include XValidation per this [Upstream PR](ihttps://github.com/kubernetes-sigs/pull/653)
* Updated k8s.io/apiextensions-apiserver to v0.29.0 to per XValidation dependencies.

Signed-off-by: soggiest <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@droot droot Awaiting requested review from droot

@pwittrock pwittrock Awaiting requested review from pwittrock

@mengqiy mengqiy Awaiting requested review from mengqiy

Assignees

@joelanford joelanford

@alvaroaleman alvaroaleman

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@benluddy @k8s-ci-robot @joelanford @alvaroaleman