dew 0.1.0 → 0.1.1

data/README.md

@@ -1,31 +1,65 @@
-Dew is a layer between the ground and fog, which is used to access the cloud.
+**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:
 
-## Installation
+  * 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**
 
-First install the dew gem
+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
 
-Then create all the config files it needs.
+### If you're an employee of PlayUp:
 
     $ git clone git@github.com:playup/dew-config.git ~/.dew
 
-or
+### 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.
 
-    $ mkdir -p ~/.dew/accounts
-    $ cat > ~/.dew/accounts/development.yaml
-    aws:
-      user_id: xxxx-xxxx-xxxx
-      access_key_id: YYYYYYYYYYYYYYYYYYYY
-      secret_access_key: ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+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:
 
-Then run the dew command
+    ~/.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 environments
 
 ## Creating a Simple Environment
 

data/bin/dew

@@ -7,6 +7,10 @@ class DewCommand < DewBaseCommand
   option ['-q', '--quiet'], :flag, "Quiet mode, disables logging", :default => false
   option ['-v', '--verbose'], :flag, "Verbose mode, print debug output", :default => false
   option '--debug', :flag, "Show stacktraces on error", :default => false
+  option '--version', :flag, "Prints the dew version" do
+    puts "dew version #{Dew::VERSION}"
+    exit(0)
+  end
 
   subcommand "environments", "perform subcommands on the environments", EnvironmentsCommand
   subcommand "amis", "perform subcommands on the AMIs", AMIsCommand

data/example/dew/accounts/development.yaml

@@ -0,0 +1,7 @@
+---
+name: development
+description: Default 'dew' account
+aws:
+  user_id: 0000-0000-0000
+  access_key_id: XXXXXXXXXXXX 
+  secret_access_key: XXXXXXXXXX

data/example/dew/profiles/template.yaml

@@ -0,0 +1,14 @@
+# Template Profile YAML.  Use this to create a new Profile.
+# 
+# ---
+# instances:
+#   amis:                           # List of AMI id's for regions you might like to create environments
+#     ap-southeast-1: ami-dcfc858e  # An AMI entry *must* appear here for the region you wish to create accounts within
+#   size: m1.large                  # Size of EC2 to create.  More info http://aws.amazon.com/ec2/instance-types
+#   count: 2                        # The number of Server(s) to create
+#   keypair: devops                 # Amazon keypair to deploy onto new Server(s).  More info http://docs.amazonwebservices.com/AWSEC2/latest/UserGuide/index.html?generating-a-keypair.html
+# elb:                              # Optional Load Balancer section. More info http://aws.amazon.com/elasticloadbalancing
+#   listener_ports:                 # List of ports to 'balance' onto Server(s)
+#     - 80
+# rds:                              # Optional Database section
+#   size: db.m1.small               # Size of Database to create.  More info http://aws.amazon.com/rds

data/example/dew/profiles/test-full.yaml

@@ -0,0 +1,15 @@
+---
+instances:
+  amis:                           # http://uec-images.ubuntu.com/releases/10.10/release
+    ap-southeast-1: ami-0c423c5e  # https://console.aws.amazon.com/ec2/home?region=ap-southeast-1#launchAmi=ami-0c423c5e
+    eu-west-1: ami-fb9ca98f       # https://console.aws.amazon.com/ec2/home?region=eu-west-1#launchAmi=ami-fb9ca98f
+    us-west-1: ami-ad7e2ee8       # https://console.aws.amazon.com/ec2/home?region=us-west-1#launchAmi=ami-ad7e2ee8
+  size: c1.medium
+  count: 2
+  security-group: default
+  keypair: devops 
+elb:
+  listener_ports:
+    - 80
+rds:
+  size: db.m1.small

data/example/dew/profiles/test-light.yaml

@@ -0,0 +1,32 @@
+---
+instances:
+  # An AMI is an image file used as a template to create an instance.
+  #
+  # AMIs aren't shared between regions. You'll need to specify an AMI for each
+  # region you want to create your environment in. AMIs can be created
+  # with the script/ami.rb create command.
+  #
+  # These AMIs, however, are 32-bit Ubuntu 10.10 images from Canonical.
+  # See: http://uec-images.ubuntu.com/releases/10.10/release
+  amis:
+    ap-southeast-1: ami-0c423c5e
+    eu-west-1: ami-fb9ca98f
+    us-west-1: ami-ad7e2ee8
+
+  # Each instance is created with particular size. The size determines
+  # the architecture, CPU and RAM available to the instance.
+  #
+  # m1.small is a 32-bit, dual core instance with 1.7gb of RAM.
+  size: m1.small
+
+  # Create two instances
+  count: 2
+
+  #security-groups:
+  #  - default
+
+  keypair: devops
+
+elb:
+  listener_ports:
+    - 80

data/lib/dew.rb

@@ -1,4 +1,6 @@
 require 'inform'
+require 'highline/import'
+require 'dew/version'
 require 'dew/commands'
 require 'dew/models'
 require 'dew/controllers'

data/lib/dew/models/profile.rb

@@ -27,11 +27,11 @@ class Profile
     end
     profile
   end
-  
+
   def has_elb?
     elb_listener_ports != nil
   end
-  
+
   def has_rds?
     rds_size != nil
   end
@@ -42,17 +42,21 @@ class Profile
     # :rds_size, :elb_listener_ports
   end
 
-  def to_s
-    db_instance_str = "%{memory} memory, %{processor} processor, %{platform} platform, %{io_performance} I/O performance"
+  def self.size_to_s(size)
     #instance_str = "%{memory} memory, %{processor} processor, %{storage} storage, %{platform} platform, %{io_performance} I/O performance"
     instance_str = "%{memory} GB memory, %{processor} ECUs processor, %{storage} GB storage, %{platform}-bit platform, %{io_performance} I/O performance"
     flavor = Cloud.compute.flavors.detect { |f| f.id == size }
     instance_hash = { :memory => flavor.ram.to_s, :processor => flavor.cores.to_s, :storage => flavor.disk.to_s, :platform => flavor.bits.to_s, :io_performance => '??' }
+    instance_hash.inject(instance_str) { |res,(k,v)| res.gsub(/%\{#{k}\}/, v) }
+  end
+
+  def to_s
+    db_instance_str = "%{memory} memory, %{processor} processor, %{platform} platform, %{io_performance} I/O performance"
     table { |t|
-      t << [ "#{count} instance#{'s' if count > 1}", "#{size.inspect} (#{instance_str % instance_hash })"]
+      t << [ "#{count} instance#{'s' if count > 1}", "#{size.inspect} (#{self.class.size_to_s(size)})"]
       t << ['disk image', ami.inspect]
       t << ['load balancer', "listener ports: #{elb_listener_ports.inspect}"] if has_elb?
-      t << ['database', "#{rds_size.inspect} (#{db_instance_str % AWS_RESOURCES['db_instance_types'][rds_size]})"] if has_rds?
+      t << ['database', "#{rds_size.inspect} (#{AWS_RESOURCES['db_instance_types'][rds_size].inject(db_instance_str) { |res,(k,v)| res.gsub(/%\{#{k}\}/, v) } })"] if has_rds?
       t << ['security groups', security_groups.inspect]
       t << ['keypair', keypair.inspect]
     }.to_s

data/lib/dew/version.rb

@@ -1,3 +1,3 @@
 module Dew
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: dew
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - PlayUp Devops
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +10:00
+date: 2011-06-22 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -204,6 +204,10 @@ files:
 - lib/dew.rb
 - README.md
 - LICENSE
+- example/dew/profiles/test-full.yaml
+- example/dew/profiles/template.yaml
+- example/dew/profiles/test-light.yaml
+- example/dew/accounts/development.yaml
 - Rakefile
 - spec/dew/controllers/deploy_controller_spec.rb
 - spec/dew/controllers/amis_controller_spec.rb