capistrano-releases 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c8b02de2ee347d75131b77ed59df3d2f8ca392
-  data.tar.gz: 71d451dbfeb6ac72decab1c8e973d336b7a64294
+  metadata.gz: 59d6dff6482631156eba519cee7dc7205baa6953
+  data.tar.gz: 82fa108d36ff56bc11d2606ad3fd34764fea3ba2
 SHA512:
-  metadata.gz: aa4d61c892fee55dbe10e26c50ff658139e408c016c2273af00fe97e076464c5f557e3560649622dfe62268b3a6c8b162dd559feddaf2503d0aa1ba850267567
-  data.tar.gz: 13eca03654b74f18c1aaec90524475883b72995ccc0f53a0285ed20cd2742132811deb55970fc3c2a1f4c27c45703d49559855a2a51e60ca814e45d89e9a9a68
+  metadata.gz: 4f6ed45f6baeda7c996f49ca855c061c521e6680bbfae80c96bffbaa55ea5f77467785295c0a1c8c727ad4ab8532331b757136e9b2b6de1933f34ebc639ccc26
+  data.tar.gz: 5b8d7226a89243e6c079cf69eeef4999a9fbb889a55001b4d45aa2e24024b21db89e757b0dd7e9394bd65b2beb6608add9137bb3dde1486b1a56171d8a501bdb

data/README.md

@@ -1,7 +1,14 @@
 # Capistrano::Releases
