版本：v1.3

插件管理

你可以通过安装 KubeVela 的插件（Addon）获取更多的系统功能。

具有插件管理权限的用户可以进入插件管理页面，进行插件启用/停用等操作。

addon list

如上图所示，在插件列表中，你可以查看到插件启用状态和其他基础信息。点击插件名称可以进入到插件详情页面，你可以查询到插件的版本列表，提供的扩展类型和介绍信息。

addon detail

选择一个部署版本（默认为最新），设置需要部署的集群后，你可以点击 启用 按钮安装该插件。对于已启用的插件，如果没有应用使用该插件提供的扩展，你可以点击禁用按钮来卸载它。

KubeVela 官方团队维护了一个默认的插件仓库 (https://addons.kubevela.net) ，默认情况下会从这个仓库实时发现。

  1. $ vela addon list
  2. NAME                            REGISTRY        DESCRIPTION                                                                                             AVAILABLE-VERSIONS              STATUS          
  3. 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        
  4. rollout                         KubeVela        Provides basic batch publishing capability.                                                             [1.3.0, 1.2.4, 1.2.3]           disabled        
  5. terraform-baidu                 KubeVela        Kubernetes Terraform Controller Provider for Baidu Cloud                                                [1.0.1, 1.0.0]                  disabled        
  6. terraform-tencent               KubeVela        Kubernetes Terraform Controller Provider for Tencent Cloud                                              [1.0.1, 1.0.0]                  disabled        
  7. model-serving                   KubeVela        Enable serving for models                                                                               [1.0.0]                         disabled        
  8. model-training                  KubeVela        Enable training for models                                                                              [1.0.0]                         disabled        
  9. terraform                       KubeVela        Terraform Controller is a Kubernetes Controller for Terraform.                                          [1.0.6]                         disabled        
  10. terraform-aws                   KubeVela        Kubernetes Terraform Controller for AWS                                                                 [1.0.1, 1.0.0]                  disabled        
  11. terraform-azure                 KubeVela        Kubernetes Terraform Controller for Azure                                                               [1.0.1, 1.0.0]                  disabled        
  12. terraform-gcp                   KubeVela        Kubernetes Terraform Controller Provider for Google Cloud Platform                                      [1.0.1, 1.0.0]                  disabled        
  13. dex                             KubeVela        Enable dex for login                                                                                    [0.6.5]                         disabled        
  14. ocm-hub-control-plane           KubeVela        ocm-hub-control-plane can install OCM hub control plane to the central cluster.                         [0.6.0]                         disabled        
  15. terraform-ucloud                KubeVela        Kubernetes Terraform Controller Provider for UCloud                                                     [1.0.1, 1.0.0]                  disabled        
  16. fluxcd                          KubeVela        Extended workload to do continuous and progressive delivery                                             [1.1.0, 1.0.0]                  disabled
  17. 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)
  18. terraform-alibaba               KubeVela        Kubernetes Terraform Controller for Alibaba Cloud                                                       [1.0.2, 1.0.1]                  disabled
  1. $ vela addon enable fluxcd
  2. I0111 21:45:24.553174   89345 apply.go:106] "creating object" name="addon-fluxcd" resource="core.oam.dev/v1beta1, Kind=Application"
  3. I0111 21:45:25.258914   89345 apply.go:106] "creating object" name="helm" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition"
  4. I0111 21:45:25.342731   89345 apply.go:106] "creating object" name="kustomize-json-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition"
  5. I0111 21:45:25.382201   89345 apply.go:106] "creating object" name="kustomize-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition"
  6. I0111 21:45:25.411723   89345 apply.go:106] "creating object" name="kustomize" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition"
  7. I0111 21:45:25.625815   89345 apply.go:106] "creating object" name="kustomize-strategy-merge" resource="core.oam.dev/v1beta1, Kind=TraitDefinition"
  8. I0111 21:45:25.660129   89345 apply.go:106] "creating object" name="component-uischema-helm" resource="/v1, Kind=ConfigMap"
  9. Addon: fluxcd enabled Successfully.

你可以通过通过设置 --version 启动参数，来指定安装插件的某个特定版本。例如：

  1. vela addon enable fluxcd --version=1.0.0

如果不指定该参数，默认会安装此插件的最新版本。

启用一个插件时，默认会在所有子集群中安装该插件，你也可以通过设置 --cluster 启动参数选择安装在某些集群当中。例如：

  1. vela addon enable <addon-name> --clusters={cluster1,cluster2}

安装完成后，插件中的功能会以组件，运维特征，工作流步骤等形式呈现，你可以通过 vela component，vela trait 等命令查看新增的能力，也可以在插件的参考文档中查看每个官方插件对应的能力.

删除前请确认插件对应的能力没有被任何应用使用。

  1. $ vela addon disable fluxcd
  2. Successfully disable addon:fluxcd
  1. $ vela addon registry list 
  2. Name            Type    URL                        
  3. KubeVela        helm    https://addons.kubevela.net

KubeVela 社区在 Github 上维护了一个官方的正式插件包仓库 和一个试验阶段插件包仓库 。你在相应的仓库中找到插件包的定义文件。

同时这些文件会被同步到 对象存储 当中，以加快下载速度。

你可以添加自己的插件包仓库，目前支持 OSS 和 Github 两种仓库类型。

  1. $ vela addon registry add experimental --type OSS --endpoint=https://addons.kubevela.net --path=experimental/
  2. Successfully add an addon registry experimental
  1. $ vela addon registry delete experimental
  2. Successfully delete an addon registry experimental

如果你的环境中添加了若干个子集群，启用插件包时会默认在管控集群和所有子集群中安装此插件包。但如果子集群在某个插件包启用之后加入环境当中，则需要通过升级操作在新加入集群中安装此插件包。如下所示

  1. $ vela addon upgrade velaux
  2. Addon: 
  3.  enabled Successfully

如果因为某些原因，你的环境无法通过访问插件包仓库，你可以通过指定本地的插件包目录来进行离线安装。如下所示：

  1. $ ls
  2. README.md           fluxcd              ocm-cluster-manager terraform           terraform-alibaba   terraform-aws       terraform-azure     velaux
  4. $ vela addon enable velaux/
  5. Addon: velaux enabled Successfully

需要注意的是，在安装插件过程当中，仍可能需要从网络中拉取镜像或者 helm chart，如果你的网络环境同样无法访问这些地址，请参考文档进行完整的离线安装。

请参考插件包制作文档。

Last updated on 2022年11月1日 by Tianxin Dong