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

update addon documentation to cover disabling cluster-proxy-addon

XMLWordPrintable

    • False
    • 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. - [X] Mandatory: Add the required version to the Fix version/s field.

      2. - [X] 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. - [X] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      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.

      We need to add 1.4 disabling cluster-proxy-addon - the documentation should just state that if you do not need a reverse proxy to have your clusters reach RHACM you can disable the cluster-proxy-addon  through not the klusterletAddonConfig but the multiclusterhub-config - the `cluster-proxy-addon` deployments will stop if the component of the same name is disabled in MCE. Examples :

      apiVersion: operator.open-cluster-management.io/v1
      kind: MultiClusterEngine
      metadata:
        name: multiclusterengine
      spec:
        overrides:
          components:
          - name: cluster-proxy-addon
            enabled: false
      

      or

      oc patch MultiClusterEngine <multiclusterengine-name> --type=json -p='[{"op": "add", "path": "/spec/overrides/components/-","value":{"name":"cluster-proxy-addon","enabled":false}}]' 

      can be used for that purpose.

      and you can link to https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html-single/clusters/index#deployed-components which does state how to enable - could instead of the examples state to change the component cluster-proxy-addon to enabled: false from the default enabled: true.

              bswope@redhat.com Brandi Swope
              rhn-support-fdewaley Felix Dewaleyne
              Hui Chen Hui Chen
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: