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

Console supports Operator to specify where (on infra/master/worker node) to run with CSV suggested namespace template annotation

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Major
    • openshift-4.13
    • None
    • OLM Screens
    • None
    • HAC Infra OCP - Sprint 227, HAC Infra OCP - Sprint 228

    Description

      Problem

      As an Operator author, I want to be able to specify where my Operators to run (on infra, master, or worker nodes) so my end-users can easily install them through OperatorHub in the console without special setups.

      Acceptance Criteria

      • Operators can assign a Namespace object template in YAML to the provided `operatorframework.io/suggested-namespace-template` CSV annotation to specify how the suggested namespace is being created by the console during the installation.
      • During the installation, UI will:
      • populate the "Installed Namespace" dropdown using the `metadata.name` field in the attached Namespace YAML manifest
      • create the namespace object using the Namespace YAML manifest being assigned to `operatorframework.io/suggested-namespace-template` CSV annotation.
      • If end-users change the "Installed Namespace" dropdown to another namespace, the UI shows warning messages so users know the user-selected namespace might not have all the correct setup recommended by the Operator and it might not run correctly/successfully.
      • If both `suggested-namespace` and `suggested-namespace-template` annotation are present in CSV template should take precedence.

      Details

      The console adds support to take the value field of a CSV annotation as the Namespace YAML template to create a Namespace object for installing the Operator.

      CSV Annotation Example

      apiVersion: v1
      kind: Namespace
      metadata:
        annotations:
          openshift.io/node-selector: ""
        name: my-operator-namespace
      

      Attachments

        Activity

          People

            sgoodwin_redhat Steve goodwin
            rhn-coreos-tunwu Tony Wu
            Xiyun Zhao Xiyun Zhao
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: