Feat: add helm repo config (#616)

* add helm repo config

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

* fix error link

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

* fix comments

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

* add ref to config in helm doc

Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
This commit is contained in:
wyike 2022-04-20 15:38:43 +08:00 committed by GitHub
parent ee0268d570
commit 695067b056
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 123 additions and 14 deletions

View File

@ -0,0 +1,26 @@
---
title: Helm repository
description: Configure a helm repository
---
In this guide, we will introduce how to use Integration create a private helm repository and create a helm type application to use this repo.
Notice: You must enable the `fluxcd` addon firstly.
## Create a helm repo
You can set the url of your private repository in `url` field. If your repo have set up the HTTP basic authentication , you can set the `username` and `password` for it.
In this image we use the [azure](https://marketplace.azurecr.io/helm/v1/repo) helm repo.
![config](../../../resources/helm-config.jpg)
## Use the helm repo
You can follow the [application creation guide](../application/create-application) to create a helm type application in project `default`. eg:
![helm-type-app](../../../resources/new-helm-type-app.jpg)
Then you can choose the helm repo url configured before like this image, and use the available charts in this repo.
![helm-app](../../../resources/helm-app.jpg)

BIN
docs/resources/helm-app.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

@ -40,10 +40,10 @@ You've must have mastered creating applications through the previous sections. W
As shown, you need to do the following configuration:
- 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: 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.
- Repo URL: Fill in the repo address you needed. we type in: https://charts.bitnami.com/bitnami. If you have configured the helm repo in [Integration](../how-to/dashboard/config/helm-repo) you can choose the repo directly.
- Chart: After fill Helm repo URL, will list all available charts in this field. You can choose one from the list, here we choose: redis.
- Version: After choose the helm chart, will list all available versions in this field. Choose one version of this chart, here we choose: 16.8.5.
- Values: After choose the version, will list all parameters of this helm 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

@ -0,0 +1,26 @@
---
标题: helm 仓库
描述: 配置 helm 仓库
---
在本教程中,我们将会介绍如何通过集成配置,创建 helm 仓库,并在创建应用时使用该仓库。
请注意:在配置前你需要先启用 `fluxcd` 的插件。
## 创建一个 Helm 仓库
例如在本图中,你可以设置 helm 仓库的 url并且如果你的仓库还开启了 `HTTP basic authentication` 你也可以为这个仓库设置 `username``paswword`
在本例子中,我们使用 [azure](https://marketplace.azurecr.io/helm/v1/repo) 作为 helm 仓库。
![config](../../../resources/helm-config.jpg)
## 创建应用并使用该 helm 仓库
你可以参考 [应用创建指南](../application/create-application) 在项目 `default` 中创建 helm 类型的应用。如下图所示:
![helm-type-app](../../../resources/new-helm-type-app.jpg)
接下来,你就可以在 `Repo URL` 的选择框中选择刚才创建的 helm 仓库。之后你就可以使用仓库中可用的 chart 来创建自己的应用了。
![helm-app](../../../resources/helm-app.jpg)

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

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

View File

@ -0,0 +1,26 @@
---
标题: helm 仓库
描述: 配置 helm 仓库
---
在本教程中,我们将会介绍如何通过集成配置,创建 helm 仓库,并在创建应用时使用该仓库。
请注意:在配置前你需要先启用 `fluxcd` 的插件。
## 创建一个 Helm 仓库
例如在本图中,你可以设置 helm 仓库的 url并且如果你的仓库还开启了 `HTTP basic authentication` 你也可以为这个仓库设置 `username``paswword`
在本例子中,我们使用 [azure](https://marketplace.azurecr.io/helm/v1/repo) 作为 helm 仓库。
![config](../../../resources/helm-config.jpg)
## 创建应用并使用该 helm 仓库
你可以参考 [应用创建指南](../application/create-application) 在项目 `default` 中创建 helm 类型的应用。如下图所示:
![helm-type-app](../../../resources/new-helm-type-app.jpg)
接下来,你就可以在 `Repo URL` 的选择框中选择刚才创建的 helm 仓库。之后你就可以使用仓库中可用的 chart 来创建自己的应用了。
![helm-app](../../../resources/helm-app.jpg)

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

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

View File

@ -150,6 +150,7 @@ module.exports = {
{
"Manage integration configs": [
"how-to/dashboard/config/dex-connectors",
"how-to/dashboard/config/helm-repo",
],
},
"how-to/dashboard/addon/overview",

View File

@ -0,0 +1,26 @@
---
title: Helm repository
description: Configure a helm repository
---
In this guide, we will introduce how to use Integration create a private helm repository and create a helm type application to use this repo.
Notice: You must enable the `fluxcd` addon firstly.
## Create a helm repo
You can set the url of your private repository in `url` field. If your repo have set up the HTTP basic authentication , you can set the `username` and `password` for it.
In this image we use the [azure](https://marketplace.azurecr.io/helm/v1/repo) helm repo.
![config](../../../resources/helm-config.jpg)
## Use the helm repo
You can follow the [application creation guide](../application/create-application) to create a helm type application in project `default`. eg:
![helm-type-app](../../../resources/new-helm-type-app.jpg)
Then you can choose the helm repo url configured before like this image, and use the available charts in this repo.
![helm-app](../../../resources/helm-app.jpg)

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

@ -40,9 +40,9 @@ You've must have mastered creating applications through the previous sections. W
As shown, you need to do the following configuration:
- 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
- Repo URL: Fill in the repo address you needed. we type in: https://charts.bitnami.com/bitnami. If you have configured the helm repo in [Integration](../how-to/dashboard/config/helm-repo) you can choose the repo directly.
- 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.
- Version: After choose the helm chart, will list all available version of it. 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

@ -366,6 +366,10 @@
{
"type": "doc",
"id": "version-v1.3/how-to/dashboard/config/dex-connectors"
},
{
"type": "doc",
"id": "version-v1.3/how-to/dashboard/config/helm-repo"
}
]
},