Rockpool

Scheduled docker volume backups to S3

installation

npm install -g rockpool

usage

1. start

Rockpool is built on pm2. The first thing you will need to do is start the rockpool service.

rockpool start

2. configure

For Rockpool to upload to s3, you'll need to configure your AWS credentials

input

rockpool configure -A [access key id] -S [secret access key]

Notes:

• You can also use --access, --secret.

3. add

Once you are configured for uploads you can add an export schedule

input

rockpool add "[cron scheme]" [volume name] [export name] [bucket]

output

-
  name:   [export name]
  volume: [volume name]
  cron:   [cron scheme]
-
  name:   [previously added export name]
  volume: [previously added volume name]
  cron:   [previously added cron scheme]

Notes:

• The cron scheme needs to be wrapped in quotes.
• You can find the volume name with docker volume ls
• The [export name] will be the base for the exported file (with a timestamp)
• The output will be the entire list of current schedules
• Schedules are stored in memory and will have to be readded if the service stops

4. remove

You can remove schedules that have been added.

input

rockpool remove [export name]

output

-
  name:   [previously added export name]
  volume: [previously added volume name]
  cron:   [previously added cron scheme]

5. ls

You can use ls if you need to inspect current schedules

input

rockpool ls

output

-
  name:   [previously added export name]
  volume: [previously added volume name]
  cron:   [previously added cron scheme]

6. stop

Rockpool can be stopped when no longer needed

rockpool stop

Notes:

• You will lose schedules and configuration settings when stopping rockpool

Logging

Rockpool generates logs via pm2. I haven't yet set up a rockpool command to display these, however you can access them via pm2 logs rockpool

PM2

Rockpool will requires pm2 and will install it. Rockpool always runs as rockpool and can be interfaced with via pm2. The pm2 docs can be found here