2024-01-02

阿里云 MSE + Zadig，面向开发者的全链路灰度发布解决方案

Zadig 借助阿里云 MSE 微服务引擎，推出 MSE 全链路灰度发布方案，助力企业高效、安全、平稳的发布。

发布策略对于企业软件的开发和交付至关重要，它有助于平衡创新与风险，满足业务需求，从而提升软件发布的效率和质量。在云原生转型的背景下，企业在制定和执行发布策略时常常遭遇挑战：

云原生技能缺口：企业从传统部署模式转向云原生时，缺乏具备相关技能的人才，使得发布策略难以有效实施。
自动化支持不足：即便确定了合适的发布策略，缺少自动化平台的支持往往导致依赖手动操作，这可能引起操作遗漏或错误，增加生产事故的风险。
发布过程缓慢：仅实现服务级别的灰度发布能力，逐个服务的发布耗时较长，导致整体发布效率低下，验证效果不尽人意。

为了克服这些难题，Zadig 结合阿里云 MSE 微服务引擎，推出了全链路灰度发布解决方案，旨在帮助企业实现高效、安全、稳定的软件发布。

本文将深入探讨 Zadig 利用阿里云 MSE 实现全链路灰度发布的具体方案，涵盖方案原理、管理员配置指南以及工程师日常操作的实践细节。

# 工作原理介绍

# 工作原理图示：

# 工作流程描述：

MSE 灰度发布任务

复制一份基准环境中服务的 YAML
自动为 YAML 中的资源名称 metadata.name 添加后缀 -mse-<grayTag>
自动为 YAML 中的资源添加 MSE 全链路灰度发布所需的相关 label
用户可以设置灰度镜像、副本数，此外可以直接在渲染后的 YAML 中修改其他需要改动的字段（不可删除灰度过程中使用的 label）
根据最终的 YAML 生成灰度版本资源

下线 MSE 灰度服务

删除所有带灰度标的 Kubernetes 资源

# 前置操作

MSE 全链路灰度能力可以支持任意 K8S 集群，全链路灰度场景需基于网关能力建设，下面以 MSE 自带的云原生网关为例介绍场景，用户可以根据自身情况选择合适的网关。

# 安装 MSE 组件

在阿里云 ACK 集群中安装 MSE 组件，安装方式参考文档：安装 ack-onepilot 组件 (opens new window)。

# 安装 MSE Ingress 云原生网关

安装方式参考文档

下面以spring-a、spring-b、spring-c、nacos 这几个服务为例，结合 MSE 云原生网关演示项目初始化和 MSE 灰度发布过程。

# 管理员做项目初始化

运维或者 DevOps 工程师在 Zadig 上进行项目的初始化，包括新建项目、新建服务、新建环境并启用 MSE、新建灰度发布工作流等步骤。以下操作是一次性操作，后续只需按需配置执行工作流即可。

# 步骤一：新建项目

在 Zadig 上新建项目，输入项目名称，项目类型选择「K8s YAML」项目。

# 步骤二：新建服务

在 Zadig 服务-生产服务模块新建 nacos、spring-a、spring-b、spring-c 服务并配置对应的 YAML。具体配置参考示例项目 YAML 配置 (opens new window) 。

注意：在服务 deployment 中需添加以下 selector 和 template.metadata.labels：

zadigx-release-version: original

# 步骤三：新建环境并启用 MSE

在 Zadig 上新建生产环境

执行以下命令启用 MSE，对灰度过程涉及到的命名空间（上图中为：mse-prod）打上 mse-enable 标签。

kubectl label namespace <NAMESPACE> mse-enable=enabled

在生产环境中添加服务spring-a、spring-b、spring-c、nacos。
检查服务是否成功接入 MSE。在 Zadig 环境中选择服务，比如spring-a，检查 Pod YAML 中是否成功注入one-pilot-initcontainer，如下图所示。

# 步骤四：配置 MSE 灰度发布工作流

新建发布工作流 mse-gray-workflow，添加任务，配置如下。
1. MSE 灰度发布：用于部署灰度服务
2. [可选]通用任务 ：用于验证灰度后的新版本
3. 下线 MSE 灰度：用于下线灰度服务

新建发布工作流 prod-workflow ，添加部署任务，用于执行生产发布，配置如下图所示。

# 工程师执行 MSE 灰度发布

# 多个灰度服务部署

执行 mse-gray-workflow，选择服务组件 spring-cloud-a和spring-cloud-c ，设置灰度标，选择对应的灰度镜像、副本数量、修改灰度服务 YAML 配置，点击执行即可完成灰度服务部署。

此处 spring-cloud-a 为流量入口，因此需要在灰度服务 YAML 中手动添加/修改 Service 和 MSE Ingress 资源的一些相关字段：

通过 MSE Ingress 的 annotations 设置灰度流量规则，并为灰度流量带上灰度标 Header。
1. MSE Ingress 云原生网关支持按请求头、Cookie、权重三个维度进行配置，三者可以只配置一种，若同时配置生效规则按请求头、Cookie、权重顺序匹配
2. 按请求头：基于Request Header 的流量切分，添加注解nginx.ingress.kubernetes.io/canary-by-header、nginx.ingress.kubernetes.io/canary-by-header-value或nginx.ingress.kubernetes.io/canary-by-header-pattern。
3. 按 Cookie：基于 Cookie 的流量切分，添加注解nginx.ingress.kubernetes.io/canary-by-cookie。
4. 按权重：设置请求到指定服务的百分比（值为0~100的整数），添加注解nginx.ingress.kubernetes.io/canary-weight。
设置灰度路由规则的 backend.service.name 为其下的灰度 Service 名称。

具体改动内容如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    mse.ingress.kubernetes.io/request-header-control-update: x-mse-tag gray
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: x-user-id
    nginx.ingress.kubernetes.io/canary-by-header-value: "100"
    nginx.ingress.kubernetes.io/canary-weight: "0"
  creationTimestamp: null
  labels:
    zadigx-release-service-name: spring-a
    zadigx-release-type: mse-gray
    zadigx-release-version: gray
  name: spring-cloud-a-mse-gray
spec:
  ingressClassName: mse
  rules:
  - host: example.com
    http:
      paths:
      - backend:
          service:
            name: spring-cloud-a-mse-gray
            port:
              number: 20001
        path: /
        pathType: Prefix
status:
  loadBalancer: {}
---
apiVersion: v1
kind: Service
metadata:
  creationTimestamp: null
  labels:
    zadigx-release-service-name: spring-a
    zadigx-release-type: mse-gray
    zadigx-release-version: gray
  name: spring-cloud-a-mse-gray
spec:
  ports:
  - name: http
    port: 20001
    protocol: TCP
    targetPort: 20001
  selector:
    app: spring-cloud-a
    zadigx-release-service-name: spring-a
    zadigx-release-type: mse-gray
    zadigx-release-version: gray
status:
  loadBalancer: {}

部署完成后，可在生产环境中查看灰度服务的运行状态和基本信息。