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

Feat: update cli command and use vela up (#426) 

* Feat: update cli command and use vela up

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* refine vela CLI how-to

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Add more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Update cli doc

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* Fix: refine more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>

* refine more docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-01-12 21:27:19 +08:00 committed by GitHub
parent ac4016a5f4
commit 3870f8de4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
208 changed files with 1579 additions and 1896 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -25,4 +25,5 @@ yarn-error.log*
# editor and IDE paraphernalia
.idea
.vscode
_tmp/

6
docs/case-studies/canary-blue-green.md
View File

@ -32,7 +32,7 @@ kubectl label namespace default istio-injection=enabled
Deploy the Application of `bookinfo`:
```shell
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/first-deploy.yaml
vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/first-deploy.yaml
```
The component architecture and relationship of the application are as follows:
@ -86,7 +86,7 @@ Next, we take the `reviews` Component as an example to simulate the complete pro
Execute the following command to update the application.
```shell
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/rollout-v2.yaml
vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/rollout-v2.yaml
```
This operation updates the mirror of the `reviews` Component from the previous v2 to v3. At the same time, the Rollout Trait of the `reviews` Component specifies that the number of target instances to be upgraded is two, which are upgraded in two batches, with one instance in each batch.
@ -187,7 +187,7 @@ If you continue to verify the webpage several times on the browser, you will fin
During the manual verification, if the service does not meet the expectations, you can terminate the pre-defined release workflow and rollback the instances and the traffic to the previous version.
```shell
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/rollback.yaml
vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/canary-rollout-use-case/rollback.yaml
```
This is basically updates the workflow to rollback step:

4
docs/case-studies/gitops.md
View File

@ -170,7 +170,7 @@ After storing bellow files in the Git config repo, we need to apply the GitOps c
First, apply the `clusters/infra.yaml` to cluster, we can see that the MySQL in `infrastructure/` is automatically deployed:
```shell
kubectl apply -f clusters/infra.yaml
vela up -f clusters/infra.yaml
```
```shell
@ -185,7 +185,7 @@ mysql mysql-controller helm running healthy 2021-09-26 20:
Apply the `clusters/apps.yaml` to cluster, we can see that the application in `apps/` is automatically deployed:
```shell
kubectl apply -f clusters/apps.yaml
vela up -f clusters/apps.yaml
```
```shell

2
docs/case-studies/initialize-env.md
View File

@ -48,7 +48,7 @@ We can use `depends-on-app` to make sure `fluxcd` is deployed before kruise.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:

4
docs/cli/vela.md
View File

@ -7,7 +7,7 @@ title: CLI Commands
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Create or update vela application from file, both appfile or application object format are supported.
* [vela up](vela_up) - Create or update vela application from file or URL, both appfile or application object format are supported.
* [vela show](vela_show) - Show the reference doc for component or trait types.
## Managing Applications
@ -40,6 +40,6 @@ title: CLI Commands
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh).
The shell code must be evaluated to provide interactive completion of vela commands.
* [vela export](vela_export) - Export deploy manifests from appfile or application.
* [vela version](vela_version) - Prints out build version information.
* [vela version](vela_version) - Prints vela build version information.
###### Auto generated by [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_addon.md
View File

@ -20,11 +20,11 @@ Manage addons for extension.
* [vela addon disable](vela_addon_disable) - disable an addon
* [vela addon enable](vela_addon_enable) - enable an addon
* [vela addon list](vela_addon_list) - List addons
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon status](vela_addon_status) - get an addon's status
* [vela addon registry](vela_addon_registry) - Manage addon registry.
* [vela addon status](vela_addon_status) - get an addon's status.
* [vela addon upgrade](vela_addon_upgrade) - upgrade an addon
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_addon_disable.md
View File

@ -6,7 +6,7 @@ disable an addon
### Synopsis
disable an addon in cluster
disable an addon in cluster.
```
vela addon disable [flags]
@ -31,4 +31,4 @@ vela addon disable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_addon_enable.md
View File

@ -6,7 +6,7 @@ enable an addon
### Synopsis
enable an addon in cluster
enable an addon in cluster.
```
vela addon enable [flags]
@ -31,4 +31,4 @@ vela addon enable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_addon_list.md
View File

@ -25,4 +25,4 @@ vela addon list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

14
docs/cli/vela_addon_registry.md
View File

@ -2,11 +2,11 @@
title: vela addon registry
---
Manage addon registry
Manage addon registry.
### Synopsis
Manage addon registry
Manage addon registry.
### Options
@ -17,13 +17,13 @@ Manage addon registry
### SEE ALSO
* [vela addon](vela_addon) - Manage addons for extension.
* [vela addon registry add](vela_addon_registry_add) - Add an addon registry
* [vela addon registry add](vela_addon_registry_add) - Add an addon registry.
* [vela addon registry delete](vela_addon_registry_delete) - Delete an addon registry
* [vela addon registry get](vela_addon_registry_get) - Get an addon registry
* [vela addon registry list](vela_addon_registry_list) - List addon registries
* [vela addon registry update](vela_addon_registry_update) - Update an addon registry
* [vela addon registry get](vela_addon_registry_get) - Get an addon registry.
* [vela addon registry list](vela_addon_registry_list) - List addon registries.
* [vela addon registry update](vela_addon_registry_update) - Update an addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

14
docs/cli/vela_addon_registry_add.md
View File

@ -2,11 +2,11 @@
title: vela addon registry add
---
Add an addon registry
Add an addon registry.
### Synopsis
Add an addon registry
Add an addon registry.
```
vela addon registry add [flags]
@ -15,25 +15,25 @@ vela addon registry add [flags]
### Examples
```
"vela addon registry add my-repo --type OSS --endpoint=xxxxx --bucket=xxxx or vela addon registry add my-repo --type git --endpoint=xxxxx --path=xxxx --gitToken=xxx"
"vela addon registry add <my-registry-name> --type OSS --endpoint=<URL> --bucket=<bukect-name> or vela addon registry add my-repo --type git --endpoint=<URL> --path=<OSS-ptah> --gitToken=<git token>"
```
### Options
```
--bucket string specify the OSS bucket
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
-h, --help help for add
--path string specify the repo path
--path string specify the addon registry OSS path
--type string specify the addon registry type
```
### SEE ALSO
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon registry](vela_addon_registry) - Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_addon_registry_delete.md
View File

@ -15,7 +15,7 @@ vela addon registry delete [flags]
### Examples
```
vela addon registry delete my-repo
vela addon registry delete <registry-name>
```
### Options
@ -26,9 +26,9 @@ vela addon registry delete my-repo
### SEE ALSO
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon registry](vela_addon_registry) - Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

10
docs/cli/vela_addon_registry_get.md
View File

@ -2,11 +2,11 @@
title: vela addon registry get
---
Get an addon registry
Get an addon registry.
### Synopsis
Get an addon registry
Get an addon registry.
```
vela addon registry get [flags]
@ -15,7 +15,7 @@ vela addon registry get [flags]
### Examples
```
vela addon registry get my-repo
vela addon registry get <registry name>
```
### Options
@ -26,9 +26,9 @@ vela addon registry get my-repo
### SEE ALSO
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon registry](vela_addon_registry) - Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_addon_registry_list.md
View File

@ -2,11 +2,11 @@
title: vela addon registry list
---
List addon registries
List addon registries.
### Synopsis
List addon registries
List addon registries.
```
vela addon registry list [flags]
@ -26,9 +26,9 @@ vela addon registry list
### SEE ALSO
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon registry](vela_addon_registry) - Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

14
docs/cli/vela_addon_registry_update.md
View File

@ -2,11 +2,11 @@
title: vela addon registry update
---
Update an addon registry
Update an addon registry.
### Synopsis
Update an addon registry
Update an addon registry.
```
vela addon registry update [flags]
@ -15,25 +15,25 @@ vela addon registry update [flags]
### Examples
```
vela addon registry update my-repo --type OSS --endpoint=xxxxx --bucket=xxxx
vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=<bucket name>
```
### Options
```
--bucket string specify the OSS bucket
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
-h, --help help for update
--path string specify the repo path
--path string specify the addon registry OSS path
--type string specify the addon registry type
```
### SEE ALSO
* [vela addon registry](vela_addon_registry) - Manage addon registry
* [vela addon registry](vela_addon_registry) - Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_addon_status.md
View File

