Skip to content

Guides ​

Task-oriented instructions. Each page answers one "how do I…" question and assumes you already know what a topic, a consumer group and an epoch are — if not, read Concepts first.

Unlike Getting Started, these pages do not form a sequence. Find your task in the table, do it, leave.

In this chapter ​

I want to…Page
Stand up a 3-node cluster — ports, startup order, verificationDeploy a cluster
Tick every line before carrying real trafficProduction checklist
Handle a broker failure — quorum loss, metadata quarantine, kill -9 recoveryRunbook
Turn an error code into a fixTroubleshooting
Upgrade or roll back without breaking clientsUpgrade
Write a producer or consumer the right wayBest practices
Get a straight yes/no answer about behaviourFAQ

Planned pages ​

  • Manage topics and consumer groups — create, list, describe, delete
  • Observe — reading the 15-metric allowlist, what to alert on
  • Back up and restore — segment files, metadata log and snapshots
  • Exact command syntax and exit codes: CLI
  • Metric names, types and conservation properties: Metrics