Skip to content

docs: fix disaster recovery CLI options #2492

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
fengjiachun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix disaster recovery CLI options #2492

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
4 changes: 2 additions & 2 deletions docs/reference/command-lines/utilities/data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ greptime cli data export [OPTIONS]
| `--s3-bucket` | Yes* | - | The s3 bucket name if s3 is set, this is required |
| `--s3-root` | Yes* | - | If s3 is set, this is required |
| `--s3-endpoint` | No* | - | The s3 endpoint if s3 is set, this is required |
| `--s3-access-key` | Yes* | - | The s3 access key if s3 is set, this is required |
| `--s3-secret-key` | Yes* | - | The s3 secret key if s3 is set, this is required |
| `--s3-access-key-id` | Yes* | - | The s3 access key ID if s3 is set, this is required |
| `--s3-secret-access-key` | Yes* | - | The s3 secret access key if s3 is set, this is required |
| `--s3-region` | Yes* | - | The s3 region if s3 is set, this is required |
| `--oss` | No | - | If export data to oss |
| `--oss-bucket` | Yes* | - | The oss bucket name if oss is set, this is required |
Expand Down
4 changes: 2 additions & 2 deletions ...er-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ greptime cli data export \
--addr localhost:4000 \
--s3 \
--s3-bucket <YOUR_S3_BUCKET> \
--s3-access-key <YOUR_S3_ACCESS_KEY> \
--s3-secret-key <YOUR_S3_SECRET_KEY> \
--s3-access-key-id <YOUR_S3_ACCESS_KEY_ID> \
--s3-secret-access-key <YOUR_S3_SECRET_ACCESS_KEY> \
--s3-region <YOUR_S3_REGION> \
--s3-root <YOUR_S3_ROOT> \
--s3-endpoint <YOUR_S3_ENDPOINT>
Expand Down
10 changes: 5 additions & 5 deletions ...ide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ greptime cli meta snapshot save \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

**Output**: Creates `metadata_snapshot.metadata.fb` file in the specified S3 bucket.
Expand Down Expand Up @@ -100,8 +100,8 @@ greptime cli meta snapshot restore \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

### Import from Local File
Expand Down Expand Up @@ -144,4 +144,4 @@ Restore metadata from local backup file to RaftEngine:
greptime cli meta snapshot restore \
--store-addrs "raftengine:///path/to/metadata" \
--backend raft-engine-store
```
```
7 changes: 2 additions & 5 deletions docs/user-guide/deployments-administration/disaster-recovery/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ But if running the Standalone with remote WAL and object storage, there is a bet

Write the WAL to the Kafka cluster and store the data in object storage, so the database itself is stateless. In the event of a disaster affecting the standalone database, you can restore it using the remote WAL and object storage. This solution can achieve **RPO=0** and **RTO in minutes**.

For more information about this solution, see [DR solution for Standalone](./dr-solution-for-standalone.md).

### DR solution based on Active-Active Failover

![Active-active failover](/active-active-failover.png)
Expand Down Expand Up @@ -106,7 +104,7 @@ In this architecture, GreptimeDB Cluster 1 is deployed in region 1. The BR proce

The DR solution based on BR provides an RPO depending on the backup frequency and an RTO that varies with the size of the data to be restored.

Read [Backup & restore data](./back-up-&-restore-data.md) for details, and we plan to provide a BR tool in-house for this solution.
Read [Backup & restore data](./back-up-&-restore-data.md) for details.

### Solution Comparison

Expand All @@ -124,7 +122,6 @@ By comparing these DR solutions, you can decide on the final option based on the
## References

* [Backup & restore data](./back-up-&-restore-data.md)
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the Standalone DR link

Removing the Standalone link here makes the detailed dr-solution-for-standalone.md page effectively undiscoverable from the current docs: I checked sidebars.ts, and this page is not listed under disaster recovery, and a repo-wide rg for dr-solution-for-standalone shows no remaining current-doc link after this change. Users reading the Standalone DR section now have no path to the implementation details even though the page still exists.

