Skip to main content
Version: Preview

Supported addons

KubeBlocks, as a cloud-native data infrastructure based on Kubernetes, provides management and control for relational databases, NoSQL databases, vector databases, and stream computing systems; and these databases can be all added as addons. Besides databases, the KubeBlocks addon now also supports plugins for cloud environments and applications.

AddonsDescription
apecloud-mysqlApeCloud MySQL is a database that is compatible with MySQL syntax and achieves high availability through the utilization of the RAFT consensus protocol.
apecloud-postgresqlApeCloud PostgreSQL is a database that is compatible with PostgreSQL syntax and achieves high availability through the utilization of the RAFT consensus protocol.
camellia-redis-proxyCamellia Redis Proxy is a high-performance redis proxy developed using Netty4.
clickhouseClickHouse is a column-oriented database that enables its users to generate powerful analytics, using SQL queries, in real-time.
dorisApache Doris is a modern data warehouse for real-time analytics. It delivers lightning-fast analytics on real-time data at scale.
elasticsearchElasticsearch is a distributed, RESTful search engine optimized for speed and relevance on production-scale workloads.
etcdetcd 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.
flinkApache Flink is a framework and distributed processing engine for stateful computations over unbounded and bounded data streams.
foxlakeApeCloud FoxLake is an open-source cloud-native data warehouse.
ggmlGGML is a tensor library for machine learning to enable large models and high performance on commodity hardware.
greptimedbGreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency.
haloHaloDB is a fast and simple embedded key-value store written in Java.
influxdbInfluxDB enables real-time analytics by serving as a purpose-built database that optimizes processing and scaling for large time series data workloads.
kafkaApache 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.
mariadbMariaDB is a high performance open source relational database management system that is widely used for web and application servers.
milvusMilvus is a flexible, reliable, & blazing-fast cloud-native, open-source vector database.
minioMinIO is an object storage solution that provides an Amazon Web Services S3-compatible API and supports all core S3 features.
mogdbMOgDB is a stable and easy-to-use enterprise-ready relational database based on the openGauss open source database.
mongodbMongoDB is a document-oriented NoSQL database used for high volume data storage.
mysqlMySQL is a widely used, open-source relational database management system (RDBMS).
nebulaNebulaGraph is an open source graph database that can store and process graphs with trillions of edges and vertices.
neonNeon is Serverless Postgres built for the cloud.
oceanbaseUnlimited scalable distributed database for data-intensive transactional and real-time operational analytics workloads, with ultra-fast performance that has once achieved world records in the TPC-C benchmark test. OceanBase has served over 400 customers across the globe and has been supporting all mission critical systems in Alipay.
official-postgresqlAn official PostgreSQL cluster definition Helm chart for Kubernetes.
opengaussopenGauss is an open source relational database management system that is released with the Mulan PSL v2.
openldapThe OpenLDAP Project is a collaborative effort to develop a robust, commercial-grade, fully featured, and open source LDAP suite of applications and development tools. This chart provides KubeBlocks.
opensearchOpen source distributed and RESTful search engine.
oriolebdOrioleDB 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.
pikaPika (PikiwiDB) is a persistent huge storage service, compatible with the vast majority of redis interfaces, including string, hash, list, zset, set and management interfaces.
polardb-xPolarDB-X is a cloud native distributed SQL Database designed for high concurrency, massive storage, complex querying scenarios.
postgresqlPostgreSQL is an advanced, enterprise class open source relational database that supports both SQL (relational) and JSON (non-relational) querying.
pulsarApache® Pulsar™ is an open-source, distributed messaging and streaming platform built for the cloud.
qdrantQdrant is a vector database & vector similarity search engine.
redisRedis is a fast, open source, in-memory, key-value data store.
risingwaveRisingWave is a distributed SQL database for stream processing. It is designed to reduce the complexity and cost of building real-time applications.
solrSolr is the popular, blazing-fast, open source enterprise search platform built on Apache Lucene.
starrocksStarRocks is a next-gen, high-performance analytical data warehouse that enables real-time, multi-dimensional, and highly concurrent data analysis.
tidbTiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.
tdengineTDengine™ 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.
vllmvLLM is a fast and easy-to-use library for LLM inference and serving.
weaviateWeaviate is an open-source vector database.
xinferenceXorbits Inference(Xinference) is a powerful and versatile library designed to serve language, speech recognition, and multimodal models.
yanshanYashanDB is a database management system developed by Shenzhen Institute of Computing Science.
zookeeperApache ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.

Supported functions of addons​

