Version: v1.8

Timeout of Step

Timeout of Step - 图1note

You need to upgrade to version 1.5+ to use the timeout feature.

This section introduces how to add timeout to workflow steps in KubeVela.

In KubeVela workflow, each step can specify a timeout, you can use timeout to specify the timeout time for the step.

timeout follows the duration format, e.g. 30s, 1m, etc. You can refer to Golang’s parseDuration.

If a step is not completed within the specified time, KubeVela will set the status of the step to failed and the Reason of the step will be set to Timeout.

Apply the following example:

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. metadata:
  4.   name: timeout-example
  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: apply-comp1
  21.       type: apply-component
  22.       properties:
  23.         component: comp1
  24.     - name: suspend
  25.       type: suspend
  26.       timeout: 5s
  27.     - name: apply-comp2
  28.       type: apply-component
  29.       properties:
  30.         component: comp2

Use vela status to check the status of the Application:

  1. $ vela status timeout-example
  2. About:
  4.   Name:         timeout-example
  5.   Namespace:    default
  6.   Created at:   2022-06-25 00:51:43 +0800 CST
  7.   Status:       workflowTerminated
  9. Workflow:
  11.   mode: StepByStep
  12.   finished: true
  13.   Suspend: false
  14.   Terminated: true
  15.   Steps
  16.   - id:1f58n13qdp
  17.     name:apply-comp1
  18.     type:apply-component
  19.     phase:succeeded
  20.     message:
  21.   - id:1pfije4ugt
  22.     name:suspend
  23.     type:suspend
  24.     phase:failed
  25.     message:
  26.   - id:lqxyenjxj4
  27.     name:apply-comp2
  28.     type:apply-component
  29.     phase:skipped
  30.     message:
  32. Services:
  34.   - Name: comp1
  35.     Cluster: local  Namespace: default
  36.     Type: webservice
  37.     Healthy Ready:1/1
  38.     No trait applied

As you can see, when the first component is successfully deployed, the workflow is suspended on the second suspend step. The suspend step is set with a timeout of five seconds. If the workflow is not resumed within five seconds, the step will fail because of timeout. The third step is skipped because the previous suspend step failed.

Last updated on May 6, 2023 by Tianxin Dong