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: rename multi-env to deploy2env (#284)

This commit is contained in:
Somefive 2021-09-15 14:59:37 +08:00 committed by GitHub
parent 2701b5e707
commit 964e3dfb14
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/case-studies/multi-cluster.md
View File

@ -118,7 +118,7 @@ spec:
steps: steps:
# deploy to staging env # deploy to staging env
- name: deploy-staging - name: deploy-staging
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: staging env: staging
@ -129,7 +129,7 @@ spec:
# deploy to prod env # deploy to prod env
- name: deploy-prod - name: deploy-prod
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: prod env: prod
@ -164,7 +164,7 @@ We can see that the workflow is suspended at `manual-approval`:
- id: wek2b31nai - id: wek2b31nai
name: deploy-staging name: deploy-staging
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
- id: 7j5eb764mk - id: 7j5eb764mk
name: manual-approval name: manual-approval
phase: succeeded phase: succeeded
@ -280,7 +280,7 @@ All the step status in workflow is succeeded:
- id: q8yx7pr8wb - id: q8yx7pr8wb
name: deploy-staging name: deploy-staging
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
- id: 6oxrtvki9o - id: 6oxrtvki9o
name: manual-approval name: manual-approval
phase: succeeded phase: succeeded
@ -288,7 +288,7 @@ All the step status in workflow is succeeded:
- id: uk287p8c31 - id: uk287p8c31
name: deploy-prod name: deploy-prod
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
suspend: false suspend: false
terminated: false terminated: false
waitCount: 0 waitCount: 0

12
docs/core-concepts/application.md
View File

@ -44,17 +44,17 @@ spec:
envs: envs:
- name: test - name: test
placement: placement:
namespaceSelector: clusterSelector:
name: test name: cluster-test
- name: prod - name: prod
placement: placement:
namespaceSelector: clusterSelector:
name: prod name: cluster-prod
workflow: workflow:
steps: steps:
#workflow step name #workflow step name
- name: deploy-test-env - name: deploy-test-env
type: multi-env type: deploy2env
properties: properties:
# Specify the policy name # Specify the policy name
policy: demo-policy policy: demo-policy
@ -64,7 +64,7 @@ spec:
# use suspend can stop workflow and wait here until condition changed # use suspend can stop workflow and wait here until condition changed
type: suspend type: suspend
- name: deploy-prod-env - name: deploy-prod-env
type: multi-env type: deploy2env
properties: properties:
# Specify the policy name # Specify the policy name
policy: demo-policy policy: demo-policy

4
docs/end-user/policies/envbinding.md
View File

@ -64,7 +64,7 @@ spec:
steps: steps:
# deploy to staging env # deploy to staging env
- name: deploy-staging - name: deploy-staging
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: staging env: staging
@ -75,7 +75,7 @@ spec:
# deploy to prod env # deploy to prod env
- name: deploy-prod - name: deploy-prod
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: prod env: prod

18
docs/end-user/workflow/multi-env.md
View File

@ -2,17 +2,17 @@
title: Multi Environments title: Multi Environments
--- ---
If we have multiple clusters, we want to apply our application in the test cluster first, and then apply it to the production cluster after the application in test cluster is running. KubeVela provides the `multi-env` workflow step to manage multi environments. You can have a glimpse of how does it work as below: If we have multiple clusters, we want to apply our application in the test cluster first, and then apply it to the production cluster after the application in test cluster is running. KubeVela provides the `deploy2env` workflow step to manage multi environments. You can have a glimpse of how does it work as below:
![alt](../../resources/workflow-multi-env.png) ![alt](../../resources/workflow-multi-env.png)
In this guide, you will learn how to manage multi environments via `multi-env` in `Workflow`. In this guide, you will learn how to manage multi environments via `deploy2env` in `Workflow`.
> Before reading this section, please make sure you have learned about the [Env Binding](../policies/envbinding) in KubeVela. > Before reading this section, please make sure you have learned about the [Env Binding](../policies/envbinding) in KubeVela.
## How to use ## How to use
Apply the following `Application` with workflow step type of `multi-env`: Apply the following `Application` with workflow step type of `deploy2env`:
```yaml ```yaml
apiVersion: core.oam.dev/v1beta1 apiVersion: core.oam.dev/v1beta1
@ -63,7 +63,7 @@ spec:
steps: steps:
- name: deploy-test-server - name: deploy-test-server
# specify the workflow step type # specify the workflow step type
type: multi-env type: deploy2env
properties: properties:
# specify the component name # specify the component name
component: nginx-server component: nginx-server
@ -75,7 +75,7 @@ spec:
# suspend is a built-in task of workflow used to suspend the workflow # suspend is a built-in task of workflow used to suspend the workflow
type: suspend type: suspend
- name: deploy-prod-server - name: deploy-prod-server
type: multi-env type: deploy2env
properties: properties:
component: nginx-server component: nginx-server
policy: env policy: env
@ -102,7 +102,7 @@ We can see that the workflow is suspended at `manual-approval`:
- name: deploy-test-server - name: deploy-test-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
- name: manual-approval - name: manual-approval
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
@ -146,7 +146,7 @@ All the step status in workflow is succeeded:
- name: deploy-test-server - name: deploy-test-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
- name: manual-approval - name: manual-approval
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
@ -154,7 +154,7 @@ All the step status in workflow is succeeded:
- name: deploy-prod-server - name: deploy-prod-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
suspend: false suspend: false
terminated: true terminated: true
``` ```
@ -170,4 +170,4 @@ nginx-server 1/1 1 1 1m10s
We can see that the component have been applied to both clusters. We can see that the component have been applied to both clusters.
With `multi-env`, we can easily manage applications in multiple environments. With `deploy2env`, we can easily manage applications in multiple environments.

4
docs/platform-engineers/workflow/built-in-workflow-defs.md
View File

@ -145,12 +145,12 @@ spec:
workflow: workflow:
steps: steps:
- name: deploy-test-server - name: deploy-test-server
type: multi-env type: deploy2env
properties: properties:
policy: env policy: env
env: test env: test
- name: deploy-prod-server - name: deploy-prod-server
type: multi-env type: deploy2env
properties: properties:
policy: env policy: env
env: prod env: prod

10
i18n/zh/docusaurus-plugin-content-docs/current/case-studies/multi-cluster.md
View File

@ -115,7 +115,7 @@ spec:
steps: steps:
# 部署到预发环境中 # 部署到预发环境中
- name: deploy-staging - name: deploy-staging
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: staging env: staging
@ -126,7 +126,7 @@ spec:
# 部署到生产环境中 # 部署到生产环境中
- name: deploy-prod - name: deploy-prod
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: prod env: prod
@ -161,7 +161,7 @@ example-app hello-world-server webservice workflowSuspending true R
- id: wek2b31nai - id: wek2b31nai
name: deploy-staging name: deploy-staging
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
- id: 7j5eb764mk - id: 7j5eb764mk
name: manual-approval name: manual-approval
phase: succeeded phase: succeeded
@ -277,7 +277,7 @@ example-app hello-world-server webservice running true Ready:1/1
- id: q8yx7pr8wb - id: q8yx7pr8wb
name: deploy-staging name: deploy-staging
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
- id: 6oxrtvki9o - id: 6oxrtvki9o
name: manual-approval name: manual-approval
phase: succeeded phase: succeeded
@ -285,7 +285,7 @@ example-app hello-world-server webservice running true Ready:1/1
- id: uk287p8c31 - id: uk287p8c31
name: deploy-prod name: deploy-prod
phase: succeeded phase: succeeded
type: multi-env type: deploy2env
suspend: false suspend: false
terminated: false terminated: false
waitCount: 0 waitCount: 0

16
i18n/zh/docusaurus-plugin-content-docs/current/core-concepts/application.md
View File

@ -44,18 +44,18 @@ spec:
envs: envs:
- name: test - name: test
placement: placement:
namespaceSelector: clusterSelector:
name: test name: cluster-test
- name: prod - name: prod
placement: placement:
namespaceSelector: clusterSelector:
name: prod name: cluster-prod
workflow: workflow:
steps: steps:
# 步骤名称 # 步骤名称
- name: deploy-test-env - name: deploy-test-env
# 指定步骤类型 # 指定步骤类型
type: multi-env type: deploy2env
properties: properties:
# 指定策略名称 # 指定策略名称
policy: demo-policy policy: demo-policy
@ -65,7 +65,7 @@ spec:
# 工作流内置 suspend 类型的任务，用于暂停工作流 # 工作流内置 suspend 类型的任务，用于暂停工作流
type: suspend type: suspend
- name: deploy-prod-env - name: deploy-prod-env
type: multi-env type: deploy2env
properties: properties:
policy: demo-policy policy: demo-policy
env: prod env: prod
@ -151,8 +151,8 @@ KubeVela 的工作流机制允许用户自定义应用部署计划中的步骤
在上面的例子中，我们已经可以看到一些工作流的步骤： 在上面的例子中，我们已经可以看到一些工作流的步骤：
- 这里使用了 `multi-env` 和 `suspend` 类型的工作流步骤： - 这里使用了 `deploy2env` 和 `suspend` 类型的工作流步骤：
- `multi-env` 类型可以根据用户定义的策略将应用部署到指定的环境。 - `deploy2env` 类型可以根据用户定义的策略将应用部署到指定的环境。
- 在第一步完成后，开始执行 `suspend` 类型的工作流步骤。该步骤会暂停工作流，我们可以查看集群中第一个组件的状态，当其成功运行后，再使用 `vela workflow resume website` 命令来继续该工作流。 - 在第一步完成后，开始执行 `suspend` 类型的工作流步骤。该步骤会暂停工作流，我们可以查看集群中第一个组件的状态，当其成功运行后，再使用 `vela workflow resume website` 命令来继续该工作流。
- 当工作流继续运行后，第三个步骤开始部署组件及运维特征。此时我们查看集群，可以看到所以资源都已经被成功部署。 - 当工作流继续运行后，第三个步骤开始部署组件及运维特征。此时我们查看集群，可以看到所以资源都已经被成功部署。

4
i18n/zh/docusaurus-plugin-content-docs/current/end-user/policies/envbinding.md
View File

@ -64,7 +64,7 @@ spec:
steps: steps:
# 部署 预发 环境 # 部署 预发 环境
- name: deploy-staging - name: deploy-staging
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: staging env: staging
@ -75,7 +75,7 @@ spec:
# 部署 生产 环境 # 部署 生产 环境
- name: deploy-prod - name: deploy-prod
type: multi-env type: deploy2env
properties: properties:
policy: example-multi-env-policy policy: example-multi-env-policy
env: prod env: prod

12
i18n/zh/docusaurus-plugin-content-docs/current/end-user/workflow/multi-env.md
View File

@ -65,7 +65,7 @@ spec:
steps: steps:
- name: deploy-test-server - name: deploy-test-server
# 指定步骤类型 # 指定步骤类型
type: multi-env type: deploy2env
properties: properties:
# 指定组件名称 # 指定组件名称
component: nginx-server component: nginx-server
@ -77,7 +77,7 @@ spec:
# 工作流内置 suspend 类型的任务，用于暂停工作流 # 工作流内置 suspend 类型的任务，用于暂停工作流
type: suspend type: suspend
- name: deploy-prod-server - name: deploy-prod-server
type: multi-env type: deploy2env
properties: properties:
component: nginx-server component: nginx-server
policy: env policy: env
@ -104,7 +104,7 @@ kubectl get application multi-env-demo -o yaml
- name: deploy-test-server - name: deploy-test-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
- name: manual-approval - name: manual-approval
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
@ -148,7 +148,7 @@ kubectl get application multi-env-demo -o yaml
- name: deploy-test-server - name: deploy-test-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
- name: manual-approval - name: manual-approval
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
@ -156,7 +156,7 @@ kubectl get application multi-env-demo -o yaml
- name: deploy-prod-server - name: deploy-prod-server
phase: succeeded phase: succeeded
resourceRef: {} resourceRef: {}
type: multi-env type: deploy2env
suspend: false suspend: false
terminated: true terminated: true
``` ```
@ -172,4 +172,4 @@ nginx-server 1/1 1 1 1m10s
可以看到，使用最新配置的组件已经被成功地部署到了两个集群中。 可以看到，使用最新配置的组件已经被成功地部署到了两个集群中。
通过 `multi-env`，我们可以轻松地在多个环境中管理应用。 通过 `deploy2env`，我们可以轻松地在多个环境中管理应用。

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

@ -145,12 +145,12 @@ spec:
workflow: workflow:
steps: steps:
- name: deploy-test-server - name: deploy-test-server
type: multi-env type: deploy2env
properties: properties:
policy: env policy: env
env: test env: test
- name: deploy-prod-server - name: deploy-prod-server
type: multi-env type: deploy2env
properties: properties:
policy: env policy: env
env: prod env: prod