neumann-deploy

What problem does it solve?

Deployment and operation of Neumann can be complex and error-prone across development, containerized, and Kubernetes environments; this guide consolidates best practices for single-node and clustered Raft deployments, durability, monitoring, backups, and production hardening so teams can run Neumann reliably at scale.

Core Features & Use Cases

• Single-node deployment: quick development or lightweight production node with optional WAL for durability and configurable data directories.
• Cluster orchestration: instructions for forming odd-sized Raft clusters with peer configuration, NTP requirements, and health verification.
• Container and Kubernetes patterns: ready-to-use Docker Compose for multi-node clusters and a Kustomize/StatefulSet example with probes, resource limits, and PVC templates.
• Operational tooling: health checks via gRPC, checkpoint and WAL-based backup/restore guidance, TLS recommendations, and production checklist for AZ distribution and failover testing.

Quick Start

Start a three-node Neumann cluster using the included Docker Compose configuration, wait for each node to become healthy, and verify with the gRPC health endpoint on each mapped port.