Overview

Try out KubeBlocks with Playground

Try out KubeBlocks on cloud

Try out KubeBlocks on laptop

Installation

Prerequisite for Local Env

Install kbcli

Install KubeBlocks

Install Addons

Uninstall KubeBlocks and kbcli

Upgrade KubeBlocks

Connect Database

Production environment

Maintenance

Scale

Backup and Restore

Backup

Configure BackupPolicy

Scheduled backup

On-demand backup

Restore

Restore from backup set

PITR

In Place Update

Overview on in-place update

Enable in-place update

Resource Scheduling

Configure pod affinity for database clusters

Cross K8s Deployment

Deploy a Cluster across Multiple Kubernetes Clusters by KubeBlocks

Instance Template

Introduction of instance template

Apply instance template

Observability

User Management

Handle an Exception

Developer

Add an add-on to KubeBlocks

Add-ons of KubeBlocks

Add an add-on

Backup and restore

Parameter template

Parameter configuration

Monitoring

Multi-component configuration

Environment variables and placeholders

External Component

Reference external component

API Reference

Cluster

Backup

Add-On

Uninstall KubeBlocks and kbcli

Uninstallation order:

Delete all clusters and backups before uninstalling KubeBlocks and kbcli.

kubectl delete cluster <clustername> -n namespace

kubectl delete backup <backname> -n namespace

Uninstall KubeBlocks.

Uninstall KubeBlocks

Delete all the clusters and resources created before performing the following command, otherwise the uninstallation may not be successful.

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

You can generate YAMLs from the KubeBlocks chart and uninstall using kubectl. Use --version x.y.z to specify a version and make sure the uninstalled version is the same as the installed one.

helm template kubeblocks kubeblocks/kubeblocks --namespace kb-system --version x.y.z | kubectl delete -f -

kbcli kubeblocks uninstall

Uninstall kbcli

Uninstall kbcli if you want to delete kbcli after your trial. Use the same option as the way you install kbcli.

For curl, run

sudo rm /usr/local/bin/kbcli

For brew, run

brew uninstall kbcli

kbcli creates a hidden folder named ~/.kbcli under the HOME directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.

Go to the kbcli installation path and delete the installation folder.
- If you install kbcli by script, go to C:\Program Files and delete the kbcli-windows-amd64 folder.
- If you customize the installation path, go to your specified path and delete the installation folder.
Delete the environment variable.
1. Click the Windows icon and click System.
2. Go to Settings -> Related Settings -> Advanced system settings.
3. On the Advanced tab, click Environment Variables.
4. Double-click Path in User variables or System variables list.
  - If you install kbcli by script, double-click Path in User variables.
  - If you customize the installation path, double-click Path based on where you created the variable before.
5. Select C:\Program Files\kbcli-windows-amd64 or your customized path and delete it. This operation requires double confirmation.
Delete a folder named .kbcli.

kbcli creates a folder named .kbcli under the C:\Users\username directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.

Uninstall kbcli using the curl command.

sudo rm /usr/local/bin/kbcli

kbcli creates a hidden folder named ~/.kbcli under the HOME directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.

Uninstall KubeBlocks

Delete all the clusters and resources created before performing the following command, otherwise the uninstallation may not be successful.

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

You can generate YAMLs from the KubeBlocks chart and uninstall using kubectl. Use --version x.y.z to specify a version and make sure the uninstalled version is the same as the installed one.

helm template kubeblocks kubeblocks/kubeblocks --namespace kb-system --version x.y.z | kubectl delete -f -

kbcli kubeblocks uninstall

Uninstall kbcli

Uninstall kbcli if you want to delete kbcli after your trial. Use the same option as the way you install kbcli.

For curl, run

sudo rm /usr/local/bin/kbcli

For brew, run

brew uninstall kbcli

kbcli creates a hidden folder named ~/.kbcli under the HOME directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.

Go to the kbcli installation path and delete the installation folder.
- If you install kbcli by script, go to C:\Program Files and delete the kbcli-windows-amd64 folder.
- If you customize the installation path, go to your specified path and delete the installation folder.
Delete the environment variable.
1. Click the Windows icon and click System.
2. Go to Settings -> Related Settings -> Advanced system settings.
3. On the Advanced tab, click Environment Variables.
4. Double-click Path in User variables or System variables list.
  - If you install kbcli by script, double-click Path in User variables.
  - If you customize the installation path, double-click Path based on where you created the variable before.
5. Select C:\Program Files\kbcli-windows-amd64 or your customized path and delete it. This operation requires double confirmation.
Delete a folder named .kbcli.

kbcli creates a folder named .kbcli under the C:\Users\username directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.

Uninstall kbcli using the curl command.

sudo rm /usr/local/bin/kbcli

kbcli creates a hidden folder named ~/.kbcli under the HOME directory to store configuration information and temporary files. You can delete this folder after uninstalling kbcli.