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

How to populate catalog source metadata when pulling index image? #3

Open
joelanford opened this issue Aug 4, 2020 · 0 comments
Open
Labels
blocked-by-olm Related to an OLM feature or bug that blocks this issue/PR

Comments

@joelanford
Copy link
Member

joelanford commented Aug 4, 2020

The catalog source has several metadata fields in the spec that are optional, but nice to have for UX purposes, both on the command line and in a UI. These fields include:

  • spec.description
  • spec.displayName
  • spec.icon
  • spec.publisher

Currently (as a prototype) kubectl operator looks for index image labels:

  • alpha.operators.operatorframework.io.index.display-name.v1 to set spec.displayName
  • alpha.operators.operatorframework.io.index.publisher.v1 to set spec.publisher

When outputting the results of kubectl operator catalog list, kubectl operator includes columns for the display name and publisher. So images without these labels have no value in these columns.

The kubectl operator catalog add command has flags to handle setting these values, but it doesn't make a whole lot of sense to me for an administrator to be setting these fields.

Should there be optional labels added to the image spec to make it possible for index image owners to define the values for these fields?

@joelanford joelanford added the blocked-by-olm Related to an OLM feature or bug that blocks this issue/PR label Nov 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked-by-olm Related to an OLM feature or bug that blocks this issue/PR
Projects
None yet
Development

No branches or pull requests

1 participant