# 安装部署

# 前置准备工作

·

  • 基础设施准备:部署并获取中间件服务地址及认证信息

  • 部署安装工具:将安装工具部署包上传至服务器并解压

  • 部署包准备:将V8安装包上传至安装工具所在服务器并解压,需注意3.12及后续版本的初始化安装包结构有所调整,解压时install安装包内的各个应用也需要解压

  • 联系商务获取license

  1. # 首次使用安装工具

    1. # 启动安装工具

  • bin目录下找到安装工具启动脚本进行启动

descript{width="6.299305555555556in" height="2.7275339020122487in"}

安装工具启动成功后访问地址为:部署服务器IP+端口,默认端口8888;如 http://10.100.100.100:8888/ (opens new window)

# 设置密码

  • 安装工具启动成功后可设置登录密码,用户名默认admin,不支持修改

descript{width="6.299305555555556in" height="3.4909120734908137in"}

# 登录安装工具

  • 输入用户名及密码登录安装工具

descript{width="6.299305555555556in" height="3.514937664041995in"}

# 选择部署模式及安装方式

  • 首次登录安装工具后,基于部署资源确定部署模式及安装方式,确定后将不支持修改。目前经支持"微服务"部署方式,"K8S+docker"安装方式

descript{width="6.299305555555556in" height="3.51170384951881in"}

# 修改备份目录

  • 安装工具默认备份目录:/usr/local/app/backup;为不影响应用备份,确保磁盘剩余空间充足,建议及时修改备份目录

descript{width="6.299305555555556in" height="2.8744728783902014in"}

# 修改密码

  • bin目录下找到安装工具重置密码脚本进行密码重置

descript{width="6.299305555555556in" height="2.729384295713036in"}

# 停用安装工具

  • bin目录下找到安装工具停用脚本停用安装工具

descript{width="6.299305555555556in" height="2.7169827209098862in"}

# 管理环境

安装工具提供了全新环境创建和适配已部署环境的能力,支持同时部署并管理多套环境,各环境均可以独立进行应用的初始化部署、应用升级、打补丁、修改配置等操作。

# 创建全新环境

创建全新环境适用于新客户POC阶段或正式入场阶段,可通过安装工具为客户部署新环境。

  • 进入环境管理列表,点击 [创建环境] 按钮

descript{width="6.299305555555556in" height="2.880536964129484in"}

  • **第一步:**定义环境名称及环境简称。环境名称建议用中文进行描述,如:测试环境;环境简称将用于创建Nacos/K8S命名空间,建议用英文进行描述,如:test。环境部署成功后,环境名称及环境简称将不支持修改。

descript{width="6.299305555555556in" height="2.8823392388451445in"}

  • **第二步:**上传商务颁发的许可文件(license)

descript{width="6.299305555555556in" height="2.8905041557305338in"}

  • **第三步:**将V8部署包上传至安装工具所在的服务器并解压,填写解压后的路径进行扫描,即可选取初始化安装的应用范围

descript{width="6.299305555555556in" height="2.8681375765529307in"}

  • 按需选择需要部署的应用,并对各应用的部署及启动参数(K8s)、业务参数(Nacos)进行配置。部分参数已提供默认值,也可按需修改

descript{width="6.299305555555556in" height="2.8615146544181975in"}

descript{width="6.299305555555556in" height="2.860906605424322in"}

  • **第四步:**对当前环境所需的基础设施参数进行配置。该步骤需要依赖中间件的部署,中间件部署请参照本手册第二章"环境要求"中的内容。需注意:Nacos地址暂不支持https协议

descript{width="6.299305555555556in" height="2.863620953630796in"}

  • **第五步:**对中间件进行测试连接检查,包括中间件是否可以访问、中间件版本是否合规等。检查通过后安装工具将自动部署服务;检查失败后请基于错误信息修改相关配置后再试。测试连接检查阶段,安装工具将执行以下动作:

    • Nacos:检测seeyon/dubbo命名空间是否存在,不存在将自动创建

    • Kubernetes:检测命名空间是否存在,不存在将自动创建;检查PVC是否创建,不存在将自动创建

    • 镜像仓库:检测镜像仓库是否存在,不存在将自动创建

    • 对象存储:检测公共桶、私有桶、摆渡桶是否存在,不存在将自动创建

    • Gitlab:检测群组是否存在,不存在将自动创建

    • 消息服务:自动创建topic

descript{width="6.299305555555556in" height="2.8702744969378826in"}

# 适配已部署环境

