Route database work on Kubernetes to the right KubeBlocks skill. Use this as the top-level entrypoint when the user needs a database, database operations, or database observability on Kubernetes. The root skill only decides the next hop; detailed workflows live in the leaf skills.
Resources
7Install
npx skillscat add apecloud/kubeblocks-skills Install via the SkillsCat registry.
KubeBlocks Router
This root skill is a router only. It should decide the next step, not re-explain every workflow.
Use README.md for repository overview, installation instructions, and the full skill catalog.
Route Order
Always route in this order:
No Kubernetes cluster yet
Route to create-local-k8s-cluster.Kubernetes exists, but KubeBlocks is not installed
Route to install-kubeblocks.First-time provisioning, or environment readiness is unknown
Route to kubeblocks-preflight before any engine-specific provisioning.Provision a database after preflight
- MySQL → engine-mysql
- PostgreSQL → engine-postgresql
- Redis → engine-redis
- MongoDB → engine-mongodb
- Kafka → engine-kafka
- Elasticsearch → engine-elasticsearch
- Milvus → engine-milvus
- Qdrant → engine-qdrant
- RabbitMQ → engine-rabbitmq
- ClickHouse → engine-clickhouse
- MariaDB → engine-mariadb
- MinIO → engine-minio
- OpenSearch → engine-opensearch
- Pulsar → engine-pulsar
- TiDB → engine-tidb
- Other engines without dedicated entry skills → engine-generic
Operate an existing cluster
Route to the matching capability layer:- lifecycle → op-lifecycle
- horizontal scale → op-horizontal-scale
- vertical scale → op-vertical-scale
- volume expansion → op-volume-expansion
- parameters → op-reconfigure
- backup → op-backup
- restore → op-restore
- expose → op-expose
- switchover → op-switchover
- engine upgrade → op-upgrade
- account / password management → manage-accounts
- TLS / mTLS → configure-tls
- safe deletion → delete-cluster
Observability
- Broad observability ask → observability-router
- Existing Prometheus/Grafana stack → observability-existing-stack
- No monitoring base yet → observability-bootstrap-stack
- If the user only says “set up monitoring”, use the shim setup-monitoring, which routes to the right observability branch.
Troubleshooting
Route to troubleshoot from any stage when state is unknown, capability is unclear, or observed behavior is broken.
For replica recovery or HA repair after troubleshooting, also consider rebuild-replica.
Hard Routing Rules
- Do not route the Tier-1 engine set to engine-generic or to any family/taxonomy-only explanation layer.
- Do not provision a first-time database without going through kubeblocks-preflight when environment readiness is unknown.
- Do not equate “metrics exist” with “monitoring is delivered”. Observability must declare whether it is only
metrics-ready,scrape-ready,dashboard-ready, oralerting-ready. - Do not recommend legacy
kubeblocks-addon-*,kubeblocks-create-cluster, or old Day-2 names as the primary path when the correspondingkubeblocks-engine-*,kubeblocks-engine-generic, orkubeblocks-op-*entry exists.
Recommendation Bundle Contract
kubeblocks-preflight should produce an environment profile / recommendation bundle that downstream engine-entry skills can consume. At minimum it must answer:
- Recommended
storageClassName - Whether topology-aware /
WaitForFirstConsumerstorage is required - Which engine entry skill to use
- Which generic paths are forbidden
- Demo vs production sizing guidance
- Whether observability should go to
existing-stackorbootstrap-stack
Common Misroutes To Prevent
- ACK multi-AZ + PostgreSQL/MySQL:
Route topreflightfirst. Do not jump directly from install to addon provisioning. - Existing Prometheus/Grafana:
Route toobservability-existing-stack, not full monitoring bootstrap. - Unknown or low-frequency engines:
Only then use engine-generic as theother-addonsfallback.