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

Document configuration of client QPS on config-policy-controller

XMLWordPrintable

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

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

            - [x] New topic in an existing section or new section https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/governance/governance#policy-controller-advanced-config 
            - [ ] Update to an existing topic

      3. - [ ] Mandatory for GA content:
                  
             - [ ] Add steps and/or other important conceptual information here: 

      Draft, new section titled "Configure the rate of requests to the API server" Best spot would be between the existing 2.4.1 and 2.4.2 sections. It is closely related to "2.4.1 Configure the concurrency".

      DRAFT:

      You can configure the rate of requests to the API server that the configuration policy controller makes on each managed cluster. A higher rate improves the responsiveness of the configuration policy controller, but also increases the CPU and memory utilization of the Kubernetes API server and OpenShift API server. By default, the rate of requests scales with the `policy-evaluation-concurrency` setting, and is `30` queries per second (QPS), with a `45` burst value, allowing for a higher number of requests over short periods of time.

      You can configure the rate and burst by setting the `client-qps` and `client-burst` annotations with non-zero integers within quotes. You can set the value on the `ManagedClusterAddOn` object called `config-policy-controller` in the managed cluster namespace of the hub cluster.

      In the following YAML example, the queries per second is set to `20` and the burst is set to `100` on the managed cluster called `cluster1`:

      ```

      apiVersion: addon.open-cluster-management.io/v1alpha1
      kind: ManagedClusterAddOn
      metadata:
        name: config-policy-controller
        namespace: cluster1
        annotations:
          client-qps: "20"
          client-burst: "100"
      spec:
        installNamespace: open-cluster-management-agent-addon

      ```

      END DRAFT

      Note: I found this old OpenShift 3.11 doc which had some explanation of QPS and burst... it's a very specific topic, and I would expect that if a user wanted to adjust this setting, they would already know what the settings do, we wouldn't need to teach them in the documentation here. https://docs.openshift.com/container-platform/3.11/scaling_performance/host_practices.html 

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

      Read/Write access to ManagedClusterAddOn resources on the hub, in the cluster namespace.

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)

      The config-policy-controller pod on the managed cluster should have arguments matching the configured values. For example, if the queries per second was configured to be 75, `--client-max-qps=75` would be present in the pod YAML.

             - [ ] Add link to dev story here:

      https://issues.redhat.com/browse/ACM-4294 

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

              mdockery@redhat.com Mikela Jackson
              jkulikau@redhat.com Justin Kulikauskas
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: