https://github.com/aerospike/aerospike-backup-cli
CLI tools for Aerospike backup and restore
https://github.com/aerospike/aerospike-backup-cli
aerospike backup backup-restore backup-tools cli restore
Last synced: about 1 month ago
JSON representation
CLI tools for Aerospike backup and restore
- Host: GitHub
- URL: https://github.com/aerospike/aerospike-backup-cli
- Owner: aerospike
- License: apache-2.0
- Created: 2025-07-07T15:20:05.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-08-24T15:13:00.000Z (about 2 months ago)
- Last Synced: 2025-08-24T20:10:34.209Z (about 2 months ago)
- Topics: aerospike, backup, backup-restore, backup-tools, cli, restore
- Language: Go
- Homepage: https://pkg.go.dev/github.com/aerospike/aerospike-backup-cli
- Size: 19.7 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aerospike Backup CLI
[](https://github.com/aerospike/aerospike-backup-cli/actions/workflows/tests.yml/badge.svg)
[](https://pkg.go.dev/github.com/aerospike/aerospike-backup-cli)
[](https://codecov.io/gh/aerospike/aerospike-backup-cli)
The repository includes the [asbackup](cmd/asbackup) and [asrestore](cmd/asrestore) CLI tools,
built using [backup-go](https://github.com/aerospike/backup-go) library.
Refer to their respective README files for usage instructions.
Binaries for various platforms are released alongside the library and can be found under
[releases](https://github.com/aerospike/aerospike-backup-cli/releases).
## Core Features
### Standard Operations
- **Full backups**: Complete namespace or set backups
- **Incremental backups**: Time-based filtering for changed records
- **Parallel processing**: Configurable workers for optimal performance
- **Resume capability**: Continue interrupted backups from state files
### Advanced Filtering
- **Set-based**: Backup specific sets within namespaces
- **Bin filtering**: Include only specified bins
- **Time windows**: Records modified within date ranges
- **Partition filtering**: Backup specific partition ranges
- **Node/Rack targeting**: Geographic or hardware-specific backups
### Enterprise Features
- **Compression**: ZSTD compression for reduced storage
- **Encryption**: AES-128/256 encryption for data security
- **Cloud storage**: Direct backup to AWS S3, GCP Storage, Azure Blob
- **Secret management**: Integration with Aerospike Secret Agent
- **Rate limiting**: Bandwidth and RPS controls
## Quick Start
### Basic Backup
```bash
# Simple namespace backup
asbackup -h 127.0.0.1:3000 -n test -d /backup/test-namespace
```
### Basic Restore
```bash
# Restore from backup directory
asrestore -h 127.0.0.1:3000 -n test -d /backup/test-namespace
```
## Installation
### From Releases
Download pre-built binaries from [GitHub Releases](https://github.com/aerospike/aerospike-backup-cli/releases):
```bash
# Linux x64
wget https://github.com/aerospike/aerospike-backup-cli/releases/download//asrestore--.tar.gz
wget https://github.com/aerospike/aerospike-backup-cli/releases/download//asbackup--.tar.gz
# Extract
tar -xzvf asrestore--.tar.gz
tar -xzvf asbackup--.tar.gz
# Make executable
chmod +x asbackup asrestore
```
### Build from Source
```bash
# Build binaries
make build
# Install to /usr/bin
make install
# Uninstall
make uninstall
```
### Docker
Build and push a multi-platform Docker image:
```bash
DOCKER_USERNAME="" DOCKER_PASSWORD="" TAG="" make docker-buildx
```
Build a Docker image for local use:
```bash
TAG="" make docker-build
```
A single docker image, including both tools, will be created.
Usage example:
```bash
docker run --rm aerospike-backup-tools: asrestore --help
docker run --rm aerospike-backup-tools: asbackup --help
```
### Linux Packages
To generate `.rpm` and `.deb` packages for supported Linux architectures (`linux/amd64`, `linux/arm64`):
```bash
make packages
```
The generated packages and their `sha256` checksum files will be located in the `/target` directory.
## Configuration Reference
Please look at [asbackup](cmd/asbackup/readme.md) and [asrestore](cmd/asrestore/readme.md) readme files for details.
## License
Apache License, Version 2.0. See [LICENSE](LICENSE) file for details.
## Support
- **Documentation**: [Aerospike Documentation](https://aerospike.com/docs/tools/backup/)
- **Issues**: [GitHub Issues](https://github.com/aerospike/aerospike-backup-cli/issues)
- **Community**: [Aerospike Community Forum](https://discuss.aerospike.com/)