暂停和继续

本节将介绍如何在 KubeVela 中暂停和继续工作流。

暂停工作流

在 KubeVela 中，你可以选择使用 vela 命令来手动暂停工作流的执行，也可以使用一个内置的特殊步骤类型 suspend 使工作流自动进入暂停状态。

手动暂停

如果你有一个正在运行工作流的应用，并且你希望暂停它的执行，你可以使用 vela workflow suspend 来暂停该工作流，在未来可以通过 vela workflow resume 继续工作流。

  • 暂停工作流
  1. vela workflow suspend my-app

暂停和继续 - 图1提示

如果工作流已经执行完毕，对应用使用 vela workflow suspend 命令不会产生任何效果。

使用暂停步骤

部署如下例子：

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. metadata:
  4.   name: suspend-demo
  5.   namespace: default
  6. spec:
  7.   components:
  8.   - name: comp1
  9.     type: webservice
  10.     properties:
  11.       image: crccheck/hello-world
  12.       port: 8000
  13.   - name: comp2
  14.     type: webservice
  15.     properties:
  16.       image: crccheck/hello-world
  17.       port: 8000
  18.   workflow:
  19.     steps:
  20.     - name: apply1
  21.       type: apply-component
  22.       properties:
  23.         component: comp1
  24.     - name: suspend
  25.       type: suspend
  26.     - name: apply2
  27.       type: apply-component
  28.       properties:
  29.         component: comp2

使用 vela status 命令查看应用状态：

  1. vela status suspend-demo

期望输出

  1. About:
  3.   Name:         suspend-demo
  4.   Namespace:    default
  5.   Created at:   2022-06-27 17:36:58 +0800 CST
  6.   Status:       workflowSuspending
  8. Workflow:
  10.   mode: StepByStep
  11.   finished: false
  12.   Suspend: true
  13.   Terminated: false
  14.   Steps
  15.   - id:yj9h29uv6v
  16.     name:apply1
  17.     type:apply-component
  18.     phase:succeeded
  19.   - id:xvmda4he5e
  20.     name:suspend
  21.     type:suspend
  22.     phase:running
  24. Services:
  26.   - Name: comp1
  27.     Cluster: local  Namespace: default
  28.     Type: webservice
  29.     Healthy Ready:1/1
  30.     No trait applied

可以看到，当第一个步骤执行完成之后，会开始执行 suspend 步骤。而这个步骤会让工作流进入暂停状态。

继续工作流

手动继续工作流

当工作流进入暂停状态后，你可以使用 vela workflow resume 命令来手动继续工作流。workflow resume 命令会把工作流从暂停状态恢复到执行状态。

以上面处于暂停状态的应用为例：

  1. vela workflow resume suspend-demo

成功继续工作流后，查看应用的状态：

  1. vela status suspend-demo

期望输出

  1. About:
  3.   Name:         suspend-demo
  4.   Namespace:    default
  5.   Created at:   2022-06-27 17:36:58 +0800 CST
  6.   Status:       running
  8. Workflow:
  10.   mode: StepByStep
  11.   finished: true
  12.   Suspend: false
  13.   Terminated: false
  14.   Steps
  15.   - id:yj9h29uv6v
  16.     name:apply1
  17.     type:apply-component
  18.     phase:succeeded
  19.     message:
  20.   - id:xvmda4he5e
  21.     name:suspend
  22.     type:suspend
  23.     phase:succeeded
  24.     message:
  25.   - id:66jonaxjef
  26.     name:apply2
  27.     type:apply-component
  28.     phase:succeeded
  29.     message:
  31. Services:
  33.   - Name: comp2
  34.     Cluster: local  Namespace: default
  35.     Type: webservice
  36.     Healthy Ready:1/1
  37.     No trait applied
  39.   - Name: comp1
  40.     Cluster: local  Namespace: default
  41.     Type: webservice
  42.     Healthy Ready:1/1
  43.     No trait applied

可以看到，工作流已经继续执行完毕。

手动终止工作流

当工作流处于暂停状态时，如果你想终止它，你可以使用 vela workflow terminate 命令来终止工作流。

  • 终止工作流
  1. vela workflow terminate my-app

暂停和继续 - 图2提示

区别于暂停，终止的工作流不能继续执行，只能重新运行工作流。重新运行意味着工作流会重新开始执行所有工作流步骤，而继续工作流则是从暂停的步骤后面继续执行。

  • 重新运行工作流
  1. vela workflow restart my-app

暂停和继续 - 图3警告

一旦应用被终止，KubeVela 控制器不会再对资源做状态维持，你可以对底层资源做手动修改但请注意防止配置漂移。

工作流执行完毕进入正常运行状态的应用无法被终止或重新运行。

自动继续工作流

如果你希望经过了一段时间后，工作流能够自动被继续。那么，你可以在 suspend 步骤中加上 duration 参数。当 duration 时间超过后，工作流将自动继续执行。

部署如下例子：

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. metadata:
  4.   name: auto-resume
  5.   namespace: default
  6. spec:
  7.   components:
  8.   - name: comp1
  9.     type: webservice
  10.     properties:
  11.       image: crccheck/hello-world
  12.       port: 8000
  13.   - name: comp2
  14.     type: webservice
  15.     properties:
  16.       image: crccheck/hello-world
  17.       port: 8000
  18.   workflow:
  19.     steps:
  20.     - name: apply1
  21.       type: apply-component
  22.       properties:
  23.         component: comp1
  24.     - name: suspend
  25.       type: suspend
  26.       properties:
  27.         duration: 5s
  28.     - name: apply2
  29.       type: apply-component
  30.       properties:
  31.         component: comp2

查看应用状态：

  1. vela status auto-resume

期望输出

  1. About:
  3.   Name:         auto-resume
  4.   Namespace:    default
  5.   Created at:   2022-06-27 17:57:35 +0800 CST
  6.   Status:       running
  8. Workflow:
  10.   mode: StepByStep
  11.   finished: true
  12.   Suspend: false
  13.   Terminated: false
  14.   Steps
  15.   - id:q5jhm6mgwv
  16.     name:apply1
  17.     type:apply-component
  18.     phase:succeeded
  19.     message:
  20.   - id:3xgfcp3cuj
  21.     name:suspend
  22.     type:suspend
  23.     phase:succeeded
  24.     message:
  25.   - id:zjux8ud876
  26.     name:apply2
  27.     type:apply-component
  28.     phase:succeeded
  29.     message:
  31. Services:
  33.   - Name: comp2
  34.     Cluster: local  Namespace: default
  35.     Type: webservice
  36.     Healthy Ready:1/1
  37.     No trait applied
  39.   - Name: comp1
  40.     Cluster: local  Namespace: default
  41.     Type: webservice
  42.     Healthy Ready:1/1
  43.     No trait applied

可以看到，suspend 步骤在五秒后自动执行成功，继续了工作流。