capistrano-slug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c410eecc15c688b93ca6a7525f3b957a93e5c950
+  data.tar.gz: bed597e554bed48fcd766216dc0d8c102830a124
+SHA512:
+  metadata.gz: 7eeb8697ea54e1dc9c56c8bc283e6ee1f5830c0194db3bcfb0cc4013771b5c1fbeac6d7f5b181c473f3f215b98bda795451076f44fe4cd0e84cc9f8e5f7b8373
+  data.tar.gz: f4319ae71b1a56db17d5066fa9d68092844359aa970eeb96e7a561c3ce32cdea9e441d7c6d90d6f5053d1495f51d95c9c4294c2cca043f21a0e0614bef58a5ab

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Coleman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Capistrano-Slug
+
+[![Gem Version](https://badge.fury.io/rb/capistrano-slug.svg)](http://badge.fury.io/rb/capistrano-slug)
+
+Basically after a deploy is completed Capistrano packs up it's directory and sends it off for artifact deployment sometime else.
+
+The initial use case is taking a point-in-time snapshot of Capistrano deployment, after every deployment, to use on newly bootstrapped servers.
+When a new server bootstraps I want it to have the current code (and config etc) that was deployed by Capistrano. This is achieved downloading and 'installing' the slug on boot of a new server.
+
+This enables things like automatic provisioning of new servers but still allows for Capistrano deployments.
+
+Slug work happens on a single server only - the primary of the configured role (default `:all`).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.2.0'
+gem 'capistrano-slug'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install capistrano-slug`
+
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano/slug'
+```
+
+`capistrano-slug` comes with 4 tasks:
+
+* `slug`
+* `slug:create`
+* `slug:upload`
+* `slug:clean`
+
+
+#### slug
+
+Create a slug and upload it to your configured storage.
+
+```shell
+$ cap production slug
+ INFO Some stuff
+```
+
+Can be used during a deploy; if you want to create/upload a slug on every deploy:
+
+```ruby
+# add to config/deploy.rb
+
+after 'deploy:finished', :slug
+```
+
+
+#### slug:create
+
+Creates a slug:
+
+```shell
+$ cap staging slug:create
+ INFO Created Slug: foo-application-slug.tar.gz
+```
+
+
+#### slug:upload
+
+Uploads a slug to your configured storage:
+
+```shell
+$ cap staging slug:upload
+ INFO Uploaded Slug: foo-application-slug.tar.gz
+```
+
+#### slug:clean
+
+Removes a slug from your server (not it's storage):
+
+```shell
+$ cap staging slug:clean
+ INFO Cleaned Slug: foo-application-slug.tar.gz
+```
+
+
+
+### Configuration
+
+Configurable options, shown here with defaults:
+
+```ruby
+set :slug_role, :all
+set :slug_name, -> { fetch(:application) }
+set :slug_storage_backend, 's3'
+set :slug_s3_bucket, nil
+```
+
+
+### Storage
+
+Currently only Amazon S3 is supported. Adding new storage backends shouldn't be a major task, I just haven't had the need -
+look at `./lib/capistrano/tasks/storage.rake` and send a PR if you're interested!
+
+#### Amazon S3
+
+An existing S3 bucket is required.
+
+Credentials are not set anywhere in Capistrano, it's assumed you're using IAM instance profiles or have ENV vars set for credentials - if this isn't the case create an issue or send a PR!
+
+The following configuration is required and must be set:
+
+```ruby
+set :slug_s3_bucket, 'foo-slug-bucket'
+```
+
+Object uploads are set to the `:private` ACL and uploaded with server side encryption - they're not configurable I think these are sane options for this use case.
+
+It currently relies on the `aws` cli being installed on the server: https://aws.amazon.com/cli/
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-slug.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-slug'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+  spec.summary       = %q{Capistrano tasks to make deployment artifacts}
+  spec.description   = %q{Capistrano tasks to make deployment artifacts}
+  spec.homepage      = 'https://github.com/rjocoleman/capistrano-slug'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/slug.rb

@@ -0,0 +1,2 @@
+load File.expand_path('../tasks/slug.rake', __FILE__)
+load File.expand_path('../tasks/storage.rake', __FILE__)

data/lib/capistrano/tasks/slug.rake

@@ -0,0 +1,39 @@
+namespace :slug do
+
+  desc 'Create Slug'
+  task :create do
+    on primary fetch(:slug_role) do
+      slug_file = "#{fetch(:tmp_dir)}/#{fetch(:application)}/#{fetch(:slug_name)}-slug.tar.gz"
+      info "Slug: Creating #{slug_file}"
+      execute "tar czf #{slug_file} -C #{deploy_path} ."
+      info "Slug: Successfully created #{slug_file}"
+    end
+  end
+
+  # pluggable storage backends are in storage.rake
+  desc 'Upload Slug'
+  task :upload do
+    invoke "slug:upload:#{fetch(:slug_storage_backend)}"
+  end
+
+  task :clean do
+    on primary fetch(:slug_role) do
+      slug_file = "#{fetch(:tmp_dir)}/#{fetch(:application)}/#{fetch(:slug_name)}-slug.tar.gz"
+      execute :rm, slug_file
+      info "Slug: Cleaned #{slug_file}"
+    end
+  end
+
+end
+
+desc 'Create & upload a new slug'
+task :slug => ['slug:create', 'slug:upload', 'slug:clean']
+
+namespace :load do
+  task :defaults do
+
+    set :slug_name, -> { fetch(:application) }
+    set :slug_role, :web
+
+  end
+end

data/lib/capistrano/tasks/storage.rake

@@ -0,0 +1,23 @@
+namespace :slug do
+  namespace :upload do
+
+    task :s3 do
+      on primary fetch(:slug_role) do
+        slug_file = "#{fetch(:slug_name)}-slug.tar.gz"
+        slug = "#{fetch(:tmp_dir)}/#{fetch(:application)}/#{slug_file}"
+        execute :aws, "s3 cp #{slug} s3://#{fetch(:slug_s3_bucket)}/#{slug_file} --acl private --sse"
+        info "Slug: Uploaded #{slug_file}"
+      end
+    end
+
+  end
+end
+
+namespace :load do
+  task :defaults do
+
+    set :slug_storage_backend, 's3'
+    set :slug_s3_bucket, nil
+
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-slug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano tasks to make deployment artifacts
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-slug.gemspec
+- lib/capistrano/slug.rb
+- lib/capistrano/tasks/slug.rake
+- lib/capistrano/tasks/storage.rake
+homepage: https://github.com/rjocoleman/capistrano-slug
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Capistrano tasks to make deployment artifacts
+test_files: []