Skip to content

docs: document horizontal controller scaling via leader election buckets #9670

@vdemeester

Description

@vdemeester

Description

Tekton controllers support horizontal scaling via Knative's bucket-based leader election, but this is not documented anywhere in docs/.

The mechanism is configured in config-leader-election-controller ConfigMap:

data:
  buckets: "10"  # partition key space into 10 buckets

Then scale the deployment:

kubectl -n tekton-pipelines scale deployment tekton-pipelines-controller --replicas=5

With M buckets and N replicas, replicas compete for buckets. Each bucket owner reconciles keys in its partition.

Areas to Document

  • How to configure buckets in config-leader-election-controller
  • Recommended bucket/replica ratios
  • Impact on reconciliation latency and throughput
  • Same mechanism available for config-leader-election-webhook and config-leader-election-events
  • Any caveats (e.g., rebalancing behavior when replicas change)

Context

Closes the long-standing request from #3404 (25 comments, opened 2020). The feature has been available for years but users don't know about it.

/kind documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions