# KubeBlocks

> KubeBlocks is an open-source Kubernetes operator that manages 35+ database
> engines (MySQL, PostgreSQL, MongoDB, Redis, Valkey, Kafka, Elasticsearch,
> ClickHouse, Pulsar, Milvus, RabbitMQ, Qdrant, MariaDB, StarRocks, etc.)
> via unified CRD APIs. It simplifies Day-2 operations — backup, failover,
> scaling, monitoring, and point-in-time recovery (PITR) — through a single control plane.

## Project
- GitHub: https://github.com/apecloud/kubeblocks (AGPL-3.0)
- Stars: 2500+
- Docs: https://kubeblocks.io/docs/preview/
- Databases hub: https://kubeblocks.io/databases
- CLI (kbcli): companion tool for kubectl
- Key CRDs: ClusterDefinition, ComponentDefinition, Cluster, Component
- Current stable version: 1.0.x

## Operator landing pages
- MySQL Operator for Kubernetes (Raft HA, multi-primary, PITR, read replicas): https://kubeblocks.io/mysql-operator
- Oracle Operator for Kubernetes (Oracle 12c Data Guard, FSFO, RMAN backup/restore): https://kubeblocks.io/oracle-operator
- PostgreSQL Operator for Kubernetes (streaming replication, Patroni HA, PITR, connection pooling): https://kubeblocks.io/pg-operator
- MongoDB Operator for Kubernetes (replica sets, sharded clusters, WT storage, PITR): https://kubeblocks.io/mongodb-operator
- Redis Operator for Kubernetes (Sentinel HA, cluster mode, ACL, TLS, backup): https://kubeblocks.io/redis-operator
- Kafka Operator for Kubernetes (KRaft mode, no ZooKeeper, combined/separated topology, topic/ACL/quota management): https://kubeblocks.io/kafka-operator
- ZooKeeper Operator for Kubernetes (ZAB consensus, leader routing, quorum-safe scaling, snapshot backup): https://kubeblocks.io/zookeeper-operator
- Milvus Operator for Kubernetes (vector database, standalone/distributed topology, billion-scale ANN search, milvus-backup): https://kubeblocks.io/milvus-operator
- Elasticsearch Operator for Kubernetes (multi-node HA, dedicated master/data/ingest/transform roles, snapshot backup, rolling upgrades): https://kubeblocks.io/elasticsearch-operator
- etcd Operator for Kubernetes (Raft HA, automatic leader election, snapshot backup, horizontal scaling): https://kubeblocks.io/etcd-operator
- ClickHouse Operator for Kubernetes (sharding 1–128, ClickHouse Keeper HA, full/incremental backup, ReplicatedMergeTree): https://kubeblocks.io/clickhouse-operator

## Supported database engines
| Engine | Category | Docs |
|--------|----------|------|
| MySQL | Relational | https://kubeblocks.io/docs/preview/kubeblocks-for-mysql |
| Oracle | Relational | https://kubeblocks.io/docs/preview/kubeblocks-for-oracle |
| PostgreSQL | Relational | https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql |
| MariaDB | Relational | — |
| TiDB | Relational | — |
| OceanBase CE | Relational | — |
| PolarDB-X | Relational | — |
| MongoDB | Document | https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb |
| Redis | Cache / KV | https://kubeblocks.io/docs/preview/kubeblocks-for-redis |
| Valkey | Cache / KV | https://kubeblocks.io/docs/release-1_0_2/kubeblocks-for-valkey |
| etcd | Cache / KV | https://kubeblocks.io/docs/preview/kubeblocks-for-etcd |
| Kafka | Message Queue | https://kubeblocks.io/docs/preview/kubeblocks-for-kafka |
| Pulsar | Message Queue | https://kubeblocks.io/docs/release-0_9/kubeblocks-for-pulsar |
| RabbitMQ | Message Queue | https://kubeblocks.io/rabbitmq-operator |
| RocketMQ | Message Queue | https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq |
| Elasticsearch | Search | https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch |
| OpenSearch | Search | — |
| ClickHouse | OLAP | https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse |
| StarRocks | OLAP | https://kubeblocks.io/docs/release-1_0_2/kubeblocks-for-starrocks |
| Doris | OLAP | — |
| RisingWave | OLAP | — |
| InfluxDB | Time Series | — |
| VictoriaMetrics | Time Series | — |
| GreptimeDB | Time Series | — |
| Milvus | Vector DB | https://kubeblocks.io/docs/preview/kubeblocks-for-milvus |
| Qdrant | Vector DB | https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant |
| Weaviate | Vector DB | — |
| FalkorDB | Vector DB | — |
| Neo4j | Graph DB | — |
| Nebula Graph | Graph DB | — |
| Xinference | AI / Inference | — |
| ZooKeeper | Coordination | https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper |
| MinIO | Object Storage | https://kubeblocks.io/docs/preview/kubeblocks-for-minio |

## Documentation index
- Site: https://kubeblocks.io/
- Full index: https://kubeblocks.io/llms-full.txt
- XML sitemap: https://kubeblocks.io/sitemap.xml
- RSS feed: https://kubeblocks.io/blog/feed.xml

## Product quickstarts
- ClickHouse Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/02-quickstart
- Elasticsearch Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/02-quickstart
- etcd Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/02-quickstart
- Kafka Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/02-quickstart
- Milvus Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/02-quickstart
- MinIO Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/02-quickstart
- MongoDB Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/02-quickstart
- Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/02-quickstart
- PostgreSQL Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/02-quickstart
- Qdrant Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/02-quickstart
- RabbitMQ Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/02-quickstart
- Redis Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/02-quickstart
- RocketMQ Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/02-quickstart
- ZooKeeper Quickstart: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/02-quickstart

## Product overviews
- KubeBlocks for ClickHouse: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/01-overview
- Overview of KubeBlocks Elasticsearch Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/01-overview
- Overview of KubeBlocks etcd Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/01-overview
- Overview of KubeBlocks Kafka Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/01-overview
- Overview of KubeBlocks Milvus Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/01-overview
- KubeBlocks for MinIO Overview: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/01-overview
- Overview of KubeBlocks MongoDB Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/01-overview
- Overview of KubeBlocks MySQL Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/01-overview
- Overview of KubeBlocks PostgreSQL Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/01-overview
- Overview of KubeBlocks Qdrant Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/01-overview
- Overview of KubeBlocks RabbitMQ Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/01-overview
- Overview of KubeBlocks Redis Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/01-overview
- KubeBlocks for RocketMQ: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/01-overview
- Overview of KubeBlocks ZooKeeper Addon: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/01-overview

## Recent blogs
- Community Monthly Report for April 2024: https://kubeblocks.io/blog/Community-Monthly-Report-for-April-2024
- Community Monthly Report for February 2024: https://kubeblocks.io/blog/Community-Monthly-Report-for-February-2024
- Community Monthly Report for January 2024: https://kubeblocks.io/blog/Community-Monthly-Report-for-January-2024
- Community Monthly Report for March 2024: https://kubeblocks.io/blog/Community-Monthly-Report-for-March-2024
- Community Monthly Report for May 2024: https://kubeblocks.io/blog/Community-Monthly-Report-for-May-2024
- Practical Experience in Validating KubeBlocks Addon Availability with Chaos Mesh: https://kubeblocks.io/blog/validating-kubeblocks-addon-availability-with-chaos-mesh
- We Let an AI Agent Manage Our Databases. Here's Why Most Operators Failed It.: https://kubeblocks.io/blog/we-let-an-ai-agent-manage-our-databases
- KubeBlocks x Redis: Streamlining Redis Cluster and Solving Network Compatibility: https://kubeblocks.io/blog/kubeblocks-x-redis-streaming-redis-cluster-and-solving-network-compatibility
- Managing Over 6,000 Self-Hosted Databases Without a DBA - How a Single Engineer Leveraged KubeBlocks to Make It Possible: https://kubeblocks.io/blog/manage-6k-db-instance-with-kubeblocks
- Resource Utilization Boost - Large-Scale Redis Migration from Bare Metal to Kubernetes: https://kubeblocks.io/blog/migrate-redis-at-kuaishou-from-bare-metal-to-k8s
- Deploy Moodle on K8s with KubeBlocks MySQL Operator: https://kubeblocks.io/blog/moodle-in-kubeblocks
- A Deep Dive into Troubleshooting and Resolving a SQL Server TCP Blackhole on an OKE Cluster: https://kubeblocks.io/blog/oci-mssql-tcp-blackhole-troubleshooting
- Redis Operatorization - Ready Yet?: https://kubeblocks.io/blog/redis-operatorization-ready-yet
- Running Databases on Kubernetes - Insights from Leading Chinese Internet Companies: https://kubeblocks.io/blog/run-databases-on-k8s-insights-from-leading-chinese-internet-companies
- How to Take Specified Instances Offline?: https://kubeblocks.io/blog/take-specified-instances-offline
- Use KubeBlocks to build your AIGC infrastructure on Amazon EKS: https://kubeblocks.io/blog/Use-KubeBlocks-to-build-your-AIGC-infrastructure-on-Amazon-EKS
- Is Kubernetes a Database? A Deep Dive into IaD and Declarative APIs: https://kubeblocks.io/blog/is-k8s-a-database
- Securing Your Workloads with Kata Containers - Running KubeBlocks on Kata: https://kubeblocks.io/blog/kubeblocks-on-kata
- KubeBlocks x Clickhouse: Production-Ready Operator on Kubernetes: https://kubeblocks.io/blog/kubeblocks-x-clickhouse-production-ready-operator-on-kubernetes
- KubeBlocks x Milvus: Kubernetes Operator Guide: https://kubeblocks.io/blog/kubeblocks-x-milvus-kubernetes-operator-guide