Skip to content
This repository has been archived by the owner on Jan 20, 2021. It is now read-only.

Latest commit

 

History

History
154 lines (109 loc) · 3.99 KB

README.md

File metadata and controls

154 lines (109 loc) · 3.99 KB
Raw

Consider using Data Lifecycle Manager or Backup.

amirotate

日本語

Lambda functions to backup and rotate images of EC2 instance.

Prerequisite

Usage

Set AWS credentials and region

Set environment variable AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION.

direnv is very useful for this.

Instead of setting AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, you can write your credentials on ~/.aws/credentials (and set AWS_PROFILE if it's not [default]).

Deploy Lambda Functions

Clone repo.

$ git clone https://github.com/y13i/amirotate.git

Install dependencies.

$ cd amirotate

$ yarn
# or
$ npm install

Deploy.

$ yarn run deploy
# or
$ npm run deploy

By default, the functions will be scheduled to be invoked daily at 0:00 UTC (create) and 1:00 UTC (delete).

If you want to change the schedule, edit cron(0 0 ? * * *) in serverless.yml. See Serverless Framework - AWS Lambda Events - Scheduled & Recurring.

Tag instances

Create a tag for the EC2 instances you want to backup like below.

Key Value
amirotate:default (JSON string)

JSON string represents the option of amirotate for the instance. The structure is...

{
  "NoReboot": (true | false), // Boolean. Optional. If true, CreateImage API will called with `NoReboot` option.

  "Retention": { // Required. This option specifies retention policy for the image.
    "Count": 1, // Numeric. Optional. If present, specified number of newest images will retained.
    "Period": 180000000 // Numeric. Optional. Unit is in milliseconds. If present, the image will retained in specified time period after creation.
  }
}

The value must be valid JSON. Example below (No reboot, retain 3 images):

{"NoReboot": true, "Retention": {"Count": 3}}

If you want to change the key of the tag from amirotate:default, simply edit provider.environment.tagKey in format of amirotate:<your alternate name here> in serverless.yml.

Configuring multiple cycles of backup

You can set multiple cycles by settting multiple schedule on functions.<create|delete>.events in serverless.yml. In that case, you must override tagKey value also.

For example...

functions:
  create:
    handler: lambda/create.default
    events:
    - schedule:
        rate: cron(0 0 ? * * *)
        input:
          tagKey: amirotate:daily
    - schedule:
        rate: cron(0 1 ? * SUN *)
        input:
          tagKey: amirotate:weekly
  delete:
    handler: lambda/delete.default
    events:
    - schedule:
        rate: cron(0 2 ? * * *)
        input:
          tagKey: amirotate:daily
    - schedule:
        rate: cron(0 3 ? * SUN *)
        input:
          tagKey: amirotate:weekly

Invoke functions manually

$ yarn run create
# or
$ npm run create
$ yarn run delete
# or
$ npm run delete

If you want to override tagKey with manual invocation,

$ echo '{"tagKey": "amirotate:daily"}' | yarn run create
# or
$ echo '{"tagKey": "amirotate:daily"}' | npm run create

Remove functions

$ yarn run remove
# or
$ npm run remove

See also

History