-Auto scaling AWS EC2 environments need a way to share the Capistrano 'releases' directory and 'current' symlink.
-This gem provides that capability using AWS S3 to store releases.
-Each release is stored as a zip file.
+
+This gem simplifies working with [Auto scaling for AWS EC2](https://aws.amazon.com/autoscaling/) and [Capistrano](http://capistranorb.com). It does this by storing your releases in AWS S3 and synchronizing them when needed (after deploy, instance reboot, and after a new instance is created).
+
+## Requirements
+
+* Ruby 2.X or greater
+* aws-sdk 2.X or greater
+* An AWS S3 bucket to store releases
+* Read and write API permissions to the S3 bucket
+* Capistrano installed and configured properly with deploys already working
 
 ## Installation
 
@@ -21,8 +28,93 @@ Or install it yourself as:
 
 ## Usage
 
+It is assumed that you have already setup a S3 bucket and granted API read/write permissions to it.
+You should test to make sure your instances are able to read/write to the bucket before continuing.
+
+You normally interact with the gem through the command line (see below for flag details):
+
     $ releases --help
 
+The general idea is that after each deploy, you 'push' the new release to S3.
+Then, after each boot (or reboot) your instances 'pull' the latest releases from S3.
+
+For 'push' you need to edit your *deploy.rb* and add something like this:
+
+    namespace :releases do
+        bucket = 'your-bucket-name-goes-here'
+        
+        desc 'Push releases'
+        task :push do
+            on roles(:all, primary: true) do
+                execute "releases -b #{bucket} -d #{fetch(:deploy_to)} -m push"
+            end
+        end
+    end
+    after 'deploy:finished', 'releases:push'
+
+For 'pull' you need to configure your server to run a command **before** your Rails processes (Puma, Thin, Sidekiq, etc) start:
+
+    $ releases -b your-bucket-name-goes-here -d /your/deploy/to/name/goes/here -m pull
+    
+You must now write a boot script for your Rails processes.
+These tend to be very specific to your environment and the set of Capistrano gems you are using.
+An example is provided below.
+
+## Flags
+
+#### --mode
+
+You must pick a mode to run in: 'push' or 'pull'.
+
+The push mode compare your local releases to those stored in S3.
+Any missing releases will get compressed and uploaded.
+The 'current' symlink version will also get uploaded.
+
+The pull mode compares the releases stored in S3 to your local releases.
+Any missing releases will get downloaded and uncompressed.
+Finally, the 'current' symlink will get updated to match the remote version.
+
+#### --bucket
+
+Your instances must have read/write access to the specified S3 bucket.
+Make sure your instances have the correct permissions with an IAM role
+or make sure you specify the ````AWS_ACCESS_KEY_ID```` and ````AWS_SECRET_ACCESS_KEY```` environment variables.
+Under the hood this gem uses the [aws-sdk](https://github.com/aws/aws-sdk-ruby) gem for all API calls.
+
+#### --deploy-to
+
+This flag must be set to match the Capistrano configuration variable of the same name.
+You can normally find it in your *deploy.rb*. An example from a stock config:
+
+    set :deploy_to, "/var/www/my_app_name"
+
+## Rails boot script
+
+This is just a sample.
+You will need to modify it based on your Capistrano configuration.
+Watch the commands that are executed when you run ````cap production deploy```` to see what commands are executed.
+Also make sure you run it as ````:deploy_user```` as specified in your *deploy.rb*.
+
+    #!/bin/bash
+
+    echo '***** pulling releases *****' &&
+    releases -b my-releases-bucket -d /apps/my-app -m pull &&
+    
+    echo '***** Deleting old PID files *****' &&
+    rm -rf /apps/my-app/shared/tmp/pids/* &&
+    
+    echo '***** Installing gems *****' &&
+    bundle install --path /apps/my-app/shared/bundle --without development test --deployment --quiet &&
+
+    echo '***** Precompiling assets *****' &&
+    bundle exec rake assets:precompile &&
+    
+    echo '***** Starting web server *****' &&
+    echo 'put your web server command here' &&
+    
+    echo '***** Starting job server *****' &&
+    echo 'put your job server command here'
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/capistrano/releases/manager.rb

@@ -27,29 +27,45 @@ module Capistrano
 
       def push
         make_dirs
+
         remotes = Set.new(remote_releases)
-        to_upload = local_releases.reject { |r| remotes.include?(r) }
-        to_upload.each { |r| upload(r) }
+        puts "Remote releases: #{remotes.to_a.inspect}"
+
+        to_upload_releases = local_releases.reject { |r| remotes.include?(r) }
+        to_upload_releases.each do |r|
+          puts "Uploading release: #{r}"
+          upload_release(r)
+        end
+
+        puts "Setting remote current to: #{remote_current}"
         self.remote_current = local_current
 
-        to_upload
+        upload_bundle
+
+        to_upload_releases
       end
 
       def pull
         make_dirs
+
         locals = Set.new(local_releases)
         puts "Local releases: #{locals.to_a.inspect}"
-        to_download = remote_releases.last(params[:keep_releases])
-                                     .reject { |r| locals.include?(r) }
-        to_download.each do |r|
+
+        to_download_releases = remote_releases.last(params[:keep_releases])
+                                              .reject { |r| locals.include?(r) }
+        to_download_releases.each do |r|
           puts "Downloading release: #{r}"
-          download(r)
+          download_release(r)
         end
+
         self.local_current = remote_current
+
         puts "Setting local current to: #{local_current}"
         Dir.chdir(File.join(params[:deploy_to], 'current'))
 
-        to_download
+        download_bundle
+
+        to_download_releases
       end
 
       private
@@ -86,6 +102,10 @@ module Capistrano
         File.join(params[:deploy_to], 'releases')
       end
 
+      def local_shared_path
+        File.join(params[:deploy_to], 'shared')
+      end
+
       def local_releases
         Dir.glob("#{local_releases_path}/*")
            .sort
@@ -95,7 +115,7 @@ module Capistrano
       def remote_releases
         bucket.objects
               .map(&:key)
-              .select { |k| k.end_with?('.tar.gz') }
+              .select { |k| k =~ /\A\d+.*\.tar\.gz\z/ }
               .map { |k| k.gsub(/\.tar\.gz\z/, '') }
               .sort
       end
@@ -124,8 +144,8 @@ module Capistrano
         nil
       end
 
-      def upload(release)
-        tmp = Tempfile.new(["capistrano-releases_upload-#{release}", '.tar.gz'],
+      def upload_release(release)
+        tmp = Tempfile.new(["capistrano-releases_upload-release-#{release}", '.tar.gz'],
                            Dir.tmpdir, encoding: 'BINARY')
 
         begin
@@ -137,8 +157,8 @@ module Capistrano
         end
       end
 
-      def download(release)
-        tmp = Tempfile.new(["capistrano-releases_download-#{release}", '.tar.gz'],
+      def download_release(release)
+        tmp = Tempfile.new(["capistrano-releases_download-release-#{release}", '.tar.gz'],
                            Dir.tmpdir, encoding: 'BINARY')
 
         begin
@@ -150,6 +170,40 @@ module Capistrano
         end
       end
 
+      def upload_bundle
+        return unless Dir.exist?(File.join(local_shared_path, 'bundle'))
+
+        puts 'Uploading bundle'
+
+        tmp = Tempfile.new(['capistrano-releases_upload-bundle', '.tar.gz'],
+                           Dir.tmpdir, encoding: 'BINARY')
+
+        begin
+          system!(['tar', 'Ccfz', local_shared_path, tmp.path, 'bundle'])
+          bucket.object('bundle.tar.gz').put(body: tmp)
+        ensure
+          tmp.close
+          tmp.unlink
+        end
+      end
+
+      def download_bundle
+        return if Dir.exist?(File.join(local_shared_path, 'bundle'))
+
+        puts 'Downloading bundle'
+
+        tmp = Tempfile.new(['capistrano-releases_download-bundle', '.tar.gz'],
+                           Dir.tmpdir, encoding: 'BINARY')
+
+        begin
+          bucket.object('bundle.tar.gz').get(response_target: tmp)
+          system!(['tar', 'Cxfz', local_shared_path, tmp.path])
+        ensure
+          tmp.close
+          tmp.unlink
+        end
+      end
+
       def bucket
         @bucket ||= Aws::S3::Bucket.new(params[:bucket])
       end

data/lib/capistrano/releases/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Releases
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-releases
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chad Remesch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler