From 2919997b05bf09868743929680a32932b08847a6 Mon Sep 17 00:00:00 2001 From: akihi99 <101778636+akihi99@users.noreply.github.com> Date: Tue, 4 Jul 2023 15:33:07 +0800 Subject: [PATCH] Update backup-and-restore.md --- .../operator/backup-and-restore.md | 35 +++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md index 43cdc0942ac..12b83acb036 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md @@ -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 @@ -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. @@ -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. @@ -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.