README
¶
SuitcaseCTL
Package and inventory your data, then send it to the cloud!
Overview
SuitcaseCTL is a tool for packaging up research data in a standardized format (tar, tar.gz) with the following additional features:
- Optional GPG encryption, either on the archive itself, or the files within the archive
- Splitting a single directory in to multiple tar files (known as Suitcases). This allows for smaller files to be transported to the cloud, and allows for faster archive creation since the multiple archives are created in parallel
- Inventory file which contains hashes and locations of all files in the archives, along with optional metadata
- CLI metadata file that contains the options the archive was created with
Get Suitcasectl
QuickStart
$ suitcasectl create suitcase $YOUR_DATA --destination=/srv/cold-storage/ --max-suitcase-size=50G
...
Documentation
Check out the Official SuitcaseCTL Documentation!
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
suitcasectl
Packaged main defines the top level CLI module
|
Packaged main defines the top level CLI module |
|
suitcasectl/cmd
Package cmd is the command line utility
|
Package cmd is the command line utility |
|
Package porter is the superset of things that can operate the suitcases and such
|
Package porter is the superset of things that can operate the suitcases and such |
|
config
Package config holds configuration options for suitcases
|
Package config holds configuration options for suitcases |
|
gpg
Package gpg provides encrypted files
|
Package gpg provides encrypted files |
|
inventory
Package inventory provides the needed pieces to correctly create an Inventory of a directory
|
Package inventory provides the needed pieces to correctly create an Inventory of a directory |
|
plugins/transporters
Package transporters define how transport plugins behave
|
Package transporters define how transport plugins behave |
|
plugins/transporters/cloud
Package cloud defines how to transport the files out to the cloud ☁️
|
Package cloud defines how to transport the files out to the cloud ☁️ |
|
plugins/transporters/shell
Package shell is a shell transporter plugin
|
Package shell is a shell transporter plugin |
|
rclone
Package rclone contains all the rclone operations
|
Package rclone contains all the rclone operations |
|
suitcase
Package suitcase holds all the stuff necessary for a suitecase generation
|
Package suitcase holds all the stuff necessary for a suitecase generation |
|
suitcase/tar
Package tar provides simple tar suitcases
|
Package tar provides simple tar suitcases |
|
suitcase/tarbz2
Package tarbz2 creates tar.bz2 files
|
Package tarbz2 creates tar.bz2 files |
|
suitcase/targpg
Package targpg works the tar.gpg suitcases
|
Package targpg works the tar.gpg suitcases |
|
suitcase/targz
Package targz creates tar.gz files
|
Package targz creates tar.gz files |
|
suitcase/targzgpg
Package targzgpg provides gpg encrypted tar.gz suitcases
|
Package targzgpg provides gpg encrypted tar.gz suitcases |
|
suitcase/tarzstd
Package tarzstd creates tar.zst files
|
Package tarzstd creates tar.zst files |
|
suitcase/tarzstdgpg
Package tarzstgpg provides gpg encrypted tar.zst suitcases
|
Package tarzstgpg provides gpg encrypted tar.zst suitcases |
|
travelagent
Package travelagent gets the suitcases to their final destination
|
Package travelagent gets the suitcases to their final destination |
Click to show internal directories.
Click to hide internal directories.