Skip to content

Commit

Permalink
opt-br-ent-restrictions (#2127)
Browse files Browse the repository at this point in the history
  • Loading branch information
abby-cyber authored Jun 16, 2023
1 parent ce6d5a3 commit 28385e2
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ For the deployment of BR in K8s Operator, see [Backup and restore data using Neb
## Limits

- The version of NebulaGraph Enterprise Edition clusters must be equal to or greater than v{{ nebula.release }}.
- [Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md) backups are not supported.
- Full-text indexes data backups are not supported.
- If you back up data to a local disk, the backup files will be saved in the local storage path of each server in a NebulaGraph cluster. You can also mount the NFS on your server to restore the backup data to a different server.
- During the backup process, both DDL and DML statements in a specified graph space are blocked. We recommend that you perform the operation within the low peak period of the business, for example, from 2:00 AM to 5:00 AM.
- Restoration requires that the number of the storage servers in the original cluster is the same as that of the storage servers in the target cluster and storage server IPs must be the same.
- Backing up data of a specified graph space is not supported.
- Using BR Enterprise Edition in a container-based NebulaGraph cluster is not supported.

## Usage process
Expand Down
8 changes: 7 additions & 1 deletion docs-2.0/backup-and-restore/nebula-br-ent/3.backup-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ You can use BR (Enterprise Edition) to back up NebulaGraph data. You can perform

## Notes


- During the process of data backup, DDL and DML statements in all specified graph spaces are blocked. We recommend that you perform the backup operation during the low business peak period.
- If you back up data to a local disk, the backup files will be saved in the local storage path of each server in a NebulaGraph cluster. You can also mount the NFS on your server to restore the backup data to a different server.
- During the process of a full backup, it may take a long time if the amount of the data to be backed up is large.
- During the process of data backup, DDL and DML statements in the specified graph space are blocked. We recommend that you perform the backup operation during the low business peak period.
- The cluster performing an incremental backup needs to be the same as the cluster specified for the previous backup. The storage path of the incremental backup should also be the same as the path of the previous backup.
- Make sure that the time between each incremental backup and the last backup is less than a [`wal_ttl`](../../5.configurations-and-logs/1.configurations/4.storage-config.md) time.
- Make sure that Agent has read and write permissions for the corresponding NebulaGraph cluster installation directory and backup directory.
- Not support backup for [Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md).
- Not support backup for full-text indexes.

- Not support backup for data of a specified graph space.

## Prerequisites

Expand Down
3 changes: 2 additions & 1 deletion docs-2.0/backup-and-restore/nebula-br-ent/4.restore-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ For the backed-up NebulaGraph data with the [BR tool](2.install-tools.md), you c

## Notes

- After the data restoration is executed successfully, the existing data on the target cluster will be deleted and then replaced with the data in the backup directory. It is recommended to back up the data on the target cluster in advance.
- There will be a period of NebulaGraph service unavailability for data restoration, so it is recommended to operate during the low business peak period.
- Restoration requires that the number of the storage servers in the original cluster is the same as that of the storage servers in the target cluster.
- After the data restoration is executed successfully, the existing data on the target cluster will be deleted and then replaced with the data in the backup directory. It is recommended to back up the data on the target cluster in advance.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/backup-and-restore/nebula-br/1.what-is-br.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The BR has the following features. It supports:
- Supports full backup, but not incremental backup.
- Currently, NebulaGraph Listener and full-text indexes do not support backup.
- If you back up data to the local disk, the backup files will be saved in the local path of each server. You can also mount the NFS on your host to restore the backup data to a different host.
- During the backup process, both DDL and DML statements in the specified graph spaces are blocked. We recommend that you do the operation within the low peak period of the business, for example, from 2:00 AM to 5:00 AM.
- During the backup process, both DDL and DML statements in any specified graph spaces are blocked. We recommend that you do the operation within the low peak period of the business, for example, from 2:00 AM to 5:00 AM.
- The backup graph space can be restored to the original cluster only. Cross clusters restoration is not supported. Make sure the number of hosts in the cluster is not changed. Restoring a specified graph space will delete all other graph spaces in the cluster.
- Restoration requires that the number of the storage servers in the original cluster is the same as that of the storage servers in the target cluster and storage server IPs must be the same. Restoring the specified space will clear all the remaining spaces in the cluster.
- During the restoration process, there is a time when NebulaGraph stops running.
Expand Down

0 comments on commit 28385e2

Please sign in to comment.