变更管理
所有文档

          云原生微服务应用平台 CNAP

          变更管理

          变更管理支持同时变更应用下多个部署组,并记录每次变更的详情,方便追踪部署组变化历史。

          变更管理支持您根据实际变更结果进行暂停、继续、挂起、执行、终止等操作。

          变更管理支持您查看应用下的变更记录列表,并进行条件筛选。

          变更管理支持您将部署组回滚到指定版本。

          温馨提醒: 如果您想使用变更管理来追踪部署组变化历史,请您保证镜像版本和配置版本的唯一性。

          生成变更记录

          生成运维变更记录

          有三种场景将自动生成一条运维变更类型的变更记录,您可以去变更管理页面查看生成的变更记录。这三种场景分别为:

          • 新建应用(空应用除外)
          • 新建部署组(空部署除外)
          • 更新部署组部署配置、运维配置、节点选择标签

          生成上线单记录

          1、登陆CNAP控制台。
          2、在左侧功能菜单栏,点击【应用托管】下【应用】,进入应用列表页,点击目标应用名称,进入应用详情页。
          3、在左侧功能菜单栏,点击【变更管理】。
          4、点击【发起上线】。

          image.png

          5、页面中已经列出应用下部署组引用的所有镜像与配置,选择需要更新的镜像/配置版本。
          6、填写变更记录描述,必填,用于描述本次上线的目的,长度必须小于140个字符。
          7、在阶段配置处增加阶段,阶段详情处会同步显示已选择阶段的详细信息。

          温馨提醒:

          • 如果您需要更新配置,请确保所选配置版本环境包含全局或部署组所属的环境。
          • 阶段可以删除,可以拖动调整顺序。

          8、选择阶段右侧的执行策略。目前,阶段执行策略有:

          • 完成后挂起:本阶段变更完成后不继续变更下一阶段,需要点击【执行】,下一阶段才会开始变更。
          • 完成后继续:本阶段变更完成后继续变更下一阶段,为默认策略。

          image.png

          9、 点击【发起上线】。您可以在变更管理列表页查看生成的变更记录。

          image.png

          生成回滚单记录

          1、登陆CNAP控制台。
          2、在左侧功能菜单栏,点击【应用托管】下【应用】,进入应用列表页,点击目标应用名称,进入应用详情页。
          3、在左侧功能菜单栏,点击【变更管理】。
          4、点击目标变更单右侧的【回滚至该版本】。

          image.png

          5、点击【查看更新内容】,确定更新内容。

          温馨提醒:

          • 当部署组不存在,或者部署组目标部署配置所引用的资源不存在时,部署组无法回滚
          • 回滚时的阶段顺序根据对应变更记录阶段配置逆序排列

          6、选择阶段执行策略。
          7、填写回滚单描述,必填,用于描述本次回滚的原因,长度必须小于140个字符。
          8、点击【确定】。您可以在变更管理列表页查看生成的变更记录。

          image.png

          查看变更记录

          查看变更记录列表

          1、登陆CNAP控制台。
          2、在左侧功能菜单栏,点击【应用托管】下【应用】,进入应用列表页,点击目标应用名称,进入应用详情页。
          3、在左侧功能菜单栏,点击【变更管理】。

          image.png

          4、点击右上角【自定义列】,勾选/去除勾选列名,变更记录列表会增加/减少对应列。例如,勾选部署组,变更记录列表会增加部署组列,展示如下。

          image.png

          5、点击变更类型右侧的筛选图标,选择其中的任意一个类型,可以筛选出该类型的变更记录。同样,您可以根据状态、时间范围、发起者筛选变更记录,也可以根据开始时间/结束时间对变更记录进行排序。如果,您点击【仅看进行中】,则只会筛选出状态为执行中、暂停、挂起的变更记录。例如,选择回滚变更筛选条件,变更记录列表只展示回滚变更类型的变更记录,展示如下。

          image.png

          查看变更记录详情

          1、在变更记录列表页,点击目标变更记录右侧的【查看详情】。

          image.png

          image.png

          基本信息:

          • 变更记录ID:变更记录的唯一标识。
          • 状态:变更记录的状态。
          • 变更类型:变更记录的类型。目前有上线单、回滚单、运维变更三种类型。
          • 发起者:发起当前变更的账号名称。
          • 变更记录描述:描述当前变更的目的。
          • 开始时间:当前变更开始执行的时间。
          • 结束时间:当前变更结束的时间。
          • 操作日志:点击【查看详情】,可以跳转至变更记录的操作日志详情页,方便查看当前变更的所有事件。

          执行状态:

          • 变更记录执行进度:当前变更执行的进度,例如,本次变更四个阶段,当前已完成2个,则变更记录执行进度为50%。
          • 当前执行阶段:展示当前正在进行变更的阶段。如果当前没有正在变更的阶段,则没有该信息。您可以点击【查看当前阶段实例】,可跳转至部署组实例列表,方便您查看当前变更部署组的实例变化进度以及错误原因。
          • 滚动更新详情:展示当前变更阶段的进度。如果当前没有正在变更的阶段,则没有该信息。
          • 发布顺序:如果你使用的是分批发布策略,还会展示所有批次的发布状态,具体请参考分批发布

          image.png

          上线内容:

          展示当前变更更新的镜像地址、配置名称及版本信息。

          阶段配置:

          • 上线顺序:展示本次变更包含的阶段和阶段的变更顺序。
          • 阶段详情:展示本次变更所有阶段的变更详情,包括:

            • 部署组:当前阶段变更的部署组的名称。您可以点击阶段中的部署组名称,跳转至部署组实例列表,查看更新进度和错误原因。
            • 当前上线顺序:当前阶段的变更顺序。
            • 执行详情:展示当前变更阶段的变更详情,包括:

              • 执行时间:表示当前阶段的变更耗时。
              • 执行状态:表示当前阶段变更的状态。
              • 执行策略:当前阶段变更完成后的操作。
              • 开始时间:当前阶段开始变更的时间。
              • 结束时间:当前阶段完成变更的时间。
            • 操作:

              • 跳过:如果当前变更记录处于执行中状态,且当前阶段处于执行中或者失败状态,则可以点击【跳过】,不需要等待该阶段变更完成,直接进行下一步操作。如果当前部署组采用了分批发布策略,则可跳过本阶段剩余批次更新,已经发布批次的实例更新为新版本,未开始批次实例保持旧版本。
              • 快速回滚:对本阶段部署组变更进行快速回滚。
              • 重试:如果当前变更记录处于执行中状态,当前阶段处于失败状态,且为更新部署组操作,则可以点击【重试】,重新开始本阶段变更。
              • 查看更新内容:展示当前阶段变更前后的内容,展示如下。

                image.png

          操作变更记录

          暂停变更

          暂停变更可以暂停变更当前阶段,直至您点击【继续】,才能继续变更当前阶段。 如果您想暂停变更,可以在变更记录列表页,目标变更记录右侧,点击【更多操作】->【暂停】。

          image.png

          也可以点击变更详情页右上侧和左下侧的【暂停】

          image.png

          image.png

          温馨提醒:

          • 只有状态为执行中的变更记录,且当前阶段为执行中状态,才可以进行暂停操作。
          • 暂停状态下,阶段操作无法进行快速回滚。

          继续变更

          继续变更可以继续变更当前阶段。
          如果您想继续变更,可以在变更记录列表页,目标变更记录右侧,点击【更多操作】->【继续】。

          image.png

          也可以点击变更详情页右上侧和左下侧的【继续】

          image.png

          image.png

          挂起变更

          挂起变更可以在当前阶段变更完成后,不执行下一步操作,直至您点击【执行】,才能继续变更下一个阶段。
          如果您想挂起变更,可以在变更记录列表页,目标变更记录右侧,点击【更多操作】->【挂起】。

          image.png

          也可以点击变更详情页右上侧和左下侧的【挂起】

          image.png

          image.png

          执行变更

          执行变更可以继续变更下一个阶段。
          如果您想执行变更,可以在变更记录列表页,目标变更记录右侧,点击【更多操作】->【执行】。

          image.png

          也可以点击变更详情页右上侧和左下侧的【执行】

          image.png

          image.png

          终止变更

          终止变更可以结束当前变更记录,当前正在进行的阶段会继续变更,未执行的阶段不会再进行变更。
          如果您想终止变更,可以在变更记录列表页,目标变更记录右侧,点击【更多操作】->【终止】。

          image.png

          也可以点击变更详情页右上侧和左下侧的【终止】

          image.png

          image.png

          回滚到该版本

          回滚到此版本可以将目标变更记录包含的阶段从当前线上的部署配置回滚至目标变更版本对应的部署配置。

          如果您想终止变更,可以在变更记录列表页,目标变更记录右侧,点击【回滚至该版本】。 具体操作步骤见<生成回滚单记录>。

          温馨提醒: 只有已完成状态的变更记录可以点击【回滚至该版本】。

          附录

          变更记录状态说明

          状态 说明 备注
          RUNNING 执行中 变更正在执行中
          PAUSED 暂停 变更被暂停,需要点击【继续】才能继续变更
          PENDING 挂起 变更被挂起,需要点击【执行】才能继续变更
          TERMINATED 已终止 变更被终止
          SUCCESS 已完成 变更成功

          阶段状态说明

          状态 说明 备注
          READY 未执行 当前阶段还未开始变更
          RUNNING 执行中 当前阶段正在变更
          SKIPPED 已跳过 当前阶段被跳过,但不需要等待该阶段变更完成,直接进行下一步操作
          ROLLBACKING 快速回滚中 当前阶段正在快速回滚中
          ROLLBACK 已回滚 当前阶段已经完成快速回滚
          TERMINATED 已终止 当前阶段正在变更,但不需要等待该阶段变更完成
          CANCELLED 取消 当前阶段还未开始变更,且取消了对该阶段的变更操作
          PAUSED 暂停 当前阶段变更被暂停,如果当前解读版存在实例没有开始变更,这些实例不会开始变更;如果不存在实例未开始变更,阶段将继续变更直至完成
          SUCCESS 已完成 当前阶段已完成变更
          FAILED 失败 当前阶段变更失败

          操作及其条件说明

          操作 变更记录状态要求 阶段状态要求 结果说明 备注
          暂停 执行中 执行中 变更记录状态变为暂停,当前阶段状态变为暂停(如果存在实例没有开始变更,这些实例不会开始变更)/成功(如果不存在实例未开始变更,阶段将继续变更直至完成) -
          继续 暂停 - 暂停的阶段继续变更,如果没有暂停的阶段,则下一阶段开始变更;如果不存在下一阶段,则变更完成 -
          挂起 执行中 - 变更记录挂起,当前阶段变更完成后,下一阶段不继续变更 -
          执行 挂起 - 如果存在执行中的阶段,则继续执行该阶段;如果存在失败状态的阶段,则不做任何操作;如果既不存在执行中的阶段,也不存在失败的阶段,但存在就绪的阶段,则开始变更就绪的阶段;否则,所有阶段完成变更,本次变更成功 -
          终止 执行中/挂起 - 如果存在执行中的阶段,该阶段将继续变更,但状态会被更新为终止,标识终止操作;如果存在就绪状态的阶段,该阶段不会再进行变更,其状态会被更新为取消 -
          跳过 执行中 执行中/失败 当前阶段继续变更,如果存在下一个阶段,将变更下一个阶段;否则,本次变更完成 -
          快速回滚 执行中 执行中 当前阶段将被快速回滚 -
          重试 执行中 失败,且该阶段是更新部署组操作 当前阶段将重新执行 -
          查看更新内容 - - - 只要生成变更记录,就可以查看阶段的更新内容
          回滚至该版本 已完成 - 如果当前阶段所引用的资源仍然存在,则该阶段将回滚至目标变更记录变更完成后的状态;如果当前阶段所引用的资源不存在,则该阶段无法回滚 回滚时的阶段顺序根据对应上线单阶段配置逆序排列,不包括无法回滚的阶段;如果当前所有阶段均无法回滚,则无法回滚至该版本

          Q&A

          1. Q: 修改部署组副本数/更新部署配置/删除部署组时提示"部署组: *** 被锁, 请在变更管理解锁后再次操作, 变更记录ID: 00b757d0-fb38-4677-8e23-1117685f4d7a。

            A:这种情况是因为某个进行中的上线单包含了该部署组,您可以点击错误信息中的链接,跳转至变更记录详情页,继续等待变更完成,或者点击【终止】结束变更记录。只有变更记录的状态为已终止、已完成时,才可以修改部署组副本数/更新部署配置/删除部署组。

          2. Q: 发起上线时提示:"配置 *** 的版本 *** 环境不包含全局或部署组 *** 的环境,请选择其他版本。如果您想变更配置版本,请确保所选配置版本环境包含全局或部署组所属的环境"。

            A:这种情况是因为阶段配置中某个阶段的配置版本环境不包含全局和部署组的环境。此时,根据错误信息中的部署组名称找到对应的阶段,将该阶段删除即可。

          上一篇
          存储卷管理
          下一篇
          分批发布