capistrano_two_phase_deployment 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9c9945152efe930fa68bfd3a9bfd609e15a3045
+  data.tar.gz: 55b96b28d9cde94d9dd7bb72583cf19473175580
+SHA512:
+  metadata.gz: 547039642f57031e4ed9c0ff809f8447dbc76b29f4f78f9cda168743275cda9b800bd3978625c705cc69a63eedab84268a08bfb13cd9e72797ab2e87933a28e7
+  data.tar.gz: 0c620e3e14fbc4c0f4103dbde1fc36116646a1c0cef7bf3239f1145d277419f31ef96964085f812fc687b392a708d41f4534886a5c7a9a098f5cb0a36bfb66d0

data/README.md

@@ -0,0 +1,66 @@
+# Two-Phase Deployment for Capistrano 3.1
+
+This gem provides two-phase deployment capabilities to capistrano 3.
+
+The deployment process is split into two phases: the first generates a 
+tar.gz file of the content to be deployed via ```cap deploy:prepare_release```
+and uploads it to an intermediary server. This intermediary server should 
+ideally be located in the network infrastructure of your application servers.
+
+In the second phase (```cap deploy```), the frontend servers pull the current
+release from the intermediary server and install it locally.
+
+This allows the servers to not require an installed SCM (e.g. git),
+and saves network bandwith, because the new release is no longer transmitted
+to all servers from an external source.
+
+## Installation
+Add the following to your deploy.rb file:
+```
+set :scm, :intermediate_host
+set :intermediate_host, "host.example.com"
+```
+
+## Capistrano Directory structure on the intermediary host
+These recipes will use the same capistrano directory structure on the 
+intermediary host as on the application servers.
+
+The tar Archives are stored as {deploy_to}/releases/{timestamp}.tar.gz with
+a {deploy_to}/current_tgz symlink pointing to the release tarfile that should
+be pulled in the second phase of the deployment process. This also allows your
+intermediary host to be a regular application server.
+
+## Release directory changes from the capistrano default
+Unlike the default capistrano release path name, the release path will now
+consist of two timestamps:
+{deploy_to}/releases/{deployment_timestamp_of_phase2}_#{timestamp_of_release_preparation}/
+
+Using this directory name format, you can deploy the same intermediary archive
+multiple times without conflicting with an existing deployment of the same
+version. This can come in handy in case you generate additional files during
+your deployment that are not part of the tar archive (e.g. rendering configuration
+file templates, locally compiled assets during deployment etc.).
+
+## Configuration Options
+```
+# Host which acts as intermediary for the deployment files
+# NOTE: only the primary host is currently evaluated
+role :intermediate_host, "host.example.com"
+
+# Which format git archive should output as. See the git archive manual page.
+# Defaults to tar.gz
+set :archive_format, "tar.gz"
+
+# Where to output the generated git archive locally before uploading.
+# Will use Tempfile.new by default to create non-static filename.
+# The tempfile will be deleted after capistrano terminates.
+set :archive_output, "myfile"
+
+# Which branch git archive should generate the tar file from.
+set :branch, "production"
+```
+
+## Caveats/TODOs
+* Only supports git at the moment
+* Will only evaluate the primary intermediary host
+

data/lib/capistrano/intermediate_host.rb

@@ -0,0 +1,30 @@
+require 'capistrano'
+require 'capistrano/scm'
+require 'tempfile'
+
+class Capistrano::IntermediateHost < Capistrano::SCM
+  module GitStrategy
+    def test
+      test! "[ -f #{repo_path}/HEAD ]"
+    end
+
+    def check
+    end
+
+    def generate_archive
+      now = Time.now
+      format = fetch( :archive_format, "tar.gz" )
+      prefix = release_timestamp 
+      output_file = fetch( :archive_output, Tempfile.new( "archive" ).path )
+      branch = fetch( :branch )
+      run_locally do
+        execute :git, "archive --format=#{format} --prefix=#{prefix}/ --output=#{output_file} #{branch}" 
+      end
+      output_file
+    end
+
+  end
+end
+
+import File.join( File.dirname( __FILE__ ), 'tasks', 'intermediate_host.cap' )
+import File.join( File.dirname( __FILE__ ), 'tasks', 'deploy.cap' )

