Skip to content

[Router] Document peer bootstrap: flags, RBAC, downward API, probe implications - #42049

Merged
ShangmingCai merged 1 commit into
mainfrom
router-peer-bootstrap-readme
Oct 1, 2026
Merged

ShangmingCai merged 1 commit into
mainfrom
router-peer-bootstrap-readme

Conversation

@ShangmingCai

@ShangmingCai ShangmingCai commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

Docs-only follow-up from the peer-bootstrap stack review (#40687–#40699): the feature's four flags and its deployment requirements appeared nowhere user-facing — the RBAC, downward-API and selector wiring lived only inside the e2e manifest.

Adds a ### Peer bootstrap (Kubernetes) section under Running, following the pattern of the neighbouring feature sections:

  • what the feature does and when it is inert (off without --kv-peer-selector; requires --policy cache_aware with the local radix tree and --service-discovery, which the CLI enforces);
  • the four flags with defaults, including the EndpointSlice-labels-not-pod-labels trap for the selector (a pod-template label matches nothing and every replica silently boots cold) and the readiness-probe implication of --kv-bootstrap-timeout-ms;
  • --kv-bootstrap-seed-required semantics: bounded hold at max(3× the bootstrap timeout, 60s), delays a failed seed rather than shipping it cache-blind, cannot stall a rollout indefinitely;
  • deployment requirements: get/list/watch on endpointslices (already granted by the worker-discovery Role), the POD_NAME/POD_NAMESPACE/POD_IP downward-API trio for self-exclusion, surge-only rollouts;
  • pointers to the worked manifest (tests/e2e/k8s_integration/manifests/kv-bootstrap.yaml) and the sgl_router_kv_bootstrap_* metric table in monitoring/README.md.

All defaults and semantics verified against the code (DEFAULT_KV_BOOTSTRAP_TIMEOUT_MS, DEFAULT_KV_BOOTSTRAP_FETCH_TIMEOUT_CAP_MS, seed_gate_timeout, manifests/rbac.yaml). No code changes.

🤖 Generated with Claude Code


CI States

Latest PR Test (Base): ✅ Run #36851998663
Latest PR Test (Extra): ❌ Run #36851998470
Latest PR Test (AMD ROCm 10): ➖ No AMD PR run found for this commit.

The feature cannot function without deployment wiring that until now was
described only inside the e2e manifest: the EndpointSlice RBAC, the
downward-API env trio for self-exclusion, and a selector that must match
Service labels rather than pod labels. Document all of it where the other
router features are documented, with the four flags, their defaults, the
readiness-probe implication of the bootstrap deadline, and pointers to the
worked manifest and the metric table.

Follow-up from the #40687-#40699 stack review, item 4.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 1, 2026
@ShangmingCai
ShangmingCai merged commit a71c7d1 into main Oct 1, 2026
97 of 101 checks passed
@ShangmingCai
ShangmingCai deleted the router-peer-bootstrap-readme branch October 1, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant