[Helm] Make Kube Client QPS and Burst configurable for kuberay-operator (#4002)

* [Helm] Make Kube Client QPS and burst configurable for kuberay-operator

Signed-off-by: Future-Outlier <eric901201@gmail.com>

* update

Signed-off-by: Future-Outlier <eric901201@gmail.com>

* update

Signed-off-by: Future-Outlier <eric901201@gmail.com>

---------

Signed-off-by: Future-Outlier <eric901201@gmail.com>

Author: Future-Outlier

helm-chart/kuberay-operator/README.md

@@ -174,6 +174,9 @@ spec:
 | operatorCommand | string | `"/manager"` | Path to the operator binary |
 | leaderElectionEnabled | bool | `true` | If leaderElectionEnabled is set to true, the KubeRay operator will use leader election for high availability. |
 | reconcileConcurrency | int | `1` | The maximum number of reconcile operations that can be performed simultaneously. This setting controls the concurrency of the controller reconciliation loops. Higher values can improve throughput in clusters with many resources, but may increase resource consumption. |
+| kubeClient | object | `{"burst":200,"qps":100}` | Kube Client configuration for QPS and burst settings. This setting controls the QPS and burst rate of the kube client when sending requests to the Kubernetes API server. If the QPS and burst values are too low, we may easily hit rate limits on the API server and slow down the controller reconciliation loops. |
+| kubeClient.qps | float | `100` | The QPS value for the client communicating with the Kubernetes API server. Must be a float number. |
+| kubeClient.burst | int | `200` | The maximum burst for throttling requests from this client to the Kubernetes API server. Must be a non-negative integer. |
 | rbacEnable | bool | `true` | If rbacEnable is set to false, no RBAC resources will be created, including the Role for leader election, the Role for Pods and Services, and so on. |
 | crNamespacedRbacEnable | bool | `true` | When crNamespacedRbacEnable is set to true, the KubeRay operator will create a Role for RayCluster preparation (e.g., Pods, Services) and a corresponding RoleBinding for each namespace listed in the "watchNamespace" parameter. Please note that even if crNamespacedRbacEnable is set to false, the Role and RoleBinding for leader election will still be created.  Note: (1) This variable is only effective when rbacEnable and singleNamespaceInstall are both set to true. (2) In most cases, it should be set to true, unless you are using a Kubernetes cluster managed by GitOps tools such as ArgoCD. |
 | singleNamespaceInstall | bool | `false` | When singleNamespaceInstall is true: - Install namespaced RBAC resources such as Role and RoleBinding instead of cluster-scoped ones like ClusterRole and ClusterRoleBinding so that   the chart can be installed by users with permissions restricted to a single namespace.   (Please note that this excludes the CRDs, which can only be installed at the cluster scope.) - If "watchNamespace" is not set, the KubeRay operator will, by default, only listen   to resource events within its own namespace. |

helm-chart/kuberay-operator/templates/deployment.yaml

@@ -115,6 +115,22 @@ spec:
             {{- end }}
             {{- $argList = append $argList (printf "--reconcile-concurrency=%v" .Values.reconcileConcurrency) -}}
             {{- end -}}
+            {{- if hasKey .Values "kubeClient" -}}
+            {{- if hasKey .Values.kubeClient "qps" -}}
+            {{- $qps := toString .Values.kubeClient.qps }}
+            {{- if not (regexMatch "^[+-]?[0-9]+(\\.[0-9]+)?$" $qps) }}
+            {{- fail (printf "values.kubeClient.qps must be a valid float number, got %q" $qps) }}
+            {{- end }}
+            {{- $argList = append $argList (printf "--qps=%v" .Values.kubeClient.qps) -}}
+            {{- end -}}
+            {{- if hasKey .Values.kubeClient "burst" -}}
+            {{- $burst := toString .Values.kubeClient.burst }}
+            {{- if not (regexMatch "^[0-9]+$" $burst) }}
+            {{- fail (printf "values.kubeClient.burst must be a non-negative integer, got %q" $burst) }}
+            {{- end }}
+            {{- $argList = append $argList (printf "--burst=%v" .Values.kubeClient.burst) -}}
+            {{- end -}}
+            {{- end -}}
             {{- (printf "\n") -}}
             {{- $argList | toYaml | indent 12 }}
           ports:

helm-chart/kuberay-operator/tests/deployment_test.yaml

@@ -275,3 +275,16 @@ tests:
       - contains:
           path: spec.template.spec.containers[?(@.name=="kuberay-operator")].args
           content: "--reconcile-concurrency=5"
+
+  - it: Should use custom kube client qps and burst when set
+    set:
+      kubeClient:
+        qps: 75.5
+        burst: 150
+    asserts:
+    - contains:
+        path: spec.template.spec.containers[?(@.name=="kuberay-operator")].args
+        content: "--qps=75.5"
+    - contains:
+        path: spec.template.spec.containers[?(@.name=="kuberay-operator")].args
+        content: "--burst=150"

helm-chart/kuberay-operator/values.yaml

@@ -121,6 +121,17 @@ leaderElectionEnabled: true
 # Higher values can improve throughput in clusters with many resources, but may increase resource consumption.
 reconcileConcurrency: 1
 
+# -- Kube Client configuration for QPS and burst settings.
+# This setting controls the QPS and burst rate of the kube client when sending requests to the Kubernetes API server.
+# If the QPS and burst values are too low, we may easily hit rate limits on the API server and slow down the controller reconciliation loops.
+kubeClient:
+  # -- The QPS value for the client communicating with the Kubernetes API server.
+  # Must be a float number.
+  qps: 100.0
+  # -- The maximum burst for throttling requests from this client to the Kubernetes API server.
+  # Must be a non-negative integer.
+  burst: 200
+
 # -- If rbacEnable is set to false, no RBAC resources will be created, including the Role for leader election, the Role for Pods and Services, and so on.
 rbacEnable: true