update reference docs (#1127)
Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com> Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun
GitHub
parent
d6f511ddca
commit
715445f01e
|
|
@ -24,7 +24,7 @@ title: CLI Commands
|
|||
|
||||
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 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.
|
||||
|
|
|
|||
|
|
@ -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: workload, scope, workflow-step, component, trait, policy
|
||||
```
|
||||
|
||||
### 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: scope, workflow-step, component, trait, policy, workload
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ 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: trait, policy, workload, scope, workflow-step, component
|
||||
-t, --type string Specify the type of the new definition. Valid types: component, trait, policy, workload, scope, workflow-step
|
||||
```
|
||||
|
||||
### 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: component, trait, policy, workload, scope, workflow-step
|
||||
-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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Built-in Component Type
|
|||
|
||||
This documentation will walk through all the built-in component types sorted alphabetically.
|
||||
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-10T21:14:25+08:00.
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-13T17:08:03+08:00.
|
||||
|
||||
## Cron-Task
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Built-in Policy Type
|
|||
|
||||
This documentation will walk through all the built-in policy types sorted alphabetically.
|
||||
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-10T21:14:25+08:00.
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-13T17:08:03+08:00.
|
||||
|
||||
## Apply-Once
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Built-in Trait Type
|
|||
|
||||
This documentation will walk through all the built-in trait types sorted alphabetically.
|
||||
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-10T21:14:25+08:00.
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-13T17:08:03+08:00.
|
||||
|
||||
## Affinity
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Built-in WorkflowStep Type
|
|||
|
||||
This documentation will walk through all the built-in workflow step types sorted alphabetically.
|
||||
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-10T21:14:25+08:00.
|
||||
> It was generated automatically by [scripts](../../contributor/cli-ref-doc), please don't update manually, last updated at 2023-01-13T17:08:03+08:00.
|
||||
|
||||
## Apply-Component
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,11 @@ title: CLI Commands
|
|||
|
||||
* [vela addon](vela_addon) - Manage addons for extension.
|
||||
* [vela status](vela_status) - Show status of vela application.
|
||||
* [vela delete](vela_delete) - Delete an 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.
|
||||
|
|
@ -40,6 +44,15 @@ You can also specify a remote url for app:
|
|||
|
||||
## Continuous Delivery
|
||||
|
||||
* [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.
|
||||
|
||||
There are two types of adoption supported by far, 'native' Kubernetes resources (by default) and 'helm' releases. 1. For 'native' type, you can specify a list of resources you want to adopt in the application. Only resources in local cluster are supported for now. 2. For 'helm' type, you can specify a helm release name. This helm release should be already published in the local cluster. The command will find the resources managed by the helm release and convert them into an adoption application.
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ vela addon enable [flags]
|
|||
vela addon enable <your-local-addon-path>
|
||||
Enable addon with specified args (the args should be defined in addon's parameters):
|
||||
vela addon enable <addon-name> <my-parameter-of-addon>=<my-value>
|
||||
Enable addon with specified registry:
|
||||
vela addon enable <registryName>/<addonName>
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -37,12 +39,7 @@ vela addon enable [flags]
|
|||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
-v, --version string specify the addon version to enable
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
-y, --yes all checks will be skipped and the default answer is yes for all validation check.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ non-empty new arg
|
|||
### Options
|
||||
|
||||
```
|
||||
-c, --clusters string specify the runtime-clusters to upgrade
|
||||
-h, --help help for upgrade
|
||||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
|
|
|
|||
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: vela adopt
|
||||
---
|
||||
|
||||
Adopt resources into new application
|
||||
|
||||
### Synopsis
|
||||
|
||||
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.
|
||||
|
||||
There are two types of adoption supported by far, 'native' Kubernetes resources (by default) and 'helm' releases. 1. For 'native' type, you can specify a list of resources you want to adopt in the application. Only resources in local cluster are supported for now. 2. For 'helm' type, you can specify a helm release name. This helm release should be already published in the local cluster. The command will find the resources managed by the helm release and convert them into an adoption application.
|
||||
|
||||
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 adopt [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Native Resources Adoption
|
||||
|
||||
## Adopt resources into new application
|
||||
## Use: vela adopt <resources-type>[/<resource-namespace>]/<resource-name> <resources-type>[/<resource-namespace>]/<resource-name> ...
|
||||
vela adopt deployment/my-app configmap/my-app
|
||||
|
||||
## Adopt resources into new application with specified app name
|
||||
vela adopt deployment/my-deploy configmap/my-config --app-name my-app
|
||||
|
||||
## Adopt resources into new application in specified namespace
|
||||
vela adopt deployment/my-app configmap/my-app -n demo
|
||||
|
||||
## Adopt resources into new application across multiple namespace
|
||||
vela adopt deployment/ns-1/my-app configmap/ns-2/my-app
|
||||
|
||||
## Adopt resources into new application with take-over mode
|
||||
vela adopt deployment/my-app configmap/my-app --mode take-over
|
||||
|
||||
## Adopt resources into new application and apply it into cluster
|
||||
vela adopt deployment/my-app configmap/my-app --apply
|
||||
|
||||
-----------------------------------------------------------
|
||||
|
||||
# Helm Chart Adoption
|
||||
|
||||
## Adopt resources in a deployed helm chart
|
||||
vela adopt my-chart -n my-namespace --type helm
|
||||
|
||||
## Adopt resources in a deployed helm chart with take-over mode
|
||||
vela adopt my-chart --type helm --mode take-over
|
||||
|
||||
## Adopt resources in a deployed helm chart in an application and apply it into cluster
|
||||
vela adopt my-chart --type helm --apply
|
||||
|
||||
## Adopt resources in a deployed helm chart in an application, apply it into cluster, and recycle the old helm release after the adoption application successfully runs
|
||||
vela adopt my-chart --type helm --apply --recycle
|
||||
|
||||
-----------------------------------------------------------
|
||||
|
||||
## Customize your adoption rules
|
||||
vela adopt my-chart -n my-namespace --type helm --adopt-template my-rules.cue
|
||||
```
|
||||
|
||||
### 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")
|
||||
```
|
||||
|
||||
### 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).
|
||||
|
|
@ -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: component, trait, policy, workload, scope, workflow-step
|
||||
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload, scope
|
||||
```
|
||||
|
||||
### 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: trait, policy, workload, scope, workflow-step, component
|
||||
-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
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ 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: workflow-step, component, trait, policy, workload, scope
|
||||
-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: trait, policy, workload, scope, workflow-step, component
|
||||
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: policy, workload, scope, workflow-step, component, trait
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
|||
|
|
@ -6,26 +6,55 @@ Delete an application
|
|||
|
||||
### Synopsis
|
||||
|
||||
Delete an application.
|
||||
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 delete APP_NAME1 [APP_NAME2 APP_NAME3...]
|
||||
vela delete
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela delete frontend
|
||||
# Delete an application
|
||||
vela delete my-app
|
||||
|
||||
# Delete multiple applications in a namespace
|
||||
vela delete app-1 app-2 -n example
|
||||
|
||||
# Delete all applications in one namespace
|
||||
vela delete -n example --all
|
||||
|
||||
# Delete application without waiting to be deleted
|
||||
vela delete my-app --wait=false
|
||||
|
||||
# Delete application without confirmation
|
||||
vela delete my-app -y
|
||||
|
||||
# Force delete application at client-side
|
||||
vela delete my-app -f
|
||||
|
||||
# Delete application by orphaning resources and skip recycling them
|
||||
vela delete my-app --orphan
|
||||
|
||||
# Delete application interactively
|
||||
vela delete my-app -i
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-f, --force force to delete the application
|
||||
--all delete all the application under the given namespace
|
||||
-e, --env string The environment name for the CLI request
|
||||
-f, --force force delete the application
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-w, --wait wait util the application is deleted completely
|
||||
-i, --interactive delete the application interactively
|
||||
-n, --namespace string If present, the namespace scope for this CLI request
|
||||
-o, --orphan delete the application and orphan managed resources
|
||||
-w, --wait wait util the application is deleted completely (default true)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@ Operate the Workflow during Application Delivery. Note that workflow command is
|
|||
|
||||
* [vela workflow debug](vela_workflow_debug) - Debug workflow steps
|
||||
* [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 restart](vela_workflow_restart) - Restart a workflow.
|
||||
* [vela workflow resume](vela_workflow_resume) - Resume a suspend 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 workflow.
|
||||
* [vela workflow suspend](vela_workflow_suspend) - Suspend a workflow.
|
||||
* [vela workflow terminate](vela_workflow_terminate) - Terminate a workflow.
|
||||
|
||||
#### Go Back to [CLI Commands](vela) Homepage.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow restart
|
||||
---
|
||||
|
||||
Restart an application workflow.
|
||||
Restart a workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Restart an application workflow in cluster.
|
||||
Restart a workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow restart [flags]
|
||||
|
|
@ -15,7 +15,7 @@ vela workflow restart [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
vela workflow restart <application-name>
|
||||
vela workflow restart <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
|
@ -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
|
||||
-s, --step string specify the step name in the workflow
|
||||
-t, --type string the type of the resource, support: [app, workflow]
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow resume
|
||||
---
|
||||
|
||||
Resume a suspend application workflow.
|
||||
Resume a suspend workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Resume a suspend application workflow in cluster.
|
||||
Resume a suspend workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow resume [flags]
|
||||
|
|
@ -15,7 +15,7 @@ vela workflow resume [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
vela workflow resume <application-name>
|
||||
vela workflow resume <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow suspend
|
||||
---
|
||||
|
||||
Suspend an application workflow.
|
||||
Suspend a workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Suspend an application workflow in cluster.
|
||||
Suspend a workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow suspend [flags]
|
||||
|
|
@ -15,7 +15,7 @@ vela workflow suspend [flags]
|
|||
### Examples
|
||||
|
||||
```
|
||||
vela workflow suspend <application-name>
|
||||
vela workflow suspend <workflow-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: vela workflow terminate
|
||||
---
|
||||
|
||||
Terminate an workflow.
|
||||
Terminate a workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Terminate an workflow in cluster.
|
||||
Terminate a workflow in cluster.
|
||||
|
||||
```
|
||||
vela workflow terminate [flags]
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: 内置组件列表
|
|||
|
||||
本文档将**按字典序**展示所有内置组件的参数列表。
|
||||
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-10T21:14:25+08:00。
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-13T17:08:03+08:00。
|
||||
|
||||
## Cron-Task
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: 内置策略列表
|
|||
|
||||
本文档将**按字典序**展示所有内置策略的参数列表。
|
||||
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-10T21:14:25+08:00。
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-13T17:08:03+08:00。
|
||||
|
||||
## Apply-Once
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: 内置运维特征列表
|
|||
|
||||
本文档将**按字典序**展示所有内置运维特征的参数列表。
|
||||
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-10T21:14:25+08:00。
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-13T17:08:03+08:00。
|
||||
|
||||
## Affinity
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: 内置工作流步骤列表
|
|||
|
||||
本文档将**按字典序**展示所有内置工作流步骤的参数列表。
|
||||
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-10T21:14:25+08:00。
|
||||
> 本文档由[脚本](../../contributor/cli-ref-doc)自动生成，请勿手动修改，上次更新于 2023-01-13T17:08:03+08:00。
|
||||
|
||||
## Apply-Component
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue