kubeblocks

分类: 数据库与数据存储 | 上传者: apecloud | 下载: 0 | 版本: v1.0（最新）

Provision and manage production-grade databases on Kubernetes using KubeBlocks. Use this skill whenever the user needs a database — MySQL, PostgreSQL, Redis, MongoDB, Kafka, Elasticsearch, Milvus, Qdrant, RabbitMQ, or any other data infrastructure — regardless of whether they mention KubeBlocks or Kubernetes. If someone says "I need a database", "set up MySQL", "I want Redis for caching", "I need a message queue", "spin up Postgres", "deploy a vector database for RAG", or anything involving database provisioning, scaling, backup, restore, monitoring, or troubleshooting, this skill applies. Even if the user has never heard of KubeBlocks or Kubernetes, use this skill to give them the easiest path to a running database. Also use when the user explicitly mentions KubeBlocks, wants to manage existing database clusters, or needs guidance on any database operation on Kubernetes.

更新日志: Source: GitHub https://github.com/apecloud/kubeblocks-skills

目录结构

当前层级: 根目录

📁 references/
- 📄 safety-patterns.md 4.0 KB
📁 skills/
- 📁 kubeblocks-addon-elasticsearch/
  - 📄 SKILL.md 7.2 KB
- 📁 kubeblocks-addon-kafka/
  - 📁 references/
    
    📄 reference.md 3.6 KB
  - 📄 SKILL.md 10.0 KB
- 📁 kubeblocks-addon-milvus/
  - 📄 SKILL.md 6.8 KB
- 📁 kubeblocks-addon-mongodb/
  - 📁 references/
    
    📄 reference.md 5.8 KB
  - 📄 SKILL.md 8.0 KB
- 📁 kubeblocks-addon-mysql/
  - 📁 references/
    
    📄 reference.md 6.8 KB
  - 📄 SKILL.md 8.1 KB
- 📁 kubeblocks-addon-postgresql/
  - 📁 references/
    
    📄 reference.md 4.8 KB
  - 📄 SKILL.md 8.1 KB
- 📁 kubeblocks-addon-qdrant/
  - 📄 SKILL.md 6.0 KB
- 📁 kubeblocks-addon-rabbitmq/
  - 📄 SKILL.md 5.8 KB
- 📁 kubeblocks-addon-redis/
  - 📁 references/
    
    📄 reference.md 5.5 KB
  - 📄 SKILL.md 8.5 KB
- 📁 kubeblocks-backup/
  - 📁 references/
    
    📄 reference.md 5.6 KB
  - 📄 SKILL.md 7.3 KB
- 📁 kubeblocks-cluster-lifecycle/
  - 📁 references/
    
    📄 reference.md 5.1 KB
  - 📄 SKILL.md 7.0 KB
- 📁 kubeblocks-configure-tls/
  - 📁 references/
    
    📄 reference.md 6.4 KB
  - 📄 SKILL.md 7.5 KB
- 📁 kubeblocks-create-cluster/
  - 📁 references/
    
    📄 reference.md 9.7 KB
  - 📄 SKILL.md 9.7 KB
- 📁 kubeblocks-create-local-k8s-cluster/
  - 📄 SKILL.md 4.3 KB
- 📁 kubeblocks-delete-cluster/
  - 📄 SKILL.md 4.7 KB
- 📁 kubeblocks-expose-service/
  - 📁 references/
    
    📄 reference.md 7.0 KB
  - 📄 SKILL.md 6.3 KB
- 📁 kubeblocks-horizontal-scaling/
  - 📁 references/
    
    📄 reference.md 7.6 KB
  - 📄 SKILL.md 9.4 KB
- 📁 kubeblocks-install/
  - 📁 references/
    
    📄 reference.md 7.0 KB
  - 📄 SKILL.md 7.6 KB
- 📁 kubeblocks-manage-accounts/
  - 📄 SKILL.md 5.0 KB
- 📁 kubeblocks-manage-addons/
  - 📁 references/
    
    📄 reference.md 5.8 KB
  - 📄 SKILL.md 6.3 KB
- 📁 kubeblocks-minor-version-upgrade/
  - 📄 SKILL.md 6.4 KB
- 📁 kubeblocks-rebuild-replica/
  - 📄 SKILL.md 4.7 KB
- 📁 kubeblocks-reconfigure-parameters/
  - 📁 references/
    
    📄 reference.md 5.3 KB
  - 📄 SKILL.md 5.1 KB
