README
¶
AeroLab
AeroLab deploys and manages Aerospike clusters on Docker, AWS, or GCP — for local dev, testing, and performance benchmarking.
Quick Start
# Install (macOS via Homebrew; see Getting Started for other platforms)
brew install aerospike/tools/aerolab
# Configure backend (Docker)
aerolab config backend -t docker
# Create a cluster
aerolab cluster create -n mycluster -c 3
# List clusters
aerolab cluster list
Want AWS or GCP instead of Docker? Both need extra setup (credentials, and gotchas like private-only VPCs) — see Getting Started.
Documentation
- Getting Started - install, configure a backend, create your first cluster
- Commands Reference
- Cloud Configuration
- MCP Server for AI agents - Drive AeroLab from Claude, Cursor, Codex, etc. via
aerolab mcp - Migration Guide - Upgrading from AeroLab 7.x to 8.x
Migration from v7.x
If upgrading from AeroLab 7.x, see the Migration Guide for details on migrating your configuration and inventory.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
agi
Package agi provides shared constants and utilities for the Aerospike Grafana Integration.
|
Package agi provides shared constants and utilities for the Aerospike Grafana Integration. |
|
agi/db
Package db is an embedded, single-node, fast on-disk database tailored to the AGI ingest + plugin workload.
|
Package db is an embedded, single-node, fast on-disk database tailored to the AGI ingest + plugin workload. |
|
backend/backendtest
Package backendtest provides reusable test doubles for the backends package: a FakeBackend (implementing backends.Backend), a FakeCloud (implementing backends.Cloud), inventory fixture builders, and a helper for registering a fake Cloud in the global registry with automatic cleanup.
|
Package backendtest provides reusable test doubles for the backends package: a FakeBackend (implementing backends.Backend), a FakeCloud (implementing backends.Cloud), inventory fixture builders, and a helper for registering a fake Cloud in the global registry with automatic cleanup. |
|
backend/clouds/bgcp/iap
Package iap provides a thin adapter around github.com/cedws/iapc/iap that hides the third-party import behind aerolab-shaped types.
|
Package iap provides a thin adapter around github.com/cedws/iapc/iap that hides the third-party import behind aerolab-shaped types. |
|
backend/clouds/sshkey
Package sshkey manages the SSH key pair that a project's instances are created with.
|
Package sshkey manages the SSH key pair that a project's instances are created with. |
|
expiry
command
|
|
|
mcp
Package mcp implements the aerolab MCP (Model Context Protocol) server.
|
Package mcp implements the aerolab MCP (Model Context Protocol) server. |
|
utils/callerip
Package callerip resolves the source CIDRs which AeroLab-managed firewalls should allow inbound.
|
Package callerip resolves the source CIDRs which AeroLab-managed firewalls should allow inbound. |
|
utils/contextio
Package contextio provides io.Writer and io.Reader that stop accepting/providing data when an attached context is canceled.
|
Package contextio provides io.Writer and io.Reader that stop accepting/providing data when an attached context is canceled. |
|
utils/installers/aerospike/jfrog
Package jfrog implements an alternative download source for Aerospike server install artifacts hosted on a JFrog Artifactory instance.
|
Package jfrog implements an alternative download source for Aerospike server install artifacts hosted on a JFrog Artifactory instance. |
|
utils/installers/filebrowser
Package filebrowser provides installation scripts for filebrowser from GitHub releases.
|
Package filebrowser provides installation scripts for filebrowser from GitHub releases. |
|
utils/installers/ttyd
Package ttyd provides installation scripts for ttyd (web terminal) from GitHub releases.
|
Package ttyd provides installation scripts for ttyd (web terminal) from GitHub releases. |
|
utils/openbrowser
Package openbrowser provides cross-platform browser opening functionality.
|
Package openbrowser provides cross-platform browser opening functionality. |
|
utils/progress
Package progress provides thread-safe progress tracking for file transfers with support for multi-node parallel operations and TUI display.
|
Package progress provides thread-safe progress tracking for file transfers with support for multi-node parallel operations and TUI display. |
|
webui
Package webui provides the embedded web UI assets and HTTP handlers for serving the AeroLab Web UI.
|
Package webui provides the embedded web UI assets and HTTP handlers for serving the AeroLab Web UI. |
Click to show internal directories.
Click to hide internal directories.