Install Aerospike Backup Control (absctl)

This page describes how to install Aerospike Backup Control (absctl) and run from a container for testing or production.

Aerospike Backup Control is the command-line tool for on-demand Aerospike backup and restore operations. Use absctl backup to create backup files and absctl restore to restore or validate those backups.

To try a guided end-to-end example, see the quickstart.

Choose an installation method

Select a method based on your environment and whether you require a managed, containerized, or custom build:

• Pre-built downloads for a standard local installation
• Docker to run absctl without installing the tool on your host
• Build from source if you need a development build or want to modify the tool for your use case

Pre-built downloads

Download pre-built release files from GitHub Releases. Select your platform and architecture:

Linux x86_64

# Download
wget https://github.com/aerospike/absctl/releases/download/v1.0.0-1/absctl-1.0.0-1.x86_64.rpm

# Install (RHEL/CentOS/Fedora)
sudo rpm -i absctl-1.0.0-1-1.x86_64.rpm

Linux aarch64

# Download
wget https://github.com/aerospike/absctl/releases/download/v1.0.0-1/absctl-1.0.0-1.aarch64.rpm

# Install (RHEL/CentOS/Fedora)
sudo rpm -i absctl-1.0.0-1-1.aarch64.rpm

macOS arm64

# Download
curl -LO https://github.com/aerospike/absctl/releases/download/v1.0.0-1/absctl-1.0.0-1-Darwin-arm64.tar.gz

# Extract
tar -xzvf absctl-1.0.0-1-Darwin-arm64.tar.gz

# Make executable and move to PATH
chmod +x absctl
sudo mv absctl /usr/local/bin/

macOS x86_64

# Download
curl -LO https://github.com/aerospike/absctl/releases/download/v1.0.0-1/absctl-1.0.0-1-Darwin-x86_64.tar.gz

# Extract
tar -xzvf absctl-1.0.0-1-Darwin-x86_64.tar.gz

# Make executable and move to PATH
chmod +x absctl
sudo mv absctl /usr/local/bin/

Docker

Run absctl from a Docker container without installing locally.

docker run -it --rm \
-v ./data:/data/backup \
aerospike.jfrog.io/ecosystem-container-preview-public-local/absctl:v1.0.0-1 \
absctl --help

See the quickstart for a complete Docker example.

Build from source

Build absctl from source when you need custom modifications or the latest development version.

1. Clone the absctl GitHub repository.

   git clone https://github.com/aerospike/absctl.git

2. Navigate to the repository root.

   cd absctl

3. Build absctl.

   make build

4. Optionally, build .rpm and .deb packages for supported Linux architectures (linux/amd64, linux/arm64).

   make packages

   The generated packages and their sha256 checksum files appear in the /target directory.

To verify that absctl is available after installation, run:

absctl --help

Get started

• Follow the absctl quickstart to test out the tools.
• For backup instructions, see Backup (absctl backup).
• For restore instructions, see Restore (absctl restore).
• For Secret Agent integration, see Secret usage with backup and restore.