Fix: Update addon helm associated docs (#601)

* update helm

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* update addon docs

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* rename pic

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>

* fix several issues

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
This commit is contained in:
wyike 2022-04-14 16:53:44 +08:00 committed by GitHub
parent d6a6f752b6
commit 6280d8b23c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 151 additions and 48 deletions

View File

@ -8,17 +8,27 @@ You can get more capabilities from KubeVela ecosystem by installing addons.
By default, the following command lists addons from a default addon registry (https://addons.kubevela.net) maintained by KubeVela team.
This command will show all available versions of every addon.
```shell
$ vela addon list
terraform Terraform Controller is a Kubernetes Controller for Terraform. disabled
velaux The KubeVela User Experience (UX ). Dashboard Designed as an extensible, application-oriented delivery and management control panel. disabled
ocm-cluster-manager ocm-cluster-manager can deploy an OCM hub cluster environment. disabled
fluxcd Extended workload to do continuous and progressive delivery disabled
terraform-aws Kubernetes Terraform Controller for AWS disabled
observability An out of the box solution for KubeVela observability disabled
terraform-alibaba Kubernetes Terraform Controller for Alibaba Cloud disabled
terraform-azure Kubernetes Terraform Controller for Azure disabled
NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS
ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled
rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled
terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled
terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled
model-serving KubeVela Enable serving for models [1.0.0] disabled
model-training KubeVela Enable training for models [1.0.0] disabled
terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled
terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled
terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled
terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled
dex KubeVela Enable dex for login [0.6.5] disabled
ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled
terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled
fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled
velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0)
terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled
```
## Install Addon
@ -35,6 +45,20 @@ I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-ui
Addon: fluxcd enabled Successfully.
```
### Install with specified version
You can choose one special version of this addon by add `--version` flag in this command. eg:
```shell
vela addon enable fluxcd --version=1.0.0
```
By default, this command will install this addon in all managed-clusters.You can use `--cluster` flag to choose specific clusters. eg:
```shell
vela addon enable <addon-name> --clusters={cluster1,cluster2}
```
You can view the new component or trait types added by `vela component` or `vela trait`. You can also find more details about [built-in addon docs](../../../reference/addons/overview).
## Uninstall Addon
@ -51,13 +75,13 @@ Successfully disable addon:fluxcd
```
$ vela addon registry list
Name Type URL
KubeVela OSS https://addons.kubevela.net
KubeVela helm https://addons.kubevela.net
```
## Add Registry
```
$ vela addon registry add experimental --type OSS --endpoint=https://addons.kubevela.net --path=experimental/
$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/
Successfully add an addon registry experimental
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 326 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

@ -33,15 +33,16 @@ When the addon is `enabled`, it means that it's ready to. You can start to deplo
## Creating Redis application
You've must have mastered creating applications through the previous sections. When it comes to creating Redis with Helm Chart, all you need is to select type as `helm`, then Then select the Target which has the default StorageClass that provides PV, and at last enter the deployment parameter configuration page.
You've must have mastered creating applications through the previous sections. When it comes to creating Redis with Helm Chart, all you need is to select type as `helm`, Then select the Target which has the default StorageClass that provides PV, and at last enter the deployment parameter configuration page.
![helm app config](../resources/helm-app-config.jpg)
As shown, you need to do the following configuration:
- Repo Type: Git, Helm, and OSS are supported. In this example, we choose Helm.
- Repo Type: Git and Helm are supported. In this example, we choose Helm.
- Repo URL: Fill in the repo address you needed. we type in: https://charts.bitnami.com/bitnami
- Chart Path: Chart package path, here we fill in: redis
- Chart: After fill Helm repo URL, will list all available chart in this field. You can choose one from the list, here we choose: redis.
- Version: Choose one version of this chart, here we choose: 16.8.5.
- Values: Custom parameters of Chart. Since we are using ACK cluster in the example, PV has a minimum capacity requirement, 15Gi. In the same way, other parameters can also be configured according to your cluster's status.
After filling in the above parameters, click `Create` to complete the application creation and enter the application configuration page. The following steps will stay the same as you've learned in [Deploy First Application](../quick-start).

View File

@ -11,14 +11,23 @@ KubeVela 官方团队维护了一个默认的插件仓库 (https://addons.kubeve
```shell
$ vela addon list
terraform Terraform Controller is a Kubernetes Controller for Terraform. disabled
velaux The KubeVela User Experience (UX ). Dashboard Designed as an extensible, application-oriented delivery and management control panel. disabled
ocm-cluster-manager ocm-cluster-manager can deploy an OCM hub cluster environment. disabled
fluxcd Extended workload to do continuous and progressive delivery disabled
terraform-aws Kubernetes Terraform Controller for AWS disabled
observability An out of the box solution for KubeVela observability disabled
terraform-alibaba Kubernetes Terraform Controller for Alibaba Cloud disabled
terraform-azure Kubernetes Terraform Controller for Azure disabled
NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS
ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled
rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled
terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled
terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled
model-serving KubeVela Enable serving for models [1.0.0] disabled
model-training KubeVela Enable training for models [1.0.0] disabled
terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled
terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled
terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled
terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled
dex KubeVela Enable dex for login [0.6.5] disabled
ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled
terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled
fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled
velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0)
terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled
```
## 安装插件
@ -35,6 +44,23 @@ I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-ui
Addon: fluxcd enabled Successfully.
```
### 安装特定版本的插件
你可以通过通过设置 `--version` 启动参数,来指定安装插件的某个特定版本。例如:
```shell
vela addon enable fluxcd --version=1.0.0
```
如果不指定该参数,默认会安装此插件的最新版本。
启用一个插件时,默认会在所有子集群中安装该插件,你也可以通过设置 `--cluster` 启动参数选择安装在某些集群当中。例如:
```shell
vela addon enable <addon-name> --clusters={cluster1,cluster2}
```
安装完成后,插件中的功能会以组件,运维特征,工作流步骤等形式呈现,你可以通过 `vela component``vela trait` 等命令查看新增的能力,也可以在[插件的参考文档](../../../reference/addons/overview)中查看每个官方插件对应的能力.
## 删除/卸载已安装的插件

Binary file not shown.

Before

Width:  |  Height:  |  Size: 326 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

@ -40,9 +40,10 @@ description: 本文介绍通过 KubeVela 交付 Helm Chart
参考上图,需要做如下配置:
- Repo Type: 仓库类型,目前支持 Git、Helm 和 OSS 三种,本例我们选择 Helm 类型。
- Repo Type: 仓库类型,目前支持 Git 和 Helm,本例我们选择 Helm 类型。
- Repo URL: 仓库地址基于不同的仓库类型填写仓库地址这里我们填写https://charts.bitnami.com/bitnami
- Chart Path: Chart 包路径,这里我们填写: redis
- Chart: 填写仓库地址之后,这里会展示出所有可用的 Helm chart这里我们选择: redis
- Version: 选择可用的 chart 版本,这里我们选择 16.8.5
- Values: Chart 的自定义配置参数,这里由于我们使用的是 ACK 集群PV 有最小容量要求,这里填写 15Gi。同理其他配置参数也可以通过该方式进行配置你需要根据你的集群情况进行配置。
如上参数填写完成后,点击 `Create` 完成应用创建进入应用管理页面。后续的部署流程与你在 [交付第一个应用](../quick-start) 的学习内容就一致了。

View File

@ -11,14 +11,23 @@ KubeVela 官方团队维护了一个默认的插件仓库 (https://addons.kubeve
```shell
$ vela addon list
terraform Terraform Controller is a Kubernetes Controller for Terraform. disabled
velaux The KubeVela User Experience (UX ). Dashboard Designed as an extensible, application-oriented delivery and management control panel. disabled
ocm-cluster-manager ocm-cluster-manager can deploy an OCM hub cluster environment. disabled
fluxcd Extended workload to do continuous and progressive delivery disabled
terraform-aws Kubernetes Terraform Controller for AWS disabled
observability An out of the box solution for KubeVela observability disabled
terraform-alibaba Kubernetes Terraform Controller for Alibaba Cloud disabled
terraform-azure Kubernetes Terraform Controller for Azure disabled
NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS
ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled
rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled
terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled
terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled
model-serving KubeVela Enable serving for models [1.0.0] disabled
model-training KubeVela Enable training for models [1.0.0] disabled
terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled
terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled
terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled
terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled
dex KubeVela Enable dex for login [0.6.5] disabled
ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled
terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled
fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled
velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0)
terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled
```
## 安装插件
@ -35,6 +44,22 @@ I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-ui
Addon: fluxcd enabled Successfully.
```
### 安装特定版本的插件
你可以通过通过设置 `--version` 启动参数,来指定安装插件的某个特定版本。例如:
```shell
vela addon enable fluxcd --version=1.0.0
```
如果不指定该参数,默认会安装此插件的最新版本。
启用一个插件时,默认会在所有子集群中安装该插件,你也可以通过设置 `--cluster` 启动参数选择安装在某些集群当中。例如:
```shell
vela addon enable <addon-name> --clusters={cluster1,cluster2}
```
安装完成后,插件中的功能会以组件,运维特征,工作流步骤等形式呈现,你可以通过 `vela component``vela trait` 等命令查看新增的能力,也可以在[插件的参考文档](../../../reference/addons/overview)中查看每个官方插件对应的能力.
## 删除/卸载已安装的插件
@ -51,7 +76,7 @@ Successfully disable addon:fluxcd
```
$ vela addon registry list
Name Type URL
KubeVela helm https://addons.kubevela.net
KubeVela helm https://addons.kubevela.net
```
KubeVela 社区在 Github 上维护了一个官方的[正式插件包仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件包仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。你在相应的仓库中找到插件包的定义文件。
@ -63,7 +88,7 @@ KubeVela 社区在 Github 上维护了一个官方的[正式插件包仓库](htt
你可以添加自己的插件包仓库,目前支持 OSS 和 Github 两种仓库类型。
```
$ vela addon registry add experimental --type OSS --endpoint=https://addons.kubevela.net --path=experimental/
$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/
Successfully add an addon registry experimental
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 326 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

@ -40,9 +40,10 @@ description: 本文介绍通过 KubeVela 交付 Helm Chart
参考上图,需要做如下配置:
- Repo Type: 仓库类型,目前支持 Git、Helm 和 OSS 三种,本例我们选择 Helm 类型。
- Repo Type: 仓库类型,目前支持 Git 和 Helm,本例我们选择 Helm 类型。
- Repo URL: 仓库地址基于不同的仓库类型填写仓库地址这里我们填写https://charts.bitnami.com/bitnami
- Chart Path: Chart 包路径,这里我们填写: redis
- Chart: 填写仓库地址之后,这里会展示出所有可用的 Helm chart这里我们选择: redis
- Version: 选择可用的 chart 版本,这里我们选择 16.8.5
- Values: Chart 的自定义配置参数,这里由于我们使用的是 ACK 集群PV 有最小容量要求,这里填写 15Gi。同理其他配置参数也可以通过该方式进行配置你需要根据你的集群情况进行配置。
如上参数填写完成后,点击 `Create` 完成应用创建进入应用管理页面。后续的部署流程与你在 [交付第一个应用](../quick-start) 的学习内容就一致了。

View File

@ -8,17 +8,27 @@ You can get more capabilities from KubeVela ecosystem by installing addons.
By default, the following command lists addons from a default addon registry (https://addons.kubevela.net) maintained by KubeVela team.
This command will show all available versions of every addon.
```shell
$ vela addon list
terraform Terraform Controller is a Kubernetes Controller for Terraform. disabled
velaux The KubeVela User Experience (UX ). Dashboard Designed as an extensible, application-oriented delivery and management control panel. disabled
ocm-cluster-manager ocm-cluster-manager can deploy an OCM hub cluster environment. disabled
fluxcd Extended workload to do continuous and progressive delivery disabled
terraform-aws Kubernetes Terraform Controller for AWS disabled
observability An out of the box solution for KubeVela observability disabled
terraform-alibaba Kubernetes Terraform Controller for Alibaba Cloud disabled
terraform-azure Kubernetes Terraform Controller for Azure disabled
NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS
ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled
rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled
terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled
terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled
model-serving KubeVela Enable serving for models [1.0.0] disabled
model-training KubeVela Enable training for models [1.0.0] disabled
terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled
terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled
terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled
terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled
dex KubeVela Enable dex for login [0.6.5] disabled
ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled
terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled
fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled
velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0)
terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled
```
## Install Addon
@ -35,6 +45,20 @@ I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-ui
Addon: fluxcd enabled Successfully.
```
### Install with specified version
You can choose one special version of this addon by add `--version` flag in this command. eg:
```shell
vela addon enable fluxcd --version=1.0.0
```
By default, this command will install this addon in all managed-clusters.You can use `--cluster` flag to choose specific clusters. eg:
```shell
vela addon enable <addon-name> --clusters={cluster1,cluster2}
```
You can view the new component or trait types added by `vela component` or `vela trait`. You can also find more details about [built-in addon docs](../../../reference/addons/overview).
## Uninstall Addon
@ -51,13 +75,13 @@ Successfully disable addon:fluxcd
```
$ vela addon registry list
Name Type URL
KubeVela OSS https://addons.kubevela.net
KubeVela helm https://addons.kubevela.net
```
## Add Registry
```
$ vela addon registry add experimental --type OSS --endpoint=https://addons.kubevela.net --path=experimental/
$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/
Successfully add an addon registry experimental
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 326 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

@ -33,15 +33,16 @@ When the addon is `enabled`, it means that it's ready to. You can start to deplo
## Creating Redis application
You've must have mastered creating applications through the previous sections. When it comes to creating Redis with Helm Chart, all you need is to select type as `helm`, then Then select the Target which has the default StorageClass that provides PV, and at last enter the deployment parameter configuration page.
You've must have mastered creating applications through the previous sections. When it comes to creating Redis with Helm Chart, all you need is to select type as `helm`, Then select the Target which has the default StorageClass that provides PV, and at last enter the deployment parameter configuration page.
![helm app config](../resources/helm-app-config.jpg)
As shown, you need to do the following configuration:
- Repo Type: Git, Helm, and OSS are supported. In this example, we choose Helm.
- Repo Type: Git and Helm are supported. In this example, we choose Helm.
- Repo URL: Fill in the repo address you needed. we type in: https://charts.bitnami.com/bitnami
- Chart Path: Chart package path, here we fill in: redis
- Chart: After fill Helm repo URL, will list all available chart in this field. You can choose one from the list, here we choose: redis.
- Version: Choose one version of this chart, here we choose: 16.8.5.
- Values: Custom parameters of Chart. Since we are using ACK cluster in the example, PV has a minimum capacity requirement, 15Gi. In the same way, other parameters can also be configured according to your cluster's status.
After filling in the above parameters, click `Create` to complete the application creation and enter the application configuration page. The following steps will stay the same as you've learned in [Deploy First Application](../quick-start).