add command docs
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
parent
b600b2f09e
commit
2337296dc9
|
@ -28,6 +28,7 @@ title: CLI Commands
|
|||
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
|
||||
|
@ -41,8 +42,9 @@ You can also specify a remote url for app:
|
|||
|
||||
* [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.
|
||||
* [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
|
||||
|
||||
|
@ -51,6 +53,7 @@ You can also specify a remote url for app:
|
|||
* [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.
|
||||
|
||||
## Others
|
||||
|
|
|
@ -32,6 +32,7 @@ vela addon enable [flags]
|
|||
|
||||
```
|
||||
-c, --clusters string specify the runtime-clusters to enable
|
||||
--dry-run render all yaml files out without real execute it
|
||||
-h, --help help for enable
|
||||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
|
|
|
@ -15,21 +15,24 @@ vela addon registry add [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
"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>"
|
||||
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=<ptah> --token=<git token>"
|
||||
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--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
|
||||
--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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
--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
|
||||
-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 OSS path
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -21,15 +21,16 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
|
|||
### Options
|
||||
|
||||
```
|
||||
--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
|
||||
--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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
--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
|
||||
-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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
title: vela config-template
|
||||
---
|
||||
|
||||
Manage the template of config.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config-template
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config-template apply](vela_config-template_apply) - Apply a config template.
|
||||
* [vela config-template delete](vela_config-template_delete) - Delete a config template.
|
||||
* [vela config-template list](vela_config-template_list) - List the config templates.
|
||||
* [vela config-template show](vela_config-template_show) - Show the documents of the template properties
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela config-template apply
|
||||
---
|
||||
|
||||
Apply a config template.
|
||||
|
||||
```
|
||||
vela config-template apply [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string specify the template file name
|
||||
-h, --help help for apply
|
||||
--name string specify the config template name
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: vela config-template delete
|
||||
---
|
||||
|
||||
Delete a config template.
|
||||
|
||||
```
|
||||
vela config-template delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template delete <name> [-n vela-system]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela config-template list
|
||||
---
|
||||
|
||||
List the config templates.
|
||||
|
||||
```
|
||||
vela config-template list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template list [-A]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: vela config-template show
|
||||
---
|
||||
|
||||
Show the documents of the template properties
|
||||
|
||||
```
|
||||
vela config-template show [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config-template show <name> [-n]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for show
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela config
|
||||
---
|
||||
|
||||
Manage the configs.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage the configs, such as the terraform provider, image registry, helm repository, etc.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config create](vela_config_create) - Create a config.
|
||||
* [vela config delete](vela_config_delete) - Delete a config.
|
||||
* [vela config distribute](vela_config_distribute) - Distribute a config
|
||||
* [vela config list](vela_config_list) - List the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: vela config create
|
||||
---
|
||||
|
||||
Create a config.
|
||||
|
||||
```
|
||||
vela config create [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate a config with the args
|
||||
vela config create test-registry --template=image-registry registry=index.docker.io auth.username=test auth.password=test
|
||||
|
||||
# Generate a config with the file
|
||||
vela config create test-config --template=image-registry -f config.yaml
|
||||
|
||||
# Generate a config without the template
|
||||
vela config create --name test-vela -f config.yaml
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--alias string specify the alias of the config
|
||||
--description string specify the description of the config
|
||||
--dry-run Dry run to apply the config
|
||||
-f, --file string specify the file name of the config properties
|
||||
-h, --help help for create
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--target stringArray this config will be distributed if this flag is set
|
||||
-t, --template string specify the config template name and namespace
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: vela config delete
|
||||
---
|
||||
|
||||
Delete a config.
|
||||
|
||||
```
|
||||
vela config delete [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--not-recall means only deleting the config from the local and do not recall from targets.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: vela config distribute
|
||||
---
|
||||
|
||||
Distribute a config
|
||||
|
||||
```
|
||||
vela config distribute [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# distribute the config(test-registry) from the vela-system namespace to the default namespace in the local cluster.
|
||||
vela config d test-registry -t default
|
||||
|
||||
# distribute the config(test-registry) from the vela-system namespace to the other clusters.
|
||||
vela config d test-registry -t cluster1/default -t cluster2/default
|
||||
|
||||
# recall the config
|
||||
vela config d test-registry --recall
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for distribute
|
||||
-n, --namespace string specify the namespace of the distribution (default "vela-system")
|
||||
-r, --recall this field means recalling the configs from all targets.
|
||||
-t, --target stringArray specify the targets that want to distribute,the format is: <clusterName>/<namespace>
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela config list
|
||||
---
|
||||
|
||||
List the configs.
|
||||
|
||||
```
|
||||
vela config list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
-t, --template string specify the template of the config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -27,7 +27,7 @@ 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: policy, workload, scope, workflow-step, component, trait
|
||||
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: trait, policy, workload, scope, workflow-step, component
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -28,7 +28,7 @@ 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: 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: policy, workload, scope, workflow-step, component, trait
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -41,9 +41,9 @@ vela def init DEF_NAME [flags]
|
|||
--local string Specify the local path of the configuration(HCL) file. Valid when --provider/-p is set.
|
||||
-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.
|
||||
-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: trait, policy, workload, scope, workflow-step, component
|
||||
-t, --type string Specify the type of the new definition. Valid types: policy, workload, scope, workflow-step, component, trait
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -27,7 +27,7 @@ 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: 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: workload, scope, workflow-step, component, trait, policy
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -29,6 +29,10 @@ vela def show [flags]
|
|||
> vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json
|
||||
6. Show doc for a specified revision, it must exist in control plane cluster:
|
||||
> vela show webservice --revision v1
|
||||
7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/
|
||||
> vela show
|
||||
8. Generate all docs and start a doc server
|
||||
> vela show --web
|
||||
|
||||
```
|
||||
|
||||
|
|
|
@ -23,8 +23,6 @@ Authenticate Terraform Cloud Providers by managing Terraform Controller Provider
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
|
||||
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
|
||||
* [vela provider list](vela_provider_list) - List Terraform Cloud Providers
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
|
|
@ -23,6 +23,7 @@ Manage KubeVela Application Revisions
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela revision get](vela_revision_get) - get specific revision of application
|
||||
* [vela revision list](vela_revision_list) - list application revisions
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela revision get
|
||||
---
|
||||
|
||||
get specific revision of application
|
||||
|
||||
### Synopsis
|
||||
|
||||
get specific revision of application
|
||||
|
||||
```
|
||||
vela revision get [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --definition string component definition
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for get
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-o, --output string raw Application output format. One of: (json, yaml, jsonpath)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela revision](vela_revision) - Manage Application Revisions
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -29,6 +29,10 @@ vela show [flags]
|
|||
> vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json
|
||||
6. Show doc for a specified revision, it must exist in control plane cluster:
|
||||
> vela show webservice --revision v1
|
||||
7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/
|
||||
> vela show
|
||||
8. Generate all docs and start a doc server
|
||||
> vela show --web
|
||||
|
||||
```
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ vela status APP_NAME [flags]
|
|||
```
|
||||
--cluster string filter the endpoints or pods by cluster name
|
||||
-c, --component string filter the endpoints or pods by component name
|
||||
-d, --detail display the realtime details of application resources, must be used with --tree
|
||||
-d, --detail display more details in the application like input/output data in context. Note that if you want to show the realtime details of application resources, please use it with --tree
|
||||
--detail-format string the format for displaying details, must be used with --detail. Can be one of inline, wide, list, table, raw. (default "inline")
|
||||
-p, --endpoint show all service endpoints of the application
|
||||
-e, --env string specify environment name for application
|
||||
|
|
|
@ -15,9 +15,9 @@ vela system info [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for info
|
||||
-n, --namespace string Specify the namespace of the deployment to check detail information. If empty, it will prints deployments information of all namespaces. Default to be empty. An empty namespace may not be can when a resource name is provided.
|
||||
-s, --specify string Specify the name of the deployment to check detail information. If empty, it will print all deployments information. Default to be empty.
|
||||
-h, --help help for info
|
||||
-o, --output string Specifies the output format. One of: (wide | yaml)
|
||||
-s, --specify string Specify the name of the deployment to check detail information. If empty, it will print all deployments information. Default to be empty.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: vela top
|
||||
---
|
||||
|
||||
Launch UI to display the platform overview.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Launch UI to display platform overview information and diagnose the status for any specific application.
|
||||
|
||||
```
|
||||
vela top [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Launch UI to display platform overview information and diagnose the status for any specific application
|
||||
vela top
|
||||
|
||||
# Show applications which are in <vela-namespace> namespace
|
||||
vela top -n <vela-namespace>
|
||||
|
||||
# Show applications which are in all namespaces
|
||||
vela top -A
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for top
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -6,7 +6,7 @@ Operate application delivery workflow.
|
|||
|
||||
### Synopsis
|
||||
|
||||
Operate the Workflow during Application Delivery.
|
||||
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.
|
||||
|
||||
### Options
|
||||
|
||||
|
@ -23,11 +23,12 @@ Operate the Workflow during Application Delivery.
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela workflow logs](vela_workflow_logs) - Tail logs for workflow steps
|
||||
* [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 terminate](vela_workflow_terminate) - Terminate an workflow.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: vela workflow logs
|
||||
---
|
||||
|
||||
Tail logs for workflow steps
|
||||
|
||||
### Synopsis
|
||||
|
||||
Tail logs for workflow steps, note that you need to use op.#Logs in step definition to set the log config of the step.
|
||||
|
||||
```
|
||||
vela workflow logs [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela workflow logs <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for logs
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-o, --output string output format for logs, support: [default, raw, json] (default "default")
|
||||
-s, --step string specify the step name in the workflow
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela workflow](vela_workflow) - Operate application delivery workflow.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -24,6 +24,7 @@ vela workflow restart <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for restart
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow resume <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for resume
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow rollback <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for rollback
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow suspend <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for suspend
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow terminate
|
||||
---
|
||||
|
||||
Terminate an application workflow.
|
||||
Terminate an workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Terminate an application workflow in cluster.
|
||||
Terminate an workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow terminate [flags]
|
||||
|
@ -15,7 +15,7 @@ vela workflow terminate [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
vela workflow terminate <application-name>
|
||||
vela workflow terminate <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
@ -24,6 +24,7 @@ vela workflow terminate <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for terminate
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -28,6 +28,7 @@ title: CLI Commands
|
|||
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
|
||||
|
@ -41,8 +42,9 @@ You can also specify a remote url for app:
|
|||
|
||||
* [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.
|
||||
* [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
|
||||
|
||||
|
@ -51,6 +53,7 @@ You can also specify a remote url for app:
|
|||
* [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.
|
||||
|
||||
## Others
|
||||
|
|
|
@ -32,6 +32,7 @@ vela addon enable [flags]
|
|||
|
||||
```
|
||||
-c, --clusters string specify the runtime-clusters to enable
|
||||
--dry-run render all yaml files out without real execute it
|
||||
-h, --help help for enable
|
||||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
|
|
|
@ -15,21 +15,24 @@ vela addon registry add [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
"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>"
|
||||
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=<ptah> --token=<git token>"
|
||||
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --token=<git token>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--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
|
||||
--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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
--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
|
||||
-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 OSS path
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -21,15 +21,16 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
|
|||
### Options
|
||||
|
||||
```
|
||||
--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
|
||||
--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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
--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
|
||||
-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
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
title: vela config-template
|
||||
---
|
||||
|
||||
Manage the template of config.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config-template
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config-template apply](vela_config-template_apply) - Apply a config template.
|
||||
* [vela config-template delete](vela_config-template_delete) - Delete a config template.
|
||||
* [vela config-template list](vela_config-template_list) - List the config templates.
|
||||
* [vela config-template show](vela_config-template_show) - Show the documents of the template properties
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela config-template apply
|
||||
---
|
||||
|
||||
Apply a config template.
|
||||
|
||||
```
|
||||
vela config-template apply [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string specify the template file name
|
||||
-h, --help help for apply
|
||||
--name string specify the config template name
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: vela config-template delete
|
||||
---
|
||||
|
||||
Delete a config template.
|
||||
|
||||
```
|
||||
vela config-template delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template delete <name> [-n vela-system]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela config-template list
|
||||
---
|
||||
|
||||
List the config templates.
|
||||
|
||||
```
|
||||
vela config-template list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template list [-A]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: vela config-template show
|
||||
---
|
||||
|
||||
Show the documents of the template properties
|
||||
|
||||
```
|
||||
vela config-template show [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config-template show <name> [-n]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for show
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela config
|
||||
---
|
||||
|
||||
Manage the configs.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage the configs, such as the terraform provider, image registry, helm repository, etc.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config create](vela_config_create) - Create a config.
|
||||
* [vela config delete](vela_config_delete) - Delete a config.
|
||||
* [vela config distribute](vela_config_distribute) - Distribute a config
|
||||
* [vela config list](vela_config_list) - List the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: vela config create
|
||||
---
|
||||
|
||||
Create a config.
|
||||
|
||||
```
|
||||
vela config create [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate a config with the args
|
||||
vela config create test-registry --template=image-registry registry=index.docker.io auth.username=test auth.password=test
|
||||
|
||||
# Generate a config with the file
|
||||
vela config create test-config --template=image-registry -f config.yaml
|
||||
|
||||
# Generate a config without the template
|
||||
vela config create --name test-vela -f config.yaml
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--alias string specify the alias of the config
|
||||
--description string specify the description of the config
|
||||
--dry-run Dry run to apply the config
|
||||
-f, --file string specify the file name of the config properties
|
||||
-h, --help help for create
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--target stringArray this config will be distributed if this flag is set
|
||||
-t, --template string specify the config template name and namespace
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: vela config delete
|
||||
---
|
||||
|
||||
Delete a config.
|
||||
|
||||
```
|
||||
vela config delete [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--not-recall means only deleting the config from the local and do not recall from targets.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: vela config distribute
|
||||
---
|
||||
|
||||
Distribute a config
|
||||
|
||||
```
|
||||
vela config distribute [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# distribute the config(test-registry) from the vela-system namespace to the default namespace in the local cluster.
|
||||
vela config d test-registry -t default
|
||||
|
||||
# distribute the config(test-registry) from the vela-system namespace to the other clusters.
|
||||
vela config d test-registry -t cluster1/default -t cluster2/default
|
||||
|
||||
# recall the config
|
||||
vela config d test-registry --recall
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for distribute
|
||||
-n, --namespace string specify the namespace of the distribution (default "vela-system")
|
||||
-r, --recall this field means recalling the configs from all targets.
|
||||
-t, --target stringArray specify the targets that want to distribute,the format is: <clusterName>/<namespace>
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela config list
|
||||
---
|
||||
|
||||
List the configs.
|
||||
|
||||
```
|
||||
vela config list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
-t, --template string specify the template of the config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -24,7 +24,7 @@ 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: trait, policy, workload, scope, workflow-step, component
|
||||
-t, --type string Specify the definition type of target. Valid types: workflow-step, component, trait, policy, workload, scope
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -27,7 +27,7 @@ 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: policy, workload, scope, workflow-step, component, trait
|
||||
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: trait, policy, workload, scope, workflow-step, component
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -41,9 +41,9 @@ vela def init DEF_NAME [flags]
|
|||
--local string Specify the local path of the configuration(HCL) file. Valid when --provider/-p is set.
|
||||
-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.
|
||||
-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: trait, policy, workload, scope, workflow-step, component
|
||||
-t, --type string Specify the type of the new definition. Valid types: policy, workload, scope, workflow-step, component, trait
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -27,7 +27,7 @@ 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, scope, workflow-step
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -29,6 +29,10 @@ vela def show [flags]
|
|||
> vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json
|
||||
6. Show doc for a specified revision, it must exist in control plane cluster:
|
||||
> vela show webservice --revision v1
|
||||
7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/
|
||||
> vela show
|
||||
8. Generate all docs and start a doc server
|
||||
> vela show --web
|
||||
|
||||
```
|
||||
|
||||
|
|
|
@ -23,8 +23,6 @@ Authenticate Terraform Cloud Providers by managing Terraform Controller Provider
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
|
||||
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
|
||||
* [vela provider list](vela_provider_list) - List Terraform Cloud Providers
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
|
|
@ -23,6 +23,7 @@ Manage KubeVela Application Revisions
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela revision get](vela_revision_get) - get specific revision of application
|
||||
* [vela revision list](vela_revision_list) - list application revisions
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela revision get
|
||||
---
|
||||
|
||||
get specific revision of application
|
||||
|
||||
### Synopsis
|
||||
|
||||
get specific revision of application
|
||||
|
||||
```
|
||||
vela revision get [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --definition string component definition
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for get
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-o, --output string raw Application output format. One of: (json, yaml, jsonpath)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela revision](vela_revision) - Manage Application Revisions
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -29,6 +29,10 @@ vela show [flags]
|
|||
> vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json
|
||||
6. Show doc for a specified revision, it must exist in control plane cluster:
|
||||
> vela show webservice --revision v1
|
||||
7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/
|
||||
> vela show
|
||||
8. Generate all docs and start a doc server
|
||||
> vela show --web
|
||||
|
||||
```
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ vela status APP_NAME [flags]
|
|||
```
|
||||
--cluster string filter the endpoints or pods by cluster name
|
||||
-c, --component string filter the endpoints or pods by component name
|
||||
-d, --detail display the realtime details of application resources, must be used with --tree
|
||||
-d, --detail display more details in the application like input/output data in context. Note that if you want to show the realtime details of application resources, please use it with --tree
|
||||
--detail-format string the format for displaying details, must be used with --detail. Can be one of inline, wide, list, table, raw. (default "inline")
|
||||
-p, --endpoint show all service endpoints of the application
|
||||
-e, --env string specify environment name for application
|
||||
|
|
|
@ -15,9 +15,9 @@ vela system info [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for info
|
||||
-n, --namespace string Specify the namespace of the deployment to check detail information. If empty, it will prints deployments information of all namespaces. Default to be empty. An empty namespace may not be can when a resource name is provided.
|
||||
-s, --specify string Specify the name of the deployment to check detail information. If empty, it will print all deployments information. Default to be empty.
|
||||
-h, --help help for info
|
||||
-o, --output string Specifies the output format. One of: (wide | yaml)
|
||||
-s, --specify string Specify the name of the deployment to check detail information. If empty, it will print all deployments information. Default to be empty.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: vela top
|
||||
---
|
||||
|
||||
Launch UI to display the platform overview.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Launch UI to display platform overview information and diagnose the status for any specific application.
|
||||
|
||||
```
|
||||
vela top [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Launch UI to display platform overview information and diagnose the status for any specific application
|
||||
vela top
|
||||
|
||||
# Show applications which are in <vela-namespace> namespace
|
||||
vela top -n <vela-namespace>
|
||||
|
||||
# Show applications which are in all namespaces
|
||||
vela top -A
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for top
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -6,7 +6,7 @@ Operate application delivery workflow.
|
|||
|
||||
### Synopsis
|
||||
|
||||
Operate the Workflow during Application Delivery.
|
||||
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.
|
||||
|
||||
### Options
|
||||
|
||||
|
@ -23,11 +23,12 @@ Operate the Workflow during Application Delivery.
|
|||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela workflow logs](vela_workflow_logs) - Tail logs for workflow steps
|
||||
* [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 terminate](vela_workflow_terminate) - Terminate an workflow.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: vela workflow logs
|
||||
---
|
||||
|
||||
Tail logs for workflow steps
|
||||
|
||||
### Synopsis
|
||||
|
||||
Tail logs for workflow steps, note that you need to use op.#Logs in step definition to set the log config of the step.
|
||||
|
||||
```
|
||||
vela workflow logs [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela workflow logs <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for logs
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-o, --output string output format for logs, support: [default, raw, json] (default "default")
|
||||
-s, --step string specify the step name in the workflow
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela workflow](vela_workflow) - Operate application delivery workflow.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
|
@ -24,6 +24,7 @@ vela workflow restart <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for restart
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow resume <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for resume
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow rollback <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for rollback
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -24,6 +24,7 @@ vela workflow suspend <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for suspend
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow terminate
|
||||
---
|
||||
|
||||
Terminate an application workflow.
|
||||
Terminate an workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Terminate an application workflow in cluster.
|
||||
Terminate an workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow terminate [flags]
|
||||
|
@ -15,7 +15,7 @@ vela workflow terminate [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
vela workflow terminate <application-name>
|
||||
vela workflow terminate <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
@ -24,6 +24,7 @@ vela workflow terminate <application-name>
|
|||
-e, --env string specify environment name for application
|
||||
-h, --help help for terminate
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
Loading…
Reference in New Issue