Skip to main content
版本:v1.5

内置工作流步骤列表

本文档将按字典序展示所有内置工作流步骤的参数列表。

本文档由脚本自动生成,请勿手动修改,上次更新于 2022-07-24T20:59:39+08:00。

Apply-Object

描述

在工作流中部署 Kubernetes 资源对象。

示例 (apply-object)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: server-with-pvc
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
volumes:
- name: "my-pvc"
type: "pvc"
mountPath: "/test"
claimName: "myclaim"

workflow:
steps:
- name: apply-pvc
type: apply-object
properties:
# Kubernetes native resources fields
value:
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: myclaim
namespace: default
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 8Gi
storageClassName: standard
# the cluster you want to apply the resource to, default is the current cluster
cluster: <your cluster name>
- name: apply-server
type: apply-component
properties:
component: express-serve

参数说明 (apply-object)

名称描述类型是否必须默认值
valueKubernetes 资源对象参数。map[string]:(null|bool|string|bytes|{...}|[...]|number)true
cluster需要部署的集群名称。如果不指定,则为当前集群。stringfalseempty

Depends-On-App

描述

等待指定的 Application 完成。

示例 (depends-on-app)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: express-server
type: depends-on-app
properties:
name: another-app
namespace: default

depends-on-app will check if the cluster has the application with name and namespace given in properties. If the application exists, it will hang the next step until the application is running. If the application does not exist, KubeVela will check the ConfigMap with the same name, and read the config of the Application and apply to cluster. The ConfigMap is like below: the name and namespace of the ConfigMap is the same in properties. In data, the key must be specified by application, and the value is the yaml of the deployed application yaml.

apiVersion: v1
kind: ConfigMap
metadata:
name: myapp
namespace: vela-system
data:
application:
<app yaml file>

参数说明 (depends-on-app)

名称描述类型是否必须默认值
name需要等待的 Application 名称。stringtrue
namespace需要等待的 Application 所在的命名空间。stringtrue

Deploy

描述

功能丰富且统一的用于多集群部署的步骤,可以指定多集群差异化配置策略。

示例 (deploy)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: deploy-workflowstep
namespace: examples
spec:
components:
- name: nginx-deploy-workflowstep
type: webservice
properties:
image: nginx
policies:
- name: topology-hangzhou-clusters
type: topology
properties:
clusterLabelSelector:
region: hangzhou
- name: topology-local
type: topology
properties:
clusters: ["local"]
namespace: examples-alternative
workflow:
steps:
- type: deploy
name: deploy-local
properties:
policies: ["topology-local"]
- type: deploy
name: deploy-hangzhou
properties:
# require manual approval before running this step
auto: false
policies: ["topology-hangzhou-clusters"]

参数说明 (deploy)

名称描述类型是否必须默认值
policies指定本次部署要使用的策略。如果不指定策略,将自动部署到管控集群。[]stringfalse
parallelism指定本次部署的并发度。intfalse5
ignoreTerraformComponent部署时忽略 Terraform 的组件,默认忽略,Terraform 仅需要在管控集群操作云资源,不需要管控信息下发到多集群。boolfalsetrue
auto默认为 true。如果为 false,工作流将在执行该步骤前自动暂停。。boolfalsetrue

Deploy-Cloud-Resource

描述

将云资源生成的秘钥部署到多集群。

参数说明 (deploy-cloud-resource)

名称描述类型是否必须默认值
env指定多集群策略中定义的环境名称。stringtrue
policyDeclare the name of the env-binding policy, if empty, the first env-binding policy will be used。stringfalseempty

Export2config

描述

在工作流中导出数据到 Kubernetes ConfigMap 对象。

示例 (export2config)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: export-config
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
workflow:
steps:
- name: apply-server
type: apply-component
outputs:
- name: status
valueFrom: output.status.conditions[0].message
properties:
component: express-server
- name: export-config
type: export-config
inputs:
- from: status
parameterKey: data.serverstatus
properties:
configName: my-configmap
data:
testkey: testvalue

参数说明 (export2config)

名称描述类型是否必须默认值
cluster要导出到的集群名称。stringfalseempty
namespaceConfigMap 的 namespace,默认为当前应用的 namespace。stringfalse
data需要导出到 ConfigMap 中的数据,是一个 key-value 的 map。{...}true
configNameConfigMap 的名称。stringtrue

Export2secret

描述

在工作流中导出数据到 Kubernetes Secret 对象。

示例 (export2secret)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: export-secret
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
workflow:
steps:
- name: apply-server
type: apply-component
outputs:
- name: status
valueFrom: output.status.conditions[0].message
properties:
component: express-server
- name: export-secret
type: export-secret
inputs:
- from: status
parameterKey: data.serverstatus
properties:
secretName: my-secret
data:
testkey: testvalue

参数说明 (export2secret)

名称描述类型是否必须默认值
cluster要导出到的集群名称。stringfalseempty
namespacesecret 的 namespace,默认为当前应用的 namespace。stringfalse
type指定导出的 secret 类型。stringfalse
secretNameSecret 的名称。stringtrue
data需要导出到 Secret 中的数据。{...}true

Generate-Jdbc-Connection

描述

Generate a JDBC connection based on Component of alibaba-rds。

参数说明 (generate-jdbc-connection)

名称描述类型是否必须默认值
nameSpecify the name of the secret generated by database component。stringtrue
namespaceSpecify the namespace of the secret generated by database component。stringfalse

Notification

描述

向指定的 Webhook 发送信息,支持邮件、钉钉、Slack 和飞书。

示例 (notification)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: dingtalk-message
type: notification
properties:
dingding:
# the DingTalk webhook address, please refer to: https://developers.dingtalk.com/document/robots/custom-robot-access
url:
value: <url>
message:
msgtype: text
text:
context: Workflow starting...
- name: application
type: apply-application
- name: slack-message
type: notification
properties:
slack:
# the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
url:
secretRef:
name: <secret-key>
key: <secret-value>
message:
text: Workflow ended.
lark:
url:
value: <lark-url>
message:
msg_type: "text"
content: "{\"text\":\" Hello KubeVela\"}"
email:
from:
address: <sender-email-address>
alias: <sender-alias>
password:
# secretRef:
# name: <secret-name>
# key: <secret-key>
value: <sender-password>
host: <email host like smtp.gmail.com>
port: <email port, optional, default to 587>
to:
- kubevela1@gmail.com
- kubevela2@gmail.com
content:
subject: test-subject
body: test-body

Expected outcome

We can see that before and after the deployment of the application, the messages can be seen in the corresponding group chat.

参数说明 (notification)

名称描述类型是否必须默认值
lark发送飞书信息。larkfalse
slack发送 Slack 信息。slackfalse
email发送邮件通知。emailfalse
dingding发送钉钉信息。dingdingfalse

lark (notification)

名称描述类型是否必须默认值
urlSpecify the the lark url, you can either sepcify it in value or use secretRef。url-option-0 or url-option-1true
messageSpecify the message that you want to sent, refer to Lark messagingmessagetrue
url-option-0 (notification)
名称描述类型是否必须默认值
valuethe url address content in string。stringtrue
url-option-1 (notification)
名称描述类型是否必须默认值
secretRefsecretReftrue
secretRef (notification)
名称描述类型是否必须默认值
nameKubernetes Secret 名称。stringtrue
keyKubernetes Secret 中的 key。stringtrue
message (notification)
名称描述类型是否必须默认值
contentcontent should be json encode string。stringtrue
msg_typemsg_type can be text, post, image, interactive, share_chat, share_user, audio, media, file, sticker。stringtrue

slack (notification)

名称描述类型是否必须默认值
urlSlack 的 Webhook 地址,可以选择直接在 value 填写或从 secretRef 中获取。url-option-0 or url-option-1true
messageSpecify the message that you want to sent, refer to slack messagingmessagetrue
url-option-0 (notification)
名称描述类型是否必须默认值
valuethe url address content in string。stringtrue
url-option-1 (notification)
名称描述类型是否必须默认值
secretRefsecretReftrue
secretRef (notification)
名称描述类型是否必须默认值
nameKubernetes Secret 名称。stringtrue
keyKubernetes Secret 中的 key。stringtrue
message (notification)
名称描述类型是否必须默认值
textSpecify the message text for slack notification。stringtrue
blocks(null|[...])false
attachments(null|{...})false
thread_tsstringfalse
mrkdwnSpecify the message text format in markdown for slack notification。boolfalsetrue

email (notification)

名称描述类型是否必须默认值
content指定邮件内容。contenttrue
from指定邮件发送人信息。fromtrue
to指定收件人信息。[]stringtrue
content (notification)
名称描述类型是否必须默认值
body指定邮件正文内容。stringtrue
subject指定邮件标题。stringtrue
from (notification)
名称描述类型是否必须默认值
address发件人邮件地址。stringtrue
aliasThe alias is the email alias to show after sending the email。stringfalse
passwordSpecify the password of the email, you can either sepcify it in value or use secretRef。password-option-0 or password-option-1true
hostSpecify the host of your email。stringtrue
portSpecify the port of the email host, default to 587。intfalse587
password-option-0 (notification)
名称描述类型是否必须默认值
valuethe password content in string。stringtrue
password-option-1 (notification)
名称描述类型是否必须默认值
secretRefsecretReftrue
secretRef (notification)
名称描述类型是否必须默认值
nameKubernetes Secret 名称。stringtrue
keyKubernetes Secret 中的 key。stringtrue

