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.

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

zh,en: update tls config #228

Merged
merged 18 commits into from
Aug 17, 2020
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
9 changes: 9 additions & 0 deletions en/dm-master-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ advertise-peer-urls = "http://127.0.0.1:8291"
# cluster configuration
initial-cluster = "master1=http://127.0.0.1:8291,master2=http://127.0.0.1:8292,master3=http://127.0.0.1:8293"
join = ""

ssl-ca = "/path/to/ca.pem"
ssl-cert = "/path/to/cert.pem"
ssl-key = "/path/to/key.pem"
cert-allowed-cn = ["dm"]
```

## Configuration parameters
Expand All @@ -49,3 +54,7 @@ This section introduces the configuration parameters of DM-master.
| `advertise-peer-urls` | Specifies the peer URL that DM-master advertises to the outside world. The value of `advertise-peer-urls` is by default the same as that of `peer-urls`. |
| `initial-cluster` | The value of `initial-cluster` is the combination of the `advertise-peer-urls` value of all DM-master nodes in the initial cluster. |
| `join` | The value of `join` is the combination of the `advertise-peer-urls` value of the existed DM-master nodes in the cluster. If the DM-master node is newly added, replace `initial-cluster` with `join`. |
| `ssl-ca` | Path of file that contains list of trusted SSL CAs for connection with DM-master components. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does English version need to update?

| `ssl-cert` | Path of file that contains X509 certificate in PEM format for connection with DM-master components. |
| `ssl-key` | Path of file that contains X509 key in PEM format for connection with DM-master components. |
| `cert-allowed-cn` | Common Name list. |
9 changes: 9 additions & 0 deletions en/dm-worker-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ log-file = "dm-worker.log"
worker-addr = ":8262"
advertise-addr = "127.0.0.1:8262"
join = "127.0.0.1:8261,127.0.0.1:8361,127.0.0.1:8461"

ssl-ca = "/path/to/ca.pem"
ssl-cert = "/path/to/cert.pem"
ssl-key = "/path/to/key.pem"
cert-allowed-cn = ["dm"]
```

