Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add example to generate dm key #18996

Merged
merged 3 commits into from
Nov 6, 2024
Merged

add example to generate dm key #18996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
120636b
change
D3Hunter Nov 4, 2024
586acb7
Update dm/dm-master-configuration-file.md
D3Hunter Nov 5, 2024
0a8e91b
add a link to the secret key doc
qiancai Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions dm/dm-customized-secret-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ summary: 介绍如何自定义密钥，用于加密和解密 DM（Data Migration

## 使用方式

1. 创建一个自定义的密钥文件，文件内容必须为长度为 64 个字符的十六进制的 AES-256 密钥。
1. 创建一个自定义的密钥文件，文件内容必须为长度为 64 个字符的十六进制的 AES-256 密钥。一种生成该秘钥的方式是对随机内容计算 SHA256 校验和，比如 `head -n 256 /dev/urandom | sha256sum`。
2. 在 DM-master [启动参数](/dm/dm-command-line-flags.md)或[配置文件](/dm/dm-master-configuration-file.md) 中，设置 `secret-key-path` 为你自定义的密钥文件的路径。

## 从低于 v8.0.0 的版本升级
Expand All @@ -29,8 +29,8 @@ summary: 介绍如何自定义密钥，用于加密和解密 DM（Data Migration

> **注意：**
>
> - 请确保所有 DM-master 节点更新为相同的密钥配置。
> - 在密钥更新期间，请不要创建新的[数据源配置文件](/dm/dm-source-configuration-file.md)和[迁移任务配置文件](/dm/task-configuration-file-full.md)。
> - 请确保所有 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)。
2 changes: 1 addition & 1 deletion dm/dm-master-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ secret-key-path = "/path/to/secret/key"
| `ssl-cert` | DM-master 组件用于与其它组件连接的 PEM 格式的 X509 证书所在的路径 |
| `ssl-key` | DM-master 组件用于与其它组件连接的 PEM 格式的 X509 密钥所在的路径 |
| `cert-allowed-cn` | 证书检查 Common Name 列表 |
| `secret-key-path` | 用来加解密上下游密码的密钥所在的路径，该文件内容必须是长度为 64 个字符的十六进制的 AES-256 密钥 |
| `secret-key-path` | 用来加解密上下游密码的密钥所在的路径，该文件内容必须是长度为 64 个字符的十六进制的 AES-256 密钥。一种生成该秘钥的方式是对随机内容计算 SHA256 校验和，比如 <code>head -n 256 /dev/urandom \| sha256sum</code>。更多信息，请参考 [DM 自定义加解密 key](/dm/dm-customized-secret-key.md)。|