dingding (notification)

名称描述类型是否必须默认值
urlSpecify the the dingding url, you can either sepcify it in value or use secretRef。url-option-0 or url-option-1true
messageSpecify the message that you want to sent, refer to dingtalk messagingmessagetrue
url-option-0 (notification)
名称描述类型是否必须默认值
valuethe url address content in string。stringtrue
url-option-1 (notification)
名称描述类型是否必须默认值
secretRefsecretReftrue
secretRef (notification)
名称描述类型是否必须默认值
nameKubernetes Secret 名称。stringtrue
keyKubernetes Secret 中的 key。stringtrue
message (notification)
名称描述类型是否必须默认值
textSpecify the message content of dingtalk notification。(null|{...})false
msgtypemsgType can be text, link, mardown, actionCard, feedCard。stringfalsetext
link(null|{...})false
markdown(null|{...})false
at(null|{...})false
actionCard(null|{...})false
feedCard(null|{...})false

Read-Object

描述

在工作流中读取 Kubernetes 资源对象。

示例 (read-object)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: read-object
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
workflow:
steps:
- name: read-object
type: read-object
outputs:
- name: cpu
valueFrom: output.value.data["cpu"]
- name: memory
valueFrom: output.value.data["memory"]
properties:
apiVersion: v1
kind: ConfigMap
name: my-cm-name
cluster: <your cluster name
- name: apply
type: apply-component
inputs:
- from: cpu
parameterKey: cpu
- from: memory
parameterKey: memory
properties:
component: express-server

参数说明 (read-object)

名称描述类型是否必须默认值
nameSpecify the name of the object。stringtrue
cluster需要部署的集群名称。如果不指定,则为当前集群。stringfalseempty
apiVersionSpecify the apiVersion of the object, defaults to 'core.oam.dev/v1beta1'。stringfalse
kindSpecify the kind of the object, defaults to Application。stringfalse
namespaceThe namespace of the resource you want to read。stringfalsedefault

Share-Cloud-Resource

描述

Sync secrets created by terraform component to runtime clusters so that runtime clusters can share the created cloud resource。

参数说明 (share-cloud-resource)

名称描述类型是否必须默认值
env指定多集群策略中定义的环境名称。stringtrue
policyDeclare the name of the env-binding policy, if empty, the first env-binding policy will be used。stringfalseempty
placementsDeclare the location to bind。[]placementstrue

placements (share-cloud-resource)

名称描述类型是否必须默认值
clusterstringfalse
namespacestringfalse

Step-Group

描述

A special step that you can declare 'subSteps' in it, 'subSteps' is an array containing any step type whose valid parameters do not include the step-group step type itself. The sub steps were executed in parallel。

示例 (step-group)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: example
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
- name: express-server2
type: webservice
properties:
image: crccheck/hello-world
port: 8000

workflow:
steps:
- name: step
type: step-group
subSteps:
- name: apply-sub-step1
type: apply-component
properties:
component: express-server
- name: apply-sub-step2
type: apply-component
properties:
component: express-server2

参数说明 (step-group)

This capability has no arguments.

Suspend

描述

暂停当前工作流,可以通过 'vela workflow resume' 继续已暂停的工作流。

示例 (suspend)

The duration parameter is supported in KubeVela v1.4 or higher.

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
workflow:
steps:
- name: slack-message
type: webhook-notification
properties:
slack:
# the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
message:
text: Ready to apply the application, ask the administrator to approve and resume the workflow.
- name: manual-approval
type: suspend
# properties:
# duration: "30s"
- name: express-server
type: apply-application

参数说明 (suspend)

名称描述类型是否必须默认值
duration指定工作流暂停的时长,超过该时间后工作流将自动继续,如:"30s", "1min", "2m15s"。stringfalse

Webhook

描述

向指定 Webhook URL 发送请求,若不指定请求体,则默认发送当前 Application。

示例 (webhook)

apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: oamdev/hello-world
port: 8000
workflow:
steps:
- name: express-server
type: apply-application
- name: webhook
type: webhook
properties:
url:
value: <your webhook url>

参数说明 (webhook)

名称描述类型是否必须默认值
url需要发送的 Webhook URL,可以选择直接在 value 填写或从 secretRef 中获取。url-option-0 or url-option-1true
data需要发送的内容。map[string]:(null|bool|string|bytes|{...}|[...]|number)false

url-option-0 (webhook)

名称描述类型是否必须默认值
valuestringtrue

url-option-1 (webhook)

名称描述类型是否必须默认值
secretRefsecretReftrue
secretRef (webhook)
名称描述类型是否必须默认值
nameKubernetes Secret 名称。stringtrue
keyKubernetes Secret 中的 key。stringtrue