kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: add built-in workflows doc (#226)

This commit is contained in:
Tianxin Dong 2021-09-02 16:00:39 +08:00 committed by GitHub
parent d398b84890
commit 304462daf6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 543 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

271
docs/platform-engineers/workflow/built-in-workflow-defs.md Normal file
View File

@ -0,0 +1,271 @@
---
title: Built-in Workflow Definitions
---
KubeVela provides some built-in workflow step definitions for better experience.
## apply-application
### Overview
Apply all components and traits in Application.
### Parameter
| Name | Type | Description |
| :---: | :--: | :--: |
| - | - | - |
### Example
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: express-server
type: apply-application
```
## depends-on-app
### Overview
Wait for the specified Application to complete.
### Parameter
| Name | Type | Description |
| :---: | :--: | :--: |
| name | string | The name of the Application |
| namespace | string | The namespace of the Application |
### Example
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/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
```
## multi-env
### Overview
Apply Application in different policies and envs.
### Parameter
| Name | Type | Description |
| :---: | :--: | :--: |
| policy | string | The name of the policy |
| env | string | The name of the env |
### Example
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: multi-env-demo
namespace: default
spec:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.21
port: 80
policies:
- name: env
type: env-binding
properties:
created: false
envs:
- name: test
patch:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.20
port: 80
placement:
namespaceSelector:
name: test
- name: prod
patch:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.20
port: 80
placement:
namespaceSelector:
name: prod
workflow:
steps:
- name: deploy-test-server
type: multi-env
properties:
policy: env
env: test
- name: deploy-prod-server
type: multi-env
properties:
policy: env
env: prod
```
## webhook-notification
### Overview
Send messages to the webhook address.
### 参数
| Name | Type | Description |
| :---: | :--: | :-- |
| slack | Object | Optional, please fulfill its url and message if you want to send Slack messages |
| slack.url | String | Required, the webhook address of Slack |
| slack.message | Object | Required, the Slack messages you want to send, please follow [Slack messaging](https://api.slack.com/reference/messaging/payload) |
| dingding | Object | Optional, please fulfill its url and message if you want to send DingTalk messages |
| dingding.url | String | Required, the webhook address of DingTalk |
| dingding.message | Object | Required, the DingTalk messages you want to send, please follow [DingTalk messaging](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw) | |
### Example
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: dingtalk-message
type: webhook-notification
properties:
dingding:
# the DingTalk webhook address, please refer to: https://developers.dingtalk.com/document/robots/custom-robot-access
url: xxx
message:
msgtype: text
text:
context: Workflow starting...
- name: application
type: apply-application
- name: slack-message
type: webhook-notification
properties:
slack:
# the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
url: xxx
message:
text: Workflow ended.
```
## suspend
### Overview
Suspend the current workflow, we can use `vela workflow resume appname` to resume the suspended workflow.
> For more information of `vela workflow`, please refer to [vela cli](../../cli/vela_workflow)。
### Parameter
| Name | Type | Description |
| :---: | :--: | :--: |
| - | - | - |
### Example
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 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
- name: express-server
type: apply-application
```

272
i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/workflow/built-in-workflow-defs.md Normal file
View File

@ -0,0 +1,272 @@
---
title: 内置工作流步骤
---
为了便于用户使用，KubeVela 提供了一些内置的工作流步骤。
## apply-application
### 简介
部署当前 Application 中的所有组件和运维特征。
### 参数
| 参数名 | 类型 | 说明 |
| :---: | :--: | :--: |
| - | - | - |
### 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: express-server
type: apply-application
```
## depends-on-app
### 简介
等待指定的 Application 完成。
### 参数
| 参数名 | 类型 | 说明 |
| :---: | :--: | :--: |
| name | string | 需要等待的 Application 名称 |
| namespace | string | 需要等待的 Application 所在的命名空间 |
### 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/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
```
## multi-env
### 简介
将 Application 在不同的环境和策略中部署。
### 参数
| 参数名 | 类型 | 说明 |
| :---: | :--: | :--: |
| policy | string | 需要关联的策略名 |
| env | string | 需要关联的环境名 |
### 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: multi-env-demo
namespace: default
spec:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.21
port: 80
policies:
- name: env
type: env-binding
properties:
created: false
envs:
- name: test
patch:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.20
port: 80
placement:
namespaceSelector:
name: test
- name: prod
patch:
components:
- name: nginx-server
type: webservice
properties:
image: nginx:1.20
port: 80
placement:
namespaceSelector:
name: prod
workflow:
steps:
- name: deploy-test-server
type: multi-env
properties:
policy: env
env: test
- name: deploy-prod-server
type: multi-env
properties:
policy: env
env: prod
```
## webhook-notification
### 简介
向指定的 Webhook 发送信息。
### 参数
| 参数名 | 类型 | 说明 |
| :---: | :--: | :-- |
| slack | Object | 可选值，如果需要发送 Slack 信息，则需填写其 url 及 message |
| slack.url | String | 必填值，Slack 的 Webhook 地址 |
| slack.message | Object | 必填值，需要发送的 Slack 信息，请符合 [Slack 信息规范](https://api.slack.com/reference/messaging/payload) |
| dingding | Object | 可选值，如果需要发送钉钉信息，则需填写其 url 及 message |
| dingding.url | String | 必填值，钉钉的 Webhook 地址 |
| dingding.message | Object | 必填值，需要发送的钉钉信息，请符合 [钉钉信息规范](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw) |
### 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: dingtalk-message
type: webhook-notification
properties:
dingding:
# 钉钉 Webhook 地址，请查看：https://developers.dingtalk.com/document/robots/custom-robot-access
url: xxx
message:
msgtype: text
text:
context: 开始运行工作流
- name: application
type: apply-application
- name: slack-message
type: webhook-notification
properties:
slack:
# Slack Webhook 地址，请查看：https://api.slack.com/messaging/webhooks
url: xxx
message:
text: 工作流运行完成
```
## suspend
### 简介
暂停当前工作流，可以通过 `vela workflow resume appname` 继续已暂停的工作流。
> 有关于 `vela workflow` 命令的介绍，可以详见 [vela cli](../../cli/vela_workflow)。
### 参数
| 参数名 | 类型 | 说明 |
| :---: | :--: | :--: |
| - | - | - |
### 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-workflow
namespace: default
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
/: 8000
workflow:
steps:
- name: slack-message
type: webhook-notification
properties:
slack:
# Slack Webhook 地址，请查看：https://api.slack.com/messaging/webhooks
url: xxx
message:
text: 准备开始部署应用，请管理员审批并继续工作流
- name: manual-approval
type: suspend
- name: express-server
type: apply-application
```