mirror of
https://github.com/kubevela/kubevela.git
synced 2026-08-18 20:17:04 +00:00
update vela cli docs and remove the deleted command docs
This commit is contained in:
天元
@@ -56,16 +56,8 @@
|
||||
- [vela port-forward](/en/cli/vela_port-forward.md)
|
||||
- [vela show](/en/cli/vela_show.md)
|
||||
- [vela status](/en/cli/vela_status.md)
|
||||
- [vela svc](/en/cli/vela_svc.md)
|
||||
- [vela workloads](/en/cli/vela_workloads.md)
|
||||
- [vela traits](/en/cli/vela_traits.md)
|
||||
- [vela scaler](/en/cli/vela_scaler.md)
|
||||
- [vela route](/en/cli/vela_route.md)
|
||||
- [vela autoscale](/en/cli/vela_autoscale.md)
|
||||
- [vela rollout](/en/cli/vela_rollout.md)
|
||||
- [vela metrics](/en/cli/vela_metrics.md)
|
||||
- [vela completion](/en/cli/vela_completion.md)
|
||||
- [vela dashboard](/en/cli/vela_dashboard.md)
|
||||
- [vela system](/en/cli/vela_system.md)
|
||||
- [vela template](/en/cli/vela_template.md)
|
||||
- [vela cap](/en/cli/vela_cap.md)
|
||||
|
||||
+3
-3
@@ -22,10 +22,10 @@ vela [flags]
|
||||
* [vela env](vela_env.md) - Manage environments
|
||||
* [vela exec](vela_exec.md) - Execute command in a container
|
||||
* [vela export](vela_export.md) - Export deploy manifests from appfile
|
||||
* [vela help](vela_help.md) - Help about any command
|
||||
* [vela init](vela_init.md) - Create scaffold for an application
|
||||
* [vela install](vela_install.md) - Install Vela Core with built-in capabilities
|
||||
* [vela logs](vela_logs.md) - Tail logs for application
|
||||
* [vela ls](vela_ls.md) - List services
|
||||
* [vela ls](vela_ls.md) - List applications
|
||||
* [vela port-forward](vela_port-forward.md) - Forward local ports to services in an application
|
||||
* [vela show](vela_show.md) - Show the reference doc for a workload type or trait
|
||||
* [vela status](vela_status.md) - Show status of an application
|
||||
@@ -36,4 +36,4 @@ vela [flags]
|
||||
* [vela version](vela_version.md) - Prints out build version information
|
||||
* [vela workloads](vela_workloads.md) - List workloads
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ Manage capability centers and installing/uninstalling capabilities
|
||||
* [vela cap ls](vela_cap_ls.md) - List capabilities from cap-center
|
||||
* [vela cap uninstall](vela_cap_uninstall.md) - Uninstall capability from cluster
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ Manage Capability Center with config, sync, list
|
||||
* [vela cap center remove](vela_cap_center_remove.md) - Remove specified capability center
|
||||
* [vela cap center sync](vela_cap_center_sync.md) - Sync capabilities from remote center, default to sync all centers
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela cap center config mycenter https://github.com/oam-dev/catalog/cap-center
|
||||
|
||||
* [vela cap center](vela_cap_center.md) - Manage Capability Center
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela cap center ls
|
||||
|
||||
* [vela cap center](vela_cap_center.md) - Manage Capability Center
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela cap center remove mycenter
|
||||
|
||||
* [vela cap center](vela_cap_center.md) - Manage Capability Center
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela cap center sync mycenter
|
||||
|
||||
* [vela cap center](vela_cap_center.md) - Manage Capability Center
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela cap install mycenter/route
|
||||
|
||||
* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela cap ls
|
||||
|
||||
* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela cap uninstall route
|
||||
|
||||
* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -27,4 +27,4 @@ of vela commands.
|
||||
* [vela completion bash](vela_completion_bash.md) - generate autocompletions script for bash
|
||||
* [vela completion zsh](vela_completion_zsh.md) - generate autocompletions script for zsh
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -36,4 +36,4 @@ vela completion bash
|
||||
|
||||
* [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh)
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela completion zsh
|
||||
|
||||
* [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh)
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ Manage configurations
|
||||
* [vela config ls](vela_config_ls.md) - List configs
|
||||
* [vela config set](vela_config_set.md) - Set data for a config
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela config del <config-name>
|
||||
|
||||
* [vela config](vela_config.md) - Manage configurations
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela config get <config-name>
|
||||
|
||||
* [vela config](vela_config.md) - Manage configurations
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela config ls
|
||||
|
||||
* [vela config](vela_config.md) - Manage configurations
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela config set <config-name> KEY=VALUE K2=V2
|
||||
|
||||
* [vela config](vela_config.md) - Manage configurations
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela delete frontend
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ Manage environments
|
||||
* [vela env ls](vela_env_ls.md) - List environments
|
||||
* [vela env set](vela_env_set.md) - Set an environment
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela env delete test
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -35,4 +35,4 @@ vela env init test --namespace test --email my@email.com
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela env ls [env-name]
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela env set test
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -30,4 +30,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -27,4 +27,4 @@ vela export
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
## vela help
|
||||
|
||||
Help about any command
|
||||
|
||||
```
|
||||
vela help [command]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for help
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
@@ -33,4 +33,4 @@ vela init
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
## vela install
|
||||
|
||||
Install Vela Core with built-in capabilities
|
||||
|
||||
### Synopsis
|
||||
|
||||
Install Vela Core with built-in capabilities
|
||||
|
||||
```
|
||||
vela install [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for install
|
||||
--image-pull-policy string vela core image pull policy, this will align to chart value image.pullPolicy
|
||||
--image-repo string vela core image repo, this will align to chart value image.repo
|
||||
--image-tag string vela core image repo, this will align to chart value image.tag
|
||||
-s, --set strings arguments for installing vela-core chart
|
||||
-p, --vela-chart-path string path to vela core chart to override default chart
|
||||
-w, --wait string wait until vela-core is ready to serve, default will not wait (default "0s")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
@@ -27,4 +27,4 @@ vela logs [flags]
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
## vela ls
|
||||
|
||||
List services
|
||||
List applications
|
||||
|
||||
### Synopsis
|
||||
|
||||
List services of all applications
|
||||
List all applications in cluster
|
||||
|
||||
```
|
||||
vela ls
|
||||
@@ -19,8 +19,8 @@ vela ls
|
||||
### Options
|
||||
|
||||
```
|
||||
--app string specify the name of application
|
||||
-h, --help help for ls
|
||||
-h, --help help for ls
|
||||
-n, --namespace string specify the namespace the application want to list, default is the current env namespace
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
@@ -33,4 +33,4 @@ vela ls
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -35,4 +35,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ show webservice
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela status APP_NAME
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -24,4 +24,4 @@ System management utilities
|
||||
* [vela system dry-run](vela_system_dry-run.md) - Dry Run an application, and output the conversion result to stdout
|
||||
* [vela system info](vela_system_info.md) - Show vela client and cluster chartPath
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -33,4 +33,4 @@ vela dry-run
|
||||
|
||||
* [vela system](vela_system.md) - System management utilities
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ vela system info [flags]
|
||||
|
||||
* [vela system](vela_system.md) - System management utilities
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -23,4 +23,4 @@ Manage templates
|
||||
* [vela](vela.md) -
|
||||
* [vela template context](vela_template_context.md) - Show context parameters
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -32,4 +32,4 @@ vela template context
|
||||
|
||||
* [vela template](vela_template.md) - Manage templates
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -7,7 +7,7 @@ List traits
|
||||
List traits
|
||||
|
||||
```
|
||||
vela traits [--apply-to WORKLOAD_NAME]
|
||||
vela traits
|
||||
```
|
||||
|
||||
### Examples
|
||||
@@ -19,9 +19,7 @@ vela traits
|
||||
### Options
|
||||
|
||||
```
|
||||
-r, -- Enforce refresh from cluster even if cache is not expired
|
||||
--apply-to string Workload name
|
||||
-h, --help help for traits
|
||||
-h, --help help for traits
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
@@ -34,4 +32,4 @@ vela traits
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -27,4 +27,4 @@ vela up
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -26,4 +26,4 @@ vela version [flags]
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -19,7 +19,6 @@ vela workloads
|
||||
### Options
|
||||
|
||||
```
|
||||
-r, -- Enforce refresh from cluster even if cache is not expired
|
||||
-h, --help help for workloads
|
||||
```
|
||||
|
||||
@@ -33,4 +32,4 @@ vela workloads
|
||||
|
||||
* [vela](vela.md) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 28-Jan-2021
|
||||
###### Auto generated by spf13/cobra on 20-Mar-2021
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# Ingress
|
||||
|
||||
## Description
|
||||
|
||||
Configures K8s ingress and service to enable web traffic for your service. Please use route trait in cap center for advanced usage.
|
||||
|
||||
## Specification
|
||||
|
||||
List of all configuration options for a `Ingress` trait.
|
||||
|
||||
```yaml```
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
domain | | string | true |
|
||||
http | | map[string]int | true |
|
||||
@@ -252,10 +252,9 @@ func (ref *MarkdownReference) CreateMarkdown(caps []types.Capability, baseRefPat
|
||||
}
|
||||
specification := fmt.Sprintf("\n\n## Specification\n\n%s\n\n%s", specificationIntro, specificationContent)
|
||||
|
||||
conflictWithAndMoreSection, err := ref.generateConflictWithAndMore(capName, referenceSourcePath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// it's fine if the conflict info files not found
|
||||
conflictWithAndMoreSection, _ := ref.generateConflictWithAndMore(capName, referenceSourcePath)
|
||||
|
||||
refContent = title + description + specification + refContent + conflictWithAndMoreSection
|
||||
if _, err := f.WriteString(refContent); err != nil {
|
||||
return err
|
||||
|
||||
Reference in New Issue
Block a user