- 📁 kubeblocks-restore/
  - 📁 references/
    
    📄 reference.md 4.0 KB
  - 📄 SKILL.md 7.3 KB
- 📁 kubeblocks-setup-monitoring/
  - 📁 references/
    
    📄 reference.md 5.1 KB
  - 📄 SKILL.md 6.5 KB
- 📁 kubeblocks-switchover/
  - 📁 references/
    
    📄 reference.md 4.4 KB
  - 📄 SKILL.md 6.3 KB
- 📁 kubeblocks-troubleshoot/
  - 📄 SKILL.md 6.5 KB
- 📁 kubeblocks-upgrade/
  - 📄 SKILL.md 4.9 KB
- 📁 kubeblocks-vertical-scaling/
  - 📄 SKILL.md 7.1 KB
- 📁 kubeblocks-volume-expansion/
  - 📁 references/
    
    📄 reference.md 2.9 KB
  - 📄 SKILL.md 8.5 KB
📄 .gitignore 582 B
📄 AGENTS.md 297 B
📄 LICENSE 10.5 KB
📄 README.md 9.1 KB
📄 SKILL.md 10.9 KB

SKILL.md

---
name: kubeblocks
metadata:
  version: "0.1.0"
description: Provision and manage production-grade databases on Kubernetes using KubeBlocks. Use this skill whenever the user needs a database — MySQL, PostgreSQL, Redis, MongoDB, Kafka, Elasticsearch, Milvus, Qdrant, RabbitMQ, or any other data infrastructure — regardless of whether they mention KubeBlocks or Kubernetes. If someone says "I need a database", "set up MySQL", "I want Redis for caching", "I need a message queue", "spin up Postgres", "deploy a vector database for RAG", or anything involving database provisioning, scaling, backup, restore, monitoring, or troubleshooting, this skill applies. Even if the user has never heard of KubeBlocks or Kubernetes, use this skill to give them the easiest path to a running database. Also use when the user explicitly mentions KubeBlocks, wants to manage existing database clusters, or needs guidance on any database operation on Kubernetes.
---

# KubeBlocks — Databases on Kubernetes, Made Simple

## When To Use This Skill

You should reach for this skill in any of these situations:

- The user needs a database (any engine, any purpose) and has access to a Kubernetes cluster — or could have one
- The user asks to "set up", "create", "deploy", "spin up", or "provision" any database
- The user mentions a specific database engine: MySQL, PostgreSQL, Redis, MongoDB, Kafka, Elasticsearch, Milvus, Qdrant, RabbitMQ, ClickHouse, or others
- The user needs database operations: scaling, backup, restore, monitoring, failover, parameter tuning
- The user is troubleshooting a database issue on Kubernetes
- The user mentions KubeBlocks directly

If the user doesn't have a Kubernetes cluster yet, that's fine — this skill set includes creating a local K8s cluster for development and testing.

## What is KubeBlocks?

KubeBlocks is a Kubernetes operator that manages 30+ database engines on any K8s cluster. It provides a unified API for the full lifecycle — from provisioning and scaling to backup, restore, and observability — across relational, NoSQL, streaming, vector, and graph databases.

- Official docs: https://kubeblocks.io/docs/preview/user_docs/overview/introduction
- Full LLM doc index: https://kubeblocks.io/llms-full.txt
- GitHub: https://github.com/apecloud/kubeblocks

## Quick Status Check

Before performing any operation, verify the current state:

```bash
# Check if KubeBlocks is installed
kubectl -n kb-system get pods

# List all database clusters across namespaces
kubectl get cluster -A

# Check KubeBlocks version
helm list -n kb-system | grep kubeblocks
```

If KubeBlocks is not installed, start with the [install-kubeblocks](skills/kubeblocks-install/SKILL.md) skill. If there is no Kubernetes cluster at all, start with [create-local-k8s-cluster](skills/kubeblocks-create-local-k8s-cluster/SKILL.md).

## Skill Map

Read the skill that matches the user's intent. Each skill is a self-contained guide with YAML templates, step-by-step workflow, and troubleshooting.

### Getting Started

| User Intent | Skill |
|---|---|
| Create a local K8s test cluster | [create-local-k8s-cluster](skills/kubeblocks-create-local-k8s-cluster/SKILL.md) |
| Install KubeBlocks operator | [install-kubeblocks](skills/kubeblocks-install/SKILL.md) |
| Install/manage database engine addons | [manage-addons](skills/kubeblocks-manage-addons/SKILL.md) |

