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

Update documents to cover CEL validation on CRDs #1212

Merged
merged 3 commits into from
Nov 8, 2023

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Oct 31, 2023

Proposed changes

Update resource validation docs to cover CEL validation.

Problem: Gateway API 0.8.0 introduced CEL based-validation and the shift away from webhook validation.

Solution: Updated the resource validation docs to cover CEL validation for supported Kubernetes versions and kept webhook validation for older versions.

Please focus on (optional): @sjberman and I discussed if we should leave in areas where we mention rerunning the validation webhook on the NGF side as that would not be needed for newer versions of Kubernetes and Saylor advised me to take it out of the documents but wanted to hear what the rest of the team thought. For Kubernetes versions 1.23 and 1.24 where using the validation webhook is still advised, should we still mention in our docs that we rerun the webhook on our end?

Closes #971

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@bjee19 bjee19 requested a review from a team as a code owner October 31, 2023 22:14
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 31, 2023
design/resource-validation.md Outdated Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
docs/resource-validation.md Show resolved Hide resolved
design/resource-validation.md Outdated Show resolved Hide resolved
Copy link

netlify bot commented Nov 7, 2023

Deploy Preview for nginx-gateway-fabric failed.

Name Link
🔨 Latest commit 8331d10706c21e756c3840348cffdfdec8e15b8a
🔍 Latest deploy log https://app.netlify.com/sites/nginx-gateway-fabric/deploys/654ab33aa2bc5c0008f6a6c9

Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

🚀

@bjee19 bjee19 merged commit 0deece6 into nginxinc:main Nov 8, 2023
23 checks passed
@bjee19 bjee19 deleted the docs/cel-validation branch November 20, 2023 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update resource validation docs to cover CEL
5 participants