You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
This should also update the CSV as part of the bundle generation so that the ALM examples annotation includes a complete example for users to reference:
I'd use the minimum required as the main example to get non-experienced users a simple way to get started.
As we can provide multiple examples, then we can append some other examples with a specific purpose so that UIs supporting it can allow you to pick one or use the default.
Maybe as an all-in-one example we can use this https://github.com/gatekeeper/gatekeeper-operator/blob/master/config/samples/gatekeeper_with_all_values.yaml
Yes, I agree a simple example makes sense. At the same time my concern is that the existing sample is used for documentation purposes within the CSV that is then placed onto operatorhub.io. I've seen some operators use a simple example like etcd and others like istio use a more extensive example that may show all the config options possible. These examples are obtained from the alm-examples field of the CSV as shown in the snippet above.
font
changed the title
Update sample operator CR to include all possible config knobs for user reference
Consider updating sample operator CR to include all possible config knobs for user reference in CSV
Dec 16, 2020
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
This should also update the CSV as part of the bundle generation so that the ALM examples annotation includes a complete example for users to reference:
gatekeeper-operator/bundle/manifests/gatekeeper-operator.clusterserviceversion.yaml
Lines 5 to 28 in 66712a1
The text was updated successfully, but these errors were encountered: