From: 刘洪青 Date: Tue, 29 Jun 2021 08:59:42 +0000 (+0800) Subject: docs: 完善chart 部署的文档 X-Git-Url: https://source.supwisdom.com/gerrit/gitweb?a=commitdiff_plain;h=123311b639aecd11ebc2d009ae8b235837850827;p=institute%2Fdeploy-authx-service.git docs: 完善chart 部署的文档 --- diff --git "a/deploy-manifests/charts/1.2.0000.\350\256\244\350\257\201\346\216\210\346\235\203\346\234\215\345\212\241\345\256\211\350\243\205\351\203\250\347\275\262\346\211\213\345\206\214\357\274\210\345\237\272\344\272\216\345\272\224\347\224\250\345\225\206\345\272\227\357\274\211.md" "b/deploy-manifests/charts/1.2.0000.\350\256\244\350\257\201\346\216\210\346\235\203\346\234\215\345\212\241\345\256\211\350\243\205\351\203\250\347\275\262\346\211\213\345\206\214\357\274\210\345\237\272\344\272\216\345\272\224\347\224\250\345\225\206\345\272\227\357\274\211.md" index 5331b46..f5a2b22 100644 --- "a/deploy-manifests/charts/1.2.0000.\350\256\244\350\257\201\346\216\210\346\235\203\346\234\215\345\212\241\345\256\211\350\243\205\351\203\250\347\275\262\346\211\213\345\206\214\357\274\210\345\237\272\344\272\216\345\272\224\347\224\250\345\225\206\345\272\227\357\274\211.md" +++ "b/deploy-manifests/charts/1.2.0000.\350\256\244\350\257\201\346\216\210\346\235\203\346\234\215\345\212\241\345\256\211\350\243\205\351\203\250\347\275\262\346\211\213\345\206\214\357\274\210\345\237\272\344\272\216\345\272\224\347\224\250\345\225\206\345\272\227\357\274\211.md" @@ -192,9 +192,7 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 jobs-server 同步服务 - cas-server CAS 认证 - - token-server Token 认证 + cas-server 认证（CAS 认证 + Token Server） ``` * 确定命名空间 @@ -210,9 +208,7 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 jobs-server 同步服务 - cas-server CAS 认证 - - token-server Token 认证 + cas-server 认证（CAS 认证 + Token Server） ``` @@ -397,9 +393,9 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 外部MySQL port： <请填写数据库服务的端口> * AGENT SERVICE - MYSQL数据库配置 - 用户名： `agent_service` ，固定值 + 用户名： `agent_service` ，固定值、或按实际情况修改 密码： <请填写创建的数据库用户的密码> - 数据库名： `agent_service` ，固定值 + 数据库名： `agent_service` ，固定值、或按实际情况修改 * 文件服务设置 Minio Url： `http://minio.authx-minio.svc.cluster.local:9000` ，若 minio 的命名空间有调整，请修改 @@ -426,12 +422,8 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 命名空间： authx-service -* MYSQL服务 - 服务地址 - MySQL服务 host： <请填写数据库服务的IP地址> - MySQL服务 port： <请填写数据库服务的端口> - * REDIS配置 - 安全配置 - Redis密码： `OEt1d29zbE9pdXc3SA==` + Redis密码： `8KuwoslOiuw7H` Default Storage Class： <请选择存储类> @@ -439,53 +431,61 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 用户名： guest 密码： guest -* 简易监控设置 - 用户密码 - 用户名： sbaadmin - 密码： nimdaabs +* MYSQL数据库配置 - 服务地址 + MYSQL数据库配置 host： <请填写数据库服务的IP地址> + MYSQL数据库配置 port： <请填写数据库服务的端口> -* 依赖服务 - 文件服务设置 +* MYSQL数据库配置 - 用户服务 - Minio外网地址： `http://authx-minio.paas..edu.cn` ，请设置为 minio 的外网地址 + 用户名： `user` ，固定值、或按实际情况修改 + 密码： <请填写创建的数据库用户的密码> + 数据库名： `user` ，固定值、或按实际情况修改 -* 依赖服务 - 认证设置 +* MYSQL数据库配置 - 授权服务 + + 用户名： `user_authz` ，固定值、或按实际情况修改 + 密码： <请填写创建的数据库用户的密码> + 数据库名： `user_authz` ，固定值、或按实际情况修改 - CAS认证地址： `http://cas.paas..edu.cn/cas` ，请设置为 cas 认证的外网地址 -* 依赖服务 - POA 设置 +* 域名全局设置 + + 根域名： `paas..edu.cn` ，请修改为实际的学校域名 + +* 域名配置 - 安全中心 + + 子域名： `security-center` ，若须修改，根据实际情况修改即可 + + +* POA 设置 POA网关地址： `http://poa.paas..edu.cn` ，请设置为 poa 网关的外网地址 - POA SA地址： `http://poa-sa.paas..edu.cn` ，请设置为 poa-sa 管理接口的地址（也可使用 k8s 内部地址） + POA SA地址： 请设置为 poa-sa 管理接口的 k8s 内部地址（根据实际部署的 POA 进行调整） -* 依赖服务 - CAS SERVER - CAS内部地址： `http://cas-server-webapp.cas-server.svc.cluster.local:8080/cas` ，固定值，若 cas-server 的命名空间有调整，请修改 - CAS SA API内部地址： `http://cas-server-sa.cas-server.svc.cluster.local:8080` ，固定值，若 cas-server 的命名空间有调整，请修改 +* 依赖服务 - 文件服务设置 -* 依赖服务 - AGENT SERVICE + Minio外网地址： `http://authx-minio.paas..edu.cn` ，请设置为 minio 的外网地址 - Agent Service API内部地址： `http://agent-service.agent-service.svc.cluster.local:8080` ，固定值，若 agent-service 的命名空间有调整，请修改 +* 依赖服务 - 认证设置 - Agent Service 文件上传路径： `/api/v1/tpas/file/minio` ，一般不用修改 - Agent Service 邮件发送路径： `/api/v1/tpas/mail/smtp` ，一般不用修改 - Agent Service 短信发送路径： `/api/v1/tpas/sms/aliyun` ， 若不使用阿里云短信服务，须修改 + CAS认证地址： `http://cas.paas..edu.cn/cas` ，请设置为 cas 认证的外网地址 -* 用户服务 - MYSQL数据库配置 +* 依赖 API - AGENT SERVICE - 用户名： `user` ，固定值 - 密码： <请填写创建的数据库用户的密码> - 数据库名： `user` ，固定值 + Agent Service API内部地址： `http://agent-service.agent-service.svc.cluster.local:8080` ，固定值，若 agent-service 的命名空间有调整，请修改 -* 授权服务 - MYSQL数据库配置 + Agent Service 文件上传路径： `/api/v1/tpas/file/minio` ，一般不用修改 + Agent Service 邮件发送路径： `/api/v1/tpas/mail/smtp` ，一般不用修改 + Agent Service 短信发送路径： `/api/v1/tpas/sms/aliyun` ， 若不使用阿里云短信服务，须修改 - 用户名： `user_authz` ，固定值 - 密码： <请填写创建的数据库用户的密码> - 数据库名： `user_authz` ，固定值 +* 依赖 API - CAS SERVER -* 安全中心 - 域名配置 + CAS内部地址： `http://cas-server-webapp.cas-server.svc.cluster.local:8080/cas` ，固定值，若 cas-server 的命名空间有调整，请修改 + CAS SA API内部地址： `http://cas-server-sa.cas-server.svc.cluster.local:8080` ，固定值，若 cas-server 的命名空间有调整，请修改 - 域名： `security-center.paas..edu.cn` ，请修改为实际的学校域名 #### jobs-server @@ -517,12 +517,8 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 命名空间： cas-server -* 外部MYSQL-连接配置 - 外部MySQL host： <请填写数据库服务的IP地址> - 外部MySQL port： <请填写数据库服务的端口> - * REDIS配置 - 安全配置 - Redis密码： `OEt1d29zbE9pdXc3SA==` + Redis密码： `8KuwoslOiuw7H` Default Storage Class： <请选择存储类> @@ -531,126 +527,104 @@ v1 | 刘洪青 | 2021-05-15 | 初稿 密码： guest -* 依赖服务 - 用户服务 - - 用户数据API内部地址： `http://authx-service-user-data-service-goa.authx-service.svc.cluster.local:8080` ，固定值，若 authx-service 的命名空间有调整，请修改 - -* 依赖服务 - 授权服务 - - 用户授权API内部地址： `http://authx-service-user-authz-service-sa.authx-service.svc.cluster.local:8080` ，固定值，若 authx-service 的命名空间有调整，请修改 - -* 依赖服务 - AGENT SERVICE - - Agent Service 内部地址： `http://agent-service.agent-service.svc.cluster.local:8080` ，固定值，若 agent-service 的命名空间有调整，请修改 - - Agent Service文件服务API路径： `/api/v1/tpas/file/minio` ，一般不用修改 - Agent Service短信发送API路径： `/api/v1/tpas/sms/aliyun/send` ， 若不使用阿里云短信服务，须修改 +* MYSQL数据库配置 - 服务地址 + MySQL服务 host： <请填写数据库服务的IP地址> + MySQL服务 port： <请填写数据库服务的端口> -* 依赖服务 - TOKEN SERVER +* MYSQL数据库配置 - CAS 认证 - Token Server 内部地址： `http://token-server.token-server.svc.cluster.local:8080` ，固定值，若 token-server 的命名空间有调整，请修改 + 用户名： `cas_server` ，固定值、或按实际情况修改 + 密码： <请填写创建的数据库用户的密码> + 数据库名： `cas_server` ，固定值、或按实际情况修改 +* MYSQL数据库配置 - Token Server -* CAS 认证 - MYSQL数据库配置 - 用户名： `cas_server` ，固定值 + 用户名： `token_server` ，固定值、或按实际情况修改 密码： <请填写创建的数据库用户的密码> - 数据库名： `cas_server` ，固定值 + 数据库名： `token_server` ，固定值、或按实际情况修改 -* SCHEME设置 - 持久卷 - Default Storage Class： <请选择存储类> +* 域名全局设置 -* WEBAPP设置-域名配置 + 根域名： `paas..edu.cn` ，请修改为实际的学校域名 - 域名： `cas.paas..edu.cn` ，请修改为实际的学校域名 +* 域名配置 - CAS 认证 -* WEBAPP设置-图片验证码 + 子域名： `cas` ，若须修改，根据实际情况修改即可 - 启用图片验证码： 是 or 否 +* 域名配置 - Token Server -* WEBAPP设置-动态密码 + 子域名： `token` ，若须修改，根据实际情况修改即可 - 动态密码短信标题： 认证中心，固定值 - 动态密码短信模板： 请修改为合适的短信模板 -* WEBAPP设置-JWT +* POA 设置 - 参考 certs/jwt/readme.md 生成公私钥pem，修改相关配置（请使用与 token-server 一致的公私钥） + POA网关地址： `http://poa.paas..edu.cn` ，请设置为 poa 网关的外网地址 + POA SA地址： 请设置为 poa-sa 管理接口的 k8s 内部地址（根据实际部署的 POA 进行调整） - JWT私钥： - JWT公钥： -* DATAX设置-参数配置 +* 依赖 API - AGENT SERVICE - 数据源JdbcUrl： `jdbc:mysql://authx-service-mysql-server.authx-service.svc.cluster.local:3306/user?serverTimezone=Asia/Shanghai` ，连接 authx-service 的mysql，若 authx-service 的命名空间有调整，请修改 - 数据源用户名： user - 数据源密码： <请填写创建的数据库用户的密码> + Agent Service 内部地址： `http://agent-service.agent-service.svc.cluster.local:8080` ，固定值，若 agent-service 的命名空间有调整，请修改 + Agent Service 文件上传路径： `/api/v1/tpas/file/minio` ，一般不用修改 + Agent Service 邮件发送路径： `/api/v1/tpas/mail/smtp` ，一般不用修改 + Agent Service 短信发送路径： `/api/v1/tpas/sms/aliyun` ， 若不使用阿里云短信服务，须修改 -#### token-server +* 依赖 API - 用户服务 -命名空间： token-server + 用户数据API内部地址： `http://authx-service-user-data-service-goa.authx-service.svc.cluster.local:8080` ，固定值，若 authx-service 的命名空间有调整，请修改 -* 外部MYSQL-连接配置 - 外部MySQL host： <请填写数据库服务的IP地址> - 外部MySQL port： <请填写数据库服务的端口> +* 依赖 API - 授权服务 -* REDIS配置 - 安全配置 - Redis密码： `OEt1d29zbE9pdXc3SA==` + 用户授权API内部地址： `http://authx-service-user-authz-service-sa.authx-service.svc.cluster.local:8080` ，固定值，若 authx-service 的命名空间有调整，请修改 - Default Storage Class： <请选择存储类> -* 依赖服务 - 用户服务 +* 动态密码 - 用户数据API内部地址： `http://authx-service-user-data-service-goa.authx-service.svc.cluster.local:8080` ，固定值，若 authx-service 的命名空间有调整，请修改 + 动态密码短信标题： 认证中心，固定值 + 动态密码短信模板： 请修改为合适的短信模板 -* 依赖服务 - AGENT SERVICE +* JWT 公私钥 - Agent Service 内部地址： `http://agent-service.agent-service.svc.cluster.local:8080` ，固定值，若 agent-service 的命名空间有调整，请修改 + 参考 certs/jwt/readme.md 生成公私钥pem，修改相关配置（请使用与 token-server 一致的公私钥） - Agent Service短信发送API路径： `/api/v1/tpas/sms/aliyun/send` ， 若不使用阿里云短信服务，须修改 + JWT私钥： + JWT公钥： -* 依赖服务 - CAS SERVER - CAS SA API内部地址： `http://cas-server-sa.cas-server.svc.cluster.local:8080` ，固定值，若 cas-server 的命名空间有调整，请修改 +* CAS认证 - 图片验证码 + 启用图片验证码： 是 or 否 -* TOKEN SERVER - MYSQL数据库配置 - 用户名： `token_server` ，固定值 - 密码： <请填写创建的数据库用户的密码> - 数据库名： `token_server` ，固定值 -* TOKEN SERVER设置-域名配置 +* CAS认证 - 持久卷 - 域名： `token.paas..edu.cn` ，请修改为实际的学校域名 + Default Storage Class： <请选择存储类> -* TOKEN SERVER设置-动态密码 - 动态密码短信标题： 认证中心，固定值 - 动态密码短信模板： 请修改为合适的短信模板 +* CAS认证 - DATAX数据库配置 -* TOKEN SERVER设置-JWT + 数据源JdbcUrl： `jdbc:mysql://authx-service-mysql-server.authx-service.svc.cluster.local:3306/user?serverTimezone=Asia/Shanghai` ，连接 authx-service 的mysql，若 authx-service 的命名空间有调整，请修改 + 数据源用户名： user + 数据源密码： <请填写创建的数据库用户的密码> - 参考 certs/jwt/readme.md 生成公私钥pem，修改相关配置（请使用与 cas-server 一致的公私钥） - JWT私钥： - JWT公钥： +* TOKEN SERVER - 消息服务 -* TOKEN SERVER设置-平台OPEN API + 是否开启消息服务： true or false，默认 false + 消息服务应用ID： 由消息服务提供 - Platform OpenAPI地址： `https://poa.paas..edu.cn` ，请设置为 poa 网关的外网地址 - Platform OpenAPI Client Id： 从 POA 进行申请 - Platform OpenAPI Client Secret： 从 POA 进行申请 -* TOKEN SERVER设置-消息服务 +* TOKEN SERVER - POA CLIENT - 是否开启消息服务-个推： true or false - 消息服务应用ID： 从 消息服务 进行申请 + Client Id： 从 POA 进行申请 + Client Secret： 从 POA 进行申请 -* TOKEN SERVER设置-人脸服务配置 +* TOKEN SERVER - 人脸服务配置 可与 新开普人脸平台 或 百度人脸服务 进行对接 人脸登录类型： aiface: 新开普人脸, aipface: 百度人脸