Skip to content
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

Add annotations to CSV required for community operator acceptance #6576

Closed
chipzoller opened this issue Sep 19, 2023 · 4 comments
Closed

Add annotations to CSV required for community operator acceptance #6576

chipzoller opened this issue Sep 19, 2023 · 4 comments

Comments

@chipzoller
Copy link

chipzoller commented Sep 19, 2023

Feature Request

Describe the problem you need a feature to resolve.

When using operator SDK (v1.31 used) to build a community operator for submission to redhat-openshift-ecosystem/community-operators-prod, it is missing the following required (or recommend) annotations.

  • categories
  • containerImage
  • support
  • repository
  • description

And spec.icon is empty by default which is also a requirement.

If an operator built with operator SDK by performing an init is submitted to the community operator repo, it will fail for required CI checks due to these omissions.

Describe the solution you'd like.

It would be extremely nice if operator SDK would either include these fields by default (first preference), or when performing make bundle they are prompts added to the current list of prompts asked of a user with a note specifying that in some cases they may be required.

@varshaprasad96
Copy link
Member

The requirements could differ in different situations. Which is why we are skeptical on adding these annotations by default to the SDK scaffolding. We would recommend using kustomize patches to add these annotations, or adding them to the scaffolded bases should also work.

@chipzoller closing this issue for now, please feel free to reopen if you feel otherwise. Thank you!

@chipzoller
Copy link
Author

I respect the decision, however I think because this is such a common destination for operators you could at least build in something in the Makefile and allow users to opt in.

In any case, this issue should be closed as not planned rather than completed if you do not intend on implementing it.

@varshaprasad96
Copy link
Member

varshaprasad96 commented Sep 25, 2023

@chipzoller These annotations are useful, but not a necessity, and eventually it would be difficult for us to cater to all the scenarios. The major reason for introducing Kustomize for building bundles was exactly this, to allow customizations in bundles, so that an operator author can extend it for different needs. Which is why we have the generic kustomize build command in place, and the users can inject any kind of kustomize generators/patches in their files. Hope that helps!

@chipzoller
Copy link
Author

According to the latest directions in the PR template, the annotations are required. I understand the Kustomize angle I'm just suggesting the user experience could be a bit better by at least informing users that the output of this SDK isn't sufficient for Red Hat's community needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants