Skip to content

Clarify temporary PD lifecycle in pd-recover #23011

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

Merged
ti-chi-bot merged 3 commits into from
Jun 8, 2026
+4 −2
Merged

Clarify temporary PD lifecycle in pd-recover #23011

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fc2984
Create empty translation PR
hfxsd Jun 5, 2026
53c6483
Auto-sync: Update English docs from Chinese PR
github-actions[bot] Jun 5, 2026
1d9f240
Update pd-recover.md
hfxsd Jun 5, 2026
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
6 changes: 4 additions & 2 deletions pd-recover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Start the surviving PD node using the `--force-new-cluster` startup parameter, a
./bin/pd-server --force-new-cluster --name=pd-127.0.0.10-2379 --data-dir=/path/to/existing/pd/data --client-urls=http://0.0.0.0:2379 --advertise-client-urls=http://127.0.0.1:2379 --peer-urls=http://0.0.0.0:2380 --advertise-peer-urls=http://127.0.0.1:2380 --config=conf/pd.toml
```

This command starts a temporary single-node PD, allowing `pd-recover` in the next step to connect and repair the metadata. Keep this PD process running, and perform the next step in another terminal window.

> **Note:**
>
> - If `--data-dir` is not specified in the command line, ensure that `data-dir` in `conf/pd.toml` correctly points to the original data directory of the surviving PD node. Otherwise `pd-recover` might fail in subsequent operations.
Expand All @@ -60,11 +62,11 @@ Since this method relies on a minority PD node to recover the service, the node

### Step 4: Restart the PD node

Once you see the prompt message `recovery is successful`, restart the PD node.
Once you see the prompt message `recovery is successful`, stop the temporary PD process that starts with `--force-new-cluster` in Step 2, and then restart the PD node normally without the `--force-new-cluster` parameter.

### Step 5: Scale out PD and start the cluster

Scale out the PD cluster using the deployment tool and start the other components in the cluster. At this point, the PD service is available.
After confirming that the PD in Step 4 has started normally and is providing service, scale out the PD cluster using the deployment tool and start the other components in the cluster. At this point, the service is restored.

## Method 2: Entirely rebuild a PD cluster

Expand Down