Fix diff for CRD .spec.preserveUnknownFields #2506
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
The v4 diffing logic relies on resource normalization to accurately compare input values to live state. Most resources are normalize by converting the Unstructured resource to its typed equivalent and then back, but this process requires a defined conversion scheme. However, CRDs do not have a conversion scheme defined. CRD resources have a deprecated parameter ".spec.preserveUnknownFields" that the apiserver removes from the created CRD if the value is false. This causes problems for diffing, because the inputs and the live state are continuously out of sync. This change adds CRD-specific normalization logic to avoid causing a continuous diff if this field is set in the resource definition.
Does the PR have any schema changes?Looking good! No breaking changes found. |
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.
Proposed changes
The v4 diffing logic relies on resource normalization to accurately compare input values to live state. Most resources are normalize by converting the Unstructured resource to its typed equivalent and then back, but this process requires a defined conversion scheme. However, CRDs do not have a conversion scheme defined.
CRD resources have a deprecated parameter ".spec.preserveUnknownFields" that the apiserver removes from the created CRD if the value is false. This causes problems for diffing, because the inputs and the live state are continuously out of sync.
This change adds CRD-specific normalization logic to avoid causing a continuous diff if this field is set in the resource definition.
Related issues (optional)
Fix #2505