Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-19816

Namespace error in SiteConfig docs (rhacm vs open-cluster-management).

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

      1. - [ ] Mandatory: Add the required version to the Fix version/s field.
      2.13

      2. - [ ] Mandatory: Choose the type of documentation change or review.

      [X] We need to update to an existing topic
      [ ] We need to add a new document to an existing section
      [ ] We need a whole new section; this is a function not
      documented before and doesn't belong in any current section
      [ ] We need an Operator Advisory review and approval
      [ ] We need a z-Stream (Errata) Advisory and Release note for
      MCE and/or ACM

      3. - [ ] Mandatory: Find the link to where the documentation update
      should go and add it to the recommended changes. You can either use the
      published doc or the staged repo for this step:

      Follow instructions at:
      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/multicluster_engine_operator_with_red_hat_advanced_cluster_management/siteconfig-intro#enable-siteconfig-mch

      Note: As the feature and doc is understood, this recommendation may
      change. If this is new documentation, link to the section where you think
      it should be placed.

      Customer Portal published version

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12

      Doc staged repo within the ACM Workspace:
      https://github.com/stolostron/rhacm-docs

      4. - [ ] Mandatory for GA content:

      [ ] Add steps, the diff, known issue, and/or other important
      conceptual information in the following space:
      [ ] *Add Required access level *(example, *Cluster
      Administrator*) for the user to complete the task:
      [ ] Add verification at the end of the task, how does the user
      verify success (a command to run or a result to see?)
      [ ] Add link to dev story here:

      5. - [X] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

      There appears to be a typo or incorrect assumption in the documentation related to enabling the SiteConfig operator from the MultiClusterHub resource. The documentation mentions the namespace as rhacm, but the correct namespace should be open-cluster-management (assuming ACM is installed in the default namespace).

      Follow instructions at:
      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/multicluster_engine_operator_with_red_hat_advanced_cluster_management/siteconfig-intro#enable-siteconfig-mch

      Run the command from the docs and observes error message:

      ```
      $oc patch multiclusterhubs.operator.open-cluster-management.io multiclusterhub -n rhacm --type json --patch '[\{"op": "add", "path":"/spec/overrides/components/-", "value": {"name":"siteconfig","enabled": true}}]'
      Error from server (NotFound): namespaces "rhacm" not found
      ```
      Retry the same command with -n open-cluster-management and the command succeeds:

      ```
      oc patch multiclusterhubs.operator.open-cluster-management.io multiclusterhub -n open-cluster-management --type json --patch '[\{"op": "add", "path":"/spec/overrides/components/-", "value": {"name":"siteconfig","enabled": true}}]'
      multiclusterhub.operator.open-cluster-management.io/multiclusterhub patched
      ```

              rhn-support-amolnar Alexandra Molnar (Inactive)
              rhn-support-sandyada Sandeep Yadav
              Votes:
              1 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: