Skip to content
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

Jump to bottom

Update backup-and-restore.md #2144

Merged
merged 1 commit into from
Jul 4, 2023
Merged

Update backup-and-restore.md #2144

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
35 changes: 33 additions & 2 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Back up and restore NebulaGraph data

To prevent data loss due to operational errors or system failures, NebulaGraph offers the Backup & Restore (BR) tool to help users back up and restore graph data. Dashboard Enterprise Edition integrates BR capabilities and offers simple UIs that allow users to perform data backup and restore operations in just a few steps. This document describes how to use Dashboard Enterprise Edition to backup and restore NebulaGraph data.
To prevent data loss due to operational errors or system failures, NebulaGraph offers the Backup & Restore (BR) tool to help users back up and restore graph data. Dashboard Enterprise Edition integrates BR capabilities and offers simple UIs that allow users to perform data backup and restore operations in just a few steps. This document describes how to use Dashboard Enterprise Edition to back up and restore NebulaGraph data.


## Limits
Expand Down Expand Up @@ -31,6 +31,8 @@ To prevent data loss due to operational errors or system failures, NebulaGraph o

### Full backup

#### Backup to cloud storage compatible with S3

Data is backed up to the cloud storage service by creating a backup file as follows.

1. On the **Backup&Restore** page, click the **Backup List** tab.
Expand Down Expand Up @@ -65,7 +67,8 @@ Data is backed up to the cloud storage service by creating a backup file as foll

Environment check includes:

- Your NebulaGraph cluster is running.
- The NebulaGraph services are running.
- The cluster must have at least one space.
- The access key to log onto the storage service has not expired.
- The status of business traffic. It only checks if the QPS of your business is 0. When QPS is not 0, you are prompted to back up data during off-peak hours.

Expand Down Expand Up @@ -93,6 +96,34 @@ Data is backed up to the cloud storage service by creating a backup file as foll

Do not modify the file name and storage path of backup files, otherwise, the backup data cannot be restored to the cluster.

#### Backup to local

Users can save the backup data locally by creating a backup file, the operation is as follows.

1. In the upper right corner of the page, click **Create New Backup**.
2. On the **Create New Backup** page, choose **Full backup**.
3. In **Backup type**, choose **Local**.
4. Enter the storage path of the backup file in **Storage Path**.
5. Click **Environment check** to check whether the relevant configurations are working properly, and then click **Submit**.

Environment check includes:

- The NebulaGraph services are running.
- The cluster must have at least one space.
- The status of business traffic. It only checks if the QPS of your business is 0. When QPS is not 0, you are prompted to back up data during off-peak hours.

6. View the created backup file in the backup list.

!!! note

You are unable to perform a new backup until the previous backup is completed.

7. Check if the created backup file exists in the storage path. Successfully created backup files are stored in the storage path set above.

!!! danger

Do not modify the file name and storage path of backup files, otherwise, the backup data cannot be restored to the cluster.

### Incremental backup

Users can perform incremental backup based on existing backup files. Incremental backup only covers all files that have changed or been modified since the last backup was made.
Expand Down