update log backup user docs #2641
Open
+698
−33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ti-chi-bot
bot
added
the
first-time-contributor
|
|
ti-chi-bot
bot
added
missing-translation-status
csuzhangxc
reviewed
Nov 5, 2024
Co-authored-by: Xuecheng Zhang <csuzhangxc@gmail.com>
Co-authored-by: Xuecheng Zhang <csuzhangxc@gmail.com>
ti-chi-bot
bot
added
size/XL
csuzhangxc
reviewed
Nov 18, 2024
Co-authored-by: Xuecheng Zhang <csuzhangxc@gmail.com>
csuzhangxc
reviewed
Nov 28, 2024
ti-chi-bot
bot
added
size/XXL
csuzhangxc
reviewed
Nov 28, 2024
Co-authored-by: Cody (Xuecheng) Zhang <csuzhangxc@gmail.com>
Co-authored-by: Cody (Xuecheng) Zhang <csuzhangxc@gmail.com>
Co-authored-by: Cody (Xuecheng) Zhang <csuzhangxc@gmail.com>
Oreoxmt
reviewed
Dec 25, 2024
| kubectl edit backup demo1-log-backup-s3 -n backup-test | ||
| ``` | ||
|
|
||
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： | |
| 要恢复日志备份任务，只需将 `logSubcommand` 的值从 `log-pause` 更改为 `log-start`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
| prefix: my-log-backup-folder | ||
| ``` | ||
|
|
||
| 可以看到名为 demo1-log-backup-s3 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： |
There was a problem hiding this comment.
Suggested change
| 可以看到名为 demo1-log-backup-s3 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： | |
| 可以看到名为 `demo1-log-backup-s3` 的 Backup CR 的 `STATUS` 从 `Paused` 状态变为 `Running`： |
Oreoxmt
reviewed
Dec 25, 2024
| #### 停止日志备份 | ||
|
|
||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-s3` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，来激活停止日志备份的操作。操作激活优先级从高到低分别是停止日志备份任务、删除日志备份数据和开启日志备份任务。 | ||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-s3` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，停止日志备份。 |
There was a problem hiding this comment.
Suggested change
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-s3` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，停止日志备份。 | |
| 你可以通过将 Backup 自定义资源 (CR) 的 `logSubcommand` 字段设置为 `log-stop` 来停止日志备份。下面以停止[启动日志备份](#启动日志备份)中创建的名为 `demo1-log-backup-s3` 的 CR 为例。 |
Oreoxmt
reviewed
Dec 25, 2024
|
|
||
| ```shell | ||
| kubectl edit backup demo1-log-backup-s3 -n backup-test | ||
| ``` | ||
|
|
||
| 在最后新增一行字段 `spec.logStop: true`，保存并退出。更新后的内容如下： | ||
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： | |
| 将 `logSubcommand` 的值修改为 `log-stop`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+456
to
+458
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | ||
|
|
||
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 |
There was a problem hiding this comment.
Suggested change
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | |
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | |
| `Stopped` 是日志备份的终止状态。在此状态下，无法再次更改备份状态，但你仍然可以清理日志备份数据。 | |
| 在 TiDB Operator v1.5.4、v1.6.0 及之前版本中，可以使用 `logStop: true/false` 字段来停止或启动日志备份任务。此字段仍然保留以确保向后兼容。 | |
Oreoxmt
reviewed
Dec 25, 2024
| @@ -144,6 +144,24 @@ demo1-full-backup-gcs full snapshot Complete gcs://my-bucket/my-full-bac | |||
|
|
|||
| 你可以使用一个 `Backup` CR 来描述日志备份任务的启动、停止以及清理日志备份数据等操作。日志备份对远程存储访问授权方式与快照备份一致。本节示例创建了名为 `demo1-log-backup-gcs` 的 `Backup` CR，具体操作如下所示。 | |||
|
|
|||
| #### 日志备份的`logSubcommand` | |||
There was a problem hiding this comment.
Suggested change
| #### 日志备份的`logSubcommand` | |
| #### `logSubcommand` 字段说明 |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+149
to
+157
| Backup 自定义资源（CR）中的 logSubcommand 字段允许你控制日志备份任务的状态。logSubcommand 有三个有效输入： | ||
|
|
||
| - log-start：该命令用于启动新的日志备份任务，或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 | ||
|
|
||
| - log-pause：该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 | ||
|
|
||
| - log-stop：该命令永久停止日志备份任务。当执行此命令时，Backup CR 将进入停止状态且无法重启。 | ||
|
|
||
| 这些命令使日志备份任务的生命周期控制更加精细，支持启动、暂停、恢复和停止操作，以管理 Kubernetes 环境中的日志数据保留。 |
There was a problem hiding this comment.
Suggested change
| Backup 自定义资源（CR）中的 logSubcommand 字段允许你控制日志备份任务的状态。logSubcommand 有三个有效输入： | |
| - log-start：该命令用于启动新的日志备份任务，或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 | |
| - log-pause：该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 | |
| - log-stop：该命令永久停止日志备份任务。当执行此命令时，Backup CR 将进入停止状态且无法重启。 | |
| 这些命令使日志备份任务的生命周期控制更加精细，支持启动、暂停、恢复和停止操作，以管理 Kubernetes 环境中的日志数据保留。 | |
| 在 Backup 自定义资源 (CR) 中，你可以使用 `logSubcommand` 字段控制日志备份任务的状态。`logSubcommand` 支持以下三个命令： | |
| - `log-start`：该命令用于启动新的日志备份任务，或恢复已暂停的任务。使用此命令可以开始日志备份流程，或从暂停状态恢复任务。 | |
| - `log-pause`：该命令用于暂停当前正在进行的日志备份任务。暂停任务后，你可以使用 `log-start` 命令恢复任务。 | |
| - `log-stop`：该命令用于永久停止日志备份任务。执行此命令后，Backup CR 会进入停止状态，且无法再次启动。 | |
| 这些命令提供了对日志备份任务生命周期的精细控制，支持启动、暂停、恢复和停止操作，帮助有效管理 Kubernetes 环境中的日志数据保留。 |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+160
to
+162
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | ||
|
|
||
| 但请勿在同一个 Backup CR 混用 logStop 和 logSubcommand，这属于不支持的用法。在较新版本中，不推荐使用 logStop，建议使用 logSubcommand 以确保配置清晰且一致。 |
There was a problem hiding this comment.
Suggested change
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | |
| 但请勿在同一个 Backup CR 混用 logStop 和 logSubcommand，这属于不支持的用法。在较新版本中，不推荐使用 logStop，建议使用 logSubcommand 以确保配置清晰且一致。 | |
| 在 TiDB Operator v1.5.4、v1.6.0 及之前版本中，可以使用 `logStop: true/false` 字段来停止或启动日志备份任务。此字段仍然保留以确保向后兼容。 | |
| 但是，请勿在同一个 Backup CR 中同时使用 `logStop` 和 `logSubcommand` 字段，这属于不支持的用法。对于 TiDB Operator v1.5.5、v1.6.1 及之后版本，推荐使用 `logSubcommand` 以确保配置清晰且一致。 | |
Oreoxmt
reviewed
Dec 25, 2024
| @@ -223,15 +241,99 @@ Conditions: | |||
| Log Checkpoint Ts: 436569119308644661 | |||
| ``` | |||
|
|
|||
| #### 暂停日志备份 | |||
|
|
|||
| 由于在启动日志备份时已经创建了名为 `demo1-log-backup-gcs` 的 Backup 自定义资源（CR），可以通过修改相同的 Backup CR 来暂停日志备份。 | |||
There was a problem hiding this comment.
Suggested change
| 由于在启动日志备份时已经创建了名为 `demo1-log-backup-gcs` 的 Backup 自定义资源（CR），可以通过修改相同的 Backup CR 来暂停日志备份。 | |
| 你可以通过将 Backup 自定义资源 (CR) 的 `logSubcommand` 字段设置为 `log-pause` 来暂停日志备份任务。下面以暂停[启动日志备份](#启动日志备份)中创建的名为 `demo1-log-backup-gcs` 的 CR 为例。 |
Oreoxmt
reviewed
Dec 25, 2024
| kubectl edit backup demo1-log-backup-gcs -n backup-test | ||
| ``` | ||
|
|
||
| 要暂停日志备份任务，只需将 logSubcommand 从 log-start 更改为 log-pause。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 要暂停日志备份任务，只需将 logSubcommand 从 log-start 更改为 log-pause。然后保存并退出编辑器。修改后的内容如下： | |
| 要暂停日志备份任务，只需将 `logSubcommand` 的值从 `log-start` 修改为 `log-pause`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
|
|
||
| #### 恢复日志备份 | ||
|
|
||
| 如果日志备份任务已暂停，可以将 logSubcommand 设置为 log-start 来恢复它。请注意，你无法从 Fail 或 Stopped 状态恢复任务。 |
There was a problem hiding this comment.
Suggested change
| 如果日志备份任务已暂停，可以将 logSubcommand 设置为 log-start 来恢复它。请注意，你无法从 Fail 或 Stopped 状态恢复任务。 | |
| 如果日志备份任务已暂停，你可以通过将 `logSubcommand` 字段设置为 `log-start` 来恢复该任务。下面以恢复[暂停日志备份](#暂停日志备份)中已暂停的 `demo1-log-backup-gcs` CR 为例。 | |
| > **Note:** | |
| > | |
| > 此操作仅适用于处于暂停状态 (`Pause`) 的任务，无法恢复状态为 `Fail` 或 `Stopped` 的任务。 |
Oreoxmt
reviewed
Dec 25, 2024
| kubectl edit backup demo1-log-backup-gcs -n backup-test | ||
| ``` | ||
|
|
||
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： | |
| 要恢复日志备份任务，只需将 `logSubcommand` 的值从 `log-pause` 更改为 `log-start`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
| prefix: my-log-backup-folder | ||
| ``` | ||
|
|
||
| 可以看到名为 demo1-log-backup-gcs 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： |
There was a problem hiding this comment.
Suggested change
| 可以看到名为 demo1-log-backup-gcs 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： | |
| 可以看到名为 `demo1-log-backup-gcs` 的 Backup CR 的 `STATUS` 从 `Paused` 状态变为 `Running`： |
Oreoxmt
reviewed
Dec 25, 2024
| #### 停止日志备份 | ||
|
|
||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-gcs` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，来激活停止日志备份的操作。操作激活优先级从高到低分别是停止日志备份任务、删除日志备份数据和开启日志备份任务。 | ||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-gcs` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，来激活停止日志备份的操作。 |
There was a problem hiding this comment.
Suggested change
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-gcs` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，来激活停止日志备份的操作。 | |
| 你可以通过将 Backup 自定义资源 (CR) 的 `logSubcommand` 字段设置为 `log-stop` 来停止日志备份。下面以停止[启动日志备份](#启动日志备份)中创建的名为 `demo1-log-backup-gcs` 的 CR 为例。 |
Oreoxmt
reviewed
Dec 25, 2024
|
|
||
| ```shell | ||
| kubectl edit backup demo1-log-backup-gcs -n backup-test | ||
| ``` | ||
|
|
||
| 在最后新增一行字段 `spec.logStop: true`，保存并退出。更新后的内容如下： | ||
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： | |
| 将 `logSubcommand` 的值修改为 `log-stop`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+372
to
+374
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | ||
|
|
||
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 |
There was a problem hiding this comment.
Suggested change
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | |
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | |
| `Stopped` 是日志备份的终止状态。在此状态下，无法再次更改备份状态，但你仍然可以清理日志备份数据。 | |
| 在 TiDB Operator v1.5.4、v1.6.0 及之前版本中，可以使用 `logStop: true/false` 字段来停止或启动日志备份任务。此字段仍然保留以确保向后兼容。 |
Oreoxmt
reviewed
Dec 25, 2024
| @@ -140,6 +140,24 @@ demo1-full-backup-azblob full snapshot Complete azure://my-container/my- | |||
|
|
|||
| 你可以使用一个 `Backup` CR 来描述日志备份任务的启动、停止以及清理日志备份数据等操作。本节示例创建了名为 `demo1-log-backup-azblob` 的 `Backup` CR。具体操作如下所示。 | |||
|
|
|||
| #### 日志备份的`logSubcommand` | |||
There was a problem hiding this comment.
Suggested change
| #### 日志备份的`logSubcommand` | |
| #### `logSubcommand` 字段说明 |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+145
to
+153
| Backup 自定义资源（CR）中的 logSubcommand 字段允许你控制日志备份任务的状态。logSubcommand 有三个有效输入： | ||
|
|
||
| - log-start：该命令用于启动新的日志备份任务，或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 | ||
|
|
||
| - log-pause：该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 | ||
|
|
||
| - log-stop：该命令永久停止日志备份任务。当执行此命令时，Backup CR 将进入停止状态且无法重启。 | ||
|
|
||
| 这些命令使日志备份任务的生命周期控制更加精细，支持启动、暂停、恢复和停止操作，以管理 Kubernetes 环境中的日志数据保留。 |
There was a problem hiding this comment.
Suggested change
| Backup 自定义资源（CR）中的 logSubcommand 字段允许你控制日志备份任务的状态。logSubcommand 有三个有效输入： | |
| - log-start：该命令用于启动新的日志备份任务，或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 | |
| - log-pause：该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 | |
| - log-stop：该命令永久停止日志备份任务。当执行此命令时，Backup CR 将进入停止状态且无法重启。 | |
| 这些命令使日志备份任务的生命周期控制更加精细，支持启动、暂停、恢复和停止操作，以管理 Kubernetes 环境中的日志数据保留。 | |
| 在 Backup 自定义资源 (CR) 中，你可以使用 `logSubcommand` 字段控制日志备份任务的状态。`logSubcommand` 支持以下三个命令： | |
| - `log-start`：该命令用于启动新的日志备份任务，或恢复已暂停的任务。使用此命令可以开始日志备份流程，或从暂停状态恢复任务。 | |
| - `log-pause`：该命令用于暂停当前正在进行的日志备份任务。暂停任务后，你可以使用 `log-start` 命令恢复任务。 | |
| - `log-stop`：该命令用于永久停止日志备份任务。执行此命令后，Backup CR 会进入停止状态，且无法再次启动。 | |
| 这些命令提供了对日志备份任务生命周期的精细控制，支持启动、暂停、恢复和停止操作，帮助有效管理 Kubernetes 环境中的日志数据保留。 |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+156
to
+158
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | ||
|
|
||
| 但请勿在同一个 Backup CR 中混用 logStop 和 logSubcommand，这属于不支持的用法。在较新版本中，不推荐使用 logStop，建议使用 logSubcommand 以确保配置清晰且一致。 |
There was a problem hiding this comment.
Suggested change
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | |
| 但请勿在同一个 Backup CR 中混用 logStop 和 logSubcommand，这属于不支持的用法。在较新版本中，不推荐使用 logStop，建议使用 logSubcommand 以确保配置清晰且一致。 | |
| 在 TiDB Operator v1.5.4、v1.6.0 及之前版本中，可以使用 `logStop: true/false` 字段来停止或启动日志备份任务。此字段仍然保留以确保向后兼容。 | |
| 但是，请勿在同一个 Backup CR 中同时使用 `logStop` 和 `logSubcommand` 字段，这属于不支持的用法。对于 TiDB Operator v1.5.5、v1.6.1 及之后版本，推荐使用 `logSubcommand` 以确保配置清晰且一致。 | |
Oreoxmt
reviewed
Dec 25, 2024
| @@ -219,15 +237,107 @@ Conditions: | |||
| Log Checkpoint Ts: 436569119308644661 | |||
| ``` | |||
|
|
|||
| #### 暂停日志备份 | |||
|
|
|||
| 由于在启动日志备份时已经创建了名为 `demo1-log-backup-azblob` 的 Backup 自定义资源（CR），可以通过修改相同的 Backup CR 来暂停日志备份。 | |||
There was a problem hiding this comment.
Suggested change
| 由于在启动日志备份时已经创建了名为 `demo1-log-backup-azblob` 的 Backup 自定义资源（CR），可以通过修改相同的 Backup CR 来暂停日志备份。 | |
| 你可以通过将 Backup 自定义资源 (CR) 的 `logSubcommand` 字段设置为 `log-pause` 来暂停日志备份任务。下面以暂停[启动日志备份](#启动日志备份)中创建的名为 `demo1-log-backup-azblob` 的 CR 为例。 |
Oreoxmt
reviewed
Dec 25, 2024
| kubectl edit backup demo1-log-backup-azblob -n backup-test | ||
| ``` | ||
|
|
||
| 要暂停日志备份任务，只需将 logSubcommand 从 log-start 更改为 log-pause。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 要暂停日志备份任务，只需将 logSubcommand 从 log-start 更改为 log-pause。然后保存并退出编辑器。修改后的内容如下： | |
| 要暂停日志备份任务，只需将 `logSubcommand` 的值从 `log-start` 修改为 `log-pause`，然后保存并退出编辑器。 |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+250
to
+252
| ```shell | ||
| kubectl apply -f log-backup-azblob.yaml | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ```shell | |
| kubectl apply -f log-backup-azblob.yaml | |
| ``` | |
| ```shell | |
| kubectl apply -f log-backup-azblob.yaml | |
| ``` |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+254
to
+276
| `log-backup-azblob.yaml` 文件内容如下： | ||
|
|
||
| ```yaml | ||
| --- | ||
| apiVersion: pingcap.com/v1alpha1 | ||
| kind: Backup | ||
| metadata: | ||
| name: demo1-log-backup-azblob | ||
| namespace: backup-test | ||
| spec: | ||
| backupMode: log | ||
| logSubcommand: log-pause | ||
| br: | ||
| cluster: demo1 | ||
| clusterNamespace: test1 | ||
| sendCredToTikv: true | ||
| s3: | ||
| provider: aws | ||
| secretName: s3-secret | ||
| region: us-west-1 | ||
| bucket: my-bucket | ||
| prefix: my-log-backup-folder | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| `log-backup-azblob.yaml` 文件内容如下： | |
| ```yaml | |
| --- | |
| apiVersion: pingcap.com/v1alpha1 | |
| kind: Backup | |
| metadata: | |
| name: demo1-log-backup-azblob | |
| namespace: backup-test | |
| spec: | |
| backupMode: log | |
| logSubcommand: log-pause | |
| br: | |
| cluster: demo1 | |
| clusterNamespace: test1 | |
| sendCredToTikv: true | |
| s3: | |
| provider: aws | |
| secretName: s3-secret | |
| region: us-west-1 | |
| bucket: my-bucket | |
| prefix: my-log-backup-folder | |
| ``` | |
| 修改后 `log-backup-azblob.yaml` 文件内容如下： | |
| ```yaml | |
| --- | |
| apiVersion: pingcap.com/v1alpha1 | |
| kind: Backup | |
| metadata: | |
| name: demo1-log-backup-azblob | |
| namespace: backup-test | |
| spec: | |
| backupMode: log | |
| logSubcommand: log-pause | |
| br: | |
| cluster: demo1 | |
| clusterNamespace: test1 | |
| sendCredToTikv: true | |
| s3: | |
| provider: aws | |
| secretName: s3-secret | |
| region: us-west-1 | |
| bucket: my-bucket | |
| prefix: my-log-backup-folder | |
| ``` |
There was a problem hiding this comment.
这部分应修改为 azblob
s3:
provider: aws
secretName: s3-secret
region: us-west-1
bucket: my-bucket
prefix: my-log-backup-folder
Oreoxmt
reviewed
Dec 25, 2024
|
|
||
| #### 恢复日志备份 | ||
|
|
||
| 如果日志备份任务已暂停，可以将 logSubcommand 设置为 log-start 来恢复它。请注意，你无法从 Fail 或 Stopped 状态恢复任务。 |
There was a problem hiding this comment.
Suggested change
| 如果日志备份任务已暂停，可以将 logSubcommand 设置为 log-start 来恢复它。请注意，你无法从 Fail 或 Stopped 状态恢复任务。 | |
| 如果日志备份任务已暂停，你可以通过将 `logSubcommand` 字段设置为 `log-start` 来恢复该任务。下面以恢复[暂停日志备份](#暂停日志备份)中已暂停的 `demo1-log-backup-azblob` CR 为例。 | |
| > **Note:** | |
| > | |
| > 此操作仅适用于处于暂停状态 (`Pause`) 的任务，无法恢复状态为 `Fail` 或 `Stopped` 的任务。 |
Oreoxmt
reviewed
Dec 25, 2024
| kubectl edit backup demo1-log-backup-azblob -n backup-test | ||
| ``` | ||
|
|
||
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 要恢复日志备份任务，只需将 logSubcommand 从 log-pause 更改为 log-start。然后保存并退出编辑器。修改后的内容如下： | |
| 要恢复日志备份任务，只需将 `logSubcommand` 的值从 `log-pause` 更改为 `log-start`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
| cluster: demo1 | ||
| clusterNamespace: test1 | ||
| sendCredToTikv: true | ||
| s3: |
Oreoxmt
reviewed
Dec 25, 2024
| prefix: my-log-backup-folder | ||
| ``` | ||
|
|
||
| 可以看到名为 demo1-log-backup-azblob 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： |
There was a problem hiding this comment.
Suggested change
| 可以看到名为 demo1-log-backup-azblob 的 Backup CR 的 STATUS 从 Paused 状态变为 Running： | |
| 可以看到名为 `demo1-log-backup-azblob` 的 Backup CR 的 `STATUS` 从 `Paused` 状态变为 `Running`： |
Oreoxmt
reviewed
Dec 25, 2024
| #### 停止日志备份 | ||
|
|
||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-azblob` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，来激活停止日志备份的操作。操作激活优先级从高到低分别是停止日志备份任务、删除日志备份数据和开启日志备份任务。 | ||
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-azblob` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，停止日志备份。 |
There was a problem hiding this comment.
Suggested change
| 由于你在开启日志备份的时候已经创建了名为 `demo1-log-backup-azblob` 的 `Backup` CR，因此可以直接更新该 `Backup` CR 的配置，停止日志备份。 | |
| 你可以通过将 Backup 自定义资源 (CR) 的 `logSubcommand` 字段设置为 `log-stop` 来停止日志备份。下面以停止[启动日志备份](#启动日志备份)中创建的名为 `demo1-log-backup-azblob` 的 CR 为例。 |
Oreoxmt
reviewed
Dec 25, 2024
|
|
||
| ```shell | ||
| kubectl edit backup demo1-log-backup-azblob -n backup-test | ||
| ``` | ||
|
|
||
| 在最后新增一行字段 `spec.logStop: true`，保存并退出。更新后的内容如下： | ||
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： |
There was a problem hiding this comment.
Suggested change
| 将 logSubcommand 更改为 log-stop。然后保存并退出编辑器。修改后的内容如下： | |
| 将 `logSubcommand` 的值修改为 `log-stop`，然后保存并退出编辑器。修改后的内容如下： |
Oreoxmt
reviewed
Dec 25, 2024
Comment on lines
+375
to
+377
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | ||
|
|
||
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 |
There was a problem hiding this comment.
Suggested change
| Stopped 是日志备份的终止状态，此状态下无法再次更改状态，但你仍然可以清理日志备份的数据。 | |
| 在 v1.5.4/v1.6.0 及更早版本的 TiDB Operator 中，可以使用 logStop: true/false 字段来停止或启动任务。此字段为了向后兼容而保留。 | |
| `Stopped` 是日志备份的终止状态。在此状态下，无法再次更改备份状态，但你仍然可以清理日志备份数据。 | |
| 在 TiDB Operator v1.5.4、v1.6.0 及之前版本中，可以使用 `logStop: true/false` 字段来停止或启动日志备份任务。此字段仍然保留以确保向后兼容。 | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First-time contributors' checklist
What is changed, added, or deleted? (Required)
Added the description of new TiDB operator interface, including:
Which TiDB Operator version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?