kubeblocks

README

KubeBlocks

• KubeBlocks
  • What is KubeBlocks
    • Why you need KubeBlocks
    • Goals
    • Key features
  • Get started with KubeBlocks
  • Community
  • Contributing to KubeBlocks
  • Report Vulnerability
  • License

What is KubeBlocks

KubeBlocks is an open source system software that runs and manages data infrastructure on Kubernetes. It could manage various data/database engines, including RDBMSs (MySQL, PostgreSQL), Caches(Redis), NoSQLs (MongoDB), MQs(Kafka, Pulsar), and vector databases(Milvus, Qdrant, Weaviate), and the community is actively integrating more types of data/database engines into KubeBlocks. KubeBlocks helps developers, SREs, and platform engineers deploy and maintain dedicated DBPaaS, and supports a variety of public clouds and on-premise environments.

KubeBlocks is designed for production purposes, providing secure, cost-effective, high-available and extensible DBPaaS solution for enterprise. The name KubeBlocks is inspired by Kubernetes and LEGO blocks, signifying that integrating data infrastructure on K8s can be standard and productive, like playing with LEGO blocks. The core of KubeBlocks is a K8s operator, which defines a set of CRDs to abstract the common attributes of various data/database engines, thereby supporting the rapid integration of a new data/database system into KubeBlocks while keeping the same operating experience and expected behaviors.

Why you need KubeBlocks

KubeBlocks integrates the most popular data/database engines and provides rich management functions, along with declarative APIs, on various environments. Furthermore, KubeBlocks offers the following benefits:

• Cost-effective

  KubeBlocks optimizes the kernel and parameters of MySQL and PostgreSQL databases for containerized and cloud environments, and its performance exceeds that of RDS with the same hardware (see our blogs for test reports).

• Reliability

  KubeBlocks supports high-availability cluster configurations for multiple database engines, and supports Raft replication cluster for MySQL to achieve enhanced availability with durability guarantees.

• Observability

  KubeBlocks collects monitoring metrics from richful data sources, integrates with the Prometheus stack, and provides insightful Grafana templates. In addition, troubleshooting tools such as slow logs are also provided.

• Extensibility

  KubeBlocks provides the addon mechanism for integrating new data/database engines. So it can be extended to run the databases your project needs.

Goals

• Being open and cloud-neutral
• Promoting the containerization of database workloads
• Promoting IaC and GitOps in the field of databases
• Reducing the cost of using databases
• Smoothing the learning curve of managing databases

Key features

• Be compatible with AWS, GCP, Azure, and more
• Supports various data infrastructure systems, including MySQL, PostgreSQL, Redis, MongoDB, Kafka, Pulsar and more
• Provides production-level performance, resilience, scalability, and observability
• Simplifies day-2 operations, such as upgrading, scaling, monitoring, backup, and restore
• Contains a powerful and intuitive command line tool

Get started with KubeBlocks

Quick Start shows you the quickest way to get started with KubeBlocks.

Community

• KubeBlocks Slack Channel
• KubeBlocks Github Discussions

Contributing to KubeBlocks

Your contributions are welcomed and appreciated.

• See the Contributor Guide for details on typical contribution workflows.
• See the Developer Guide to get started with building and developing.

Report Vulnerability

We consider security is a top priority issue. If you come across a related issue, please create a Report a security vulnerability issue.

License

KubeBlocks is under the GNU Affero General Public License v3.0. See the LICENSE file for details.