feat: 临时人员管理,部署文档
author刘洪青 <hongqing.liu@supwisdom.com>
Fri, 11 Feb 2022 10:25:03 +0000 (18:25 +0800)
committer刘洪青 <hongqing.liu@supwisdom.com>
Fri, 11 Feb 2022 10:25:03 +0000 (18:25 +0800)
deploy-manifests/charts/3.temporary-management/0.0.0000.临时人员管理_安装部署手册(基于应用商店).md [new file with mode: 0644]
deploy-manifests/charts/3.temporary-management/1.0.0001.临时人员管理_认证对接数据初始化.md [new file with mode: 0644]
deploy-manifests/charts/3.temporary-management/1.0.0002.临时人员管理_用户服务数据初始化(配置).md [new file with mode: 0644]
deploy-manifests/charts/3.temporary-management/1.0.0003.临时人员管理_授权服务数据初始化(应用、角色).md [new file with mode: 0644]

diff --git a/deploy-manifests/charts/3.temporary-management/0.0.0000.临时人员管理_安装部署手册(基于应用商店).md b/deploy-manifests/charts/3.temporary-management/0.0.0000.临时人员管理_安装部署手册(基于应用商店).md
new file mode 100644 (file)
index 0000000..7acd8a2
--- /dev/null
@@ -0,0 +1,266 @@
+
+# 安装部署手册
+
+**临时人员管理**
+
+
+* 修订历史
+
+版本 | 作者 | 日期 | 备注
+- | - | - | -
+v1 | 刘洪青 | 2022-02-11 | 初稿
+
+
+[TOC]
+
+
+## 部署变更说明
+
+**仅列举了一些重要的、对外部存在影响的变更**
+
+
+## 产品依赖
+
+* platform openapi
+
+确保已部署,或 请使用 应用商店 部署
+
+* agent-service
+
+请使用 应用商店 部署
+
+* cas-server 认证
+
+请使用 应用商店 部署
+
+* authx-service 用户授权
+
+请使用 应用商店 部署
+
+* formflow 流程平台
+
+请使用 应用商店 部署
+
+* message-service 消息服务
+
+请使用 应用商店 部署
+
+
+## 数据库要求
+
+须 MySQL 数据库
+
+
+## 安装准备
+
+### Harbor 镜像同步
+
+  从 https://harbor.supwisdom.com 中同步镜像
+
+  ```
+  temporary-management      temporary-management/*
+  ```
+
+### Rancher 商店设置、项目创建
+
+* 商店设置
+
+  进入 全局 - 集群(具体名称视项目安装而定) - 工具 - 商店设置,添加应用商店
+
+  名称:`supwisdom`
+  商店URL地址:`https://e.coding.net/supwisdom/charts/charts.git`
+  分支:`master`
+  范围:选择`cluster`
+
+
+* 创建项目
+
+  进入 全局 - 集群(具体名称视项目安装而定) - 项目/命名空间,添加项目
+
+  输入 项目名称,保存
+
+  本产品所须创建的项目名称为:`authx-platform`
+
+
+* 启动应用
+
+  进入 全局 - 集群(具体名称视项目安装而定) - 项目(某个项目)
+
+  进入 应用商店
+
+  点击 启动,在应用列表中 找到 相关应用
+
+  点击 该应用,选择模板版本(一般选择最新的版本),根据情况设置 配置选项,启动 即可
+
+  本产品所须的相关应用清单:
+
+  ```
+  temporary-management        临时人员管理
+  ```
+
+* 确定命名空间
+
+  本产品安装过程中所须的命名空间如下:
+
+  ```
+  temporary-management        临时人员管理
+  ```
+
+### 域名准备
+
+* 确定域名
+
+  首先明确是否使用泛域名,如:`*.paas.xxx.edu.cn`,或 直接使用学校域名 `xxx.edu.cn`
+
+  本产品安装需要的域名如下:
+
+  ```
+  temporary-management.paas.xxx.edu.cn        临时人员管理
+  ```
+
+  如果使用 学校域名,则去除 .paas 即可,同时申请开通相关域名
+
+
+
+
+## 开始安装
+
+### 数据库安装(略)
+
+* 确定服务地址、端口
+
+  明确MySQL 数据库的 IP、端口
+
+
+### 数据库创建
+
+* 数据库帐号
+
+  以下是 各服务对应的数据库帐号
+
+  服务 | 数据库帐号
+  - | -
+  临时人员管理 temporary-management | temporary_management
+
+  命令:
+  **请修改命令中的 `your_password` 为实际的数据库用户的密码**
+  ```
+  create user 'temporary_management'@'%' identified with mysql_native_password  by 'your_password';
+  ```
+
+
+* 数据库
+
+  以下是 各服务对应的数据库
+
+  服务 | 数据库
+  - | -
+  临时人员管理 temporary-management | temporary_management
+
+  命令:
+  ```
+  create database `temporary_management` DEFAULT CHARSET utf8 COLLATE utf8_general_ci;
+  ```
+
+
+* 数据库权限授予
+
+  将 database 的权限授予对应的帐号
+
+  命令:
+  ```
+  grant all privileges on `temporary_management`.* to 'temporary_management'@'%' with grant option;
+  ```
+
+
+**创建好 数据库用户 temporary-management ,记下 用户密码**
+
+
+### rancher 部署(应用商店)
+
+#### temporary-management
+
+命名空间: temporary-management
+
+* MYSQL数据库配置 - 服务地址
+  MySQL服务 host: <请填写数据库服务的IP地址>
+  MySQL服务 port: <请填写数据库服务的端口>
+
+* MYSQL数据库配置 - 用户服务
+
+  用户名: `temporary_management` ,固定值、或按实际情况修改
+  密码: <请填写创建的数据库用户的密码>
+  数据库名: `temporary_management` ,固定值、或按实际情况修改
+
+
+* 域名全局设置
+
+  根域名: `paas.<school>.edu.cn` ,请修改为实际的学校域名
+
+* 域名配置 - 临时人员管理
+
+  子域名: `temporary-management` ,若须修改,根据实际情况修改即可
+
+
+* POA 设置
+
+  POA网关地址: `http://poa.paas.<school>.edu.cn` ,请设置为 poa 网关的外网地址
+
+
+* 依赖服务 - 认证设置
+
+  CAS认证地址: `http://cas.paas.<school>.edu.cn/cas` ,请设置为 cas 认证的外网地址
+
+
+* 依赖 API - AGENT SERVICE
+
+  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` , 若不使用阿里云短信服务,须修改
+  Agent Service 人脸服务接口: `/api/v1/tpas/face/aiface` ,新开普人脸 aiface,百度人脸 aipface
+
+* 依赖 API - CAS SERVER
+
+  CAS内部地址: `http://cas-server-webapp.cas-server.svc.cluster.local:8080/cas` ,固定值,若 cas-server 的命名空间有调整,请修改
+
+* 依赖 API - 用户服务
+
+  用户数据API的内部地址: `http://authx-service-user-data-service-goa.authx-service.svc.cluster.local:8080` ,固定值,若 authx-service 的命名空间有调整,请修改
+
+* 依赖 API - 授权服务
+
+  用户授权API的内部地址: `http://authx-service-user-authz-service-sa.authx-service.svc.cluster.local:8080` ,固定值,若 authx-service 的命名空间有调整,请修改
+
+* 依赖 API - 流程服务
+
+  流程服务API的内部地址: `http://formflow-formflow.formflow.svc.cluster.local:8080/formflow` ,固定值,若 formflow 的命名空间有调整,请修改
+  流程服务 keys: `TtcTmxwbGJ6VnZhVE0xV1dGR05XRTJOVFZaY1djMVlTdEg=` ,固定值
+
+  用户自主注册申请流程ID: `b3a98487-ca56-4a1b-95fb-44569528ab7d`
+
+  部门管理员添加临时人员申请流程ID: `fcfe7f4e-309a-4188-8213-3fcd54a5cc91`
+  部门管理员添加临时人员申请流程 - API子表单: `sonform_colorful_egg_1619508906646`
+
+* 临时人员管理后端 - POA CLIENT
+
+  用于通过 POA 调用消息服务的接口
+
+  Client Id: 从 POA 进行申请
+  Client Secret: 从 POA 进行申请
+
+
+* 临时人员管理后端 - 消息服务
+
+  调用消息服务的接口,所须的应用ID
+
+  是否开启消息服务: true or false,默认 false
+  消息服务应用ID: 由消息服务提供
+
+
+
+
+
+
+
diff --git a/deploy-manifests/charts/3.temporary-management/1.0.0001.临时人员管理_认证对接数据初始化.md b/deploy-manifests/charts/3.temporary-management/1.0.0001.临时人员管理_认证对接数据初始化.md
new file mode 100644 (file)
index 0000000..6121343
--- /dev/null
@@ -0,0 +1,62 @@
+
+# 临时人员管理 - 认证对接数据初始化.md
+
+
+[TOC]
+
+
+## 文档说明
+
+
+
+## 操作指南
+
+**请仔细阅读文档后,再进行操作**
+
+
+
+## 初始化数据
+
+
+### 创建认证对接应用
+
+为了支持 临时人员管理 能够实现单点登录,需要在认证 的 TB_SERVICE 里初始化配置信息
+
+
+#### 方式,SQL脚本
+
+连接至 cas_server 数据库,执行以下 SQL脚本
+
+```sql
+use cas_server;
+
+-- temporary-management 认证对接信息
+INSERT INTO `TB_SERVICE` (`ID`, `COMPANY_ID`, `DELETED`, `ADD_ACCOUNT`, `ADD_TIME`, 
+  `NAME`, `DESCRIPTION`, `INFORMATION_URL`, `LOGOUT_URL`, 
+  `RESPONSE_TYPE`, `LOGOUT_TYPE`, 
+  `EVALUATION_ORDER`, `FRIENDLY_NAME`, `REGISTERED_SERVICE_ID`, `SERVICE_ID`, 
+  `ENABLED`, `SSO_ENABLED`, `REQUIRE_ALL_ATTRIBUTES`, 
+  `APPLICATION_ID`, `EXTERNAL_ID`)
+VALUES ('100', '1', 0, 'init', now(),
+  '临时人员管理', '临时人员管理', 'https://temporary-management.paas.example.com', 'https://temporary-management.paas.example.com/?clearCertification=clearCertification', 
+  'REDIRECT', 'FRONT_CHANNEL', 
+  100, '临时人员管理', 100, 'https://temporary-management.paas.example.com/(.*)', 
+  1, 1, 1, 
+  '100', '100');
+
+commit;
+
+-- 修改根域名
+update TB_SERVICE 
+set 
+  INFORMATION_URL='http://temporary-management.paas.example.com', 
+  LOGOUT_URL='http://temporary-management.paas.example.com/?clearCertification=clearCertification', 
+  SERVICE_ID='http://temporary-management.paas.example.com/(.*)', 
+  ID_TOKEN_ENABLED=1,
+  JWT_AS_SERVICE_TICKET=1,
+  APPLICATION_DOMAIN='temporary-management.paas.example.com'
+where ID='100';  -- todo, modify
+
+commit;
+
+```
\ No newline at end of file
diff --git a/deploy-manifests/charts/3.temporary-management/1.0.0002.临时人员管理_用户服务数据初始化(配置).md b/deploy-manifests/charts/3.temporary-management/1.0.0002.临时人员管理_用户服务数据初始化(配置).md
new file mode 100644 (file)
index 0000000..ffb9239
--- /dev/null
@@ -0,0 +1,39 @@
+
+# 临时人员管理 - 用户服务数据初始化.md
+
+
+[TOC]
+
+
+## 文档说明
+
+
+
+## 操作指南
+
+**请仔细阅读文档后,再进行操作**
+
+
+
+## 初始化数据
+
+
+### 创建用户服务配置
+
+临时人员账号生成策略
+
+#### 方式,SQL脚本
+
+连接至 user 数据库,执行以下 SQL脚本
+
+```sql
+use user;
+
+INSERT INTO TB_B_CONFIG(ID, COMPANY_ID, DELETED, CATEGORY_CODE, CATEGORY_NAME, NAME, DESCRIPTION, CONFIG_KEY, CONFIG_VALUE, EDITABLE)
+VALUES ('1501', '1', 0, 'temporary-management-account-strategy', '临时人员账号生成策略', '固定值', '', 'temporary.management.account.strategy.fixed.value', '0000', 1);
+INSERT INTO TB_B_CONFIG(ID, COMPANY_ID, DELETED, CATEGORY_CODE, CATEGORY_NAME, NAME, DESCRIPTION, CONFIG_KEY, CONFIG_VALUE, EDITABLE)
+VALUES ('1502', '1', 0, 'temporary-management-account-strategy', '临时人员账号生成策略', '递增值', '', 'temporary.management.account.strategy.increase.value', '0', 1);
+
+commit;
+```
+
diff --git a/deploy-manifests/charts/3.temporary-management/1.0.0003.临时人员管理_授权服务数据初始化(应用、角色).md b/deploy-manifests/charts/3.temporary-management/1.0.0003.临时人员管理_授权服务数据初始化(应用、角色).md
new file mode 100644 (file)
index 0000000..2a747ba
--- /dev/null
@@ -0,0 +1,68 @@
+
+# 临时人员管理 - 授权服务数据初始化.md
+
+
+[TOC]
+
+
+## 文档说明
+
+
+
+## 操作指南
+
+**请仔细阅读文档后,再进行操作**
+
+
+
+## 初始化数据
+
+
+### 创建授权应用
+
+#### 方式,SQL脚本
+
+连接至 user_authz 数据库,执行以下 SQL脚本(如果已经存在相关数据,则无须执行;建议比对下数据是否正确)
+
+```sql
+use user_authz;
+
+INSERT INTO TB_R_SYSTEM (ID, COMPANY_ID, DELETED, ADD_ACCOUNT, ADD_TIME, 
+  BUSINESS_DOMAIN_ID, 
+  CODE, NAME, ENABLED)
+VALUES ('100', '1', 0, 'init', now(), 
+  '1', 
+   'temporary-management', '临时人员管理', 1);
+
+INSERT INTO TB_APPLICATION (ID, COMPANY_ID, DELETED, ADD_ACCOUNT, ADD_TIME, 
+  BUSINESS_DOMAIN_ID, SYSTEM_ID, 
+  NAME, APPLICATION_ID, SYNC_URL, ENABLED)
+VALUES ('100', '1', 0, 'init', now(), 
+  '1', '100', 
+  '临时人员管理', '100', '', 1);
+
+commit;
+```
+
+
+### 创建应用角色
+
+#### 方式,SQL脚本
+
+连接至 user_authz 数据库,执行以下 SQL脚本(如果已经存在相关数据,则无须执行;建议比对下数据是否正确)
+
+```sql
+use user_authz;
+
+INSERT INTO TB_ROLE (ID, COMPANY_ID, DELETED, ADD_ACCOUNT, ADD_TIME, APPLICATION_ID, CODE, NAME, DESCRIPTION, ENABLED, EXTERNAL_ID)
+VALUES ('100', '1', 0, 'admin', '2019-07-01 00:00:00', '100', 'temporary-admin', '临时人员管理员', '临时人员管理员', 1, '100');
+
+INSERT INTO TB_ROLE (ID, COMPANY_ID, DELETED, ADD_ACCOUNT, ADD_TIME, APPLICATION_ID, CODE, NAME, DESCRIPTION, ENABLED, EXTERNAL_ID)
+VALUES ('101', '1', 0, 'admin', '2019-07-01 00:00:00', '100', 'temporary-view-admin', '临时人员查看权限管理员', '临时人员查看权限管理员', 1, '101');
+INSERT INTO TB_ROLE (ID, COMPANY_ID, DELETED, ADD_ACCOUNT, ADD_TIME, APPLICATION_ID, CODE, NAME, DESCRIPTION, ENABLED, EXTERNAL_ID)
+VALUES ('102', '1', 0, 'admin', '2019-07-01 00:00:00', '100', 'temporary-management-admin', '临时人员管理权限管理员', '临时人员管理权限管理员', 1, '102');
+
+commit;
+```
+
+