Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 2.4 KB

README.rst

File metadata and controls

96 lines (58 loc) · 2.4 KB
Raw

Spare

One S3 backup, encrypted on the fly.

Description

This tool is used at Seantis to create backups stored on various S3 compatible services using a very limited subset of S3 commands.

This is what you need to know:

  • Spare should not be used in production yet! Use at your own risk.
  • Buckets should be managed by spare exclusively, other files are deleted!
  • Each hostname must have a separate bucket for each backed up path.
  • Spare stores exactly one copy of your data.
  • Files are compressed using LZMA and encrypted on the client using AES-SIV.
  • During upload, spare is limited to one core and less than 100MiB of memory.
  • Duplicated files are stored only once.
  • If you forget your password, you cannot restore your files.
  • Spare is meant to be used with configuration management, the cli is minimal.
  • Python 3.6.2+ is required.

Usage

To install spare:

pip install spare

To set the connection parameters:

export SPARE_ENDPOINT=host
export SPARE_ACCESS_KEY=access-key
export SPARE_SECRET_KEY=secret-key

To backup a folder:

spare create --password my-password --bucket my-bucket --path /my-path

To restore a backup:

spare restore --password my-password --bucket my-bucket --path /my-path

To verify the backup (downloads everything!):

spare verify --password my-password --bucket my-bucket --path /my-path

Locking

During a spare run, the bucket is locked, so other Spare instances know not to touch it. However, it's possible that a lock persists when Spare crashes.

If that happens, make sure that the host pushing the backup is truly not running any spare processes, then use the unlock command:

To unlock a backup (if locked)

spare unlock --password my-password --bucket my-bucket

If however, you would like to lock a backup to avoid anyone from changing it, run the following command:

spare lock --password my-password --bucket my-bucket

Run the Tests

Spare uses Minio <https://www.minio.io> to run tests against a real object storage server. As a result it can take a bit for the first test run to complete, as Minio is downloaded and stored in the pytest cache directory:

pip install -e '.[test]'
py.test

Build Status

Build Status

License

spare is released under the MIT license