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

doc: configure proxy setting for cluster proxy add-on

XMLWordPrintable

    • False
    • None
    • False
    • doc-ack
    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

      Describe the changes in the doc and link to your dev story

      Provide info for the following steps:

      1. - [x] Mandatory Add the required version to the Fix version/s field.  MCE 2.5.0

      2. - [x] Mandatory Choose the type of documentation change.

            - [ ] New topic in an existing section or new section
            - [x] Update to an existing topic

      3. - [ ] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here: 
       doc update : 1.5.8. Using cluster proxy add-ons

        https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#cluster-proxy-addon

      1. remove section:

      Important: There must not be a cluster-wide proxy configuration on your hub cluster.

      2.  add section:
      1.5.8.2. Configuring proxy settings for cluster proxy add-ons

      Configure the proxy settings to allow the communications from the managed cluster to access the hub cluster through a HTTP and HTTPS proxy server. You need
      Cconfigure the proxy setting for the cluster proxy add-on if the cluster proxy addon agent needs access the hub cluster through the proxy server.

      Complete the following steps to configure the proxy settings for the cluster proxy add-on:

      Create an AddOnDeploymentConfig resource with the proxy settings by adding a spec.proxyConfig parameter on your Hub cluster. View the following YAML example:

      ```
      apiVersion: addon.open-cluster-management.io/v1alpha1
      kind: AddOnDeploymentConfig
      metadata:
      name: <addon-deploy-config-name>
      namespace: <managed-cluster-name>
      spec:
      agentInstallNamespace: open-cluster-managment-addon-observability
      proxyConfig:
      httpsProxy: "http://<username>:<password>@<ip>:<port>" 1
      noProxy: ".cluster.local,.svc,172.30.0.1" 2
      caBundle: xxx  3
      ```

      1. For this field, you can specify either a HTTP proxy or a HTTPS proxy.
      2. Include the IP address of the kube-apiserver.
      To get the IP address, run following command on your managed cluster:
      ```
      oc -n default describe svc kubernetes | grep IP:
      ```
      3. Need set the proxy server CA bundle here if you specify HTTPS proxy in 1.

      Go to the ManagedClusterAddOn resource and update it by referencing the AddOnDeploymentConfig resource that you made. View the following YAML example:

      ```
      apiVersion: addon.open-cluster-management.io/v1alpha1
      kind: ManagedClusterAddOn
      metadata:
      name: cluster-proxy
      namespace: <managed-cluster-name>
      spec:
      installNamespace: open-cluster-managment-addon
      configs:

      • group: addon.open-cluster-management.io
        resource: AddonDeploymentConfig
        name: <addon-deploy-config-name>
        namespace: <managed-cluster-name>
        ```

      Verify the proxy settings. If you successfully configured the proxy settings, the cluster proxy proxy agent pod in open-cluster-managment-addon namespace will have HTTPS_PROXY an NO_PROXY env on the managed cluster.
       

      also suggest add a link about how to configure proxy for addons to the added content  in https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html-single/clusters/index#configuring-proxy-hub-and-managed-cluster 

                  
             - [ ] Add Required access level for the user to complete the task here:
             

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
           
           
             - [x] Add link to dev story here:  *https://issues.redhat.com/browse/ACM-9192*

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

            rh-ee-ofischer Oliver Fischer
            zyin@redhat.com Zhiwei Yin
            Hui Chen Hui Chen
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: