MySQL TLS 连接配置
本文介绍如何配置 HAP 使用单向 TLS 或 mTLS 连接 MySQL。
配置前,请确保 MySQL 已启用 TLS。单向 TLS 使用的账号不能要求客户端证书,例如不能设置 REQUIRE X509。
mTLS 要求 MySQL 信任客户端证书的 CA。如需强制账号提供客户端证书,可为该账号设置 REQUIRE X509。
准备证书
准备以下证书文件,并确保容器内的服务有权限读取:
| 文件 | 说明 |
|---|---|
mysql-ca-cert.pem | 用于验证 MySQL 服务器证书的 CA 证书 |
mysql-client-cert.pem | 客户端证书,mTLS 使用 |
mysql-client-key.pem | 客户端私钥,mTLS 使用 |
单向 TLS 只需准备 CA 证书;mTLS 还需准备客户端证书和私钥。
以下示例将证书挂载到容器内的 /etc/mysql/ssl/ 目录。实际路径可以调整,但必须与连接配置中的路径一致。连接地址需与 MySQL 服务器证书中的名称匹配。
挂载证书
- HAP 单机模式(Docker Compose)
- HAP 集群模式(Kubernetes)
-
将证书存放在服务器上。例如,放在
docker-compose.yaml同级目录的volume/mysql/ssl/下。 -
修改
/data/mingdao/script/docker-compose.yaml,在已有的app服务的volumes中增加证书挂载:
services:
app:
volumes:
- ./volume/mysql/ssl/mysql-ca-cert.pem:/etc/mysql/ssl/mysql-ca-cert.pem:ro
- ./volume/mysql/ssl/mysql-client-cert.pem:/etc/mysql/ssl/mysql-client-cert.pem:ro
- ./volume/mysql/ssl/mysql-client-key.pem:/etc/mysql/ssl/mysql-client-key.pem:ro
单向 TLS 只需挂载 CA 证书;mTLS 需要挂载以上三个文件。
-
参考挂载配置文件,将所需证书文件分别挂载到容器内。
- 单向 TLS:挂载 CA 证书。
- mTLS:挂载 CA 证书、客户端证书和私钥。
每个文件使用不同的
ENV_SERVICE_CONFIG开头的环境变量。 -
确认容器内的挂载路径与下方连接配置中的证书路径一致。
配置连接
根据部署方式,修改对应的配置文件:
- HAP 单机模式(Docker Compose)
- HAP 集群模式(Kubernetes)
在 /data/mingdao/script/docker-compose.yaml 的 app 服务下配置。
在微服务的 config.yaml 中配置。
根据认证方式添加以下环境变量,并修改地址、端口、用户名、密码和证书路径。证书路径为容器内的文件路径。
- 单向 TLS
- mTLS 双向认证
ENV_RDB_TYPE: '10'
ENV_RDB_URI_MDPROJECT: 'Server=192.0.2.10;Port=3306;Database=MDProject;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;'
ENV_RDB_URI_MDLOG: 'Server=192.0.2.10;Port=3306;Database=MDLog;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;'
ENV_RDB_URI_MDSTRUCTURE: 'Server=192.0.2.10;Port=3306;Database=MDStructure;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;'
ENV_RDB_URI_MDCALENDAR: 'Server=192.0.2.10;Port=3306;Database=MDCalendar;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;'
ENV_RDB_URI_MDAPPLICATION: 'Server=192.0.2.10;Port=3306;Database=MDApplication;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;'
ENV_RDB_TYPE: '10'
ENV_RDB_URI_MDPROJECT: 'Server=192.0.2.10;Port=3306;Database=MDProject;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;SslCert=/etc/mysql/ssl/mysql-client-cert.pem;SslKey=/etc/mysql/ssl/mysql-client-key.pem;'
ENV_RDB_URI_MDLOG: 'Server=192.0.2.10;Port=3306;Database=MDLog;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;SslCert=/etc/mysql/ssl/mysql-client-cert.pem;SslKey=/etc/mysql/ssl/mysql-client-key.pem;'
ENV_RDB_URI_MDSTRUCTURE: 'Server=192.0.2.10;Port=3306;Database=MDStructure;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;SslCert=/etc/mysql/ssl/mysql-client-cert.pem;SslKey=/etc/mysql/ssl/mysql-client-key.pem;'
ENV_RDB_URI_MDCALENDAR: 'Server=192.0.2.10;Port=3306;Database=MDCalendar;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;SslCert=/etc/mysql/ssl/mysql-client-cert.pem;SslKey=/etc/mysql/ssl/mysql-client-key.pem;'
ENV_RDB_URI_MDAPPLICATION: 'Server=192.0.2.10;Port=3306;Database=MDApplication;uid=hap;password=YOUR_PASSWORD;SslMode=VerifyFull;SslCa=/etc/mysql/ssl/mysql-ca-cert.pem;SslCert=/etc/mysql/ssl/mysql-client-cert.pem;SslKey=/etc/mysql/ssl/mysql-client-key.pem;'
ENV_RDB_URI_*的优先级大于原有的ENV_MYSQL_*连接配置。确认其他服务和维护脚本不再依赖后,可移除原有的地址、端口、用户名和密码变量。
通过 MySQL Router 连接 MGR 时,Server 填写 Router 地址,多个地址以英文逗号分隔;Port 填写 Router 读写端口。
连接地址须与 TLS 连接所验证的服务器证书匹配;使用 IP 地址时,证书须包含对应的 IP 地址。
配置完成后,单机模式在安装管理器所在目录执行以下命令,重新创建 app 容器以应用 Compose 配置:
docker compose -f docker-compose.yaml up -d --no-deps --force-recreate app
然后重启 HAP 微服务。集群模式应用配置后,重启 HAP 微服务使配置生效。