Mark the Version field required and adapt CRD generation for trivialVersions #2480
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
Currently if the Version field is not set, we reject the resource in the validation webhook. If the webhook is disabled, the operator returns an error early in the reconciliation. This could be considered a breaking API change, but the Version field was already required implicitly, just not caught by the OpenAPI validation.
A bug in controller-tools prevent validation to appear in the generated CRDs if trivialVersions is set and multiple versions do not share the exact same schema. See kubernetes-sigs/controller-tools#349. This commit removes the usage of `crd:trivialVersions=true`, to "manually" (through Kustomize) apply the CRD modifications so we end up with the trivialVersion scheme. That is: a single `validation` field matching the OpenAPISchema of the currently stored version (v1).
sebgl
commented
Jan 29, 2020
sebgl
commented
Jan 29, 2020
sebgl
commented
Jan 29, 2020
2 tasks
|
One thing I noticed while testing is that we will want to update the controller-gen check in the makefile: I think any changes should probably be a separate PR though, because 0.2.4 also adds some of the markers required for structural schema ( |
barkbay
approved these changes
Jan 30, 2020
anyasabo
approved these changes
Jan 30, 2020
anyasabo
changed the title
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.
This PR should have been split into 2:
Versionfield as mandatoryHowever they both rely on each other:
CI would fail building manifests in both individual cases. Hence a single PR with 2 commits.
1. Mark the Version field as required in all CRD
Currently if the Version field is not set, we reject the resource in the
validation webhook.
If the webhook is disabled, the operator returns an error early in the
reconciliation.
This could be considered a breaking API change, but the Version field
was already required implicitly, just not caught by the OpenAPI
validation.
Fixes #2395.
2. Customize CRDs to work around trivialVersions gen bug
A bug in controller-tools prevent validation to appear in the generated
CRDs if trivialVersions is set and multiple versions do not share the
exact same schema.
See kubernetes-sigs/controller-tools#349.
This commit removes the usage of
crd:trivialVersions=true, to"manually" (through Kustomize) apply the CRD modifications so we end up
with the trivialVersion scheme. That is: a single
validationfieldmatching the OpenAPISchema of the currently stored version (v1).
Fixes #2479.