Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-4774

document the annotation "console.openshift.io/plugins"

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • Dynamic Plugins
    • None
    • document CSV annotation for plugins
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • None
    • None
    • None

      When a partner develops a dynamic web console, which is a significant investment in our ecosystem, they follow the documentation here: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/dynamic-plugins

      But that documentation does not tell them how to make sure that their operator's installation page has a "Console plugin: Enable / Disable" selector (see attached screenshot). It is valuable to surface the plugin's existence to the operator installation process, but we need to tell developers how to do that.

      It turns out that can be done by adding an annotation with key "console.openshift.io/plugins" to the operator's ClusterServiceVersion resource. That is documented in the original enhancement proposal, but not in our official docs.

      Today one of our large partners asked me how to do this, because they saw the selector when installing operators from other partners that include a console plugin. We should have official and current documentation that explains it.

      Thanks!

        1. 12_24_18.jpg
          350 kB
          Michael Hrivnak

              Unassigned Unassigned
              mhrivnak@redhat.com Michael Hrivnak
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: