Skip to content

ykyr/enhanced-snapshots

 
 

Repository files navigation

Enhanced Snapshots

Enhanced Snapshots Logo

Table of contents

Product Description

Enhanced Snapshots, from Sungard Availability Services | Labs, manages EBS snapshots and performs data deduplication to S3 for greater cost savings. The product will be useful for AWS users who want to :

  • Reduce the cost of storing snapshots
  • Reduce the time IT engineers spend on routine snapshot management tasks
  • Schedule recurring snapshots

Deduplication is run across all enabled snapshots in a region, which decreases the amount of total data stored. Furthermore, deduplicated blocks are stored in S3 at a much lower cost than AWS’ standard EBS snapshots. This tool provides users with a great way to pay less for long-term retention of snapshot based data in AWS.

Using an intuitive interface, users can easily automate routine tasks like the creation of snapshots and the deletion of old backups. Since these tasks are automated, risks associated with human error are minimized.

Technical support is not available for the first version of the product; however, please create a Github issue if you have any comments or suggestions. Customer support service may be added in a future release.

Enhanced Snapshots is open sourced and licensed under Apache v 2.0. Use of Enhanced Snapshots software is free and you only pay for the underlying infrastructure required to support it.

This tool will be available by launching the AMI from the enhanced snapshots market place by choosing the "Enhanced Snapshots tool creation stack" option or by creating a role like es-admin-role while using the single AMI option. Cloud formation template mentioned in the Quick start section can be used to create the es-admin role. Similarly the EC2 instance created and the associated resources can be removed by using the "Uninstall" button under for the Settings tab, however this will not remove the customer from the AWS subscription for the SungardAS provided marketplace products. Refer to the Removing the enhanced snapshots system for more details.

Key Features

Backup & Recovery

  • Performing backups of EBS volumes.
  • The ability to perform recovery from historical backups.
  • The ability to store backups of deleted volumes.
  • Ability to quickly initiate recovery of backups.

Schedule Policy

  • Allows user to create scheduled tasks by minute, hour, day, week and month.
  • Full support of CRON expressions.

Retention Policy

  • Allows user to automatically delete older backups based on the original volume’s size, count or age.
  • A user can cancel any task before it is moved to the running state.

Management

  • The ability to assign different (two) roles for users.
  • Simple and intuitive wizard for initial setup process.

Limitations

  • No support for management of volumes using OS level RAID
  • EBS volumes using EBS encryption must be pre-warmed to avoid significant storage overhead

Quick start

  • If the "Enhanced Snapshots tool creation stack" is used in marketplace , the es-admin role will be automatically created. But for the single AMI option from the market place Create a es-admin role using the cloud formation template as prerequisite es-admin-role To launch a CloudFormation stack based on the template, first decide which region you will deploy in. In that region you will need the following information:
  • An EC2 keypair
  • A VPC id (Not needed if you are using the Simple Stack option below.)
  • An IP prefix from which inbound http/https/ssh connections will be allowed. If you're not sure, use your current public IP address with "/32" tacked on the end (like "1.2.3.4/32").

Note When creating the CloudFormation stack, on the Review page, make sure to check the box at the bottom of the page in the Capabilities section.

Capabilities_checkbox

Once you have collected that information, find your target region, note the AMI ID for that region, and click the corresponding Launch Stack link.

Region AMI ID Simple Stack (default VPC) VPC Stack (your VPC)
us-east-1 ami-fd838b97 Launch Stack Launch Stack
us-west-1 ami-b0b5c8d0 Launch Stack Launch Stack
us-west-2 ami-e0fc1680 Launch Stack Launch Stack
eu-west-1 ami-75a32506 Launch Stack Launch Stack
sa-east-1 ami-0a2fa366 Launch Stack Launch Stack
eu-central-1 ami-7148ae1e Launch Stack Launch Stack
ap-southeast-1 ami-0c2ce66f Launch Stack Launch Stack
ap-southeast-2 ami-ff01229c Launch Stack Launch Stack
ap-norhteast-1 ami-e7aabd89 Launch Stack Launch Stack

Once the CloudFormation stack has finished building, go to its Outputs tab at the bottom of the AWS Console. Copy the instance ID (you will need it in a later step) and click the URL, then proceed to Getting Started.

User also should to:

  • Select minimum m3.large instance and minimum 8 GB size for volume
  • Select es_admin role while launching instance to get acsess to CloudWatch

Role

Getting Started

Note If you have not followed the Quick start section above, then you will first need to manually create an IAM role and then create an EC2 instance using the Enhanced Snapshots AMI, which can be found in the first table above.

Note By default a new instance has a self-signed SSL certificate, so you will need to bypass your browser's security warning to start.

Step 1

For the first login please use the following credentials:

  • Login: admin@enhancedsnapshots
  • Password: Your AWS EC2 Instance ID (available on the AWS console) Login

Step 2

The next picture shows the list of additional resources that will be created: S3 bucket, SDFS settings and DynamoDB tables. To view more information these resource the user can click the question mark. Settings(2)

Warning Once "Setup" has been clicked on this screen, these settings cannot be changed.

Step 3

Time to create a first user. The first user always will receive admin rights. Email is used as user ID. New user

Step 4

After the system is received all necessary input data it will create all necessary environment. Please wait

After the configurations process will be successfully completed, the following notification will appear. Congratulations

Step 5

The system automatically redirects the user to the login page. Now the user will use their credentials that were created in step 4.

Login

After logging in, the list of EBS volumes for the local region is displayed. Volumes

Management Tasks

Peforming Manual Backups

To perform a backup, the user selects the appropriate EBS volume and clicks the button Backup selected. Also, the user can configure multi-backup, or several volumes during one task. For this, a user selects several appropriate volumes and clicks the button Backup selected. (Backups are performed one at a time.) Volumes (backup selected)

Creating a Schedule

The user can automate the process of creating backups thanks to the Schedule feature. Schedules can be edited with Enhanced Snapshots web UI; schedules are displayed and stored in Cron format. The interval of backups is from one minute to one year. If necessary, schedules can be disabled.

New schedule

Users can also edit or delete existing schedules. Schedule menu

Managing Retention Policies

The retention policy function that allows the user to automatically delete backups according certain conditions: size limit, count limit days limit. Edit retention rule

Only one retention policy can be created for each volume. If a volume does not have any backups, the retention policy cannot be created.

Filters for users are available in order to sort according to different parameters: Volume ID, Name, Size, Instance ID and date of creation. Filter

Other Management Tasks

A list of all active and pending tasks can be found in the tab Tasks. The user can cancel any task before it starts running.

A list of all users is available in the Users tab. All information about users except their passwords is displayed. Users with admin rights can make changes to all users (even other administrators). A user without administrative rights can edit only their user profile. If there is only one administrator user, administrator rights cannot be revoked.

Removing the Enhanced Snapshots system

If you choose to remove Enhanced Snapshots, you can do so by clicking the Uninstall button on the Settings tab. Settings

The system will continue with the removal of all resources once you enter the EC2 Instance Id for the EC2 instance that Enhanced Snapshots is running on.

Delete

The following resources are deleted:

  • EC2 Instance
  • S3 bucket and all backup data
  • DynamoDB tables

Note Though the EC2 instance will be deleted it will not remove the subscription to the software product from AWS and for more details on this refer to https://aws.amazon.com/marketplace/help/200799470

Note It may take several minutes to delete all the resources, especially if backup data has been stored.

IAM role creation (optional)

If you are creating an instance from the AMI directly without using the provided CloudFormation template, you must first create an IAM role with the following policy as defined in this template. es-admin role cloud formation template Once the role is created, also create and save an API key, which will be needed to configure Enhanced Snapshots.

Without a properly configured role, the following error message will appear during configuration: DynamoDBAccessDenied

Logging

Application uses AWS CloudWatch as logs storage. Logs can be found in following location: Logs

License

See the LICENSE.md file for license rights and limitations (Apache 2).

Use of the provided AMIs is covered by a separate End User License Agreement.

Sungard Availability Services | Labs

This project is maintained by the Labs group at Sungard Availability Services

GitHub: https://sungardas.github.io

Blog: http://blog.sungardas.com/CTOLabs/

Packages

No packages published

Languages

  • Java 67.3%
  • JavaScript 14.1%
  • HTML 13.1%
  • CSS 4.5%
  • Shell 1.0%