-
Notifications
You must be signed in to change notification settings - Fork 209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Operator bundle resource descriptions should come from golang doc comments #1416
Comments
From discussion on #1410 |
The operatorhub CSV (Cluster Service Version) is a document that describes what the operatorhub bundle output looks like. Right now this file is handcrafted for ASO v1. For ASOv2, we would like to autogenerate this file so that we can pull the Resource descriptions from the Go types. This would probably be similar to the |
@babbageclunk should we push to next milestone? |
Confirmed with offline discussion: this is still needed and should be done at the same time as #1967. |
Status is still the same as above: Waiting on #1967 |
Status is still the same as above: Waiting on #1967 |
Still waiting on #1967 |
Still waiting on #1967 |
Closing in favor of tracking operator bundle stuff via #1967 |
Describe the current behavior
At the moment the descriptions of the resources are in the template ClusterServiceVersion document
config/operator-bundle/bases/azure-service-operator.clusterserviceversion.yaml
(under.spec.customresourcedefinitions.owned
). That means that if we add a resource but forget to add it to the yaml, it won't have any description in the Openshift resource UI.Describe the improvement
We should populate that section of the CSV from the doc comments on the Go resource types.
manifests
that collects those up and writes them into a generated CSV yaml file inconfig/operator-bundle-populated/bases
. (controller-gen
puts the doc comments into each CRD yaml at.spec.validation.openAPIV3Schema.description
.)generate-operator-bundle
to use that generated yaml as the base rather than the existing template one.The text was updated successfully, but these errors were encountered: