Skip to content

docs(pd): document the periodic leader balance settings - #547

Open
arshilkxwork wants to merge 1 commit into
apache:masterfrom
arshilkxwork:docs/pd-balance-leader-config
Open

arshilkxwork wants to merge 1 commit into
apache:masterfrom
arshilkxwork:docs/pd-balance-leader-config

Conversation

@arshilkxwork

Copy link
Copy Markdown
Contributor

Docs for apache/hugegraph#3356 (apache/hugegraph#3356), which adds optional periodic partition leader balancing to PD with three new settings.

Updated in both EN and CN, in the PD core table of quickstart/hugegraph/hugegraph-pd.md:

  • pd.balance-leader-enable (false): run leader balancing on a timer on the PD leader.
  • pd.balance-leader-interval (300 seconds): time between checks, and the minimum time between two plans, counted from the last plan including a manual balanceLeaders call.
  • pd.balance-leader-max-skew (2): the leader-count spread above which a check balances.

A short paragraph under the table says the keys exist only in versions after 1.7.0, when a check or a single transfer is skipped, and that an invalid interval or skew leaves the feature off with a warning.

The text matches apache/hugegraph#3356 at f8c3a952f. This should merge after that PR, since no released PD has these settings yet.

I ran git diff --check. I did not build the site locally.

apache/hugegraph#3356 adds pd.balance-leader-enable,
pd.balance-leader-interval and pd.balance-leader-max-skew. Add them to
the PD core table on the PD quickstart page, EN and CN, with a note on
when a check or a transfer is skipped.

@bitflicker64 bitflicker64 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.

Blocking: no. Score: 9.5/10. Summary: The pd.balance-leader-enable, pd.balance-leader-interval and pd.balance-leader-max-skew rows and the note under the table match apache/hugegraph#3356 at f8c3a952f (PDConfig defaults, distribution application.yml, the init() validation warning, and the skip and transfer checks in TaskScheduleService), and the EN and CN pages agree. This should merge after apache/hugegraph#3356, which is still open; if it changes before merging, these rows need another check.

This branch has not been deployed

No deployments
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