Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-52452

Some improvements of the Managing cluster extensions documentation

XMLWordPrintable

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • 3
    • Moderate
    • None
    • None
    • None
    • None
    • OSDOCS Sprint 268, OSDOCS Sprint 269
    • 2
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

      There are some inconsistency between the steps in `10.1.3.5. Creating a cluster role for an extension` section and the actual field in the example operator'csv file.
      
      The details are as follows:
      
      1. In step 3, there seems to be no `rules.resources` field in the CSV file and also no `clusterrole ` or `clusterrolebindings` field. I had to copy the example in the documentation.
      
      2. In step 4, no `rules.resources` field, but I found the `spec.customresourcedefinitions` field and successfully identified all customresourcedefinitions.
      
      3. In step 5, no `rules.resources` field, but I found the `spec.install.spec.clusterPermissions` field and successfully identified all clusterPermissions.
      
      4. In step 6, found the `install.spec.deployments` stanza, or more accurately `spec.install.spec.deployments` field and successfully identified all deployments.
      
      5. In step 7, no `rules.resources` field, and no `services` or `configmaps` field. I had to copy the example in the documentation. 
      
      Additionally, this is not about `Creating a cluster role for an extension` section, but about the example ClusterExtension'name, we have "pipelines-operator" and "pipes", so it is better to choose one and stick to it, "pipelines-operator" should be good:
      
      1. In `10.1.3.6. Example cluster role for the Red Hat OpenShift Pipelines Operator` section, the `resourceNames` is "pipes"
      
      2. In `Example pipelines-operator.yaml CR` in `10.1.4. Installing a cluster extension from a catalog` section, the `metadata.name` is "pipelines-operator"
      
      3. In `Example 10.11. Example output ` in `10.1.4. Installing a cluster extension from a catalog` section, the `metadata.name` is "pipelines-operator", however, the `metadata.annotations.kubectl.kubernetes.io/last-applied-configuration` has ""metadata":{"annotations":{},"name":"pipes"}"

              rhn-support-mipeter Michael Peter
              rhn-support-yhe Yiyong He
              None
              None
              Jian Zhang Jian Zhang
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: