如何使用 Gitee + Zadig 实现微服务架构持续交付

Gitee & Zadig:微服务架构的高效 DevOps 交付方案!

cover.png

# 概述

Gitee.com (opens new window)(码云) 是开源中国推出的代码托管平台,支持 Git 和 SVN,目前已有超过 800 万的开发者选择 Gitee,本文将介绍通过 Gitee 仓库管理的项目如何在 Zadig 上进行持续集成与部署,结合 Zadig 强大的环境管理能以及 Git Webhook 能力,可以帮助更多工程师高效、愉悦的 DevOps 交付。

下面以 microservice-demo 项目为例,该项目包含 Vue.js 前端服务和 Golang 后端服务,包含从 Code 到 Ship 的整个过程的演示。

01.png

# 准备工作

# 案例源码准备

本案例所用代码及配置 fork 自项目案例源码 (opens new window),主要包含:

# 代码源集成

# 项目配置

进入 Zadig 系统,点击新建项目 -> 填写项目名称 microservice-demo -> 选择 K8s YAML 项目 -> 点击立即创建 -> 点击下一步

02.png

03.png

04.png

# 新建服务并配置构建

# 新建服务

服务配置指的是 YAML 对这个服务的定义,Kubernetes 可以根据这个定义产生出服务实例。可以理解为 Service as Code。

Zadig 提供四种方式管理服务配置:

  • 手工输入:在创建服务时手动输入服务的 K8s YAML 配置文件,内容存储在 Zadig 系统中。
  • 从代码库同步:服务的 K8s YAML 配置文件在代码库中,从代码库中同步服务配置。之后提交到该代码库的 YAML 变更会被自动同步到 Zadig 系统上。
  • 使用模板新建:在 Zadig 平台中创建服务 K8s YAML 模板,创建服务时,在模板的基础上对服务进行重新定义。
  • 从 Kubernetes 导入:从集群中导入服务的配置到 Zadig 平台

这里,我们使用从代码库同步的方式:点击从代码库同步按钮 -> 选择集成的 Gitee代码源 -> 选择对应目录下的服务配置 -> 点击同步按钮即可。

05.png

06.png

07.png

08.png

09.png

# 配置构建

配置后端服务构建:选择 backend 服务 -> 点击添加构建 -> 填写构建配置和构建脚本后保存。

10.png

构建配置说明:

  1. 应用列表:选择 go 1.13
  2. 代码信息:准备工作中 fork 的代码仓库
  3. 构建脚本如下:
cd zadig/examples/microservice-demo/backend
make build-backend
docker build -t $IMAGE -f Dockerfile .
docker push $IMAGE

11.png

同样的步骤为 frontend 服务配置构建并保存。

构建配置说明:

  1. 代码信息:准备工作中 fork 的代码仓库
  2. 构建脚本如下:
cd zadig/examples/microservice-demo/frontend
docker build -t $IMAGE -f Dockerfile .
docker push $IMAGE

12.png

# 环境

  • 点击向导的下一步,进入环境配置页面,该页面支持对环境进行自定义,也可以保持默认配置,点击创建环境

13.png

这时,Zadig 会根据你的配置,创建两套包括上述 2 个服务的环境以及相关工作流,继续点击下一步完成向导流程。

14.png

  • 点击完成向导,一个有 2 个微服务的项目、2 套环境、3 条工作流已经产生,项目概览如下。

15.png

# 工作流交付

使用工作流对环境中的服务进行部署更新,以 dev 环境为例操作步骤如下。

  • 点击 microservice-demo-workflow-dev 工作流 -> 选择服务,点击「启动任务」运行工作流。

16.png

  • 触发工作流后,可查看工作流运行状况,点击相应的任务可查看服务构建的实时日志。

17.png

  • 待工作流运行完毕,进入 dev 环境,可看到 backend 服务和 frontend 服务被部署更新成功,镜像信息均被更新。

18.png

# 配置自动触发工作流

添加触发器,使得代码 Push commit、Pull Request、Push tag 都能自动触发服务的重新构建和部署。

  • 配置工作流

19.png

  • 添加触发器 -> 选择 Git 触发器 -> 填写 Git 触发器配置

20.png

21.png

22.png

配置触发执行的工作流

23.png

点击确定后可见 Git 触发器被成功保存

24.png

# 改动代码,触发工作流

  • 以 Pull Request 事件为例说明,提交 Gitee PR 修改源代码

25.png

  • 在 Gitee 的 PR 页面中,会有触发工作流的信息。可点击工作流链接快速跳转到 Zadig 中。

26.png

27.png

  • 待工作流执行完毕,进入 项目->microservice-demo->环境,可看到服务的镜像已被自动触发的工作流更新。

28.png

29.png

# 配置 IM 通知

  • 点击工作流配置选择通知

30.png

31.png

这里以飞书为例,其它 IM 请参考官方文档 (opens new window)进行配置

32.png

  • 工作流执行后,会自动将运行结果和环境、服务等信息推送到 IM 系统中,方便及时跟进

33.png

Background Image

作为一名软件工程师,我们一直给各行各业写软件提升效率,但是软件工程本身却是非常低效,为什么市面上没有一个工具可以让研发团队不这么累,还能更好、更快地满足大客户的交付需求?我们是否能够打造一个面向开发者的交付平台呢?我们开源打造 Zadig 正是去满足这个愿望。

—— Zadig 创始人 Landy