capistrano-s3-copy 0.0.1 → 0.0.2

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -16,4 +15,5 @@ test/tmp
 test/version_tmp
 tmp
 
+.idea
 .rvmrc

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    capistrano-s3-copy (0.0.1)
+      capistrano (>= 2.12.0)
+      s3sync
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    capistrano (2.12.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    highline (1.6.11)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.3.0)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    s3sync (1.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-s3-copy!

data/README.md

@@ -2,16 +2,12 @@
 
 This is a revised implementation of the ideas in Bill Kirtleys capistrano-s3 gem.
 
-I have a requirement to push new deployments via capistrano, but also to retain the last
-deployed package in S3 for the purposes of auto-scaling. 
+I have a requirement to push new deployments via capistrano, but also to retain the last deployed
+package in S3 for the purposes of auto-scaling.
 
-This gem use Capistrano's own code to build the tarball package, but instead of 
-deploying it to each machine, we deploy it to a configured S3 bucket (using s3cmd), then
-deploy it from there to the known nodes from the capistrano script.
-
-At some point, I aim to persist a shell script to accompany the package. This will be used
-to instruct a fresh AWS instance how to locate, download and install he S3 package as if
-it was deployed via capistrano.
+This gem use Capistrano's own code to package the tarball, but instead of deploying it to each
+machine, we deploy it to a configured S3 bucket (using s3cmd provided by the rahugo-s3sync gem https://github.com/frahugo/s3sync),
+then deploy it from there to the known nodes from the capistrano script.
 
 ## Installation
 
@@ -43,7 +39,7 @@ package to S3
 
 Finally, we need to indicate which bucket to store the packages in:
 
-    set :aws_s3_copy_bucket, 'mybucket-deployments'
+    set :aws_releases_bucket, 'mybucket-deployments'
 
 The package will be stored in S3 prefixed with a rails_env that was set in capistrano:
 
@@ -51,6 +47,105 @@ e.g.
 
     S3://mybucket-deployment/production/201204212007.tar.gz
 
+If the deployment succeeds, another file is written to S3:
+
+    S3://mybucket-deployment/production/aws_install.sh
+
+The intention is that auto-scaled instances started after the deploy could download this well-known script
+to an AMI, and executing it would bring down the latest tarball, and extract it in a manner similar to
+someone running:
+
+  cap deploy:setup
+  cap deploy
+
+Of course, everyone has tweaks that they make to the standard capistrano recipe. For this reason, the script
+thats executed is generated from an ERB template.
+
+    #!/bin/sh
+
+    # Auto-scaling capistrano like deployment script Rails3 specific.
+
+    echo "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}"
+    echo "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}"
+    AWS_RELEASES_BUCKET=<%= configuration[:aws_releases_bucket] %>
+
+    RAILS_ENV=<%= configuration[:rails_env] %>              # e.g. production
+    DEPLOY_TO=<%= configuration[:deploy_to] %>              # e.g. /u/apps/myapp
+    RELEASES_PATH=<%= configuration[:releases_path] %>      # e.g. /u/apps/myapp/releases
+    RELEASE_PATH=<%= configuration[:release_path] %>        # e.g. /u/apps/myapp/releases/20120428210958
+    SHARED_PATH=<%= configuration[:shared_path] %>          # e.g. /u/apps/myapp/shared
+    CURRENT_PATH=<%= configuration[:current_path] %>        # e.g. /u/apps/myapp/current
+
+    PACKAGE_NAME=<%= File.basename(filename) %>             # e.g. 20120428210958.tar.gz
+    S3_PACKAGE_PATH=${RAILS_ENV}/${PACKAGE_NAME}            # e.g. production/20120428210958.tar.gz
+    DOWNLOADED_PACKAGE_PATH=<%= remote_filename %>          # e.g. /tmp/20120428210958.tar.gz
+    DECOMPRESS_CMD="<%= decompress(remote_filename).join(" ") %>" # e.g. tar xfz /tmp/20120428210958.tar.gz
+
+    mkdir -p $DEPLOY_TO
+    mkdir -p $RELEASES_PATH
+    mkdir -p ${SHARED_PATH}
+    mkdir -p ${SHARED_PATH}/system
+    mkdir -p ${SHARED_PATH}/log
+    mkdir -p ${SHARED_PATH}/pids
+
+    touch ${SHARED_PATH}/log/${RAILS_ENV}.log
+    chmod 0666 ${SHARED_PATH}/log/${RAILS_ENV}.log
+    chmod -R g+w ${DEPLOY_TO}
+
+    # AFTER: cap deploy:setup
+    # Project specific shared directories
+    # mkdir -p ${SHARED_PATH}/content
+    # mkdir -p ${SHARED_PATH}/uploads
+
+    # cap deploy:update_code
+    s3cmd get ${AWS_RELEASE_BUCKET}:${S3_PACKAGE_PATH} ${DOWNLOADED_PACKAGE_PATH} 2>&1
+    cd ${RELEASES_PATH} && ${DECOMPRESS_CMD} && rm ${DOWNLOADED_PACKAGE_PATH}
+
+    # cap deploy:assets_symlink   (Rails 3.x specific)
+    rm -rf ${RELEASE_PATH}/public/assets
+    mkdir -p ${RELEASE_PATH}/public
+    mkdir -p ${DEPLOY_TO}/shared/assets
+    ln -s ${SHARED_PATH}/assets ${RELEASE_PATH}/public/assets
+
+    # cap deploy:finalize_update
+    chmod -R g+w ${RELEASE_PATH}
+    rm -rf ${RELEASE_PATH}/log
+    rm -rf ${RELEASE_PATH}/public/system
+    rm -rf ${RELEASE_PATH}/tmp/pids
+    mkdir -p ${RELEASE_PATH}/public
+    mkdir -p ${RELEASE_PATH}/tmp
+    ln -s ${SHARED_PATH}/system ${RELEASE_PATH}/public/system
+    ln -s ${SHARED_PATH}/log ${RELEASE_PATH}/log
+    ln -s ${SHARED_PATH}/pids ${RELEASE_PATH}/tmp/pids
+
+    # AFTER: cap deploy:finalize_update
+    cd ${RELEASE_PATH}
+    bundle install --gemfile ${RELEASE_PATH}/Gemfile --path ${SHARED_PATH}/bundle --deployment --quiet --without development test
+
+    # AFTER: cap deploy:update_code
+    # cap deploy:assets:precompile
+    cd ${RELEASE_PATH}
+    bundle exec rake RAILS_ENV=${RAILS_ENV} RAILS_GROUPS=assets assets:precompile
+
+    # Project specific shared symlinking
+    #ln -nfs ${SHARED_PATH}/content ${RELEASE_PATH}/public/content
+    #ln -nfs ${SHARED_PATH}/uploads ${RELEASE_PATH}/public/uploads
+
+    # cap deploy:create_symlink
+    rm -f ${CURRENT_PATH}
+    ln -s ${RELEASE_PATH} ${CURRENT_PATH}
+
+    # cap deploy:restart
+    # touch ${CURRENT_PATH}/tmp/restart.txt
+
+    # AFTER: cap deploy:restart
+    # cd ${CURRENT_PATH};RAILS_ENV=${RAILS_ENV} script/delayed_job restart
+
+An alternative ERB script can be configured via something like this:
+
+    set :aws_install_script, File.read(File.join(File.dirname(__FILE__), "custom_aws_install.sh.erb")
+
+
 ## Contributing
 
 1. Fork it

data/capistrano-s3-copy.gemspec

@@ -4,13 +4,14 @@ require File.expand_path('../lib/capistrano-s3-copy/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Richie McMahon"]
   gem.email         = ["richie.mcmahon@gmail.com"]
-  gem.description   = %q{Capistrano deployment strategy that creates and pushes a tarball 
+  gem.description   = %q{Capistrano deployment strategy that creates and pushes a tarball
 into S3, for both pushed deployments and pulled auto-scaling.}
   gem.summary       = %q{Capistrano deployment strategy that transfers the release on S3}
   gem.homepage      = "http://github.com/richie/capistrano-s3-copy"
-  
+
   gem.add_dependency 'capistrano', ">= 2.12.0"
-  
+  gem.add_dependency 'frahugo-s3sync'
+
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/capistrano/recipes/deploy/strategy/aws_install.sh.erb

@@ -0,0 +1,79 @@
+#!/bin/sh
+
+# Auto-scaling capistrano like deployment script Rails3 specific.
+
+echo "AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}"
+echo "AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}"
+AWS_RELEASES_BUCKET=<%= configuration[:aws_releases_bucket] %>
+
+RAILS_ENV=<%= configuration[:rails_env] %>              # e.g. production
+DEPLOY_TO=<%= configuration[:deploy_to] %>              # e.g. /u/apps/myapp
+RELEASES_PATH=<%= configuration[:releases_path] %>      # e.g. /u/apps/myapp/releases
+RELEASE_PATH=<%= configuration[:release_path] %>        # e.g. /u/apps/myapp/releases/20120428210958
+SHARED_PATH=<%= configuration[:shared_path] %>          # e.g. /u/apps/myapp/shared
+CURRENT_PATH=<%= configuration[:current_path] %>        # e.g. /u/apps/myapp/current
+
+PACKAGE_NAME=<%= File.basename(filename) %>             # e.g. 20120428210958.tar.gz
+S3_PACKAGE_PATH=${RAILS_ENV}/${PACKAGE_NAME}            # e.g. production/20120428210958.tar.gz
+DOWNLOADED_PACKAGE_PATH=<%= remote_filename %>          # e.g. /tmp/20120428210958.tar.gz
+DECOMPRESS_CMD="<%= decompress(remote_filename).join(" ") %>" # e.g. tar xfz /tmp/20120428210958.tar.gz
+
+mkdir -p $DEPLOY_TO
+mkdir -p $RELEASES_PATH
+mkdir -p ${SHARED_PATH}
+mkdir -p ${SHARED_PATH}/system
+mkdir -p ${SHARED_PATH}/log
+mkdir -p ${SHARED_PATH}/pids
+
+touch ${SHARED_PATH}/log/${RAILS_ENV}.log
+chmod 0666 ${SHARED_PATH}/log/${RAILS_ENV}.log
+chmod -R g+w ${DEPLOY_TO}
+
+# AFTER: cap deploy:setup
+# Project specific shared directories
+# mkdir -p ${SHARED_PATH}/content
+# mkdir -p ${SHARED_PATH}/uploads
+
+# cap deploy:update_code
+s3cmd get ${AWS_RELEASE_BUCKET}:${S3_PACKAGE_PATH} ${DOWNLOADED_PACKAGE_PATH} 2>&1
+cd ${RELEASES_PATH} && ${DECOMPRESS_CMD} && rm ${DOWNLOADED_PACKAGE_PATH}
+
+# cap deploy:assets_symlink   (Rails 3.x specific)
+rm -rf ${RELEASE_PATH}/public/assets
+mkdir -p ${RELEASE_PATH}/public
+mkdir -p ${DEPLOY_TO}/shared/assets
+ln -s ${SHARED_PATH}/assets ${RELEASE_PATH}/public/assets
+
+# cap deploy:finalize_update
+chmod -R g+w ${RELEASE_PATH}
+rm -rf ${RELEASE_PATH}/log
+rm -rf ${RELEASE_PATH}/public/system
+rm -rf ${RELEASE_PATH}/tmp/pids
+mkdir -p ${RELEASE_PATH}/public
+mkdir -p ${RELEASE_PATH}/tmp
+ln -s ${SHARED_PATH}/system ${RELEASE_PATH}/public/system
+ln -s ${SHARED_PATH}/log ${RELEASE_PATH}/log
+ln -s ${SHARED_PATH}/pids ${RELEASE_PATH}/tmp/pids
+
+# AFTER: cap deploy:finalize_update
+cd ${RELEASE_PATH}
+bundle install --gemfile ${RELEASE_PATH}/Gemfile --path ${SHARED_PATH}/bundle --deployment --quiet --without development test
+
+# AFTER: cap deploy:update_code
+# cap deploy:assets:precompile
+cd ${RELEASE_PATH}
+bundle exec rake RAILS_ENV=${RAILS_ENV} RAILS_GROUPS=assets assets:precompile
+
+# Project specific shared symlinking
+#ln -nfs ${SHARED_PATH}/content ${RELEASE_PATH}/public/content
+#ln -nfs ${SHARED_PATH}/uploads ${RELEASE_PATH}/public/uploads
+
+# cap deploy:create_symlink
+rm -f ${CURRENT_PATH}
+ln -s ${RELEASE_PATH} ${CURRENT_PATH}
+
+# cap deploy:restart
+# touch ${CURRENT_PATH}/tmp/restart.txt
+
+# AFTER: cap deploy:restart
+# cd ${CURRENT_PATH};RAILS_ENV=${RAILS_ENV} script/delayed_job restart

data/lib/capistrano/recipes/deploy/strategy/s3_copy.rb

@@ -1,57 +1,78 @@
 require 'capistrano/recipes/deploy/strategy/copy'
+require 'erb'
+
 
 module Capistrano
   module Deploy
     module Strategy
       class S3Copy < Copy
-      
-        S3CMD_VARS = ["aws_access_key_id", "aws_secret_access_key"]
-      
+
         def initialize(config={})
-          super(config)          
-          
+          super(config)
+
           s3cmd_vars = []
-          S3CMD_VARS.each do |var|
+          ["aws_access_key_id", "aws_secret_access_key"].each do |var|
             value = configuration[var.to_sym]
             raise Capistrano::Error, "Missing configuration[:#{var}] setting" if value.nil?
             s3cmd_vars << "#{var.upcase}=#{value}"
-          end       
-          @aws_environment = s3cmd_vars.join(" ")                 
-          
-          @bucket_name = configuration[:aws_s3_copy_bucket]
-          raise Capistrano::Error, "Missing configuration[:aws_s3_copy_bucket]" if @bucket_name.nil?
-        end      
-        
+          end
+          @aws_environment = s3cmd_vars.join(" ")
+
+          @bucket_name = configuration[:aws_releases_bucket]
+          raise Capistrano::Error, "Missing configuration[:aws_releases_bucket]" if @bucket_name.nil?
+        end
+
         def check!
           super.check do |d|
-            d.local.command("s3cmd")          
+            d.local.command("s3cmd")
             d.remote.command("s3cmd")
           end
-        end          
-      
-        # Distributes the file to the remote servers          
+        end
+
+        # Distributes the file to the remote servers
         def distribute!
           package_path = filename
           package_name = File.basename(package_path)
-          s3_package = "s3://#{bucket_name}/#{rails_env}/#{package_name}"
-          system("#{aws_environment} s3cmd --no-progress put #{package_path} #{s3_package} 2>&1")
-          
-          if $? != 0
-            raise Capistrano::Error, "shell command failed with return code #{$?}"
-          end          
-          
+          s3_push_cmd = "#{aws_environment} s3cmd put #{bucket_name}:#{rails_env}/#{package_name} #{package_path} x-amz-server-side-encryption:AES256"
+
+          if configuration.dry_run
+            logger.debug s3_push_cmd
+          else
+            system(s3_push_cmd)
+            raise Capistrano::Error, "shell command failed with return code #{$?}" if $? != 0
+          end
+
           run "#{aws_environment} s3cmd get #{bucket_name}:#{rails_env}/#{package_name} #{remote_filename} 2>&1"
-          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"          
+          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
           logger.debug "done!"
+
+          build_aws_install_script
+        end
+
+        def build_aws_install_script
+          template_text = configuration[:aws_install_script]
+          template_text = File.read(File.join(File.dirname(__FILE__), "aws_install.sh.erb")) if template_text.nil?
+          template_text = template_text.gsub("\r\n?", "\n")
+          template = ERB.new(template_text, nil, '<>-')
+          output = template.result(self.binding)
+          local_output_file = File.join(copy_dir, "aws_install.sh")
+          File.open(local_output_file, "w") do  |f|
+            f.write(output)
+          end
+          configuration[:s3_copy_aws_install_cmd] = "#{aws_environment} s3cmd put #{bucket_name}:#{rails_env}/aws_install.sh #{local_output_file} x-amz-server-side-encryption:AES256"
         end
-          
-        def aws_environment            
+
+        def binding
+          super
+        end
+
+        def aws_environment
           @aws_environment
         end
-        
+
         def bucket_name
           @bucket_name
-        end                  
+        end
       end
     end
   end

data/lib/capistrano-s3-copy/recipes/s3_copy.rb

@@ -0,0 +1,15 @@
+Capistrano::Configuration.instance(false).load do
+
+  namespace :s3_copy do
+
+    desc "Internal hook that updates the aws_install.sh script to latest if the deploy completed"
+    task :store_aws_install_script_on_success do
+      cmd = fetch(:s3_copy_aws_install_cmd)
+      if cmd
+        run_locally(cmd)
+      end
+    end
+  end
+
+  after 'deploy', 's3_copy:store_aws_install_script_on_success'
+end

data/lib/capistrano-s3-copy/version.rb

@@ -1,7 +1,7 @@
 module Capistrano
   module S3
     module Copy
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/lib/capistrano-s3-copy.rb

@@ -1,9 +1,2 @@
 require "capistrano-s3-copy/version"
-
-module Capistrano
-  module S3
-    module Copy
-      # Your code goes here...
-    end
-  end
-end
+require 'capistrano-s3-copy/recipes/s3_copy'

metadata

@@ -2,7 +2,7 @@
 name: capistrano-s3-copy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Richie McMahon
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-21 00:00:00 Z
+date: 2012-04-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
@@ -23,8 +23,19 @@ dependencies:
         version: 2.12.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: frahugo-s3sync
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: |-
-  Capistrano deployment strategy that creates and pushes a tarball 
+  Capistrano deployment strategy that creates and pushes a tarball
   into S3, for both pushed deployments and pulled auto-scaling.
 email: 
 - richie.mcmahon@gmail.com
@@ -37,12 +48,15 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - capistrano-s3-copy.gemspec
 - lib/capistrano-s3-copy.rb
+- lib/capistrano-s3-copy/recipes/s3_copy.rb
 - lib/capistrano-s3-copy/version.rb
+- lib/capistrano/recipes/deploy/strategy/aws_install.sh.erb
 - lib/capistrano/recipes/deploy/strategy/s3_copy.rb
 homepage: http://github.com/richie/capistrano-s3-copy
 licenses: []