From f504c90844dd1a99366e9390e9ba4ef6b8f38686 Mon Sep 17 00:00:00 2001 From: Shivaji Kharse Date: Wed, 7 Oct 2026 16:35:42 +0530 Subject: [PATCH] docs(zero): document --rebalance_interval=0 disabling automatic rebalancing Updates the zero CLI reference, the /moveTablet admin endpoint note and the architecture page's automatic rebalancing section. Manual tablet moves keep working when automatic rebalancing is disabled. --- docusaurus-docs/docs/admin/admin-endpoints.md | 2 +- docusaurus-docs/docs/cli/zero.md | 4 ++-- docusaurus-docs/docs/installation/dgraph-architecture.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docusaurus-docs/docs/admin/admin-endpoints.md b/docusaurus-docs/docs/admin/admin-endpoints.md index a0c13410..ed4b3835 100644 --- a/docusaurus-docs/docs/admin/admin-endpoints.md +++ b/docusaurus-docs/docs/admin/admin-endpoints.md @@ -33,7 +33,7 @@ Dgraph Zero exposes the following HTTP endpoints on port `6080` (plus optional p Before using the `/removeNode` endpoint, ensure that the node is down and ensure that it doesn't come back up ever again. Do not use the same `idx` of a node that was removed earlier. ::: -- **`/moveTablet?tablet=name&group=2`** - Moves a tablet to a group. Zero already rebalances shards every 8 mins, but this endpoint can be used to force move a tablet. +- **`/moveTablet?tablet=name&group=2`** - Moves a tablet to a group. Zero already rebalances shards every 8 mins by default (configurable with `--rebalance_interval`; set to `0` to disable automatic rebalancing), but this endpoint can be used to force move a tablet. Manual moves work even when automatic rebalancing is disabled. ### POST Endpoints diff --git a/docusaurus-docs/docs/cli/zero.md b/docusaurus-docs/docs/cli/zero.md index 30389295..95bb8b55 100644 --- a/docusaurus-docs/docs/cli/zero.md +++ b/docusaurus-docs/docs/cli/zero.md @@ -23,7 +23,7 @@ dgraph zero [flags] | `-o, --port_offset` | Value added to all listening port numbers [Grpc=5080, HTTP=6080] | `0` | | `-w, --wal` | Directory storing WAL | `"zw"` | | `--replicas` | How many Dgraph Alpha replicas to run per data shard group | `1` | -| `--rebalance_interval` | Interval for trying a predicate move | `8m0s` | +| `--rebalance_interval` | Interval for trying a predicate move; `0` disables automatic tablet rebalancing | `8m0s` | | `--enterprise_license` | Path to the enterprise license file | | ## Superflags @@ -91,7 +91,7 @@ Flags: idx=1; Provides an optional Raft ID that this Alpha would use to join Raft groups. learner=false; Make this Zero a "learner" node. In learner mode, this Zero will not participate in Raft elections. This can be used to achieve a read-only replica. (default "idx=1; learner=false;") - --rebalance_interval duration Interval for trying a predicate move. (default 8m0s) + --rebalance_interval duration Interval for trying a predicate move. Set to 0 to disable automatic tablet rebalancing. (default 8m0s) --replicas int How many Dgraph Alpha replicas to run per data shard group. The count includes the original shard. (default 1) --security string Security options token=; If set, all requests to Zero's administrative HTTP endpoints must present this token in the X-Dgraph-AuthToken header. diff --git a/docusaurus-docs/docs/installation/dgraph-architecture.md b/docusaurus-docs/docs/installation/dgraph-architecture.md index d0b7c3a4..b070818f 100644 --- a/docusaurus-docs/docs/installation/dgraph-architecture.md +++ b/docusaurus-docs/docs/installation/dgraph-architecture.md @@ -130,7 +130,7 @@ Group 3: location, company Zero continuously monitors disk usage across groups and automatically rebalances predicates to maintain even distribution: -- Runs rebalancing checks every 8-10 minutes +- Runs rebalancing checks every 8-10 minutes (interval set by Zero's `--rebalance_interval` flag; `0` disables automatic rebalancing) - Moves predicates from high-usage groups to lower-usage groups - During a predicate move: - The predicate becomes temporarily read-only