Getting Started
Concepts and Features
Backup and Restore
In Place Update
Instance Template
Trouble Shooting
References
Upgrade KubeBlocks
Supported Addons
KubeBlocks uses Addons to extend support for various database engines. And there are currently over 30 Addons available in the KubeBlocks repository, which can be further categorized as follows sections.
For installing and enabling Addons, refer to Addon installation tutorial.
Relational Databases
MySQL and PostgreSQL are the two most popular open-source relational databases in the world, and they have branches/variants.
MySQL and its variants
Addon List
| Addons | Description |
|---|---|
| mysql | This addon uses the community edition MySQL image officially released by Oracle. |
| mariadb | MariaDB is a high performance open source relational database management system that is widely used for web and application servers. |
Supported Features
NOTE
The versions listed below may not be up-to-date, and some supported versions might be missing. For the latest addon versions, please refer to the KubeBlocks addon GitHub repo.
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| mysql | • 5.7.44 • 8.0.33 • 8.4.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| mariadb | 10.6.15 | ✔️ | N/A | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Postgresql and its variants
Addon List
| Addons | Description |
|---|---|
| postgresql | This addon provides PostgreSQL services using the Spilo image with Patroni for high availability (HA). |
| vanilla-postgresql | This Addon is based on the vanilla PostgreSQL, providing high availability capabilities for native PostgreSQL and its variants. |
| orioledb | OrioleDB is a new storage engine for PostgreSQL, bringing a modern approach to database capacity, capabilities and performance to the world's most-loved database platform. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| postgresql | • 12.14.0 • 12.14.1 • 12.15.0 • 14.7.2 • 14.8.0 • 15.7.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| vanilla-postgresql | • 12.15.0 • 14.7.0 • 15.6.1138 • 15.7.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| orioledb | 14.7.2-beta1 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
NoSQL
Addon List
| Addons | Description |
|---|---|
| mongodb | MongoDB is a document-oriented NoSQL database used for high volume data storage. |
| redis | Redis is a fast, open source, in-memory, key-value data store. |
| etcd | etcd is a strongly consistent, distributed key-value store that provides a reliable way to store data that needs to be accessed by a distributed system or cluster of machines. |
| zookeeper | Apache ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| mongodb | • 4.0.28 • 4.2.24 • 4.4.29 • 5.0.28 • 6.0.16 • 7.0.12 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | ✔️ | ✔️ |
| redis | • 7.0.6 • 7.2.4 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | ✔️ | ✔️ | N/A |
| etcd | 3.5.15 3.5.6 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| zookeeper | 3.4.14 3.6.4 3.7.2 3.8.4 3.9.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | ✔️ | ✔️ | N/A | N/A | N/A | N/A |
OLAP Systems
Addon List
| Addons | Description |
|---|---|
| elasticsearch | Elasticsearch is a distributed, RESTful search engine optimized for speed and relevance on production-scale workloads. |
| starrocks-ce | StarRocks is a next-gen, high-performance analytical data warehouse that enables real-time, multi-dimensional, and highly concurrent data analysis. |
| clickhouse | ClickHouse is a column-oriented database that enables its users to generate powerful analytics, using SQL queries, in real-time. |
| opensearch | Open source distributed and RESTful search engine. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| elasticsearch | • 7.10.1 • 7.7.1 • 7.8.1 • 8.1.3 • 8.8.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| starrocks-ce | • 3.2.2 • 3.3.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| clickhouse | 22.9.4 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| opensearch | 2.7.0 | ✔️ | N/A | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Distributed SQL Databases
Addon List
| Addons | Description |
|---|---|
| tidb | TiDB is a MySQL-compatible distributed database, with the SQL layer developed in Go, the storage layer based on RocksDB, and the transaction model using Percolator. Provided by PingCap. |
| oceanbase-ce | OceanBase Community Edition is a MySQL-compatible distributed database developed in C++. |
| polardb-x | PolarDB-X Community Edition is a MySQL-compatible distributed database that supports horizontal scaling based on MySQL. Provided by Alibaba Cloud, it is open-source. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| tidb | • 6.5.10 • 7.1.5 • 7.5.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| oceanbase | 4.3.0 | N/A | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
| polardb-x | 2.3 | ✔️ | ✔️ | N/A | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Message Queues
Addon List
| Addons | Description |
|---|---|
| kafka | Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications. |
| rabbitmq | RabbitMQ is a reliable and mature messaging and streaming broker. |
| pulsar | Apache Pulsar is an open-source, distributed messaging and streaming platform. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| kafka | • 3.3.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | ✔️ | N/A | N/A | N/A | N/A |
| rabbitmq | • 3.13.2 • 3.12.14 • 3.11.28 • 3.10.25 • 3.9.29 • 3.8.14 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | Managed by the RabbitMQ Management system. | ✔️ | ✔️ |
| pulsar | • 2.11.2 • 3.0.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | ✔️ | N/A | N/A | N/A | N/A |
Vector Databases
Addon List
| Addons | Description |
|---|---|
| qdrant | Qdrant is a vector database & vector similarity search engine. |
| weaviate | Weaviate is an open-source vector database. |
| milvus | Milvus is a flexible, reliable, & blazing-fast cloud-native, open-source vector database. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| qdrant | • 1.10.0 • 1.5.0 • 1.7.3 • 1.8.1 • 1.8.4 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A |
| weaviate | 1.23.1 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | ✔️ | N/A | N/A | N/A | N/A |
| milvus | 2.3.2 | ✔️ | N/A | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Time Series Databases
Addon List
| Addons | Description |
|---|---|
| influxdb | InfluxDB enables real-time analytics by serving as a purpose-built database that optimizes processing and scaling for large time series data workloads. |
| victoria-metrics | VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. |
| greptimedb | GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. |
| tdengine | TDengine™ is an industrial data platform purpose-built for the Industrial IoT, combining a time series database with essential features like stream processing, data subscription, and caching. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| influxdb | 2.7.4 | ✔️ | N/A | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| victoria-metrics | 1.0.0 | |||||||||||||
| greptimedb | 0.3.2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| tdengine | 3.0.5 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Graph Databases
Addon List
| Addons | Description |
|---|---|
| nebula | NebulaGraph is an open source graph database that can store and process graphs with trillions of edges and vertices. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| nebula | 3.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
Storage System
Addon List
| Addons | Description |
|---|---|
| minio | MinIO is an object storage solution that provides an Amazon Web Services S3-compatible API and supports all core S3 features. |
Supported Features
| Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| minio | RELEASE.2024-06-29T01-20-47Z | ✔️ | ✔️ | N/A | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | N/A | N/A | N/A |