Useful? React with 👍 / 👎.

* [DR solution for GreptimeDB Standalone](./dr-solution-for-standalone.md)
* [DR solution based on Active-Active Failover ](/enterprise/deployments-administration/disaster-recovery/dr-solution-based-on-active-active-failover.md)
* [DR solution based on cross-region deployment in a single cluster](./dr-solution-based-on-cross-region-deployment-in-single-cluster.md)
* [S3 Replicating objects overview](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html)
* [S3 Replicating objects overview](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html)
6 changes: 3 additions & 3 deletions ...ocusaurus-plugin-content-docs/current/reference/command-lines/utilities/data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ greptime cli data export [OPTIONS]
| `--s3-bucket` | 是\* | - | 当设置了 `--s3` 时，必须指定 S3 的 bucket 名称 |
| `--s3-root` | 是\* | - | 当设置了 `--s3` 时，必须指定导出在 bucket 中的根路径 |
| `--s3-endpoint` | 否\* | - | 当设置了 `--s3` 时，需指定 S3 的 endpoint |
| `--s3-access-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Access Key |
| `--s3-secret-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Secret Key |
| `--s3-access-key-id` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Access Key ID |
| `--s3-secret-access-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Secret Access Key |
| `--s3-region` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的区域（Region） |
| `--oss` | 否 | - | 是否导出数据到阿里云 OSS |
| `--oss-bucket` | 是\* | - | 当设置了 `--oss` 时，需指定 OSS 的 bucket 名称 |
Expand Down Expand Up @@ -83,4 +83,4 @@ greptime cli data import [OPTIONS]
### 导入目标
- `schema`: 仅导入表结构
- `data`: 仅导入表数据
- `all`: 导入表结构和数据（默认）
- `all`: 导入表结构和数据（默认）
4 changes: 2 additions & 2 deletions ...er-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ greptime cli data export \
--addr localhost:4000 \
--s3 \
--s3-bucket <YOUR_S3_BUCKET> \
--s3-access-key <YOUR_S3_ACCESS_KEY> \
--s3-secret-key <YOUR_S3_SECRET_KEY> \
--s3-access-key-id <YOUR_S3_ACCESS_KEY_ID> \
--s3-secret-access-key <YOUR_S3_SECRET_ACCESS_KEY> \
--s3-region <YOUR_S3_REGION> \
--s3-root <YOUR_S3_ROOT> \
--s3-endpoint <YOUR_S3_ENDPOINT>
Expand Down
10 changes: 5 additions & 5 deletions ...ide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ greptime cli meta snapshot save \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

**输出**: 在指定的 S3 桶中创建 `metadata_snapshot.metadata.fb` 文件。
Expand Down Expand Up @@ -99,8 +99,8 @@ greptime cli meta snapshot restore \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

### 从本地文件导入
Expand Down Expand Up @@ -143,4 +143,4 @@ greptime cli meta snapshot restore \
greptime cli meta snapshot restore \
--store-addrs "raftengine:///path/to/metadata" \
--backend raft-engine-store
```
```
5 changes: 1 addition & 4 deletions ...ocs/current/user-guide/deployments-administration/disaster-recovery/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ GreptimeDB 将数据存储在对象存储（如 [AWS S3](https://docs.aws.amazon
在影响独立数据库的灾难事件发生时，你可以使用远程 WAL 和对象存储来恢复它。
此方案能实现 RPO=0 和分钟级 RTO。

有关此解决方案的更多信息，请参阅[独立模式的 DR 解决方案](./dr-solution-for-standalone.md)。

### 基于双活互备的 DR 解决方案

![Active-active failover](/active-active-failover.png)
Expand Down Expand Up @@ -123,7 +121,7 @@ BR 进程持续定期将数据从 Cluster 1 备份到 Region 2。

基于 BR 的 DR 解决方案提供的 RPO 取决于备份频率，RTO 随要恢复的数据大小而变化。

阅读[备份与恢复数据](./back-up-&-restore-data.md)获取详细信息，我们计划为此解决方案提供一种内部 BR 工具。
阅读[备份与恢复数据](./back-up-&-restore-data.md)获取详细信息。

### 解决方案比较

Expand All @@ -141,7 +139,6 @@ BR 进程持续定期将数据从 Cluster 1 备份到 Region 2。
## 参考资料

* [备份与恢复数据](./back-up-&-restore-data.md)
* [GreptimeDB Standalone 的 DR 解决方案](./dr-solution-for-standalone.md)
* [基于双活 - 备份的 DR 解决方案](/enterprise/deployments-administration/disaster-recovery/dr-solution-based-on-active-active-failover.md)
* [基于单集群跨区域部署的 DR 解决方案](./dr-solution-based-on-cross-region-deployment-in-single-cluster.md)
* [S3 对象副本概述](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html)
6 changes: 3 additions & 3 deletions ...aurus-plugin-content-docs/version-1.0/reference/command-lines/utilities/data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ greptime cli data export [OPTIONS]
| `--s3-bucket` | 是\* | - | 当设置了 `--s3` 时，必须指定 S3 的 bucket 名称 |
| `--s3-root` | 是\* | - | 当设置了 `--s3` 时，必须指定导出在 bucket 中的根路径 |
| `--s3-endpoint` | 否\* | - | 当设置了 `--s3` 时，需指定 S3 的 endpoint |
| `--s3-access-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Access Key |
| `--s3-secret-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Secret Key |
| `--s3-access-key-id` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Access Key ID |
| `--s3-secret-access-key` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的 Secret Access Key |
| `--s3-region` | 是\* | - | 当设置了 `--s3` 时，需指定 S3 的区域（Region） |
| `--oss` | 否 | - | 是否导出数据到阿里云 OSS |
| `--oss-bucket` | 是\* | - | 当设置了 `--oss` 时，需指定 OSS 的 bucket 名称 |
Expand Down Expand Up @@ -83,4 +83,4 @@ greptime cli data import [OPTIONS]
### 导入目标
- `schema`: 仅导入表结构
- `data`: 仅导入表数据
- `all`: 导入表结构和数据（默认）
- `all`: 导入表结构和数据（默认）
4 changes: 2 additions & 2 deletions ...er-guide/deployments-administration/disaster-recovery/back-up-&-restore-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ greptime cli data export \
--addr localhost:4000 \
--s3 \
--s3-bucket <YOUR_S3_BUCKET> \
--s3-access-key <YOUR_S3_ACCESS_KEY> \
--s3-secret-key <YOUR_S3_SECRET_KEY> \
--s3-access-key-id <YOUR_S3_ACCESS_KEY_ID> \
--s3-secret-access-key <YOUR_S3_SECRET_ACCESS_KEY> \
--s3-region <YOUR_S3_REGION> \
--s3-root <YOUR_S3_ROOT> \
--s3-endpoint <YOUR_S3_ENDPOINT>
Expand Down
10 changes: 5 additions & 5 deletions ...ide/deployments-administration/disaster-recovery/back-up-&-restore-meta-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ greptime cli meta snapshot save \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

**输出**: 在指定的 S3 桶中创建 `metadata_snapshot.metadata.fb` 文件。
Expand Down Expand Up @@ -99,8 +99,8 @@ greptime cli meta snapshot restore \
--s3 \
--s3-bucket your-bucket-name \
--s3-region ap-southeast-1 \
--s3-access-key <your-s3-access-key> \
--s3-secret-key <your-s3-secret-key>
--s3-access-key-id <your-s3-access-key-id> \
--s3-secret-access-key <your-s3-secret-access-key>
```

### 从本地文件导入
Expand Down Expand Up @@ -143,4 +143,4 @@ greptime cli meta snapshot restore \
greptime cli meta snapshot restore \
--store-addrs "raftengine:///path/to/metadata" \
--backend raft-engine-store
```
```
Loading
Loading