AeroLab is a tool that creates Aerospike development and testing clusters in Docker or on AWS, streamlining efforts to test cluster configuration options, upgrade procedures, and client applications in a controlled development environment.
NOTE: AeroLab is intended for local development and testing environments. It is not recommended for production operations.
See this document on upgrading from versions 6.0- to 6.1+
NOTE: AeroLab 7.0.0 implements an instance expiry system. By default your instances will terminate after 30 hours. To modify this behaviour, create clusters with --aws-expires TIME or --gcp-expires. For example --aws-expires 50h. To disable expiry, set to 0.
The releases page contains links to current installer packages for all the supported backends.
| Operating System | Package | Notes |
|---|---|---|
| macOS | aerolab-macos-* |
Native macOS binary, compiled for x86_64 and M series ARM chips |
| Linux | aerolab-linux-* |
Native package for Linux (all x86_64 and ARM64 distros) |
| Windows | aerolab-windows-* |
Native Windows executable. Unzip and run from explorer to install. |
See this document for manually building AeroLab (not recommended).
- Docker Native and Docker Desktop
- on macOS
- on Linux
- on Windows
- Podman Desktop
- Install Podman Desktop
- Enable Docker Compatibility mode in Podman Desktop
- Use
dockerbackend in aerolab:aerolab config backend -t docker - Install full official
docker-cli- Example MacOS:
brew install docker - Example Ubuntu: follow the official documentation, but instead of installing the full docker engine, just install
docker-ce-clipackage
- Example MacOS:
- Podman Native on Linux
- Follow podman documentation to install podman.
- To install the full docker cli tool, follow the official documentation, but instead of installing the full docker engine, just install
docker-ce-clipackage. - Enable podman service with:
sudo systemctl enable --now podman.service podman.socket && sudo touch /etc/containers/nodocker. - Enable the docker repositories:
sudo vi /etc/containers/registries.confand ensure docker is listed on this line:unqualified-search-registries = ["docker.io","localhost"]. - Use
dockerbackend in aerolab
- AWS
- GCP
Containers on Docker Desktop cannot be accessed directly by their IPs. For this purpose, AeroLab will automatically attempt to map host ports to container ports.
The containers can then be accessed using IP 127.0.0.1 and the port shown under aerolab inventory list. Aerospike clusters created using this method can be seeded and connected to directly from the desktop computer, using the services-alternate option in either Aerospike tools or in the client libraries.
To disable this functionality and prevent AeroLab from modifying Aerospike configuration files to that effect, create clusters with the --no-autoexpose switch.
An alternative method of access exists on MacOS and Linux, if using --no-autoexpose. See the tunnel container setup instructions for more information about setting up tunneling for direct container access.
- Getting started
- Help commands
- GCP
- AWS
- Docker Multiarch
- Usage examples
- AWS EKS Kubernetes
- DirEnv - different aerolab configuration per directory
- AGI - graphing aerospike statistics from logs
- Deploying clients
- REST API
- Utility scripts
- Volume usage examples
- WebUI Hosted Mode
- Ansible dynamic inventory with aerolab
See https://github.com/aerospike/aerolab/tree/master/CHANGELOG/ for version changes
See VERSION.md for latest stable version number
Aerolab list commands by default use neutral coloring to compress and present the listing tables of all items. Coloring can be disabled by exporting one of these environment variables:
export NO_COLOR=1export CLICOLOR=0
The following methods work:
- just for this command:
CLICOLOR=0 aerolab cluster list - for this terminal session:
export CLICOLOR=0 - forever: add one of the
exportcommands from above your your.zshrcor.bashrcfile
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}