@ -2,11 +2,11 @@
title: vela addon status
---
get an addon's status
get an addon's status.
### Synopsis
get an addon's status from cluster
get an addon's status from cluster.
```
vela addon status [flags]
@ -31,4 +31,4 @@ vela addon status <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_addon_upgrade.md
View File

@ -6,7 +6,7 @@ upgrade an addon
### Synopsis
upgrade an addon in cluster
upgrade an addon in cluster.
```
vela addon upgrade [flags]
@ -31,4 +31,4 @@ vela addon upgrade <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

10
docs/cli/vela_cluster.md
View File

@ -17,13 +17,13 @@ Manage Kubernetes Clusters for Continuous Delivery.
### SEE ALSO
* [vela cluster detach](vela_cluster_detach) - detach managed cluster
* [vela cluster join](vela_cluster_join) - join managed cluster
* [vela cluster detach](vela_cluster_detach) - detach managed cluster.
* [vela cluster join](vela_cluster_join) - join managed cluster.
* [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster probe](vela_cluster_probe) - probe managed cluster
* [vela cluster rename](vela_cluster_rename) - rename managed cluster
* [vela cluster probe](vela_cluster_probe) - health probe managed cluster.
* [vela cluster rename](vela_cluster_rename) - rename managed cluster.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_cluster_detach.md
View File

@ -2,7 +2,11 @@
title: vela cluster detach
---
detach managed cluster
detach managed cluster.
### Synopsis
detach managed cluster.
```
vela cluster detach [CLUSTER_NAME] [flags]
@ -22,4 +26,4 @@ vela cluster detach [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_cluster_join.md
View File

@ -2,11 +2,11 @@
title: vela cluster join
---
join managed cluster
join managed cluster.
### Synopsis
join managed cluster by kubeconfig
join managed cluster by kubeconfig.
```
vela cluster join [KUBECONFIG] [flags]
@ -36,4 +36,4 @@ vela cluster join [KUBECONFIG] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_cluster_list.md
View File

