项目实施手册

概述

在 ZadigX 中,项目是核心的业务管理单元,通常用于独立可自治的团队或产品线。每个项目包括工作流、环境、服务、构建、测试、代码扫描和版本等资源。本手册涵盖了 ZadigX 项目中的主要运维操作,包括项目接入,标准模板管理,服务与环境配置,工作流配置,权限和协作管理等。通过本手册,您将能够快速了解和使用 ZadigX,提高配置和管理效率,快速支持研发流程。

项目接入方式

ZadigX 支持三种项目接入方式:现有项目托管、现有项目导入和新项目接入。

  • 现有项目托管:适用于已有服务配置未经 ZadigX 管理的项目
  • 现有项目导入:适用于已有服务配置通过 Git 仓库或其他存储介质管理的项目
  • 新项目接入:适用于需要搭建工程体系的新项目

现有项目托管

  1. 新建项目 -> 选择托管项目。 现有项目托管

  2. 配置托管环境,从指定集群、指定命名空间中选择服务导入。 现有项目托管

  3. 配置服务构建,参考文档:构建现有项目托管

  4. 执行工作流,部署更新指定环境中的服务。 现有项目托管

提示

若后续需要在 ZadigX 上管理服务配置,可以通过切换项目类型来实现,参考文档:切换项目类型

现有项目导入

就配置文件的两种形式(YAML / Helm Chart)分别介绍接入步骤。

YAML 形式

  1. 新建项目,选择 K8s YAML 项目。 现有项目导入 现有项目导入

  2. 新建服务:从代码库中同步服务配置,参考文档:新建服务现有项目导入

  3. 新建环境:选择已有命名空间新建环境(比如:dev/sit/uat/prod 环境),参考文档:新建环境现有项目导入

  4. 配置构建:进入项目 -> 构建,配置服务构建脚本,参考文档:构建现有项目导入

  5. 执行工作流:进入项目 -> 工作流,运行工作流更新指定环境的服务。 现有项目导入

Helm Chart 形式

  1. 新建项目,选择 K8s Helm Chart 项目。 现有项目导入 现有项目导入

  2. 新建服务:从代码库中同步服务配置,参考文档:新建服务现有项目导入

  3. 新建环境:选择已有命名空间新建环境(比如:dev/sit/uat/prod 环境),参考文档:新建环境现有项目导入

  4. 配置构建:进入项目 -> 构建,配置服务构建脚本,参考文档:构建现有项目导入

  5. 执行工作流:进入项目 -> 工作流,执行工作流更新指定环境的服务。工作流的更多功能可参考文档:工作流现有项目导入

新项目接入

就配置文件的两种形式(YAML / Helm Chart)分别介绍接入步骤。

YAML 形式

  1. 新建项目:选择 K8s YAML 项目。 新项目接入 新项目接入

  2. 新建服务:使用模板新建服务,参考文档:新建服务新项目接入 新项目接入

  3. 新建环境:选择服务新建 dev/sit/uat/prod 环境。 新项目接入

  4. 配置构建:使用构建模板配置构建脚本,参考文档:构建新项目接入 新项目接入

  5. 配置工作流:配置测试和生产环境对应工作流,参考文档:工作流新项目接入

Helm Chart 形式

  1. 新建项目:选择 K8s Helm Chart 类型项目。 新项目接入 新项目接入

  2. 新建服务:使用模板新建服务,参考文档:新建服务新项目接入

  3. 新建环境:选择服务新建 dev/sit/uat/prod 环境。 新项目接入

  4. 配置构建:使用构建模板配置构建脚本,参考文档:构建新项目接入 新项目接入

  5. 配置工作流:配置测试环境和生产环境对应工作流,参考文档:工作流新项目接入

标准模板管理

通过 ZadigX 模板库,运维团队可以实现统一的应用交付标准,规范化发布流程,并沉淀符合企业自身特色的标准化模板。这为研发和运维部门提供高效的工程化协作基础,快速应对业务迭代的需求,确保系统的稳定性和可扩展性。模板库提供了多种类型的模板,包括服务模板、构建模板、Dockerfile 模板和工作流模板等。

