KubeBlocks
BlogsKubeBlocks Cloud
⌘K
​

Overview

Introduction
Concepts
Kubernetes and Operator 101
Supported addons
About this manual

Try out KubeBlocks with Playground

Try out KubeBlocks on cloud
Try out KubeBlocks on laptop

Installation

Prerequisite for Local Env

Prerequisite for Local Env
Install kbcli
Install KubeBlocks
Install Addons
Uninstall KubeBlocks and kbcli

Upgrade KubeBlocks

Upgrade to v0.8
Upgrade to v0.9.0
Upgrade to v0.9.3
FAQ

Connect Database

Overview
Testing environment
Production environment

Maintenance

Scale

Horizontal Scale
Vertical Scale

Backup and Restore

Introduction

Backup

Configure BackupRepo
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

Monitor database
Configure alert

User Management

Manage user accounts

Handle an Exception

Handle an exception
Full disk lock

Developer

Developer guides
Terminology

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

    Add-ons of KubeBlocks

    KubeBlocks is a control and management platform to manage a bunch of database engines and other add-ons.

    This series provides basic knowledge of add-ons, so you can get a quick start and become a member of the KubeBlocks community.

    KubeBlocks features a rich add-on ecosystem with major databases, streaming and vector databases, including:

    • Relational Database: ApeCloud-MySQL (MySQL RaftGroup cluster), PostgreSQL (Replication cluster)
    • NoSQL Database: MongoDB, Redis
    • Graph Database: Nebula (from community contributors)
    • Time Series Database: TDengine, Greptime (from community contributors)
    • Vector Database: Milvus, Qdrant, Weaviate, etc.
    • Streaming: Kafka, Pulsar, ElasticSearch

    Adding an add-on to KubeBlocks is easy, you can just follow this guide to add the add-on to KubeBlocks as long as you know the followings:

    1. How to write a YAML file (e.g., You should know how many spaces to add when indenting with YAML).
    2. Knowledge about Helm (e.g. What is Helm and Helm chart).
    3. Have tried K8s (e.g., You should know what a pod is, or have installed an operator on K8s with Helm).
    4. Grasp basic concepts of KubeBlocks, such as ClusterDefinition, ClusterVersion and Cluster.

    If you have any question, you can join our slack channel to ask.

    © 2025 ApeCloud PTE. Ltd.