aerolab

AeroLab

AeroLab is a tool that creates Aerospike development and testing clusters on Docker, AWS, or GCP, 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.

Upgrading

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.

Install using homebrew on MacOS or Linux

$ brew install aerospike/tools/aerolab

Releases

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.

Manual build

See this document for manually building AeroLab (not recommended).

Supported backends

• Docker Native and Docker Desktop
  • on macOS
  • on Linux
  • on Windows
• Podman Desktop
  • Install Podman Desktop
  • Enable Docker Compatibility mode in Podman Desktop
  • Use docker backend 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-cli package
• 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-cli package.
  • 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.conf and ensure docker is listed on this line: unqualified-search-registries = ["docker.io","localhost"].
  • Use docker backend in aerolab
• AWS
• GCP

Routing to the containers using Docker Desktop

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.

Documentation

• Getting started
• Help commands
• GCP
  • Spot instance support
  • Expiry system
  • Extra Volume Support
  • Partitioner
  • Advanced - GCP Firewall Rules
• AWS
  • Spot instance support
  • EFS Support
  • Expiry system
  • Partitioner
  • Advanced - AWS Firewall Rules
  • Advanced - Custom VPC
  • Advanced - Run without PublicIPs
• Docker Multiarch
• Usage examples
  • Basic
  • Advanced
  • Full Stack
• AWS EKS Kubernetes
• DirEnv - different aerolab configuration per directory
• AGI - graphing aerospike statistics from logs
• Deploying clients
  • Basic instance
  • Elastic Search
  • Rest Gateway
  • Trino
  • VSCode
  • Graph
  • Vector
  • AMS monitoring stack
  • Tools and Asbench
• REST API
• Utility scripts
• Volume usage examples
• WebUI Hosted Mode
• Ansible dynamic inventory with aerolab

Changelog

See https://github.com/aerospike/aerolab/tree/master/CHANGELOG/ for version changes

Version

See VERSION.md for latest stable version number

Disabling console colors

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=1
• export CLICOLOR=0

The following methods work:

1. just for this command: CLICOLOR=0 aerolab cluster list
2. for this terminal session: export CLICOLOR=0
3. forever: add one of the export commands from above your your .zshrc or .bashrc file

This site is open source. Improve this page.