部署说明（新版交付物）

飞书用户5243

9月26日修改

1.
发版交付物概述​

•
什么是发版交付物（部署物料）？​

1.
发版交付物是由开发提供的一份标准部署材料包，每个系统新发版本，都会提供对应版本的一套标准交付物。​

2.
它是一套可供运维直接部署或升级系统的标准化文件清单，包含镜像、部署模版、文档等内容。​

1.1
交付物分类​

•
开发准备的交付物内容分类如下：​

1.
各系统每次发版提供的交付物均按照以上类型划分，共计5类，其中中控类为必须项，其余类根据版本内容按需提供。​

2.
文档类中的部署手册，非必须提供，如果某个版本不涉及人工操作部署、无关联系统依赖、无其他特殊情况说明，则可以不提供。部署手册中仅包含无法自动化执行的部署流程说明；​

3.
属地部署前需要提前获取上述交付物，按标准部署流程执行。​

1.2
中控类说明​

1.
中控类是部署流程的“控制塔”，里面包含了具体的部署内容及步骤。​

2.
中控类类似过去的部署手册，它指导运维同事或自动化工具应该如何完成部署。​

中控类是三个 .csv 文件，分别为全局变量清单，脚本执行计划，以及容器部署计划，具体执行顺序如下：

画板

4.
中控类交付物说明：​

•
全局变量清单​global-vars-template，记录部署中需要替换到部署模版中的环境相关变量，部署开始前，需要提前编辑该csv文件，填写这些变量所在环境的具体值。​

•
脚本编排计划​script-execution-plan，用于描述本次部署涉及执行的脚本（mysql、redis等）及执行顺序。​

•
容器编排计划​deploy-execution-plan-template，用于描述本次部署涉及的K8S资源及部署顺序。​

2.
部署流程​

2.1
流程概览​

画板

2.2
部署准备​

2.2.1
环境准备​

1.
网络环境、硬件资源均满足各系统部署要求；K8S 集群可用，具备宿主机命令行操作权限。​

2.
宿主机已安装 mysql, pgsql, redis-cli, mongosh 等各系统部署依赖的中间件命令行客户端工具。（建议，非必须）​

2.2.2
部署资源获取​

1.
获取自动部署工具​

•
提前下载半自动部署或自动部署工具（选择其一即可），参考​部署工具第2.1章​

•
提前下载部署工具镜像并上传至本地镜像仓库，参考​部署工具第3.1章​

2.
获取部署交付物​

•

当前镜像类和其他类分目录存放，具体 OBS 存放地址联系高林岳获取。

◦
镜像类，下载后需要手动上传至本地 Harbor 。​

◦
其他类，均打包在一个压缩包中，解压后的目录示例如下：​

交付物目录示例

3.4.x/                                      ​
├── k8s-resources/                                 # k8s资源类​
│   ├── video-base-vms-adm-deployment.yaml​
│   ├── video-base-vms-adm-service.yaml       ​
│   ├── video-algorithm-task-event-deployment.yaml  ​
│   ├── video-algorithm-task-event-service.yaml     ​
│   ├── video-nginx-configmap.yaml              ​
│   └── ...                                                                              ​
├── scripts/                                       # 脚本类​
│   ├── mysql/                                 ​
│   │   ├── video_base-ddl.sql                 ​
│   │   ├── video_base-dml.sql              ​
│   │   └── ... ​
│   ├── nacos/                        ​
│   │   ├── application.properties               ​
│   │   ├── video_application.yaml​
│   │   └── ...  ​
│   ├── rdb/                                 ​
│   │   ├── update-user.redis                  ​
│   │   ├── init-role.redis                ​
│   │   └── ... ​
│   ├── update_mysql.sh                   ​
│   ├── update_nacos.sh​
│   └── update_redis.sh ​
├── controls/                                      # 中控类​
│   ├── k8s-execution-plan.csv       ​
│   ├── global-vars.csv                                                           ​
│   └── script-execution-plan.csv            ​
└── XXX部署手册.docx                                # 文档类​

部署说明（新版交付物）​

部署说明（新版交付物）