Feat: add reference documents about the traefik addon (#641)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-04-29 17:03:09 +08:00 committed by GitHub
parent 5f1df0cf55
commit 8b13e0af8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
170 changed files with 1381 additions and 186 deletions

View File

@ -4,4 +4,5 @@ title: Built-in Addons
* [VelaUX](./velaux): The KubeVela User Experience (UX ) addon. It will launch a dashboard and an APIServer for better user experience.
* [Addon Cloud Resources](./terraform): Provide a bunch of addons to provision cloud resources for different cloud providers.
* [Machine Learning Addon](./ai): Machine learning addon is divided into model-training addon and model-serving addon.
* [Machine Learning Addon](./ai): Machine learning addon is divided into model-training addon and model-serving addon.
* [Traefik](./traefik): Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.

View File

@ -0,0 +1,158 @@
---
title: Traefik
---
Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. you can use this addon as a cluster gateway or a microservices gateway.
## XDefinitions
### http-route(trait)
defines HTTP rules for mapping requests from a Gateway to Application.
#### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayName | Specify the gateway name | string | false | traefik-gateway
listenerName | Specify the listener name of the gateway | string | false | web
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
port | Specify the service port of component. | int | true |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
### https-route(trait)
defines HTTPS rules for mapping requests from a Gateway to Application.
#### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
secrets | Specify the TLS secrets | [[]secrets](#secrets) | true |
TLSPort | | int | true | 443
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
port | Specify the service port of component. | int | true |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
##### secrets
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
namespace | | string | false |
### tcp-route(trait)
defines TCP rules for mapping requests from a Gateway to Application.
#### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
rules | Specify the TCP matchers | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayPort | Specify the gateway listener port | int | true |
port | Specify the service port of component. | int | true |
serviceName | Specify the service name of component, the default is component name. | string | false |
### config-tls-certificate(config)
This component definition is designed to manage the TLS certificate
#### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
cert | the certificate public key encrypted by base64 | string | true |
key | the certificate private key encrypted by base64 | string | true |
## Install
```bash
vela addon enable traefik
```
### Visit Traefik dashboard by port-forward
Port forward will work as a proxy to allow visiting Traefik dashboard by local port.
```bash
vela port-forward -n vela-system addon-traefik
```
expected output:
```
Forwarding from 127.0.0.1:9000 -> 9000
Forwarding from [::1]:9000 -> 9000
Forward successfully! Opening browser ...
Handling connection for 9000
```
You can visiting Traefik dashboard with address `http://127.0.0.1:9000/dashboard/`.
### Setup with Specified Service Type
If your cluster has cloud LoadBalancer available:
```bash
vela addon enable traefik serviceType=LoadBalancer
```

View File

@ -0,0 +1,159 @@
---
title: Traefik
---
Traefik 是一个现代化且易用的 HTTP 反向代理和负载均衡服务,用于部署微服务。你可以使用该插件作为你的集群网关活着微服务系统的网关。
## XDefinitions
### http-route(trait)
基于 HTTP 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayName | Specify the gateway name | string | false | traefik-gateway
listenerName | Specify the listener name of the gateway | string | false | web
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
port | Specify the service port of component. | int | true |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
### https-route(trait)
基于 HTTPS 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
secrets | Specify the TLS secrets | [[]secrets](#secrets) | true |
TLSPort | | int | true | 443
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
port | Specify the service port of component. | int | true |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
##### secrets
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
namespace | | string | false |
### tcp-route(trait)
基于四层的 TCP 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
rules | Specify the TCP matchers | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayPort | Specify the gateway listener port | int | true |
port | Specify the service port of component. | int | true |
serviceName | Specify the service name of component, the default is component name. | string | false |
### config-tls-certificate(config)
用于扩展集成配置的选项,支持用户配置 TLS 证书用于上述 HTTPs规则。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
cert | the certificate public key encrypted by base64 | string | true |
key | the certificate private key encrypted by base64 | string | true |
## 插件安装
```bash
vela addon enable traefik
```
### 访问 Traefik 的 UI
默认安装情况下 Traefik 无法直接访问,可通过 port-forward 进行本地代理,这仅适用于调试阶段。
```bash
vela port-forward -n vela-system addon-traefik
```
expected output:
```
Forwarding from 127.0.0.1:9000 -> 9000
Forwarding from [::1]:9000 -> 9000
Forward successfully! Opening browser ...
Handling connection for 9000
```
你可以通过 `http://127.0.0.1:9000/dashboard/` 地址访问到 Traefik 的 UI 可视化面板。
### 设置网关流量接入方式
如果你使用云上的集群,使用 LoadBalancer 暴露 Traefik 的访问入口是最佳方案。
```bash
vela addon enable traefik serviceType=LoadBalancer
```
如果在自建集群,需要根据你是作为集群网关还是应用网关来选择流量接入方式。

View File

@ -7,7 +7,13 @@ title: CLI Commands
* [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Create or update vela application from file or URL, both appfile or application object format are supported.
* [vela up](vela_up) - Deploy one application
Deploy one application based on local files or re-deploy an existing application. With the -n/--namespace flag, you can choose the location of the target application.
To apply application from file, use the -f/--file flag to specify the application file location.
To give a particular version to this deploy, use the -v/--publish-version flag. When you are deploying an existing application, the version name must be different from the current name. You can also use a history revision for the deploy and override the current application by using the -r/--revision flag.
* [vela show](vela_show) - Show the reference doc for component, trait or workflow types.
## Managing Applications
@ -18,8 +24,9 @@ title: CLI Commands
* [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela logs](vela_logs) - Tail logs for vela application.
* [vela live-diff](vela_live-diff) - Dry-run application locally, and diff with a deployed application version.
* [vela live-diff](vela_live-diff) - Compare application and revisions
* [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout.
* [vela revision](vela_revision) - Manage KubeVela Application Revisions
## Continuous Delivery
@ -32,6 +39,7 @@ title: CLI Commands
* [vela uischema](vela_uischema) - Manage UI schema for addons.
* [vela def](vela_def) - Manage X-Definitions for extension.
* [vela registry](vela_registry) - Manage Registry of X-Definitions for extension.
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
* [vela component](vela_component) - List component types installed and discover more in registry.
* [vela trait](vela_trait) - List trait types installed and discover more in registry.

View File

@ -33,4 +33,4 @@ Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -21,7 +21,8 @@ vela addon disable <addon-name>
### Options
```
-h, --help help for disable
-f, --force skip checking if applications are still using this addon
-h, --help help for disable
```
### Options inherited from parent commands
@ -37,4 +38,4 @@ vela addon disable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -15,13 +15,22 @@ vela addon enable [flags]
### Examples
```
vela addon enable <addon-name>
\
Enable addon by:
vela addon enable <addon-name>
Enable addon with specify version:
vela addon enable <addon-name> --version <addon-version>
Enable addon for specific clusters, (local means control plane):
vela addon enable <addon-name> --clusters={local,cluster1,cluster2}
```
### Options
```
-h, --help help for enable
-c, --clusters string specify the runtime-clusters to enable
-h, --help help for enable
-v, --version string specify the addon version to enable
```
### Options inherited from parent commands
@ -37,4 +46,4 @@ vela addon enable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela addon list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ vela addon registry add [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry delete <registry-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry get <registry name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry list
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon status <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -15,13 +15,21 @@ vela addon upgrade [flags]
### Examples
```
vela addon upgrade <addon-name>
\
Upgrade addon by:
vela addon upgrade <addon-name>
Upgrade addon with specify version:
vela addon upgrade <addon-name> --version <addon-version>
Upgrade addon for specific clusters, (local means control plane):
vela addon upgrade <addon-name> --clusters={local,cluster1,cluster2}
```
### Options
```
-h, --help help for upgrade
-h, --help help for upgrade
-v, --version string specify the addon version to upgrade
```
### Options inherited from parent commands
@ -37,4 +45,4 @@ vela addon upgrade <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -23,8 +23,10 @@ Manage Kubernetes Clusters for Continuous Delivery.
### SEE ALSO
* [vela cluster alias](vela_cluster_alias) - alias a named cluster.
* [vela cluster detach](vela_cluster_detach) - detach managed cluster.
* [vela cluster join](vela_cluster_join) - join managed cluster.
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
* [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster probe](vela_cluster_probe) - health probe managed cluster.
* [vela cluster rename](vela_cluster_rename) - rename managed cluster.
@ -32,4 +34,4 @@ Manage Kubernetes Clusters for Continuous Delivery.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,34 @@
---
title: vela cluster alias
---
alias a named cluster.
### Synopsis
alias a named cluster.
```
vela cluster alias CLUSTER_NAME ALIAS [flags]
```
### Options
```
-h, --help help for alias
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ vela cluster detach [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -22,8 +22,8 @@ vela cluster join [KUBECONFIG] [flags]
### Options
```
--create-namespace string Specifies the namespace need to create in managedCluster
-t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty.
--create-namespace string Specifies the namespace need to create in managedCluster (default "vela-system")
-t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty. (default "cluster-gateway")
-h, --help help for join
--in-cluster-boostrap If true, the registering managed cluster will use the internal endpoint prescribed in the hub cluster's configmap "kube-public/cluster-info to register "itself to the hub cluster. Otherwise use the original endpoint from the hub kubeconfig. (default true)
-n, --name string Specify the cluster name. If empty, it will use the cluster name in config file. Default to be empty.
@ -42,4 +42,4 @@ vela cluster join [KUBECONFIG] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,32 @@
---
title: vela cluster labels
---
Manage Kubernetes Cluster Labels
### Synopsis
Manage Kubernetes Cluster Labels for Continuous Delivery.
### Options
```
-h, --help help for labels
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster labels add](vela_cluster_labels_add) - add labels to managed cluster
* [vela cluster labels del](vela_cluster_labels_del) - delete labels for managed cluster
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,40 @@
---
title: vela cluster labels add
---
add labels to managed cluster
### Synopsis
add labels to managed cluster
```
vela cluster labels add CLUSTER_NAME LABELS [flags]
```
### Examples
```
vela cluster labels add my-cluster project=kubevela,owner=oam-dev
```
### Options
```
-h, --help help for add
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,40 @@
---
title: vela cluster labels del
---
delete labels for managed cluster
### Synopsis
delete labels for managed cluster
```
vela cluster labels del CLUSTER_NAME LABELS [flags]
```
### Examples
```
vela cluster labels del my-cluster project,owner
```
### Options
```
-h, --help help for del
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela cluster list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela cluster probe [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,4 @@ The shell code must be evaluated to provide interactive completion of vela comma
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -41,4 +41,4 @@ vela completion bash
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -38,4 +38,4 @@ vela completion zsh
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -43,4 +43,4 @@ vela comp
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -40,4 +40,4 @@ vela comp get <component>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,44 @@
---
title: vela debug
---
Debug running application
### Synopsis
Debug running application with debug policy.
```
vela debug [flags]
```
### Examples
```
vela debug <application-name>
```
### Options
```
-e, --env string specify environment name for application
-f, --focus string specify the focus value to debug
-h, --help help for debug
-n, --namespace string specify the Kubernetes namespace to use
-s, --step string specify the step to debug
```
### 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).

View File

@ -27,6 +27,7 @@ Manage X-Definitions for extension.
* [vela def del](vela_def_del) - Delete X-Definition.
* [vela def doc-gen](vela_def_doc-gen) - Generate documentation of definitions (Only Terraform typed definitions are supported)
* [vela def edit](vela_def_edit) - Edit X-Definition.
* [vela def gen-api](vela_def_gen-api) - Generate Go struct of Parameter from X-Definition.
* [vela def get](vela_def_get) - Get definition
* [vela def init](vela_def_init) - Init a new definition
* [vela def list](vela_def_list) - List definitions.
@ -36,4 +37,4 @@ Manage X-Definitions for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -43,4 +43,4 @@ vela def apply DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -24,7 +24,7 @@ vela def del DEFINITION_NAME [flags]
```
-h, --help help for del
-n, --namespace string Specify which namespace the definition locates.
-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: component, trait, policy, workload, scope, workflow-step
```
### Options inherited from parent commands
@ -40,4 +40,4 @@ vela def del DEFINITION_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -17,6 +17,8 @@ vela def doc-gen NAME [flags]
```
1. Generate documentation for ComponentDefinition alibaba-vpc:
> vela def doc-gen alibaba-vpc -n vela-system
2. Generate documentation for local ComponentDefinition file alibaba-vpc.yaml:
> vela def doc-gen alibaba-vpc.yaml
```
@ -40,4 +42,4 @@ vela def doc-gen NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -43,4 +43,4 @@ vela def edit NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,45 @@
---
title: vela def gen-api
---
Generate Go struct of Parameter from X-Definition.
### Synopsis
Generate Go struct of Parameter from definition file.
* Currently, this function is still working in progress and not all formats of parameter in X-definition are supported yet.
```
vela def gen-api DEFINITION.cue [flags]
```
### Examples
```
# Command below will generate the Go struct for the my-def.cue file.
> vela def gen-api my-def.cue
```
### Options
```
-h, --help help for gen-api
--package-name string Specify the package name in generated Go code. (default "main")
--prefix string Specify the prefix of the generated Go struct.
--skip-package-name Skip package name in generated Go code.
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela def](vela_def) - Manage Definitions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -26,7 +26,7 @@ vela def get NAME [flags]
```
-h, --help help for get
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-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: policy, workload, scope, workflow-step, component, trait
```
### Options inherited from parent commands
@ -42,4 +42,4 @@ vela def get NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -58,4 +58,4 @@ vela def init DEF_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -26,7 +26,7 @@ vela def list [flags]
```
-h, --help help for list
-n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched.
-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
-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
@ -42,4 +42,4 @@ vela def list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -43,4 +43,4 @@ vela def render DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela def vet DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ vela delete frontend
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -41,4 +41,4 @@ vela dry-run
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela env delete test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -38,4 +38,4 @@ vela env init test --namespace test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela env ls [env-name]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela env set test
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -49,4 +49,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -34,4 +34,4 @@ vela export
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -27,4 +27,4 @@ vela help [command]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -40,4 +40,4 @@ vela init
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela install [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -2,11 +2,11 @@
title: vela live-diff
---
Dry-run application locally, and diff with a deployed application version
Compare application and revisions
### Synopsis
Dry-run application locally, and diff with a deployed application version.
Compare application and revisions
```
vela live-diff
@ -15,19 +15,26 @@ vela live-diff
### Examples
```
vela live-diff -f app-v2.yaml -r app-v1 --context 10
# compare the current application and the running revision
> vela live-diff my-app
# compare the current application and the specified revision
> vela live-diff my-app --revision my-app-v1
# compare two application revisions
> vela live-diff --revision my-app-v1,my-app-v2
# compare the application file and the specified revision
> vela live-diff -f my-app.yaml -r my-app-v1 --context 10
```
### Options
```
-r, --Revision string specify an application Revision name, by default, it will compare with the latest Revision
-c, --context int output number lines of context around changes, by default show all unchanged lines (default -1)
-d, --definition string specify a file or directory containing capability definitions, they will only be used in dry-run rather than applied to K8s cluster
-e, --env string specify environment name for application
-f, --file string application file name (default "./app.yaml")
-f, --file string application file name
-h, --help help for live-diff
-n, --namespace string specify the Kubernetes namespace to use
-r, --revision string specify one or two application revision name(s), by default, it will compare with the latest revision
```
### Options inherited from parent commands
@ -43,4 +50,4 @@ vela live-diff -f app-v2.yaml -r app-v1 --context 10
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -18,6 +18,7 @@ vela logs APP_NAME [flags]
-c, --container string specify container name for output
-e, --env string specify environment name for application
-h, --help help for logs
--name string specify resource name for output
-n, --namespace string specify the Kubernetes namespace to use
-o, --output string output format for logs, support: [default, raw, json] (default "default")
```
@ -35,4 +36,4 @@ vela logs APP_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -40,4 +40,4 @@ vela ls
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,31 @@
---
title: vela provider
---
Authenticate Terraform Cloud Providers
### Synopsis
Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
### Options
```
-h, --help help for provider
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider list](vela_provider_list) - List Terraform Cloud Providers
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,34 @@
---
title: vela provider list
---
List Terraform Cloud Providers
### Synopsis
List Terraform Cloud Providers
```
vela provider list [flags]
```
### Options
```
-h, --help help for list
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -30,4 +30,4 @@ Manage Registry of X-Definitions for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -15,7 +15,7 @@ vela registry config <registryName> <centerURL> [flags]
### Examples
```
vela registry config my-registry https://github.com/kubevela/catalog/tree/master/registry
vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/registry
```
### Options
@ -38,4 +38,4 @@ vela registry config my-registry https://github.com/kubevela/catalog/tree/master
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela registry ls
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela registry remove mycenter
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,31 @@
---
title: vela revision
---
Manage Application Revisions
### Synopsis
Manage KubeVela Application Revisions
### Options
```
-h, --help help for revision
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision list](vela_revision_list) - list 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).

View File

@ -0,0 +1,36 @@
---
title: vela revision list
---
list application revisions
### Synopsis
list Kubevela application revisions
```
vela revision list [flags]
```
### Options
```
-e, --env string specify environment name for application
-h, --help help for list
-n, --namespace string specify the Kubernetes namespace to use
```
### 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).

View File

@ -40,4 +40,4 @@ show webservice
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -21,11 +21,15 @@ vela status APP_NAME
### Options
```
-p, --endpoint show all service endpoints of the application
-e, --env string specify environment name for application
-h, --help help for status
-n, --namespace string specify the Kubernetes namespace to use
-s, --svc string service name
-c, --component string filter service endpoints by component name
-d, --detail display the realtime details of application resources
--detail-format string the format for displaying details. Can be one of inline (default), wide, list, table, raw. (default "inline")
-p, --endpoint show all service endpoints of the application
-e, --env string specify environment name for application
-h, --help help for status
-n, --namespace string specify the Kubernetes namespace to use
-s, --svc string service name
-t, --tree display the application resources into tree structure
```
### Options inherited from parent commands
@ -41,4 +45,4 @@ vela status APP_NAME
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -43,4 +43,4 @@ vela trait
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -40,4 +40,4 @@ vela trait get <trait>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -28,4 +28,4 @@ Manage UI schema for addons.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela uischema apply [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -22,6 +22,7 @@ vela uninstall
```
-d, --detail show detail log of installation (default true)
-f, --force force uninstall whole vela include all addons
-h, --help help for uninstall
-n, --namespace string namespace scope for installing KubeVela Core (default "vela-system")
```
@ -39,4 +40,4 @@ vela uninstall
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -2,23 +2,45 @@
title: vela up
---
Apply an appfile or application from file
Deploy one application
### Synopsis
Create or update vela application from file or URL, both appfile or application object format are supported.
Deploy one application
Deploy one application based on local files or re-deploy an existing application. With the -n/--namespace flag, you can choose the location of the target application.
To apply application from file, use the -f/--file flag to specify the application file location.
To give a particular version to this deploy, use the -v/--publish-version flag. When you are deploying an existing application, the version name must be different from the current name. You can also use a history revision for the deploy and override the current application by using the -r/--revision flag.
```
vela up
```
### Examples
```
# Deploy an application from file
vela up -f ./app.yaml
# Deploy an application with a version name
vela up example-app -n example-ns --publish-version beta
# Deploy an application using existing revision
vela up example-app -n example-ns --publish-version beta --revision example-app-v2
```
### Options
```
-e, --env string specify environment name for application
-f, --file string specify file path for appfile or application, it could be a remote url.
-h, --help help for up
-n, --namespace string specify the Kubernetes namespace to use
--debug Enable debug mode for application
-e, --env string The environment name for the CLI request
-f, --file string The file path for appfile or application. It could be a remote url.
-h, --help help for up
-n, --namespace string If present, the namespace scope for this CLI request
-v, --publish-version string The publish version for deploying application.
-r, --revision string The revision to use for deploying the application, if empty, the current application configuration will be used.
```
### Options inherited from parent commands
@ -34,4 +56,4 @@ vela up
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ vela version [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ vela version list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ Operate the Workflow during Application Delivery.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela workflow restart <application-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela workflow resume <application-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela workflow rollback <application-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela workflow suspend <application-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -39,4 +39,4 @@ vela workflow terminate <application-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -0,0 +1,159 @@
---
title: Traefik
---
Traefik 是一个现代化且易用的 HTTP 反向代理和负载均衡服务,用于部署微服务。你可以使用该插件作为你的集群网关活着微服务系统的网关。
## XDefinitions
### http-route(trait)
基于 HTTP 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayName | Specify the gateway name | string | false | traefik-gateway
listenerName | Specify the listener name of the gateway | string | false | web
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
port | Specify the service port of component. | int | true |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
### https-route(trait)
基于 HTTPS 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
secrets | Specify the TLS secrets | [[]secrets](#secrets) | true |
TLSPort | | int | true | 443
domains | Specify some domains, the domain may be prefixed with a wildcard label (*.) | []string | true |
rules | Specify some HTTP matchers, filters and actions. | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
path | An HTTP request path matcher. If this field is not specified, a default prefix match on the "/" path is provided. | [path](#path) | false |
port | Specify the service port of component. | int | true |
headers | Conditions to select a HTTP route by matching HTTP request headers. | [[]headers](#headers) | false |
serviceName | Specify the service name of component, the default is component name. | string | false |
###### headers
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
type | | string | true |
value | | string | true |
###### path
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
type | | string | true | PathPrefix
value | | string | true | /
##### secrets
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | | string | true |
namespace | | string | false |
### tcp-route(trait)
基于四层的 TCP 路由规则来将请求从网关代理到应用。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
rules | Specify the TCP matchers | [[]rules](#rules) | true |
##### rules
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
gatewayPort | Specify the gateway listener port | int | true |
port | Specify the service port of component. | int | true |
serviceName | Specify the service name of component, the default is component name. | string | false |
### config-tls-certificate(config)
用于扩展集成配置的选项,支持用户配置 TLS 证书用于上述 HTTPs规则。
#### 参数说明
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
cert | the certificate public key encrypted by base64 | string | true |
key | the certificate private key encrypted by base64 | string | true |
## 插件安装
```bash
vela addon enable traefik
```
### 访问 Traefik 的 UI
默认安装情况下 Traefik 无法直接访问,可通过 port-forward 进行本地代理,这仅适用于调试阶段。
```bash
vela port-forward -n vela-system addon-traefik
```
expected output:
```
Forwarding from 127.0.0.1:9000 -> 9000
Forwarding from [::1]:9000 -> 9000
Forward successfully! Opening browser ...
Handling connection for 9000
```
你可以通过 `http://127.0.0.1:9000/dashboard/` 地址访问到 Traefik 的 UI 可视化面板。
### 设置网关流量接入方式
如果你使用云上的集群,使用 LoadBalancer 暴露 Traefik 的访问入口是最佳方案。
```bash
vela addon enable traefik serviceType=LoadBalancer
```
如果在自建集群,需要根据你是作为集群网关还是应用网关来选择流量接入方式。

View File

@ -184,6 +184,7 @@ module.exports = {
'reference/addons/velaux',
'reference/addons/terraform',
'reference/addons/ai',
'reference/addons/traefik',
],
},
'end-user/components/cloud-services/cloud-resources-list',

View File

@ -33,4 +33,4 @@ Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -38,4 +38,4 @@ vela addon disable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -46,4 +46,4 @@ Enable addon for specific clusters, (local means control plane):
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela addon list [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ vela addon registry add [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry delete <registry-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry get <registry name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon registry list
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -42,4 +42,4 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -37,4 +37,4 @@ vela addon status <addon-name>
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -45,4 +45,4 @@ Upgrade addon for specific clusters, (local means control plane):
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -34,4 +34,4 @@ Manage Kubernetes Clusters for Continuous Delivery.
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -31,4 +31,4 @@ vela cluster alias CLUSTER_NAME ALIAS [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

View File

@ -32,4 +32,4 @@ vela cluster detach [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).

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