diff --git a/docs/en/cli/vela.md b/docs/en/cli/vela.md index 754e0ed6a..efda13bed 100644 --- a/docs/en/cli/vela.md +++ b/docs/en/cli/vela.md @@ -19,25 +19,20 @@ vela [flags] ### SEE ALSO -* [vela autoscale](vela_autoscale.md) - Attach autoscale trait to an app -* [vela cap](vela_cap.md) - Capability Management +* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities * [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh) -* [vela config](vela_config.md) - Manage application configurations +* [vela config](vela_config.md) - Manage configurations * [vela dashboard](vela_dashboard.md) - Setup API Server and launch Dashboard -* [vela delete](vela_delete.md) - Delete Applications -* [vela env](vela_env.md) - Manage application environments -* [vela exec](vela_exec.md) - Execute a command in a container -* [vela init](vela_init.md) - Init an OAM Application -* [vela install](vela_install.md) - Initialize vela on both client and server +* [vela delete](vela_delete.md) - Delete an application +* [vela env](vela_env.md) - Manage environments +* [vela exec](vela_exec.md) - Execute command in a container +* [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 metric](vela_metric.md) - Attach metric trait to an app -* [vela port-forward](vela_port-forward.md) - Forward one or more local ports to a Pod of a service in an application -* [vela rollout](vela_rollout.md) - Attach rollout trait to an app -* [vela route](vela_route.md) - Attach route trait to an app -* [vela scaler](vela_scaler.md) - Attach scaler trait to an app -* [vela show](vela_show.md) - Get details of an application -* [vela status](vela_status.md) - get status of an application +* [vela port-forward](vela_port-forward.md) - Forward local ports to services in an application +* [vela show](vela_show.md) - Show details of an application +* [vela status](vela_status.md) - Show status of an application * [vela svc](vela_svc.md) - Manage services * [vela system](vela_system.md) - System management utilities * [vela template](vela_template.md) - Manage templates @@ -46,4 +41,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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap.md b/docs/en/cli/vela_cap.md index e8c7d6605..7221063a0 100644 --- a/docs/en/cli/vela_cap.md +++ b/docs/en/cli/vela_cap.md @@ -1,10 +1,10 @@ ## vela cap -Capability Management +Manage capability centers and installing/uninstalling capabilities ### Synopsis -Capability Management with config, list, add, remove capabilities +Manage capability centers and installing/uninstalling capabilities ### Options @@ -26,4 +26,4 @@ Capability Management with config, list, add, remove 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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_center.md b/docs/en/cli/vela_cap_center.md index 2813eefc8..e749cd00a 100644 --- a/docs/en/cli/vela_cap_center.md +++ b/docs/en/cli/vela_cap_center.md @@ -20,10 +20,10 @@ Manage Capability Center with config, sync, list ### SEE ALSO -* [vela cap](vela_cap.md) - Capability Management +* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities * [vela cap center config](vela_cap_center_config.md) - Configure (add if not exist) a capability center, default is local (built-in capabilities) * [vela cap center ls](vela_cap_center_ls.md) - List all capability centers * [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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_center_config.md b/docs/en/cli/vela_cap_center_config.md index 9b7486805..1f64d3e9a 100644 --- a/docs/en/cli/vela_cap_center_config.md +++ b/docs/en/cli/vela_cap_center_config.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_center_ls.md b/docs/en/cli/vela_cap_center_ls.md index 33a536b51..e6858721b 100644 --- a/docs/en/cli/vela_cap_center_ls.md +++ b/docs/en/cli/vela_cap_center_ls.md @@ -32,4 +32,4 @@ vela cap center ls * [vela cap center](vela_cap_center.md) - Manage Capability Center -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_center_remove.md b/docs/en/cli/vela_cap_center_remove.md index 7c2e92a84..d1413c67a 100644 --- a/docs/en/cli/vela_cap_center_remove.md +++ b/docs/en/cli/vela_cap_center_remove.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_center_sync.md b/docs/en/cli/vela_cap_center_sync.md index 9be0ca3bc..5b467b943 100644 --- a/docs/en/cli/vela_cap_center_sync.md +++ b/docs/en/cli/vela_cap_center_sync.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_install.md b/docs/en/cli/vela_cap_install.md index 26a867ce0..810bc4128 100644 --- a/docs/en/cli/vela_cap_install.md +++ b/docs/en/cli/vela_cap_install.md @@ -31,6 +31,6 @@ vela cap install mycenter/route ### SEE ALSO -* [vela cap](vela_cap.md) - Capability Management +* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_ls.md b/docs/en/cli/vela_cap_ls.md index b84a2e95a..fdd0c43b9 100644 --- a/docs/en/cli/vela_cap_ls.md +++ b/docs/en/cli/vela_cap_ls.md @@ -30,6 +30,6 @@ vela cap ls ### SEE ALSO -* [vela cap](vela_cap.md) - Capability Management +* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_cap_uninstall.md b/docs/en/cli/vela_cap_uninstall.md index 981c36294..b93ef3dda 100644 --- a/docs/en/cli/vela_cap_uninstall.md +++ b/docs/en/cli/vela_cap_uninstall.md @@ -31,6 +31,6 @@ vela cap uninstall route ### SEE ALSO -* [vela cap](vela_cap.md) - Capability Management +* [vela cap](vela_cap.md) - Manage capability centers and installing/uninstalling capabilities -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_completion.md b/docs/en/cli/vela_completion.md index eef370f99..6da7c0f59 100644 --- a/docs/en/cli/vela_completion.md +++ b/docs/en/cli/vela_completion.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_completion_bash.md b/docs/en/cli/vela_completion_bash.md index 1c4a13cc7..e0116afc5 100644 --- a/docs/en/cli/vela_completion_bash.md +++ b/docs/en/cli/vela_completion_bash.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_completion_zsh.md b/docs/en/cli/vela_completion_zsh.md index e01663eff..f2947ca07 100644 --- a/docs/en/cli/vela_completion_zsh.md +++ b/docs/en/cli/vela_completion_zsh.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_config.md b/docs/en/cli/vela_config.md index ce6e69988..d79c8c336 100644 --- a/docs/en/cli/vela_config.md +++ b/docs/en/cli/vela_config.md @@ -1,10 +1,10 @@ ## vela config -Manage application configurations +Manage configurations ### Synopsis -Manage application configurations under given env +Manage configurations ### Options @@ -26,4 +26,4 @@ Manage application configurations under given env * [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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_config_del.md b/docs/en/cli/vela_config_del.md index bbff744cd..8e7ea3eac 100644 --- a/docs/en/cli/vela_config_del.md +++ b/docs/en/cli/vela_config_del.md @@ -30,6 +30,6 @@ vela config del ### SEE ALSO -* [vela config](vela_config.md) - Manage application configurations +* [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_config_get.md b/docs/en/cli/vela_config_get.md index 605ef3d64..b20663718 100644 --- a/docs/en/cli/vela_config_get.md +++ b/docs/en/cli/vela_config_get.md @@ -30,6 +30,6 @@ vela config get ### SEE ALSO -* [vela config](vela_config.md) - Manage application configurations +* [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_config_ls.md b/docs/en/cli/vela_config_ls.md index 0a7e1af46..591a8aef1 100644 --- a/docs/en/cli/vela_config_ls.md +++ b/docs/en/cli/vela_config_ls.md @@ -30,6 +30,6 @@ vela config ls ### SEE ALSO -* [vela config](vela_config.md) - Manage application configurations +* [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_config_set.md b/docs/en/cli/vela_config_set.md index 08b969622..53dfabf28 100644 --- a/docs/en/cli/vela_config_set.md +++ b/docs/en/cli/vela_config_set.md @@ -30,6 +30,6 @@ vela config set KEY=VALUE K2=V2 ### SEE ALSO -* [vela config](vela_config.md) - Manage application configurations +* [vela config](vela_config.md) - Manage configurations -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_dashboard.md b/docs/en/cli/vela_dashboard.md index e19182bf4..20a1b0d01 100644 --- a/docs/en/cli/vela_dashboard.md +++ b/docs/en/cli/vela_dashboard.md @@ -38,4 +38,4 @@ dashboard * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_delete.md b/docs/en/cli/vela_delete.md index 4c5409e52..4663db756 100644 --- a/docs/en/cli/vela_delete.md +++ b/docs/en/cli/vela_delete.md @@ -1,13 +1,13 @@ ## vela delete -Delete Applications +Delete an application ### Synopsis -Delete Applications +Delete an application ``` -vela delete +vela delete APP_NAME ``` ### Examples @@ -33,4 +33,4 @@ vela delete frontend * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_env.md b/docs/en/cli/vela_env.md index 88eb60a74..59d578d81 100644 --- a/docs/en/cli/vela_env.md +++ b/docs/en/cli/vela_env.md @@ -1,10 +1,10 @@ ## vela env -Manage application environments +Manage environments ### Synopsis -Manage application environments +Manage environments ### Options @@ -26,4 +26,4 @@ Manage application 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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_env_delete.md b/docs/en/cli/vela_env_delete.md index 800016aac..12c3fdb3f 100644 --- a/docs/en/cli/vela_env_delete.md +++ b/docs/en/cli/vela_env_delete.md @@ -30,6 +30,6 @@ vela env delete test ### SEE ALSO -* [vela env](vela_env.md) - Manage application environments +* [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_env_init.md b/docs/en/cli/vela_env_init.md index 00a4d62ac..692ec964d 100644 --- a/docs/en/cli/vela_env_init.md +++ b/docs/en/cli/vela_env_init.md @@ -34,6 +34,6 @@ vela env init test --namespace test --email my@email.com ### SEE ALSO -* [vela env](vela_env.md) - Manage application environments +* [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_env_ls.md b/docs/en/cli/vela_env_ls.md index 5b49c1c23..14ecb29e6 100644 --- a/docs/en/cli/vela_env_ls.md +++ b/docs/en/cli/vela_env_ls.md @@ -30,6 +30,6 @@ vela env ls [env-name] ### SEE ALSO -* [vela env](vela_env.md) - Manage application environments +* [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_env_set.md b/docs/en/cli/vela_env_set.md index 2d0c52346..3cb008a81 100644 --- a/docs/en/cli/vela_env_set.md +++ b/docs/en/cli/vela_env_set.md @@ -30,6 +30,6 @@ vela env set test ### SEE ALSO -* [vela env](vela_env.md) - Manage application environments +* [vela env](vela_env.md) - Manage environments -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_exec.md b/docs/en/cli/vela_exec.md index 1e5e11482..538c50a38 100644 --- a/docs/en/cli/vela_exec.md +++ b/docs/en/cli/vela_exec.md @@ -1,13 +1,13 @@ ## vela exec -Execute a command in a container +Execute command in a container ### Synopsis -Execute a command in the 1st container of specific Application => Service => (1st)Pod +Execute command in a container ``` -vela exec [flags] AppName -- COMMAND [args...] +vela exec [flags] APP_NAME -- COMMAND [args...] ``` ### Options @@ -29,4 +29,4 @@ vela exec [flags] AppName -- COMMAND [args...] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_init.md b/docs/en/cli/vela_init.md index 5aaabebf9..23febc874 100644 --- a/docs/en/cli/vela_init.md +++ b/docs/en/cli/vela_init.md @@ -1,10 +1,10 @@ ## vela init -Init an OAM Application +Create scaffold for an application ### Synopsis -Init an OAM Application by one command +Create scaffold for an application ``` vela init @@ -33,4 +33,4 @@ vela init * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_install.md b/docs/en/cli/vela_install.md index c8d1ccb83..adc2f2085 100644 --- a/docs/en/cli/vela_install.md +++ b/docs/en/cli/vela_install.md @@ -1,10 +1,10 @@ ## vela install -Initialize vela on both client and server +Install Vela Core with built-in capabilities ### Synopsis -Install OAM runtime and vela builtin capabilities. +Install Vela Core with built-in capabilities ``` vela install [flags] @@ -18,7 +18,7 @@ vela install [flags] --image-repo string vela core image repo, this will align to chart value image.repo (default "oamdev/vela-core") --image-tag string vela core image repo, this will align to chart value image.tag (default "latest") -p, --vela-chart-path string path to vela core chart to override default chart - -w, --wait wait until vela-core is ready to serve + -w, --wait string wait until vela-core is ready to serve, default will not wait (default "0s") ``` ### Options inherited from parent commands @@ -31,4 +31,4 @@ vela install [flags] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_logs.md b/docs/en/cli/vela_logs.md index 4dbb5e5c2..86f7503a8 100644 --- a/docs/en/cli/vela_logs.md +++ b/docs/en/cli/vela_logs.md @@ -27,4 +27,4 @@ vela logs [flags] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_ls.md b/docs/en/cli/vela_ls.md index 953d2a491..0985b8c99 100644 --- a/docs/en/cli/vela_ls.md +++ b/docs/en/cli/vela_ls.md @@ -4,7 +4,7 @@ List services ### Synopsis -List services with their application, type, traits, status and created time, etc. +List services of all applications ``` vela ls @@ -33,4 +33,4 @@ vela ls * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_port-forward.md b/docs/en/cli/vela_port-forward.md index 44acb3604..633896ff4 100644 --- a/docs/en/cli/vela_port-forward.md +++ b/docs/en/cli/vela_port-forward.md @@ -1,10 +1,10 @@ ## vela port-forward -Forward one or more local ports to a Pod of a service in an application +Forward local ports to services in an application ### Synopsis -Forward one or more local ports to a Pod of a service in an application +Forward local ports to services in an application ``` vela port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags] @@ -16,6 +16,7 @@ vela port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N: --address strings Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, vela will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind. (default [localhost]) -h, --help help for port-forward --pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 1m0s) + --route forward ports from route trait service ``` ### Options inherited from parent commands @@ -28,4 +29,4 @@ vela port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N: * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_show.md b/docs/en/cli/vela_show.md index 5f838c83c..6857c9a3f 100644 --- a/docs/en/cli/vela_show.md +++ b/docs/en/cli/vela_show.md @@ -1,19 +1,19 @@ ## vela show -Get details of an application +Show details of an application ### Synopsis -Get details of an application +Show details of an application ``` -vela show [flags] +vela show APP_NAME [flags] ``` ### Examples ``` -vela show +vela show APP_NAME ``` ### Options @@ -33,4 +33,4 @@ vela show * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_status.md b/docs/en/cli/vela_status.md index e7c024fec..d0bab0f18 100644 --- a/docs/en/cli/vela_status.md +++ b/docs/en/cli/vela_status.md @@ -1,19 +1,19 @@ ## vela status -get status of an application +Show status of an application ### Synopsis -get status of an application, including workloads and traits of each service. +Show status of an application, including workloads and traits of each service. ``` -vela status [flags] +vela status APP_NAME [flags] ``` ### Examples ``` -vela status +vela status APP_NAME ``` ### Options @@ -33,4 +33,4 @@ vela status * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_svc.md b/docs/en/cli/vela_svc.md index 914822e8c..0c648c0f0 100644 --- a/docs/en/cli/vela_svc.md +++ b/docs/en/cli/vela_svc.md @@ -24,4 +24,4 @@ Manage services * [vela](vela.md) - * [vela svc deploy](vela_svc_deploy.md) - Initialize and run a service -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_svc_deploy.md b/docs/en/cli/vela_svc_deploy.md index c546bf10e..55db71f06 100644 --- a/docs/en/cli/vela_svc_deploy.md +++ b/docs/en/cli/vela_svc_deploy.md @@ -35,4 +35,4 @@ vela svc deploy -t * [vela svc](vela_svc.md) - Manage services -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_system.md b/docs/en/cli/vela_system.md index c35d464f8..acb9e3762 100644 --- a/docs/en/cli/vela_system.md +++ b/docs/en/cli/vela_system.md @@ -23,4 +23,4 @@ System management utilities * [vela](vela.md) - * [vela system info](vela_system_info.md) - Show vela client and cluster chartPath -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_system_info.md b/docs/en/cli/vela_system_info.md index 184af355c..9ce44d55a 100644 --- a/docs/en/cli/vela_system_info.md +++ b/docs/en/cli/vela_system_info.md @@ -26,4 +26,4 @@ vela system info [flags] * [vela system](vela_system.md) - System management utilities -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_template.md b/docs/en/cli/vela_template.md index 54d6783f5..b8318f34a 100644 --- a/docs/en/cli/vela_template.md +++ b/docs/en/cli/vela_template.md @@ -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 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_template_context.md b/docs/en/cli/vela_template_context.md index e24352318..9badbb881 100644 --- a/docs/en/cli/vela_template_context.md +++ b/docs/en/cli/vela_template_context.md @@ -32,4 +32,4 @@ vela template context * [vela template](vela_template.md) - Manage templates -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_traits.md b/docs/en/cli/vela_traits.md index 4fa10a9c2..98c6897b5 100644 --- a/docs/en/cli/vela_traits.md +++ b/docs/en/cli/vela_traits.md @@ -7,7 +7,7 @@ List traits List traits ``` -vela traits [--apply-to WORKLOADNAME] +vela traits [--apply-to WORKLOAD_NAME] ``` ### Examples @@ -34,4 +34,4 @@ vela traits * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_up.md b/docs/en/cli/vela_up.md index 1488a6e0c..8bcc675c4 100644 --- a/docs/en/cli/vela_up.md +++ b/docs/en/cli/vela_up.md @@ -4,7 +4,7 @@ Apply an appfile ### Synopsis -Apply an appfile, by default vela.yaml +Apply an appfile ``` vela up @@ -27,4 +27,4 @@ vela up * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_version.md b/docs/en/cli/vela_version.md index cd5a3bc70..0d19aa23d 100644 --- a/docs/en/cli/vela_version.md +++ b/docs/en/cli/vela_version.md @@ -26,4 +26,4 @@ vela version [flags] * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/cli/vela_workloads.md b/docs/en/cli/vela_workloads.md index 4cbfcac8b..fe9083e25 100644 --- a/docs/en/cli/vela_workloads.md +++ b/docs/en/cli/vela_workloads.md @@ -33,4 +33,4 @@ vela workloads * [vela](vela.md) - -###### Auto generated by spf13/cobra on 12-Nov-2020 +###### Auto generated by spf13/cobra on 13-Nov-2020 diff --git a/docs/en/platform-engineers/workload-type.md b/docs/en/platform-engineers/workload-type.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/pkg/commands/capability.go b/pkg/commands/capability.go index 53defc039..257884fbe 100644 --- a/pkg/commands/capability.go +++ b/pkg/commands/capability.go @@ -19,8 +19,8 @@ import ( func CapabilityCommandGroup(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command { cmd := &cobra.Command{ Use: "cap", - Short: "Capability Management", - Long: "Capability Management with config, list, add, remove capabilities", + Short: "Manage capability centers and installing/uninstalling capabilities", + Long: "Manage capability centers and installing/uninstalling capabilities", Annotations: map[string]string{ types.TagCommandType: types.TypeCap, }, diff --git a/pkg/commands/config.go b/pkg/commands/config.go index 1e884369a..e6ef48afc 100644 --- a/pkg/commands/config.go +++ b/pkg/commands/config.go @@ -24,8 +24,8 @@ func NewConfigCommand(args types.Args, io cmdutil.IOStreams) *cobra.Command { cmd := &cobra.Command{ Use: "config", DisableFlagsInUseLine: true, - Short: "Manage application configurations", - Long: "Manage application configurations under given env", + Short: "Manage configurations", + Long: "Manage configurations", Annotations: map[string]string{ types.TagCommandType: types.TypeApp, }, diff --git a/pkg/commands/delete.go b/pkg/commands/delete.go index 49b7a0051..dcd0f4193 100644 --- a/pkg/commands/delete.go +++ b/pkg/commands/delete.go @@ -17,8 +17,8 @@ func NewDeleteCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command cmd := &cobra.Command{ Use: "delete APP_NAME", DisableFlagsInUseLine: true, - Short: "Delete Applications", - Long: "Delete Applications", + Short: "Delete an application", + Long: "Delete an application", Annotations: map[string]string{ types.TagCommandType: types.TypeApp, }, diff --git a/pkg/commands/env.go b/pkg/commands/env.go index f0fffae7b..e60ca27f8 100644 --- a/pkg/commands/env.go +++ b/pkg/commands/env.go @@ -19,8 +19,8 @@ func NewEnvCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command { cmd := &cobra.Command{ Use: "env", DisableFlagsInUseLine: true, - Short: "Manage application environments", - Long: "Manage application environments", + Short: "Manage environments", + Long: "Manage environments", Annotations: map[string]string{ types.TagCommandType: types.TypeApp, }, diff --git a/pkg/commands/exec.go b/pkg/commands/exec.go index 84079aa1a..cdb44fa91 100644 --- a/pkg/commands/exec.go +++ b/pkg/commands/exec.go @@ -60,8 +60,8 @@ func NewExecCommand(c types.Args, ioStreams velacmdutil.IOStreams) *cobra.Comman } cmd := &cobra.Command{ Use: "exec [flags] APP_NAME -- COMMAND [args...]", - Short: "Execute a command in a container", - Long: "Execute a command in the 1st container of specific Application => Service => (1st)Pod", + Short: "Execute command in a container", + Long: "Execute command in a container", RunE: func(cmd *cobra.Command, args []string) error { if len(args) < 1 { ioStreams.Error("Please specify an application name.") diff --git a/pkg/commands/init.go b/pkg/commands/init.go index 829fc966c..ceb0fecd9 100644 --- a/pkg/commands/init.go +++ b/pkg/commands/init.go @@ -40,8 +40,8 @@ func NewInitCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command { cmd := &cobra.Command{ Use: "init", DisableFlagsInUseLine: true, - Short: "Init an OAM Application", - Long: "Init an OAM Application by one command", + Short: "Create scaffold for an application", + Long: "Create scaffold for an application", Example: "vela init", RunE: func(cmd *cobra.Command, args []string) error { newClient, err := client.New(c.Config, client.Options{Scheme: c.Schema}) diff --git a/pkg/commands/ls.go b/pkg/commands/ls.go index 1b4e15532..45d4ea683 100644 --- a/pkg/commands/ls.go +++ b/pkg/commands/ls.go @@ -26,7 +26,7 @@ func NewListCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Command { Aliases: []string{"list"}, DisableFlagsInUseLine: true, Short: "List services", - Long: "List services with their application, type, traits, status and created time, etc.", + Long: "List services of all applications", Example: `vela ls`, RunE: func(cmd *cobra.Command, args []string) error { env, err := GetEnv(cmd) diff --git a/pkg/commands/portforward.go b/pkg/commands/portforward.go index 7f5ed1298..7a32f3fe1 100644 --- a/pkg/commands/portforward.go +++ b/pkg/commands/portforward.go @@ -61,8 +61,8 @@ func NewPortForwardCommand(c types.Args, ioStreams velacmdutil.IOStreams) *cobra cmd := &cobra.Command{ Use: "port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]", - Short: "Forward one or more local ports to a Pod of a service in an application", - Long: "Forward one or more local ports to a Pod of a service in an application", + Short: "Forward local ports to services in an application", + Long: "Forward local ports to services in an application", RunE: func(cmd *cobra.Command, args []string) error { if len(args) < 1 { ioStreams.Error("Please specify application name.") diff --git a/pkg/commands/show.go b/pkg/commands/show.go index 5502aba42..bcc5769ef 100644 --- a/pkg/commands/show.go +++ b/pkg/commands/show.go @@ -16,8 +16,8 @@ import ( func NewAppShowCommand(ioStreams cmdutil.IOStreams) *cobra.Command { cmd := &cobra.Command{ Use: "show APP_NAME", - Short: "Get details of an application", - Long: "Get details of an application", + Short: "Show details of an application", + Long: "Show details of an application", Example: `vela show APP_NAME`, RunE: func(cmd *cobra.Command, args []string) error { argsLength := len(args) diff --git a/pkg/commands/status.go b/pkg/commands/status.go index 037972c15..d70172be0 100644 --- a/pkg/commands/status.go +++ b/pkg/commands/status.go @@ -106,8 +106,8 @@ func NewAppStatusCommand(c types.Args, ioStreams cmdutil.IOStreams) *cobra.Comma ctx := context.Background() cmd := &cobra.Command{ Use: "status APP_NAME", - Short: "Get status of an application", - Long: "Get status of an application, including workloads and traits of each service.", + Short: "Show status of an application", + Long: "Show status of an application, including workloads and traits of each service.", Example: `vela status APP_NAME`, RunE: func(cmd *cobra.Command, args []string) error { argsLength := len(args) diff --git a/pkg/commands/system.go b/pkg/commands/system.go index 63b0d6837..f664d785d 100644 --- a/pkg/commands/system.go +++ b/pkg/commands/system.go @@ -98,8 +98,8 @@ func NewInstallCommand(c types.Args, chartContent string, ioStreams cmdutil.IOSt i := &initCmd{ioStreams: ioStreams} cmd := &cobra.Command{ Use: "install", - Short: "Initialize vela on both client and server", - Long: "Install OAM runtime and vela builtin capabilities.", + Short: "Install Vela Core with built-in capabilities", + Long: "Install Vela Core with built-in capabilities", RunE: func(cmd *cobra.Command, args []string) error { newClient, err := client.New(c.Config, client.Options{Scheme: c.Schema}) if err != nil { diff --git a/pkg/commands/up.go b/pkg/commands/up.go index d1f51426b..606f98da6 100644 --- a/pkg/commands/up.go +++ b/pkg/commands/up.go @@ -36,7 +36,7 @@ func NewUpCommand(c types.Args, ioStream cmdutil.IOStreams) *cobra.Command { Use: "up", DisableFlagsInUseLine: true, Short: "Apply an appfile", - Long: "Apply an appfile, by default vela.yaml", + Long: "Apply an appfile", Annotations: map[string]string{ types.TagCommandType: types.TypeStart, },