# KubeBlocks — Full Documentation Index > KubeBlocks is an open-source Kubernetes operator managing 35+ database engines > via unified CRD APIs. This file lists every indexed page for LLM retrieval. - Site: https://kubeblocks.io/ - Sitemap: https://kubeblocks.io/sitemap.xml - Summary index: https://kubeblocks.io/llms.txt - Raw index JSON: https://kubeblocks.io/docs-index.json ## blog/5-network-modes-for-kubeblocks-for-redis - Mastering Redis Network Modes in Kubernetes with KubeBlocks — Explore 5 essential network modes for deploying and managing Redis on Kubernetes using KubeBlocks. This guide covers Headless Service, Fixed Pod IP, HostNetwork, NodePort, and LoadBalancer to optimize your Redis cluster's performance, accessibility, and cost-effectiveness.: https://kubeblocks.io/blog/5-network-modes-for-kubeblocks-for-redis ## blog/A-testing-report-for-optimizing-PG-performance-on-Kubernetes - PostgreSQL Performance Tuning on Kubernetes: A KubeBlocks Deep Dive — A detailed performance benchmark of PostgreSQL (PG) on Kubernetes. This report investigates and solves critical performance issues like TPS drops and CPU fluctuations by tuning WAL settings (wal_init_zero, full_page_write), IO bandwidth, and checkpoints.: https://kubeblocks.io/blog/A-testing-report-for-optimizing-PG-performance-on-Kubernetes ## blog/announcing-kubeblocks-v0-7-0 - Announcing KubeBlocks v0.7.0 — This blog introduces major changes in KubeBlocks v0.7.0.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-7-0 ## blog/announcing-kubeblocks-v0-8-0 - Announcing KubeBlocks v0.8.0 — This blog introduces major changes in KubeBlocks v0.8.0.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-8-0 ## blog/announcing-kubeblocks-v0-9-0 - Announcing KubeBlocks v0.9.0 — This blog introduces major changes in KubeBlocks v0.9.0.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-0 ## blog/announcing-kubeblocks-v0-9-1 - Announcing KubeBlocks v0.9.1 — This blog introduces major changes in KubeBlocks v0.9.1.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-1 ## blog/announcing-kubeblocks-v0-9-2 - Announcing KubeBlocks v0.9.2 — This blog introduces major changes in KubeBlocks v0.9.2.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-2 ## blog/announcing-kubeblocks-v0-9-3 - Announcing KubeBlocks v0.9.3 — This blog introduces major changes in KubeBlocks v0.9.3.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-3 ## blog/announcing-kubeblocks-v0-9-4 - Announcing KubeBlocks v0.9.4 — This blog introduces major changes in KubeBlocks v0.9.4.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-4 ## blog/announcing-kubeblocks-v0-9-5 - Announcing KubeBlocks v0.9.5 — This blog introduces major changes in KubeBlocks v0.9.5.: https://kubeblocks.io/blog/announcing-kubeblocks-v0-9-5 ## blog/announcing-kubeblocks-v1-0-0 - Announcing KubeBlocks v1.0.0 — This blog introduces major changes in KubeBlocks v1.0.0.: https://kubeblocks.io/blog/announcing-kubeblocks-v1-0-0 ## blog/announcing-kubeblocks-v1-0-1 - Announcing KubeBlocks v1.0.1 — This blog introduces major changes in KubeBlocks v1.0.1.: https://kubeblocks.io/blog/announcing-kubeblocks-v1-0-1 ## blog/announcing-kubeblocks-v1-0-2 - Announcing KubeBlocks v1.0.2 — This blog introduces major changes in KubeBlocks v1.0.2.: https://kubeblocks.io/blog/announcing-kubeblocks-v1-0-2 ## blog/Community-Monthly-Report-for-April-2024 - Community Monthly Report for April 2024 — OSPP 2024, the upcoming v0.9.0, find out what's happening in the KubeBlocks community.: https://kubeblocks.io/blog/Community-Monthly-Report-for-April-2024 ## blog/Community-Monthly-Report-for-February-2024 - Community Monthly Report for February 2024 — Sharding API、Camellia Redis Proxy...Take a look at the fresh news in the KubeBlocks Community.: https://kubeblocks.io/blog/Community-Monthly-Report-for-February-2024 ## blog/Community-Monthly-Report-for-January-2024 - Community Monthly Report for January 2024 — v0.8.x Release, New Contributors, Client SDK... Take a look at the fresh news in the KubeBlocks Community: https://kubeblocks.io/blog/Community-Monthly-Report-for-January-2024 ## blog/Community-Monthly-Report-for-March-2024 - Community Monthly Report for March 2024 — KubeBlocks v0.8.2, new contributors, come and see the latest news in the community.: https://kubeblocks.io/blog/Community-Monthly-Report-for-March-2024 ## blog/Community-Monthly-Report-for-May-2024 - Community Monthly Report for May 2024 — Find out what's happening in the KubeBlocks community.: https://kubeblocks.io/blog/Community-Monthly-Report-for-May-2024 ## blog/configure-instance-template - Gaining Granular Pod Control in KubeBlocks with Instance Templates — Unlock granular control over your database pods in KubeBlocks. This guide explains how to use instance templates to override default settings for individual pods, including resources, scheduling policies, environment variables, and labels. Perfect for customizing clusters like RisingWave.: https://kubeblocks.io/blog/configure-instance-template ## blog/deploy-aigc-applications-using-kubeblocks-and-dify - Deploy Production-Ready AIGC Applications on Kubernetes using KubeBlocks (K8s Operator for PostgreSQL, Redis and Qdrant) and Dify — Learn to build and deploy production-grade AIGC applications on Kubernetes. This guide shows how to combine Dify for rapid LLM app development with KubeBlocks to easily manage the required data infrastructure, including PostgreSQL, Redis, and the Qdrant vector database.: https://kubeblocks.io/blog/deploy-aigc-applications-using-kubeblocks-and-dify ## blog/deploy-harbor-on-kubeblocks - Deploy a High Availability Harbor Cluster on Kubernetes with KubeBlocks (Operator for PostgreSQL and Redis ) in 5 Minutes — Learn how to easily deploy a high-availability (HA) Harbor image repository on Kubernetes. This guide shows how KubeBlocks simplifies the setup of HA PostgreSQL and Redis, providing a reliable and resilient Harbor cluster in minutes.: https://kubeblocks.io/blog/deploy-harbor-on-kubeblocks ## blog/deploy-kubeblocks-on-openshift - How to Deploy and Use KubeBlocks on OpenShift — This blog introduces how to deploy and use KubeBlocks on OpenShift.: https://kubeblocks.io/blog/deploy-kubeblocks-on-openshift ## blog/deploy-wordpress-on-kubeblocks - Deploy a High-Availability WordPress Site on Kubernetes with KubeBlocks MySQL Operator — Move beyond the limitations of single-node databases. This guide shows how to deploy a scalable, high-availability WordPress site on Kubernetes using the KubeBlocks MySQL Operator to achieve true failover, resource isolation, and easy management.: https://kubeblocks.io/blog/deploy-wordpress-on-kubeblocks ## blog/Does-containerization-affect-the-performance-of-databases - How Containerization Affects Database Performance: A Benchmark of runC, Kata, and gVisor — An in-depth analysis of containerization's impact on database performance. This article benchmarks CPU, memory, and I/O for container runtimes like runC, Kata Containers, and gVisor, and investigates common bottlenecks like I/O hangs and OOM errors in a Kubernetes environment.: https://kubeblocks.io/blog/Does-containerization-affect-the-performance-of-databases ## blog/Does-running-MySQL-on-Kubernetes-lead-to-significant-performance-degradation - MySQL on Kubernetes Performance: A Benchmark of KubeBlocks, Percona, and Oracle Operators vs. Amazon RDS — Does running MySQL on Kubernetes degrade performance? This report answers the question with a detailed benchmark comparing KubeBlocks, Percona, and Oracle operators against Amazon RDS. We analyze throughput and latency, revealing how factors like parameter tuning and IOPS are the real performance drivers.: https://kubeblocks.io/blog/Does-running-MySQL-on-Kubernetes-lead-to-significant-performance-degradation ## blog/gitlab-on-kubeblocks - GitLab on Kubernetes: Production-Ready PostgreSQL and Redis HA with KubeBlocks — Learn how to replace GitLab's fragile bundled databases with KubeBlocks-managed HA clusters — PostgreSQL with Patroni and Redis with Sentinel — for automatic failover, zero-downtime upgrades, and day-2 operations out of the box.: https://kubeblocks.io/blog/gitlab-on-kubeblocks ## blog/how-to-fix-pods-stuck-in-terminating-status - How to Fix Pods Stuck in Terminating Status in Kubernetes? — A step-by-step guide to troubleshooting and fixing Kubernetes Pods stuck in the Terminating status. This deep dive reproduces the common issue, analyzes kubelet logs and volume mount problems, and uncovers a bug in the Hostpath CSI Driver as the root cause.: https://kubeblocks.io/blog/how-to-fix-pods-stuck-in-terminating-status ## blog/how-to-manage-database-clusters-without-a-dedicated-operator - How to Manage Database Clusters Without a Dedicated Operator? — Discover a unified approach to managing diverse databases on Kubernetes without the overhead of dedicated operators. This article explores the architecture of KubeBlocks, a database-agnostic operator, and features a case study on how China Mobile Cloud uses it to manage their DBaaS platform and reduce development time.: https://kubeblocks.io/blog/how-to-manage-database-clusters-without-a-dedicated-operator ## blog/in-place-update-in-k8s - Achieving In-Place Pod Updates on Kubernetes for High Availability Databases with KubeBlocks — Learn how KubeBlocks enables in-place Pod updates on Kubernetes to improve high availability for databases. This article explains how KubeBlocks' InstanceSet overcomes the limitations of StatefulSet, allowing updates to images, CPU/memory resources, and PVC volumes without disruptive Pod recreation.: https://kubeblocks.io/blog/in-place-update-in-k8s ## blog/instanceset-introduction - InstanceSet: A Kubernetes Workload API for High-Availability Databases — An introduction to InstanceSet, the general workload API in KubeBlocks designed for managing stateful applications. Learn about its key features, including role-based updates, in-place updates, and instance templates, which provide high availability for databases on Kubernetes.: https://kubeblocks.io/blog/instanceset-introduction ## blog/interview-china-mobile-cloud-dingshun - Building a Leading DBaaS Platform from 0 to 1: The KubeBlocks Practice of China Mobile Cloud Architect Ding Shun — Discover how China Mobile Cloud architect Ding Shun leveraged KubeBlocks to build a leading DBaaS platform from 0 to 1. Learn about the challenges they faced and how KubeBlocks helped them overcome them.: https://kubeblocks.io/blog/interview-china-mobile-cloud-dingshun ## blog/is-k8s-a-database - Is Kubernetes a Database? A Deep Dive into IaD and Declarative APIs — Explore the idea of Kubernetes as a database. This article delves into the core concepts of Infrastructure as Data (IaD) and declarative application management to reframe your understanding of how Kubernetes works.: https://kubeblocks.io/blog/is-k8s-a-database ## blog/kubeblocks-on-kata - Securing Your Workloads with Kata Containers - Running KubeBlocks on Kata — How do you increase your container security with Kata?: https://kubeblocks.io/blog/kubeblocks-on-kata ## blog/kubeblocks-x-clickhouse-production-ready-operator-on-kubernetes - KubeBlocks x Clickhouse: Production-Ready Operator on Kubernetes — How to operatorize ClickHouse with KubeBlocks: cluster management, sharding, Keeper integration, HA, parameter control, and backup/recovery using an operator-first approach.: https://kubeblocks.io/blog/kubeblocks-x-clickhouse-production-ready-operator-on-kubernetes ## blog/kubeblocks-x-milvus-kubernetes-operator-guide - KubeBlocks x Milvus: Kubernetes Operator Guide — Operatorize Milvus on Kubernetes using KubeBlocks: deploy standalone and cluster modes, integrate etcd/Kafka/MinIO via Addons and ServiceRef, and manage Day-2 operations with an operator-first approach.: https://kubeblocks.io/blog/kubeblocks-x-milvus-kubernetes-operator-guide ## blog/kubeblocks-x-minio-an-operator-journey-in-one-click - KubeBlocks × MinIO: An Operator Journey in One Click — How KubeBlocks applies operator-based management to MinIO: automated cluster lifecycle, high availability, and logical horizontal scaling as an alternative to dedicated MinIO operators.: https://kubeblocks.io/blog/kubeblocks-x-minio-an-operator-journey-in-one-click ## blog/kubeblocks-x-mssql-high-availability-implementation - KubeBlocks x MSSQL: High Availability Implementation — Deep dive into how KubeBlocks implements high availability for MSSQL using the lightweight Syncer framework, comparing it with traditional Pacemaker solutions and demonstrating fault tolerance capabilities.: https://kubeblocks.io/blog/kubeblocks-x-mssql-high-availability-implementation ## blog/kubeblocks-x-mssql-operator-based-always-on-ag-revealed - KubeBlocks x MSSQL: Operator-based Always On AG Revealed — How KubeBlocks enables MSSQL Always On Availability Groups through operator-based management: automated lifecycle, high availability, automatic failover, and backup/restore as an alternative to dedicated MSSQL operators.: https://kubeblocks.io/blog/kubeblocks-x-mssql-operator-based-always-on-ag-revealed ## blog/kubeblocks-x-oracle-operator-based-dg-deployment-and-management-guide - KubeBlocks x Oracle: Operator-Based DG Deployment and Management Guide — How KubeBlocks operatorizes Oracle Data Guard (12c) on Kubernetes — design, Addon implementation, backup, failover, and day-2 operations using an operator-first approach.: https://kubeblocks.io/blog/kubeblocks-x-oracle-operator-based-dg-deployment-and-management-guide ## blog/kubeblocks-x-redis-streaming-redis-cluster-and-solving-network-compatibility - KubeBlocks x Redis: Streamlining Redis Cluster and Solving Network Compatibility — How we manage/operatorize Redis Cluster on Kubernetes with KubeBlocks and solve network compatibility issues (CNI, NodePort, announce-ip) when using Redis Cluster.: https://kubeblocks.io/blog/kubeblocks-x-redis-streaming-redis-cluster-and-solving-network-compatibility ## blog/manage-6k-db-instance-with-kubeblocks - Managing Over 6,000 Self-Hosted Databases Without a DBA - How a Single Engineer Leveraged KubeBlocks to Make It Possible — Case study: How Sealos used KubeBlocks to manage 6,000+ self-hosted databases across four availability zones — architecture, HA, backup, migration and operational practices.: https://kubeblocks.io/blog/manage-6k-db-instance-with-kubeblocks ## blog/migrate-redis-at-kuaishou-from-bare-metal-to-k8s - Resource Utilization Boost - Large-Scale Redis Migration from Bare Metal to Kubernetes — This is a joint talk delivered by ApeCloud and Kuaishou on KubeCon China 2024. This talk is about migrating large-scale Redis instances at Kuaishou from bare metal to Kubernetes to improve resource utilization.: https://kubeblocks.io/blog/migrate-redis-at-kuaishou-from-bare-metal-to-k8s ## blog/moodle-in-kubeblocks - Deploy Moodle on K8s with KubeBlocks MySQL Operator — This blog introduces how to deploy Moodle using the KubeBlocks MySQL operator on Windows: https://kubeblocks.io/blog/moodle-in-kubeblocks ## blog/oci-mssql-tcp-blackhole-troubleshooting - A Deep Dive into Troubleshooting and Resolving a SQL Server TCP Blackhole on an OKE Cluster — This article documents the entire process of troubleshooting and resolving a TCP blackhole issue discovered during SQL Server failover testing on an Oracle Kubernetes Engine (OKE) cluster. The problem caused long-lived connections to experience a "fake death" phenomenon after failover, taking about 15 minutes to recover.: https://kubeblocks.io/blog/oci-mssql-tcp-blackhole-troubleshooting ## blog/redis-operatorization-ready-yet - Redis Operatorization - Ready Yet? — Is operatorizing Redis with Kubernetes Operators production-ready? Examine HA, persistence, sharding challenges and alternatives like Kubeblocks and open-source Redis Operators.: https://kubeblocks.io/blog/redis-operatorization-ready-yet ## blog/run-databases-on-k8s-insights-from-leading-chinese-internet-companies - Running Databases on Kubernetes - Insights from Leading Chinese Internet Companies — This blog explores why leading Chinese internet companies are increasingly adopting the practice of running databases on Kubernetes.: https://kubeblocks.io/blog/run-databases-on-k8s-insights-from-leading-chinese-internet-companies ## blog/run-redis-on-k8s-kuaishou-solution-with-kubeblocks - Managing Large-Scale Redis Clusters on Kubernetes with an Operator - Kuaishou's Approach — Drawing from Kuaishou's experience in implementing cloud-native Redis at scale, this blog delves into practical solutions and critical considerations for managing stateful services in Kubernetes environments.: https://kubeblocks.io/blog/run-redis-on-k8s-kuaishou-solution-with-kubeblocks ## blog/take-specified-instances-offline - How to Take Specified Instances Offline? — This blog introduces how KubeBlocks takes specified instances offline using InstanceSet.: https://kubeblocks.io/blog/take-specified-instances-offline ## blog/Use-KubeBlocks-to-build-your-AIGC-infrastructure-on-Amazon-EKS - Use KubeBlocks to build your AIGC infrastructure on Amazon EKS — Use KubeBlocks to build your AIGC infrastructure on Amazon EKS: https://kubeblocks.io/blog/Use-KubeBlocks-to-build-your-AIGC-infrastructure-on-Amazon-EKS ## blog/validating-kubeblocks-addon-availability-with-chaos-mesh - Practical Experience in Validating KubeBlocks Addon Availability with Chaos Mesh — This blog introduces how to leverage Chaos Mesh for chaos engineering to validate and enhance KubeBlocks' high availability capabilities through systematic fault injection testing.: https://kubeblocks.io/blog/validating-kubeblocks-addon-availability-with-chaos-mesh ## blog/we-let-an-ai-agent-manage-our-databases - We Let an AI Agent Manage Our Databases. Here's Why Most Operators Failed It. — We tested AI agents against traditional Kubernetes database operators. The results revealed a fundamental mismatch between fragmented operator APIs and how LLMs actually reason — and why a unified API like KubeBlocks changes everything.: https://kubeblocks.io/blog/we-let-an-ai-agent-manage-our-databases ## docs/preview/kubeblocks-for-clickhouse — ClickHouse OLAP cluster management - _prerequisites — - A functional Kubernetes cluster (v1.21+ recommended) - v1.21+ installed and configured with cluster access - KubeBlocks installed (installation guide) - ClickHouse Add-on enabled - A namespace:: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/_tpl/_prerequisites - KubeBlocks for ClickHouse — Overview of ClickHouse support in KubeBlocks, including architecture, topologies, and key features.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/01-overview - ClickHouse Quickstart — Deploy and connect to a ClickHouse cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/02-quickstart - ClickHouse Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages ClickHouse clusters on Kubernetes, including the resource hierarchy, pod layout, ClickHouse Keeper-based coordination, and traffic routing.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/03-architecture - Stop, Start, and Restart a ClickHouse Cluster — Learn how to stop, start, and restart ClickHouse clusters managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/01-stop-start-restart - Vertical Scaling for ClickHouse — Learn how to adjust CPU and memory resources for ClickHouse components in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/02-vertical-scaling - Horizontal Scaling for ClickHouse — Learn how to scale ClickHouse replicas within a shard and scale the number of shards in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/03-horizontal-scaling - Volume Expansion for ClickHouse — Learn how to expand the storage volume for ClickHouse pods in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/04-volume-expansion - Reconfigure ClickHouse Parameters — Update ClickHouse configuration by supplying custom XML templates (ConfigMaps) in KubeBlocks 1.0, aligned with the ClickHouse add-on design.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/05-reconfigure - ClickHouse Keeper Switchover — Learn how to perform a Keeper leader switchover in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/06-switchover - Manage Services for ClickHouse — Learn how to expose ClickHouse services externally in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/04-operations/07-manage-services - Integrate ClickHouse with Prometheus Operator — Learn how to configure Prometheus monitoring for ClickHouse clusters managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-clickhouse/07-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-elasticsearch — Elasticsearch cluster management - _create-cluster — KubeBlocks uses a declarative approach for managing Elasticsearch Clusters. Below is an example configuration for deploying a Elasticsearch Cluster with create a cluster with replicas for different ro...: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/_tpl/_create-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/_tpl/_prerequisites - _verify-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your Elasticsearch cluste...: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/_tpl/_verify-cluster - Overview of KubeBlocks Elasticsearch Addon — Learn about the features and capabilities of the KubeBlocks Elasticsearch addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/01-overview - Elasticsearch Quickstart — Comprehensive guide to deploying and managing Elasticsearch ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/02-quickstart - Elasticsearch Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Elasticsearch clusters on Kubernetes across four topologies — single-node, mdit, multi-node, and m-d-i-t — with dedicated architecture diagrams, pod internals, and HA details for each layout.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/03-architecture - Elasticsearch Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage Elasticsearch Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/01-stop-start-restart - Vertical Scaling in a Elasticsearch Cluster — Learn how to perform vertical scaling in a Elasticsearch Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/02-vertical-scaling - Horizontal Scaling of Elasticsearch Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a Elasticsearch cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/03-horizontal-scaling - Expanding Volume in a Elasticsearch Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a Elasticsearch cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/04-volume-expansion - Create and Destroy Elasticsearch Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage Elasticsearch services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/05-manage-loadbalancer - Decommission a Specific Pod in KubeBlocks-Managed Elasticsearch Clusters — Learn how to decommission (take offline) a specific Pod in a Elasticsearch cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/04-operations/09-decommission-a-specific-replica - Observability for Elasticsearch Clusters with the Prometheus Operator — Learn how to set up observability for Elasticsearch Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-elasticsearch/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-etcd — etcd key-value store management - _prerequisites — Before proceeding, verify your environment meets these requirements: - A functional Kubernetes cluster (v1.21+ recommended) - v1.21+ installed and configured with cluster access - Helm installed (inst...: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/_tpl/_prerequisites - Overview of KubeBlocks etcd Addon — Learn about the features and capabilities of the KubeBlocks etcd addon, including lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/01-overview - etcd Quickstart — Comprehensive guide to deploying and managing etcd clusters with KubeBlocks, including installation, configuration, and operational best practices.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/02-quickstart - etcd Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages etcd clusters on Kubernetes, including the resource hierarchy, pod layout, Raft consensus, and automatic leader election.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/03-architecture - etcd Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage etcd cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/01-stop-start-restart - Vertical Scaling of etcd Clusters with KubeBlocks — Learn how to vertically scale an etcd cluster managed by KubeBlocks by adjusting CPU and memory resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/02-vertical-scaling - Horizontal Scaling of etcd Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on an etcd cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/03-horizontal-scaling - Volume Expansion for etcd Clusters with KubeBlocks — Learn how to expand the storage volume of an etcd cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/04-volume-expansion - Switchover for etcd Clusters with KubeBlocks — Learn how to perform a manual leader switchover for an etcd cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/05-switchover - Upgrading the Minor Version of an etcd Cluster in KubeBlocks — Learn how to upgrade an etcd cluster to a newer minor version managed by KubeBlocks with minimal downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/06-minor-version-upgrade - Manage etcd Services in KubeBlocks — Learn how to expose etcd services externally using LoadBalancer and how to disable external access when no longer needed.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/04-operations/07-manage-services - Backup an etcd Cluster — Learn how to create on-demand and scheduled backups for etcd clusters managed by KubeBlocks using the datafile backup method.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/05-backup-restore/01-backup - Restore an etcd Cluster from Backup — Learn how to restore a new etcd cluster from an existing datafile backup in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/05-backup-restore/02-restore - Observability for etcd Clusters with the Prometheus Operator — Learn how to set up observability for etcd Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-etcd/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-kafka — Kafka broker/controller cluster management - _create-cluster — KubeBlocks uses a declarative approach for managing Kafka Clusters. Below is an example configuration for deploying a Kafka Cluster with 3 components Apply the following YAML configuration to deploy t...: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/_tpl/_create-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/_tpl/_prerequisites - _verify-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your Kafka cluster is rea...: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/_tpl/_verify-cluster - Overview of KubeBlocks Kafka Addon — Learn about the features and capabilities of the KubeBlocks Kafka addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/01-overview - Kafka Quickstart — Comprehensive guide to deploying and managing Kafka ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/02-quickstart - Kafka Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Apache Kafka clusters on Kubernetes. Covers Combined (broker+controller co-located), Separated (independent controller and broker components), and Kafka 2.x (ZooKeeper-based) topologies with KRaft consensus, partition leader election, per-pod service routing, and SASL account management.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/03-architecture - Kafka Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage Kafka Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/01-stop-start-restart - Vertical Scaling in a Kafka Cluster — Learn how to perform vertical scaling in a Kafka Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/02-vertical-scaling - Horizontal Scaling of Kafka Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a Kafka cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/03-horizontal-scaling - Expanding Volume in a Kafka Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a Kafka cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/04-volume-expansion - Create and Destroy Kafka Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage Kafka services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/05-manage-loadbalancer - Decommission a Specific Pod in KubeBlocks-Managed Kafka Clusters — Learn how to decommission (take offline) a specific Pod in a Kafka cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/04-operations/09-decommission-a-specific-replica - Observability for Kafka Clusters with the Prometheus Operator — Learn how to set up observability for Kafka Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-kafka/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-milvus — Milvus vector database management - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/_tpl/_prerequisites - Overview of KubeBlocks Milvus Addon — Learn about the features and capabilities of the KubeBlocks Milvus addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/01-overview - Milvus Quickstart — Comprehensive guide to deploying and managing Milvus ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices,an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/02-quickstart - Milvus Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Milvus vector database on Kubernetes. Covers both Standalone (all-in-one single process) and Distributed (microservices with proxy, coordinator, and worker components) architectures.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/03-architecture - Deploying a Milvus Standalone Cluster with KubeBlocks — Learn how to deploy a Milvus Standalone Cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/03-topologies/01-standlone - Deploying a Milvus Cluster with KubeBlocks — Learn how to deploy a Redis Replication cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/03-topologies/02-cluster - Milvus Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage Milvus Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/04-operations/01-stop-start-restart - Vertical Scaling in a Milvus Cluster — Learn how to perform vertical scaling in a Milvus Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/04-operations/02-vertical-scaling - Horizontal Scaling of Milvus Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a Milvus cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/04-operations/03-horizontal-scaling - Create and Destroy Milvus Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage Milvus services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/04-operations/05-manage-loadbalancer - Decommission a Specific Pod in KubeBlocks-Managed Milvus Clusters — Learn how to decommission (take offline) a specific Pod in a Milvus cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/04-operations/09-decommission-a-specific-replica - Observability for Milvus Clusters with the Prometheus Operator — Learn how to set up observability for Milvus Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-milvus/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-minio — MinIO object storage management - _prerequisites — - A functional Kubernetes cluster (v1.21+ recommended) - v1.21+ installed and configured with cluster access - KubeBlocks installed (installation guide) - MinIO Add-on enabled: - A namespace for the c...: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/_tpl/_prerequisites - KubeBlocks for MinIO Overview — Overview of the MinIO addon for KubeBlocks, including features, architecture, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/01-overview - MinIO Quickstart — Deploy and connect to a MinIO cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/02-quickstart - MinIO Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages MinIO distributed object storage on Kubernetes, including the resource hierarchy, pod layout, erasure coding, and data durability.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/03-architecture - Stop, Start, and Restart MinIO — Learn how to stop, start, and restart a MinIO cluster in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/04-operations/01-stop-start-restart - Vertical Scaling for MinIO — Learn how to adjust CPU and memory resources for a MinIO cluster in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/04-operations/02-vertical-scaling - Horizontal Scaling for MinIO — Learn how to add MinIO nodes in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/04-operations/03-horizontal-scaling - Manage Services for MinIO — Learn how to expose MinIO services externally in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/04-operations/04-manage-services - Volume Expansion for MinIO — Learn how to expand storage for a MinIO cluster in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/04-operations/05-volume-expansion - Integrate MinIO with Prometheus Operator — Learn how to configure Prometheus monitoring for MinIO clusters managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-minio/07-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-mongodb — MongoDB sharded/replica-set cluster management - _create-cluster — KubeBlocks uses a declarative approach for managing MongoDB Replication Clusters. Below is an example configuration for deploying a MongoDB ReplicaSet Cluster with one primary replica and two secondar...: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/_tpl/_create-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/_tpl/_prerequisites - _verify-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your MongoDB cluster is r...: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/_tpl/_verify-cluster - Overview of KubeBlocks MongoDB Addon — Learn about the features and capabilities of the KubeBlocks MongoDB addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/01-overview - MongoDB Quickstart — Comprehensive guide to deploying and managing MongoDB ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/02-quickstart - MongoDB Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages MongoDB on Kubernetes. Covers both Replica Set (primary/secondary HA) and Sharding (mongos + config servers + data shards) architectures, including pod layout, traffic routing, and failover behavior.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/03-architecture - Deploying a MongoDB ReplicaSet Cluster with KubeBlocks — Learn how to deploy a MongoDB ReplicaSet Cluster using KubeBlocks. This guide covers configuration, verification, and cluster management.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/03-topologies/01-standlone - Deploying a MongoDB Sharding Cluster with KubeBlocks — Learn how to deploy a MongoDB Sharding cluster using KubeBlocks. This guide covers configuration, verification, scaling, and switchover.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/03-topologies/02-sharding - MongoDB ReplicaSet Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage MongoDB ReplicaSet Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/01-stop-start-restart - Vertical Scaling in a MongoDB ReplicaSet Cluster — Learn how to perform vertical scaling in a MongoDB ReplicaSet Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/02-vertical-scaling - Horizontal Scaling of MongoDB Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a MongoDB cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/03-horizontal-scaling - Expanding Volume in a MongoDB Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a MongoDB cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/04-volume-expansion - Create and Destroy MongoDB Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage MongoDB services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/05-manage-loadbalancer - Modify MongoDB Parameters — Learn how to modify dynamic and static MongoDB parameters in KubeBlocks using Reconfiguring OpsRequest to optimize database performance and availability.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/07-modify-parameters - MongoDB Cluster Switchover — Perform planned role transitions in MongoDB clusters with KubeBlocks for minimal downtime and controlled maintenance: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/08-switchover - Decommission a Specific Pod in KubeBlocks-Managed MongoDB Clusters — Learn how to decommission (take offline) a specific Pod in a MongoDB cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/04-operations/09-decommission-a-specific-replica - Create a MongoDB Cluster with a Custom Root Password on KubeBlocks — Learn how to deploy a MongoDB cluster on KubeBlocks with a custom root password securely configured using Kubernetes Secrets.: https://kubeblocks.io/docs/preview/kubeblocks-for-mongodb/06-custom-secret/01-custom-secret ## docs/preview/kubeblocks-for-mysql - Overview of KubeBlocks MySQL Addon — Learn about the features and capabilities of the KubeBlocks MySQL addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/01-overview - Quickstart — Learn how to get started with KubeBlocks MySQL Add-on, including prerequisites, enabling the MySQL Add-on, creating a MySQL cluster, and managing it effectively, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/02-quickstart - MySQL Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages MySQL clusters on Kubernetes. Covers Semisync (binlog replication), MGR (Group Replication with Paxos consensus on :33061), and Orchestrator-based HA architectures, with optional ProxySQL frontend.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-architecture - Deploying a MySQL Semi-Synchronous Cluster with KubeBlocks — Learn how to deploy a MySQL semi-synchronous replication cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/01-semisync - Deploying a MySQL Semi-Synchronous Cluster with ProxySQL on KubeBlocks — Learn how to deploy a MySQL semi-synchronous replication cluster with ProxySQL using KubeBlocks. This guide covers configuration, verification, and failover testing.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/02-semisync-with-proxysql - Deploying a MySQL Group Replication Cluster Using KubeBlocks — Learn how to deploy and manage a MySQL Group Replication (MGR) cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and cleanup.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/03-mgr - Deploying a MySQL Group Replication Cluster with ProxySQL Using KubeBlocks — Learn how to deploy a MySQL Group Replication (MGR) cluster with ProxySQL integration using KubeBlocks. This guide covers configuration, verification, failover testing, and cleanup.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/04-mgr-with-proxysql - Deploying a MySQL Cluster and Orchestrator with KubeBlocks — A step-by-step guide to deploying a MySQL semi-synchronous replication cluster with Orchestrator using KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/05-orchestrator - Deploying a MySQL Cluster with Orchestrator and ProxySQL using KubeBlocks — Learn how to deploy a MySQL semi-synchronous replication cluster with Orchestrator and ProxySQL using KubeBlocks for high availability and efficient query routing.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/03-topologies/06-orchestrator-with-proxysql - Managing MySQL Cluster Lifecycle (Stop, Start, and Restart) — Learn how to manage the lifecycle of a MySQL cluster in KubeBlocks, including stopping, starting, and restarting clusters to optimize resource usage and maintain flexibility.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/01-stop_start_restart - Vertical Scaling in a MySQL Cluster — Learn how to perform vertical scaling in a MySQL cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/02-vertical-scaling - Horizontal Scaling of MySQL Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a MySQL cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/03-horizontal-scaling - Expanding Volume in a MySQL Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a MySQL cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/04-volume-expansion - Create and Destroy MySQL Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage MySQL services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/05-manage-loadbalancer - Upgrading the Minor Version of a MySQL Cluster in KubeBlocks — Learn how to deploy and upgrade a MySQL cluster managed by KubeBlocks with minimal downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/06-minor-version-upgrade - Modify MySQL Parameters — Learn how to modify dynamic and static MySQL parameters in KubeBlocks using Reconfiguring OpsRequest to optimize database performance and availability.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/07-modify-parameters - Planned Switchover in a MySQL Cluster — Learn how to perform a planned switchover in a MySQL cluster using KubeBlocks to ensure minimal downtime and seamless role transitions.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/08-switchover - Decommission a Specific Pod in KubeBlocks-Managed MySQL Clusters — Learn how to decommission (take offline) a specific Pod in a MySQL cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/09-decommission-a-specific-replica - Recovering MySQL Replica in KubeBlocks — How to recover a MySQL replica in a semi-synchronous cluster managed by KubeBlocks using in-place and non-in-place repair methods.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/04-operations/11-rebuild-replica - Create a Backup Repository for KubeBlocks — Learn how to create and configure a BackupRepo for KubeBlocks using an S3 bucket to store backup data.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/01-create-backuprepo - Create a Full Backup for a MySQL Cluster on KubeBlocks — Step-by-step guide to creating and validating full backups for MySQL clusters using Backup API and Ops API in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/02-create-full-backup - Setting Up a MySQL Cluster with Scheduled Backups in KubeBlocks — Learn how to deploy a MySQL cluster using KubeBlocks and configure automated scheduled backups with retention in an S3 repository.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/03-scheduled-full-backup - Setting Up a MySQL Cluster with Scheduled Continuous Backup in KubeBlocks — Learn how to set up a MySQL cluster with scheduled full backups and continuous incremental backups enabled in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/04-scheduled-continuous-backup - Restore a MySQL Cluster from Backup — Learn how to restore a new MySQL cluster from an existing backup in KubeBlocks using the Cluster Annotation or Ops API.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/05-restoring-from-full-backup - Restore a MySQL Cluster from Backup with Point-In-Time-Recovery(PITR) on KubeBlocks — Learn how to restore a MySQL cluster using a full backup and continuous binlog backup for Point-In-Time Recovery (PITR) on KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/05-backup-restore/06-restore-with-pitr - Create a MySQL Cluster with a Custom Root Password on KubeBlocks — Learn how to deploy a MySQL cluster on KubeBlocks with a custom root password securely configured using Kubernetes Secrets.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/06-custom-secret/01-custom-secret - Deploy a MySQL Cluster with a Custom Password Generation Policy on KubeBlocks — Learn how to deploy a MySQL cluster in KubeBlocks with a custom password generation policy for the root user to enhance security.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/06-custom-secret/02-custom-password-generation-policy - Deploying a MySQL Cluster with TLS on KubeBlocks — Learn how to deploy a MySQL cluster with TLS encryption on KubeBlocks for secure communication. This guide covers deployment configuration, secure connections, and resource cleanup.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/07-tls/01-tls-overview - Deploy a MySQL Cluster with User-Provided TLS on KubeBlocks — Learn how to deploy a MySQL cluster on KubeBlocks with user-provided TLS certificates for secure communication. This guide covers generating certificates, deploying the cluster, and verifying secure connections.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/07-tls/02-tls-custom-cert - Deploy a MySQL Cluster with mTLS on KubeBlocks — Learn how to configure mutual TLS (mTLS) encryption for a MySQL cluster on KubeBlocks. This guide walks through certificate generation, cluster deployment, mTLS user setup, and secure connection verification.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/07-tls/03-mtls - Observability for MySQL Clusters with the Prometheus Operator — Learn how to set up observability for MySQL Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/08-monitoring/01-integrate-with-prometheus-operator - Configuring Custom Scheduling Policies for MySQL Cluster Pods in KubeBlocks — Learn how to configure custom scheduling policies for MySQL Cluster Pods in KubeBlocks to ensure high availability or optimize for low latency by controlling their distribution across availability zones.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/01-custom-scheduling-policy - Customizing Pod Resource Configurations and Labels in a MySQL Cluster Managed by KubeBlocks — Learn how to customize Pod resource configurations and labels in a MySQL cluster using KubeBlocks to meet specific workload demands.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/02-custom-pod-resources - Configuring MySQL Cluster with Controlled Pod Creation, Scaling, and Deletion Parallelism in KubeBlocks — Learn how to configure MySQL clusters in KubeBlocks with controlled pod parallelism for creation, scaling, and deletion using the `parallelPodManagementConcurrency` parameter.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/03-parallel-pod-management-concurrency - Setting Instance Update Strategy to OnDelete for MySQL Clusters in KubeBlocks — Learn how to configure the OnDelete instance update strategy to control updates for MySQL clusters in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/04-instance-update-strategy-ondelete - Configuring a MySQL Cluster with Gradual Rolling Update in KubeBlocks — Learn how to configure and perform gradual rolling updates for MySQL clusters in KubeBlocks using the rolling update strategy to ensure minimal disruption during updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/05-gradual-rolling-update - Retain PVCs when deleting/scaling down a MySQL Cluster in KubeBlocks — Learn how to retain PVCs when deleting/scaling down a MySQL cluster in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-mysql/09-advanced-pod-management/06-retain-pvc ## docs/preview/kubeblocks-for-postgresql — PostgreSQL cluster management, HA, extensions - _create-pg-replication-cluster — KubeBlocks uses a declarative approach for managing PostgreSQL clusters. Below is an example configuration for deploying a PostgreSQL cluster with 2 replicas (1 primary, 1 replicas).: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/_tpl/_create-pg-replication-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/_tpl/_prerequisites - _verify-pg-replication-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Once the cluster status becomes Running, your PostgreSQL cluster is ready for use.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/_tpl/_verify-pg-replication-cluster - Overview of KubeBlocks PostgreSQL Addon — Learn about the features and capabilities of the KubeBlocks PostgreSQL addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/01-overview - PostgreSQL Quickstart — Comprehensive guide to deploying and managing PostgreSQL clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/02-quickstart - PostgreSQL High Availability Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages PostgreSQL high-availability clusters on Kubernetes, including the resource hierarchy, pod layout, traffic routing, and automatic failover.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/03-architecture - PostgreSQL Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage PostgreSQL cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/01-stop-start-restart - Vertical Scaling in a PostgreSQL Cluster — Learn how to perform vertical scaling in a PostgreSQL cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/02-vertical-scaling - Horizontal Scaling of PostgreSQL Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a PostgreSQL cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/03-horizontal-scaling - Expanding Volume in a PostgreSQL Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a PostgreSQL cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/04-volume-expansion - Create and Destroy PostgreSQL Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage PostgreSQL services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/05-manage-loadbalancer - Upgrading the Minor Version of a PostgreSQL Cluster in KubeBlocks — Learn how to deploy and upgrade a PostgreSQL cluster managed by KubeBlocks with minimal downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/06-minor-version-upgrade - Modify PostgreSQL Parameters — Learn how to modify dynamic and static PostgreSQL parameters in KubeBlocks using Reconfiguring OpsRequest to optimize database performance and availability.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/07-modify-parameters - PostgreSQL Cluster Switchover — Perform planned role transitions in PostgreSQL clusters with KubeBlocks for minimal downtime and controlled maintenance: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/08-switchover - Decommission a Specific Pod in KubeBlocks-Managed PostgreSQL Clusters — Learn how to decommission (take offline) a specific Pod in a PostgreSQL cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/09-decommission-a-specific-replica - Recovering PostgreSQL Replica in KubeBlocks — How to rebuild a PostgreSQL replica in a replication cluster managed by KubeBlocks using in-place and non-in-place methods.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/04-operations/11-rebuild-replica - Create a Backup Repository for KubeBlocks — Learn how to create and configure a BackupRepo for KubeBlocks using an S3 bucket to store backup data.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/01-create-backuprepo - Create a Full Backup for a PostgreSQL Cluster on KubeBlocks — Step-by-step guide to creating and validating full backups for PostgreSQL clusters using Backup API and OpsRequest API in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/02-create-full-backup - Setting Up a PostgreSQL Cluster with Scheduled Backups in KubeBlocks — Learn how to deploy a PostgreSQL cluster using KubeBlocks and configure automated scheduled backups with retention in an S3 repository.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/03-scheduled-full-backup - Setting Up a PostgreSQL Cluster with Scheduled Continuous Backup in KubeBlocks — Learn how to set up a PostgreSQL cluster with scheduled full backups and continuous incremental backups enabled in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/04-scheduled-continuous-backup - Restore a PostgreSQL Cluster from Backup — Learn how to restore a new PostgreSQL cluster from an existing backup in KubeBlocks using the Cluster Annotation or OpsRequest API.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/05-restoring-from-full-backup - Restore a PostgreSQL Cluster from Backup with Point-In-Time-Recovery(PITR) on KubeBlocks — Learn how to restore a PostgreSQL cluster using a full backup and continuous binlog backup for Point-In-Time Recovery (PITR) on KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/05-backup-restore/06-restore-with-pitr - Create a PostgreSQL Cluster with a Custom Root Password on KubeBlocks — Learn how to deploy a PostgreSQL cluster on KubeBlocks with a custom root password securely configured using Kubernetes Secrets.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/06-custom-secret/01-custom-secret - Deploy a PostgreSQL Cluster with a Custom Password Generation Policy on KubeBlocks — Learn how to deploy a PostgreSQL cluster in KubeBlocks with a custom password generation policy for the root user to enhance security.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/06-custom-secret/02-custom-password-generation-policy - Deploying a PostgreSQL Cluster with TLS on KubeBlocks — Learn how to deploy a PostgreSQL cluster with TLS encryption on KubeBlocks for secure communication. This guide covers deployment configuration, secure connections, and resource cleanup.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/07-tls/01-tls-overview - Deploy a PostgreSQL Cluster with Custom TLS Certificates on KubeBlocks — Step-by-step guide to deploy a PostgreSQL cluster on KubeBlocks using custom TLS certificates for secure communication. Includes certificate generation, cluster deployment, and connection verification.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/07-tls/02-tls-custom-cert - Observability for PostgreSQL Clusters with the Prometheus Operator — Learn how to set up observability for PostgreSQL Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/08-monitoring/01-integrate-with-prometheus-operator - FAQs — Frequently asked questions about running PostgreSQL with KubeBlocks, covering HA, replication, connection pooling, and common operational issues.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/09-faqs - Using Pre-installed Extensions — How to enable and use the pre-installed PostgreSQL extensions shipped with KubeBlocks, including pgvector, PostGIS, TimescaleDB, pg_cron, pgaudit, and more.: https://kubeblocks.io/docs/preview/kubeblocks-for-postgresql/10-using-extensions ## docs/preview/kubeblocks-for-qdrant — Qdrant vector database management - _create-cluster — KubeBlocks uses a declarative approach for managing Qdrant Clusters. Below is an example configuration for deploying a Qdrant Cluster with 3 replicas.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/_tpl/_create-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/_tpl/_prerequisites - _verify-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your Qdrant cluster is re...: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/_tpl/_verify-cluster - Overview of KubeBlocks Qdrant Addon — Learn about the features and capabilities of the KubeBlocks Qdrant addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/01-overview - Qdrant Quickstart — Comprehensive guide to deploying and managing Qdrant ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/02-quickstart - Qdrant Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Qdrant vector database clusters on Kubernetes, including the resource hierarchy, pod layout, Raft-based sharding, and traffic routing.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/03-architecture - Qdrant Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage Qdrant Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/01-stop-start-restart - Vertical Scaling in a Qdrant Cluster — Learn how to perform vertical scaling in a Qdrant Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/02-vertical-scaling - Horizontal Scaling of Qdrant Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a Qdrant cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/03-horizontal-scaling - Expanding Volume in a Qdrant Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a Qdrant cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/04-volume-expansion - Create and Destroy Qdrant Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage Qdrant services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/05-manage-loadbalancer - Upgrading the Minor Version of a Qdrant Cluster in KubeBlocks — Learn how to deploy and upgrade a Qdrant Cluster managed by KubeBlocks with minimal downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/06-minor-version-upgrade - Decommission a Specific Pod in KubeBlocks-Managed Qdrant Clusters — Learn how to decommission (take offline) a specific Pod in a Qdrant cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/04-operations/09-decommission-a-specific-replica - Create a Backup Repository for KubeBlocks — Learn how to create and configure a BackupRepo for KubeBlocks using an S3 bucket to store backup data.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/05-backup-restore/01-create-backuprepo - Create a Full Backup for a Qdrant Cluster on KubeBlocks — Step-by-step guide to creating and validating full backups for Qdrant clusters using Backup API and OpsRequest API in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/05-backup-restore/02-create-full-backup - Setting Up a Qdrant Cluster with Scheduled Backups in KubeBlocks — Learn how to deploy a Qdrant cluster using KubeBlocks and configure automated scheduled backups with retention in an S3 repository.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/05-backup-restore/03-scheduled-full-backup - Restore a Qdrant Cluster from Backup — Learn how to restore a new Qdrant cluster from an existing backup in KubeBlocks using the Cluster Annotation or OpsRequest API.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/05-backup-restore/05-restoring-from-full-backup - Observability for Qdrant Clusters with the Prometheus Operator — Learn how to set up observability for Qdrant Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-qdrant/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-rabbitmq — RabbitMQ message broker management - _create-cluster — KubeBlocks uses a declarative approach for managing RabbitMQ Clusters. Below is an example configuration for deploying a RabbitMQ Cluster with 3 replicas.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/_tpl/_create-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/_tpl/_prerequisites - _verify-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your RabbitMQ cluster is ...: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/_tpl/_verify-cluster - Overview of KubeBlocks RabbitMQ Addon — Learn about the features and capabilities of the KubeBlocks RabbitMQ addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/01-overview - RabbitMQ Quickstart — Comprehensive guide to deploying and managing RabbitMQ ReplicaSet Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/02-quickstart - RabbitMQ Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages RabbitMQ clusters on Kubernetes. Covers the cluster mode topology with Erlang distributed clustering, quorum queue HA via Raft consensus, per-pod layout, traffic routing, and automatic failover.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/03-architecture - RabbitMQ Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage RabbitMQ Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/01-stop-start-restart - Vertical Scaling in a RabbitMQ Cluster — Learn how to perform vertical scaling in a RabbitMQ Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/02-vertical-scaling - Horizontal Scaling of RabbitMQ Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a RabbitMQ cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/03-horizontal-scaling - Expanding Volume in a RabbitMQ Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a RabbitMQ cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/04-volume-expansion - Create and Destroy RabbitMQ Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage RabbitMQ services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/05-manage-loadbalancer - Decommission a Specific Pod in KubeBlocks-Managed RabbitMQ Clusters — Learn how to decommission (take offline) a specific Pod in a RabbitMQ cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/04-operations/09-decommission-a-specific-replica - Observability for RabbitMQ Clusters with the Prometheus Operator — Learn how to set up observability for RabbitMQ Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-rabbitmq/08-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-redis — Redis cluster, Sentinel, network modes - _create-redis-replication-cluster — KubeBlocks uses a declarative approach for managing Redis Replication Clusters. Below is an example configuration for deploying a Redis Replication Cluster with two components, redis and redis sentine...: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/_tpl/_create-redis-replication-cluster - _prerequisites — Before proceeding, ensure the following: - Environment Setup: - A Kubernetes cluster is up and running. - The kubectl CLI tool is configured to communicate with your cluster.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/_tpl/_prerequisites - _verify-redis-replication-cluster — Monitor the cluster status until it transitions to the Running state: Example Output: Check the pod status and roles: Example Output: Once the cluster status becomes Running, your Redis cluster is rea...: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/_tpl/_verify-redis-replication-cluster - Overview of KubeBlocks Redis Addon — Learn about the features and capabilities of the KubeBlocks Redis addon, including deployment topologies, lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/01-overview - Redis Quickstart — Comprehensive guide to deploying and managing Redis Replication Clusters with KubeBlocks, including installation, configuration, and operational best practices, an alternative to dedicated operator.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/02-quickstart - Redis Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Redis on Kubernetes. Covers both Sentinel (primary/replica with automatic failover) and Redis Cluster (hash-slot sharding) architectures, including pod layout, traffic routing, and failover behavior.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/03-architecture - Deploying a Redis Standalone Cluster with KubeBlocks — Learn how to deploy a Redis Standalone cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/03-topologies/01-standlone - Deploying a Redis Replication Cluster with KubeBlocks — Learn how to deploy a Redis Replication cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/03-topologies/02-replication - Deploying a Redis Sharding Cluster with KubeBlocks — Learn how to deploy a Redis Sharding cluster using KubeBlocks. This guide covers configuration, verification, failover testing, and timeout configuration.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/03-topologies/03-sharding - Redis Replication Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage Redis Replication Cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/01-stop-start-restart - Vertical Scaling in a Redis Replication Cluster — Learn how to perform vertical scaling in a Redis Replication Cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/02-vertical-scaling - Horizontal Scaling of Redis Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a Redis cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/03-horizontal-scaling - Expanding Volume in a Redis Cluster — Learn how to expand Persistent Volume Claims (PVCs) in a Redis cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/04-volume-expansion - Create and Destroy Redis Service Using the Declarative Cluster API in KubeBlocks — Learn how to configure and manage Redis services in KubeBlocks for external and internal access using LoadBalancer and other service types.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/05-manage-loadbalancer - Modify Redis Parameters — Learn how to modify dynamic and static Redis parameters in KubeBlocks using Reconfiguring OpsRequest to optimize database performance and availability.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/07-modify-parameters - Redis Cluster Switchover — Perform planned role transitions in Redis clusters with KubeBlocks for minimal downtime and controlled maintenance: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/08-switchover - Decommission a Specific Pod in KubeBlocks-Managed Redis Clusters — Learn how to decommission (take offline) a specific Pod in a Redis cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/04-operations/09-decommission-a-specific-replica - Create a Backup Repository for KubeBlocks — Learn how to create and configure a BackupRepo for KubeBlocks using an S3 bucket to store backup data.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/01-create-backuprepo - Create a Full Backup for a Redis Cluster on KubeBlocks — Step-by-step guide to creating and validating full backups for Redis clusters using Backup API and OpsRequest API in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/02-create-full-backup - Setting Up a Redis Cluster with Scheduled Backups in KubeBlocks — Learn how to deploy a Redis cluster using KubeBlocks and configure automated scheduled backups with retention in an S3 repository.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/03-scheduled-full-backup - Setting Up a Redis Cluster with Scheduled Continuous Backup in KubeBlocks — Learn how to set up a Redis cluster with scheduled full backups and continuous incremental backups enabled in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/04-scheduled-continuous-backup - Restore a Redis Cluster from Backup — Learn how to restore a new Redis cluster from an existing backup in KubeBlocks using the Cluster Annotation or OpsRequest API.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/05-restoring-from-full-backup - Restore a Redis Cluster from Backup with Point-In-Time-Recovery(PITR) on KubeBlocks — Learn how to restore a Redis cluster using a full backup and continuous binlog backup for Point-In-Time Recovery (PITR) on KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/05-backup-restore/06-restore-with-pitr - Create a Redis Cluster with a Custom Root Password on KubeBlocks — Learn how to deploy a Redis cluster on KubeBlocks with a custom root password securely configured using Kubernetes Secrets.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/06-custom-secret/01-custom-secret - Observability for Redis Clusters with the Prometheus Operator — Learn how to set up observability for Redis Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/08-monitoring/01-integrate-with-prometheus-operator - FAQs — FAQs of Redis: https://kubeblocks.io/docs/preview/kubeblocks-for-redis/09-faqs ## docs/preview/kubeblocks-for-rocketmq - _prerequisites — Before proceeding, verify your environment meets these requirements: - A functional Kubernetes cluster (v1.21+ recommended) - v1.21+ installed and configured with cluster access - Helm installed (inst...: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/_tpl/_prerequisites - KubeBlocks for RocketMQ — Overview of RocketMQ support in KubeBlocks, including architecture, components, and key features.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/01-overview - RocketMQ Quickstart — Deploy and connect to a RocketMQ cluster managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/02-quickstart - RocketMQ Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Apache RocketMQ clusters on Kubernetes, including the resource hierarchy, NameServer and Broker components, ASYNC_MASTER/SLAVE HA, and traffic routing.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/03-architecture - Stop, Start, and Restart a RocketMQ Cluster — Learn how to stop, start, and restart RocketMQ clusters managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/01-stop-start-restart - Vertical Scaling for RocketMQ — Learn how to adjust CPU and memory resources for RocketMQ components in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/02-vertical-scaling - Horizontal Scaling for RocketMQ — Learn how to scale out or scale in RocketMQ NameServer replicas in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/03-horizontal-scaling - Volume Expansion for RocketMQ — Learn how to expand the storage volume for RocketMQ broker pods in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/04-volume-expansion - Reconfigure RocketMQ Broker Parameters — Learn how to dynamically update RocketMQ broker configuration parameters in KubeBlocks without restarting pods.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/05-reconfigure - Manage Services for RocketMQ — Learn how to expose RocketMQ services externally in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/04-operations/06-manage-services - Integrate RocketMQ with Prometheus Operator — Learn how to configure Prometheus monitoring for RocketMQ clusters managed by KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-rocketmq/07-monitoring/01-integrate-with-prometheus-operator ## docs/preview/kubeblocks-for-zookeeper — Apache ZooKeeper management - _prerequisites — Before proceeding, verify your environment meets these requirements: - A functional Kubernetes cluster (v1.21+ recommended) - v1.21+ installed and configured with cluster access - Helm installed (inst...: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/_tpl/_prerequisites - Overview of KubeBlocks ZooKeeper Addon — Learn about the features and capabilities of the KubeBlocks ZooKeeper addon, including lifecycle management, backup and restore, and supported versions.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/01-overview - ZooKeeper Quickstart — Comprehensive guide to deploying and managing ZooKeeper clusters with KubeBlocks, including installation, configuration, and operational best practices.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/02-quickstart - ZooKeeper Architecture in KubeBlocks — Learn how KubeBlocks deploys and manages Apache ZooKeeper ensembles on Kubernetes, including the resource hierarchy, pod layout, ZAB protocol, and automatic leader election.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/03-architecture - ZooKeeper Cluster Lifecycle Management (Stop, Start, Restart) — Learn how to manage ZooKeeper cluster states in KubeBlocks including stopping, starting, and restarting operations to optimize resources.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/01-stop-start-restart - Vertical Scaling in a ZooKeeper Cluster — Learn how to perform vertical scaling in a ZooKeeper cluster managed by KubeBlocks to optimize resource utilization and improve performance.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/02-vertical-scaling - Horizontal Scaling of ZooKeeper Clusters with KubeBlocks — Learn how to perform horizontal scaling (scale-out and scale-in) on a ZooKeeper cluster managed by KubeBlocks using OpsRequest and direct Cluster API updates.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/03-horizontal-scaling - Volume Expansion in a ZooKeeper Cluster — Learn how to expand persistent storage volumes in a ZooKeeper cluster managed by KubeBlocks without downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/04-volume-expansion - ZooKeeper Configuration — Understand how ZooKeeper configuration is managed in KubeBlocks, including static parameters and dynamic ensemble membership.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/05-modify-parameters - Upgrading the Minor Version of a ZooKeeper Cluster in KubeBlocks — Learn how to upgrade a ZooKeeper cluster to a newer minor version managed by KubeBlocks with minimal downtime.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/06-minor-version-upgrade - Manage ZooKeeper Services in KubeBlocks — Learn how to expose ZooKeeper services externally using LoadBalancer or NodePort, and how to disable external access when no longer needed.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/04-operations/07-manage-services - Backup a ZooKeeper Cluster — Learn how to create on-demand and scheduled backups for ZooKeeper clusters managed by KubeBlocks using the zoocreeper backup method.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/05-backup-restore/01-backup - Restore a ZooKeeper Cluster from Backup — Learn how to restore a new ZooKeeper cluster from an existing zoocreeper backup in KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/05-backup-restore/02-restore - Observability for ZooKeeper Clusters with the Prometheus Operator — Learn how to set up observability for ZooKeeper Clusters in KubeBlocks using the Prometheus Operator. Configure monitoring and visualize metrics with Grafana.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/08-monitoring/01-integrate-with-prometheus-operator - ZooKeeper FAQs — Frequently asked questions about managing ZooKeeper clusters with KubeBlocks.: https://kubeblocks.io/docs/preview/kubeblocks-for-zookeeper/09-faqs ## docs/preview/user_docs — End-user documentation: installation, cluster management, backup, scaling, monitoring - Configure BackupRepo — How to configure BackupRepo: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/backup/backup-repo - Configure BackupPolicy — How to configure BackupPolicy: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/backup/configure-backuppolicy - On-demand backup — How to back up databases on-demand by snapshot and backup tool: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/backup/on-demand-backup - Scheduled backup — How to back up databases by schedule: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/backup/scheduled-backup - Introduction — Introduction of KubeBlocks backup and restore functions: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/introduction - PITR — How to perform PITR: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/restore/pitr - Restore data from backup set — How to restore data from backup set: https://kubeblocks.io/docs/preview/user_docs/concepts/backup-and-restore/restore/restore-data-from-backup-set - Concepts — KubeBlocks, CRD: https://kubeblocks.io/docs/preview/user_docs/concepts/concept - Enable in-place update — Enable in-place update: https://kubeblocks.io/docs/preview/user_docs/concepts/in-place-update/ignore-vertical-scale - Introduction — Introduction: https://kubeblocks.io/docs/preview/user_docs/concepts/in-place-update/overview - Apply instance template — Apply instance template: https://kubeblocks.io/docs/preview/user_docs/concepts/instance-template/how-to-use-instance-template - Introduction — Introduction: https://kubeblocks.io/docs/preview/user_docs/concepts/instance-template/introduction - Installation — Install KubeBlocks on the existing Kubernetes clusters with Helm: https://kubeblocks.io/docs/preview/user_docs/overview/install-kubeblocks - Introduction — introduction to KubeBlocks: https://kubeblocks.io/docs/preview/user_docs/overview/introduction - Supported Addons — Addons supported by KubeBlocks: https://kubeblocks.io/docs/preview/user_docs/overview/supported-addons - Add-On API Reference — Add-On API Reference: https://kubeblocks.io/docs/preview/user_docs/references/api-reference/add-on - Cluster API Reference — Cluster API Reference: https://kubeblocks.io/docs/preview/user_docs/references/api-reference/cluster - Dataprotection API Reference — Dataprotection API Reference: https://kubeblocks.io/docs/preview/user_docs/references/api-reference/dataprotection - Operations API Reference — Operations API Reference: https://kubeblocks.io/docs/preview/user_docs/references/api-reference/operations - Parameters API Reference — Parameters API Reference: https://kubeblocks.io/docs/preview/user_docs/references/api-reference/parameters - Addons Management — Install KubeBlocks addons with Helm: https://kubeblocks.io/docs/preview/user_docs/references/install-addons - Install and Configure the KubeBlocks CLI (kbcli) — Complete guide to installing, verifying, and configuring kbcli for KubeBlocks cluster management: https://kubeblocks.io/docs/preview/user_docs/references/install-kbcli - Install MinIO — Complete guide to installing MinIO for KubeBlocks cluster management: https://kubeblocks.io/docs/preview/user_docs/references/install-minio - Install Snapshot Controller — Install Snapshot Controller: https://kubeblocks.io/docs/preview/user_docs/references/install-snapshot-controller - KubeBlocks Options — KubeBlocks Options: https://kubeblocks.io/docs/preview/user_docs/references/kubeblocks_options - KubeBlocks RBAC Permissions — KubeBlocks RBAC Permissions: https://kubeblocks.io/docs/preview/user_docs/references/kubeblocks_rbac - Kubernetes and Operator 101 — things about K8s you need to know: https://kubeblocks.io/docs/preview/user_docs/references/kubernetes_and_operator_101 - Create a test Kubernetes cluster — Create a test Kubernetes cluster: https://kubeblocks.io/docs/preview/user_docs/references/prepare-a-local-k8s-cluster - Terminology — Terms you should know of KubeBlocks: https://kubeblocks.io/docs/preview/user_docs/references/terminology - FAQs — How to handle an exception in a cluster: https://kubeblocks.io/docs/preview/user_docs/troubleshooting/handle-a-cluster-exception - Known Issues — Known issues in KubeBlocks: https://kubeblocks.io/docs/preview/user_docs/troubleshooting/known-issues - Migrate Existing Clusters to a New Addon Version — Step-by-step guide to upgrade Addons and migrate existing clusters to the new Addon version: https://kubeblocks.io/docs/preview/user_docs/upgrade/migrate-clusters-to-new-addon - Upgrade to v0.8 — Upgrade to KubeBlocks v0.8, operation, tips and notes: https://kubeblocks.io/docs/preview/user_docs/upgrade/upgrade-to-0_8 - Upgrade to v0.9.0 — Upgrade to KubeBlocks v0.9.0, operation, tips and notes: https://kubeblocks.io/docs/preview/user_docs/upgrade/upgrade-to-0_9_0 - Upgrade to v0.9.x — Upgrade to KubeBlocks v0.9.x, operation, tips and notes: https://kubeblocks.io/docs/preview/user_docs/upgrade/upgrade-to-v09-version - Upgrade to v1.0.x — Upgrade to KubeBlocks v1.0.x, operation, tips and notes: https://kubeblocks.io/docs/preview/user_docs/upgrade/upgrade-to-v10x