neumann-deploy

Deploy Neumann clusters and single-node instances across Docker Compose and Kubernetes.

74|6|Updated Dec 23, 2025
One-click install
npx skills add https://github.com/Shadylukin/Neumann --skill neumann-deploy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: neumann-deploy
Source: https://github.com/Shadylukin/Neumann/tree/main/.claude/skills/neumann-deploy
Command: npx skills add https://github.com/Shadylukin/Neumann --skill neumann-deploy

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about neumann-deploy

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a multi-node Neumann cluster using Docker Compose?

To deploy a Neumann cluster with Docker Compose, configure an odd-sized Raft quorum across multiple nodes, define peer configurations, and verify cluster health using the gRPC health endpoint on each mapped port.

Can I run Neumann on Kubernetes with persistent storage and health probes?

Yes, Neumann can run on Kubernetes using a StatefulSet configuration with PVC templates for persistent storage, gRPC health probes, and defined resource limits to ensure reliable production availability.

What is the best way to back up and recover a Neumann Raft cluster?

The best way to back up Neumann is by using checkpoint and WAL-based backup procedures, which capture persistent storage states and allow reliable recovery for Raft cluster nodes.

Does Neumann deployment require TLS configuration and NTP synchronization?

Neumann deployment recommends TLS for secure communication and requires NTP synchronization across nodes to maintain Raft quorum stability and ensure consistent cluster operations.

How do I set up a single-node Neumann instance for development?

To set up a single-node Neumann development instance, configure a lightweight node with a specified data directory and optional WAL for durability, providing a quick local testing environment.

What are the production hardening requirements for a Neumann StatefulSet deployment?

Production hardening for Neumann StatefulSet deployments requires configuring multi-AZ distribution, setting resource limits, applying TLS recommendations, and conducting failover testing to ensure availability.