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 and provider to CSV #11

Open
jharmison-redhat opened this issue Sep 19, 2020 · 2 comments
Open

Add annotations and provider to CSV #11

jharmison-redhat opened this issue Sep 19, 2020 · 2 comments
Assignees

Comments

@jharmison-redhat
Copy link
Member

CSV annotations are what populate the extra information on the embedded OperatorHub interface. See for example the following snippet:

apiVersion: packages.operators.coreos.com/v1
kind: PackageManifest
metadata:
# labels snipped for brevity
  name: awss3-operator-registry
  namespace: openshift-marketplace
spec: {}
status:
  catalogSource: community-operators
  catalogSourceDisplayName: Community Operators
  catalogSourceNamespace: openshift-marketplace
  catalogSourcePublisher: Red Hat
  channels:
  - currentCSV: awss3operator.1.0.1
    currentCSVDesc:
      annotations:
        alm-examples: '[]'
        capabilities: Basic Install
        categories: Storage
        certified: "false"
        containerImage: quay.io/screeley44/aws-s3-provisioner:v1.0.0
        createdAt: "2019-05-02 16:12:00"
        description: Manage the full lifecycle of installing, configuring and managing
        repository: https://github.com/yard-turkey/aws-s3-provisioner
        support: Community
      apiservicedefinitions: {}
# customresourcedefinitions, description, installModes, keywords, links, maintainers, maturity, relatedImages, version snipped for brevity
      displayName: AWS S3 Operator
      provider:
        name: Community
    name: alpha
# additional embedded CSV snipped for brevity
  defaultChannel: alpha
  packageName: awss3-operator-registry
  provider:
    name: Community

And reference the OperatorHub pop-out drawer for that operator:
image

Compared to that for the Gitea operator:
image

I also believe that the provider.name: Community is what applies the obvious Community label on the interface, and this should be added as well. The PackageManifest labels appear to have been derived from the CSV annotations and other various sources.

Other PackageManifests' nested CSVs show more verbose information for the support annotation, sometimes with links to the GitHub new Issue page. I think a Community badge on the operator with a link to the new Issue page as the Support tag on the web UI would be obvious enough, if my hunch on provider.name is right, or we can otherwise identify the proper triggers for that badge.

@jharmison-redhat
Copy link
Member Author

Also, considering the existing links in the CSV aren't being surfaced at the UI, I suggest we should include more verbose Markdown syntax for description as that is rendered directly on the UI.

@jharmison-redhat jharmison-redhat self-assigned this Sep 19, 2020
@jharmison-redhat
Copy link
Member Author

Also, we need to go through relatedImages and do pinning based on sum for bundle images and release operator images if we're going to get in line with documentation/expectation from others.

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

1 participant