From 10815fdc0ccc266e7e069578d298f6bbcbe03fb2 Mon Sep 17 00:00:00 2001 From: hillium Date: Fri, 7 Mar 2025 11:44:17 +0800 Subject: [PATCH 1/5] added translation (by Claude 3.7 Sonnet Thinking) --- br/br-pitr-manual.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index 22711ce5dffdd..f9d91d5807834 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -493,3 +493,18 @@ tiup br restore point --pd="${PD_IP}:2379" --master-key-crypter-method aes128-ctr --master-key "local:///path/to/master.key" ``` + +### Compatibility between Ongoing Log Backup and Restore Introduced in v9.0.0 + +Starting from v9.0.0, when a log backup task exists, if the following conditions are met, snapshot restore (`br restore [full|database|table]`) can be performed normally, and the restored content can be properly recorded by the ongoing log backup: + +- The node executing BR, in addition to having the necessary permissions to access the external storage for snapshot restoration, also needs to have write permissions to the log backup target external storage. +- The log backup target external storage type is S3 (`s3://`), GCS (`gcs://`), or Azure Blob Storage (`azblob://`). +- Storage of the data to be restored and the log backup target storage have the same external storage type. +- Neither the data to be restored nor the log backup has enabled local encryption: refer to [Log Backup Encryption](#encrypt-the-log-backup-data) and [Snapshot Backup Encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data). + +If these conditions are not met or if you want to restore to a specific point in time, BR will refuse to restore when a log backup task exists. In this case, you can [stop the backup task](#stop-a-log-backup-task) and after restoration is complete, perform a new snapshot backup and [restart the backup task](#restart-a-log-backup-task) to complete the restoration. + +> **Note:** +> +> When restoring log backups that have recorded full restorations, you also need to use BR version `v9.0.0` or higher. Otherwise, the recorded full restoration may not be recoverable. \ No newline at end of file From 214db76868d5b23134a589a39ee5d0722384fca0 Mon Sep 17 00:00:00 2001 From: hillium Date: Fri, 7 Mar 2025 11:57:33 +0800 Subject: [PATCH 2/5] tweaking some terms --- br/br-pitr-manual.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index f9d91d5807834..23b2c65df5cbd 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -498,13 +498,13 @@ tiup br restore point --pd="${PD_IP}:2379" Starting from v9.0.0, when a log backup task exists, if the following conditions are met, snapshot restore (`br restore [full|database|table]`) can be performed normally, and the restored content can be properly recorded by the ongoing log backup: -- The node executing BR, in addition to having the necessary permissions to access the external storage for snapshot restoration, also needs to have write permissions to the log backup target external storage. +- The node executing BR, in addition to having the necessary permissions to access the external storage for snapshot restore, also needs to have write permissions to the log backup target external storage. - The log backup target external storage type is S3 (`s3://`), GCS (`gcs://`), or Azure Blob Storage (`azblob://`). - Storage of the data to be restored and the log backup target storage have the same external storage type. - Neither the data to be restored nor the log backup has enabled local encryption: refer to [Log Backup Encryption](#encrypt-the-log-backup-data) and [Snapshot Backup Encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data). -If these conditions are not met or if you want to restore to a specific point in time, BR will refuse to restore when a log backup task exists. In this case, you can [stop the backup task](#stop-a-log-backup-task) and after restoration is complete, perform a new snapshot backup and [restart the backup task](#restart-a-log-backup-task) to complete the restoration. +If these conditions are not met or if you want to do a point in time restore (`br restore point`), BR will refuse to restore when a log backup task exists. In this case, you can [stop the backup task](#stop-a-log-backup-task) and after restoration is complete, perform a new snapshot backup and [restart the backup task](#restart-a-log-backup-task) to complete the restoration. > **Note:** > -> When restoring log backups that have recorded full restorations, you also need to use BR version `v9.0.0` or higher. Otherwise, the recorded full restoration may not be recoverable. \ No newline at end of file +> When restoring log backups that have recorded full restores, you also need to use BR version `v9.0.0` or higher. Otherwise, the recorded full restoration may not be restored. \ No newline at end of file From 37b19463bf0cf3e0fb1948547d5430da223cd3a8 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Wed, 9 Apr 2025 15:56:48 +0800 Subject: [PATCH 3/5] Refine wording and format Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- br/br-pitr-manual.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index 23b2c65df5cbd..db15e213cbe19 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -494,17 +494,22 @@ tiup br restore point --pd="${PD_IP}:2379" --master-key "local:///path/to/master.key" ``` -### Compatibility between Ongoing Log Backup and Restore Introduced in v9.0.0 +### Compatibility between ongoing log backup and snapshot restore -Starting from v9.0.0, when a log backup task exists, if the following conditions are met, snapshot restore (`br restore [full|database|table]`) can be performed normally, and the restored content can be properly recorded by the ongoing log backup: +Starting from v9.0.0, when a log backup task is running, if all of the following conditions are met, you can still perform snapshot restore (`br restore [full|database|table]`) and allow the restored data to be properly recorded by the ongoing log backup (hereinafter referred to as "log backup"): -- The node executing BR, in addition to having the necessary permissions to access the external storage for snapshot restore, also needs to have write permissions to the log backup target external storage. -- The log backup target external storage type is S3 (`s3://`), GCS (`gcs://`), or Azure Blob Storage (`azblob://`). +- The node performing backup and restore operations has necessary permissions: read access to the external storage containing the backup source for snapshot restore, and write access to the target external storage used by the log backup. +- The target external storage for the log backup is Amazon S3 (`s3://`), Google Cloud Storage (`gcs://`), or Azure Blob Storage (`azblob://`). - Storage of the data to be restored and the log backup target storage have the same external storage type. -- Neither the data to be restored nor the log backup has enabled local encryption: refer to [Log Backup Encryption](#encrypt-the-log-backup-data) and [Snapshot Backup Encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data). +- Neither the data to be restored nor the log backup has enabled local encryption. For details, see [log backup encryption](#encrypt-the-log-backup-data) and [snapshot backup encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data). -If these conditions are not met or if you want to do a point in time restore (`br restore point`), BR will refuse to restore when a log backup task exists. In this case, you can [stop the backup task](#stop-a-log-backup-task) and after restoration is complete, perform a new snapshot backup and [restart the backup task](#restart-a-log-backup-task) to complete the restoration. +If any of the above conditions are not met, or if you need to perform a point-in-time recovery, while a log backup task is running, BR refuses to proceed with the data recovery. In this case, you can complete the recovery by following these steps: + +1. [Stop the log backup task](#stop-a-log-backup-task). +2. Perform the data restore. +3. After the restore is complete, perform a new snapshot backup. +4. [Restart the log backup task](#restart-a-log-backup-task). > **Note:** > -> When restoring log backups that have recorded full restores, you also need to use BR version `v9.0.0` or higher. Otherwise, the recorded full restoration may not be restored. \ No newline at end of file +> When restoring a log backup that contains records of snapshot (full) restore data, you must use BR v9.0.0 or later. Otherwise, restoring the recorded full restore data might fail. \ No newline at end of file From d8339f31277537a518938db2041b4c05e50468b3 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Wed, 9 Apr 2025 15:57:07 +0800 Subject: [PATCH 4/5] Update wording --- br/br-pitr-manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index db15e213cbe19..f9ea5299d2851 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -500,7 +500,7 @@ Starting from v9.0.0, when a log backup task is running, if all of the following - The node performing backup and restore operations has necessary permissions: read access to the external storage containing the backup source for snapshot restore, and write access to the target external storage used by the log backup. - The target external storage for the log backup is Amazon S3 (`s3://`), Google Cloud Storage (`gcs://`), or Azure Blob Storage (`azblob://`). -- Storage of the data to be restored and the log backup target storage have the same external storage type. +- The data to be restored uses the same type of external storage as the target storage for the log backup. - Neither the data to be restored nor the log backup has enabled local encryption. For details, see [log backup encryption](#encrypt-the-log-backup-data) and [snapshot backup encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data). If any of the above conditions are not met, or if you need to perform a point-in-time recovery, while a log backup task is running, BR refuses to proceed with the data recovery. In this case, you can complete the recovery by following these steps: From 47019904f844f531c9e7b5528606da378bab1bc4 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Thu, 10 Apr 2025 10:24:54 +0800 Subject: [PATCH 5/5] Update br/br-pitr-manual.md Co-authored-by: xixirangrang --- br/br-pitr-manual.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/br/br-pitr-manual.md b/br/br-pitr-manual.md index de1a27f0bd206..b3f007c8976a1 100644 --- a/br/br-pitr-manual.md +++ b/br/br-pitr-manual.md @@ -500,7 +500,9 @@ tiup br restore point --pd="${PD_IP}:2379" Starting from v9.0.0, when a log backup task is running, if all of the following conditions are met, you can still perform snapshot restore (`br restore [full|database|table]`) and allow the restored data to be properly recorded by the ongoing log backup (hereinafter referred to as "log backup"): -- The node performing backup and restore operations has necessary permissions: read access to the external storage containing the backup source for snapshot restore, and write access to the target external storage used by the log backup. +- The node performing backup and restore operations has the following necessary permissions: + - Read access to the external storage containing the backup source, for snapshot restore + - Write access to the target external storage used by the log backup - The target external storage for the log backup is Amazon S3 (`s3://`), Google Cloud Storage (`gcs://`), or Azure Blob Storage (`azblob://`). - The data to be restored uses the same type of external storage as the target storage for the log backup. - Neither the data to be restored nor the log backup has enabled local encryption. For details, see [log backup encryption](#encrypt-the-log-backup-data) and [snapshot backup encryption](/br/br-snapshot-manual.md#encrypt-the-backup-data).