feat: Add XValidations in the generated documentation #214
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
trynity
force-pushed
the
trynity-add-xvalidations
branch
2 times, most recently
from
1d196b0
to
a9773b8
Compare
|
@fybrik Please let me know if this is acceptable |
trynity
force-pushed
the
trynity-add-xvalidations
branch
from
a9773b8
to
d93a960
Compare
With Kubernetes 1.25, CEL will be added, as an alternative to enforcing validations, rather than webhooks. This allows, among other things, the ability to enforce immutability on fields. Since this is documented in the CRD YAML itself, bubbling this up into the documentation allows one to see custom validation rules An example kubebuilder comment in Go would be: ``` // +kubebuilder:validation:XValidation:rule="self == oldSelf", message="Value is immutable" ``` This would result in the following in the CRD: ``` x-kubernetes-validations: - message: Value is immutable rule: self == oldSelf ``` And now the generated documentation will reflect this: ``` <i>Validations</i>:<li>self == oldSelf: Value is immutable</li> ``` Signed-off-by: Trynity Mirell <trynity@mirell.org>
roytman
force-pushed
the
trynity-add-xvalidations
branch
from
d93a960
to
64ff660
Compare
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.
With Kubernetes 1.25, CEL will be added, as an alternative to enforcing validations, rather than webhooks. This allows, among other things, the ability to enforce immutability on fields.
Since this is documented in the CRD YAML itself, bubbling this up into the documentation allows one to see custom validation rules
An example kubebuilder comment in Go would be:
This would result in the following in the CRD:
And now the generated documentation will reflect this: