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

dashboard supports incremental backup #1828

Merged
merged 3 commits into from
Dec 30, 2022
Merged

dashboard supports incremental backup #1828

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00ae8fb
dashboard supports incremental backup
cooper-lzy Dec 26, 2022
5e54ecc
Update docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/back…
cooper-lzy Dec 27, 2022
0f5c31c
Update docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/back…
cooper-lzy Dec 27, 2022
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
45 changes: 32 additions & 13 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
Expand Up @@ -10,8 +10,7 @@ To prevent data loss due to operational errors or system failures, NebulaGraph o
!!! note

To back up data to a local device, see [What is Backup & Restore](../../../backup-and-restore/nebula-br/1.what-is-br.md).

- Currently, only full backup and full restore of data are supported, and incremental backup and incremental restore are not supported.

- Backup and restoration of space-level data are not supported.
- Backup data can only be restored to the original cluster, and cannot be restored across clusters.
- Breakpoint moving of backup and restore data is not supported.
Expand All @@ -29,8 +28,8 @@ To prevent data loss due to operational errors or system failures, NebulaGraph o
1. In the top navigation bar, click **Cluster Management**.
2. On the right side of the target cluster, click **Detail**.
3. In the left navigation bar, click **Operation**->**Backup&Restore**.
### Back up data

### Full backup data
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down Expand Up @@ -61,7 +60,8 @@ Data is backed up to the cloud storage service by creating a backup file as foll
To back up data to OSS, you need to replace `oss` with `s3` for the OSS storage path. For example, change the original OSS path `oss://nebula-br-test/` to `s3://nebula-br-test/`.

4. In the upper right corner of the page, click **Create New Backup**.
5. On the **Create New Backup** page, click **Environment check** to check whether the relevant configurations are working properly, and then click **Submit**.
5. On the **Create New Backup** page, choose **Full backup**.
6. Click **Environment check** to check whether the relevant configurations are working properly, and then click **Submit**.

Environment check includes:

Expand All @@ -73,20 +73,15 @@ Data is backed up to the cloud storage service by creating a backup file as foll

You are unable to submit the backup when your cluster works abnormally or the access key to the storage service has expired.

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

![br_list](https://docs-cdn.nebula-graph.com.cn/figures/brlist_2022-06-27_14-23-24_en.png)

- The backup list shows backups created within 30 days by default, showing backup name, time, status, backup spaces, backup type, storage path, and related operations.
- The backup status includes `running`, `success`, and `failed`.
- Related operations include restoring the backup, viewing restoration records, viewing logs generated by the backup operation, and deleting the backup.
- You can filter created backups by creation time and status) or search backup file names for backups.
![br_list](https://docs-cdn.nebula-graph.com.cn/figures/brlist_221226_en.png)

!!! 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 service.
8. Check if the created backup file exists in the storage service.
Successfully created backup files are stored to the storage path set above, like `s3://nebula-br-test`.

- Amazon S3:
Expand All @@ -98,6 +93,30 @@ 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.

### Incremental backup data
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

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.

1. On the **Backup&Restore** page, click the **Backup List** tab.
2. In the upper right corner of the page, click **Create New Backup**.
3. On the **Create New Backup** page, choose **Incremental backup**.
4. Choose **Base Backup Name**.

!!! note

New data will be backed up based on this base backup. Make sure that the data of the base backup is not changed. Otherwise, the incremental backup may fail.

5. Click **Environment check** to check whether the relevant configurations are working properly, and then click **Submit**.

Environment check includes:

- Your NebulaGraph cluster is running.
- 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.

!!! note

You are unable to submit the backup when your cluster works abnormally or the access key to the storage service has expired.

### Restore data

Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,6 @@ nav:
- Limitations: nebula-studio/about-studio/st-ug-limitations.md
- Deploy and connect:
- Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- Deploy Studio with Helm: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
- Connect to NebulaGraph: nebula-studio/deploy-connect/st-ug-connect.md
- Quick start:
- Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
Expand Down Expand Up @@ -578,14 +577,14 @@ nav:
- Information overview: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md
- Cluster diagnostics: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md
# - Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
- Backup and restore: nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md
- Operation:
- Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md
- Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md
- Service: nebula-dashboard-ent/4.cluster-operator/operator/service.md
- Update config: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md
- Member management: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md
- Version upgrade: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md
- Backup and restore: nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md
- Operation records: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md
- Other settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md
- Authority management: nebula-dashboard-ent/5.account-management.md
Expand Down