Prerequisites for self-hosting Neptune
Neptune runs on a Kubernetes cluster. For details on architecture and features, see the Self-hosted Neptune overview.
Neptune's system requirements
The following are requirements of Neptune itself:
- SSD disks for storage
- PV provisioner support in the underlying infrastructure
Internet access isn't required. If available, it's used only for the installation and upgrade procedure itself. However, deployment artifacts can also be transferred to an air-gapped environment through a secure offline method.
Platform requirements
The below are minimum requirements. The overall hardware requirements depend on the volume of metadata that users log, as well as data ingestion speeds determined by the subscription plan.
- Helm
3.17+ - Kubernetes
1.29+
Additionally, Kubernetes has the following hardware requirements:
| Kubernetes requirements | Processing | Memory |
|---|---|---|
| General | 20 CPUs | 100 GB RAM |
| For each shard | 112 CPUs | 500 GB RAM |
The actual required CPU and RAM depends on the ingestion rate. A single shard can be enough if ingesting a small amount of data (less than 100k points/second). However, multiple shards make the UI more responsive, due to increased retrieval performance.
The per-shard requirement might be smaller if not using multi-zone deployment.
For details, contact us at support@neptune.ai.
Neptune's dependencies
All of the listed dependencies can be delivered as part of the installation process.
| Component | Version | CPU | Memory | Storage |
|---|---|---|---|---|
| ClickHouse | 24.10.3 | 24 CPUs (3 replicas, 8 CPU each) | 72 GB (3 replicas, 24 GB each) | 900 GB (see section below for details) |
| MySQL | 5.7.14+ or 8.0.13+ | 2 | 8 GB | 200 GB |
| Redis | 6.0+ | 1 | 4 GiB | - |
| Kafka | 3.6.1+ | 6 CPUs (3 nodes, 2 CPU each) | 12 GB (3 nodes, 4 GB each) | 100 GB |
Storage
To store the data that users are logging, Neptune supports PersistentVolumeClaim storage. The Kubernetes cluster where Neptune is deployed needs to be able to provision storage. Managed Kubernetes services (such as Amazon EKS, Google GKE, and Azure AKS) usually have this capability out of the box.
How much storage space is required?
We recommend at least 2.7 TB, but the storage requirement depends on the amount of actual logged experiment metadata.
Deployment host requirements
You need the following on the machine or VM that performs the deployment:
- Access to the Kubernetes cluster where Neptune will be installed.
- The
kubectlandhelmcommand-line tools.