Addon (v0.9.0)versionVscaleHscaleVolumeexpandStop/StartRestartExposeBackup/RestoreLogsConfigUpgrade (DB engine version)AccountFailoverSwitchoverMonitor
apecloud-mysql8.0.30✔️✔️✔️✔️✔️✔️✔️✔️✔️N/A✔️✔️✔️✔️
apecloud-postgresql14.11✔️✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/A
camellia-redis-proxy1.2.26✔️✔️✔️✔️✔️✔️N/A✔️N/AN/AN/AN/AN/AN/A
clickhouse22.9.4✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
doris2.0.3✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
elasticsearch8.8.2✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
etcd3.5.6✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
foxlake0.8.0✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
flink1.16✔️✔️ (task manager)N/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
ggmlN/AN/AN/AN/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
greptimedb0.3.2✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
halo0.2.0✔️✔️N/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
influxdb2.7.4✔️N/A✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
kafka3.3.2✔️✔️✔️✔️✔️N/AN/AN/A✔️N/AN/AN/AN/A✔️
mariadb10.6.15✔️N/A✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
milvus2.2.4✔️N/A✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
minio8.0.17✔️N/A✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
mogdb5.0.5✔️✔️✔️✔️✔️✔️✔️✔️✔️N/AN/AN/A✔️N/A
mongodb

4.0

4.2

4.4

5.0

5.0.20

6.0

✔️✔️✔️✔️✔️✔️✔️✔️✔️N/AN/A✔️✔️✔️
mysql

5.7.42

8.0.33

✔️✔️✔️✔️✔️✔️✔️✔️✔️N/A✔️✔️✔️✔️
nebula3.5.0✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
neonlatest✔️N/AN/AN/AN/AN/AN/AN/AN/AN/AN/AN/AN/AN/A
oceanbase4.2.0.0-100010032023083021N/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/AN/A
oceanbase-cluster4.2.0.0-100010032023083021✔️ (host network)✔️✔️✔️ (host network)✔️ (host network)N/AN/AN/AN/AN/AN/AN/AN/AN/A
official-postgresql

12.15

14.7

14.7-zhparser

✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
opengauss5.0.0✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
openldap2.4.57✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/A
opensearch2.7.0✔️N/A✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
oracle19.3.0-ee✔️N/AN/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
orioledbbeta1✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
pika3.5.1✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
polardb-x2.3✔️✔️N/A✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A✔️
postgresql

12.14.0

12.14.1

12.15.0

14.7.2

14.8.0

✔️✔️✔️✔️✔️✔️✔️✔️✔️✔️✔️✔️✔️✔️
pulsar2.11.2✔️✔️✔️✔️✔️N/AN/AN/A✔️N/AN/AN/AN/A✔️
qdrant1.5.0✔️✔️✔️✔️✔️N/A✔️N/AN/AN/AN/AN/AN/A✔️
redis7.0.6✔️✔️✔️✔️✔️✔️✔️✔️✔️N/A✔️✔️N/A✔️
risingwave1.0.0✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
starrocks3.1.1✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
solr8.11.2✔️✔️N/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
tdengine3.0.5.0✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
tidb7.1.2✔️✔️✔️✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
vllmN/AN/AN/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
weaviate1.18.0✔️✔️✔️✔️✔️N/AN/AN/A✔️N/AN/AN/AN/A✔️
xinference1.16.0✔️N/AN/A✔️✔️N/AN/AN/AN/AN/AN/AN/AN/AN/A
yashanpersonal-23.1.1.100✔️✔️ (Standalone)✔️✔️✔️N/AN/A✔️✔️N/AN/AN/AN/AN/A
zookeeper3.7.1✔️✔️✔️✔️✔️N/AN/A✔️✔️N/AN/AN/AN/AN/A
note

The upgrade feature means that KubeBlocks supports minor version upgrades for a database engine. For example, you can upgrade PostgreSQL from v12.14 to v12.15.

Use addons​

Use the index to install an addon​

With the release of KubeBlocks v0.8.0, addons are decoupled from KubeBlocks and some addons are not installed by default. If you want to use these addons, add addons first by index.

The official index repo is KubeBlocks index. The code of all addons is maintained in the KubeBlocks addon repo.

  1. View the index.

    kbcli creates an index named kubeblocks by default and you can check whether this index is created by running kbcli addon index list.

    kbcli addon index list
    >
    INDEX        URL
    kubeblocks   https://github.com/apecloud/block-index.git

    If the list is empty or you want to add your index, you can add the index manually by using kbcli addon index add <index-name> <source>. For example,

    kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git

  2. (Optional) Search whether the addon exists in the index.

    kbcli addon search mariadb
    >
    ADDON     VERSION   INDEX
    mariadb   0.7.0     kubeblocks

  3. Install the addon.

    If there are multiple index sources and versions for an addon, you can specify them by adding flags. The system installs the latest version in the kubeblocks index by default.

    kbcli addon install mariadb --index kubeblocks --version 0.7.0

    What's next

    After the addon is installed, you can list and enable it.

List addons​

To list supported addons, run kbcli addon list command.

Enable/Disable addons​

To manually enable or disable addons, follow the steps below.

Steps:

  1. To enable an addon, use kbcli addon enable.

    Example

    kbcli addon enable snapshot-controller

    To disable an addon, use kbcli addon disable.

  2. List the addons again to check whether it is enabled.

    kbcli addon list