forked from Oreoxmt/pingcap-docsite-preview
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Preview PR pingcap/docs-cn#16683 and this preview is triggered from c…
…ommit pingcap/docs-cn@bb36e36
- Loading branch information
Docsite Preview Bot
committed
Mar 5, 2024
1 parent
a934d01
commit 740eccd
Showing
11 changed files
with
1,608 additions
and
4 deletions.
There are no files selected for viewing
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
141 changes: 141 additions & 0 deletions
141
markdown-pages/zh/tidb/master/dm/dm-command-line-flags.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| title: TiDB Data Migration 命令行参数 | ||
| summary: 介绍 DM 各组件的主要命令行参数。 | ||
| aliases: ['/docs-cn/tidb-data-migration/dev/command-line-flags/'] | ||
| --- | ||
|
|
||
| # TiDB Data Migration 命令行参数 | ||
|
|
||
| 本文档介绍 TiDB Data Migration (DM) 中各组件的主要命令行参数。 | ||
|
|
||
| ## DM-master | ||
|
|
||
| ### `--advertise-addr` | ||
|
|
||
| - DM-master 用于接收客户端请求的外部地址 | ||
| - 默认值为 `"{master-addr}"` | ||
| - 可选参数，可以为 `"域名:port"` 的形式 | ||
|
|
||
| ### `--advertise-peer-urls` | ||
|
|
||
| - DM-master 节点间通信的外部连接地址 | ||
| - 默认值为 `"{peer-urls}"` | ||
| - 可选参数，可以为 `"http(s)://域名:port"` 的形式 | ||
|
|
||
| ### `--config` | ||
|
|
||
| - DM-master 配置文件路径 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ### `--data-dir` | ||
|
|
||
| - DM-master 用于存储自身数据的目录 | ||
| - 默认值为 `"default.{name}"` | ||
| - 可选参数 | ||
|
|
||
| ### `--initial-cluster` | ||
|
|
||
| - 用于 bootstrap DM-master 集群的 `"{节点名}={外部地址}"` 列表 | ||
| - 默认值为 `"{name}={advertise-peer-urls}"` | ||
| - 在未指定 `join` 参数时需要指定该参数。一个 3 节点集群的配置示例为 `"dm-master-1=http://172.16.15.11:8291,dm-master-2=http://172.16.15.12:8291,dm-master-3=http://172.16.15.13:8291"` | ||
|
|
||
| ### `--join` | ||
|
|
||
| - DM-master 节点加入到已有集群时，已有集群的 `advertise-addr` 地址列表 | ||
| - 默认值为 `""` | ||
| - 未指定 `initial-cluster` 参数时需要指定该参数。一个新节点加入到一个已有 2 个节点的集群的示例为 `"172.16.15.11:8261,172.16.15.12:8261"` | ||
|
|
||
| ### `--log-file` | ||
|
|
||
| - log 输出文件名 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ### `-L` | ||
|
|
||
| - log 级别 | ||
| - 默认值为 `"info"` | ||
| - 可选参数 | ||
|
|
||
| ### `--master-addr` | ||
|
|
||
| - DM-master 监听客户端请求的地址 | ||
| - 默认值为 `""` | ||
| - 必选参数 | ||
|
|
||
| ### `--name` | ||
|
|
||
| - DM-master 节点名称 | ||
| - 默认值为 `"dm-master-{hostname}"` | ||
| - 必选参数 | ||
|
|
||
| ### `--peer-urls` | ||
|
|
||
| - DM-master 节点间通信的监听地址 | ||
| - 默认值为 `"http://127.0.0.1:8291"` | ||
| - 必选参数 | ||
|
|
||
| ### `--secret-key-path` | ||
|
|
||
| - 自定义加解密密钥路径 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ## DM-worker | ||
|
|
||
| ### `--advertise-addr` | ||
|
|
||
| - DM-worker 用于接受客户端请求的外部地址 | ||
| - 默认值为 `"{worker-addr}"` | ||
| - 可选参数，可以为 `"域名:port"` 的形式 | ||
|
|
||
| ### `--config` | ||
|
|
||
| - DM-worker 配置文件路径 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ### `--join` | ||
|
|
||
| - DM-worker 注册到集群时，相应集群的 DM-master 节点的 `{advertise-addr}` 列表 | ||
| - 默认值为 `""` | ||
| - 必选参数，一个 3 DM-master 节点的集群配置示例为 `"172.16.15.11:8261,172.16.15.12:8261,172.16.15.13:8261"` | ||
|
|
||
| ### `--log-file` | ||
|
|
||
| - log 输出文件名 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ### `-L` | ||
|
|
||
| - log 级别 | ||
| - 默认值为 `"info"` | ||
| - 可选参数 | ||
|
|
||
| ### `--name` | ||
|
|
||
| - DM-worker 节点名称 | ||
| - 默认值为 `"{advertise-addr}"` | ||
| - 必选参数 | ||
|
|
||
| ### `--worker-addr` | ||
|
|
||
| - DM-worker 监听客户端请求的地址 | ||
| - 默认值为 `""` | ||
| - 必选参数 | ||
|
|
||
| ## dmctl | ||
|
|
||
| ### `--config` | ||
|
|
||
| - dmctl 配置文件路径 | ||
| - 默认值为 `""` | ||
| - 可选参数 | ||
|
|
||
| ### `--master-addr` | ||
|
|
||
| - dmctl 要连接的集群的任意 DM-master 节点的 `{advertise-addr}` | ||
| - 默认值为 `""` | ||
| - 需要与 DM-master 交互时为必选参数 |
35 changes: 35 additions & 0 deletions
35
markdown-pages/zh/tidb/master/dm/dm-customized-secret-key.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| title: DM 自定义加解密 key | ||
| summary: 介绍 DM（Data Migration）在 v8.0.0 中引入的自定义加密和解密密钥功能，以及如何在使用 DM 进行数据迁移时配置和使用该功能。 | ||
| --- | ||
|
|
||
| # DM 自定义加解密 key | ||
|
|
||
| 在 v8.0.0 之前，DM 使用了一个[固定的 AES-256 密钥](https://github.com/pingcap/tiflow/blob/1252979421fc83ffa2a1548d981e505f7fc0b909/dm/pkg/encrypt/encrypt.go#L27)来加密和解密数据源和迁移任务配置中的密码，但固定秘钥可能产生安全风险，特别是在对安全性要求较高的环境中。为了提高安全性，从 v8.0.0 开始，DM 移除了固定密钥，并支持设置自定义密钥。 | ||
|
|
||
| ## 使用方式 | ||
|
|
||
| 在 DM-master [启动参数](dm/dm-command-line-flags.md)或[配置文件](/dm/dm-master-configuration-file.md) 中设置 `secret-key-path`，该参数指向密钥文件路径，文件内容必须是长度为 64 个字符的十六进制的 AES-256 密钥。 | ||
|
|
||
| ## 从 < v8.0.0 版本升级 | ||
|
|
||
| 从 v8.0.0 开始，DM 不再使用固定密钥，因此从低于 v8.0.0 的版本升级时需要注意： | ||
|
|
||
| - 如果[数据源配置](/dm/dm-source-configuration-file.md)和[迁移任务配置](/dm/task-configuration-file-full.md)里使用的都是明文密码，则升级不需要做额外处理。 | ||
| - 如果[数据源配置](/dm/dm-source-configuration-file.md)和[迁移任务配置](/dm/task-configuration-file-full.md)里使用了加密密码，或者后续希望使用加密密码，则需进行以下操作： | ||
| 1. 修改 [DM-master 配置文件](dm/dm-master-configuration-file.md)，增加 `secret-key-path`。该参数指向密钥文件路径，文件内容必须是长度为 64 个字符的十六进制的 AES-256 密钥。如果升级前使用了 [固定的 AES-256 密钥](https://github.com/pingcap/tiflow/blob/1252979421fc83ffa2a1548d981e505f7fc0b909/dm/pkg/encrypt/encrypt.go#L27) 进行加密，可拷贝该秘钥到秘钥文件中。请确保所有 DM-master 节点使用相同的密钥配置。 | ||
| 2. 先滚动升级 DM-master，然后滚动升级 DM-worker，具体参考[滚动升级](/dm/maintain-dm-using-tiup.md#滚动升级)。 | ||
|
|
||
| ## 更新加密 key | ||
|
|
||
| 如需更新用于加密和解密的密钥，请按照以下顺序进行： | ||
|
|
||
| 1. 更新 [DM-master 配置文件](dm/dm-master-configuration-file.md) 中的 `secret-key-path`。 | ||
|
|
||
| > **注意：** | ||
| > | ||
| > - 请确保所有 DM-master 节点更新为相同的密钥配置。 | ||
| > - 在密钥更新期间，请不要创建新的[数据源配置文件](/dm/dm-source-configuration-file.md)和[迁移任务配置文件](/dm/task-configuration-file-full.md)。 | ||
| 2. 滚动重启 DM-master。 | ||
| 3. 使用 `tiup dmctl encrypt`(dmctl 版本需 >= v8.0.0) 加密的密码用于创建[数据源配置文件](/dm/dm-source-configuration-file.md)和[迁移任务配置文件](/dm/task-configuration-file-full.md)。 |
88 changes: 88 additions & 0 deletions
88
markdown-pages/zh/tidb/master/dm/dm-export-import-config.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| title: TiDB Data Migration 导出和导入集群的数据源和任务配置 | ||
| summary: 了解 TiDB Data Migration 导出和导入集群的数据源和任务配置。 | ||
| --- | ||
|
|
||
| # TiDB Data Migration 导出和导入集群的数据源和任务配置 | ||
|
|
||
| `config` 命令用于导出和导入集群的数据源和任务配置。 | ||
|
|
||
| > **注意：** | ||
| > | ||
| > 对于 v2.0.5 版本之前的集群，可使用 >= v2.0.5 且 < v8.0.0 的 dmctl 导出和导入集群的数据源和任务配置文件。 | ||
| ```bash | ||
| » help config | ||
| Commands to import/export config | ||
|
|
||
| Usage: | ||
| dmctl config [command] | ||
|
|
||
| Available Commands: | ||
| export Export the configurations of sources and tasks. | ||
| import Import the configurations of sources and tasks. | ||
|
|
||
| Flags: | ||
| -h, --help help for config | ||
|
|
||
| Global Flags: | ||
| -s, --source strings MySQL Source ID. | ||
|
|
||
| Use "dmctl config [command] --help" for more information about a command. | ||
| ``` | ||
|
|
||
| ## 导出集群的数据源和任务配置 | ||
|
|
||
| 使用 `export` 子命令导出集群的数据源和任务配置到指定文件夹中。 | ||
|
|
||
| ```bash | ||
| config export [--dir directory] | ||
| ``` | ||
|
|
||
| ### 参数解释 | ||
|
|
||
| - `dir`： | ||
| - 可选 | ||
| - 指定导出文件夹路径 | ||
| - 默认值为 `./configs` | ||
|
|
||
| ### 返回结果示例 | ||
|
|
||
| ```bash | ||
| config export -d /tmp/configs | ||
| ``` | ||
|
|
||
| ``` | ||
| export configs to directory `/tmp/configs` succeed | ||
| ``` | ||
|
|
||
| ## 导入集群的数据源和任务配置 | ||
|
|
||
| 使用 `import` 子命令从指定文件夹中导入集群的数据源和任务配置。 | ||
|
|
||
| ```bash | ||
| config import [--dir directory] | ||
| ``` | ||
|
|
||
| > **注意：** | ||
| > | ||
| > 对于 v2.0.2 版本之后的集群，暂不支持自动导入 relay worker 的相关配置，可以手动使用 `start-relay` 命令[开启 relay log](/dm/relay-log.md#开启关闭-relay-log)。 | ||
| ### 参数解释 | ||
|
|
||
| - `dir`： | ||
| - 可选 | ||
| - 指定导入文件夹路径 | ||
| - 默认值为 `./configs` | ||
|
|
||
| ### 返回结果示例 | ||
|
|
||
| ```bash | ||
| config import -d /tmp/configs | ||
| ``` | ||
|
|
||
| ``` | ||
| start creating sources | ||
| start creating tasks | ||
| import configs from directory `/tmp/configs` succeed | ||
| ``` |
Oops, something went wrong.