Set PreserveUnknownFields: false in v1 CRDs #124
Merged
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
Our CRDs were previously of version v1beta1. In v1beta1, spec.PreserveUnknownFields defaulted to `true`. As we did not set this value explicitly, the value was set to `true`. We've now updated our CRDs to v1. In v1, spec.PreserveUnknownFields defaults to false. In fact, it is being deprecated in favor of the more targeted x-kubernetes-preserve-unknown-fields field. Despite this new default, spec.PreserveUnknownFields remains `true` for our CRDs, even after applying the new v1 versions. This does not cause any bad behavior, but is incorrect. To fix this, we must set spec.PreserveUnknownFields to false in our CRDs. `controller-gen` v0.5.0 doesn't include an annotation for that, presumably because it's not longer the supported path for disabling pruning. So, I've achieved the desired effect with a simple kustomize patch. Contributes to open-policy-agent/gatekeeper#550 Signed-off-by: juliankatz <juliankatz@google.com>
julianKatz
force-pushed
the
PreserveUnknownFields-false-with-kustomize
branch
from
d89d10d
to
2073faf
Compare
maxsmythe
reviewed
Jun 10, 2021
Signed-off-by: juliankatz <juliankatz@google.com>
Codecov Report
@@ Coverage Diff @@
## master #124 +/- ##
==========================================
+ Coverage 44.26% 44.31% +0.04%
==========================================
Files 30 30
Lines 2417 2419 +2
==========================================
+ Hits 1070 1072 +2
Misses 1022 1022
Partials 325 325
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
julianKatz
changed the title
I've added the field to the code that generates Constraint kind CRDs. I'll make a PR in g8r as well. |
Signed-off-by: juliankatz <juliankatz@google.com>
ritazh
approved these changes
Jun 18, 2021
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.
Our CRDs were previously of version v1beta1. In v1beta1,
spec.PreserveUnknownFields defaulted to
true. As we did not set thisvalue explicitly, the value was set to
true.We've now updated our CRDs to v1. In v1, spec.PreserveUnknownFields
defaults to false. In fact, it is being deprecated in favor of the more
targeted x-kubernetes-preserve-unknown-fields field.
Despite this new default, spec.PreserveUnknownFields remains
trueforour CRDs, even after applying the new v1 versions. This does not cause
any bad behavior, but is incorrect. The simple fix is to set
spec.PreserveUnknownFields to false in all our CRDs.
As the Constraint kind CRD is generated in code, I've added this field
in constraint/pkg/client/crd_helpers.go.
The ConstraintTemplate CRD is generated using
controller-gen, butv0.5.0 of the tool doesn't include an annotation for that, presumably
because it's not longer the supported path for disabling pruning. So, I've
achieved the desired effect with a simple kustomize patch.
Contributes to open-policy-agent/gatekeeper#550
Signed-off-by: juliankatz juliankatz@google.com