### Create a Database

| User Intent | Skill |
|---|---|
| Create a MySQL cluster | [addon-mysql](skills/kubeblocks-addon-mysql/SKILL.md) |
| Create a PostgreSQL cluster | [addon-postgresql](skills/kubeblocks-addon-postgresql/SKILL.md) |
| Create a Redis cluster | [addon-redis](skills/kubeblocks-addon-redis/SKILL.md) |
| Create a MongoDB cluster | [addon-mongodb](skills/kubeblocks-addon-mongodb/SKILL.md) |
| Create a Kafka cluster | [addon-kafka](skills/kubeblocks-addon-kafka/SKILL.md) |
| Create an Elasticsearch cluster | [addon-elasticsearch](skills/kubeblocks-addon-elasticsearch/SKILL.md) |
| Create a Milvus (vector DB) cluster | [addon-milvus](skills/kubeblocks-addon-milvus/SKILL.md) |
| Create a Qdrant (vector DB) cluster | [addon-qdrant](skills/kubeblocks-addon-qdrant/SKILL.md) |
| Create a RabbitMQ cluster | [addon-rabbitmq](skills/kubeblocks-addon-rabbitmq/SKILL.md) |
| Create any other database (generic) | [create-cluster](skills/kubeblocks-create-cluster/SKILL.md) |
| Delete a database cluster | [delete-cluster](skills/kubeblocks-delete-cluster/SKILL.md) |

### Day-2 Operations

| User Intent | Skill |
|---|---|
| Stop / Start / Restart a cluster | [cluster-lifecycle](skills/kubeblocks-cluster-lifecycle/SKILL.md) |
| Scale CPU / Memory (vertical) | [vertical-scaling](skills/kubeblocks-vertical-scaling/SKILL.md) |
| Add / remove replicas or shards | [horizontal-scaling](skills/kubeblocks-horizontal-scaling/SKILL.md) |
| Expand storage volume | [volume-expansion](skills/kubeblocks-volume-expansion/SKILL.md) |
| Change database parameters | [reconfigure-parameters](skills/kubeblocks-reconfigure-parameters/SKILL.md) |
| Primary / secondary switchover | [switchover](skills/kubeblocks-switchover/SKILL.md) |
| Upgrade database engine version | [minor-version-upgrade](skills/kubeblocks-minor-version-upgrade/SKILL.md) |
| Rebuild a failed replica | [rebuild-replica](skills/kubeblocks-rebuild-replica/SKILL.md) |
| Upgrade KubeBlocks operator | [upgrade-kubeblocks](skills/kubeblocks-upgrade/SKILL.md) |

### Data Protection

| User Intent | Skill |
|---|---|
| Backup cluster data | [backup](skills/kubeblocks-backup/SKILL.md) |
| Restore from backup / PITR | [restore](skills/kubeblocks-restore/SKILL.md) |

### Security & Networking

| User Intent | Skill |
|---|---|
| Manage database passwords / accounts | [manage-accounts](skills/kubeblocks-manage-accounts/SKILL.md) |
| Configure TLS / mTLS encryption | [configure-tls](skills/kubeblocks-configure-tls/SKILL.md) |
| Expose service externally (LoadBalancer/NodePort) | [expose-service](skills/kubeblocks-expose-service/SKILL.md) |

### Observability

| User Intent | Skill |
|---|---|
| Setup monitoring (Prometheus/Grafana) | [setup-monitoring](skills/kubeblocks-setup-monitoring/SKILL.md) |

### Troubleshooting

| User Intent | Skill |
|---|---|
| Cluster not working, error, failed, stuck, CrashLoopBackOff | [troubleshoot](skills/kubeblocks-troubleshoot/SKILL.md) |

## Decision Tree

Use this when the user's intent needs clarification:

