mirror of
https://github.com/kubevela/kubevela.git
synced 2026-05-02 15:36:58 +00:00
Chore: add examples of def docs for workflow step
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
```yaml
|
||||
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: apply-application
|
||||
```
|
||||
45
references/docgen/def-doc/workflowstep/apply-object.eg.md
Normal file
45
references/docgen/def-doc/workflowstep/apply-object.eg.md
Normal file
@@ -0,0 +1,45 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
36
references/docgen/def-doc/workflowstep/deploy.eg.md
Normal file
36
references/docgen/def-doc/workflowstep/deploy.eg.md
Normal file
@@ -0,0 +1,36 @@
|
||||
```yaml
|
||||
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"]
|
||||
```
|
||||
32
references/docgen/def-doc/workflowstep/export2config.eg.md
Normal file
32
references/docgen/def-doc/workflowstep/export2config.eg.md
Normal file
@@ -0,0 +1,32 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
32
references/docgen/def-doc/workflowstep/export2secret.eg.md
Normal file
32
references/docgen/def-doc/workflowstep/export2secret.eg.md
Normal file
@@ -0,0 +1,32 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
69
references/docgen/def-doc/workflowstep/notification.eg.md
Normal file
69
references/docgen/def-doc/workflowstep/notification.eg.md
Normal file
@@ -0,0 +1,69 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
37
references/docgen/def-doc/workflowstep/read-object.eg.md
Normal file
37
references/docgen/def-doc/workflowstep/read-object.eg.md
Normal file
@@ -0,0 +1,37 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
29
references/docgen/def-doc/workflowstep/suspend.eg.md
Normal file
29
references/docgen/def-doc/workflowstep/suspend.eg.md
Normal file
@@ -0,0 +1,29 @@
|
||||
```yaml
|
||||
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
|
||||
```
|
||||
23
references/docgen/def-doc/workflowstep/webhook.eg.md
Normal file
23
references/docgen/def-doc/workflowstep/webhook.eg.md
Normal file
@@ -0,0 +1,23 @@
|
||||
```yaml
|
||||
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>
|
||||
```
|
||||
Reference in New Issue
Block a user