cursus

Cursus Documentation

This index separates normative contracts from implementation notes. When prose conflicts, the wire protocol specification and API reference define client-visible behavior; configuration defaults are defined by pkg/config.

Start Here

• Getting Started: run a broker and issue basic commands.
• Installation: source builds, binaries, Docker, and GHCR images.
• Configuration: files, environment variables, CLI flags, security, storage, cluster, and SDK options.
• Architecture: standalone and clustered data/control paths and their guarantees.
• SDK Overview: cross-language Wire v2 compatibility and Go, Java, and Python capability contracts.

Normative Contracts

• Wire Protocol Specification: framing, commands, responses, errors, groups, transactions, topic policies, and SDK requirements.
• API Reference: command-by-command request and response reference.
• Command Interface: compact command map and routing rules.
• Cluster Consumer Contract: coordinator discovery, partition-leader routing, resume, heartbeat, and rejoin behavior.
• Consumer Groups: durable nextOffset lifecycle and delivery guarantees.
• Event Sourcing: aggregate streams, optimistic concurrency, snapshots, and distributed recovery.

Architecture And Internals

• Core Systems
• Message Flow
• Server
• Topics And Partitions
• Topic Management
• Log Compaction: standalone and distributed safety gates, offset holes, replica catch-up, and recovery.
• Disk Format
• Disk Persistence
• Segment Management
• Platform Optimizations

Operations And Evaluation

• Observability: health, readiness, metrics, alerts, and security boundaries.
• Consumer Lifecycle Alerts: external minimum-member contracts and canary validation.
• Performance: tuning knobs and durability/latency trade-offs.
• Benchmarks: tools, workload model, and result interpretation.
• Benchmark Verification: local standalone and cluster verification.
• Comparison: product scope, strengths, and explicit maturity gaps.
• Release Automation: release workflow and artifacts.

Contributing

See Design And Contribution Principles. Changes to protocol behavior must update the specification, API reference, relevant SDK documentation, and executable tests in the same pull request.

This site is open source. Improve this page.