Project

s3twin

0.0
No commit activity in last 3 years
No release in over 3 years
Mirror a S3 Bucket via command line, with support for remote workers (and scheduling).
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 0.9
>= 0

Runtime

~> 1.19
~> 0.9
~> 0.18
 Project Readme

S3 Twin

Take a mirror of a S3 bucket. It leverages aws-sdk's copy_to function to do the heavy lifting at Amazon, similar to s3cmd.
Supports local usage or remote workers some of which may support scheduling - to keep a bucket's twin up to date.

One way copy only i.e. will not keep two buckets in sync.
Carries across Public ACLs only; there is no support for S3 features like server side encryption.

If an object exists in the source bucket and does not exist in the destiantion bucket then the object is copied.
If an object exists in both buckets and the etags are identical the object is not copied, if the etags do not match the object is copied.
Does not remove objects from the destination bucket that have been deleted from the source bucket.

Please note; while this works it's the first release so the API may change drastically.

Installation

$ gem install s3twin

Usage

$ s3twin help
$ s3twin go # run twin now locally

Configuration

$ s3twin init # initialise a .env file

The configuration payload can be set via an argument --payload=key:value key2:value2 or .env file.
If neither of those are present the user will be prompted for input.

Example with payload:

$ s3twin go --payload=source_s3_bucket:bar source_aws_access_key_id:foo source_aws_secret_access_key:world destination_s3_bucket:bar destination_aws_access_key_id:foo destination_aws_secret_access_key:world

Remote Workers

Currently only iron.io IronWorker tasks (including scheduled) are supported.

IronWorker Usage

Create a new project at https://hud.iron.io, collect your Iron Token and Project ID.

$ s3twin ironworker help
$ s3twin ironworker upload # upload worker code
$ s3twin ironworker go # run worker once now
$ s3twin ironworker schedule --time # schedule worker for the future

Configure --payload=iron_token:foo iron_project_id:bar

Optionally create, or append, your .env file:

IRON_TOKEN='foo'
IRON_PROJECT_ID='bar'

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request