Skip to content

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

@joelanford

Description

@joelanford

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    blocked-by-olmRelated to an OLM feature or bug that blocks this issue/PR

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions