From 8d7919b7b8d109790edc50a5d92fed27337028a4 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 15 Feb 2022 14:50:14 +0800 Subject: [PATCH 1/8] add backup&restore --- .../2.backup-restore/2.compile-br.md | 6 +- .../2.backup-restore/4.br-restore-data.md | 136 +++++++++++------- mkdocs.yml | 11 +- 3 files changed, 95 insertions(+), 58 deletions(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md b/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md index 6ede5ecfa1f..a40300956d8 100644 --- a/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md +++ b/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md @@ -13,7 +13,7 @@ To compile the BR, do a check of these: To compile the BR, follow these steps: -1. Clone the `nebula-storage` repository to your machine. +1. Clone the `nebula-br` repository to your machine. ```bash git clone https://github.com/vesoft-inc/nebula-br.git @@ -35,8 +35,8 @@ Users can enter `bin/br version` on the command line. If the following results a ```bash [nebula-br]$ bin/br version -Nebula Backup And Restore Ultility Tool,V-0.1.0 - GitSha: 8e994dc +Nebula Backup And Restore Utility Tool,V-0.6.0 + GitSha: 079e7c7 GitRef: master please run "help" subcommand for more infomation. ``` diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index 90b900e129c..5aa71d565b7 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -16,67 +16,105 @@ To restore data with the BR, do a check of these: - The BR is compiled. For more information, see [Compile BR](2.compile-br.md). -- No application is connected to the target Nebula Graph cluster. - -- Make sure that the target and the source Nebula Graph clusters have the same topology, which means that they have exactly the same number of hosts. - -- Your account on the BR machine can log on to the meta and the storage servers via SSH without a password. For more information, see[SSH tunnels with keys](http://alexander.holbreich.org/ssh-tunnel-without-password/). - - !!! caution - - This account must have write privileges to the installation directory of Nebula Graph and the data directory (--data_path) of the meta/storage service. - -- To perform the restoration process, a `root` user is required. +- Download [nebula-agent](https://github.com/vesoft-inc/nebula-agent) and start the agent service in each cluster(including metad, storaged, graphd) host. -- If the backup files are stored on Alibaba Cloud OSS or Amazon S3, make sure that the S3 CLI client or ossutil is installed and configured on the meta servers, the storage servers, and the BR machine. For more information, see [Alibaba Cloud ossutil Documentation](https://www.alibabacloud.com/help/zh/doc-detail/120075.htm#concept-303829) and [Amazon S3 CLI Documentation](https://docs.amazonaws.cn/cli/latest/userguide/cli-services-s3.html). - - !!! caution +- No application is connected to the target Nebula Graph cluster. - Run `ln -s // /usr/local/bin/ossutil` to make the `ossutil` command effective. +- Make sure that the target and the source Nebula Graph clusters have the same topology, which means that they have exactly the same number of hosts. The number of data folders for each host is consistently distributed. ## Procedures 1. Users can use the following command to list the existing backup information: - ```bash - $ ./bin/br show --storage - ``` - For example, use the following command to list the backup information in the local `/home/test/backup` path. - ```bash - $ ./bin/br show --storage "local:///home/test/backup" - +----------------------------+---------------------+------------------+-------------+---------------+ - | NAME | CREATE TIME | SPACES | FULL BACKUP | SPECIFY SPACE | - +----------------------------+---------------------+------------------+-------------+---------------+ - | BACKUP_2021_07_29_06_51_09 | 2021-07-29 06:51:09 | basketballplayer | true | true | - | BACKUP_2021_07_29_07_55_08 | 2021-07-29 07:55:09 | basketballplayer | true | true | - +----------------------------+---------------------+------------------+-------------+---------------+ - ``` + ```bash + $ ./bin/br show --storage + ``` + For example, use the following command to list the backup information in the local `/home/nebula/backup` path. + ```bash + $ ./bin/br show --storage "local:///home/nebula/backup" + +----------------------------+---------------------+------------------------+-------------+------------+ + | NAME | CREATE TIME | SPACES | FULL BACKUP | ALL SPACES | + +----------------------------+---------------------+------------------------+-------------+------------+ + | BACKUP_2022_02_10_07_40_41 | 2022-02-10 07:40:41 | basketballplayer | true | true | + | BACKUP_2022_02_11_08_26_43 | 2022-02-11 08:26:47 | basketballplayer,foesa | true | true | + +----------------------------+---------------------+------------------------+-------------+------------+ + ``` + + Or, you can use the following command to list the backup information in S3 URL `s3://127.0.0.1:9000/br-test/backup`. + ```bash + $ ./bin/br show --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default + ``` + + | Parameter | Data type | Required | Default value | Description | + | --- | --- | --- | --- | --- | + | `-h,-help` | - | No | None | Checks help for restoration. | + | `-debug` | - | No | None | Checks for more log information. | + | `-log` | string | No | br.log | Specify br detail log path. | + | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: ://.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Set access key id. | + | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | + | `--s3.region` | string | No | None | Set region or location to upload or download backup. | + | `--s3.secret_key` | string | No | None | Set secret key for access id. | + 2. Run the following command to restore data. - ``` - [root]# ./bin/br restore full --meta --storage --name --user - ``` + ``` + $ ./bin/br restore full --meta --storage --name + ``` + + For example, use the following command to upload the backup files in the local `/home/nebula/backup/` to the cluster where the meta service's address is `127.0.0.1:9559`. - For example, use the following command to restore the data in the local `/home/foesa/backup` path to the cluster where the address is `192.168.*.*:9559` and the user name of the host where the meta/storage service is located is `root`. + ``` + $ ./bin/br restore full --meta "127.0.0.1:9559" --storage "local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08 + ``` - ``` - [root]# ./bin/br restore full --meta "192.168.*.*:9559" --storage "local:///home/test/backup" --name "BACKUP_2021_07_29_07_55_08" --user "root" - ``` + Or, you can use the following command to upload the backup files in S3 URL `s3://127.0.0.1:9000/br-test/backup`. + ```bash + $ ./bin/br restore full --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region="default" --name BACKUP_2021_12_08_18_38_08 + ``` - If the following information is returned, the data is restored successfully. - ```bash - restore successed - ``` + If the following information is returned, the data is restored successfully. + ```bash + Restore succeed. + ``` - The parameters are as follows. + !!! caution - | Parameter | Required | Default value | Description | Data type | - | --- | --- | --- | --- | --- | - | --concurrent | No | 5 | The maximum number of concurrency for Alibaba Cloud OSS. | int | - | --extra_args | No | None | The parameters of backup storage tools (OSS/HDFS/S3) for backup. | string | - | -h,-help | No | None | Checks help for restoration. | - | - | --meta | Yes | None | The IP address and port of the meta service. | string | - | --name | Yes | None | The backup name. | string | - | --storage | Yes | None | The target storage url of BR backup data. | string | - | --user | Yes | None | The username to login into the hosts where meta/storage service is located. | string | + If your new cluster hosts' ip are not all the same with the backup cluster, after restore, you should use `add hosts` to add the Storage hosts in the new cluster one by one. + + The parameters are as follows. + + | Parameter | Data type | Required | Default value | Description | + | --- | --- | --- | --- | --- | + | `-h,-help` | - | No | None | Checks help for restoration. | + | `-debug` | - | No | None | Checks for more log information. | + | `-log` | string | No | br.log | Specify br detail log path. | + | `-meta` | string | Yes | None | The IP address and port of the meta service. | + | `-name` | string | Yes | None | The name of backup. | + | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Set access key id. | + | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | + | `--s3.region` | string | No | None | Set region or location to upload or download backup. | + | `--s3.secret_key` | string | No | None | Set secret key for access id. | + +3. Run the following command to clean up temporary files if any error occurred during backup. It will clean the files in cluster and external storage. You could also use it to clean up old backups files in external storage. + + ```bash + $ ./bin/br cleanup --meta --storage --name + ``` + + The parameters are as follows. + + | Parameter | Data type | Required | Default value | Description | + | --- | --- | --- | --- | --- | + | `-h,-help` | - | No | None | Checks help for restoration. | + | `-debug` | - | No | None | Checks for more log information. | + | `-log` | string | No | br.log | Specify br detail log path. | + | `-meta` | string | Yes | None | The IP address and port of the meta service. | + | `-name` | string | Yes | None | The name of backup. | + | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Set access key id. | + | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | + | `--s3.region` | string | No | None | Set region or location to upload or download backup. | + | `--s3.secret_key` | string | No | None | Set secret key for access id. | \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 35361a25da4..321faf1aeca 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -334,11 +334,11 @@ nav: - User management: 7.data-security/1.authentication/2.management-user.md - Roles and privileges: 7.data-security/1.authentication/3.role-list.md - OpenLDAP authentication: 7.data-security/1.authentication/4.ldap.md -# - Backup & Restore: -# - What is Backup & Restore: 7.data-security/2.backup-restore/1.what-is-br.md -# - Compile BR: 7.data-security/2.backup-restore/2.compile-br.md -# - Use BR to back up data: 7.data-security/2.backup-restore/3.br-backup-data.md -# - Use BR to restore data: 7.data-security/2.backup-restore/4.br-restore-data.md + - Backup & Restore: + - What is Backup & Restore: 7.data-security/2.backup-restore/1.what-is-br.md + - Compile BR: 7.data-security/2.backup-restore/2.compile-br.md + - Use BR to back up data: 7.data-security/2.backup-restore/3.br-backup-data.md + - Use BR to restore data: 7.data-security/2.backup-restore/4.br-restore-data.md - Manage snapshots: 7.data-security/3.manage-snapshot.md - SSL: 7.data-security/4.ssl.md @@ -546,7 +546,6 @@ plugins: # Exclude files with unix-style wildcards (globs) glob: # Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. - - 7.data-security/2.backup-restore/* - nebula-flink/* - CHANGELOG.md - spark-connector/* From efa86a78a6d393fe23b7567b4701d62f400dc396 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 15 Feb 2022 15:28:20 +0800 Subject: [PATCH 2/8] Update 2.compile-br.md --- docs-2.0/7.data-security/2.backup-restore/2.compile-br.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md b/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md index a40300956d8..8f299f2192e 100644 --- a/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md +++ b/docs-2.0/7.data-security/2.backup-restore/2.compile-br.md @@ -36,7 +36,4 @@ Users can enter `bin/br version` on the command line. If the following results a ```bash [nebula-br]$ bin/br version Nebula Backup And Restore Utility Tool,V-0.6.0 - GitSha: 079e7c7 - GitRef: master -please run "help" subcommand for more infomation. ``` From 38bfef2e4eb680c55337934fb54e335c31e8c51b Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:09:17 +0800 Subject: [PATCH 3/8] Update docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index 5aa71d565b7..0849cc4e6e4 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -20,7 +20,7 @@ To restore data with the BR, do a check of these: - No application is connected to the target Nebula Graph cluster. -- Make sure that the target and the source Nebula Graph clusters have the same topology, which means that they have exactly the same number of hosts. The number of data folders for each host is consistently distributed. +- Make sure that the target and the source Nebula Graph clusters have the same topology, which means that they have exactly the same number of hosts. The number of data folders for each host is consistently distributed. ## Procedures From 823e3ac14a79a009011d2ffe49b15e33a216beac Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:09:24 +0800 Subject: [PATCH 4/8] Update docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index 0849cc4e6e4..e2e8590dcb9 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -29,7 +29,7 @@ To restore data with the BR, do a check of these: ```bash $ ./bin/br show --storage ``` - For example, use the following command to list the backup information in the local `/home/nebula/backup` path. + For example, run the following command to list the backup information in the local `/home/nebula/backup` path. ```bash $ ./bin/br show --storage "local:///home/nebula/backup" +----------------------------+---------------------+------------------------+-------------+------------+ From 7aa48a4b95badfb084737e4625589e6f21f3e5b8 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:09:40 +0800 Subject: [PATCH 5/8] Update docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index e2e8590dcb9..e8b113f2345 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -40,7 +40,7 @@ To restore data with the BR, do a check of these: +----------------------------+---------------------+------------------------+-------------+------------+ ``` - Or, you can use the following command to list the backup information in S3 URL `s3://127.0.0.1:9000/br-test/backup`. + Or, you can run the following command to list the backup information stored in S3 URL `s3://127.0.0.1:9000/br-test/backup`. ```bash $ ./bin/br show --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default ``` From 81be061d6660be8b0883ac571fcb9ce796f395a1 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:09:48 +0800 Subject: [PATCH 6/8] Update docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index e8b113f2345..7fdc0259f91 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -63,7 +63,7 @@ To restore data with the BR, do a check of these: $ ./bin/br restore full --meta --storage --name ``` - For example, use the following command to upload the backup files in the local `/home/nebula/backup/` to the cluster where the meta service's address is `127.0.0.1:9559`. + For example, run the following command to upload the backup files from the local `/home/nebula/backup/` to the cluster where the meta service's address is `127.0.0.1:9559`. ``` $ ./bin/br restore full --meta "127.0.0.1:9559" --storage "local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08 From e9afef72edf26e6d433e67f9651bd7bffadf889b Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:09:56 +0800 Subject: [PATCH 7/8] Update docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index 7fdc0259f91..2b65d343db9 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -69,7 +69,7 @@ To restore data with the BR, do a check of these: $ ./bin/br restore full --meta "127.0.0.1:9559" --storage "local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08 ``` - Or, you can use the following command to upload the backup files in S3 URL `s3://127.0.0.1:9000/br-test/backup`. + Or, you can run the following command to upload the backup files from the S3 URL `s3://127.0.0.1:9000/br-test/backup`. ```bash $ ./bin/br restore full --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region="default" --name BACKUP_2021_12_08_18_38_08 ``` From 2676c9f015c38be6a1903c0ba2ed8a41cdd3c6a7 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 16 Feb 2022 11:18:04 +0800 Subject: [PATCH 8/8] Update 4.br-restore-data.md --- .../2.backup-restore/4.br-restore-data.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md index 2b65d343db9..6074b4e56cf 100644 --- a/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md +++ b/docs-2.0/7.data-security/2.backup-restore/4.br-restore-data.md @@ -49,12 +49,12 @@ To restore data with the BR, do a check of these: | --- | --- | --- | --- | --- | | `-h,-help` | - | No | None | Checks help for restoration. | | `-debug` | - | No | None | Checks for more log information. | - | `-log` | string | No | br.log | Specify br detail log path. | - | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: ://.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | - | `--s3.access_key` | string | No | None | Set access key id. | - | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | - | `--s3.region` | string | No | None | Set region or location to upload or download backup. | - | `--s3.secret_key` | string | No | None | Set secret key for access id. | + | `-log` | string | No | br.log | Specifies detailed log path for restoration and backup. | + | `--storage` | string | Yes | None | The target storage URL of BR backup data. The format is: ://.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Sets AccessKey ID. | + | `--s3.endpoint` | string | No | None | Sets the S3 endpoint URL, please specify the HTTP or HTTPS scheme explicitly. | + | `--s3.region` | string | No | None | Sets the region or location to upload or download the backup. | + | `--s3.secret_key` | string | No | None | Sets SecretKey for AccessKey ID. | 2. Run the following command to restore data. @@ -81,7 +81,7 @@ To restore data with the BR, do a check of these: !!! caution - If your new cluster hosts' ip are not all the same with the backup cluster, after restore, you should use `add hosts` to add the Storage hosts in the new cluster one by one. + If your new cluster hosts' IPs are not all the same as the backup cluster, after restoration, you should run `add hosts` to add the Storage host IPs in the new cluster one by one. The parameters are as follows. @@ -89,14 +89,14 @@ To restore data with the BR, do a check of these: | --- | --- | --- | --- | --- | | `-h,-help` | - | No | None | Checks help for restoration. | | `-debug` | - | No | None | Checks for more log information. | - | `-log` | string | No | br.log | Specify br detail log path. | + | `-log` | string | No | br.log | Specifies detailed log path for restoration and backup. | | `-meta` | string | Yes | None | The IP address and port of the meta service. | | `-name` | string | Yes | None | The name of backup. | - | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | - | `--s3.access_key` | string | No | None | Set access key id. | - | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | - | `--s3.region` | string | No | None | Set region or location to upload or download backup. | - | `--s3.secret_key` | string | No | None | Set secret key for access id. | + | `--storage` | string | Yes | None | The target storage URL of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Sets AccessKey ID. | + | `--s3.endpoint` | string | No | None | Sets the S3 endpoint URL, please specify the HTTP or HTTPS scheme explicitly. | + | `--s3.region` | string | No | None | Sets the region or location to upload or download the backup. | + | `--s3.secret_key` | string | No | None | Sets SecretKey for AccessKey ID. | 3. Run the following command to clean up temporary files if any error occurred during backup. It will clean the files in cluster and external storage. You could also use it to clean up old backups files in external storage. @@ -110,11 +110,11 @@ To restore data with the BR, do a check of these: | --- | --- | --- | --- | --- | | `-h,-help` | - | No | None | Checks help for restoration. | | `-debug` | - | No | None | Checks for more log information. | - | `-log` | string | No | br.log | Specify br detail log path. | + | `-log` | string | No | br.log | Specifies detailed log path for restoration and backup. | | `-meta` | string | Yes | None | The IP address and port of the meta service. | | `-name` | string | Yes | None | The name of backup. | - | `--storage` | string | Yes | None | The target storage url of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | - | `--s3.access_key` | string | No | None | Set access key id. | - | `--s3.endpoint` | string | No | None | Set the S3 endpoint URL, please specify the http or https scheme explicitly. | - | `--s3.region` | string | No | None | Set region or location to upload or download backup. | - | `--s3.secret_key` | string | No | None | Set secret key for access id. | \ No newline at end of file + | `--storage` | string | Yes | None | The target storage URL of BR backup data. The format is: \://\.
Schema: Optional values are `local` and `s3`.
When selecting s3, you need to fill in `s3.access_key`, `s3.endpoint`, `s3.region`, and `s3.secret_key`.
PATH: The path of the storage location. | + | `--s3.access_key` | string | No | None | Sets AccessKey ID. | + | `--s3.endpoint` | string | No | None | Sets the S3 endpoint URL, please specify the HTTP or HTTPS scheme explicitly. | + | `--s3.region` | string | No | None | Sets the region or location to upload or download the backup. | + | `--s3.secret_key` | string | No | None | Sets SecretKey for AccessKey ID. | \ No newline at end of file