Skip to content

Commit 780a2b7

Browse files
docs: cover the controller tuning values from kubernetes-sigs#392
The chart gained a controller block with concurrency, QPS and pprof settings after this PR was opened, so document them alongside the rest of the install options. Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
1 parent 20b7cfc commit 780a2b7

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

docs/book/src/user-guide/installation.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,21 @@ helm install nrr-controller ./charts/nrr-controller \
110110

111111
Both `webhook.enabled` and `validatingWebhook.enabled` are needed. The first runs the webhook server in the controller and mounts its certificate, the second registers the `ValidatingWebhookConfiguration` with the API server.
112112

113+
#### Tuning for larger clusters
114+
115+
The values under `controller` map to the manager's own flags, and each one is only passed to the container when you move it off its default:
116+
117+
| Value | Flag | Default |
118+
| :--- | :--- | :--- |
119+
| `controller.nodeConcurrentReconciles` | `--node-concurrent-reconciles` | `1` |
120+
| `controller.ruleConcurrentReconciles` | `--rule-concurrent-reconciles` | `1` |
121+
| `controller.kubeAPIQPS` | `--kube-api-qps` | `-1`, client-side throttling off |
122+
| `controller.kubeAPIBurst` | `--kube-api-burst` | `-1`, client-side throttling off |
123+
| `controller.enableNodeStateMetrics` | `--enable-node-state-metrics` | `false` |
124+
| `controller.pprofBindAddress` | `--pprof-bind-address` | unset, disabled |
125+
126+
Raising the two concurrency values is the usual response to readiness taints lagging behind node joins on a large cluster. `enableNodeStateMetrics` adds the per-rule `node_readiness_nodes_by_state` gauge at the cost of extra API reads on node updates, so turn it on when you want the fleet view and can afford the reads.
127+
113128
#### Managing rules through the chart
114129

115130
`NodeReadinessRule` objects can be shipped with the release through the `nodeReadinessRules` value:

0 commit comments

Comments
 (0)