fix(crd-generator): Ensure deterministic ordering of CRD versions #5784
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
…t v1beta1 CRDVersion
The implementation uses a method from KubernetesVersionPriority to sort the versions by priority. The version with the highest priority comes first. This ensures deterministic generation und should fix fabric8io#5508.
baloo42
requested review from
manusa,
oscerd,
rohanKanojia,
shawkins and
sunix
as code owners
baloo42
changed the title
baloo42
changed the title
baloo42
changed the title
|
| * The kubernetes specs v1.17 at <a href= | ||
| * "https://v1-17.docs.kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning/#version-priority">Version | ||
| * The kubernetes specs v1.28 at <a href= | ||
| * "https://v1-28.docs.kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#version-priority">Version |
There was a problem hiding this comment.
nit, do we really need to have version in the documentation? I checked https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#version-priority also works okay
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.
Description
If multiple versions of a CustomResource exist, the result of CRD generation is not deterministic. While this doesn't change the behaviour of Kubernetes, since the version order does not matter, it causes unnecessary changes if checked into git or applied to the cluster.
This PR resolves this issue by sorting the versions based on priority.
The implementation adds a decorator to the CRDGenerator which is configured to run late in the handler chain after all versions has been added. The decorator sorts the versions by priority so that the version with the highest priority comes first.
To be able to reuse existing functionality regarding sorting by priority and to keep the internal Version class package-private, a new method has been added to KubernetesVersionPriority.
The method allows creating a new sorted list by providing a generic list of objects and a version provider function.
Fixes #5508
Type of change
test, version modification, documentation, etc.)
Checklist