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.

Advanced Configuration

Set Addon Values

You can customize the Addon values when installing or enabling an Addon, for example, set the image registry.

Step 1. Check the full list of values can be set:

helm show values kubeblocks/elasticsearch --version 1.0.0

Where kubeblocks is the name of the addon helm repository, elasticsearch is the name of the chart, and 1.0.0 is the version of the chart.

Or you can go to KubeBlocks Addon repository and choose the right version to check more details.

Expected output:

image:
   registry: docker.io
   repository: apecloud/elasticsearch
   exporter:
      repository: apecloud/elasticsearch-exporter
      tag: "v1.7.0"
   plugin:
      repository: apecloud/elasticsearch-plugins
      tag: "8.8.2"
... # more values omitted for brevity

Step 2. Update image registry to your private registry:

helm upgrade -i kb-addon-elasticsearch kubeblocks/elasticsearch --namespace kb-system --version 1.0.0 --set image.registry=test.io # more values omitted for brevity

kbcli addon enable kb-addon-elasticsearch --set image.registry=test.io # more values omitted for brevity

Step 3. Verify the changes.

• Check the helm chart values.

  helm get values kb-addon-elasticsearch -n kb-system
  

  Expected output:

  image:
     registry: test.io
     .. # more values omitted for brevity
  

  Check if all values are updated as expected.

• Check ComponentVersion CR if all the images are updated.

  Each KubeBlocks Addon has its own ComponentVersion CR to record the list of service versions and the list of images use for each version.

  kubectl get cmpv elasticsearch -oyaml | yq '.spec.releases[].images'
  

  Expected output:

  elasticsearch: test.io/apecloud/elasticsearch:7.7.1  # using test.io instead of docker.io
  

  All images are using the private registry test.io as expected.

• Check the ComponentDefinition CR if all the images are updated.

  # for each ComponentDefinition CR, check the images field
  kubectl get cmpd -l app.kubernetes.io/instance=kb-addon-elasticsearch -oyaml  | yq '.items[].spec' | grep 'image:'
  

• Check the ComponentDefinition Status after the changes.

  # check the status of the ComponentDefinition CRs
  kubectl get cmpd -l app.kubernetes.io/instance=kb-addon-elasticsearch
  

  Expected output:

  NAME                    SERVICE         SERVICE-VERSION   STATUS      AGE
  elasticsearch-7-1.0.0   elasticsearch                     Available   33m
  elasticsearch-8-1.0.0   elasticsearch                     Available   33m
  

  If the status is Unavailable, you can describe the ComponentDefinition CR to see the error message.

  kubectl describe cmpd -l app.kubernetes.io/instance=kb-addon-elasticsearch
  

  If the message is immutable fields can't be updated as below,

  Status:
  Message:              immutable fields can't be updated
  Observed Generation:  3
  Phase:                Unavailable
  

  You need to annotate the ComponentDefinition CR to allow the changes.

  kubectl annotate cmpd -l app.kubernetes.io/instance=kb-addon-elasticsearch apps.kubeblocks.io/skip-immutable-check=true
  

  Then the status will be Available again.