From cd516a54053eeeb16a0705964ad793e3e5e61cdc Mon Sep 17 00:00:00 2001 From: cxymds Date: Mon, 29 Jun 2026 09:05:16 +0800 Subject: [PATCH 1/2] docs(admin): document heal and rebalance workflows --- README.md | 3 +- docs/reference/rc/admin.md | 81 +++++++++++++++++++++++++++++++++++++- 2 files changed, 82 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 47271b6..83d4ac3 100644 --- a/README.md +++ b/README.md @@ -273,6 +273,7 @@ rc admin expand stop local rc admin decommission start local '/data/pool1/disk{1...4}' rc admin decommission status local '/data/pool1/disk{1...4}' rc admin decommission cancel local 1 --by-id +rc admin decommission clear local 1 --by-id # Rebalance data after adding server pools rc admin rebalance start local @@ -331,7 +332,7 @@ For full command documentation, see the [`rc` command reference](docs/reference/ | `admin heal` | Manage cluster healing operations (status, start, stop) | | `admin pool` | List pools and inspect expansion/decommission status | | `admin expand` | Manage post-expansion data rebalancing (start, status, stop) | -| `admin decommission` | Manage server pool decommissioning (start, status, cancel) | +| `admin decommission` | Manage server pool decommissioning (start, status, cancel, clear) | | `admin rebalance` | Manage post-expansion rebalancing (start, status, stop) | ### ILM Subcommands diff --git a/docs/reference/rc/admin.md b/docs/reference/rc/admin.md index e9a8676..9a59a20 100644 --- a/docs/reference/rc/admin.md +++ b/docs/reference/rc/admin.md @@ -12,7 +12,8 @@ rc admin info [OPTIONS] rc admin heal [OPTIONS] rc admin pool [POOL] [OPTIONS] rc admin expand -rc admin decommission [OPTIONS] +rc admin decommission [OPTIONS] +rc admin decommission status [POOL] [OPTIONS] rc admin rebalance rc admin user ... rc admin policy ... @@ -67,6 +68,34 @@ Stop a manual bucket heal task: rc admin heal stop local --bucket logs --client-token ``` +Start decommissioning a pool: + +```bash +rc admin decommission start local '/data/pool1/disk{1...4}' +``` + +Check decommissioning status for all pools: + +```bash +rc admin decommission status local +``` + +Check, cancel, or clear decommissioning by pool ID: + +```bash +rc admin decommission status local 1 --by-id +rc admin decommission cancel local 1 --by-id +rc admin decommission clear local 1 --by-id +``` + +Start and inspect post-expansion rebalancing: + +```bash +rc admin rebalance start local +rc admin rebalance status local +rc admin rebalance stop local +``` + Create a user and attach a policy: ```bash @@ -86,6 +115,56 @@ Admin operations use the configured alias to create an admin client. The credent `rc admin heal status ` reports aggregate background heal status. Manual bucket or prefix heals started with `rc admin heal start` are token-scoped tasks; the start output includes a client token, and subsequent task status or stop requests must pass that token with `--bucket`, optional `--prefix`, and `--client-token`. +## Heal Workflow + +`rc admin heal` manages cluster healing operations. + +| Command | Description | +| --- | --- | +| `rc admin heal status ` | Show aggregate background heal status. | +| `rc admin heal status --bucket [--prefix ] --client-token ` | Show a token-scoped manual heal task. | +| `rc admin heal start [OPTIONS]` | Start a manual heal operation. | +| `rc admin heal stop ` | Stop the global background heal operation. | +| `rc admin heal stop --bucket [--prefix ] --client-token ` | Stop a token-scoped manual heal task. | + +`heal start` accepts these operation options: + +| Option | Description | +| --- | --- | +| `-b, --bucket ` | Heal a single bucket. Omit this option to recursively heal all buckets. | +| `-p, --prefix ` | Limit a bucket heal to an object prefix. | +| `--scan-mode normal\|deep` | Select the scan mode. Defaults to `normal`. | +| `--remove` | Remove dangling objects or parts found by the heal scan. | +| `--recreate` | Recreate missing data. | +| `--dry-run` | Report what would be healed without applying changes. | + +Manual bucket and prefix heals are token-scoped. Save the `clientToken` returned by `heal start`; the token is required to inspect or stop that manual task. + +## Decommission Workflow + +`rc admin decommission` retires server pools from a cluster. The `POOL` argument can be a pool command line, comma-separated pool command lines, or a zero-based pool ID when `--by-id` is set. + +| Command | Description | +| --- | --- | +| `rc admin decommission start [--by-id]` | Start decommissioning one or more pools. | +| `rc admin decommission status [POOL] [--by-id]` | Show decommissioning status for all pools or one pool. | +| `rc admin decommission cancel [--by-id]` | Cancel decommissioning for a pool. | +| `rc admin decommission clear [--by-id]` | Clear failed or canceled decommissioning metadata for a pool. | + +Use `rc admin pool list ` or `rc admin pool status ` to find pool IDs and pool command lines before starting a decommission. + +## Rebalance Workflow + +`rc admin rebalance` manages post-expansion data movement after server pools are added to a deployment. + +| Command | Description | +| --- | --- | +| `rc admin rebalance start ` | Start a cluster rebalance operation. | +| `rc admin rebalance status ` | Show cluster-wide and per-pool rebalance status. | +| `rc admin rebalance stop ` | Stop a running rebalance operation. | + +`rc admin expand` is an alias-oriented workflow for the same post-expansion rebalance step. The `expand` command is also available as `scale`. + Global options shown in command syntax use the same meaning everywhere: | Option | Description | From b0551e050a4c391183ace79ed82670da536dfb27 Mon Sep 17 00:00:00 2001 From: cxymds Date: Mon, 29 Jun 2026 09:08:31 +0800 Subject: [PATCH 2/2] docs(admin): retrigger protected files check