apecloud

kubeblocks

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.

apecloud 3 Updated 1mo ago

Resources

7
GitHub

Install

npx skillscat add apecloud/kubeblocks-skills

Install via the SkillsCat registry.

SKILL.md

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:

  1. No Kubernetes cluster yet
    Route to create-local-k8s-cluster.

  2. Kubernetes exists, but KubeBlocks is not installed
    Route to install-kubeblocks.

  3. First-time provisioning, or environment readiness is unknown
    Route to kubeblocks-preflight before any engine-specific provisioning.

  4. Provision a database after preflight

  5. Operate an existing cluster
    Route to the matching capability layer:

  6. Observability

  7. 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, or alerting-ready.
  • Do not recommend legacy kubeblocks-addon-*, kubeblocks-create-cluster, or old Day-2 names as the primary path when the corresponding kubeblocks-engine-*, kubeblocks-engine-generic, or kubeblocks-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 / WaitForFirstConsumer storage is required
  • Which engine entry skill to use
  • Which generic paths are forbidden
  • Demo vs production sizing guidance
  • Whether observability should go to existing-stack or bootstrap-stack

Common Misroutes To Prevent

  • ACK multi-AZ + PostgreSQL/MySQL:
    Route to preflight first. Do not jump directly from install to addon provisioning.
  • Existing Prometheus/Grafana:
    Route to observability-existing-stack, not full monitoring bootstrap.
  • Unknown or low-frequency engines:
    Only then use engine-generic as the other-addons fallback.