服务模板

适用场景

多个服务的配置文件内容结构同构,只是具体配置不同。比如:不同服务的端口号/副本数/数据库连接地址等不同。将服务的配置抽象成通用的 K8s YAML/Helm Chart 模板,支持用户在通用模板上创建多个服务。

就服务配置的不同组织形式(K8s YAML/Helm Chart)分别介绍。

K8s YAML 模板

准备工作:将多个服务的配置抽象成 K8s YAML 模板,以下为 multi-service-demo 项目的相关配置供参考。更多使用姿势可参考文档:K8s YAML 模板使用模板创建服务

  1. 新建模板:访问模板库 -> K8s YAML -> 创建模板,输入模板内容后保存。 标准模板管理 标准模板管理

  2. 配置自定义变量:自动解析变量,按需配置变量默认值。 标准模板管理

  3. 使用模板创建服务。 标准模板管理 标准模板管理 标准模板管理

  4. 模板内容变更同步更新服务配置:服务配置中开启自动同步,模板内容变更后,应用到服务 标准模板管理

标准模板管理

Helm Chart 模板

准备工作:将多个服务的 Helm Chart 配置抽象成 Helm Chart 模板,以下为 multi-service-demo 项目的相关配置供参考。更多使用姿势可参考文档:Helm Chart 模板使用模板创建服务

  1. 新建模板:访问模板库 -> K8s YAML -> 创建模板,输入模板内容后保存。 标准模板管理 标准模板管理

  2. 配置自定义变量:按需配置变量默认值后保存。 标准模板管理

  3. 使用模板创建服务:进入 K8s Helm Chart 项目 -> 服务 -> 使用模板新建,填写参数后导入即可。 标准模板管理 标准模板管理

  4. 模板内容变更同步更新服务配置:服务配置中开启自动同步,模板内容变更后,应用到服务。 标准模板管理 标准模板管理

Dockerfile 模板

准备工作:将多个服务的镜像构建配置抽象为 Dockerfile 模板,以下为 multi-service-demo 项目的相关配置供参考。更多使用姿势可参考文档:Dockerfile 模板构建配置

  1. 新建模板:访问模板库 -> Dockerfile 模板 -> 创建模板,输入模板内容后保存。 标准模板管理 标准模板管理

  2. 使用 Dockerfile 模板为服务配置构建。 标准模板管理

构建模板

适用场景

多个服务的构建配置同构(比如相同技术栈的多个服务代码分别在单独的代码库中维护,构建所依赖的软件包相同、构建脚本同构,只有代码信息有区别…)使用 ZadigX 构建模板来提升配置构建的效率,具体可参考文档:构建模板

  1. 新建构建模板:访问模板库 -> 构建 -> 创建模板,配置完毕后保存。 标准模板管理 标准模板管理

  2. 使用构建模板:使用模板配置构建,分别配置多个服务构建所需的代码信息。对于多个服务使用同一构建模板的情况,可使用批量录入快速配置,参考文档:批量录入标准模板管理

工作流模板

根据项目流程抽象工作流模板,基于模板快速创建工作流,具体参考文档:工作流模板标准模板管理

服务及环境配置

上线测试服务

第 1 步:配置测试服务

  1. 基于 K8s YAML 模板,新建业务服务,参考文档:服务业务运维操作

  2. 基于构建模板,为服务配置构建,参考文档:构建

优化建议:

建议项说明参考文档
构建过程提速1. 把常用构建的依赖工具打进去
2. 自定义缓存目录
1. 自定义构建镜像
2. 配置构建缓存
减少维护负担1. 多个服务构建相似,配置一份构建脚本,减少维护成本
2. 规范并统一服务构建物料的管理方式,减少维护和管理负担
1. 共享构建脚本
2. 使用构建模板

业务运维操作

第 2 步:添加到环境,参考文档:K8s YAML 环境业务运维操作

第 3 步:添加服务到对应工作流,在工作流中添加服务组件及其对应构建。 业务运维操作