```
User needs a database
├─ Is KubeBlocks installed?
│  ├─ No  → Do they have a K8s cluster?
│  │        ├─ No  → create-local-k8s-cluster → install-kubeblocks
│  │        └─ Yes → install-kubeblocks
│  └─ Yes → Continue below
│
├─ Create a database
│  ├─ Is the engine addon installed?
│  │  ├─ No  → manage-addons → then create cluster
│  │  └─ Yes → Which engine?
│  │           ├─ MySQL/PG/Redis/MongoDB/Kafka/ES/Milvus/Qdrant/RabbitMQ → addon-{engine}
│  │           └─ Other → create-cluster (generic)
│  └─ Don't know which engine? → Recommend based on use case:
│     ├─ Relational / SQL         → addon-postgresql or addon-mysql
│     ├─ Cache / session store    → addon-redis
│     ├─ Document store           → addon-mongodb
│     ├─ Event streaming          → addon-kafka
│     ├─ Full-text search / logs  → addon-elasticsearch
│     ├─ Vector similarity / RAG  → addon-milvus or addon-qdrant
│     └─ Message queue            → addon-rabbitmq or addon-kafka
│
├─ Operate an existing database
│  ├─ Scale CPU/Memory      → vertical-scaling
│  ├─ Add/remove replicas   → horizontal-scaling
│  ├─ Expand disk            → volume-expansion
│  ├─ Change DB config       → reconfigure-parameters
│  ├─ Switchover primary     → switchover
│  ├─ Upgrade DB version     → minor-version-upgrade
│  ├─ Rebuild failed replica → rebuild-replica
│  ├─ Stop / Start / Restart → cluster-lifecycle
│  └─ Delete permanently     → delete-cluster
│
├─ Protect data
│  ├─ Backup                 → backup
│  └─ Restore / PITR         → restore
│
├─ Secure the database
│  ├─ Manage passwords       → manage-accounts
│  ├─ Enable TLS/SSL         → configure-tls
│  └─ Expose externally      → expose-service
│
├─ Monitor                   → setup-monitoring
├─ Upgrade KubeBlocks itself → upgrade-kubeblocks
└─ Something is broken       → troubleshoot
```

## Engine Recommendation Guide

When the user needs a database but hasn't chosen an engine, recommend based on their use case:

| Use Case | Recommended Engine | Why |
|---|---|---|
| Web app backend, relational data, SQL | PostgreSQL | Most versatile, strong ecosystem |
| Legacy app compatibility, MySQL protocol | MySQL | Drop-in for MySQL-dependent apps |
| Caching, sessions, rate limiting | Redis | Sub-millisecond latency, simple API |
| Flexible schema, document storage | MongoDB | Schema-free, horizontal scaling |
| Event streaming, log pipelines | Kafka | High throughput, durable ordered streams |
| Full-text search, log analytics | Elasticsearch | Inverted index, powerful query DSL |
| AI embeddings, similarity search, RAG | Milvus or Qdrant | Purpose-built vector indexes |
| Task queues, pub/sub messaging | RabbitMQ | Flexible routing, multiple protocols |

## Disambiguation Guide

### "Scale" ambiguity

| User says | Skill |
|-----------|-------|
| "scale up", "more CPU", "more memory", "resize" | vertical-scaling |
| "add replicas", "more nodes", "scale out", "add shards" | horizontal-scaling |
| "more disk", "more storage", "expand volume" | volume-expansion |

### "Delete" vs "Stop"

| User says | Skill |
|-----------|-------|
| "delete", "remove", "destroy", "drop" (permanent) | delete-cluster |
| "stop", "pause", "shut down" (temporary, keeps data) | cluster-lifecycle |

### "Upgrade" ambiguity

| User says | Skill |
|-----------|-------|
| "upgrade MySQL/PG version", "patch database" | minor-version-upgrade |
| "upgrade KubeBlocks", "update operator" | upgrade-kubeblocks |

## Safety Patterns

Before performing any cluster-modifying operation, review the [safety-patterns](references/safety-patterns.md) reference for dry-run requirements, status confirmation conventions, and production cluster protection rules.

## Common Debugging Commands

```bash
kubectl describe cluster <cluster-name> -n <namespace>
kubectl get opsrequest -n <namespace>
kubectl get component -n <namespace>
kubectl logs -n <namespace> <pod-name> -c <container-name>
kubectl -n kb-system logs -l app.kubernetes.io/name=kubeblocks --tail=100
```

## Documentation Links

| Resource | URL |
|---|---|
| Introduction | https://kubeblocks.io/docs/preview/user_docs/overview/introduction |
| Supported Addons | https://kubeblocks.io/docs/preview/user_docs/overview/supported-addons |
| Full LLM Index | https://kubeblocks.io/llms-full.txt |
| GitHub Repository | https://github.com/apecloud/kubeblocks |
| Releases | https://github.com/apecloud/kubeblocks/releases |

登录后下载/点赞/收藏 ❤ 2 | ★ 0

kubeblocks

目录结构

SKILL.md

举报内容

提示