@ -6,7 +6,7 @@ list managed clusters
### Synopsis
list child clusters managed by KubeVela
list worker clusters managed by KubeVela.
```
vela cluster list [flags]
@ -25,4 +25,4 @@ vela cluster list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_cluster_probe.md
View File

@ -2,7 +2,11 @@
title: vela cluster probe
---
probe managed cluster
health probe managed cluster.
### Synopsis
health probe managed cluster.
```
vela cluster probe [CLUSTER_NAME] [flags]
@ -21,4 +25,4 @@ vela cluster probe [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_cluster_rename.md
View File

@ -2,7 +2,11 @@
title: vela cluster rename
---
rename managed cluster
rename managed cluster.
### Synopsis
rename managed cluster.
```
vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
@ -21,4 +25,4 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_completion.md
View File

@ -24,4 +24,4 @@ The shell code must be evaluated to provide interactive completion of vela comma
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_completion_bash.md
View File

@ -35,4 +35,4 @@ vela completion bash
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_completion_zsh.md
View File

@ -32,4 +32,4 @@ vela completion zsh
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_component.md
View File

@ -37,4 +37,4 @@ vela comp
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_component_get.md
View File

@ -6,7 +6,7 @@ get component from registry
### Synopsis
get component from registry
get/download/install component from registry.
```
vela component get <component> [flags]
@ -39,4 +39,4 @@ vela comp get <component>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

34
docs/cli/vela_cue-packages.md
View File

@ -1,34 +0,0 @@
---
title: vela cue-packages
---
List cue package
### Synopsis
List cue package
```
vela cue-packages
```
### Examples
```
vela cue-packages
```
### Options
```
-h, --help help for cue-packages
```
### SEE ALSO
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

15
docs/cli/vela_def.md
View File

@ -17,16 +17,17 @@ Manage X-Definitions for extension.
### SEE ALSO
* [vela def apply](vela_def_apply) - Apply definition
* [vela def del](vela_def_del) - Delete definition
* [vela def edit](vela_def_edit) - Edit definition
* [vela def apply](vela_def_apply) - Apply X-Definition.
* [vela def del](vela_def_del) - Delete X-Definition.
* [vela def doc-gen](vela_def_doc-gen) - Generate documentation of definitions (Only Terraform typed definitions are supported)
* [vela def edit](vela_def_edit) - Edit X-Definition.
* [vela def get](vela_def_get) - Get definition
* [vela def init](vela_def_init) - Init a new definition
* [vela def list](vela_def_list) - List definitions
* [vela def render](vela_def_render) - Render definition
* [vela def vet](vela_def_vet) - Validate definition
* [vela def list](vela_def_list) - List definitions.
* [vela def render](vela_def_render) - Render X-Definition.
* [vela def vet](vela_def_vet) - Validate X-Definition.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_def_apply.md
View File

@ -2,11 +2,11 @@
title: vela def apply
---
Apply definition
Apply X-Definition.
### Synopsis
Apply definition from local storage to kubernetes cluster. It will apply file to vela-system namespace by default.
Apply X-Definition from local storage to kubernetes cluster. It will apply file to vela-system namespace by default.
```
vela def apply DEFINITION.cue [flags]
@ -37,4 +37,4 @@ vela def apply DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_def_del.md
View File

@ -2,11 +2,11 @@
title: vela def del
---
Delete definition
Delete X-Definition.
### Synopsis
Delete definition in kubernetes cluster.
Delete X-Definition in kubernetes cluster.
```
vela def del DEFINITION_NAME [flags]
@ -24,7 +24,7 @@ vela def del DEFINITION_NAME [flags]
```
-h, --help help for del
-n, --namespace string Specify which namespace the definition locates.
-t, --type string Specify the definition type of target. Valid types: trait, policy, workload, scope, workflow-step, component
-t, --type string Specify the definition type of target. Valid types: workload, scope, workflow-step, component, trait, policy
```
### SEE ALSO
@ -34,4 +34,4 @@ vela def del DEFINITION_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

37
docs/cli/vela_def_doc-gen.md Normal file
View File

@ -0,0 +1,37 @@
---
title: vela def doc-gen
---
Generate documentation of definitions (Only Terraform typed definitions are supported)
### Synopsis
Generate documentation of definitions
```
vela def doc-gen NAME [flags]
```
### Examples
```
1. Generate documentation for ComponentDefinition alibaba-vpc:
> vela def doc-gen alibaba-vpc -n vela-system
```
### Options
```
-h, --help help for doc-gen
-n, --namespace string Specify the namespace of the definition.
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_def_edit.md
View File

@ -2,11 +2,11 @@
title: vela def edit
---
Edit definition
Edit X-Definition.
### Synopsis
Edit definition in kubernetes. If type and namespace are not specified, the command will automatically search all possible results.
Edit X-Definition in kubernetes. If type and namespace are not specified, the command will automatically search all possible results.
By default, this command will use the vi editor and can be altered by setting EDITOR environment variable.
```
@ -27,7 +27,7 @@ vela def edit NAME [flags]
```
-h, --help help for edit
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workload, scope, workflow-step, component, trait, policy
```
### SEE ALSO
@ -37,4 +37,4 @@ vela def edit NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_def_get.md
View File

@ -26,7 +26,7 @@ vela def get NAME [flags]
```
-h, --help help for get
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload, scope
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
```
### SEE ALSO
@ -36,4 +36,4 @@ vela def get NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

13
docs/cli/vela_def_init.md
View File

@ -7,7 +7,9 @@ Init a new definition
### Synopsis
Init a new definition with given arguments or interactively
* We support parsing a single YAML file (like kubernetes objects) into the cue-style template. However, we do not support variables in YAML file currently, which prevents users from directly feeding files like helm chart directly. We may introduce such features in the future.
* We support parsing a single YAML file (like kubernetes objects) into the cue-style template.
However, we do not support variables in YAML file currently, which prevents users from directly feeding files like helm chart directly.
We may introduce such features in the future.
```
vela def init DEF_NAME [flags]
@ -22,17 +24,22 @@ vela def init DEF_NAME [flags]
> vela def init my-def -i --output ./my-def.cue
# Command below initiate a ComponentDefinition named my-webservice with the template parsed from ./template.yaml.
> vela def init my-webservice -i --template-yaml ./template.yaml
# Command below initiate a typed ComponentDefinition named vswitch from Alibaba Cloud.
> vela def init vswitch --type component --provider alibaba --desc xxx --git https://github.com/kubevela-contrib/terraform-modules.git --path alibaba/vswitch
```
### Options
```
-d, --desc string Specify the description of the new definition.
--git string Specify which git repository the configuration(HCL) is stored in. Valid when --provider/-p is set.
-h, --help help for init
-i, --interactive Specify whether use interactive process to help generate definitions.
-o, --output string Specify the output path of the generated definition. If empty, the definition will be printed in the console.
--path string Specify which path the configuration(HCL) is stored in the Git repository. Valid when --git is set.
-p, --provider alibaba Specify which provider the cloud resource definition belongs to. Only alibaba, `aws`, `azure` are supported.
-y, --template-yaml string Specify the template yaml file that definition will use to build the schema. If empty, a default template for the given definition type will be used.
-t, --type string Specify the type of the new definition. Valid types: workflow-step, component, trait, policy, workload, scope
-t, --type string Specify the type of the new definition. Valid types: scope, workflow-step, component, trait, policy, workload
```
### SEE ALSO
@ -42,4 +49,4 @@ vela def init DEF_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_def_list.md
View File

@ -2,11 +2,11 @@
title: vela def list
---
List definitions
List definitions.
### Synopsis
List definitions in kubernetes cluster
List definitions in kubernetes cluster.
```
vela def list [flags]
@ -26,7 +26,7 @@ vela def list [flags]
```
-h, --help help for list
-n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: scope, workflow-step, component, trait, policy, workload
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step
```
### SEE ALSO
@ -36,4 +36,4 @@ vela def list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_def_render.md
View File

@ -2,11 +2,11 @@
title: vela def render
---
Render definition
Render X-Definition.
### Synopsis
Render definition with cue format into kubernetes YAML format. Could be used to check whether the cue format definition is working as expected. If a directory is used as input, all cue definitions in the directory will be rendered.
Render X-Definition with cue format into kubernetes YAML format. Could be used to check whether the cue format definition is working as expected. If a directory is used as input, all cue definitions in the directory will be rendered.
```
vela def render DEFINITION.cue [flags]
@ -37,4 +37,4 @@ vela def render DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_def_vet.md
View File

@ -2,7 +2,7 @@
title: vela def vet
---
Validate definition
Validate X-Definition.
### Synopsis
@ -33,4 +33,4 @@ vela def vet DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_delete.md
View File

@ -36,4 +36,4 @@ vela delete frontend
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_dry-run.md
View File

@ -35,4 +35,4 @@ vela dry-run
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_env.md
View File

@ -17,12 +17,12 @@ Manage environments for vela applications to run.
### SEE ALSO
* [vela env delete](vela_env_delete) - Delete an environment
* [vela env delete](vela_env_delete) - Delete an environment.
* [vela env init](vela_env_init) - Create environment for vela applications to run.
* [vela env ls](vela_env_ls) - List environments for vela applications to run.
* [vela env set](vela_env_set) - Set an environment
* [vela env set](vela_env_set) - Set an environment.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_env_delete.md
View File

@ -2,7 +2,7 @@
title: vela env delete
---
Delete an environment
Delete an environment.
### Synopsis
@ -31,4 +31,4 @@ vela env delete test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_env_init.md
View File

@ -32,4 +32,4 @@ vela env init test --namespace test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_env_ls.md
View File

@ -31,4 +31,4 @@ vela env ls [env-name]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_env_set.md
View File

@ -2,7 +2,7 @@
title: vela env set
---
Set an environment
Set an environment.
### Synopsis
@ -31,4 +31,4 @@ vela env set test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_exec.md
View File

@ -43,4 +43,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_export.md
View File

@ -28,4 +28,4 @@ vela export
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_help.md
View File

@ -21,4 +21,4 @@ vela help [command]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_init.md
View File

@ -2,7 +2,7 @@
title: vela init
---
Create scaffold for an application
Create scaffold for an application.
### Synopsis
@ -34,4 +34,4 @@ vela init
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_live-diff.md
View File

@ -37,4 +37,4 @@ vela live-diff -f app-v2.yaml -r app-v1 --context 10
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_logs.md
View File

@ -2,7 +2,7 @@
title: vela logs
---
Tail logs for application in multicluster
Tail logs for application.
### Synopsis
@ -28,4 +28,4 @@ vela logs APP_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_ls.md
View File

@ -33,4 +33,4 @@ vela ls
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_port-forward.md
View File

@ -2,7 +2,7 @@
title: vela port-forward
---
Forward local ports to container/service port of vela application
Forward local ports to container/service port of vela application.
### Synopsis
@ -36,4 +36,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_registry.md
View File

@ -24,4 +24,4 @@ Manage Registry of X-Definitions for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_registry_config.md
View File

@ -32,4 +32,4 @@ vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_registry_ls.md
View File

@ -31,4 +31,4 @@ vela registry ls
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_registry_remove.md
View File

@ -31,4 +31,4 @@ vela registry remove mycenter
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_show.md
View File

@ -2,7 +2,7 @@
title: vela show
---
Show the reference doc for a component type or trait
Show the reference doc for a component type or trait.
### Synopsis
@ -34,4 +34,4 @@ show webservice
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_status.md
View File

@ -2,7 +2,7 @@
title: vela status
---
Show status of an application
Show status of an application.
### Synopsis
@ -35,4 +35,4 @@ vela status APP_NAME
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

25
docs/cli/vela_system.md
View File

@ -1,25 +0,0 @@
---
title: vela system
---
System management utilities
### Synopsis
System management utilities
### Options
```
-h, --help help for system
```
### SEE ALSO
* [vela system info](vela_system_info) - Show vela client and cluster chartPath
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

28
docs/cli/vela_system_info.md
View File

@ -1,28 +0,0 @@
---
title: vela system info
---
Show vela client and cluster chartPath
### Synopsis
Show vela client and cluster chartPath
```
vela system info [flags]
```
### Options
```
-h, --help help for info
```
### SEE ALSO
* [vela system](vela_system) - System management utilities
##### Back to [CLI Command Homepage](vela)
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_trait.md
View File

@ -2,7 +2,7 @@
title: vela trait
---
List/get traits
List/get traits.
### Synopsis
@ -37,4 +37,4 @@ vela trait
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
docs/cli/vela_trait_get.md
View File

@ -34,9 +34,9 @@ vela trait get <trait>
### SEE ALSO
* [vela trait](vela_trait) - List/get traits
* [vela trait](vela_trait) - List/get traits.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_uischema.md
View File

@ -22,4 +22,4 @@ Manage UI schema for addons.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
docs/cli/vela_uischema_apply.md
View File

@ -25,4 +25,4 @@ vela uischema apply [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_up.md
View File

@ -6,7 +6,7 @@ Apply an appfile or application from file
### Synopsis
Create or update vela application from file, both appfile or application object format are supported.
Create or update vela application from file or URL, both appfile or application object format are supported.
```
vela up
@ -16,7 +16,7 @@ vela up
```
-e, --env string specify environment name for application
-f, --file string specify file path for appfile or application
-f, --file string specify file path for appfile or application, it could be a remote url.
-h, --help help for up
-n, --namespace string specify the Kubernetes namespace to use
```
@ -28,4 +28,4 @@ vela up
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
docs/cli/vela_version.md
View File

@ -2,11 +2,11 @@
title: vela version
---
Prints out build version information
Prints vela build version information
### Synopsis
Prints out build version information.
Prints vela build version information.
```
vela version [flags]
@ -25,4 +25,4 @@ vela version [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

14
docs/cli/vela_workflow.md
View File

@ -2,7 +2,7 @@
title: vela workflow
---
Operate application delivery workflow
Operate application delivery workflow.
### Synopsis
@ -17,13 +17,13 @@ Operate the Workflow during Application Delivery.
### SEE ALSO
* [vela workflow restart](vela_workflow_restart) - Restart an application workflow
* [vela workflow resume](vela_workflow_resume) - Resume a suspend application workflow
* [vela workflow rollback](vela_workflow_rollback) - Rollback an application workflow to the latest revision
* [vela workflow suspend](vela_workflow_suspend) - Suspend an application workflow
* [vela workflow terminate](vela_workflow_terminate) - Terminate an application workflow
* [vela workflow restart](vela_workflow_restart) - Restart an application workflow.
* [vela workflow resume](vela_workflow_resume) - Resume a suspend application workflow.
* [vela workflow rollback](vela_workflow_rollback) - Rollback an application workflow to the latest revision.
* [vela workflow suspend](vela_workflow_suspend) - Suspend an application workflow.
* [vela workflow terminate](vela_workflow_terminate) - Terminate an application workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_workflow_restart.md
View File

@ -2,11 +2,11 @@
title: vela workflow restart
---
Restart an application workflow
Restart an application workflow.
### Synopsis
Restart an application workflow in cluster
Restart an application workflow in cluster.
```
vela workflow restart [flags]
@ -28,9 +28,9 @@ vela workflow restart <application-name>
### SEE ALSO
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela workflow](vela_workflow) - Operate application delivery workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_workflow_resume.md
View File

@ -2,11 +2,11 @@
title: vela workflow resume
---
Resume a suspend application workflow
Resume a suspend application workflow.
### Synopsis
Resume a suspend application workflow in cluster
Resume a suspend application workflow in cluster.
```
vela workflow resume [flags]
@ -28,9 +28,9 @@ vela workflow resume <application-name>
### SEE ALSO
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela workflow](vela_workflow) - Operate application delivery workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_workflow_rollback.md
View File

@ -2,11 +2,11 @@
title: vela workflow rollback
---
Rollback an application workflow to the latest revision
Rollback an application workflow to the latest revision.
### Synopsis
Rollback an application workflow to the latest revision
Rollback an application workflow to the latest revision.
```
vela workflow rollback [flags]
@ -28,9 +28,9 @@ vela workflow rollback <application-name>
### SEE ALSO
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela workflow](vela_workflow) - Operate application delivery workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_workflow_suspend.md
View File

@ -2,11 +2,11 @@
title: vela workflow suspend
---
Suspend an application workflow
Suspend an application workflow.
### Synopsis
Suspend an application workflow in cluster
Suspend an application workflow in cluster.
```
vela workflow suspend [flags]
@ -28,9 +28,9 @@ vela workflow suspend <application-name>
### SEE ALSO
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela workflow](vela_workflow) - Operate application delivery workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

8
docs/cli/vela_workflow_terminate.md
View File

@ -2,11 +2,11 @@
title: vela workflow terminate
---
Terminate an application workflow
Terminate an application workflow.
### Synopsis
Terminate an application workflow in cluster
Terminate an application workflow in cluster.
```
vela workflow terminate [flags]
@ -28,9 +28,9 @@ vela workflow terminate <application-name>
### SEE ALSO
* [vela workflow](vela_workflow) - Operate application delivery workflow
* [vela workflow](vela_workflow) - Operate application delivery workflow.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 10-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).
###### Auto generated by spf13/cobra on 12-Jan-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

110
docs/deliver-app/gateway.md
View File

@ -1,110 +0,0 @@
---
title: Ingress
---
The `ingress` trait exposes a component to public Internet via a valid domain.
## Specification
```shell
kubectl vela show ingress
```
```console
# Properties
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| http | Specify the mapping relationship between the http path and the workload port | map[string]int | true | |
| domain | Specify the domain you want to expose | string | true | |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
```
## How to use
Attach a `ingress` trait to the component you want to expose and deploy.
```yaml
# vela-app.yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-app
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
"/": 8000
```
```bash
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela-app.yaml
```
```console
application.core.oam.dev/first-vela-app created
```
Check the status until we see `status` is `running` and services are `healthy`:
```bash
kubectl get application first-vela-app -w
```
```console
NAME COMPONENT TYPE PHASE HEALTHY STATUS AGE
first-vela-app express-server webservice healthChecking 14s
first-vela-app express-server webservice running true 42s
```
Check the trait detail for the its visiting url:
```shell
kubectl get application first-vela-app -o yaml
```
```console
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-app
namespace: default
spec:
...
services:
- healthy: true
name: express-server
traits:
- healthy: true
message: 'Visiting URL: testsvc.example.com, IP: <your ip address>'
type: ingress
status: running
...
```
Then you will be able to visit this application via its domain.
```
curl -H "Host:testsvc.example.com" http://<your ip address>/
```
```console
<xmp>
Hello World
## .
## ## ## ==
## ## ## ## ## ===
/""""""""""""""""\___/ ===
~~~ {~~ ~~~~ ~~~ ~~~~ ~~ ~ / ===- ~~~
\______ o _,/
\ \ _,'
`'--.._\..--''
</xmp>
```
> ⚠️ This section requires your runtime cluster has a working ingress controller.

10
docs/deliver-app/k8s-object.mdx
View File

@ -1,12 +1,12 @@
---
title: Deploy Kubernetes Raw Resource
title: Deploy Kubernetes Objects
---
This section introduces that how you can deploy Kubernetes raw resources into multi environments and clusters.
This section introduces that how you can deploy Kubernetes objects into multi environments and clusters.
KubeVela supports you to render, orchestrate and deploy Kubernetes raw resources. The common usage type is Deployment+Service. Using customized Workflow, you can deploy an application into multi-cluster in sequence. Hence you'll get to know:
KubeVela supports you to render, orchestrate and deploy Kubernetes objects. The common usage type is Deployment+Service. Using customized Workflow, you can deploy an application into multi-cluster in sequence. Hence you'll get to know:
1. Deploy Kubernetes raw resources.
1. Deploy Kubernetes objects.
2. Workflow and its usage.
3. Multi-env/cluster in application delivery.
4. The control loop of application deployment: Rollback, Terminate and Continue.
@ -85,7 +85,7 @@ If continued, the deployment goes on. In the list of instances, you can check ou
![](../resources/multiple-target-pods.jpg)
Congrats! Now you've learned how to deploy Kubernetes raw resources.
Congrats! Now you've learned how to deploy Kubernetes objects.
<!-- ## Video tutorial TODO v1.2 -->

2
docs/deliver-app/workflows.md
View File

@ -5,7 +5,7 @@ description: This article introduces the usage of Workflow and gives you a full
This section introduces the usage of Workflow and gives you a full picture of it.
In the section of [Deploy Kubernetes Raw Resources](./k8s-object), we first learned the usage of workflow, that is, manual approval in the process of multi-cluster publishing. Now we continue to introduce the following topics:
In the section of [Deploy Kubernetes Objects](./k8s-object), we first learned the usage of workflow, that is, manual approval in the process of multi-cluster publishing. Now we continue to introduce the following topics:
1. Learn more about Workflow, Revision, and Environment, as well as all the built-in Workflow steps.
2. Implement notifications in the workflow.

2
docs/developers/references/devex/faq.md
View File

@ -69,7 +69,7 @@ TYPE CATEGORY DESCRIPTION
And manually apply all WorkloadDefinition and TraitDefinition manifests to have all capabilities back.
```
kubectl apply -f charts/vela-core/templates/defwithtemplate
vela up -f charts/vela-core/templates/defwithtemplate
```
```console
traitdefinition.core.oam.dev/autoscale created

292
docs/end-user/binding-traits.md
View File

@ -1,292 +0,0 @@
---
title: Binding Traits
---
Traits is also one of the core concepts of the application. It acts on the component level and allows you to freely bind various operation and maintenance actions and strategies to the component. For example, configuration gateway, label management and container injection (Sidecar) at the business level, or flexible scaler at the admin level, gray release, etc.
Similar to Component, KubeVela provides a series of out-of-the-box traits, and also allows you to customize and extend other operation and maintenance capabilities with traits.
## KubeVela's Trait
```
$ vela traits
NAME NAMESPACE APPLIES-TO CONFLICTS-WITH POD-DISRUPTIVE DESCRIPTION
annotations vela-system * true Add annotations on K8s pod for your workload which follows
the pod spec in path 'spec.template'.
configmap vela-system * true Create/Attach configmaps on K8s pod for your workload which
follows the pod spec in path 'spec.template'.
env vela-system * false add env on K8s pod for your workload which follows the pod
spec in path 'spec.template.'
ingress vela-system false Enable public web traffic for the component.
ingress-1-20 vela-system false Enable public web traffic for the component, the ingress API
matches K8s v1.20+.
labels vela-system * true Add labels on K8s pod for your workload which follows the
pod spec in path 'spec.template'.
lifecycle vela-system * true Add lifecycle hooks for the first container of K8s pod for
your workload which follows the pod spec in path
'spec.template'.
rollout vela-system false rollout the component
sidecar vela-system * true Inject a sidecar container to K8s pod for your workload
which follows the pod spec in path 'spec.template'.
...
```
Below, we will take a few typical traits as examples to introduce the usage of KubeVela Trait.
## Use Ingress to Configure the Gateway
We will configure a gateway for a Web Service component as an example. This component is pulled from the `crccheck/hello-world` image. After setting the gateway, it provides external access through `testsvc.example.com` plus port 8000.
Please directly copy the following Shell code, which will be applied to the cluster:
```shell
cat <<EOF | kubectl apply -f -
# YAML begins
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: ingress-app
spec:
components:
- name: express-server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
properties:
domain: testsvc.example.com
http:
"/": 8000
# YAML ends
EOF
```
You can also save the YAML file as ingerss-app.yaml and use the `kubectl apply -f ingerss-app.yaml` command to deploy.
When we see that the status of the application is running and the service is healthy through `vela ls`, it means that the application is fully effective. At the same time, its TRAITS type is also correctly displayed as ingress.
```shell
$ vela ls
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
ingerss-app express-server webservice ingress running healthy 2021-08-28 21:49:44 +0800 CST
```
If the status is displayed as rendering, it means that it is still being rendered, or HEALTHY is always false, you need to use `kubectl get application ingress-app -o yaml` to view the error message in the return.
View the information returned:
```shell
$ kubectl get application ingress-app -o yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
... # Omit non-critical information
spec:
... # Omit non-critical information
status:
... # Omit non-critical information
services:
- healthy: true
name: express-server
traits:
- healthy: true
message: |
No loadBalancer found, visiting by using 'vela port-forward ingress-app'
type: ingress
workloadDefinition:
apiVersion: apps/v1
kind: Deployment
status: running
```
Then, it is forwarded to the local processing request through vela port-forward ingress-app:
```shell
vela port-forward ingress-app
Forwarding from 127.0.0.1:8000 -> 8000
Forwarding from [::1]:8000 -> 8000
Forward successfully! Opening browser ...
Handling connection for 8000
```
Access service:
```shell
curl -H "Host:testsvc.example.com" http://127.0.0.1:8000/
Hello World
## .
## ## ## ==
## ## ## ## ## ===
/""""""""""""""""\___/ ===
~~~ {~~ ~~~~ ~~~ ~~~~ ~~ ~ / ===- ~~~
\______ o _,/
\ \ _,'
`'--.._\..--''
```
## Attach Labels and Annotations to Component
Labels and Annotations Trait allow you to attach labels and annotations to components, allowing us to trigger the marked components and obtain annotation information on demand when implementing business logic.
First, we prepare an example of an application, please copy and execute it directly:
```shell
cat <<EOF | kubectl apply -f -
# YAML begins
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: labels-annotations
spec:
components:
- name: server
type: webservice
properties:
image: crccheck/hello-world
port: 8000
traits:
- type: labels
properties:
"release": "stable"
- type: annotations
properties:
"description": "web application"
# YAML ends
EOF
```
In the above business, we define the component named `server`, specify it for stable release through labels, and annotate it to be a business for web applications through annotations.
On the runtime cluster, use the `vela ls` command to check whether the application has been successfully created:
```shell
$ vela ls
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
labels-annotations server webservice labels,annotations running healthy 2021-08-29 20:55:28 +0800 CST
```
Through Kubernetes commands, we can see that the underlying resources have been labeled accordingly:
```
$ kubectl get deployments server -o jsonpath='{.spec.template.metadata.labels}'
{"app.oam.dev/component":"server","release":"stable"}
$ kubectl get deployments server -o jsonpath='{.spec.template.metadata.annotations}'
{"app.oam.dev/component":"server","release":"stable"}
```
## Inject the Container Into the Component (Sidecar)
As the existence of sidecar container decoupling from business container, it can help us with many auxiliary important tasks, such as common log proxy, used to implement Service Mesh, and so on.
Let's write a `log-gen-worker` component in an application. At the same time, we point the log data directory recorded by the sidecar and the component to the same data storage volume `varlog`.
```shell
cat <<EOF | kubectl apply -f -
# YAML begins
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: vela-app-with-sidecar
spec:
components:
- name: log-gen-worker
type: worker
properties:
image: busybox
cmd:
- /bin/sh
- -c
- >
i=0;
while true;
do
echo "$i: $(date)" >> /var/log/date.log;
i=$((i+1));
sleep 1;
done
volumes:
- name: varlog
mountPath: /var/log
type: emptyDir
traits:
- type: sidecar
properties:
name: count-log
image: busybox
cmd: [ /bin/sh, -c, 'tail -n+1 -f /var/log/date.log']
volumes:
- name: varlog
path: /var/log
# YAML ends
EOF
```
Use `vela ls` to check whether the application is successfully deployed:
```shell
$ vela ls
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
vela-app-with-sidecar log-gen-worker worker sidecar running healthy 2021-08-29 22:07:07 +0800 CST
```
After success, first to look out the workload generated by the application:
```
$ kubectl get pods -l app.oam.dev/component=log-gen-worker
NAME READY STATUS RESTARTS AGE
log-gen-worker-7bb65dcdd6-tpbdh 2/2 Running 0 45s
```
Finally, check the log output by the sidecar, you can see that the sidecar that reads the log has taken effect.
```
kubectl logs -f log-gen-worker-7bb65dcdd6-tpbdh count-log
```
Above, we took several common traits as examples to introduce how to bind traits. For more trait's functions and parameters, please go to built-in Trait view.
## Custom Trait
When the built-in Trait cannot meet your needs, you can freely customize the maintenance capabilities. Please refer to [Custom Trait](../platform-engineers/traits/customize-trait) in the Admin Guide for implementation.
## Next
- [Integrated Cloud Services](./components/cloud-services/provider-and-consume-cloud-services), learn how to integrate cloud services from various cloud vendors
- [Rollout & Scaler](./rollout-scaler)

13
docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md
View File

@ -1,5 +1,5 @@
---
title: Provision and Binding
title: Provision and Binding Cloud Resources
---
Cloud-oriented development is now becoming the norm, there is an urgent need to integrate cloud resources from different
@ -91,7 +91,7 @@ spec:
type: webservice
properties:
image: zzxwill/flask-web-application:v0.3.1-crossplane
ports: 80
port: 80
traits:
- type: service-binding
properties:
@ -142,12 +142,11 @@ webapp express-server webservice service-binding running healthy
```
```shell
$ sudo kubectl port-forward deployment/express-server 80:80
$ vela port-forward webapp
Forwarding from 127.0.0.1:8080 -> 80
Forwarding from [::1]:8080 -> 80
Forwarding from 127.0.0.1:80 -> 80
Forwarding from [::1]:80 -> 80
Handling connection for 80
Handling connection for 80
Forward successfully! Opening browser ...
```
![](../../../resources/crossplane-visit-application-v3.jpg)

106
docs/end-user/components/cue/raw.md
View File

@ -1,11 +1,13 @@
---
title: Raw Template
title: Kubernetes Objects
---
Use raw Kubernetes resources directly. For example, a Job.
Use raw Kubernetes resources directly.
## How to use
For example, a Job:
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
@ -14,23 +16,93 @@ metadata:
spec:
components:
- name: myjob
type: raw
type: k8s-objects
properties:
apiVersion: batch/v1
kind: Job
metadata:
name: pi
spec:
template:
spec:
containers:
- name: pi
image: perl
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
backoffLimit: 4
objects:
- apiVersion: batch/v1
kind: Job
metadata:
name: pi
spec:
template:
spec:
containers:
- name: pi
image: perl
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
backoffLimit: 4
```
More than one resources, you should put your main workload in the first place, vela traits will only affect on the first object:
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-stateful-service
spec:
components:
- name: my-sts
type: k8s-objects
properties:
objects:
- apiVersion: apps/v1
kind: StatefulSet
metadata:
name: web
spec:
selector:
matchLabels:
app: nginx # has to match .spec.template.metadata.labels
serviceName: "nginx"
replicas: 3 # by default is 1
template:
metadata:
labels:
app: nginx # has to match .spec.selector.matchLabels
spec:
terminationGracePeriodSeconds: 10
containers:
- name: nginx
image: k8s.gcr.io/nginx-slim:0.8
ports:
- containerPort: 80
name: web
volumeMounts:
- name: www
mountPath: /usr/share/nginx/html
volumeClaimTemplates:
- metadata:
name: www
spec:
accessModes: [ "ReadWriteOnce" ]
storageClassName: "my-storage-class"
resources:
requests:
storage: 1Gi
- apiVersion: v1
kind: Service
metadata:
name: nginx
labels:
app: nginx
spec:
ports:
- port: 80
name: web
clusterIP: None
selector:
app: nginx
```
## Attributes
Just write the whole Kubernetes Resource in properties.
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|---------|-------------|-----------------------|----------|---------|
| objects | list objects of Kubernetes resource | [[]K8s-Object](#K8s-Object) | true | |
### K8s-Object
Just write the whole Kubernetes Resource in this property.

4
docs/end-user/components/cue/task.md
View File

@ -17,8 +17,8 @@ spec:
type: task
properties:
image: perl
count: 10
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
count: 10
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
```
## Attributes

69
docs/end-user/components/cue/webservice.md
View File

@ -5,8 +5,9 @@ title: Web Service
Service-oriented components are components that support external access to services with the container as the core, and their functions cover the needs of most of he microservice scenarios.
Please copy shell below and apply to the cluster:
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
# YAML begins
apiVersion: core.oam.dev/v1beta1
kind: Application
@ -27,50 +28,52 @@ spec:
# YAML ends
EOF
```
You can also save the YAML file as website.yaml and use the `kubectl apply -f website.yaml` command to deploy.
Next, check the deployment status of the application through `kubectl get application <application name> -o yaml`:
You can also save the YAML file as website.yaml and use the `vela up -f website.yaml` command to deploy.
Next, check the deployment status of the application through `vela status <application name>`:
```shell
$ kubectl get application website -o yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: website
... # Omit non-critical information
spec:
components:
- name: frontend
properties:
... # Omit non-critical information
type: webservice
status:
conditions:
- lastTransitionTime: "2021-08-28T10:26:47Z"
reason: Available
status: "True"
... # Omit non-critical information
type: HealthCheck
observedGeneration: 1
... # Omit non-critical information
services:
- healthy: true
name: frontend
workloadDefinition:
apiVersion: apps/v1
kind: Deployment
status: running
$ vela status website
About:
Name: website
Namespace: default
Created at: 2022-01-11 21:04:59 +0800 CST
Status: running
Workflow:
mode: DAG
finished: true
Suspend: false
Terminated: false
Steps
- id:2y4rv8479h
name:frontend
type:apply-component
phase:succeeded
message:
Services:
- Name: frontend Env:
Type: webservice
healthy Ready:1/1
```
When we see that the `status.services.healthy` field is true and the status is running, it means that the entire application is delivered successfully.
When we see that the `finished` field in Workflow is `true` and the Status is `running`, it means that the entire application is delivered successfully.
If status shows as rendering or healthy as false, it means that the application has either failed to deploy or is still being deployed. Please proceed according to the information returned in `kubectl get application <application name> -o yaml`.
You can also view through the CLI of vela, using the following command:
You can also view application list by using the following command:
```shell
$ vela ls
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
website frontend webservice running healthy 2021-08-28 18:26:47 +0800 CST
```
We also see that the PHASE of the app is running and the STATUS is healthy.
## Attributes

2
docs/end-user/components/helm.md
View File

@ -9,7 +9,7 @@ KubeVela's Helm component meets the needs of users to connect to Helm Chart. You
In this `Application`, we hope to deliver a component called redis-comp. It is a chart from the [bitnami](https://charts.bitnami.com/bitnami).
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:

2
docs/end-user/components/kustomize.md
View File

@ -23,7 +23,7 @@ secret/bucket-secret created
2. Deploy it:
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:

36
docs/end-user/components/more.md
View File

@ -2,37 +2,11 @@
title: Needs More？
---
## 1. Get from capability registry
## 1. Get more from [install addons](../../how-to/cli/addon/addon)
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
## 2. Extend KubeVela by yourself
### List
By default, the following command lists capabilities from [the default registry](https://registry.kubevela.net) maintained by KubeVela.
```shell
$ vela comp --discover
Listing component definition from registry: default
NAME REGISTRY DEFINITION STATUS
kustomize default autodetects.core.oam.dev installed
webserver default deployments.apps uninstalled
```
`--discover` means list components from registry
### Install
Then you can install a component like:
```shell
$ vela comp get webserver
Getting component definition from registry: default
Installing component: webserver
Successfully install component: webserver
```
## 2. Designed by yourself
* Read [how to edit definitions](../../platform-engineers/cue/definition-edit) to build your own capability from existing ones.
* Read [how to build definitions](../../platform-engineers/cue/definition-edit) to build your own capability from existing ones.
* [Build your own capability from scratch](../../platform-engineers/cue/advanced)
and learn more features about how to [define custom components](../../platform-engineers/components/custom-component).
and learn more features about how to [define custom components](../../platform-engineers/components/custom-component).
* [Build your own addons](../../platform-engineers/addon/intro).

2
docs/end-user/overview-end-user.md
View File

@ -1,5 +1,5 @@
---
title: 概述
title: Overview
---
Here are some workitems on the roadmap

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

@ -1,5 +1,5 @@
---
title: Multi-Environment Policy
title: Multi-Environment
---
This documentation will introduce how to use env-binding to automate multi-stage application rollout across multiple environments.
@ -100,7 +100,7 @@ We apply the Application `policy-demo` in the example.
> Before applying this example application, you need a namespace named `demo` in the current cluster and namespace `test` in both the current cluster and the staging cluster. You need namespace `prod` in cluster `cluster-prod` as well. You can create it by executing cmd `kubectl create ns <namespace>`.
```shell
kubectl apply -f app.yaml
vela up -f app.yaml
```
After the Application is created, a configured Application will be created under the `demo` namespace.

3
docs/end-user/policies/health.md
View File

@ -1,5 +1,5 @@
---
title: Health Check Policy
title: Health Check
---
This documentation will introduce how to use `health` policy to apply periodical
@ -11,6 +11,7 @@ After an application is deployed, users usually want to monitor or observe the
health condition of the running application as well as each components.
Health policy decouples health checking procedure from application workflow
execution.
It allows to set independent health inspection cycle, such as check every 30s.
That helps users to notice as soon as applications turn out unhealthy and
follow the diagnosis message to troubleshot.

4
docs/end-user/quick-start-cli.md
View File

@ -25,7 +25,7 @@ spec:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress-1-20
- type: gateway
properties:
domain: testsvc.example.com
http:
@ -35,7 +35,7 @@ spec:
Now deploy it to KubeVela:
```bash
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela-app.yaml
vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela-app.yaml
```
This command will deploy a web service component to target environment, which in our case is the Kubernetes cluster that KubeVela itself is installed.

18
docs/end-user/traits/autoscaler.md
View File

@ -2,15 +2,6 @@
title: AutoScaler
---
## Specification
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| ------- | ------------------------------------------------------------------------------- | ---- | -------- | ------- |
| min | Specify the minimal number of replicas to which the autoscaler can scale down | int | true | 1 |
| max | Specify the maximum number of of replicas to which the autoscaler can scale up | int | true | 10 |
| cpuUtil | Specify the average cpu utilization, for example, 50 means the CPU usage is 50% | int | true | 50 |
## How to use
```yaml
@ -32,3 +23,12 @@ spec:
max: 10
cpuPercent: 60
```
## Specification
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| ------- | ------------------------------------------------------------------------------- | ---- | -------- | ------- |
| min | Specify the minimal number of replicas to which the autoscaler can scale down | int | true | 1 |
| max | Specify the maximum number of of replicas to which the autoscaler can scale up | int | true | 10 |
| cpuUtil | Specify the average cpu utilization, for example, 50 means the CPU usage is 50% | int | true | 50 |

97
docs/end-user/traits/ingress.md
View File

@ -1,27 +1,12 @@
---
title: Ingress
title: Gateway for Public Access
---
The `ingress` trait exposes a component to public Internet via a valid domain.
## Specification
```shell
kubectl vela show ingress
```
```console
# Properties
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| http | Specify the mapping relationship between the http path and the workload port | map[string]int | true | |
| domain | Specify the domain you want to expose | string | true | |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
```
The `gateway` trait exposes a component to public Internet via a valid domain.
## How to use
Attach a `ingress` trait to the component you want to expose and deploy.
Attach a `gateway` trait to the component you want to expose and deploy.
```yaml
# vela-app.yaml
@ -37,7 +22,7 @@ spec:
image: crccheck/hello-world
port: 8000
traits:
- type: ingress
- type: gateway
properties:
domain: testsvc.example.com
http:
@ -45,45 +30,58 @@ spec:
```
```bash
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela-app.yaml
vela up -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/vela-app.yaml
```
```console
application.core.oam.dev/first-vela-app created
```
Check the status until we see `status` is `running` and services are `healthy`:
Check the status until we see `status` is `running`:
```bash
kubectl get application first-vela-app -w
vela status first-vela-app
```
```console
NAME COMPONENT TYPE PHASE HEALTHY STATUS AGE
first-vela-app express-server webservice healthChecking 14s
first-vela-app express-server webservice running true 42s
About:
Name: first-vela-app
Namespace: default
Created at: 2022-01-11 22:04:29 +0800 CST
Status: running
Workflow:
mode: DAG
finished: true
Suspend: false
Terminated: false
Steps
- id:gfgwqp6pqh
name:express-server
type:apply-component
phase:succeeded
message:
Services:
- Name: express-server Env:
Type: webservice
healthy Ready:1/1
Traits:
- ✅ gateway: Visiting URL: testsvc.example.com, IP: 1.5.1.1
```
Check the trait detail for the its visiting url:
You can also get the endpoint by:
```shell
kubectl get application first-vela-app -o yaml
vela status first-vela-app --endpoint
```
```console
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: first-vela-app
namespace: default
spec:
...
services:
- healthy: true
name: express-server
traits:
- healthy: true
message: 'Visiting URL: testsvc.example.com, IP: <your ip address>'
type: ingress
status: running
...
```
|--------------------------------|----------------------------+
| REF(KIND/NAMESPACE/NAME) | ENDPOINT |
|--------------------------------|----------------------------+
| Ingress/default/express-server | http://testsvc.example.com |
|--------------------------------|----------------------------+
```
Then you will be able to visit this application via its domain.
@ -107,4 +105,13 @@ Hello World
</xmp>
```
> ⚠️ This section requires your runtime cluster has a working ingress controller.
> ⚠️ This section requires your runtime cluster has a working ingress controller.
## Specification
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|--------|------------------------------------------------------------------------------|----------------|----------|---------|
| http | Specify the mapping relationship between the http path and the workload port | map[string]int | true | |
| class | Specify the class of ingress to use | string | true | nginx |
| domain | Specify the domain you want to expose | string | true | |

49
docs/end-user/traits/more.md
View File

@ -1,49 +1,12 @@
---
title: Needs More?
title: Needs More？
---
## 1. Get from capability registry
## 1. Get more from [install addons](../../how-to/cli/addon/addon)
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
## 2. Extend KubeVela by yourself
### List
By default, the following command lists capabilities from [the default registry](https://registry.kubevela.net) maintained by KubeVela.
```shell
$ vela trait --discover
Showing trait definition from registry: default
NAME REGISTRY DEFINITION APPLIES-TO STATUS
autoscale default autoscalers.standard.oam.dev [deployments.apps] uninstalled
crd-manual-scaler default manualscalertraits.core.oam.dev [deployments.apps] uninstalled
dynamic-sa default [deployments.apps] uninstalled
env default [deployments.apps] installed
expose default [] installed
hpa default [deployments.apps] uninstalled
init-container default [deployments.apps] installed
kautoscale default [deployments.apps] uninstalled
metrics default metricstraits.standard.oam.dev [deployments.apps jobs.batch] uninstalled
node-affinity default [deployments.apps] installed
rollout default canaries.flagger.app [deployments.apps] installed
route default routes.standard.oam.dev [deployments.apps] uninstalled
virtualgroup default [deployments.apps] uninstalled
```
`--discover` means list components from registry
### Install
Then you can install a trait like:
```shell
$ vela trait get init-container
Getting component definition from registry: default
Installing component: init-container
Successfully install trait: init-container
```
## 2. Designed by yourself
* Read [how to edit definitions](../../platform-engineers/cue/definition-edit) to build your own capability from existing ones.
* Read [how to build definitions](../../platform-engineers/cue/definition-edit) to build your own capability from existing ones.
* [Build your own capability from scratch](../../platform-engineers/cue/advanced)
and learn more features about how to [define custom traits](../../platform-engineers/traits/customize-trait).
and learn more features about how to [define custom components](../../platform-engineers/components/custom-component).
* [Build your own addons](../../platform-engineers/addon/intro).

67
docs/end-user/traits/rollout.md
View File

@ -2,7 +2,12 @@
title: Rollout
---
This chapter will introduce how to use Rollout Trait to perform a rolling update on Workload.
This section will introduce how to use Rollout Trait to perform a rolling update on Component.
The component supported for rollout is:
* [webservice](../components/cue/webservice)
* [worker](../components/cue/worker)
## How to
@ -12,7 +17,7 @@ Apply the Application YAML below which includes a webservice-type workload with
of component name to be express-server-v1.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -37,20 +42,40 @@ EOF
This Rollout Trait has target size of 5 and two rollout batches. The first batch has 2 replicas and second batch has 3. Only after all replicas in the first batch are ready, it will start to rollout the second batch.
Check the Application status whether the rollout is successful:
```shell
$ kubectl get app rollout-trait-test
NAME COMPONENT TYPE PHASE HEALTHY STATUS AGE
rollout-trait-test express-server webservice running true 2d20h
```
Check component revision
```shell
$ kubectl get controllerRevision -l controller.oam.dev/component=express-server
NAME CONTROLLER REVISION AGE
express-server-v1 application.core.oam.dev/rollout-trait-test 1 2d22h
vela status rollout-trait-test
About:
Name: rollout-trait-test
Namespace: default
Created at: 2022-01-12 20:29:50 +0800 CST
Status: running
Workflow:
mode: DAG
finished: true
Suspend: false
Terminated: false
Steps
- id:6pnibgonga
name:express-server
type:apply-component
phase:succeeded
message:
Services:
- Name: express-server Env:
Type: webservice
healthy Ready:5/5
Traits:
- ✅ rollout: rolloutSucceed
```
Check the status of Rollout Trait. The rollout is successful only if `ROLLING-STATE` equals `rolloutSucceed`, and all replicas are ready only if `BATCH-STATE` equals `batchReady`. `TARGET`, `UPGRADED` and `READY` indicates target size of replicas is 5, updated number of replicas is 5 and all 5 replicas are ready.
```shell
$ kubectl get rollout express-server
NAME TARGET UPGRADED READY BATCH-STATE ROLLING-STATE AGE
@ -58,6 +83,7 @@ express-server 5 5 5 batchReady rolloutSucceed 2d20
```
Check Workload Status (Underlying resource behind the workload is [deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/))
```shell
$ kubectl get deploy -l app.oam.dev/component=express-server
NAME READY UP-TO-DATE AVAILABLE AGE
@ -68,7 +94,7 @@ express-server-v1 5/5 5 5 2d20h
Apply the YAML below to modify the image of the container. It will generate a new ControllerRevision.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -90,9 +116,11 @@ spec:
- replicas: 3
EOF
```
This Rollout Trait represents the target size of replicas is 5 and update will be performed in 2 batches. The first batch will update 2 replicas and the second batch will update 3 replicas. Only 2 replicas in first batch will be updated by setting `batchPartition` to 0.
Check controllerRevision and there is a new controllerRevision express-server-v2.
```shell
$ kubectl get controllerRevision -l controller.oam.dev/component=express-server
NAME CONTROLLER REVISION AGE
@ -101,6 +129,7 @@ express-server-v2 application.core.oam.dev/rollout-trait-test 2 1m
```
Check the status of Rollout Trait after a while when first batch has been upgraded successfully. `TARGET`, `UPGREADED` and `READY` indicates the target size of replicas for this revision is 5, there are 2 replicas sucessfully upgraded and they are ready. batchReady means replicas in the first rolloutBatch are all ready, rollingInBatches means there are batches still yet to be upgraded.
```shell
$ kubectl get rollout express-server
NAME TARGET UPGRADED READY BATCH-STATE ROLLING-STATE AGE
@ -108,6 +137,7 @@ express-server 5 2 2 batchReady rollingInBatches 2d20
```
Check Workload status to verify, we can see there are 2 replicas of new Workload express-server-v2 have been upgraded and old version of Workload express-server-v1 still has 3 replicas.
```shell
$ kubectl get deploy -l app.oam.dev/component=express-server
NAME READY UP-TO-DATE AVAILABLE AGE
@ -116,8 +146,9 @@ express-server-v2 2/2 2 2 1m
```
Apply the YAML below without `batchPartition` field in Rollout Trait to upgrade all replicas to latest revision.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -158,7 +189,7 @@ express-server-v2 5/5 5 5 1m
Apply the YAML below to make controllerRevision roll back to express-server-v1 by assigning `targetRevision` field to express-server-v1 in Rollout Trait.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -199,7 +230,7 @@ express-server-v1 5/5 5 5 15s
Rollout Trait also be able to scale up a Workload, apply the YAML below to modify the `targetSize`, in order to increase the number of replicas from 5 to 7.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -235,7 +266,7 @@ express-server-v1 7/7 7 7 2m
Apply the YAML below to scale down the size of replicas from 7 to 3.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -285,7 +316,7 @@ cloneset vela-system clonesets.apps.kruise.io
Apply the YAML below to create an Application, this Application includes a Workload of type cloneset with a Rollout Trait.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
@ -337,7 +368,7 @@ stefanprodan/podinfo:4.0.3
Apply the YAML below to upgrade the image.
```shell
cat <<EOF | kubectl apply -f -
cat <<EOF | vela up -f -
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:

28
docs/end-user/traits/service-binding.md
View File

@ -4,20 +4,6 @@ title: Service Binding
Service binding trait will bind data from Kubernetes `Secret` to the application container's ENV.
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
envMappings | The mapping of environment variables to secret | map[string]#KeySecret | true |
#### KeySecret
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
| key | if key is empty, we will use envMappings key instead | string | false | |
| secret | Kubernetes secret name | string | true | |
## How to use
1. Prepare a Kubernetes Secret
@ -105,3 +91,17 @@ spec:
```
Deploy this YAML and the Secret `db-conn-example` will be binding into environment of workload.
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
envMappings | The mapping of environment variables to secret | map[string]#KeySecret | true |
#### KeySecret
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
| key | if key is empty, we will use envMappings key instead | string | false | |
| secret | Kubernetes secret name | string | true | |

69
docs/end-user/traits/sidecar.md
View File

@ -4,33 +4,6 @@ title: Attaching Sidecar
The `sidecar` trait allows you to attach a sidecar container to the component.
## Specification
```shell
kubectl vela show sidecar
```
```console
# Properties
+---------+-----------------------------------------+-----------------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+---------+-----------------------------------------+-----------------------+----------+---------+
| name | Specify the name of sidecar container | string | true | |
| cmd | Specify the commands run in the sidecar | []string | false | |
| image | Specify the image of sidecar container | string | true | |
| volumes | Specify the shared volume path | [[]volumes](#volumes) | false | |
+---------+-----------------------------------------+-----------------------+----------+---------+
## volumes
+-----------+-------------+--------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+-----------+-------------+--------+----------+---------+
| name | | string | true | |
| path | | string | true | |
+-----------+-------------+--------+----------+---------+
```
## How to use
In this Application, component `log-gen-worker` and sidecar share the data volume that saves the logs.
@ -77,23 +50,22 @@ spec:
Deploy this Application.
```shell
kubectl apply -f app.yaml
vela up -f app.yaml
```
On runtime cluster, check the name of running pod.
Use `vela ls` to check the application state:
```shell
kubectl get pod
```
```console
NAME READY STATUS RESTARTS AGE
log-gen-worker-76945f458b-k7n9k 2/2 Running 0 90s
$ vela ls
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
vela-app-with-sidecar log-gen-worker worker sidecar running healthy 2021-08-29 22:07:07 +0800 CST
```
And check the logging output of sidecar.
```shell
kubectl logs -f log-gen-worker-76945f458b-k7n9k count-log
vela logs vela-app-with-sidecar -c count-log
```
```console
0: Fri Apr 16 11:08:45 UTC 2021
@ -107,3 +79,30 @@ kubectl logs -f log-gen-worker-76945f458b-k7n9k count-log
8: Fri Apr 16 11:08:53 UTC 2021
9: Fri Apr 16 11:08:54 UTC 2021
```
## Specification
```shell
vela show sidecar
```
```console
# Properties
+---------+-----------------------------------------+-----------------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+---------+-----------------------------------------+-----------------------+----------+---------+
| name | Specify the name of sidecar container | string | true | |
| cmd | Specify the commands run in the sidecar | []string | false | |
| image | Specify the image of sidecar container | string | true | |
| volumes | Specify the shared volume path | [[]volumes](#volumes) | false | |
+---------+-----------------------------------------+-----------------------+----------+---------+
## volumes
+-----------+-------------+--------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+-----------+-------------+--------+----------+---------+
| name | | string | true | |
| path | | string | true | |
+-----------+-------------+--------+----------+---------+
```

41
docs/end-user/version-control.md
View File

@ -35,45 +35,6 @@ express-server-v2 application.core.oam.dev/myapp 2 2m12s
You can specify the component revision for [component rolling update](./traits/rollout).
## Specify Component/Trait Capability Revision in Application
When the capabilities(Component or Trait) changes, KubeVela will generate a definition revision automatically.
* Check ComponentDefinition Revision
```shell
$ kubectl get definitionrevision -l="componentdefinition.oam.dev/name=webservice" -n vela-system
NAME REVISION HASH TYPE
webservice-v1 1 3f6886d9832021ba Component
webservice-v2 2 b3b9978e7164d973 Component
```
* Check TraitDefinition Revision
```shell
$ kubectl get definitionrevision -l="trait.oam.dev/name=rollout" -n vela-system
NAME REVISION HASH TYPE
rollout-v1 1 e441f026c1884b14 Trait
```
You can specify the revision with `@version` approach, for example, if a user want to stick to using the `v1` revision of `webservice` component:
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: myapp
spec:
components:
- name: express-server
type: webservice@v1
properties:
image: stefanprodan/podinfo:4.0.3
```
In this way, if system admin changes the ComponentDefinition, it won't affect your application.
If no revision specified, KubeVela will use the latest revision when you upgrade your application.
## Application Revision
When updating an application entity except workflow, KubeVela will create a new revision as a snapshot for this change.
@ -244,4 +205,4 @@ while you just want to focus on the changed ones.
</details>
Furthermore, you can integrate the revision for application snapshot and recovery with your own system.
VelaUX uses database for version record, we also recommend you to use a database instead of relying on Kubernetes etcd for versioning.

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

@ -1,5 +1,5 @@
---
title: Built-in Steps
title: Built-in Workflow Steps
---
This documentation will walk through the built-in workflow steps that you can use to design an application deployment process.

34
docs/end-user/workflow/webhook-notification.md
View File

@ -8,23 +8,6 @@ In this guide, you will learn how to send notifications via `webhook-notificatio
> Make sure the version of KubeVela is `>=v1.1.6`.
## Parameters
| Parameter | Type | Description |
| :---: | :--: | :-- |
| slack | Object | Optional, please fulfill its url and message if you want to send Slack messages |
| slack.url | Object | Required, the webhook address of Slack, you can choose to fill it in directly or specify it in secret |
| slack.url.address | String | Optional, directly specify the webhook address of Slack |
| slack.url.fromSecret.name | String | Optional, specify the webhook address of Slack from secret |
| slack.url.fromSecret.key | String | Optional, specify the webhook address of Slack from secret, the key of the secret |
| 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 | Object | Required, the webhook address of DingTalk, you can choose to fill it in directly or specify it in secret |
| dingding.url.address | String | Optional, directly specify the webhook address of DingTalk |
| dingding.url.fromSecret.name | String | Optional, specify the webhook address of DingTalk from secret |
| dingding.url.fromSecret.key | String | Optional, specify the webhook address of DingTalk from secret, the key of the secret |
| 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) |
## How to use
Apply the following `Application` with workflow step type of `webhook-notification`:
@ -92,3 +75,20 @@ spec:
we can see that before and after the deployment of the application, the messages can be seen in the corresponding group chat.
With `webhook-notification`, we can integrate with webhook notifier easily.
## Parameters
| Parameter | Type | Description |
| :---: | :--: | :-- |
| slack | Object | Optional, please fulfill its url and message if you want to send Slack messages |
| slack.url | Object | Required, the webhook address of Slack, you can choose to fill it in directly or specify it in secret |
| slack.url.address | String | Optional, directly specify the webhook address of Slack |
| slack.url.fromSecret.name | String | Optional, specify the webhook address of Slack from secret |
| slack.url.fromSecret.key | String | Optional, specify the webhook address of Slack from secret, the key of the secret |
| 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 | Object | Required, the webhook address of DingTalk, you can choose to fill it in directly or specify it in secret |
| dingding.url.address | String | Optional, directly specify the webhook address of DingTalk |
| dingding.url.fromSecret.name | String | Optional, specify the webhook address of DingTalk from secret |
| dingding.url.fromSecret.key | String | Optional, specify the webhook address of DingTalk from secret, the key of the secret |
| 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) |

2
docs/getting-started/introduction.md
View File

@ -11,7 +11,7 @@ KubeVela is a modern application platform that makes it easier and faster to del
![](../resources/what-is-kubevela.png)
## Why we built KubeVela?
## Why KubeVela?
The trend of cloud-native technology is moving towards pursuing consistent experience of application delivery across clouds and on-prem clusters. Kubernetes is becoming the standard layer which is excellent in abstracting away low-level infrastructure details. But it does not provide abstractions to model application deployment on top of hybrid and distributed environments. The lack of application level context have impacted user experience, slowed down productivity, led to unexpected errors due to misconfigurations in production.

Some files were not shown because too many files have changed in this diff Show More