breeze 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,92 @@
 # breeze
 
 Breeze provides some [Thor](https://github.com/wycats/thor) tasks and example scripts for managing cloud computing resources
-on [Amazon's AWS cloud](http://aws.amazon.com/).
+and deployments on [Amazon's AWS cloud](http://aws.amazon.com/). It uses [fog](https://github.com/geemus/fog) for the hard
+work so it should be fairly easy to add support for other cloud computing providers that are supported by fog.
+
+Breeze implements zero downtime deployments by moving an elastic ip from one server to another. Db migrations have to be
+compatible with the previous version.
+
+## install
+
+    gem install breeze
+    cd your-project
+    breeze init
+
+Then edit Thorfile and the stuff that got copied to config/breeze.
+
+Management of configuration files is almost compatible with [rubber](https://github.com/wr0ngway/rubber)
+but breeze does not support roles and additives. See [the rubber wiki](https://github.com/wr0ngway/rubber/wiki/Configuration)
+for more information.
+
+## create a server image
+
+    thor server:image:create
+
+The default install.sh compiles ruby, passenger, nginx and image magick. It takes a long time
+(maybe half an hour on a small instance). It will prompt for the image name when completed.
+
+## use it
+
+    thor describe      # List all cloud resources that the current account can control with breeze
+    
+    thor staging:deploy    # Deploy a new version by replacing old servers with new ones
+    thor staging:disable   # Copy maintenance.html to public/system/ on active web servers
+    thor staging:enable    # Remove system/maintenance.html from active web servers
+    thor staging:rollback  # Rollback the previous deploy
+    thor staging:start     # Start web server and db for staging
+    thor staging:stop      # Stop staging and destroy server and db
+
+Define your staging and production in the Thorfile and the same tasks become available for both name spaces.
+These tasks call app tasks with fixed parameters.
+
+## plumbing commands
+
+    app
+    ---
+    thor app:deploy PUBLIC_SERVER_NAME DB_SERVER_NAME BRANCH      # Deploy a new version by replacing old servers with new ones
+    thor app:disable PUBLIC_SERVER_NAME                           # Upload system/maintenance.html to web servers
+    thor app:enable PUBLIC_SERVER_NAME                            # Remove system/maintenance.html from web servers
+    thor app:rollback PUBLIC_SERVER_NAME                          # Rollback a deploy
+    thor app:start PUBLIC_SERVER_NAME [DB_SERVER_NAME] [DB_NAME]  # Start a new app with web server and db
+    thor app:stop PUBLIC_SERVER_NAME                              # Destroy web server and db
+    
+    configuration
+    -------------
+    thor configuration:deploy_to_localhost  # Transform and deploy server configuration files to the local file system based on...
+    
+    db
+    --
+    thor db:clone OLD_DB NEW_DB           # Create a new db server using the latest backup of OLD_DB.
+    thor db:create SERVER_NAME [DB_NAME]  # Create a new database server
+    thor db:destroy NAME                  # Destroy a database server
+    
+    dns
+    ---
+    thor dns:record:create ZONE_ID NAME TYPE IP [TTL]  # Create a new DNS record
+    thor dns:record:destroy ZONE_ID NAME [TYPE]        # Destroy a DNS record
+    thor dns:zone:create DOMAIN                        # Create a new DNS zone
+    thor dns:zone:destroy ZONE_ID                      # Destroy a DNS zone
+    thor dns:zone:import ZONE_ID FILE                  # Creates dns records specified in FILE
+    
+    describe
+    --------
+    thor describe:addresses            # List allocated ip addresses
+    thor describe:cloud_resources      # List all cloud resources that the current account can control with breeze
+    thor describe:db_servers           # List database servers
+    thor describe:dns_records ZONE_ID  # List all DNS records for the given zone
+    thor describe:dns_zones            # Describe DNS zones
+    thor describe:images               # Describe machine images owned by Breeze::CONFIGURATION[:image_owner]
+    thor describe:servers              # Describe server instances
+    thor describe:volumes              # Describe block store volumes (EBS)
+    
+    server
+    ------
+    thor server:address:associate IP NEW_SERVER_ID  # Associate an existing IP with a new server
+    thor server:address:create SERVER_ID            # Create and associate a new elastic ip
+    thor server:address:release IP                  # Release the ip address
+    thor server:create                              # Launch a new server instance
+    thor server:destroy INSTANCE_ID                 # Terminate a running (or stopped) server instance
+    thor server:image:create                        # Launch a server with the base image, wait for it to boot, invoke...
+    thor server:tag:create SERVER_ID KEY VALUE      # Create or update a tag
+    thor server:tag:destroy SERVER_ID KEY           # Delete a tag

data/lib/breeze.rb

@@ -1,6 +1,6 @@
 module Breeze
 
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   autoload :Veur, 'breeze/veur'
 
 end

data/lib/breeze/tasks.rb

@@ -1,6 +1,6 @@
 require 'breeze'
 require 'breeze/tasks/configuration'
-require 'breeze/tasks/list'
+require 'breeze/tasks/describe'
 require 'breeze/tasks/server'
 require 'breeze/tasks/server/address'
 require 'breeze/tasks/server/image'

data/lib/breeze/tasks/app.rb

@@ -57,24 +57,34 @@ module Breeze
       deploy_command([new_server], public_server_name, db_server_name, branch)
       puts("The new server should soon be available at #{ip(new_server)}.")
       if ask("Ready to continue and move the elastic_ip for #{public_server_name} to the new server? [YES/rollback] >") =~ /r|n/i
-        remote("sudo shutdown -h +#{CONFIGURATION[:rollback_window]}", :host => ip(old_server))
+        new_server.destroy
+      else
+        remote("sudo shutdown -h +#{CONFIGURATION[:rollback_window]} &", :host => ip(old_server))
         old_server.spare_for_rollback!
         move_addresses(old_server, new_server)
-      else
-        new_server.destroy
       end
     end
 
     desc 'rollback PUBLIC_SERVER_NAME', 'Rollback a deploy'
     def rollback(public_server_name)
       old_server = spare_servers(public_server_name).first
+      raise "no running spare server found for #{public_server_name}" unless old_server
+      if ip(old_server)
+        temp_ip = nil
+      else
+        puts("Old server does not have a public ip. Allocating a temporary address:")
+        thor("server:address:create #{old_server.id}")
+        old_server.reload until old_server.addresses.first
+        temp_ip = ip(old_server)
+      end
       remote('sudo shutdown -c', :host => ip(old_server))
       new_server = active_servers(public_server_name).first
       remote(disable_app_command, :host => ip(new_server))
+      thor("server:address:release #{temp_ip}") if temp_ip
       move_addresses(new_server, old_server)
       old_server.breeze_state('reactivated')
       new_server.breeze_state('abandoned_due_to_rollback')
-      if accept?('Destroy the abandoned server NOW?')
+      if accept?('Ready to destroy the abandoned server now?')
         new_server.destroy
       end
     end
@@ -87,16 +97,16 @@ module Breeze
       end
     end
 
-    def servers(public_server_name)
-      fog.servers.select{ |s| s.name == public_server_name }
+    def running_servers(public_server_name)
+      fog.servers.select{ |s| s.ready? and s.name == public_server_name }
     end
 
     def spare_servers(public_server_name)
-      servers(public_server_name).select{ |s| s.spare_for_rollback? }
+      running_servers(public_server_name).select{ |s| s.spare_for_rollback? }
     end
 
     def active_servers(public_server_name)
-      servers(public_server_name).select{ |s| ! s.spare_for_rollback? }
+      running_servers(public_server_name).select{ |s| not s.spare_for_rollback? }
     end
 
     def on_each_server(command, public_server_name)
@@ -106,7 +116,7 @@ module Breeze
     end
 
     def disable_app_command
-      "cd #{CONFIGURATION[:app_path]} && cp config/breeze/maintenance.html public/system/"
+      "cd #{CONFIGURATION[:app_path]} && mkdir -p public/system && cp config/breeze/maintenance.html public/system/"
     end
 
     def enable_app_command
@@ -141,5 +151,28 @@ module Breeze
       super(task + (options[:force] ? ' --force' : ''))
     end
 
+    # Don't know how to include or inherit thor tasks and descriptions.
+    # These may be included in Staging and Production.
+    def self.inherited(c)
+      c.class_eval <<-END_TASKS
+      desc 'deploy', 'Deploy a new version by replacing old servers with new ones'
+      def deploy
+        thor("app:deploy \#{PUBLIC_SERVER_NAME} \#{DB_SERVER_NAME} \#{BRANCH}")
+      end
+      desc 'rollback', 'Rollback the previous deploy'
+      def rollback
+        thor("app:rollback \#{PUBLIC_SERVER_NAME}")
+      end
+      desc 'disable', 'Copy maintenance.html to public/system/ on active web servers'
+      def disable
+        thor("app:disable \#{PUBLIC_SERVER_NAME}")
+      end
+      desc 'enable', 'Remove system/maintenance.html from active web servers'
+      def enable
+        thor("app:enable \#{PUBLIC_SERVER_NAME}")
+      end
+      END_TASKS
+    end
+
   end
 end

data/lib/breeze/tasks/{list.rb → describe.rb}

@@ -1,6 +1,8 @@
 module Breeze
 
-  class List < Veur
+  class Describe < Veur
+
+    default_task :cloud_resources
 
     desc :cloud_resources, 'List all cloud resources that the current account can control with breeze'
     def cloud_resources
@@ -24,9 +26,9 @@ module Breeze
     desc :servers, 'Describe server instances'
     def servers
       report "SERVER INSTANCES",
-        ['Name', 'Instance ID', 'IP Address', 'Image ID', 'Instance Type', 'Availability Zone', 'State'],
+        ['Name', 'Instance ID', 'IP Address', 'Image ID', 'Type', 'Zone', 'State', 'Info'],
         fog.servers.map { |i|
-          [i.name, i.id, i.public_ip_address, i.image_id, i.flavor_id, i.availability_zone, i.state]
+          [i.name, i.id, i.public_ip_address, i.image_id, i.flavor_id, i.availability_zone, i.state, i.breeze_state]
         }
     end
 

data/lib/breeze/tasks/server.rb

@@ -45,7 +45,7 @@ module Breeze
     end
 
     def remote_is_available?(host)
-      execute(:remote_command, :command => 'exit', :host => host)
+      execute(:remote_available?, :host => host)
     end
 
     def remote(command, args)

data/lib/breeze/tasks/server/image.rb

@@ -8,19 +8,24 @@ module Breeze
                    'stop the server, create a new machine image as a snapshot of the root device, and destroy the server.'
     method_options CONFIGURATION[:default_server_options].merge(CONFIGURATION[:create_image_options])
     def create
-      options[:block_device_mapping] = [{:device_name => '/dev/sda1', :ebs_volume_size => options.delete(:root_device_size)}]
+      # The commented lines used to work before fog 0.7.0.
+      # options[:block_device_mapping] = [{:device_name => '/dev/sda1', :ebs_volume_size => options.delete(:root_device_size)}]
+      options[:block_device_mapping] = [{'DeviceName' => '/dev/sda1', 'Ebs.VolumeSize' => options.delete(:root_device_size)}]
       server = create_server(options)
       prepare_private_image(server.public_ip_address)
       print('Stopping the server before saving a snapshot')
       server.stop
       wait_until('stopped!') { server.stopped? }
-      thor('list:images')
-      image = fog.images.create(:name => ask('Image name >'), :instance_id => server.id)
+      thor('describe:images')
+      puts('===== Old server images are listed above. Give a name to the new image. =====')
+      # image = fog.images.create(:name => ask('Image name >'), :instance_id => server.id)
+      fog.create_image(server.id, ask('Image name >'), '')
       server.destroy
       puts
-      puts("===> Created image #{image.id} and terminated temporary server #{server.id}.")
+      # puts("===> Created image #{image.id} and terminated temporary server #{server.id}.")
+      puts("===> Created a new server image and terminated temporary server #{server.id}.")
       puts
-      puts("NOTICE: it may take a while before the new image shows up in list:images")
+      puts("NOTICE: it may take a while before the new image shows up in describe:images")
     end
 
   end

data/lib/templates/Thorfile

@@ -16,6 +16,7 @@ Breeze::CONFIGURATION = {
   # Remote and upload commands are required in order to create a server image or deploy
   # an application. Arguments marked with %{} are automatically replaced when the
   # commands are used. Use "ssh -i /path/to/key" if not using your default ssh key.
+  :remote_available? => 'ssh -q ubuntu@%{host} exit',
   :remote_command => "ssh ubuntu@%{host} '%{command}'",
   :upload_command => 'rsync -v %{file_pattern} ubuntu@%{host}:%{remote_path}',
 
@@ -38,7 +39,7 @@ Breeze::CONFIGURATION = {
     :root_device_size => 15 # in GB
   },
 
-  # machine images owned by this account are included in list:images (provided that you have access to them)
+  # machine images owned by this account are included in describe:images (provided that you have access to them)
   :image_owner => 'YOUR-ACCOUNT-ID-WITHOUT-DASHES', # canonical: '099720109477'
 
   # db configuration is required in order to use Amazon RDS
@@ -66,10 +67,10 @@ Breeze::CONFIGURATION = {
 # with the "thor help" command.
 require 'breeze/tasks'
 
+# prepare_private_image is called from server:image:create. Modify this and/or the scripts
+# that are uploaded in order to create your own private machine image.
 class Breeze::Server::Image
   private
-  # This method is called from server:image:create. Modify this and/or the scripts that
-  # are uploaded in order to create your own private machine image.
   def prepare_private_image(ip_address)
     wait_until_host_is_available(ip_address)
     puts("Uploading scripts...")
@@ -78,8 +79,7 @@ class Breeze::Server::Image
   end
 end
 
-# You can define staging:start etc. with fixed parameters below.
-
+# deploy_command is called from app:start and app:deploy.
 class Breeze::App
   private
   def deploy_command(servers, public_server_name, db_server_name, branch)
@@ -90,15 +90,18 @@ class Breeze::App
   end
 end
 
-# thor staging:start and staging:stop
+# Define staging:start etc. below. The constants are also needed by
+# inherited tasks: deploy, rollback, enable and disable.
+
 class Staging < Breeze::App
 
   PUBLIC_SERVER_NAME = 'staging.example.com'
   DB_SERVER_NAME = 'staging-db'
+  BRANCH = 'master'
 
   desc 'start', 'Start web server and db for staging'
   def start
-    thor("app:start #{PUBLIC_SERVER_NAME} #{DB_SERVER_NAME} --db-to-clone=#{Production::DB_SERVER_NAME} --deploy-branch=master")
+    thor("app:start #{PUBLIC_SERVER_NAME} #{DB_SERVER_NAME} --db-to-clone=#{Production::DB_SERVER_NAME} --deploy-branch=#{BRANCH}")
   end
 
   desc 'stop', 'Stop staging and destroy server and db'
@@ -108,15 +111,15 @@ class Staging < Breeze::App
 
 end
 
-# thor production:start
 class Production < Breeze::App
 
-  PUBLIC_SERVER_NAME = 'production.example.com'
+  PUBLIC_SERVER_NAME = 'www.example.com'
   DB_SERVER_NAME = 'production-db'
+  BRANCH = 'stable'
 
   desc 'start', 'Start web server and db for production'
   def start
-    thor("app:start #{PUBLIC_SERVER_NAME} #{DB_SERVER_NAME} crags --dns-ttl=300 --deploy-branch=stable")
+    thor("app:start #{PUBLIC_SERVER_NAME} #{DB_SERVER_NAME} db_name --dns-ttl=300 --deploy-branch=#{BRANCH}")
   end
 
 end

data/lib/templates/profiles/rails_and_image_magick/configs/database.yml

@@ -3,7 +3,7 @@
   @owner = 'rails'
   @group = 'rails'
   @perms = 0640
-  @post = 'rake db:migrate'
+  @post = 'rake db:migrate RAILS_ENV=production'
 
   conf = CONFIGURATION[:default_db_options]
 %>

data/lib/templates/profiles/rails_and_image_magick/configs/nginx/nginx.conf

@@ -5,9 +5,9 @@
     system("mkdir -p #{dir} && chown www-data #{dir}") unless File.directory?(dir)
   end
 
-  passenger_version = "3.0.2"
+  passenger_version = "3.0.5"
   server_name = ENV['PUBLIC_SERVER_NAME']
-  server_root = "/srv/your-app/public"
+  server_root = "#{CONFIGURATION[:app_path]}/public"
 
   shared_server_conf = <<-END_SHARED_SERVER_CONF
 
@@ -22,14 +22,10 @@
     # let browsers cache static assets
     location ~ ^/(images|javascripts|stylesheets)/ { expires 1y; }
 
-    # always display system/maintenance.html if it exists
-    if ($request_filename ~* \.(js|css|gif|png|jpg)$) { break; }
-    if (-f $document_root/system/maintenance.html) {
-      rewrite  ^(.*)$  /system/maintenance.html last;
-      break;
-    }
+    # static files, page caching and maintenance.html
+    try_files $uri $uri/index.html $uri.html /system/maintenance.html @passenger;
 
-    location / {
+    location @passenger {
       passenger_enabled on;
     }
 

data/lib/templates/profiles/rails_and_image_magick/scripts/install_conf.sh

@@ -17,7 +17,7 @@ PACKAGES="$SYSTEM_PACKAGES $DB_CLIENT_PACKAGES $RUBY_BUILD_DEPENDENCIES $NGINX_A
 
 # the rest is used by install_cust.sh
 RUBY_PACKAGE=ruby-1.9.2-p180
-IMAGE_MAGICK_PACKAGE=ImageMagick-6.6.7-8
+IMAGE_MAGICK_PACKAGE=ImageMagick-6.6.8-6
 IMAGE_MAGICK_OPTIONS='--disable-static --with-modules --without-perl --without-magick-plus-plus --with-quantum-depth=8'
 NGINX_OPTIONS="\
   --conf-path=/etc/nginx/nginx.conf \

data/lib/templates/profiles/rails_and_image_magick/scripts/install_cust.sh

@@ -5,7 +5,7 @@
 download ftp://ftp.ruby-lang.org//pub/ruby/1.9/$RUBY_PACKAGE.tar.gz
 extract_and_install $RUBY_PACKAGE
 sudo gem update --system
-sudo gem install --no-ri --no-rdoc bundler passenger
+sudo gem install --no-ri --no-rdoc bundler passenger breeze
 
 # install nginx and passenger
 sudo passenger-install-nginx-module --auto --auto-download --prefix=/usr --extra-configure-flags="$NGINX_OPTIONS"

data/lib/templates/shared/scripts/deploy.sh

@@ -34,10 +34,10 @@ sudo usermod --groups rails ubuntu
 
 wget -q --no-check-certificate --directory-prefix=$HOME --output-document=tarball.tar.gz $DOWNLOAD_URL
 tar --directory $HOME -xzf tarball.tar.gz
-
 sudo mv $HOME/*$APP_NAME* $DEPLOY_PATH
-sudo chown -R rails $DEPLOY_PATH
+
 cd $DEPLOY_PATH
-sudo bundle install --without=test development
+bundle install --deployment --without=test development
+sudo chown -R rails:rails $DEPLOY_PATH
 sudo PUBLIC_SERVER_NAME=$PUBLIC_SERVER_NAME DB_SERVER=$DB_SERVER thor configuration:deploy_to_localhost
 sudo /etc/init.d/monit start

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Markus Bengts
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 +01:00
+date: 2011-03-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,8 +73,8 @@ files:
 - lib/breeze/tasks/app.rb
 - lib/breeze/tasks/configuration.rb
 - lib/breeze/tasks/db.rb
+- lib/breeze/tasks/describe.rb
 - lib/breeze/tasks/dns.rb
-- lib/breeze/tasks/list.rb
 - lib/breeze/tasks/server.rb
 - lib/breeze/tasks/server/address.rb
 - lib/breeze/tasks/server/image.rb