Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Consider updating sample operator CR to include all possible config knobs for user reference in CSV #69

Open
font opened this issue Dec 2, 2020 · 2 comments

Comments

@font
Copy link
Member

font commented Dec 2, 2020

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:

alm-examples: |-
[
{
"apiVersion": "operator.gatekeeper.sh/v1alpha1",
"kind": "Gatekeeper",
"metadata": {
"name": "gatekeeper"
},
"spec": {
"audit": {
"logLevel": "INFO",
"replicas": 1
},
"image": {
"image": "docker.io/openpolicyagent/gatekeeper:v3.1.1"
},
"validatingWebhook": "Enabled",
"webhook": {
"logLevel": "INFO",
"replicas": 2
}
}
}
]

@ruromero
Copy link
Contributor

ruromero commented Dec 2, 2020

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

@font
Copy link
Member Author

font commented Dec 16, 2020

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 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 free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants