https://github.com/playup/dew

an environment management tool intended for use in multi-instance AWS application deployments.
https://github.com/playup/dew

Last synced: 3 months ago
JSON representation

an environment management tool intended for use in multi-instance AWS application deployments.

• Host: GitHub
• URL: https://github.com/playup/dew
• Owner: playup
• License: mit
• Created: 2011-06-20T05:40:08.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2022-11-30T21:48:29.000Z (almost 2 years ago)
• Last Synced: 2024-07-27T18:57:09.419Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 133 KB
• Stars: 12
• Watchers: 37
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**Dew** is an environment management tool intended for use in multi-instance AWS application deployments.

It's called **dew** as it's a layer under [Fog](http://fog.io) which in turn is a layer under various cloud platforms.

It includes:

  * one command `dew`, with subcommands eg. `environments`, `amis`

  

These subcommands can:

  * create and destroy **environments**, a collection of AWS instances, a load balancer and a database

  * create and destroy **amis**, machine images used to create instances in your environments

  * configure your **amis** with [Puppet](http://www.puppetlabs.com)

  * deploy MRI Passenger and JRuby Tomcat applications to your **environments**

This code is Open Source, but some of it is still specific to PlayUp. Running `cucumber` with a correctly configured `development.yaml` will drain whichever credit card you've attached to that account!

## Getting Started

    $ [sudo] gem install dew

### If you're an employee of PlayUp:

    $ git clone [email protected]:playup/dew-config.git ~/.dew

### Otherwise:

#### 1. Copy over the example configuration and edit the default account file

    $ cp -r `gem which dew | dirname`/../../example/dew ~/.dew

    $ vi ~/.dew/accounts/development.yaml

    

Replace the `user_id`, `access_key_id` and `secret_access_key` with your AWS credentials.

#### 2. Install your keypair

Either pick an existing keypair or create a new one. You'll need to do this once for each account and region you intend to operate in.

Place the `.pem` file in the following location:

    ~/.dew/accounts/keys/$ACCOUNT/$REGION/$KEYPAIRNAME.pem

    

For example, the `.pem` file for the `default` key in `development` account and in the `ap-southeast-1` region would go in:

    ~/.dew/accounts/keys/development/ap-southeast-1/default.pem

Don't worry about setting permissions for the key - **dew** will manage that itself.

#### 3. Configure your security groups

**dew** makes a couple of assumptions about how you've set up your security groups. Unfortunately, **dew** doesn't yet possess the capability to manage this for you:

  * it expects that the `default` security group allows for SSH from the host you're creating the environment from

  * it expects that the `default` security group in your RDS configuration allows connections from your AWS account's instances

### Finally:

    $ dew --help

    

And perform a basic self-test:

    $ dew env

## Creating a Simple Environment

Assuming that you've created (or downloaded) your `~/.dew` directory, you should be ready to create a simple environment.

First, take a look at `~/.dew/profiles/test-light.yaml`. `test-light` is the profile we'll be using to create our environment. You'll see that it contains:

  * AMIs for each region

  * two instances, using the 'default' keypair and the 'default' security group

  * an elastic load balancer (elb) with a listener on port 80

  

If your keypair isn't called 'default', you'll need to edit this file and change it.

Now, run:

    dew -v env create test-light my-first-environment

    

You'll be shown a summary of the environment that you're about to create. Type 'y' to confirm its creation and watch as it's created.

Once complete you can run the following commands to interact with your environment:

    dew env ssh my-first-environment

    dew env show my-first-environment

    dew env destroy my-first-environment

## Creating an AMI for a new Environment

## Deploying to an Environment

## Developing with Dew

Read `HACKING.md`