KubeBlocks

# Step 1: Install CRDs
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/{{VERSION}}/kubeblocks_crds.yaml

# Step 2: Configure Helm Repository
helm repo add kubeblocks https://apecloud.github.io/helm-charts
helm repo update

# Step 3: Deploy KubeBlocks
helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace --version={{VERSION}}

unknown field "x-kubernetes-validations".... if you choose to ignore these errors, turn validation off with --validate\=false

kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/{{VERSION}}/kubeblocks_crds.yaml --validate\=false

Need a different version?

For other versions, you can find available releases on KubeBlocks Releases or query using:

# Get latest stable release
curl -s https://api.github.com/repos/apecloud/kubeblocks/releases/latest | jq -r '.tag_name'

# Get all releases (including pre-releases)
curl -s https://api.github.com/repos/apecloud/kubeblocks/tags | jq -r '.[0].name'

kubectl -n kb-system get pods

NAME                                             READY   STATUS    RESTARTS       AGE
kubeblocks-7cf7745685-ddlwk                      1/1     Running   0              4m39s
kubeblocks-dataprotection-95fbc79cc-b544l        1/1     Running   0              4m39s

helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace \
--version {{VERSION}} \
--set image.registry=docker.io \
--set dataProtection.image.registry=docker.io \
--set addonChartsImage.registry=docker.io

helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace \
--version {{VERSION}} \
--set-json 'tolerations=[ { "key": "control-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' \
--set-json 'dataPlane.tolerations=[{ "key": "data-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true"}]'

1. Installation

helm install kubeblocks kubeblocks/kubeblocks \
  --namespace kb-system \
  --create-namespace \
  --version {{VERSION}} \
  --set featureGates.inPlacePodVerticalScaling.enabled=true

1. Upgrade

helm upgrade kubeblocks kubeblocks/kubeblocks \
  --namespace kb-system \
  --version {{VERSION}} \
  --set featureGates.inPlacePodVerticalScaling.enabled=true

1. List all addons

# list all addons
helm list -n kb-system | grep kb-addon

2. Uninstall all Addons.

helm list -n kb-system | grep kb-addon | awk '{print $1}' | xargs -I {} helm -n kb-system uninstall {}

While uninstalling, you will get messages like

Release "kb-addon-etcd" uninstalled
These resources were kept due to the resource policy:
[ConfigMap] kafka27-configuration-tpl-1.0.0
[ComponentDefinition] kafka-combine-1.0.0
[ComponentDefinition] kafka-controller-1.0.0
[ComponentDefinition] kafka-exporter-1.0.0
[ComponentDefinition] kafka27-broker-1.0.0
[ComponentDefinition] kafka-broker-1.0.0

Some resources are kept due to resource policy, then check and remove them all

3. Check remaining resources, such as ComponentDefinition, ConfigMaps for Configuration, and remove them all.

kubectl get componentdefinitions.apps.kubeblocks.io
kubectl get parametersdefinitions.parameters.kubeblocks.io
kubectl get configmap -n kb-system | grep configuration
kubectl get configmap -n kb-system | grep template

For example

kubectl delete componentdefinitions.apps.kubeblocks.io --all
kubectl delete parametersdefinitions.parameters.kubeblocks.io --all
kubectl get configmap -n kb-system | grep configuration  | awk '{print $1}' | xargs -I {} kubectl delete -n kb-system cm {}
kubectl get configmap -n kb-system | grep template| awk '{print $1}' | xargs -I {} kubectl delete -n kb-system cm {}

4. Delete Addon CRs

kubectl delete addon.extensions.kubeblocks.io --all

5. Verify all KubeBlocks resources are deleted

kubectl get crd  | grep kubeblocks.io | awk '{print $1}' | while read crd; do
  echo "Processing CRD: $crd"
  kubectl get "$crd" -o json | jq '.items[] | select(.metadata.finalizers != null) | .metadata.name' -r | while read resource; do
    echo "Custom Resource left: $resource in CRD: $crd"
  done
done

If the output shows any custom resource left, please remove them all.

6. Uninstall KubeBlocks

helm uninstall kubeblocks --namespace kb-system

Helm does not delete CRD objects. You can delete the ones KubeBlocks created with the following commands:

kubectl get crd -o name | grep kubeblocks.io | xargs kubectl delete

7. Verify all KubeBlocks resources are deleted

kubectl get crd  | grep kubeblocks.io | awk '{print $1}' | while read crd; do
  echo "Processing CRD: $crd"
  kubectl get "$crd" -o json | jq '.items[] | select(.metadata.finalizers != null) | .metadata.name' -r | while read resource; do
    echo "Custom Resource left: $resource in CRD: $crd"
  done
done

The output should be empty.