## Configuration parameters
Expand All @@ -38,3 +43,7 @@ join = "127.0.0.1:8261,127.0.0.1:8361,127.0.0.1:8461"
| `worker-addr` | Specifies the address of DM-worker which provides services. You can omit the IP address and specify the port number only, such as ":8262". |
| `advertise-addr` | Specifies the address that DM-worker advertises to the outside world. |
| `join` | Corresponds to one or more [`master-addr`s](dm-master-configuration-file.md#global-configuration) in the DM-master configuration file. |
| `ssl-ca` | Path of file that contains list of trusted SSL CAs for connection with DM-worker components. |
| `ssl-cert` | Path of file that contains X509 certificate in PEM format for connection with DM-worker components. |
| `ssl-key` | Path of file that contains X509 key in PEM format for connection with DM-worker components. |
| `cert-allowed-cn` | Common Name list. |
9 changes: 7 additions & 2 deletions en/source-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ from:
host: "127.0.0.1"
port: 3306
user: "root"
password: "ZqMLjZ2j5khNelDEfDoUhkD5aV5fIJOe0fiog9w=" # The user password of the upstream database. Note that the password must be encrypted using dmctl.
password: "ZqMLjZ2j5khNelDEfDoUhkD5aV5fIJOe0fiog9w=" # The user password of the upstream database. It is recommended to use the password encrypted with dmctl.
security: # The TLS config of the upstream database
GMHDBJD marked this conversation as resolved.
Show resolved Hide resolved
ssl-ca: "/path/to/ca.pem"
ssl-cert: "/path/to/cert.pem"
ssl-key: "/path/to/key.pem"
```

## Configuration parameters
Expand All @@ -38,4 +42,5 @@ This section describes each configuration parameter in the configuration file.
| `host` | Specifies the host of the upstream database. |
| `port` | Specifies the port of the upstream database. |
| `user` | Specifies the username of the upstream database. |
| `password` | Specifies the user password of the upstream database. Note that the password must be encrypted using dmctl. |
| `password` | Specifies the user password of the upstream database. It is recommended to use the password encrypted with dmctl. |
| `security` | Specifies the TLS config of the upstream database. |
4 changes: 4 additions & 0 deletions en/task-configuration-file-full.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ target-database: # Configuration of the downstream database insta
sql_mode: "ANSI_QUOTES,NO_ZERO_IN_DATE,NO_ZERO_DATE"
tidb_skip_utf8_check: 1
tidb_constraint_check_in_place: 0
security: # The TLS config of the downstream TiDB
GMHDBJD marked this conversation as resolved.
Show resolved Hide resolved
ssl-ca: "/path/to/ca.pem"
ssl-cert: "/path/to/cert.pem"
ssl-key: "/path/to/key.pem"


## ******** Feature configuration set **********
Expand Down
8 changes: 8 additions & 0 deletions zh/dm-master-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ advertise-peer-urls = "http://127.0.0.1:8291"
initial-cluster = "master1=http://127.0.0.1:8291,master2=http://127.0.0.1:8292,master3=http://127.0.0.1:8293"
join = ""

ssl-ca = "/path/to/ca.pem"
ssl-cert = "/path/to/cert.pem"
ssl-key = "/path/to/key.pem"
cert-allowed-cn = ["dm"]
```

## 配置项说明
Expand All @@ -47,3 +51,7 @@ join = ""
| `advertise-peer-urls` | DM-master 向外界宣告的对等 URL。默认为 `peer-urls` 的值。|
| `initial-cluster` | 初始集群中所有 DM-master 的 `advertise-peer-urls` 的值。|
| `join` | 集群里已有的 DM-master 的 `advertise-peer-urls` 的值。如果是新加入的 DM-master 节点,使用 `join` 替代 `initial-cluster`。|
| `ssl-ca` | DM-master 组件用于连接其它组件的 SSL CA 证书所在的路径 |
| `ssl-cert` | DM-master 组件用于连接其它组件的 PEM 格式的 X509 证书所在的路径 |
| `ssl-key` | DM-master 组件用于连接其它组件的 PEM 格式的 X509 密钥所在的路径 |
| `cert-allowed-cn` | 证书检查 Common Name 列表 |
9 changes: 9 additions & 0 deletions zh/dm-worker-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ log-file = "dm-worker.log"
worker-addr = ":8262"
advertise-addr = "127.0.0.1:8262"
join = "127.0.0.1:8261,127.0.0.1:8361,127.0.0.1:8461"

ssl-ca = "/path/to/ca.pem"
ssl-cert = "/path/to/cert.pem"
ssl-key = "/path/to/key.pem"
cert-allowed-cn = ["dm"]
```

## 配置项说明
Expand All @@ -36,3 +41,7 @@ join = "127.0.0.1:8261,127.0.0.1:8361,127.0.0.1:8461"
| `worker-addr` | DM-worker 服务的地址,可以省略 IP 信息,例如:":8262"。|
| `advertise-addr` | DM-worker 向外界宣告的地址。 |
| `join` | 对应一个或多个 DM-master 配置中的 [`master-addr`](dm-master-configuration-file.md#global-配置)。 |
| `ssl-ca` | DM-worker 组件用于连接其它组件的 SSL CA 证书所在的路径 |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

哦,好像它们自己也还用这个参数来监听连接

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

稍微改了一下

| `ssl-cert` | DM-worker 组件用于连接其它组件的 PEM 格式的 X509 证书所在的路径 |
| `ssl-key` | DM-worker 组件用于连接其它组件的 PEM 格式的 X509 密钥所在的路径 |
| `cert-allowed-cn` | 证书检查 Common Name 列表 |
9 changes: 7 additions & 2 deletions zh/source-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ from:
host: "127.0.0.1"
port: 3306
user: "root"
password: "ZqMLjZ2j5khNelDEfDoUhkD5aV5fIJOe0fiog9w=" # 使用 dmctl 对上游数据库的用户密码加密之后的密码
password: "ZqMLjZ2j5khNelDEfDoUhkD5aV5fIJOe0fiog9w=" # 推荐使用 dmctl 对上游数据库的用户密码加密之后的密码
security: # 上游数据库 TLS 相关配置
ssl-ca: "/path/to/ca.pem"
ssl-cert: "/path/to/cert.pem"
ssl-key: "/path/to/key.pem"
```

## 配置项说明
Expand All @@ -35,4 +39,5 @@ from:
| `host` | 上游数据库的 host。|
| `port` | 上游数据库的端口。|
| `user` | 上游数据库使用的用户名。|
| `password` | 上游数据库的用户密码。注意:需要使用 dmctl 加密后的密码。|
| `password` | 上游数据库的用户密码。推荐使用 dmctl 加密后的密码。|
| `security` | 上游数据库 TLS 相关配置。|
4 changes: 4 additions & 0 deletions zh/task-configuration-file-full.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ target-database: # 下游数据库实例配置
sql_mode: "ANSI_QUOTES,NO_ZERO_IN_DATE,NO_ZERO_DATE"
tidb_skip_utf8_check: 1
tidb_constraint_check_in_place: 0
security: # 下游 TiDB TLS 相关配置
ssl-ca: "/path/to/ca.pem"
ssl-cert: "/path/to/cert.pem"
ssl-key: "/path/to/key.pem"

## ******** 功能配置集 **********

Expand Down