适配已部署环境用于运维手动为客户部署环境后,后续准备使用安装工具进行维护,可采用"适配已部署环境+升级环境"的方式处理,升级环境功能详见3.5章节。如仅适配已部署环境,未升级环境,安装工具的部分功能将不可用,如配置修改、服务启停等

  • 进入环境管理列表,点击 [适配已部署环境] 按钮

descript{width="6.299305555555556in" height="2.883578302712161in"}

  • **第一步:**填写环境名称并选择当前已部署环境的系统版本,环境名称建议用中文进行描述,如:测试环境

descript{width="6.299305555555556in" height="2.884419291338583in"}

  • **第二步:**上传商务颁发的许可文件(license)

descript{width="6.299305555555556in" height="2.8784470691163606in"}

  • **第三步:**填写该环境的Nacos和K8s配置

descript{width="6.299305555555556in" height="2.877214566929134in"}

  • **第四步:**Nacos和K8s测试连接通过后,安装工具将自动获取该环境下已部署的应用列表,v8标准应用已自动选取,私有化低代码平台搭建的应用和sandbox请勿选择;通过协同云云设计中心搭建的低代码应用建议选择,后续也可通过安装工具进行更新

descript{width="6.299305555555556in" height="2.8871817585301836in"}

  • **第五步:**选择应用并保存环境后,即可对适配环境进行维护

    1. # 继续部署环境

<!-- -->
  • 因工具异常或准备工作不足导致环境部署中断后,可选择继续部署。继续部署时,该环境已填写的配置信息不会丢失

descript{width="6.299305555555556in" height="2.8808202099737534in"}

# 修改环境基础配置

  • 环境部署完成后,可通过界面(或编辑器)修改基础配置,基础配置包含Nacos public配置。配置修改完成后需重启全部服务才能生效

descript{width="6.299305555555556in" height="2.8759864391951004in"}

descript{width="6.299305555555556in" height="2.8696467629046367in"}

  • 通过编辑器修改基础配置,编辑器支持搜索/替换配置

descript{width="6.299305555555556in" height="2.853700787401575in"}

descript{width="6.299305555555556in" height="2.862717629046369in"}

# 升级环境

升级环境是将当前环境的全部应用进行批量升级,以达到系统大版本升级的目的。如将全部应用版本由3.5.x升级到3.6.x

  • 通过环境管理发起应用升级,升级过程与创建全新环境的操作逻辑基本一致,仅需要更新license、上传此次升级的应用包即可

descript{width="6.299305555555556in" height="2.880252624671916in"}

descript{width="6.299305555555556in" height="2.88290135608049in"}

  • 升级应用时,工具将自动比对远端配置与本地配置是否有差异,如有差异可通过编辑器进行修改,避免本地配置缺失并更新后,导致远端配置被覆盖影响业务。

descript{width="6.299305555555556in" height="2.8841393263342083in"}

descript{width="6.299305555555556in" height="2.8666502624671915in"}

descript{width="6.299305555555556in" height="2.8795877077865266in"}

  • 填写基础配置时,与上述操作相似,安装工具也会比对远程配置与本地配置的差异,避免因配置变更导致客户环境异常

  • 以上操作均完成后,安装工具将自动进行测试连接,测试连接通过后将自动执行环境升级

  • 通过安装工具将环境升级完成后,还需登录V8系统管理后台进行系统升级,详见AI-COP A9 领航版 V3.10 系统管理 用户操作手册 (opens new window) "系统升级"章节

    1. # 环境设置

用于对所在环境的高级功能进行设置,当前已支持"配置自动比对"和"配置自动上传"功能的开启/关闭。

  • 配置比对:开启后,安装工具将自动拉取Nacos、Kubernetes远端配置与本地配置进行比对,避免配置不一致导致服务异常

  • 配置上传:开启后,安装工具可将本地Nacos配置上传至远端

descript{width="6.299305555555556in" height="2.8497648731408574in"}

# 管理许可

安装工具提供许可(license)的查询及在线/离线更新能力。初始化部署环境时必须要上传许可,否则V8将无法使用。许可的获取及更新可联系商务部门

# 查询证书编码

  • 环境部署完成后,可切换到指定环境查询该环境的证书编码(license code)。

descript{width="6.299305555555556in" height="2.881103455818023in"}

# 离线更新许可

  • 从致远商务获取到最新的许可后,可通过离线上传的方式更新许可。许可更新完毕需要重启全部服务才能生效

descript{width="6.299305555555556in" height="2.8841393263342083in"}

