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

release v1.9 docs and remove v1.6 docs (#1265) 

Co-authored-by: Qiaozp <qiaozhongpei.qzp@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2023-08-02 11:04:18 +08:00 committed by GitHub
parent 83f45230c7
commit e0c1595d6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3203 changed files with 19833 additions and 86627 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
docs/cli/vela.md
View File

@ -5,7 +5,6 @@ title: CLI Commands
## Getting Started
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Deploy one application
@ -14,36 +13,47 @@ title: CLI Commands
To apply application from file, use the -f/--file flag to specify the application file location.
To give a particular version to this deploy, use the -v/--publish-version flag. When you are deploying an existing application, the version name must be different from the current name. You can also use a history revision for the deploy and override the current application by using the -r/--revision flag.
* [vela status](vela_status) - Show status of vela application.
* [vela ls](vela_ls) - List all vela applications.
* [vela delete](vela_delete) - Delete applications
Delete KubeVela applications. KubeVela application deletion is associated with the recycle of underlying resources. By default, the resources created by the KubeVela application will be deleted once it is not in use or the application is deleted. There is garbage-collect policy in KubeVela application that you can use to configure customized recycle rules.
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name]". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela show](vela_show) - Show the reference doc for component, trait, policy or workflow types. 'vela show' equals with 'vela def show'.
## Managing Applications
* [vela addon](vela_addon) - Manage addons for extension.
* [vela status](vela_status) - Show status of vela application.
* [vela delete](vela_delete) - Delete applications
Delete KubeVela applications. KubeVela application deletion is associated with the recycle of underlying resources. By default, the resources created by the KubeVela application will be deleted once it is not in use or the application is deleted. There is garbage-collect policy in KubeVela application that you can use to configure customized recycle rules.
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name] ". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
* [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela logs](vela_logs) - Tail logs for vela application.
* [vela ql](vela_ql) - Show result of executing velaQL, use it like:
vela ql --query "inner-view-name{param1=value1,param2=value2}"
vela ql --file ./ql.cue
* [vela live-diff](vela_live-diff) - Compare application and revisions
* [vela top](vela_top) - Launch UI to display platform overview information and diagnose the status for any specific application.
* [vela ls](vela_ls) - List all vela applications.
* [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout.
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml
You can also specify a remote url for app:
vela dry-run -d /definition/directory/or/file/ -f https://remote-host/app.yaml
And more, you can specify policy and workflow with application file:
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml -f /path/to/policy.yaml -f /path/to/workflow.yaml, OR
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml
Additionally, if the provided policy and workflow files are not referenced by application file, warning message will show up
and those files will be ignored. You can use "merge" flag to make those standalone files effective:
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml --merge
Limitation:
1. Only support one object per file(yaml) for "-f" flag. More support will be added in the future improvement.
2. Dry Run with policy and workflow will only take override/topology policies and deploy workflow step into considerations. Other workflow step will be ignored.
* [vela live-diff](vela_live-diff) - Compare application and revisions.
* [vela logs](vela_logs) - Tail logs for vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela revision](vela_revision) - Manage KubeVela Application Revisions
* [vela debug](vela_debug) - Debug running application with debug policy.
## Continuous Delivery
* [vela workflow](vela_workflow) - Operate the Workflow during Application Delivery. Note that workflow command is both valid for Application Workflow and WorkflowRun(expect for [restart, rollout] command, they're only valid for Application Workflow). The command will try to find the Application first, if not found, it will try to find WorkflowRun. You can also specify the resource type by using --type flag.
* [vela adopt](vela_adopt) - Adopt resources into applications
Adopt resources into a KubeVela application. This command is useful when you already have resources applied in your Kubernetes cluster. These resources could be applied natively or with other tools, such as Helm. This command will automatically find out the resources to be adopted and assemble them into a new application which won't trigger any damage such as restart on the adoption.
@ -53,30 +63,21 @@ You can also specify a remote url for app:
There are two working mechanism (called 'modes' here) for the adoption by far, 'read-only' mode (by default) and 'take-over' mode. 1. In 'read-only' mode, adopted resources will not be touched. You can leverage vela tools (like Vela CLI or VelaUX) to observe those resources and attach traits to add new capabilities. The adopted resources will not be recycled or updated. This mode is recommended if you still want to keep using other tools to manage resources updates or deletion, like Helm. 2. In 'take-over' mode, adopted resources are completely managed by application which means they can be modified. You can use traits or directly modify the component to make edits to those resources. This mode can be helpful if you want to migrate existing resources into KubeVela system and let KubeVela to handle the life-cycle of target resources.
The adopted application can be customized. You can provide a CUE template file to the command and make your own assemble rules for the adoption application. You can refer to https://github.com/kubevela/kubevela/blob/master/references/cli/adopt-templates/default.cue to see the default implementation of adoption rules.
* [vela auth](vela_auth) -
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters for Continuous Delivery.
* [vela config](vela_config) - Manage the configs, such as the terraform provider, image registry, helm repository, etc.
* [vela kube](vela_kube) -
* [vela workflow](vela_workflow) - Operate the Workflow during Application Delivery. Note that workflow command is both valid for Application Workflow and WorkflowRun(expect for [restart, rollout] command, they're only valid for Application Workflow). The command will try to find the Application first, if not found, it will try to find WorkflowRun. You can also specify the resource type by using --type flag.
## Managing Extension
If you want to adopt all resources with resource topology rule to Applications, you can use: 'vela adopt --all'. The resource topology rule can be customized by '--resource-topology-rule' flag.
## Managing Extensions
* [vela uischema](vela_uischema) - Manage UI schema for addons.
* [vela def](vela_def) - Manage X-Definitions for extension.
* [vela registry](vela_registry) - Manage Registry of X-Definitions for extension.
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
* [vela component](vela_component) - List component types installed and discover more in registry.
* [vela config-template](vela_config-template) -
* [vela trait](vela_trait) - List trait types installed and discover more in registry.
* [vela def](vela_def) - Manage X-Definitions for extension.
## Others
## System Tools
* [vela uninstall](vela_uninstall) - Uninstalls KubeVela from a Kubernetes cluster.
* [vela install](vela_install) - The Kubevela CLI allows installing Kubevela on any Kubernetes derivative to which your kube config is pointing to.
* [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 system](vela_system) - Manage system, incluing printing the system deployment information in vela-system namespace and diagnosing the system's health.
* [vela uninstall](vela_uninstall) - Uninstalls KubeVela from a Kubernetes cluster.
* [vela system](vela_system) - Manage system, including printing the system deployment information in vela-system namespace and diagnosing the system's health.
* [vela version](vela_version) - Prints vela build version information.
###### Auto generated by [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

3
docs/cli/vela_addon.md
View File

@ -17,7 +17,8 @@ Manage addons for extension.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_disable.md
View File

@ -28,7 +28,8 @@ vela addon disable <addon-name>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

6
docs/cli/vela_addon_enable.md
View File

@ -42,6 +42,12 @@ vela addon enable [flags]
-y, --yes all checks will be skipped and the default answer is yes for all validation check.
```
### Options inherited from parent commands
```
-V, --verbosity Level number for the log level verbosity
```
### SEE ALSO
* [vela addon](vela_addon) - Manage addons for extension.

3
docs/cli/vela_addon_init.md
View File

@ -46,7 +46,8 @@ vela addon init [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

16
docs/cli/vela_addon_list.md
View File

@ -12,16 +12,28 @@ List addons in KubeVela
vela addon list [flags]
```
### Examples
```
List addon by:
vela addon ls
List addons in a specific registry, useful to reveal addons with duplicated names:
vela addon ls --registry <registry-name>
```
### Options
```
-h, --help help for list
-h, --help help for list
-r, --registry string specify the registry name to list
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_package.md
View File

@ -27,7 +27,8 @@ vela addon package <addon directory>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_push.md
View File

@ -66,7 +66,8 @@ $ HELM_REPO_USERNAME=name HELM_REPO_PASSWORD=pswd vela addon push mongo-1.0.0.tg
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_registry.md
View File

@ -17,7 +17,8 @@ Manage addon registry.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

9
docs/cli/vela_addon_registry_add.md
View File

@ -18,7 +18,7 @@ vela addon registry add [flags]
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --gitToken=<git token>
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
```
@ -28,11 +28,11 @@ add a specified gitlab registry: vela addon registry add my-repo --type gitlab -
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName, this option must be set when registry is gitlab
--gitlabRepoName string specify the gitlab addon registry repoName, must be set when registry is gitlab
-h, --help help for add
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry path, this option must be set when addons are not in root of registry
--path string specify the addon registry path, must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
@ -40,7 +40,8 @@ add a specified gitlab registry: vela addon registry add my-repo --type gitlab -
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_registry_delete.md
View File

@ -27,7 +27,8 @@ vela addon registry delete <registry-name>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_registry_get.md
View File

@ -27,7 +27,8 @@ vela addon registry get <registry name>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_registry_list.md
View File

@ -27,7 +27,8 @@ vela addon registry list
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

7
docs/cli/vela_addon_registry_update.md
View File

@ -24,11 +24,11 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
--bucket string specify the OSS bucket name
--endpoint string specify the addon registry endpoint
--gitToken string specify the github repo token
--gitlabRepoName string specify the gitlab addon registry repoName
--gitlabRepoName string specify the gitlab addon registry repoName, must be set when registry is gitlab
-h, --help help for update
--insecureSkipTLS specify the Helm addon registry skip tls verify
--password string specify the Helm addon registry password
--path string specify the addon registry OSS path
--path string specify the addon registry path, must be set when addons are not in root of registry
--type string specify the addon registry type
--username string specify the Helm addon registry username
```
@ -36,7 +36,8 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_status.md
View File

@ -28,7 +28,8 @@ vela addon status <addon-name>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_addon_upgrade.md
View File

@ -44,7 +44,8 @@ non-empty new arg
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

42
docs/cli/vela_adopt.md
View File

@ -2,7 +2,7 @@
title: vela adopt
---
Adopt resources into new application
Adopt resources into new application.
### Synopsis
@ -16,6 +16,8 @@ Adopt resources into applications
The adopted application can be customized. You can provide a CUE template file to the command and make your own assemble rules for the adoption application. You can refer to https://github.com/kubevela/kubevela/blob/master/references/cli/adopt-templates/default.cue to see the default implementation of adoption rules.
If you want to adopt all resources with resource topology rule to Applications, you can use: 'vela adopt --all'. The resource topology rule can be customized by '--resource-topology-rule' flag.
```
vela adopt [flags]
```
@ -26,7 +28,13 @@ vela adopt [flags]
# Native Resources Adoption
## Adopt resources into new application
## Use: vela adopt <resources-type>[/<resource-namespace>]/<resource-name> <resources-type>[/<resource-namespace>]/<resource-name> ...
## Adopt all resources to Applications with resource topology rule
## Use: vela adopt <resources-type> --all
vela adopt --all
vela adopt deployment --all --resource-topology-rule myrule.cue
## Use: vela adopt <resources-type>[/<resource-cluster>][/<resource-namespace>]/<resource-name> <resources-type>[/<resource-cluster>][/<resource-namespace>]/<resource-name> ...
vela adopt deployment/my-app configmap/my-app
## Adopt resources into new application with specified app name
@ -48,6 +56,11 @@ vela adopt [flags]
# Helm Chart Adoption
## Adopt all helm releases to Applications with resource topology rule
## Use: vela adopt <resources-type> --all
vela adopt --all --type helm
vela adopt my-chart --all --resource-topology-rule myrule.cue --type helm
## Adopt resources in a deployed helm chart
vela adopt my-chart -n my-namespace --type helm
@ -69,22 +82,25 @@ vela adopt [flags]
### Options
```
--adopt-template string The CUE template for adoption. If not provided, the default template will be used when --auto is switched on.
--app-name string The name of application for adoption. If empty for helm type adoption, it will inherit the helm chart's name.
--apply If true, the application for adoption will be applied. Otherwise, it will only be printed.
-d, --driver string The storage backend of helm adoption. Only take effect when --type=helm.
-e, --env string The environment name for the CLI request
-h, --help help for adopt
-m, --mode string The mode of adoption. Available values: [read-only, take-over] (default "read-only")
-n, --namespace string If present, the namespace scope for this CLI request
--recycle If true, when the adoption application is successfully applied, the old storage (like Helm secret) will be recycled.
-t, --type string The type of adoption. Available values: [native, helm] (default "native")
--adopt-template string The CUE template for adoption. If not provided, the default template will be used when --auto is switched on.
--all Adopt all resources in the namespace
--app-name string The name of application for adoption. If empty for helm type adoption, it will inherit the helm chart's name.
--apply If true, the application for adoption will be applied. Otherwise, it will only be printed.
-d, --driver string The storage backend of helm adoption. Only take effect when --type=helm.
-e, --env string The environment name for the CLI request
-h, --help help for adopt
-m, --mode string The mode of adoption. Available values: [read-only, take-over] (default "read-only")
-n, --namespace string If present, the namespace scope for this CLI request
--recycle If true, when the adoption application is successfully applied, the old storage (like Helm secret) will be recycled.
--resource-topology-rule string The CUE template for specify the rule of the resource topology. If not provided, the default rule will be used.
-t, --type string The type of adoption. Available values: [native, helm] (default "native")
-y, --yes Skip confirmation prompt
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
```
### SEE ALSO

3
docs/cli/vela_auth.md
View File

@ -13,7 +13,8 @@ Manage identity and authorizations.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_auth_gen-kubeconfig.md
View File

@ -48,7 +48,8 @@ vela auth gen-kubeconfig
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_auth_grant-privileges.md
View File

@ -63,7 +63,8 @@ vela auth grant-privileges
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_auth_list-privileges.md
View File

@ -55,7 +55,8 @@ vela auth list-privileges
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

12
docs/cli/vela_cluster.md
View File

@ -2,11 +2,11 @@
title: vela cluster
---
Manage Kubernetes Clusters
Manage Kubernetes clusters.
### Synopsis
Manage Kubernetes Clusters for Continuous Delivery.
Manage Kubernetes clusters for continuous delivery.
### Options
@ -17,7 +17,8 @@ Manage Kubernetes Clusters for Continuous Delivery.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
@ -25,9 +26,10 @@ Manage Kubernetes Clusters for Continuous Delivery.
* [vela cluster alias](vela_cluster_alias) - alias a named cluster.
* [vela cluster detach](vela_cluster_detach) - detach managed cluster.
* [vela cluster export-config](vela_cluster_export-config) - Export multi-cluster kubeconfig.
* [vela cluster join](vela_cluster_join) - join managed cluster.
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
* [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels.
* [vela cluster list](vela_cluster_list) - list managed clusters.
* [vela cluster probe](vela_cluster_probe) - health probe managed cluster.
* [vela cluster rename](vela_cluster_rename) - rename managed cluster.

5
docs/cli/vela_cluster_alias.md
View File

@ -21,12 +21,13 @@ vela cluster alias CLUSTER_NAME ALIAS [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_cluster_detach.md
View File

@ -22,12 +22,13 @@ vela cluster detach [CLUSTER_NAME] [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

57
docs/cli/vela_cluster_export-config.md Normal file
View File

@ -0,0 +1,57 @@
---
title: vela cluster export-config
---
Export multi-cluster kubeconfig.
### Synopsis
Export multi-cluster kubeconfig
Load existing cluster kubeconfig and list clusters registered in KubeVela. Export the proxy access of these clusters to KubeConfig and print it out.
```
vela cluster export-config [flags]
```
### Examples
```
# Export all clusters to kubeconfig
vela cluster export-config
# Export clusters with specified kubeconfig
KUBECONFIG=./my-hub-cluster.kubeconfig vela cluster export-config
# Export clusters with specified labels
vela cluster export-config -l gpu-cluster=true
# Export clusters to kubeconfig and save in file
vela cluster export-config > my-vela.kubeconfig
# Use the exported kubeconfig in kubectl
KUBECONFIG=my-vela.kubeconfig kubectl get namespaces --cluster c2
```
### Options
```
-h, --help help for export-config
-l, --selector string LabelSelector for select clusters to export.
```
### Options inherited from parent commands
```
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

7
docs/cli/vela_cluster_join.md
View File

@ -17,6 +17,7 @@ vela cluster join [KUBECONFIG] [flags]
```
# Join cluster declared in my-child-cluster.kubeconfig
> vela cluster join my-child-cluster.kubeconfig --name example-cluster
> vela cluster join my-child-cluster.kubeconfig --name example-cluster --labels project=kubevela,owner=oam-dev
```
### Options
@ -26,18 +27,20 @@ vela cluster join [KUBECONFIG] [flags]
-t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty. (default "cluster-gateway")
-h, --help help for join
--in-cluster-boostrap If true, the registering managed cluster will use the internal endpoint prescribed in the hub cluster's configmap "kube-public/cluster-info to register "itself to the hub cluster. Otherwise use the original endpoint from the hub kubeconfig. (default true)
--labels string Specifies the labels need to create in managedCluster
-n, --name string Specify the cluster name. If empty, it will use the cluster name in config file. Default to be empty.
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

11
docs/cli/vela_cluster_labels.md
View File

@ -2,7 +2,7 @@
title: vela cluster labels
---
Manage Kubernetes Cluster Labels
Manage Kubernetes Cluster Labels.
### Synopsis
@ -17,14 +17,15 @@ Manage Kubernetes Cluster Labels for Continuous Delivery.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster labels add](vela_cluster_labels_add) - add labels to managed cluster
* [vela cluster labels del](vela_cluster_labels_del) - delete labels for managed cluster
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
* [vela cluster labels add](vela_cluster_labels_add) - add labels to managed cluster.
* [vela cluster labels del](vela_cluster_labels_del) - Delete labels for managed cluster.
#### Go Back to [CLI Commands](vela) Homepage.

9
docs/cli/vela_cluster_labels_add.md
View File

@ -2,11 +2,11 @@
title: vela cluster labels add
---
add labels to managed cluster
add labels to managed cluster.
### Synopsis
add labels to managed cluster
add labels to managed cluster.
```
vela cluster labels add CLUSTER_NAME LABELS [flags]
@ -27,12 +27,13 @@ vela cluster labels add my-cluster project=kubevela,owner=oam-dev
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels.
#### Go Back to [CLI Commands](vela) Homepage.

9
docs/cli/vela_cluster_labels_del.md
View File

@ -2,11 +2,11 @@
title: vela cluster labels del
---
delete labels for managed cluster
Delete labels for managed cluster.
### Synopsis
delete labels for managed cluster
Delete labels for managed cluster.
```
vela cluster labels del CLUSTER_NAME LABELS [flags]
@ -27,12 +27,13 @@ vela cluster labels del my-cluster project,owner
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_cluster_list.md
View File

@ -2,7 +2,7 @@
title: vela cluster list
---
list managed clusters
list managed clusters.
### Synopsis
@ -21,12 +21,13 @@ vela cluster list [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_cluster_probe.md
View File

@ -21,12 +21,13 @@ vela cluster probe [CLUSTER_NAME] [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_cluster_rename.md
View File

@ -21,12 +21,13 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster](vela_cluster) - Manage Kubernetes clusters.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_completion.md
View File

@ -2,7 +2,7 @@
title: vela completion
---
Output shell completion code for the specified shell (bash or zsh)
Output shell completion code for the specified shell (bash or zsh).
### Synopsis
@ -18,7 +18,8 @@ The shell code must be evaluated to provide interactive completion of vela comma
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_completion_bash.md
View File

@ -31,12 +31,13 @@ vela completion bash
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh).
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_completion_zsh.md
View File

@ -28,12 +28,13 @@ vela completion zsh
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh)
* [vela completion](vela_completion) - Output shell completion code for the specified shell (bash or zsh).
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_component.md
View File

