github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/README.md (about) 1 # KubeBlocks 2 3 [![Documentation status](https://github.com/apecloud/kubeblocks.io/workflows/Documentation/badge.svg)](https://kubeblocks.io) 4 [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7544/badge)](https://bestpractices.coreinfrastructure.org/projects/7544) 5 [![Releases](https://img.shields.io/github/v/release/apecloud/kubeblocks)](https://github.com/apecloud/kubeblocks/releases/latest) 6 [![LICENSE](https://img.shields.io/github/license/apecloud/kubeblocks.svg?style=flat-square)](/LICENSE) 7 [![Go Report Card](https://goreportcard.com/badge/github.com/apecloud/kubeblocks)](https://goreportcard.com/report/github.com/apecloud/kubeblocks) 8 [![Docker Pulls](https://img.shields.io/docker/pulls/apecloud/kubeblocks)](https://hub.docker.com/r/apecloud/kubeblocks) 9 [![codecov](https://codecov.io/gh/apecloud/kubeblocks/branch/main/graph/badge.svg?token=GEH4I1C80Y)](https://codecov.io/gh/apecloud/kubeblocks) 10 [![Build status](https://github.com/apecloud/kubeblocks/workflows/CICD-PUSH/badge.svg)](https://github.com/apecloud/kubeblocks/actions/workflows/cicd-push.yml) 11 ![maturity](https://img.shields.io/static/v1?label=maturity&message=alpha&color=red) 12 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/kubeblocks)](https://artifacthub.io/packages/search?repo=kubeblocks) 13 14 ![image](./docs/img/banner-readme.png) 15 16 - [KubeBlocks](#kubeblocks) 17 - [What is KubeBlocks](#what-is-kubeblocks) 18 - [Why you need KubeBlocks](#why-you-need-kubeblocks) 19 - [Goals](#goals) 20 - [Key features](#key-features) 21 - [Get started with KubeBlocks](#get-started-with-kubeblocks) 22 - [Community](#community) 23 - [Contributing to KubeBlocks](#contributing-to-kubeblocks) 24 - [Report Vulnerability](#report-vulnerability) 25 - [License](#license) 26 27 ## What is KubeBlocks 28 29 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. 30 31 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. 32 33 ### Why you need KubeBlocks 34 35 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: 36 37 * Cost-effective 38 39 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). 40 41 * Reliability 42 43 KubeBlocks supports high-availability cluster configurations for multiple database engines, and supports Raft replication cluster for MySQL to achieve enhanced availability with durability guarantees. 44 45 * Observability 46 47 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. 48 49 * Extensibility 50 51 KubeBlocks provides the addon mechanism for integrating new data/database engines. So it can be extended to run the databases your project needs. 52 53 ### Goals 54 - Being open and cloud-neutral 55 - Promoting the containerization of database workloads 56 - Promoting IaC and GitOps in the field of databases 57 - Reducing the cost of using databases 58 - Smoothing the learning curve of managing databases 59 60 ### Key features 61 62 - Be compatible with AWS, GCP, Azure, and more 63 - Supports various data infrastructure systems, including MySQL, PostgreSQL, Redis, MongoDB, Kafka, Pulsar and more 64 - Provides production-level performance, resilience, scalability, and observability 65 - Simplifies day-2 operations, such as upgrading, scaling, monitoring, backup, and restore 66 - Contains a powerful and intuitive command line tool 67 68 ## Get started with KubeBlocks 69 70 [Quick Start](https://kubeblocks.io/docs/preview/user_docs/try-out-on-playground/try-kubeblocks-on-your-laptop) shows you the quickest way to get started with KubeBlocks. 71 72 ## Community 73 74 - KubeBlocks [Slack Channel](https://join.slack.com/t/kubeblocks/shared_invite/zt-23vym7xpx-Xu3xcE7HmcqGKvTX4U9yTg) 75 - KubeBlocks Github [Discussions](https://github.com/apecloud/kubeblocks/discussions) 76 77 ## Contributing to KubeBlocks 78 79 Your contributions are welcomed and appreciated. 80 81 - See the [Contributor Guide](docs/CONTRIBUTING.md) for details on typical contribution workflows. 82 - See the [Developer Guide](docs/DEVELOPING.md) to get started with building and developing. 83 84 ## Report Vulnerability 85 86 We consider security is a top priority issue. If you come across a related issue, please create a [Report a security vulnerability](https://github.com/apecloud/kubeblocks/security/advisories/new) issue. 87 88 ## License 89 90 KubeBlocks is under the GNU Affero General Public License v3.0. 91 See the [LICENSE](./LICENSE) file for details.