descript{width="6.299305555555556in" height="2.867544838145232in"}

# 在线更新许可

  • 安装工具可以连通外网时,将自动从协同云查询是否有可更新的许可并给出提醒,此时可选择在线更新许可或忽略此次更新

descript{width="6.299305555555556in" height="2.856700568678915in"}

# 管理服务

安装工具提供服务(应用)部署的全周期管理,包括服务部署阶段的K8s/Nacos配置上传、服务的前/后端资源上传、数据初始化及变更处理、服务启动及回滚等。部署过程中会输出结构化部署日志及启动日志,方便运维或实施及时发现并处理问题。

功能说明


操作 说明

启动 对未启动的服务进行启动(安装工具操作K8s)

重启 对已启动的服务进行重启(安装工具操作K8s)

停止 对已启动的服务进行停止(安装工具操作K8s)

回滚 对已启动的服务回滚至上一版本并重启服务

修改参数配置 修改服务的K8s配置或Nacos配置(安装工具操作K8s、Nacos)

重新部署 对部署失败的服务重新部署

详情 查看已部署服务的pod状态

日志 查看服务的部署日志和K8s启动日志


状态说明


术语 说明

部署中 通过安装工具对服务进行部署,包括服务的配置文件上传过程、前后端资源上传及备份过程、数据初始化及变更过程等

部署失败 部署过程中因异常导致的部署中断

启动中 通过控制K8S对服务进行启动

未启动 部署阶段完成但服务无法启动或启动失败

已启动 通过控制K8S对服务进行启动并启动成功


# 启动/重启/停止服务

descript{width="6.299305555555556in" height="2.870863954505687in"}

# 重新部署服务

  • 对部署失败的服务重新部署

descript{width="6.299305555555556in" height="2.868759842519685in"}

# 修改服务配置

修改部署及启动参数(K8s)

  • 支持通过界面或编辑器修改,参数修改完毕后需重启服务才可生效

descript{width="6.299305555555556in" height="2.8681375765529307in"}

descript{width="6.299305555555556in" height="2.8615146544181975in"}

* yaml配置请谨慎修改

修改业务参数(Nacos)

  • 支持通过界面或编辑器修改,参数修改完毕后需重启服务才可生效

descript{width="6.299305555555556in" height="2.8467694663167102in"}

descript{width="6.299305555555556in" height="2.864225721784777in"}

* yml配置请谨慎修改

配置比对

  • 开启配置比对功能后,安装工具将自动拉取Nacos、Kubernetes远端配置与本地配置进行比对,避免配置不一致导致服务异常,如比对出异常参数,请返回参数配置页面修改

descript{width="6.299305555555556in" height="2.879303368328959in"}

* 异常配置通过特殊颜色进行标识

# 查看Pod详情

descript{width="6.299305555555556in" height="2.860602580927384in"}

# 查看服务部署日志

  • 服务部署时可通过结构化日志呈现全部部署过程,部署异常时将返回明确的异常原因,便于操作人员排查问题

descript{width="6.299305555555556in" height="2.864826115485564in"}

# 查看服务启动日志

  • 安装工具可从K8S自动拉取Pod的最近1000条日志

descript{width="6.299305555555556in" height="2.864225721784777in"}

# 管理应用

安装工具提供应用的在线及离线更新能力,在线更新指通过协同云下单成功后,如安装工具可连接外网,安装工具将自动从出盘服务平台获取可更新的应用;离线更新时,需联系运维人员获取安装包才可通过安装工具更新应用。

# 离线更新应用

将应用包上传至安装工具服务器进行更新

  • 下载好的应用包上传至安装工具所在的服务器并解压,填写解压后的路径进行扫描

descript{width="6.299305555555556in" height="2.8866272965879265in"}

descript{width="6.299305555555556in" height="2.863924978127734in"}

  • 检查扫描出的应用参数配置是否完整,填写完成后即可进行应用安装

descript{width="6.299305555555556in" height="2.8584809711286088in"}

本地上传应用包进行更新

  • 从本地上传应用包进行更新,由于应用包较大,上传耗时可能会很长,不建议采用此方式

descript{width="6.299305555555556in" height="2.853700787401575in"}

# 在线更新应用

  • 安装工具可以连通外网时,将自动从出盘服务平台查询是否有可更新的应用,此时可以选择在线下载应用

descript{width="6.299305555555556in" height="2.8657360017497813in"}

  • 应用下载完成后可进行应用安装,安装时需要检查应用参数配置是否完整,确认无误后即可进行应用安装

