Version: v1.3

Addon management

You can get more capabilities from KubeVela ecosystem by installing addons.

Users with addon management permissions can enter the addon management page to enable or disable addons.

addon list

In the addon list, you can get the status of the addon and other info. Click the addon name could open the addon detail page, you can get the version list, definitions provided by the addon, and the readme message.

addon detail

Select a version and deployed clusters, you can click the enable button to install this addon.

For enabled addons, if no applications to use definitions, you can click the disable button to uninstall it.

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.

  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.

You can choose one special version of this addon by add --version flag in this command. eg:

  1. 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:

  1. 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.

Please make sure this addon along with the capabilities is no longer used in any of your applications.

  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
  1. $ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/
  2. Successfully add an addon registry experimental
  1. $ vela addon registry delete experimental
  2. Successfully delete an addon registry experimental

For some reason, if your cluster network cannot request the official addon registry you can enable an addon with a local dir. eg:

  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

Please notice that, while a addon installing cluster maybe still need pull some images or helm charts.If your cluster cannot reach these resources please refer docs to do complete installation without Internet.

Refer to extension documents to learn how to make your own addon and registry.

Last updated on Nov 1, 2022 by Tianxin Dong