fix(api): deprecate FlightRecorder and Recording CRDs#356
Merged
ebaron merged 4 commits intocryostatio:mainfrom Mar 28, 2022
Merged
fix(api): deprecate FlightRecorder and Recording CRDs#356ebaron merged 4 commits intocryostatio:mainfrom
ebaron merged 4 commits intocryostatio:mainfrom
Conversation
andrewazores
approved these changes
Mar 26, 2022
jan-law
approved these changes
Mar 28, 2022
This file contains hidden or 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
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.
The CRD spec has properties for whether a version is deprecated and a warning string to show the user when they try to use that version. Newer controller-tools versions support these properties using marker comments, but this requires Operator SDK 1.10 and we're still quite a bit behind that (see #287). In the meantime, I've added Kustomize patches to add these properties.
Example:
I didn't see this have an effect in the UI, so I've added the
operators.operatorframework.io/internal-objectsannotation to our CSV. This results in the FlightRecorder and Recording APIs being hidden from the OpenShift Console's operator UI. The functionality remains available via command line or through the CustomResourceDefinitions page in the OpenShift Console.Bundle for testing:
Fixes: #349