# 管理补丁

安装工具提供补丁的在线及离线更新能力,在线更新指通过出盘服务平台发布补丁成功后,如安装工具可连接外网,安装工具将自动从出盘服务平台获取可更新的补丁;离线更新时,需联系运维/研发人员获取补丁包才可通过安装工具更新补丁。

# 离线更新补丁

将补丁包上传至安装工具服务器进行更新

  • 下载好的补丁包上传至安装工具所在的服务器并解压,填写解压后的路径进行扫描

descript{width="6.299305555555556in" height="2.883015091863517in"}

descript{width="6.299305555555556in" height="2.873892169728784in"}

本地上传补丁包进行更新

  • 从本地上传补丁包进行更新,由于补丁包较大,上传耗时可能会很长,不建议采用此方式

descript{width="6.299305555555556in" height="2.8723775153105864in"}

# 在线更新补丁

  • 安装工具可以连通外网时,将自动从出盘服务平台查询是否有可更新的补丁,此时可以选择在线下载补丁

descript{width="6.299305555555556in" height="2.8775010936132985in"}

  • 补丁下载完成后可进行补丁安装

# 管理组件

组件管理主要用环境出初始化部署时的全量前/后端组件上传及更新和私有化部署低代码平台的构建组件上传及更新。V8已对前端组件进行外部化处理,各应用部署完成后,需同时上传完整的前端业务组件才可正常使用V8。当私有化部署低代码平台时,低代码应用的构建会依赖构建组件,请及时上传;未部署低代码平台时可不关注该类型的组件

# 前/后端组件更新

  • 将下载好的前/后端包上传至安装工具所在的服务器并解压,填写解压后的路径进行扫描

descript{width="6.299305555555556in" height="2.607253937007874in"}

descript{width="6.299305555555556in" height="3.4722637795275593in"}

descript{width="6.299305555555556in" height="3.52536854768154in"}

# 查看更新日志

descript{width="6.299305555555556in" height="3.4996139545056866in"}

# 安装工具更新

注意:安装工具只有3.10及后续版本才支持自更新,如客户现场环境所用的安装工具低于3.10,建议将客户环境先用3.10以上版本托管后再进行升级,详见3.2章节

# 在线更新

  • 使用安装工具检查是否有可更新版本,并发起更新

descript{width="6.299305555555556in" height="2.869351487314086in"}

# 离线更新

  • 使用离线包进行更新

descript{width="6.299305555555556in" height="2.87330927384077in"}

  • 离线更新时,可选择扫描本地路径或上传包的方式

descript{width="6.299305555555556in" height="2.869351487314086in"}

# 手动更新

  • 备份数据:备份db/deployment.db

  • 更新:下载最新版本的安装工具安装包,将安装包上传至服务器后解压覆盖

#

  1. # 设置

    1. # 设置备份目录

  • 服务更新时,安装工具会对老版本进行整体备份,确保更新出错后回滚至老版本。备份目录则用于存放服务的前端工程、后端镜像等

descript{width="6.299305555555556in" height="2.858202099737533in"}

# 设置是否启用中间件版本检测

  • 工具默认启用中间件版本检测,避免因中间件版本不符合要求而产生无法预知的异常,如需关闭或调整中间件版本检测规范,可前往etc目录下打开application-h2.yml文件进行调整

descript{width="6.299305555555556in" height="3.0158147419072616in"}

详细配置见下图

descript{width="6.21875in" height="4.822916666666667in"}

# 常见问题

# 存储卷声明(pvc)创建

通过容器云平台创建存储卷声明(pvc),避免应用因缺少pvc导致服务启动失败

  • 创建方式:登录容器云平台创建存储卷声明,名称为"seeyonv8-${安装工具中定义的环境标识}-dump"和""seeyonv8-${安装工具中定义的环境标识}-log""存储类和存储容量可自定义

descript{width="6.299305555555556in" height="2.6303554243219596in"}

# 修改nginx配置

安装工具会自动创建svc,环境部署完成后需同步调整nginx配置,调整点如下:nginx端口要与网关sevice svc端口对应

#

# Docker连接镜像仓库默认协议为https,如果是http报错

修改/etc/docker/daemon.json文件配置insecure-registries。示例:

descript{width="5.78125in" height="1.3645833333333333in"}

# Harbor自签https证书测试连接不通过

安装工具服务器上通过keytool -keystore ./cacerts --import -alias harbor -file ./harbor.pem导入harbor证书

编撰人:het、liluyf