Name: cassandra_snapshotter
Owner: Kik Interactive
Description: A tool to backup cassandra nodes using snapshots and incremental backups on S3
Created: 2015-06-03 14:16:18.0
Updated: 2016-07-20 20:17:58.0
Pushed: 2017-08-22 15:19:33.0
Homepage: null
Size: 149
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
A tool to backup cassandra nodes using snapshots and incremental backups on S3
The scope of this project is to make it easier to backup a cluster to S3 and to combine snapshots and incremental backups.
Both the machine that runs the backup and the Cassandra nodes need to install the tool
t clone https://github.com/kikinteractive/cassandra_snapshotter.git
cassandra_snapshotter
do pip install -e ./
Nodes in the cluster also need to have lzop installed so that backups on S3 can be archived compressed
You can install it on Debian/Ubuntu via apt-get
do yum install lzop
Make sure you have JNA enabled and (if you want to use them) that incremental backups are enabled in your cassandra config file.
You can see the list of parameters available via cassandra-snapshotter --help
ssandra-snapshotter --aws-access-key-id=X --aws-secret-access-key=Y --s3-bucket-name=Z --s3-base-path="mycluster-backup" --s3-ssenc --hosts=h1,h2,h3,h4 --user=cassandra
`--s3-ssenc`ssandra-snapshotter --aws-access-key-id=X --aws-secret-access-key=Y --s3-bucket-name=Z --s3-base-path=mycluster list
ssandra-snapshotter --aws-access-key-id=X --aws-secret-access-key=Y --s3-bucket-name=Z --s3-base-path='mycluster' restore --keyspace=K --hosts=hostA --target-hosts=hostB
cassandra_snapshotter connects to your cassandra nodes using ssh and uses nodetool to generate the backups for keyspaces / table you want to backup.
Backups are stored on S3 using this convention:
/s3_base_path/snapshot_creation_time/hostname/cassandra/data/path/keyspace/table/snapshots
/s3_base_path/snapshot_creation_time/hostname/cassandra/data/path/keyspace/table/backups
This parameter is used to make it possible to use for a single S3 bucket to store multiple cassandra backups.
This parameter can be also seen as a backup profile identifier; the snapshotter uses the s3_base_path to search for existing snapshots on your S3 bucket.
Incremental backups are created only when a snapshot already exists, incremental backups are stored in their parent snapshot path.
incremental_backups are only used when all this conditions are met:
if one of this condition is not met a new snapshot will be created.
In order to take advantage of incremental backups you need to configure your cassandra cluster for it (see cassandra.yaml config file).
NOTE: Incremental backups are not enabled by default on cassandra.
If you dont want to use incremental backups, or if for some reason you want to create a new snapshot for your data, run the cassandra_snapshotter with the --new-snapshot argument.
Its not in the scope of this project to clean up your S3 buckets.
S3 Lifecycle rules allows you do drop or archive to Glacier object stored based on their age.
cassandra_snaphotter tries to store data and metadata in a way to make restores less painful; There is not (yet) a feature complete restore command; every patch / pull request about this is more than welcome (hint hint).
In case you need, cassandra_snapshotter stores the ring token description every time a backup is done ( you can find it the ring file in the snapshot base path )
The way data is stored on S3 should makes it really easy to use the Node Restart Method (http://www.datastax.com/documentation/cassandra/2.0/webhelp/index.html#cassandra/operations/ops_backup_snapshot_restore_t.html#task_ds_cmf_11r_gk)
