概述
简述
本文档描述了如何通过安装工具部署V8，为实施和运维人员提供参考。安装工具已适配场景见下图：
角色介绍
| 角色 | 介绍 |
|---|---|
| 管理员 | 拥有完全的微服务安装工具操作权限 |
关键能力
| 序号 | 关键能力 | 简述 |
|---|---|---|
| 1 | 环境管理 | 对安装工具创建或托管的环境进行统一管理。支持创建全新环境、支持对已创建的环境进行基础配置维护或升级、支持适配已部署环境（指未通过安装工具部署V8，但需要通过安装工具进行托管及后续的运维） |
| 2 | 许可授权 | 对某一环境的许可进行维护。支持许可（license）的在线/离线更新 |
| 3 | 服务管理 | 对某一环境已部署的服务进行维护。支持服务的启动、重启、停止、回滚、重新部署及修改参数配置（包括Nacos及K8s配置）；支持查看服务的部署日志及启动日志 |
| 4 | 应用管理 | 对某一环境的应用进行维护。支持应用的在线/离线更新 |
| 5 | 组件管理 | 对某一环境的组件进行维护。支持组件的离线更新 |
修订记录
| 序号 | 修订日期 | 版本 | 内容 |
|---|---|---|---|
| 1 | 2024.7.30 | 1.0.0 | 初始化文档 |
| 2 | 2024.8.16 | 1.1.0 | 补充前置准备工作 |
前置准备工作
环境要求
微服务部署架构图
客户端服务要求
| 端 | 分类 | 兼容环境 | 详细需求 | 支持场景 | 不支持场景 |
|---|---|---|---|---|---|
| web端 | 操作系统 | windows | win7 32&64 win8.1 32&64 win10 32&64 win11 64 | 浏览器上全功能正常 | win7 32&64 win8.1 32&64 不支持 |
| MAC | OS X 10.7以上版本 | 浏览器上全功能正常 | |||
| Linux（信创） | UOS2.0SP1（芯片：鲲鹏、龙芯） 麒麟V10（芯片：飞腾） | 浏览器上全功能正常 | 浏览器上的功能不支持 | ||
| 分辨率 | 分辨率 | 最大支持2560*1440 最小支持1366*768 最佳效果分辨率1920*1080 响应式应用和大屏应用例外 | 范围内分辨率可使用的全部功能支持 | ||
| 浏览器 | windows | Chrome/Chromium 69+ /chrome65 Edge 79+ Firefox 65+ 360se 10.1+ IE 11+ 和以这些版本作为内核封装的各种浏览器 | 浏览器可使用的全部功能支持 Firefox、edge不支持pdf、签章 | IE 11+（不支持），chrome65只支持审批应用 | |
| MAC | Chrome/Chromium 69+ Edge 79+ Firefox 65+ Safari 11.1+ | 浏览器可使用的全部功能支持 Safari 不支持pdf、签章 | |||
| 信创环境 | 国产化环境浏览器 360安全浏览器 | 浏览器可使用的全部功能支持 | 不支持 | ||
| 国产化环境浏览器 UOS浏览器 | 浏览器可使用的全部功能支持 | 不支持 | |||
| 桌面端 | 操作系统 | windows | win7 32&64 win8.1 32&64 win10 32&64 win11 64 | 移动桌面版安装、卸载，功能正常使用 | win7 32&64 win8.1 32&64 不支持 |
| MAC | OS X 10.7以上版本 | 移动桌面版安装、卸载，功能正常使用 | |||
| Linux（信创） | UOS2.0SP1（芯片：鲲鹏、龙芯） 麒麟V10（芯片：飞腾） | 移动桌面版安装、卸载，功能正常使用 | 等测试验证结果 | ||
| 移动端 | M5 | IOS设备 | iPhone设备：ios10以上系统 IPAD设备：ios10以上系统 | 安装、卸载、所有功能正常使用 | iPhone设备：ios12以上系统 IPAD设备：ios12以上系统 |
| andriod设备 | andriod手机：5.2以上 andriod平板：5.2以上 | 安装、卸载、所有功能正常使用 | andriod手机：8.0以上 andriod平板：8.0以上 | ||
| 微信、企业微信 | 安装、卸载、所有功能正常使用 | iPhone设备：ios12以上系统 IPAD设备：ios12以上系统 | |||
| 钉钉 | 安装、卸载、所有功能正常使用 | andriod手机：8.0以上 andriod平板：8.0以上 | |||
| welink | 安装、卸载、所有功能正常使用 | ||||
| 飞书 | 安装、卸载、所有功能正常使用 | ||||
| 文档客户端 | office | word | 2003以上 | 文档浏览、编辑正常使用 | 不支持 |
| excel | 2003以上 | 文档浏览、编辑正常使用 | 不支持 | ||
| powerpoint | 2003以上 | 文档浏览、编辑正常使用 | 不支持 | ||
| wps | 文档/表格/演示 | wps2019专业版 | 文档浏览、编辑正常使用 | ||
| AcrobatReader | 点聚轻阅读 | 文档浏览、编辑正常使用 | |||
| wps在线服务 | |||||
| 签章 | pdf签章 | 点聚签章（点聚轻阅读） | |||
| ofd签章 | 点聚签章（点聚轻阅读） | ||||
| office签章 | 不支持 |
运行环境服务器要求
| 端 | 分类 | 兼容环境 | 详细需求 | 支持场景 |
|---|---|---|---|---|
| 服务器 | 操作系统 | linux | 1、Linux Red Hat Enterprise 7、8 | 部署、启动、维护、备份 |
| 2、CentOs 7、8 | ||||
| 3、Ubuntu | ||||
| 4、信创：UOS2.0SP1（飞腾、龙芯、鲲鹏） | ||||
| 5、信创：麒麟V10（飞腾、龙芯、鲲鹏） |
- 检查是否64位
- 检查cpu内存是否达到最低配置要求8c16g，容器节点内存不敌低于8C64G
- 检查磁盘可用空间是否不低于200G
- 检查网卡速率是否符合基线要求，1000M
- 已部署各项服务内存之和，加上即将安装的产品内存配置（默认4G)不得超过物理内存80%
- 当前服务器可用内存不得低于物理内存60%
- Linux系统，ulimit -a检查open files和max user processes都不得低于60000
运行环境并发数描述
| 类型 | 安装资源 | 虚拟机规格 | 在线用户数对应服务器台数 | ||||
|---|---|---|---|---|---|---|---|
| cpu/mem/disk | 0-1k | 1-3k | 3-5k | 5-10k | >10k | ||
| 容器 | 容器master | 16C/32G/200G硬盘 | 高可用配置（三台或以上） | ||||
| K8S Node | 16C/64G/200G硬盘 | 6 | 6 | 9 | 12 | 具体评估 | |
| 数据库 | Mysql主从 | 16C/64G/2TSSD | 2 | 2 | 2 | 4 | 具体评估 |
| 中间件 | Kafka集群 | 8C/16G/500G硬盘 | 3 | 3 | 3 | 6 | 具体评估 |
| Redis集群 | 8C/16G/200G硬盘 | 6 | 6 | 6 | 12 | 具体评估 | |
| nginx/keeplive代理 | 16C/32G/500G硬盘 | 2 | 2 | 2 | 2 | 具体评估 | |
| nacos集群 | 8C/16G/200G硬盘 | 3 | 3 | 3 | 6 | 具体评估 | |
| ClickHouse集群 | 16C/64G/1T硬盘 | 3 | 3 | 3 | 6 | 具体评估 | |
| ElasticSearch集群 | 16C/32G/500G硬盘 | 3 | 3 | 3 | 6 | 具体评估 | |
| 运维监控 | 分布式日志ELK | 8C/16G/500G硬盘 | 1 | 1 | 1 | 1 | 具体评估 |
| 调用链监控 | 8C/16G/500G硬盘 | 1 | 1 | 1 | 1 | 具体评估 | |
| 存储 | 对象存储minio | 4C/8G/2T硬盘 | 2T硬盘 | ||||
| 镜像仓库habor | 8C/16G/2T硬盘 | 2T硬盘 | |||||
| 低代码平台服务(可选) | 流水线 | 16C/32G/500G硬盘 | 2 | 3 | 3 | 6 | 具体评估 |
| 制品仓库maven/npm | 16C/32G/500G硬盘 | 1 | 1 | 1 | 1 | 具体评估 | |
| 代码仓库 | 16C/32G/500G硬盘 | 1 | 1 | 1 | 1 | 具体评估 |
组件版本及端口
| 分类 | 资源 | 最低版本 | 默认维护端口 | 备注 |
|---|---|---|---|---|
| 基础服务 | K8S Master | 1.17.3 | 6443 | |
| K8S Node | 1.17.3 | |||
| Kafka | 2.1.0 | 9092 | ||
| Redis | 5 | 6379 | ||
| TiDB/Mysql | 5.7 | 3306 | ||
| Nginx（SLB等） | 适配 | 80、443 | ||
| Nacos | 2.2.0 | 8848、9848 | ||
| 对象存储 | 适配 | 80 | ||
| ClickHouse | 21.9.4.35 | 8123 | ||
| ElasticSearch | 7.15 | 9200、9300 | ||
| 产品服务 | flow流水线 | 产品最新版本 | 8890 | |
| Git | 2.37.0 | 无 | flow流水线依赖 | |
| Maven | 3.6.3 | 无 | ||
| Docker | 20.10.17 | 无 | ||
| Yarn | 1.22.17 | 无 | ||
| npm | 6.14.15 | 无 | ||
| mysql | 适配 | 3306 | ||
| 网关 | 产品最新版本 | 30301/30401 | ctp/cip网关暴漏容器服务端口 | |
| 限流熔断 | 产品最新版本 | 8092 |
- 通过微服务安装工具部署V8时，高于Nacos 2.3.2版本需手动调整：${nacos.home}/conf目录下的application.properties文件中，设置nacos.core.param.check.enabled=false来关闭服务端的参数校验功能
- 安装工具所在服务器配置：JAVA_HOME配置，建议版本为openjdk8
部署资源清单
| 服务分类 | 后端服务 | 前端服务 | 说明 | jvm推荐内存 | 数据库创建 |
|---|---|---|---|---|---|
| 网关服务 | ctp-webapi-gateway | webApi网关服务 | 4G | 否 | |
| cip-openapi-gateway | 开放平台网关服务 | 4G | 否 | ||
| 基础服务 | app-common | app-common | 基础应用 | 4G | 是 |
| app-office | |||||
| ctp-message | ctp-message | 消息中心 | 4G | 是 | |
| ctp-user | ctp-user | 用户(应用)中心 | 4G | 是 | |
| ctp-user-mobile | |||||
| organization | organization | 组织模型 | 4G | 是 | |
| organization-mobile | |||||
| m5 | m5-manage | 移动平台 | 4G | 是 | |
| m5-desktop | |||||
| m5-mobile | |||||
| m5-login | |||||
| m5-cloud | |||||
| portal | login | 门户 | 4G | 是 | |
| main | |||||
| main-mobile | |||||
| portal | |||||
| portal-mobile | |||||
| portal-portlet | |||||
| 流程待办 | app-approval | app-approval | 审批应用 | 6G | 是 |
| app-approval-mobile | |||||
| bpm | bpm | 流程引擎服务 | 6G | 是 | |
| ctp-affair | ctp-affair | 待办服务 | 4G | 是 | |
| ctp-affair-mobile | |||||
| 数据中台 | cdp-data | cdp-data | 数据中台服务 | 4G | 是 |
| cdp-data-mobile | |||||
| cdp-schedule | 数据分析定时任务 | 4G | 是 | ||
| 低代码平台 | udc | udc | 低代码定制平台 | 6G | 是 |
| 集成连接 | cip-capability | 能力接入服务 | 4G | 是 | |
| cip-connector | cip-manager | 集成连接器 | 4G | 是 | |
| cip-manager | third | 集成连接管理平台 | 4G | 是 | |
| 扩展服务 | ctp-media | 音视频服务 | 4G | 是 | |
| cip-convert | office转换服务(在线预览) | 4G | 是 |
常见问题
jdk基础镜像上传及配置
仅私有化部署低代码平台时才需要上传jdk基础镜像，基础镜像可联系运维获取，获取后将基础镜像上传至所属环境的镜像仓库的/jdk_base目录下，同时通过安装工具修改app-sandbox的nacos配置：
gitlab创建群组
仅私有化部署低代码平台时才需要部署gitlab，而gitlab则用于存放低代码平台搭建的应用代码，操作步骤如下：
- 登录gitlab按下图创建群组
- 通过安装工具修改nacos public配置，将群组名分配填入parentGroupPath（搭建代码存放处）和parentExtendGroupPath（手写代码存放处）。修改配置后需重启UDC服务，并在V8“系统管理_沙箱管理”处重启沙箱才可生效
修改公共桶配置
- 按下图示例修改公共桶的属性和匿名用户权限，public桶属性改为public；匿名用户权限改为readonly
pvc创建
通过容器云平台创建pvc，避免应用因缺少pvc启动失败
- 创建方式：名称为“seeyonv8-${安装工具中定义的环境标识}-dump”；存储类和容量可自主选择
svc创建
通过容器云平台创建svc，仅需创建ctp-webapi-gateway、cip-openapi-gateway即可，svc创建生效后，需同步调整nginx配置
- svc创建示例如下：
- nginx配置修改点如下：nginx端口要与网关sevice svc端口对应（见上图中红框部分）
安装工具操作说明
安装工具初始化
微服务安装工具部署完成并启动后，需要配置安装工具的密码用于后续登录，首次登录后需选择部署模式及安装方式，以上初始化配置均完成后即可使用安装工具部署V8。
部署安装工具
- 将微服务安装工具部署包上传至服务器并解压
启动安装工具
- bin目录下找到安装工具启动脚本，通过脚本启动
设置密码
- 安装工具启动成功后，通过界面设置登录密码
登录安装工具
- 输入密码登录安装工具
选择部署模式及安装方式
- 首次登录安装工具后，基于部署资源确定部署模式及安装方式，确定后将不支持修改
修改密码
- bin目录下找到安装工具重置密码脚本，通过脚本重置密码
停用安装工具
- bin目录下找到安装工具停用脚本，通过脚本停用
环境管理
微服务安装工具提供了全新环境创建和托管已部署环境的能力，支持同时部署并管理多套环境，各环境均可以独立进行应用的初始化部署、应用升级、修改配置等操作。
创建全新环境
- 进入环境管理列表进行环境创建
- **第一步：**定义环境名称及环境简称。环境名称建议用中文进行描述，如：测试环境；环境简称将用于创建Nacos命名空间，建议用英文进行描述，如：test。环境部署成功后，以下参数将不支持修改。
- **第二步：**上传商务颁发的许可文件（license）
- **第三步：**将V8部署包上传至安装工具所在的服务器并解压，填写解压后的路径进行扫描，即可获取初始化安装的应用范围
- 按需选择需要部署的应用，并对各应用的部署及启动参数（K8s）、业务参数（Nacos）进行配置。部分参数已提供默认值，可按需修改
- **第四步：**对当前环境所需的基础设施参数进行配置。该步骤需要依赖组件的部署，组件部署请参照本手册第二章内容
- **第五步：**对基础设置配置进行测试连接检查，检查通过后会安装工具会自动部署服务；检查失败后请基于报错信息修改相关参数再试
继续部署
- 因异常导致环境部署中断，可选择继续部署
修改基础配置
- 环境部署完成后，可通过界面（或编辑器）修改Nacos public配置。Nacos public修改完成后需重启全部服务才能生效
- 通过编辑器修改Nacos public配置。
升级环境
升级环境是将已部署环境的全部必装应用进行批量升级，通常为应用的前两段版本号升级，如应用版本由3.5.x升级到3.6.x
- 通过环境管理发起应用升级，升级过程与创建全新环境的操作逻辑一致，一般需要更新license，上传此次升级的应用包
- 升级环境时，环境标识不支持修改，如许可有更新需上传最新的许可文件，应用包需使用升级目标版本的应用包
- 为确保环境升级的完整，通过安装工具升级应用并启动成功后，需登录系统管理员账号执行升级程序，具体操作详见《系统管理操作手册》的系统升级模块
许可授权
安装工具提供许可（license）的查询及在线/离线更新能力。初始化部署环境时必须要上传许可，否则V8将无法使用。许可的获取及更新可联系商务部门
查询证书编码
- 环境部署完成后，可切换到指定环境查询该环境的证书编码（license code）。
离线更新许可
- 从致远商务获取到最新的许可后，可通过离线上传的方式更新许可。许可更新完毕需要重启全部服务才能生效
在线更新许可
- 安装工具可以连通外网时，将自动从协同云查询是否有可更新的许可并给出提醒，此时可选择在线更新许可或忽略
服务管理
安装工具提供服务（应用）部署的全周期管理，包括服务部署阶段的K8s/Nacos配置上传、服务的前/后端资源上传、数据初始化及变更处理、服务启动及回滚等。部署过程中会输出结构化部署日志及启动日志，方便运维或实施及时发现并处理问题。
功能说明
| 操作 | 说明 |
|---|---|
| 启动 | 对未启动的服务进行启动（安装工具操作K8s） |
| 重启 | 对已启动的服务进行重启（安装工具操作K8s） |
| 停止 | 对已启动的服务进行停止（安装工具操作K8s） |
| 回滚 | 对已启动的服务回滚至上一版本并重启服务 |
| 修改参数配置 | 修改服务的K8s配置或Nacos配置（安装工具操作K8s、Nacos） |
| 重新部署 | 对部署失败的服务重新部署 |
| 详情 | 查看已部署服务的pod状态 |
| 日志 | 查看服务的部署日志和K8s启动日志 |
状态说明
| 术语 | 说明 |
|---|---|
| 部署中 | 通过安装工具对服务进行部署，包括服务的配置文件上传过程、前后端资源上传及备份过程、数据初始化及变更过程等 |
| 部署失败 | 部署过程中因异常导致的部署中断 |
| 启动中 | 通过控制K8S对服务进行启动 |
| 未启动 | 部署阶段完成但服务无法启动或启动失败 |
| 已启动 | 通过控制K8S对服务进行启动并启动成功 |
启动服务
- 将未启动的服务进行启动
重启服务
- 将已启动的服务进行重启
停止服务
- 将已启动的服务进行停止
修改参数
修改部署及启动参数（K8s）
- 支持通过界面或编辑器修改，参数修改完毕后需重启服务才可生效
* yaml配置请谨慎修改
修改业务参数（Nacos）
- 支持通过界面或编辑器修改，参数修改完毕后需重启服务才可生效
* yaml配置请谨慎修改
重新部署服务
- 对部署失败的服务重新部署
应用管理
安装工具提供应用的在线及离线更新能力，离线包可通过协同云下载或联系运维人员获取；在线更新指通过协同云下单成功后，如安装工具可连接外网，安装工具将自动从协同云获取可更新的应用清单。
离线更新应用
将应用包上传至安装工具服务器进行更新
- 将下载好的应用包上传至安装工具所在的服务器并解压，填写解压后的路径进行扫描
- 检查扫描出的应用参数配置是否完整，填写完成后即可进行应用安装
本地上传应用包进行更新
- 从本地上传应用包进行更新，由于应用包较大，上传耗时可能会很长，不建议采用此方式
- 应用包上传完成后参照上方说明进行应用安装
在线更新应用
- 安装工具可以连通外网时，将自动从出盘服务查询是否有可更新的应用，此时可以选择在线下载应用
- 应用下载完成后可进行应用安装，安装时需要检查应用参数配置是否完整（参照上方说明），确认无误后即可进行应用安装
组件管理
组件管理主要用环境出初始化部署时的全量前/后端组件上传及更新和私有化部署低代码平台的构建组件上传及更新。V8已对前端组件进行外部化处理，各应用部署完成后，需同时上传完整的前端业务组件才可正常使用V8。当私有化部署低代码平台时，低代码应用的构建会依赖构建组件，请及时上传；未部署低代码平台时可不关注该类型的组件
前/后端组件更新
- 将下载好的前/后端包上传至安装工具所在的服务器并解压，填写解压后的路径进行扫描
查看更新日志
安装工具更新
手动更新
- 备份数据：备份db/deployment.db
- 更新安装工具：下载最新版本的安装工具安装包，将安装包上传至服务器后解压覆盖，再环境之前备份的deployment.db