下线测试服务

  1. 删除服务定义,参考文档:删除服务业务运维操作

  2. 从环境中删除服务,参考文档:K8s YAML 环境业务运维操作

新建测试环境

进入项目 -> 环境 -> 新建环境 -> 测试环境,填写参数后新建。

提供部分最佳实践供参考:

  1. 使用一套服务配置创建多套测试环境 ,参考文档:配置多套集成环境
  2. 不同环境使用不同结构的 deployment,可使用变量能力,参考文档:K8s YAML 服务
  3. 不同业务线可以使用不同的 K8s 集群资源,新增集群配置参考:集群管理
  4. 环境配置管理,参考文档:环境配置

上线生产服务

第 1 步:配置生产服务,参考文档:生产服务业务运维操作

第 2 步:配置生产环境,参考文档:K8s YAML 生产环境业务运维操作

第 3 步:配置工作流,添加部署任务,参考文档:工作流业务运维操作

下线生产服务

友好提醒

鉴于生产服务的严肃性,下线操作有一定的风险,请确保服务下线不会带来影响后再操作。

参考文档:下线服务

新建生产环境

参考文档:生产环境

工作流配置

根据实际场景选择合适的工作流,参考:

工作流类型特点适用场景参考文档
产品工作流流程固定
配置简单
适用于研发迭代流程相对固定,按照构建、部署、测试和分发的顺序依次执行的场景查看
自定义工作流
流程可编排
支持对接其他系统
支持发布策略
支持审批流
适用于流程相对复杂、需要将其他系统编排到流程中,或者用于生产发布,并需要实现灰度发布的场景查看

工作流通用功能配置参考:

功能描述配置方式
触发器代码变更/定时/JIRA 任务状态变更/飞书工作项变更等触发工作流执行查看
IM 通知工作流执行状态通知,支持通知到飞书/企业微信/钉钉查看
审批支持 ZadigX 系统内审批/飞书审批/钉钉审批查看

权限管理

ZadigX 用户权限由系统权限和项目权限组成,通过配置用户的系统角色、项目角色和项目内的协作模式来管理其权限。用户权限是所有赋予其权限项的并集。具体机制如下图所示:

权限管理机制

配置操作

首先了解一下配置用户项目权限的基本操作。

项目角色配置

访问项目配置 -> 权限,配置角色和项目成员即可,可参考文档:权限配置

业务运维操作 业务运维操作 业务运维操作

协作模式配置

访问权限管理 -> 协作模式,配置协作成员以及工作流、环境资源的权限即可,具体配置过程参考:协作模式

业务运维操作

配置示例

下面以不同的角色为例,具体说明如何配置对应角色的权限项。

项目管理员

权限描述:拥有项目中任何操作的权限

具体配置:授予项目角色 project-admin

权限配置

研发工程师

权限描述:

  • 构建、测试服务、代码扫描、版本管理模块所有操作权限
  • dev 工作流所有操作权限
  • dev、sit 环境所有操作权限

具体配置:

  • 创建并授予项目角色dev,配置权限项如下图:

项目实施手册 - 图82 项目实施手册 - 图83

  • 创建并加入协作模式dev,配置工作流和环境相关权限,具体如下图:

项目实施手册 - 图84 项目实施手册 - 图85

测试工程师

权限描述:

  • 测试模块所有操作权限
  • sit 工作流所有操作权限
  • sit 环境所有操作权限

具体配置:

  • 创建并授予项目角色qa,配置权限项如下图:

项目实施手册 - 图86 项目实施手册 - 图87

  • 创建并加入协作模式qa,配置工作流和环境相关权限,具体如下图:

项目实施手册 - 图88 项目实施手册 - 图89

发布工程师

权限描述:

  • 生产服务、生产环境、版本管理所有操作权限
  • prod、uat 工作流所有操作权限
  • uat 环境所有操作权限

具体配置:

  • 创建并授予项目角色sre,配置权限项如下图:

项目实施手册 - 图90 项目实施手册 - 图91

  • 创建并加入协作模式sre,配置工作流和环境相关权限,具体如下图:

项目实施手册 - 图92 项目实施手册 - 图93