@ -2,7 +2,7 @@
title: vela component
---
List/get components
List/get components.
### Synopsis
@ -32,7 +32,8 @@ vela comp
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_component_get.md
View File

@ -30,12 +30,13 @@ vela comp get <component>
--registry string specify the registry name (default "default")
--token string specify token when using --url to specify registry url
--url string specify the registry URL
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela component](vela_component) - List/get components
* [vela component](vela_component) - List/get components.
#### Go Back to [CLI Commands](vela) Homepage.

3
docs/cli/vela_config-template.md
View File

@ -13,7 +13,8 @@ Manage the template of config.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config-template_apply.md
View File

@ -20,7 +20,8 @@ vela config-template apply [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config-template_delete.md
View File

@ -24,7 +24,8 @@ vela config template delete <name> [-n vela-system]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config-template_list.md
View File

@ -25,7 +25,8 @@ vela config template list [-A]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config-template_show.md
View File

@ -24,7 +24,8 @@ vela config-template show <name> [-n]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config.md
View File

@ -17,7 +17,8 @@ Manage the configs, such as the terraform provider, image registry, helm reposit
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config_create.md
View File

@ -37,7 +37,8 @@ vela config create [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config_delete.md
View File

@ -19,7 +19,8 @@ vela config delete [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config_distribute.md
View File

@ -33,7 +33,8 @@ vela config distribute [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_config_list.md
View File

@ -20,7 +20,8 @@ vela config list [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

15
i18n/zh/docusaurus-plugin-content-docs/version-v1.4/cli/vela_revision.md → docs/cli/vela_cuex.md
View File

@ -1,29 +1,26 @@
---
title: vela revision
title: vela cuex
---
Manage Application Revisions
### Synopsis
Manage KubeVela Application Revisions
Manage CueX engine for compile.
### Options
```
-h, --help help for revision
-h, --help help for cuex
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision list](vela_revision_list) - list application revisions
* [vela cuex eval](vela_cuex_eval) - Eval cue file with CueX engine.
#### Go Back to [CLI Commands](vela) Homepage.

53
docs/cli/vela_cuex_eval.md Normal file
View File

@ -0,0 +1,53 @@
---
title: vela cuex eval
---
Eval cue file with CueX engine.
### Synopsis
Eval cue file with CueX engine.
Evaluate your cue file with the CueX engine. When your cue file does not use KubeVela's extension, it will work similarly to the native CUE CLI. When using KubeVela's extensions, this command will execute the extension functions and resolve values, in addition to the native CUE compile process.
```
vela cuex eval [flags]
```
### Examples
```
# Evaluate a cue file
vela cuex eval -f my.cue
# Evaluate a cue file into json format
vela cuex eval -f my.cue -o json
# Evaluate a cue file and output the target path
vela cuex eval -f my.cue -p key.path
```
### Options
```
-f, --file string file for eval
-o, --format string format of the output (default "cue")
-h, --help help for eval
-p, --path string path for eval
```
### Options inherited from parent commands
```
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cuex](vela_cuex) - Manage CueX engine for compile.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

5
docs/cli/vela_debug.md
View File

@ -2,7 +2,7 @@
title: vela debug
---
Debug running application
Debug running application.
### Synopsis
@ -31,7 +31,8 @@ vela debug <application-name>
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

9
docs/cli/vela_def.md
View File

@ -2,7 +2,7 @@
title: vela def
---
Manage Definitions
Manage definitions.
### Synopsis
@ -17,7 +17,8 @@ Manage X-Definitions for extension.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
@ -26,7 +27,9 @@ Manage X-Definitions for extension.
* [vela def apply](vela_def_apply) - Apply X-Definition.
* [vela def del](vela_def_del) - Delete X-Definition.
* [vela def edit](vela_def_edit) - Edit X-Definition.
* [vela def gen-api](vela_def_gen-api) - Generate Go struct of Parameter from X-Definition.
* [vela def gen-api](vela_def_gen-api) - Generate SDK from X-Definition.
* [vela def gen-cue](vela_def_gen-cue) - Generate CUE schema from Go code.
* [vela def gen-doc](vela_def_gen-doc) - Generate documentation for non component, trait, policy and workflow definitions
* [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.

5
docs/cli/vela_def_apply.md
View File

@ -37,12 +37,13 @@ vela def apply DEFINITION.cue [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_def_del.md
View File

@ -24,18 +24,19 @@ vela def del DEFINITION_NAME [flags]
```
-h, --help help for del
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
-t, --type string Specify the definition type of target. Valid types: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify the definition type of target. Valid types: policy, workload, workflow-step, component, trait
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_def_edit.md
View File

@ -27,18 +27,19 @@ vela def edit NAME [flags]
```
-h, --help help for edit
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
-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
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workload, workflow-step, component, trait, policy
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

38
docs/cli/vela_def_gen-api.md
View File

@ -2,11 +2,12 @@
title: vela def gen-api
---
Generate Go struct of Parameter from X-Definition.
Generate SDK from X-Definition.
### Synopsis
Generate Go struct of Parameter from definition file.
Generate SDK from X-definition file.
* This command leverage openapi-generator project. Therefore demands "docker" exist in PATH
* Currently, this function is still working in progress and not all formats of parameter in X-definition are supported yet.
```
@ -16,28 +17,45 @@ vela def gen-api DEFINITION.cue [flags]
### Examples
```
# Command below will generate the Go struct for the my-def.cue file.
> vela def gen-api my-def.cue
# Generate SDK for golang with scaffold initialized
> vela def gen-api --init --language go -f /path/to/def -o /path/to/sdk
# Generate incremental definition files to existing sdk directory
> vela def gen-api --language go -f /path/to/def -o /path/to/sdk
# Generate definitions to a sub-module
> vela def gen-api --language go -f /path/to/def -o /path/to/sdk --submodule --api-dir path/relative/to/output --language-args arg1=val1,arg2=val2
```
### Options
```
-h, --help help for gen-api
--package-name string Specify the package name in generated Go code. (default "main")
--prefix string Specify the prefix of the generated Go struct.
--skip-package-name Skip package name in generated Go code.
--api-dir string API directory path to put definition API files, relative to output directory. Default value: go: pkg/apis
-f, --file strings File name of definitions, can be specified multiple times, or use comma to separate multiple files. If directory specified, all files found recursively in the directory will be used
-h, --help help for gen-api
--init Init the whole SDK project, if not set, only the API file will be generated
-g, --language string Language to generate code. Valid languages: go (default "go")
--language-args strings language-specific arguments to pass to the go generator, available options:
go:
MainModuleVersion: MainModuleVersion(default: cd431bb25a9a)
GoProxy: GoProxy(default: https://goproxy.cn,direct)
-o, --output string Output directory path (default "./apis")
-p, --package string Package name of generated code (default "github.com/kubevela/vela-go-sdk")
--submodule api-dir Whether the generated code is a submodule of the project. If set, the directory specified by api-dir will be treated as a submodule of the project
-t, --template string Template file path, if not specified, the default template will be used
-v, --verbose Print verbose logs
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

50
docs/cli/vela_def_gen-cue.md Normal file
View File

@ -0,0 +1,50 @@
---
title: vela def gen-cue
---
Generate CUE schema from Go code.
### Synopsis
Generate CUE schema from Go code.
* This command provide a way to generate CUE schema from Go code,
* Which can be used to keep consistency between Go code and CUE schema automatically.
```
vela def gen-cue [flags] SOURCE.go
```
### Examples
```
# Generate CUE schema for provider type
> vela def gen-cue -t provider /path/to/myprovider.go > /path/to/myprovider.cue
# Generate CUE schema for provider type with custom types
> vela def gen-cue -t provider --types *k8s.io/apimachinery/pkg/apis/meta/v1/unstructured.Unstructured=ellipsis /path/to/myprovider.go > /path/to/myprovider.cue
```
### Options
```
-h, --help help for gen-cue
--nullable Whether to generate null enum for pointer type
-t, --type string Type of the definition to generate. Valid types: [provider]
--types stringToString Special types to generate, format: <package+struct>=[any|ellipsis]. e.g. --types=*k8s.io/apimachinery/pkg/apis/meta/v1/unstructured.Unstructured=ellipsis (default [])
```
### Options inherited from parent commands
```
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

43
docs/cli/vela_def_gen-doc.md Normal file
View File

@ -0,0 +1,43 @@
---
title: vela def gen-doc
---
Generate documentation for non component, trait, policy and workflow definitions
### Synopsis
Generate documentation for non component, trait, policy and workflow definitions
```
vela def gen-doc [flags] SOURCE.cue...
```
### Examples
```
1. Generate documentation for provider definitions
> vela def gen-doc -t provider provider1.cue provider2.cue > provider.md
```
### Options
```
-h, --help help for gen-doc
-t, --type string Type of the definition to generate. Valid types: [provider]
```
### Options inherited from parent commands
```
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

7
docs/cli/vela_def_get.md
View File

@ -28,18 +28,19 @@ vela def get NAME [flags]
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
-r, --revision string Get the specified version of a definition.
--revisions List revisions of the specified definition.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: scope, workflow-step, component, trait, policy, workload
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: policy, workload, workflow-step, component, trait
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_def_init.md
View File

@ -43,18 +43,19 @@ vela def init DEF_NAME [flags]
--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`, `gcp`, `baidu`, `tencent`, `elastic`, `ucloud`, `vsphere` are supported.
-f, --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: component, trait, policy, workload, scope, workflow-step
-t, --type string Specify the type of the new definition. Valid types: trait, policy, workload, workflow-step, component
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_def_list.md
View File

@ -27,18 +27,19 @@ vela def list [flags]
--from string Filter definitions by which addon installed them.
-h, --help help for list
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: workload, scope, workflow-step, component, trait, policy
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: component, trait, policy, workload, workflow-step
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_def_render.md
View File

@ -33,12 +33,13 @@ vela def render DEFINITION.cue [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_def_show.md
View File

@ -53,12 +53,13 @@ vela def show [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

8
docs/cli/vela_def_vet.md
View File

@ -18,6 +18,9 @@ vela def vet DEFINITION.cue [flags]
```
# Command below will validate the my-def.cue file.
> vela def vet my-def.cue
# Validate every cue file provided
> vela def vet my-def1.cue my-def2.cue my-def3.cue
# Validate every cue file in the specified directories> vela def vet ./test1/ ./test2/
```
### Options
@ -29,12 +32,13 @@ vela def vet DEFINITION.cue [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
* [vela def](vela_def) - Manage definitions.
#### Go Back to [CLI Commands](vela) Homepage.

7
docs/cli/vela_delete.md
View File

@ -2,7 +2,7 @@
title: vela delete
---
Delete an application
Delete an application.
### Synopsis
@ -10,7 +10,7 @@ Delete applications
Delete KubeVela applications. KubeVela application deletion is associated with the recycle of underlying resources. By default, the resources created by the KubeVela application will be deleted once it is not in use or the application is deleted. There is garbage-collect policy in KubeVela application that you can use to configure customized recycle rules.
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name] ". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name]". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
```
vela delete
@ -60,7 +60,8 @@ vela delete
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

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

@ -2,7 +2,7 @@
title: vela dry-run
---
Dry Run an application, and output the K8s resources as result to stdout
Dry Run an application, and output the K8s resources as result to stdout.
### Synopsis
@ -12,6 +12,18 @@ Dry-run application locally, render the Kubernetes resources as result to stdout
You can also specify a remote url for app:
vela dry-run -d /definition/directory/or/file/ -f https://remote-host/app.yaml
And more, you can specify policy and workflow with application file:
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml -f /path/to/policy.yaml -f /path/to/workflow.yaml, OR
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml
Additionally, if the provided policy and workflow files are not referenced by application file, warning message will show up
and those files will be ignored. You can use "merge" flag to make those standalone files effective:
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml --merge
Limitation:
1. Only support one object per file(yaml) for "-f" flag. More support will be added in the future improvement.
2. Dry Run with policy and workflow will only take override/topology policies and deploy workflow step into considerations. Other workflow step will be ignored.
```
vela dry-run
@ -20,24 +32,33 @@ vela dry-run
### Examples
```
vela dry-run
# dry-run application
vela dry-run -f app.yaml
# dry-run application with policy and workflow
vela dry-run -f app.yaml -f policy.yaml -f workflow.yaml
```
### Options
```
-d, --definition string specify a definition file or directory, it will only be used in dry-run rather than applied to K8s cluster
-e, --env string specify environment name for application
-f, --file string application file name (default "./app.yaml")
-h, --help help for dry-run
-n, --namespace string specify the Kubernetes namespace to use
--offline dry-run Run dry-run in offline / local mode, all validation steps will be skipped
-d, --definition string specify a definition file or directory, it will only be used in dry-run rather than applied to K8s cluster
-x, --definition-namespace string Specify which namespace the definition locates. (default "vela-system")
-e, --env string specify environment name for application
-f, --file strings application related file names (default [app.yaml])
-h, --help help for dry-run
--merge Merge standalone files to produce dry-run results
-n, --namespace string specify the Kubernetes namespace to use
--offline dry-run Run dry-run in offline / local mode, all validation steps will be skipped
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_env.md
View File

@ -17,7 +17,8 @@ Manage environments for vela applications to run.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_env_delete.md
View File

@ -27,7 +27,8 @@ vela env delete test
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_env_init.md
View File

@ -28,7 +28,8 @@ vela env init test --namespace test
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_env_ls.md
View File

@ -27,7 +27,8 @@ vela env ls [env-name]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_env_set.md
View File

@ -28,7 +28,8 @@ vela env set test
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

9
docs/cli/vela_exec.md
View File

@ -2,20 +2,22 @@
title: vela exec
---
Execute command in a container
Execute command in a container.
### Synopsis
Execute command inside container based vela application.
```
vela exec [flags] APP_NAME -- COMMAND [args...]
vela exec [flags]
```
### Examples
```
exec [flags] APP_NAME -- COMMAND [args...]
# Get output from running 'date' command from app pod, using the first container by default
vela exec my-app -- date
@ -43,7 +45,8 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_export.md
View File

@ -24,7 +24,8 @@ vela export
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

13
docs/cli/vela_help.md
View File

@ -2,10 +2,16 @@
title: vela help
---
Help about any command
Help about any command.
```
vela help [command]
vela help
```
### Examples
```
help [command] | STRING_TO_SEARCH
```
### Options
@ -17,7 +23,8 @@ vela help [command]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_init.md
View File

@ -30,7 +30,8 @@ vela init
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_install.md
View File

@ -27,7 +27,8 @@ vela install [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_kube.md
View File

@ -17,7 +17,8 @@ vela kube [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_kube_apply.md
View File

@ -54,7 +54,8 @@ vela kube apply [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_kube_delete.md
View File

@ -41,7 +41,8 @@ vela kube delete [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

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

@ -2,11 +2,11 @@
title: vela live-diff
---
Compare application and revisions
Compare application and revisions.
### Synopsis
Compare application and revisions
Compare application and revisions.
```
vela live-diff
@ -40,7 +40,8 @@ vela live-diff
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_logs.md
View File

@ -9,7 +9,7 @@ Tail logs for application.
Tail logs for vela application.
```
vela logs APP_NAME [flags]
vela logs [flags]
```
### Options
@ -28,7 +28,8 @@ vela logs APP_NAME [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_ls.md
View File

@ -2,7 +2,7 @@
title: vela ls
---
List applications
List applications.
### Synopsis
@ -32,7 +32,8 @@ vela ls
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

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

@ -9,7 +9,7 @@ Forward local ports to container/service port of vela application.
Forward local ports to container/service port of vela application.
```
vela port-forward APP_NAME [flags]
vela port-forward [flags]
```
### Examples
@ -35,7 +35,8 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

7
docs/cli/vela_provider.md
View File

@ -2,11 +2,11 @@
title: vela provider
---
Authenticate Terraform Cloud Providers
Authenticate terraform cloud providers.
### Synopsis
Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
Authenticate terraform cloud providers by managing terraform controller providers with its credential secret.
### Options
@ -17,7 +17,8 @@ Authenticate Terraform Cloud Providers by managing Terraform Controller Provider
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_provider_list.md
View File

@ -21,12 +21,13 @@ vela provider list [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers
* [vela provider](vela_provider) - Authenticate terraform cloud providers.
#### Go Back to [CLI Commands](vela) Homepage.

3
docs/cli/vela_ql.md
View File

@ -59,7 +59,8 @@ export: "status"
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_ql_apply.md
View File

@ -47,7 +47,8 @@ If view name cannot be inferred, or you are reading from stdin (-f -), you must
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_registry.md
View File

@ -17,7 +17,8 @@ Manage Registry of X-Definitions for extension.
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_registry_config.md
View File

@ -28,7 +28,8 @@ vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_registry_ls.md
View File

@ -27,7 +27,8 @@ vela registry ls
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_registry_remove.md
View File

@ -27,7 +27,8 @@ vela registry remove mycenter
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_revision.md
View File

@ -2,7 +2,7 @@
title: vela revision
---
Manage Application Revisions
Manage Application Revisions.
### Synopsis
@ -17,7 +17,8 @@ Manage KubeVela Application Revisions
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_revision_get.md
View File

@ -25,12 +25,13 @@ vela revision get [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision](vela_revision) - Manage Application Revisions
* [vela revision](vela_revision) - Manage Application Revisions.
#### Go Back to [CLI Commands](vela) Homepage.

5
docs/cli/vela_revision_list.md
View File

@ -23,12 +23,13 @@ vela revision list [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision](vela_revision) - Manage Application Revisions
* [vela revision](vela_revision) - Manage Application Revisions.
#### Go Back to [CLI Commands](vela) Homepage.

3
docs/cli/vela_show.md
View File

@ -53,7 +53,8 @@ vela show [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

9
docs/cli/vela_status.md
View File

@ -9,7 +9,7 @@ Show status of an application.
Show status of vela application.
```
vela status APP_NAME [flags]
vela status [flags]
```
### Examples
@ -33,6 +33,9 @@ vela status APP_NAME [flags]
# Get raw Application status using jsonpath
vela status first-vela-app -o jsonpath='{.status}'
# Get Application metrics status
vela status first-vela-app --metrics
```
### Options
@ -45,6 +48,7 @@ vela status APP_NAME [flags]
-p, --endpoint show all service endpoints of the application
-e, --env string specify environment name for application
-h, --help help for status
-m, --metrics show resource quota and consumption metrics of the application
-n, --namespace string specify the Kubernetes namespace to use
-o, --output string raw Application output format. One of: (json, yaml, jsonpath)
--pod show pod list of the application
@ -55,7 +59,8 @@ vela status APP_NAME [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

5
docs/cli/vela_system.md
View File

@ -6,7 +6,7 @@ Manage system.
### Synopsis
Manage system, incluing printing the system deployment information in vela-system namespace and diagnosing the system's health.
Manage system, including printing the system deployment information in vela-system namespace and diagnosing the system's health.
### Examples
@ -29,7 +29,8 @@ Manage system, incluing printing the system deployment information in vela-syste
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_system_diagnose.md
View File

@ -21,7 +21,8 @@ vela system diagnose [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_system_info.md
View File

@ -23,7 +23,8 @@ vela system info [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_top.md
View File

@ -38,7 +38,8 @@ vela top [flags]
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

3
docs/cli/vela_trait.md
View File

@ -32,7 +32,8 @@ vela trait
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
-V, --verbosity Level number for the log level verbosity
-y, --yes Assume yes for all user prompts
```
### SEE ALSO

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