Skip to content

docs: name the router's control plane sync flag under --key-grace-period - #748

Merged
aojea merged 1 commit into
google:mainfrom
HosniBelfeki:docs/router-control-plane-sync-flag
Oct 18, 2026
Merged

aojea merged 1 commit into
google:mainfrom
HosniBelfeki:docs/router-control-plane-sync-flag

Conversation

@HosniBelfeki

Copy link
Copy Markdown
Contributor

What

The --key-grace-period row of the control plane reference says nodes and routers must pull /keys well within the grace period, and names the flags that set it:

(agentmesh-node --control-plane-sync-interval, agentmesh-router --keys-sync-interval)

--keys-sync-interval went with the single control plane sync loop (b9719e0, #719). The router now pulls /keys every --control-plane-sync-interval, and its help text already asks for that interval to stay "well below the control plane's --lease-duration and --key-grace-period". A router started with the documented flag does not start:

$ agentmesh-router --keys-sync-interval 5m
Error: unknown flag: --keys-sync-interval

Fix

The row names agentmesh-router --control-plane-sync-interval, as site/content/docs/reference/router.md does. No other reference to the removed flag is left in the repository.

Docs only; checked against a router built from main at 70fbb22.

The control plane reference tells operators to keep the router's key pull well within --key-grace-period with agentmesh-router --keys-sync-interval. That flag went with the single control plane sync loop (b9719e0); the router now pulls /keys every --control-plane-sync-interval, and refuses the old flag as unknown.
@HosniBelfeki
HosniBelfeki requested a review from aojea as a code owner October 18, 2026 15:34

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation in site/content/docs/reference/control-plane.md to correct the flag name for agentmesh-router from --keys-sync-interval to --control-plane-sync-interval in the description of the --key-grace-period option. There are no review comments, and I have no additional feedback to provide.

@aojea

aojea commented Oct 18, 2026

Copy link
Copy Markdown
Collaborator

upps, thanks for catching it

@aojea
aojea merged commit a452621 into google:main Oct 18, 2026
21 checks passed
@HosniBelfeki
HosniBelfeki deleted the docs/router-control-plane-sync-flag branch October 20, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants