# KubeBlocks

> KubeBlocks is an enterprise-grade, open-source database control plane for Kubernetes.
> It lets platform teams deploy and operate 15+ database engines — MySQL, PostgreSQL,
> MongoDB, Redis, Kafka, ClickHouse, Elasticsearch, vector databases and more — through
> a single, unified API. KubeBlocks handles Day-2 operations: high availability, automated
> failover, backup and restore, point-in-time recovery, scaling, parameter management,
> and built-in Prometheus/Grafana observability.

## Company

- **Vendor**: ApeCloud (https://kubeblocks.com)
- **GitHub**: https://github.com/apecloud/kubeblocks (Apache-2.0 / AGPL-3.0)
- **Docs**: https://kubeblocks.io/docs/preview/
- **Contact**: https://kubeblocks.com/contact

## Products

### KubeBlocks Community Edition
- Free, open-source Kubernetes operator
- Manages stateful database workloads via CRD APIs (ClusterDefinition, ComponentDefinition, Cluster)
- Key CRDs: `ClusterDefinition`, `ComponentDefinition`, `Cluster`, `Component`, `OpsRequest`
- CLI companion: `kbcli`

### KubeBlocks Enterprise Edition
- URL: https://kubeblocks.com/products/kubeblocks-enterprise
- Extends the community edition for enterprise DBaaS construction
- Adds: multi-tenancy, LDAP/SSO integration, advanced scheduling (anti-affinity, topology spread),
  parameter templates, commercial database support (Oracle, SQL Server, DM, GaussDB),
  enterprise SLA and support

## Supported Database Engines (Addons)

- [MySQL](https://kubeblocks.com/addons/mysql): MySQL is the world's most popular open-source relational database, trusted by millions of applications for its reliability, performance, and ease of use. It powers everything from web applications and e-commerce platforms to enterprise data warehouses.
- [PostgreSQL](https://kubeblocks.com/addons/postgresql): PostgreSQL is a powerful, open-source object-relational database known for its robustness, extensibility, and standards compliance. It excels at complex queries, JSON support, full-text search, and geospatial data — making it a top choice for modern applications.
- [SQL Server](https://kubeblocks.com/addons/sqlserver): Microsoft SQL Server is a leading enterprise relational database with advanced analytics, in-memory processing, and built-in business intelligence. It delivers high availability and security for mission-critical workloads across hybrid cloud environments.
- [Oracle](https://kubeblocks.com/addons/oracle): Oracle Database is the industry-standard enterprise relational database, renowned for its scalability, reliability, and comprehensive feature set. It powers the world's most demanding transaction processing, data warehousing, and mixed workloads.
- [ClickHouse](https://kubeblocks.com/addons/clickhouse): ClickHouse is a column-oriented OLAP database designed for real-time analytical queries on large datasets. It delivers exceptional query performance with high data compression, making it ideal for log analytics, time-series data, and business intelligence.
- [Redis](https://kubeblocks.com/addons/redis): Redis is an open-source, in-memory data store used as a database, cache, message broker, and streaming engine. Its sub-millisecond latency and rich data structures make it essential for real-time applications, session management, and leaderboards.
- [MongoDB](https://kubeblocks.com/addons/mongodb): MongoDB is the leading document-oriented NoSQL database, designed for flexibility and scalability. Its JSON-like document model, powerful aggregation framework, and horizontal scaling make it ideal for content management, IoT, and mobile applications.
- [Kafka](https://kubeblocks.com/addons/kafka): Apache Kafka is a distributed event streaming platform capable of handling trillions of events per day. It provides high-throughput, fault-tolerant, real-time data pipelines for event-driven architectures, log aggregation, and stream processing.
- [RabbitMQ](https://kubeblocks.com/addons/rabbitmq): RabbitMQ is the most widely deployed open-source message broker. It supports multiple messaging protocols including AMQP, MQTT, and STOMP, enabling reliable asynchronous communication, task queues, and pub/sub patterns across distributed systems.
- [RocketMQ](https://kubeblocks.com/addons/rocketmq): Apache RocketMQ is a cloud-native messaging and streaming platform born at Alibaba. It delivers low latency, high throughput, and trillion-level message capacity — purpose-built for financial-grade reliability and large-scale distributed systems.
- [Qdrant](https://kubeblocks.com/addons/qdrant): Qdrant is a high-performance vector similarity search engine built in Rust. It provides advanced filtering, payload storage, and distributed deployment — making it the ideal choice for AI-powered search, recommendation systems, and RAG applications.
- [Milvus](https://kubeblocks.com/addons/milvus): Milvus is a cloud-native vector database designed for billion-scale similarity search. With GPU-accelerated indexing, hybrid search capabilities, and multi-tenancy support, it powers enterprise AI applications from semantic search to generative AI.
- [Elasticsearch](https://kubeblocks.com/addons/elasticsearch): Elasticsearch is a distributed search and analytics engine built on Apache Lucene. It provides near real-time full-text search, structured search, and analytics across massive datasets — powering log analytics, APM, and enterprise search.
- [VictoriaMetrics](https://kubeblocks.com/addons/victoriametrics): VictoriaMetrics is a fast, cost-effective, and scalable time-series database and monitoring solution. It is fully compatible with Prometheus and Grafana, offering superior compression, high ingestion rates, and global query views across multiple data sources.
- [InfluxDB](https://kubeblocks.com/addons/influxdb): InfluxDB is a purpose-built time-series database optimized for high-write and high-query workloads. It excels at IoT monitoring, real-time analytics, and DevOps observability with its powerful query language and built-in data retention policies.
- [etcd](https://kubeblocks.com/addons/etcd): etcd is a strongly consistent, distributed key-value store that provides a reliable way to store configuration data, service discovery, and distributed coordination. It is the backbone of Kubernetes, powering cluster state management at scale.
- [ZooKeeper](https://kubeblocks.com/addons/zookeeper): Apache ZooKeeper is a centralized coordination service for distributed systems. It helps teams manage configuration, naming, synchronization, and group membership with a quorum-based design used by data platforms and messaging systems.

## Customer Success Stories

- [China Mobile](https://kubeblocks.com/user-stories/china-mobile): Managing 130,000+ database clusters across 35,000+ enterprise customers; 50% reduction in development effort
- [CITIC](https://kubeblocks.com/user-stories/citic): Container-based database platform supporting 30+ key business applications; 60% server resource utilization improvement
- [Kwai](https://kubeblocks.com/user-stories/kwai): Containerizing 10,000+ Redis instances with multi-cluster federation
- [Tiger Brokers](https://kubeblocks.com/user-stories/tiger-brokers): 90% productivity increase, 600+ clusters managed via platform engineering

## Getting Started

- Install via Helm: `helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace`
- Install via kbcli: `kbcli kubeblocks install`
- Quickstart guide: https://kubeblocks.io/docs/preview/user-docs/quick-start/
- Deploy a MySQL cluster: https://kubeblocks.io/docs/preview/user-docs/kubeblocks-for-mysql/cluster-management/create-and-connect-a-mysql-cluster/

## Key CRD Reference

- `ClusterDefinition` — defines the topology and components of a database type
- `ComponentDefinition` — defines a single stateful component (e.g., mysql-orc, redis-sentinel)
- `Cluster` — user-facing resource to provision a database cluster
- `Component` — represents a running component instance within a cluster
- `OpsRequest` — declarative Day-2 operations (scale, upgrade, backup, restart, switchover)
- `BackupPolicy` / `Backup` / `Restore` — data protection primitives
- Full CRD API reference: https://kubeblocks.io/docs/preview/developer-docs/api-reference/cluster/

## Community & Contributing

- GitHub: https://github.com/apecloud/kubeblocks
- Issues & feature requests: https://github.com/apecloud/kubeblocks/issues
- Slack: https://join.slack.com/t/kubeblocks/shared_invite/zt-29tx52d8n-vli24S6gtD5ODJlNUqLqbQ
- Contributing guide: https://github.com/apecloud/kubeblocks/blob/main/docs/CONTRIBUTING.md
- Release notes: https://github.com/apecloud/kubeblocks/releases

## Site Index

- Homepage: https://kubeblocks.com/
- Addons (database engine catalog): https://kubeblocks.com/addons
- Customer stories: https://kubeblocks.com/user-stories
- Enterprise product: https://kubeblocks.com/products/kubeblocks-enterprise
- About: https://kubeblocks.com/about
- Contact: https://kubeblocks.com/contact
- Sitemap: https://kubeblocks.com/sitemap.xml
- Docs (open-source): https://kubeblocks.io/docs/preview/