Install Addons

Use the index to install an Addon

With the release of KubeBlocks v0.8.0, Addons are decoupled from KubeBlocks and some Addons are not installed by default. If you want to use these Addons, install Addons first by index. Or if you uninstalled some Addons, you can follow the steps in this tutorial to install them again.

This tutorial takes etcd as an example. You can replace etcd with the Addon you need.

The official index repo is KubeBlocks index. The code of all Addons is maintained in the KubeBlocks Addon repo.

1. View the index.

   kbcli creates an index named kubeblocks by default and you can check whether this index is created by running kbcli addon index list.

   kbcli addon index list
   >
   INDEX        URL
   kubeblocks   https://github.com/apecloud/block-index.git 

   If the list is empty or you want to add your index, you can add the index manually by using kbcli addon index add <index-name> <source>. For example,

   kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git

   If you are not sure whether the kubeblocks index is the latest version, you can update it.

   kbcli addon index update kubeblocks

2. (Optional) Search whether the Addon exists in the index.

   kbcli addon search etcd
   >
   ADDON   VERSION         INDEX
   etcd    0.7.0           kubeblocks
   etcd    0.8.0           kubeblocks
   etcd    0.9.0           kubeblocks

3. Install the Addon.

   If there are multiple index sources and versions for an Addon, you can specify an index by --index and a version by --version. The system installs the latest version in the kubeblocks index by default.

   kbcli addon install etcd --index kubeblocks --version x.y.z

   What's next

   After the Addon is installed, you can list and enable it.

List Addons

To list supported Addons, run kbcli addon list command.

Enable/Disable Addons

To manually enable or disable Addons, follow the steps below.

Steps:

1. To enable an Addon, use kbcli addon enable.

   Example

   kbcli addon enable etcd

   To disable an Addon, use kbcli addon disable.

2. List the Addons again to check whether it is enabled.

   kbcli addon list

Uninstall Addons

You can also uninstall the Addons. If you have created a related cluster, delete the cluster first.

kbcli cluster delete <name>

Uninstall an Addon.

kbcli addon uninstall etcd