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: update workflowstep references with export service (#998) 

Signed-off-by: Yin Da <yd219913@alibaba-inc.com>

Signed-off-by: Yin Da <yd219913@alibaba-inc.com>
This commit is contained in:
Somefive 2022-10-24 16:24:08 +08:00 committed by GitHub
parent c82fa002ef
commit 3dcb031cce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 435 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

288
docs/end-user/workflow/built-in-workflow-defs.md
View File

@ -4,7 +4,7 @@ title: Built-in WorkflowStep Type
This documentation will walk through all the built-in workflow step types sorted alphabetically. This documentation will walk through all the built-in workflow step types sorted alphabetically.
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2022-07-24T20:59:39+08:00. > It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2022-10-10T15:04:28+08:00.
## Apply-Object ## Apply-Object
@ -65,7 +65,7 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
value | Specify Kubernetes native resource object to be applied. | map[string]:(null\|bool\|string\|bytes\|{...}\|[...]\|number) | true | value | Specify Kubernetes native resource object to be applied. | map[string]:_ | true |
cluster | The cluster you want to apply the resource to, default is the current control plane cluster. | string | false | empty cluster | The cluster you want to apply the resource to, default is the current control plane cluster. | string | false | empty
@ -181,10 +181,10 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
auto | If set to false, the workflow will suspend automatically before this step, default to be true. | bool | false | true
policies | Declare the policies that used for this deployment. If not specified, the components will be deployed to the hub cluster. | []string | false | policies | Declare the policies that used for this deployment. If not specified, the components will be deployed to the hub cluster. | []string | false |
parallelism | Maximum number of concurrent delivered components. | int | false | 5 parallelism | Maximum number of concurrent delivered components. | int | false | 5
ignoreTerraformComponent | If set false, this step will apply the components with the terraform workload. | bool | false | true ignoreTerraformComponent | If set false, this step will apply the components with the terraform workload. | bool | false | true
auto | If set to false, the workflow will suspend automatically before this step, default to be true. | bool | false | true
## Deploy-Cloud-Resource ## Deploy-Cloud-Resource
@ -198,8 +198,152 @@ Deploy cloud resource and deliver secret to multi clusters.
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
env | Declare the name of the env in policy. | string | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used. | string | false | empty policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used. | string | false | empty
env | Declare the name of the env in policy. | string | true |
## Export-Data
### Description
Export data to clusters specified by topology.
### Examples (export-data)
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-collect-service-endpoint-and-export
spec:
components:
- type: webservice
name: busybox
properties:
image: busybox
imagePullPolicy: IfNotPresent
cmd:
- sleep
- '1000000'
traits:
- type: expose
properties:
port: [8080]
type: ClusterIP
policies:
- type: topology
name: local
properties:
clusters: ["local"]
- type: topology
name: all
properties:
clusters: ["local", "cluster-worker"]
workflow:
steps:
- type: deploy
name: deploy
properties:
policies: ["local"]
- type: collect-service-endpoints
name: collect-service-endpoints
outputs:
- name: host
valueFrom: value.endpoint.host
- type: export-data
name: export-data
properties:
topology: all
inputs:
- from: host
parameterKey: data.host
```
### Specification (export-data)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
name | Specify the name of the export destination. | string | false |
namespace | Specify the namespace of the export destination. | string | false |
kind | Specify the kind of the export destination. | string | false | ConfigMap
data | Specify the data to export. | struct | true |
topology | Specify the topology to export. | string | false |
## Export-Service
### Description
Export service to clusters specified by topology.
### Examples (export-service)
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-collect-service-endpoint-and-export
spec:
components:
- type: webservice
name: busybox
properties:
image: busybox
imagePullPolicy: IfNotPresent
cmd:
- sleep
- '1000000'
traits:
- type: expose
properties:
port: [8080]
type: LoadBalancer
policies:
- type: topology
name: local
properties:
clusters: ["local"]
- type: topology
name: worker
properties:
clusters: ["cluster-worker"]
workflow:
steps:
- type: deploy
name: deploy
properties:
policies: ["local"]
- type: collect-service-endpoints
name: collect-service-endpoints
outputs:
- name: host
valueFrom: value.endpoint.host
- name: port
valueFrom: value.endpoint.port
- type: export-service
name: export-service
properties:
name: busybox
topology: worker
inputs:
- from: host
parameterKey: ip
- from: port
parameterKey: port
```
### Specification (export-service)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
name | Specify the name of the export destination. | string | false |
namespace | Specify the namespace of the export destination. | string | false |
ip | Specify the ip to be export. | string | true |
port | Specify the port to be used in service. | int | true |
targetPort | Specify the port to be export. | int | true |
topology | Specify the topology to export. | string | false |
## Export2config ## Export2config
@ -248,10 +392,10 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
cluster | Specify the cluster of the config map. | string | false | empty
namespace | Specify the namespace of the config map. | string | false |
data | Specify the data of config map. | {...} | true |
configName | Specify the name of the config map. | string | true | configName | Specify the name of the config map. | string | true |
namespace | Specify the namespace of the config map. | string | false |
data | Specify the data of config map. | struct | true |
cluster | Specify the cluster of the config map. | string | false | empty
## Export2secret ## Export2secret
@ -300,11 +444,11 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
cluster | Specify the cluster of the secret. | string | false | empty secretName | Specify the name of the secret. | string | true |
namespace | Specify the namespace of the secret. | string | false | namespace | Specify the namespace of the secret. | string | false |
type | Specify the type of the secret. | string | false | type | Specify the type of the secret. | string | false |
secretName | Specify the name of the secret. | string | true | data | Specify the data of secret. | struct | true |
data | Specify the data of secret. | {...} | true | cluster | Specify the cluster of the secret. | string | false | empty
## Generate-Jdbc-Connection ## Generate-Jdbc-Connection
@ -361,7 +505,7 @@ spec:
message: message:
msgtype: text msgtype: text
text: text:
content: Workflow starting... context: Workflow starting...
- name: application - name: application
type: apply-application type: apply-application
- name: slack-message - name: slack-message
@ -410,9 +554,9 @@ We can see that before and after the deployment of the application, the messages
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
lark | Please fulfill its url and message if you want to send Lark messages. | [lark](#lark-notification) | false | lark | Please fulfill its url and message if you want to send Lark messages. | [lark](#lark-notification) | false |
dingding | Please fulfill its url and message if you want to send DingTalk messages. | [dingding](#dingding-notification) | false |
slack | Please fulfill its url and message if you want to send Slack messages. | [slack](#slack-notification) | false | slack | Please fulfill its url and message if you want to send Slack messages. | [slack](#slack-notification) | false |
email | Please fulfill its from, to and content if you want to send email. | [email](#email-notification) | false | email | Please fulfill its from, to and content if you want to send email. | [email](#email-notification) | false |
dingding | Please fulfill its url and message if you want to send DingTalk messages. | [dingding](#dingding-notification) | false |
#### lark (notification) #### lark (notification)
@ -449,8 +593,51 @@ We can see that before and after the deployment of the application, the messages
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
content | content should be json encode string. | string | true |
msg_type | msg_type can be text, post, image, interactive, share_chat, share_user, audio, media, file, sticker. | string | true | msg_type | msg_type can be text, post, image, interactive, share_chat, share_user, audio, media, file, sticker. | string | true |
content | content should be json encode string. | string | true |
#### dingding (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
url | Specify the the dingding url, you can either sepcify it in value or use secretRef. | [url-option-0](#url-option-0-notification) or [url-option-1](#url-option-1-notification) | true |
message | Specify the message that you want to sent, refer to [dingtalk messaging](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw). | [message](#message-notification) | true |
##### url-option-0 (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
value | the url address content in string. | string | true |
##### url-option-1 (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
secretRef | | [secretRef](#secretref-notification) | true |
##### secretRef (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
name | name is the name of the secret. | string | true |
key | key is the key in the secret. | string | true |
##### message (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
text | Specify the message content of dingtalk notification. | (null&#124;struct) | false |
msgtype | msgType can be text, link, mardown, actionCard, feedCard. | string | false | text
link | | (null&#124;struct) | false |
markdown | | (null&#124;struct) | false |
at | | (null&#124;struct) | false |
actionCard | | (null&#124;struct) | false |
feedCard | | (null&#124;struct) | false |
#### slack (notification) #### slack (notification)
@ -488,8 +675,8 @@ We can see that before and after the deployment of the application, the messages
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
text | Specify the message text for slack notification. | string | true | text | Specify the message text for slack notification. | string | true |
blocks | | (null\|[...]) | false | blocks | | null | false |
attachments | | (null\|{...}) | false | attachments | | (null&#124;struct) | false |
thread_ts | | string | false | thread_ts | | string | false |
mrkdwn | Specify the message text format in markdown for slack notification. | bool | false | true mrkdwn | Specify the message text format in markdown for slack notification. | bool | false | true
@ -498,17 +685,9 @@ We can see that before and after the deployment of the application, the messages
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
content | Specify the content of the email. | [content](#content-notification) | true |
from | Specify the email info that you want to send from. | [from](#from-notification) | true | from | Specify the email info that you want to send from. | [from](#from-notification) | true |
to | Specify the email address that you want to send to. | []string | true | to | Specify the email address that you want to send to. | []string | true |
content | Specify the content of the email. | [content](#content-notification) | true |
##### content (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
body | Specify the context body of the email. | string | true |
subject | Specify the subject of the email. | string | true |
##### from (notification) ##### from (notification)
@ -544,47 +723,12 @@ We can see that before and after the deployment of the application, the messages
key | key is the key in the secret. | string | true | key | key is the key in the secret. | string | true |
#### dingding (notification) ##### content (notification)
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
url | Specify the the dingding url, you can either sepcify it in value or use secretRef. | [url-option-0](#url-option-0-notification) or [url-option-1](#url-option-1-notification) | true | subject | Specify the subject of the email. | string | true |
message | Specify the message that you want to sent, refer to [dingtalk messaging](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw). | [message](#message-notification) | true | body | Specify the context body of the email. | string | true |
##### url-option-0 (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
value | the url address content in string. | string | true |
##### url-option-1 (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
secretRef | | [secretRef](#secretref-notification) | true |
##### secretRef (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
name | name is the name of the secret. | string | true |
key | key is the key in the secret. | string | true |
##### message (notification)
Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | -------
text | Specify the message content of dingtalk notification. | (null\|{...}) | false |
msgtype | msgType can be text, link, mardown, actionCard, feedCard. | string | false | text
link | | (null\|{...}) | false |
markdown | | (null\|{...}) | false |
at | | (null\|{...}) | false |
actionCard | | (null\|{...}) | false |
feedCard | | (null\|{...}) | false |
## Read-Object ## Read-Object
@ -638,11 +782,11 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
name | Specify the name of the object. | string | true |
cluster | The cluster you want to apply the resource to, default is the current control plane cluster. | string | false | empty
apiVersion | Specify the apiVersion of the object, defaults to 'core.oam.dev/v1beta1'. | string | false | apiVersion | Specify the apiVersion of the object, defaults to 'core.oam.dev/v1beta1'. | string | false |
kind | Specify the kind of the object, defaults to Application. | string | false | kind | Specify the kind of the object, defaults to Application. | string | false |
name | Specify the name of the object. | string | true |
namespace | The namespace of the resource you want to read. | string | false | default namespace | The namespace of the resource you want to read. | string | false | default
cluster | The cluster you want to apply the resource to, default is the current control plane cluster. | string | false | empty
## Share-Cloud-Resource ## Share-Cloud-Resource
@ -656,17 +800,17 @@ Sync secrets created by terraform component to runtime clusters so that runtime
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
env | Declare the name of the env in policy. | string | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used. | string | false | empty
placements | Declare the location to bind. | [[]placements](#placements-share-cloud-resource) | true | placements | Declare the location to bind. | [[]placements](#placements-share-cloud-resource) | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used. | string | false | empty
env | Declare the name of the env in policy. | string | true |
#### placements (share-cloud-resource) #### placements (share-cloud-resource)
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
cluster | | string | false |
namespace | | string | false | namespace | | string | false |
cluster | | string | false |
## Step-Group ## Step-Group
@ -740,9 +884,11 @@ spec:
workflow: workflow:
steps: steps:
- name: slack-message - name: slack-message
type: webhook-notification type: notification
properties: properties:
slack: slack:
url:
value: <your-slack-url>
# the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks # the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
message: message:
text: Ready to apply the application, ask the administrator to approve and resume the workflow. text: Ready to apply the application, ask the administrator to approve and resume the workflow.
@ -751,7 +897,9 @@ spec:
# properties: # properties:
# duration: "30s" # duration: "30s"
- name: express-server - name: express-server
type: apply-application type: apply-component
properties:
component: express-server
``` ```
### Specification (suspend) ### Specification (suspend)
@ -800,7 +948,7 @@ spec:
Name | Description | Type | Required | Default Name | Description | Type | Required | Default
---- | ----------- | ---- | -------- | ------- ---- | ----------- | ---- | -------- | -------
url | Specify the webhook url. | [url-option-0](#url-option-0-webhook) or [url-option-1](#url-option-1-webhook) | true | url | Specify the webhook url. | [url-option-0](#url-option-0-webhook) or [url-option-1](#url-option-1-webhook) | true |
data | Specify the data you want to send. | map[string]:(null\|bool\|string\|bytes\|{...}\|[...]\|number) | false | data | Specify the data you want to send. | map[string]:_ | false |
#### url-option-0 (webhook) #### url-option-0 (webhook)

286
i18n/zh/docusaurus-plugin-content-docs/current/end-user/workflow/built-in-workflow-defs.md
View File

@ -4,7 +4,7 @@ title: 内置工作流步骤列表
本文档将**按字典序**展示所有内置工作流步骤的参数列表。 本文档将**按字典序**展示所有内置工作流步骤的参数列表。
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2022-07-24T20:59:39+08:00。 > 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2022-10-10T15:04:28+08:00。
## Apply-Object ## Apply-Object
@ -65,7 +65,7 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
value | Kubernetes 资源对象参数。 | map[string]:(null\|bool\|string\|bytes\|{...}\|[...]\|number) | true | value | Kubernetes 资源对象参数。 | map[string]:_ | true |
cluster | 需要部署的集群名称。如果不指定，则为当前集群。 | string | false | empty cluster | 需要部署的集群名称。如果不指定，则为当前集群。 | string | false | empty
@ -181,10 +181,10 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
auto | 默认为 true。如果为 false，工作流将在执行该步骤前自动暂停。。 | bool | false | true
policies | 指定本次部署要使用的策略。如果不指定策略，将自动部署到管控集群。 | []string | false | policies | 指定本次部署要使用的策略。如果不指定策略，将自动部署到管控集群。 | []string | false |
parallelism | 指定本次部署的并发度。 | int | false | 5 parallelism | 指定本次部署的并发度。 | int | false | 5
ignoreTerraformComponent | 部署时忽略 Terraform 的组件，默认忽略，Terraform 仅需要在管控集群操作云资源，不需要管控信息下发到多集群。 | bool | false | true ignoreTerraformComponent | 部署时忽略 Terraform 的组件，默认忽略，Terraform 仅需要在管控集群操作云资源，不需要管控信息下发到多集群。 | bool | false | true
auto | 默认为 true。如果为 false，工作流将在执行该步骤前自动暂停。。 | bool | false | true
## Deploy-Cloud-Resource ## Deploy-Cloud-Resource
@ -198,8 +198,152 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
env | 指定多集群策略中定义的环境名称。 | string | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used。 | string | false | empty policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used。 | string | false | empty
env | 指定多集群策略中定义的环境名称。 | string | true |
## Export-Data
### 描述
Export data to clusters specified by topology。
### 示例 (export-data)
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-collect-service-endpoint-and-export
spec:
components:
- type: webservice
name: busybox
properties:
image: busybox
imagePullPolicy: IfNotPresent
cmd:
- sleep
- '1000000'
traits:
- type: expose
properties:
port: [8080]
type: ClusterIP
policies:
- type: topology
name: local
properties:
clusters: ["local"]
- type: topology
name: all
properties:
clusters: ["local", "cluster-worker"]
workflow:
steps:
- type: deploy
name: deploy
properties:
policies: ["local"]
- type: collect-service-endpoints
name: collect-service-endpoints
outputs:
- name: host
valueFrom: value.endpoint.host
- type: export-data
name: export-data
properties:
topology: all
inputs:
- from: host
parameterKey: data.host
```
### 参数说明 (export-data)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
name | Specify the name of the export destination。 | string | false |
namespace | Specify the namespace of the export destination。 | string | false |
kind | Specify the kind of the export destination。 | string | false | ConfigMap
data | Specify the data to export。 | struct | true |
topology | Specify the topology to export。 | string | false |
## Export-Service
### 描述
Export service to clusters specified by topology。
### 示例 (export-service)
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-collect-service-endpoint-and-export
spec:
components:
- type: webservice
name: busybox
properties:
image: busybox
imagePullPolicy: IfNotPresent
cmd:
- sleep
- '1000000'
traits:
- type: expose
properties:
port: [8080]
type: LoadBalancer
policies:
- type: topology
name: local
properties:
clusters: ["local"]
- type: topology
name: worker
properties:
clusters: ["cluster-worker"]
workflow:
steps:
- type: deploy
name: deploy
properties:
policies: ["local"]
- type: collect-service-endpoints
name: collect-service-endpoints
outputs:
- name: host
valueFrom: value.endpoint.host
- name: port
valueFrom: value.endpoint.port
- type: export-service
name: export-service
properties:
name: busybox
topology: worker
inputs:
- from: host
parameterKey: ip
- from: port
parameterKey: port
```
### 参数说明 (export-service)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
name | Specify the name of the export destination。 | string | false |
namespace | Specify the namespace of the export destination。 | string | false |
ip | Specify the ip to be export。 | string | true |
port | Specify the port to be used in service。 | int | true |
targetPort | Specify the port to be export。 | int | true |
topology | Specify the topology to export。 | string | false |
## Export2config ## Export2config
@ -248,10 +392,10 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
cluster | 要导出到的集群名称。 | string | false | empty
namespace | ConfigMap 的 namespace，默认为当前应用的 namespace。 | string | false |
data | 需要导出到 ConfigMap 中的数据，是一个 key-value 的 map。 | {...} | true |
configName | ConfigMap 的名称。 | string | true | configName | ConfigMap 的名称。 | string | true |
namespace | ConfigMap 的 namespace，默认为当前应用的 namespace。 | string | false |
data | 需要导出到 ConfigMap 中的数据，是一个 key-value 的 map。 | struct | true |
cluster | 要导出到的集群名称。 | string | false | empty
## Export2secret ## Export2secret
@ -300,11 +444,11 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
cluster | 要导出到的集群名称。 | string | false | empty secretName | Secret 的名称。 | string | true |
namespace | secret 的 namespace，默认为当前应用的 namespace。 | string | false | namespace | secret 的 namespace，默认为当前应用的 namespace。 | string | false |
type | 指定导出的 secret 类型。 | string | false | type | 指定导出的 secret 类型。 | string | false |
secretName | Secret 的名称。 | string | true | data | 需要导出到 Secret 中的数据。 | struct | true |
data | 需要导出到 Secret 中的数据。 | {...} | true | cluster | 要导出到的集群名称。 | string | false | empty
## Generate-Jdbc-Connection ## Generate-Jdbc-Connection
@ -410,9 +554,9 @@ We can see that before and after the deployment of the application, the messages
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
lark | 发送飞书信息。 | [lark](#lark-notification) | false | lark | 发送飞书信息。 | [lark](#lark-notification) | false |
dingding | 发送钉钉信息。 | [dingding](#dingding-notification) | false |
slack | 发送 Slack 信息。 | [slack](#slack-notification) | false | slack | 发送 Slack 信息。 | [slack](#slack-notification) | false |
email | 发送邮件通知。 | [email](#email-notification) | false | email | 发送邮件通知。 | [email](#email-notification) | false |
dingding | 发送钉钉信息。 | [dingding](#dingding-notification) | false |
#### lark (notification) #### lark (notification)
@ -449,8 +593,51 @@ We can see that before and after the deployment of the application, the messages
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
content | content should be json encode string。 | string | true |
msg_type | msg_type can be text, post, image, interactive, share_chat, share_user, audio, media, file, sticker。 | string | true | msg_type | msg_type can be text, post, image, interactive, share_chat, share_user, audio, media, file, sticker。 | string | true |
content | content should be json encode string。 | string | true |
#### dingding (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
url | Specify the the dingding url, you can either sepcify it in value or use secretRef。 | [url-option-0](#url-option-0-notification) or [url-option-1](#url-option-1-notification) | true |
message | Specify the message that you want to sent, refer to [dingtalk messaging](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw)。 | [message](#message-notification) | true |
##### url-option-0 (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
value | the url address content in string。 | string | true |
##### url-option-1 (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
secretRef | | [secretRef](#secretref-notification) | true |
##### secretRef (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
name | Kubernetes Secret 名称。 | string | true |
key | Kubernetes Secret 中的 key。 | string | true |
##### message (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
text | Specify the message content of dingtalk notification。 | (null&#124;struct) | false |
msgtype | msgType can be text, link, mardown, actionCard, feedCard。 | string | false | text
link | | (null&#124;struct) | false |
markdown | | (null&#124;struct) | false |
at | | (null&#124;struct) | false |
actionCard | | (null&#124;struct) | false |
feedCard | | (null&#124;struct) | false |
#### slack (notification) #### slack (notification)
@ -488,8 +675,8 @@ We can see that before and after the deployment of the application, the messages
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
text | Specify the message text for slack notification。 | string | true | text | Specify the message text for slack notification。 | string | true |
blocks | | (null\|[...]) | false | blocks | | null | false |
attachments | | (null\|{...}) | false | attachments | | (null&#124;struct) | false |
thread_ts | | string | false | thread_ts | | string | false |
mrkdwn | Specify the message text format in markdown for slack notification。 | bool | false | true mrkdwn | Specify the message text format in markdown for slack notification。 | bool | false | true
@ -498,17 +685,9 @@ We can see that before and after the deployment of the application, the messages
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
content | 指定邮件内容。 | [content](#content-notification) | true |
from | 指定邮件发送人信息。 | [from](#from-notification) | true | from | 指定邮件发送人信息。 | [from](#from-notification) | true |
to | 指定收件人信息。 | []string | true | to | 指定收件人信息。 | []string | true |
content | 指定邮件内容。 | [content](#content-notification) | true |
##### content (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
body | 指定邮件正文内容。 | string | true |
subject | 指定邮件标题。 | string | true |
##### from (notification) ##### from (notification)
@ -544,47 +723,12 @@ We can see that before and after the deployment of the application, the messages
key | Kubernetes Secret 中的 key。 | string | true | key | Kubernetes Secret 中的 key。 | string | true |
#### dingding (notification) ##### content (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
url | Specify the the dingding url, you can either sepcify it in value or use secretRef。 | [url-option-0](#url-option-0-notification) or [url-option-1](#url-option-1-notification) | true | subject | 指定邮件标题。 | string | true |
message | Specify the message that you want to sent, refer to [dingtalk messaging](https://developers.dingtalk.com/document/robots/custom-robot-access/title-72m-8ag-pqw)。 | [message](#message-notification) | true | body | 指定邮件正文内容。 | string | true |
##### url-option-0 (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
value | the url address content in string。 | string | true |
##### url-option-1 (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
secretRef | | [secretRef](#secretref-notification) | true |
##### secretRef (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
name | Kubernetes Secret 名称。 | string | true |
key | Kubernetes Secret 中的 key。 | string | true |
##### message (notification)
名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | ---------
text | Specify the message content of dingtalk notification。 | (null\|{...}) | false |
msgtype | msgType can be text, link, mardown, actionCard, feedCard。 | string | false | text
link | | (null\|{...}) | false |
markdown | | (null\|{...}) | false |
at | | (null\|{...}) | false |
actionCard | | (null\|{...}) | false |
feedCard | | (null\|{...}) | false |
## Read-Object ## Read-Object
@ -638,11 +782,11 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
name | Specify the name of the object。 | string | true |
cluster | 需要部署的集群名称。如果不指定，则为当前集群。 | string | false | empty
apiVersion | Specify the apiVersion of the object, defaults to 'core.oam.dev/v1beta1'。 | string | false | apiVersion | Specify the apiVersion of the object, defaults to 'core.oam.dev/v1beta1'。 | string | false |
kind | Specify the kind of the object, defaults to Application。 | string | false | kind | Specify the kind of the object, defaults to Application。 | string | false |
name | Specify the name of the object。 | string | true |
namespace | The namespace of the resource you want to read。 | string | false | default namespace | The namespace of the resource you want to read。 | string | false | default
cluster | 需要部署的集群名称。如果不指定，则为当前集群。 | string | false | empty
## Share-Cloud-Resource ## Share-Cloud-Resource
@ -656,17 +800,17 @@ Sync secrets created by terraform component to runtime clusters so that runtime
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
env | 指定多集群策略中定义的环境名称。 | string | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used。 | string | false | empty
placements | Declare the location to bind。 | [[]placements](#placements-share-cloud-resource) | true | placements | Declare the location to bind。 | [[]placements](#placements-share-cloud-resource) | true |
policy | Declare the name of the env-binding policy, if empty, the first env-binding policy will be used。 | string | false | empty
env | 指定多集群策略中定义的环境名称。 | string | true |
#### placements (share-cloud-resource) #### placements (share-cloud-resource)
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
cluster | | string | false |
namespace | | string | false | namespace | | string | false |
cluster | | string | false |
## Step-Group ## Step-Group
@ -740,9 +884,11 @@ spec:
workflow: workflow:
steps: steps:
- name: slack-message - name: slack-message
type: webhook-notification type: notification
properties: properties:
slack: slack:
url:
value: <your-slack-url>
# the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks # the Slack webhook address, please refer to: https://api.slack.com/messaging/webhooks
message: message:
text: Ready to apply the application, ask the administrator to approve and resume the workflow. text: Ready to apply the application, ask the administrator to approve and resume the workflow.
@ -751,7 +897,9 @@ spec:
# properties: # properties:
# duration: "30s" # duration: "30s"
- name: express-server - name: express-server
type: apply-application type: apply-component
properties:
component: express-server
``` ```
### 参数说明 (suspend) ### 参数说明 (suspend)
@ -800,7 +948,7 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值 名称 | 描述 | 类型 | 是否必须 | 默认值
------ | ------ | ------ | ------------ | --------- ------ | ------ | ------ | ------------ | ---------
url | 需要发送的 Webhook URL，可以选择直接在 value 填写或从 secretRef 中获取。 | [url-option-0](#url-option-0-webhook) or [url-option-1](#url-option-1-webhook) | true | url | 需要发送的 Webhook URL，可以选择直接在 value 填写或从 secretRef 中获取。 | [url-option-0](#url-option-0-webhook) or [url-option-1](#url-option-1-webhook) | true |
data | 需要发送的内容。 | map[string]:(null\|bool\|string\|bytes\|{...}\|[...]\|number) | false | data | 需要发送的内容。 | map[string]:_ | false |
#### url-option-0 (webhook) #### url-option-0 (webhook)