# 创建金丝雀发布任务

应用工作台基于开源项目 [Argo Rollout](https://argoproj.github.io/argo-rollouts/) 提供强大的灰度发布能力。灰度发布可以在不影响老版本的前提下，发布新的应用版本。按照预先定义的规则，渐进式地将流量切换到新版本，当新版本运行无问题后，最终自动将全部流量从老版本迁移至新版本。

## 前提条件

- 创建一个[工作空间](../../../ghippo/user-guide/workspace/workspace.md)和一个[用户](../../../ghippo/user-guide/access-control/user.md)，该用户需加入该工作空间并具备 __Workspace Editor__ 角色。

- 创建一个应用并开启 __灰度发布__ ，可参考[基于 Git 仓构建微服务应用](../wizard/create-app-git.md)、[基于 Jar 包部署 Java 应用](../wizard/jar-java-app.md)。

- 发布对象所在的集群已经安装了 Istio 和 [Argo Rollout](../../pluggable-components.md#argo-rollouts) 两个组件。

## Istio 安装方式

您可以根据不同的业务场景需求，使用以下两种安装方案在集群中安装 Istio。

- [参考 Istio 官方安装指南](https://istio.io/latest/zh/docs/setup/install/)

- [通过平台的服务网格模块创建专有网格](https://docs.daocloud.io/mspider/user-guide/service-mesh/#_1)

## 操作步骤

1. 进入 __应用工作台__ 模块，在左侧导航栏点击 __灰度发布__ ，然后在页面右上角点击 __创建发布任务__ -> __金丝雀发布__ 。

    ![进入创建页面](../../images/canary01.png)

2. 参考下列要求填写基本信息，然后点击 __下一步__ 。

    - 名称：填写发布任务的名称。最长 63 个字符，只能包含小写字母、数字及分隔符("-")，且必须以小写字母或数字开头及结尾。
    - 集群：选择发布对象所在的集群。需要确保该集群已经部署了 Istio 和 Argo Rollout。
    - 命名空间：选择发布对象所在的命名空间，且该命名空间中已经部署了的工作负载并且开启了服务网格。
    - 无状态负载：选择具体的发布对象。

3. 参考下列说明配置发布规则。

    - 实例数量：进行灰度发布任务时应用的副本数量。
    - 流量管理类型： 支持副本数、Istio、Nginx、云原生网关。

    === "基于副本数"

        - 流量调度类型：仅支持基于权重的灰度发布。

        - 流量调度策略：

            - 当前阶段发布流量比例：每个流量周期内，为灰度版本增加的流量比例。
            - 到达流量比例后等待时间：为灰度版本增加流量周期，即等待多久后自动进入下一个灰度流量比例。

            > 如果设置为 0 或不填写，发布任务执行到此步骤时会永久暂停。

            ![副本数](../../images/canary11.png)

    === "基于 Istio"

        - 流量调度类型：基于 Istio 支持基于权重、基于请求特征的灰度发布，目前仅支持基于权重的灰度发布。
        - 流量调度策略：

            - 当前阶段发布流量比例：每个流量周期内，为灰度版本增加的流量比例。
            - 到达流量比例后等待时间：为灰度版本增加流量周期，即等待多久后自动进入下一个灰度流量比例。

            > 如果设置为 0 或不填写，发布任务执行到此步骤时会永久暂停。
        
        - 监控分析：开启后即可利用 Prometheus 的能力进行监控。根据预先定义的监控指标以及采集间隔，在整个发布过程中自动执行监控分析。
          如果不满足定义的规则，则自动回滚至旧版本，灰度发布失败。

        ![副本数](https://docs.daocloud.io/daocloud-docs-images/docs/zh/docs/amamba/images/canary12.png)

    === "基于 Nginx"

        - 流量调度类型：基于 Nginx 仅支持基于权重的灰度发布。
        - 服务：选择当前发布对象关联的 Service 对象
        - 路由：选择当前发布对象关联的 Ingress 对象，用于配置流量调度策略/
        - 流量调度策略：

            - 当前阶段发布流量比例：每个流量周期内，为灰度版本增加的流量比例。
            - 到达流量比例后等待时间：为灰度版本增加流量周期，即等待多久后自动进入下一个灰度流量比例。

            > 如果设置为 0 或不填写，发布任务执行到此步骤时会永久暂停。

            ![副本数](../../images/canary14.png)

    === "基于云原生网关"

        需要确保平台已经部署微服务引擎，并且已经安装了 contour 组件，参考文档[开启 contour](../../pluggable-components.md)

        - 流量调度类型：基于云原生网关仅支持基于权重的灰度发布。
        - 服务：选择当前发布对象关联的 Service 对象。
        - 网关实例：系统会检查当前命名空间是否已经被网关实例纳管，如果未被纳管，需要前往微服务引擎产品模块进行纳管。
        - 流量调度策略：

            - 当前阶段发布流量比例：每个流量周期内，为灰度版本增加的流量比例。
            - 到达流量比例后等待时间：为灰度版本增加流量周期，即等待多久后自动进入下一个灰度流量比例。

            > 如果设置为 0 或不填写，发布任务执行到此步骤时会永久暂停。

            ![contour](../../images/contour02.png)

4. 在页面底部点击 __创建并更新应用__ ，然后在弹框中设置灰度版本的镜像地址并点击 __确定__ 。

    此时原工作负载的副本数会被设置为 0。

    ![填写镜像地址](https://docs.daocloud.io/daocloud-docs-images/docs/zh/docs/amamba/images/canary15.png)

5. 系统自动跳转至灰度发布的任务列表页面，提示 __更新版本成功__ 。

    ![返回列表](https://docs.daocloud.io/daocloud-docs-images/docs/zh/docs/amamba/images/canary16.png)