Enhance enabling-ha.md doc

This document was missing the `data.buckets` configurable parameter for the leader election. Remove references to `data.resourceLock` for HA config While enhancing the HA document, we realized that the `resourceLock`` field is not configurable in the Knative side, but rather hardcoded. You can see in https://github.com/knative/pkg/blob/master/leaderelection/config.go#L74-L87 , where the Config object is defined, that this field is not included. Also, the value for it seems to be hardcoded to "leases", as seen in https://github.com/knative/pkg/blob/master/leaderelection/config.go#L38 Signed-off-by: Zoe <[email protected]>
tektoncd · Dec 8, 2020 · 705e971 · 705e971
1 parent e097c52
commit 705e971
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/config/config-leader-election.yaml b/config/config-leader-election.yaml
@@ -22,7 +22,6 @@ metadata:
     app.kubernetes.io/part-of: tekton-pipelines
 data:
   # An inactive but valid configuration follows; see example.
-  resourceLock: "leases"
   leaseDuration: "15s"
   renewDeadline: "10s"
   retryPeriod: "2s"
diff --git a/docs/enabling-ha.md b/docs/enabling-ha.md
@@ -36,11 +36,13 @@ The leader election can be configured via the [config-leader-election.yaml](../.
 
 | Parameter            | Default  |
 | -------------------- | -------- |
-| `data.resourceLock`  | "leases" |
+| `data.buckets`       | 1        |
 | `data.leaseDuration` | 15s      |
 | `data.renewDeadline` | 10s      |
 | `data.retryPeriod`   | 2s       |
 
+_Note_: When setting `data.buckets`, the underlying Knative library only allows a value between 1 and 10, making 10 the maximum number of allowed buckets.
+
 ## Disabling leader election
 
 ---