data/lib/capistrano/tasks/deploy.cap

@@ -0,0 +1,6 @@
+namespace :deploy do
+  desc 'Generate a new release archive and push it to the intermediary host'
+  task :prepare_release do
+    invoke 'intermediate_host:prepare_release'
+  end
+end

data/lib/capistrano/tasks/intermediate_host.cap

@@ -0,0 +1,85 @@
+namespace :intermediate_host do
+  def strategy
+    @strategy ||= Capistrano::IntermediateHost.new(self, Capistrano::IntermediateHost::GitStrategy )
+  end
+
+  def upload_path 
+    @upload_path ||=  "#{releases_path}/#{release_timestamp}.tar.gz"
+  end
+
+  def current_tgz
+    @current_tgz ||= deploy_path.join( "current.tar.gz" )
+  end
+
+  desc 'check stuff'
+  task :check do
+    strategy.check
+  end
+
+  desc 'Update the repo mirror to reflect the origin state'
+  task :update do
+    output_file = strategy.generate_archive
+  end
+
+  desc 'Upload a release to the intermediary server'
+  task :upload_release do
+    output_file = strategy.generate_archive
+
+    on primary( :intermediate_host ) do
+      upload! output_file, upload_path
+    end
+  end
+
+  desc 'Copy repo to releases host'
+  task :prepare_release => :upload_release do
+    on primary( :intermediate_host ) do
+      execute :rm, "-f", current_tgz
+      execute :ln, "-sf", upload_path, current_tgz
+    end
+  end
+
+  def mk_tempfile_name
+    tempfile_template = "#{fetch( :application )}_XXXXXX"
+    
+    mktemp_version_info = capture( :mktemp, "-V" )
+    if mktemp_version_info =~ /mktemp version 1\./
+      # Old CentOS/OpenBSD mktemp style
+      capture( :mktemp, "-p #{fetch(:deploy_to)}", tempfile_template )
+    else
+      # Otherwise, be more sane.
+      capture( :mktemp, "--suffix=.tar.gz", "--tmpdir=#{fetch(:deploy_to)}", tempfile_template )
+    end
+  end
+
+  desc 'Extract the archive timestamp from current.tar.gz on intermediary host'
+  task :set_release_path_based_on_archive_timestamp do
+    on primary( :intermediate_host ) do
+      archive_timestamp = capture( :tar, "tfzv", current_tgz, " | head -n 1 | awk '{print $6}'" )
+
+      deploy_timestamp = "#{release_timestamp}_#{archive_timestamp}"
+
+      set( :release_path, releases_path.join( deploy_timestamp ) )
+    end
+  end
+
+  desc 'Pull release from releases host'
+  task :update => :set_release_path_based_on_archive_timestamp do
+    on release_roles :all do
+      download_path = mk_tempfile_name
+
+      execute :scp, "#{primary( :intermediate_host )}:#{current_tgz}",
+                    download_path
+
+      execute :mkdir, "-p", release_path
+      execute :tar, "xfz", download_path, "-C", release_path, "--strip-components=1"
+      execute :rm, "-f", download_path
+    end
+  end
+
+  desc 'Create release from pulled repo'
+  task :create_release => :update do
+    on release_roles :all do
+      # something
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_two_phase_deployment
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sven Riedel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Deploy with tar files via an intermediary host
+email: sr@gimp.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/capistrano/intermediate_host.rb
+- lib/capistrano/tasks/deploy.cap
+- lib/capistrano/tasks/intermediate_host.cap
+homepage: http://github.com/sriedel/capistrano_two_phase_deployment
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows Capistrano 3 to deploy tar archives via an intermediary host; servers
+  no longer need to have an SCM client installed
+test_files: []