Feat: refine addon docs (#460)
* refine addon docs Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com> * add pics Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
This commit is contained in:
wyike
GitHub
parent
3f9bfa29ad
commit
c128d09ae5
|
|
@ -54,6 +54,10 @@ Name Type URL
|
|||
KubeVela OSS https://addons.kubevela.net
|
||||
```
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件包仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件包仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。你在相应的仓库中找到插件包的定义文件。
|
||||
|
||||
同时这些文件会被同步到 [对象存储](https://addons.kubevela.net) 当中，以加快下载速度。
|
||||
|
||||
## 添加插件包仓库
|
||||
|
||||
你可以添加自己的插件包仓库，目前支持 OSS 和 Github 两种仓库类型。
|
||||
|
|
@ -70,6 +74,28 @@ $ vela addon registry delete experimental
|
|||
Successfully delete an addon registry experimental
|
||||
```
|
||||
|
||||
## 多集群环境中启用插件包
|
||||
|
||||
如果你的环境中添加了若干个子集群，启用插件包时会默认在管控集群和所有子集群中安装此插件包。但如果子集群在某个插件包启用之后加入环境当中，则需要通过升级操作在新加入集群中安装此插件包。如下所示
|
||||
|
||||
```
|
||||
$ vela addon upgrade velaux
|
||||
Addon:
|
||||
enabled Successfully
|
||||
```
|
||||
|
||||
## 离线安装插件包
|
||||
|
||||
如果因为某些原因，你的环境无法通过访问插件包仓库，你可以通过指定本地的插件包目录来进行离线安装。如下所示：
|
||||
|
||||
```
|
||||
$ ls
|
||||
README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux
|
||||
|
||||
$ vela addon enable velaux/
|
||||
Addon: velaux enabled Successfully
|
||||
```
|
||||
|
||||
## 编写自己的插件包
|
||||
|
||||
请参考[插件包制作文档](../../../platform-engineers/addon/intro)。
|
||||
|
|
@ -1,3 +1,43 @@
|
|||
---
|
||||
title: Overview
|
||||
title: 管理插件包
|
||||
---
|
||||
你可以在 VelaUX 的 Addon 页面管理平台插件包，以获取更多的系统功能。
|
||||
|
||||
|
||||
|
||||
## 启用/停用插件包 (Enable/Disable Addon)
|
||||
|
||||
如下图所示，在某个插件包页面点击 `Enable` 启用一个插件包
|
||||
|
||||
|
||||
|
||||
如果某个插件需要依赖其他插件，只有当被依赖的的插件被启用之后，该插件才能被启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
有些复杂的插件包需要设置一些参数才能启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
通过点击插件页面的 `Disable` 停用一个插件
|
||||
|
||||
> 停用前请确认插件包对应的能力没有被任何应用所使用。
|
||||
|
||||
你也可以通过点击页面的 `Upgrade` 来更新插件包。
|
||||
|
||||
## 多集群环境中启用插件包
|
||||
|
||||
如果你的环境中添加了若干个子集群，启用插件时会在管控集群和所有子集群中均安装此插件包。但如果你的子集群在插件包启用之后，加入环境当中，则需要通过更新操作，让此插件包在子集群中生效。
|
||||
|
||||
## 插件包仓库 (Addon Registry)
|
||||
|
||||
插件包仓库是一个存储、发现和下载插件的地方。 插件包仓库的地址可以是一个 Git 仓库或者一个对象存储 Bucket。
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。
|
||||
|
||||
你也可以参考这两个仓库，自己定制一个插件仓库， 下图展示如何通过 VelaUX 来管理插件仓库，你可以在这里添加、更新或删除一个插件仓库。
|
||||
|
||||
|
||||
|
||||
需要注意的是，KubeVela 默认没有添加试验性的插件仓库，但你可以通过点击 `Add Experimental Registry` 一键将它添加进来，并使用其中的插件。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +1,7 @@
|
|||
---
|
||||
title: 插件管理系统
|
||||
title: 插件扩展
|
||||
---
|
||||
|
||||
插件管理系统用于管理和扩展 KubeVela 的平台功能。
|
||||
用户可以通过 UX/CLI 来启用或停用插件，从而安装或卸载 KubeVela 平台的扩展功能。
|
||||
|
||||
## 插件仓库 (Addon Registry)
|
||||
|
||||
插件仓库是一个存储、发现和下载插件的地方。 插件仓库的地址可以是一个 Git 仓库或者一个对象存储 Bucket。
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。
|
||||
|
||||
你也可以参考这两个仓库，自己定制一个插件仓库， 之后通过 UX/CLI 来将它添加到你的系统。下图展示如何通过 UX 来添加一个插件仓库：
|
||||
|
||||
|
||||
|
||||
需要注意的是，KubeVela 默认没有添加试验性的插件仓库，但你可以通过点击 `Add Experimental Registry` 一键将它添加进来，并使用其中的插件。
|
||||
|
||||
## 启用/停用插件 (Enable/Disable Addon)
|
||||
|
||||
你可以通过 UX/CLI 获取到当前插件仓库中的所有插件，并启用/停用某个插件。
|
||||
|
||||
下面例子是一个插件列表在 UX 上的展示图：
|
||||
|
||||
|
||||
|
||||
如果某个插件需要依赖其他插件，只有当被依赖的的插件被启用之后，该插件才能被启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
有些复杂的插件需要设置一些参数才能启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
## 插件原理 (Addon Mechanism)
|
||||
|
||||
下图展示了在启用一个插件时，KubeVela 做了哪些事情。可以看到插件仓库中所存放的其实是插件的资源文件，当通过 UX/CLI 启用一个插件时，它们会从插件仓库把这些资源文件拉取下来，渲染成一个 KubeVela 应用并创建。最终由运行在管控集群的 KubeVela 控制器完成对应用中所描述资源的下发。
|
||||
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 146 KiB |
|
|
@ -54,6 +54,10 @@ Name Type URL
|
|||
KubeVela OSS https://addons.kubevela.net
|
||||
```
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件包仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件包仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。你在相应的仓库中找到插件包的定义文件。
|
||||
|
||||
同时这些文件会被同步到 [对象存储](https://addons.kubevela.net) 当中，以加快下载速度。
|
||||
|
||||
## 添加插件包仓库
|
||||
|
||||
你可以添加自己的插件包仓库，目前支持 OSS 和 Github 两种仓库类型。
|
||||
|
|
@ -70,6 +74,28 @@ $ vela addon registry delete experimental
|
|||
Successfully delete an addon registry experimental
|
||||
```
|
||||
|
||||
## 多集群环境中启用插件包
|
||||
|
||||
如果你的环境中添加了若干个子集群，启用插件包时会默认在管控集群和所有子集群中安装此插件包。但如果子集群在某个插件包启用之后加入环境当中，则需要通过升级操作在新加入集群中安装此插件包。如下所示
|
||||
|
||||
```
|
||||
$ vela addon upgrade velaux
|
||||
Addon:
|
||||
enabled Successfully
|
||||
```
|
||||
|
||||
## 离线安装插件包
|
||||
|
||||
如果因为某些原因，你的环境无法通过访问插件包仓库，你可以通过指定本地的插件包目录来进行离线安装。如下所示：
|
||||
|
||||
```
|
||||
$ ls
|
||||
README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux
|
||||
|
||||
$ vela addon enable velaux/
|
||||
Addon: velaux enabled Successfully
|
||||
```
|
||||
|
||||
## 编写自己的插件包
|
||||
|
||||
请参考[插件包制作文档](../../../platform-engineers/addon/intro)。
|
||||
|
|
@ -1,3 +1,43 @@
|
|||
---
|
||||
title: Overview
|
||||
title: 管理插件包
|
||||
---
|
||||
你可以在 VelaUX 的 Addon 页面管理平台插件包，以获取更多的系统功能。
|
||||
|
||||
|
||||
|
||||
## 启用/停用插件包 (Enable/Disable Addon)
|
||||
|
||||
如下图所示，在某个插件包页面点击 `Enable` 启用一个插件包
|
||||
|
||||
|
||||
|
||||
如果某个插件需要依赖其他插件，只有当被依赖的的插件被启用之后，该插件才能被启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
有些复杂的插件包需要设置一些参数才能启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
通过点击插件页面的 `Disable` 停用一个插件
|
||||
|
||||
> 停用前请确认插件包对应的能力没有被任何应用所使用。
|
||||
|
||||
你也可以通过点击页面的 `Upgrade` 来更新插件包。
|
||||
|
||||
## 多集群环境中启用插件包
|
||||
|
||||
如果你的环境中添加了若干个子集群，启用插件时会在管控集群和所有子集群中均安装此插件包。但如果你的子集群在插件包启用之后，加入环境当中，则需要通过更新操作，让此插件包在子集群中生效。
|
||||
|
||||
## 插件包仓库 (Addon Registry)
|
||||
|
||||
插件包仓库是一个存储、发现和下载插件的地方。 插件包仓库的地址可以是一个 Git 仓库或者一个对象存储 Bucket。
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。
|
||||
|
||||
你也可以参考这两个仓库，自己定制一个插件仓库， 下图展示如何通过 VelaUX 来管理插件仓库，你可以在这里添加、更新或删除一个插件仓库。
|
||||
|
||||
|
||||
|
||||
需要注意的是，KubeVela 默认没有添加试验性的插件仓库，但你可以通过点击 `Add Experimental Registry` 一键将它添加进来，并使用其中的插件。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +1,7 @@
|
|||
---
|
||||
title: 插件管理系统
|
||||
title: 插件扩展
|
||||
---
|
||||
|
||||
插件管理系统用于管理和扩展 KubeVela 的平台功能。
|
||||
用户可以通过 UX/CLI 来启用或停用插件，从而安装或卸载 KubeVela 平台的扩展功能。
|
||||
|
||||
## 插件仓库 (Addon Registry)
|
||||
|
||||
插件仓库是一个存储、发现和下载插件的地方。 插件仓库的地址可以是一个 Git 仓库或者一个对象存储 Bucket。
|
||||
|
||||
KubeVela 社区在 Github 上维护了一个官方的[正式插件仓库](https://github.com/oam-dev/catalog/tree/master/addons) 和一个[试验阶段插件仓库](https://github.com/oam-dev/catalog/tree/master/experimental) 。
|
||||
|
||||
你也可以参考这两个仓库，自己定制一个插件仓库， 之后通过 UX/CLI 来将它添加到你的系统。下图展示如何通过 UX 来添加一个插件仓库：
|
||||
|
||||
|
||||
|
||||
需要注意的是，KubeVela 默认没有添加试验性的插件仓库，但你可以通过点击 `Add Experimental Registry` 一键将它添加进来，并使用其中的插件。
|
||||
|
||||
## 启用/停用插件 (Enable/Disable Addon)
|
||||
|
||||
你可以通过 UX/CLI 获取到当前插件仓库中的所有插件，并启用/停用某个插件。
|
||||
|
||||
下面例子是一个插件列表在 UX 上的展示图：
|
||||
|
||||
|
||||
|
||||
如果某个插件需要依赖其他插件，只有当被依赖的的插件被启用之后，该插件才能被启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
有些复杂的插件需要设置一些参数才能启用，如下图所示。
|
||||
|
||||
|
||||
|
||||
## 插件原理 (Addon Mechanism)
|
||||
|
||||
下图展示了在启用一个插件时，KubeVela 做了哪些事情。可以看到插件仓库中所存放的其实是插件的资源文件，当通过 UX/CLI 启用一个插件时，它们会从插件仓库把这些资源文件拉取下来，渲染成一个 KubeVela 应用并创建。最终由运行在管控集群的 KubeVela 控制器完成对应用中所描述资源的下发。
|
||||
|
||||
|
||||
|
|
@ -102,7 +69,7 @@ invisible: false
|
|||
### 组件资源 (resources) 目录 (非必须)
|
||||
|
||||
除了直接在模版文件中添加组件，你也可以在插件目录下创建一个 `resources` 目录，并在里面添加 YAML/CUE 类型的文件，这些文件最终会被渲染成组件并添加到应用当中。
|
||||
其中，YAML 类型的文件中应该包含的是一个 K8S 资源对象，在渲染时该对象会被做为 K8s-object 类型的组件直接添加到应用当中。
|
||||
其中，YAML 类型的文件中应该包含的是一个 K8S 资源对象，在渲染时该对象会被做为 K8s-object 类型的组件直接添加到应用当中。
|
||||
|
||||
如果你需要为应用添加一个需要在启用时根据参数动态渲染的组件，你就可以编写一个 CUE 格式的文件，如下所示。
|
||||
|
||||
|
|
@ -133,7 +100,7 @@ parameter: {
|
|||
|
||||
可以看到上面例子中的 `output` 中描述了一个 `k8s-object` 类型的组件，其中 `properties.data.input` 需要在启用时根据输入参数指定。插件在启用时的参数都需要以 CUE 的语法编写在 `parameter.cue` 文件当中。 UX/CLI 在启用插件时会把全部的 CUE 文件和 `parameter.cue` 放在一个上下文中进行渲染，最终得到一系列的组件并添加到应用当中。
|
||||
|
||||
你也可以通过 [CUE 基础入门文档](../cue/basic) 了解 CUE 的具体语法。
|
||||
你也可以通过 [CUE 基础入门文档](../cue/basic) 了解 CUE 的具体语法。
|
||||
|
||||
### 模块定义文件 (X-Definitions) 目录 (非必须)
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 146 KiB |
Loading…
Reference in New Issue