Skip to content

docs(zero): document --rebalance_interval=0 disabling automatic rebal… #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shiva-istari wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(zero): document --rebalance_interval=0 disabling automatic rebal… #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docusaurus-docs/docs/admin/admin-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docusaurus-docs/docs/cli/zero.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docusaurus-docs/docs/installation/dgraph-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading