KubeBlocks
BlogsKubeBlocks Cloud

Getting Started

Introduction
Supported addons
Installation

Concepts and Features

Concepts

Backup and Restore

Introduction

Backup

Configure BackupRepo
Configure BackupPolicy
Scheduled backup
On-demand backup

Restore

Restore from backup set
Point-in-Time Recovery

In Place Update

Introduction
Enable in-place update

Instance Template

Introduction
Apply instance template

Trouble Shooting

FAQs

References

API Reference

Cluster
Operations
Parameters
Dataprotection
Add-On
Terminology
Install Addons
Install kbcli
Snapshot Controller
Create a test Kubernetes cluster
Kubernetes and Operator 101

Upgrade KubeBlocks

Upgrade to v0.8
Upgrade to v0.9.0
Upgrade to v0.9.x

Release Notes

v1.0.0-cn
v1.0.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0

    Install Addons

    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 elasticsearch as an example. You can replace elasticsearch with the Addon you need.

    The official index repo is KubeBlocks index. Addons are maintained in the KubeBlocks Addon repo.

    NOTE

    Make sure the major version of Addons and KubeBlocks are the same.

    For example, you can install an Addon v0.9.0 with KubeBlocks v0.9.2, but using mismatched major versions, such as an Addon v0.8.0 with KubeBlocks v0.9.2, may lead to errors.

    1. (Optional) Add the KubeBlocks repo. If you install KubeBlocks with Helm, just run helm repo update.

      helm repo add kubeblocks https://apecloud.github.io/helm-charts
      helm repo update
      
    2. View the Addon versions.

      helm search repo kubeblocks/elasticsearch --devel --versions
      
    3. Install the Addon (take elasticsearch as example). Specify a version with --version.

      helm install kb-addon-es kubeblocks/elasticsearch --namespace kb-system --create-namespace --version <VERSION>
      
    4. Verify whether this Addon is installed.

      The STATUS is deployed and this Addon is installed successfully.

      helm list -A
      >
      NAME             NAMESPACE	REVISION	UPDATED                                STATUS  	 CHART                   APP VERSION
      ...
      kb-addon-es      kb-system	1       	2024-11-27 10:04:59.730127 +0800 CST   deployed	 elasticsearch-0.9.0     8.8.2
      
    5. (Optional) You can run the command below to uninstall the Addon.

      If you have created a related cluster, delete the cluster first.

      helm uninstall kb-addon-es --namespace kb-system
      
    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 elasticsearch
      >
      ADDON           VERSION         INDEX
      elasticsearch   0.7.0           kubeblocks
      elasticsearch   0.7.1           kubeblocks
      elasticsearch   0.7.2           kubeblocks
      elasticsearch   0.8.0           kubeblocks
      elasticsearch   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 elasticsearch --index kubeblocks --version <VERSION>
      
    4. Verify whether this Addon is installed.

      The STATUS is Enabled and this Addon is installed successfully.

      kbcli addon list
      >
      NAME                           VERSION        PROVIDER    STATUS     AUTO-INSTALL
      elasticsearch                  0.9.0          apecloud    Enabled    true
      
    5. (Optional) You can run the command below to disable the Addon.

      If you have created a related cluster, delete the cluster first.

      kbcli addon disable elasticsearch
      

      Or you can run the command below to uninstall the Addon.

      kbcli addon uninstall elasticsearch
      
    NOTE

    kbcli supports enable/disable an Addon. You can enable/disable Addons according to your need. Moreover, when installing KubeBlocks by kbcli, some Addons are installed but remain disabled by default, with their status shown as Disabled. You can enable them by kbcli. For example,

    1. Disable/Enable Addons
    • Enable an Addon.
    kbcli addon enable qdrant
    
    • Disable an Addon.
    kbcli addon disable qdrant
    

    After enabling/disabling an Addon, check the Addon list to verify whether the Addon's status changes as required.

    © 2025 ApeCloud PTE. Ltd.