NodeFoundry Documentation
Everything you need to deploy and operate bare-metal Ceph clusters — from first boot to day-two operations.
Get Started
Quick Start
Deploy your first cluster end-to-end in under 15 minutes.
Architecture
Understand how NodeFoundry, Sentinel, and Ceph fit together.
CLI Reference
Complete command reference for the nf tool.
REST API
Full API reference with request and response examples.
Concepts
Networking
How iPXE boot, DHCP, and cluster networking work.
Storage
Ceph pools, OSDs, CephFS, and object storage fundamentals.
Guides
iPXE Boot Setup
Configure network boot for your hardware environment.
Adding Nodes
Register new bare-metal servers with your cluster.
Deploying Ceph
Step-by-step guide to setting up monitors, OSDs, and managers.
S3 Object Storage
Deploy RGW and configure S3-compatible storage.
Prerequisites
Before getting started, make sure you have:
| Requirement | Details |
|---|---|
| Hardware | Any x86_64 servers with PXE boot support (BIOS or UEFI). Minimum 3 nodes for production. |
| Network | A managed switch with DHCP forwarding configured to point at your master node. |
| Master Node | One machine (physical or VM) with 4 vCPU, 8 GB RAM, and a 50 GB root disk. |