capistrano-decompose 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 982e23a46591cd5584c87a1396f53a4ccd176d94
+  data.tar.gz: ba306eae0a21a5da1b05bc7e4021be83c1baea8a
+SHA512:
+  metadata.gz: 5a3af8ccc36f021f2815b60bdf5dd01108ef44a34f3ebb229bf7b43018efe8a1809f5aeee2552b926dc077f5a1860a8323ff5a865ed05e55e54ec8bff5fa95a1
+  data.tar.gz: 6f8704eac3994023b425e50626d26b7d9382617fbdf66e79749ec4e29d090031efcf1f38d5e2625358531df052e67fd46ea32478d52e3d4ad49e5323b8838273

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.DS_Store

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    capistrano-decompose (0.1)
+      capistrano (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.0.2)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.5.0)
+      airbrussh (>= 1.0.0)
+      capistrano-harrow
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-harrow (0.5.1)
+    i18n (0.7.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.1.1)
+    rake (11.1.2)
+    sshkit (1.10.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano-decompose!
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Emad Elsaid
+
+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,67 @@
+# Capistrano::Decompose
+
+Add tasks for capistrano to deploy with docker-compose.
+
+## How it works
+
+after capistrano pull your repo and link it to the `current` directory, decompose will invoke `docker-compose build` to build your images and then run some rake tasks that you configured in your deployment with the key `decompose_rake_tasks`, you can add your rails tasks like `db:migration`, `assets:precompile`...etc here, then it will invoke `docker-compose up` or restart only the web service you specified in key `decompose_restart`, also you can use `cap <env> decompose:run` to run any command inside a service, so anytime you need to invoke `rails console` inside you docker image on your server you can use `cap production decompose:run rails console`.
+
+at the end decompose will delete the older images from remote server to keep the server clean.
+
+## Installation
+
+add this line to your Gemfile
+
+``` ruby
+gem 'capistrano-decompose'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+
+``` bash
+$ gem install capistrano-decompose
+```
+
+## Usage
+
+Add this line to your `Capfile`:
+
+``` ruby
+require 'capistrano/decompose
+```
+
+## Options for deployment
+
+you can specify the following options in you `deploy.rb` script or the environment specific deploy file:
+
+``` ruby
+decompose_restart: an array of services that should be restarted each deployment, if not specified decompose will restart all services
+decompose_web_service: the web service that will be used to execute commands inside like `rake` or any interactive command from `decompose:run`, default value: :web
+decompose_rake_tasks: a set of rake tasks to execute after each deploy, default value is `nil`
+```
+
+for a typical rails application the previous options should be as follows, given that the application container service name is `web`:
+
+```ruby
+set :decompose_restart, [:web]
+set :decompose_web_service, :web
+set :docker_rake_tasks, ['db:migrate', 'assets:precompile']
+```
+
+## after the first deployment of a rails application
+
+you would need to setup your database by invoking the `db:setup` task to create and seed your database, you can do that using 2 ways
+
+* `cap production decompose:db_setup`
+* `cap production decompose:run rake db:setup`
+
+## General note
+
+* this gem doesn't provide a `dockerfile` or `docker-compose.yml` file, you have to create these files yourself
+* the linked directories and files will not work and you should use docker data volumes anyway

data/Rakefile

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

data/capistrano-decompose.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'capistrano/decompose/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'capistrano-decompose'
+  s.version     = Capistrano::Decompose::VERSION
+  s.authors     = ['Emad Elsaid']
+  s.email       = ['blazeeboy@gmail.com']
+  s.homepage    = 'https://github.com/blazeeboy/capistrano-decompose'
+  s.summary     = 'Capistrano plugin to deploy your application inside docker containers using docker compose'
+  s.description = 'Capistrano plugin to deploy your application inside docker containers using docker compose'
+  s.license     = 'MIT'
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ['lib']
+
+  s.add_dependency 'capistrano', '~> 3.5'
+end

data/lib/capistrano/decompose.rb

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

data/lib/capistrano/decompose/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Decompose
+    VERSION = '0.1'
+  end
+end

data/lib/capistrano/tasks/decompose.rake

@@ -0,0 +1,109 @@
+namespace :decompose do
+
+  desc 'build docker-compose services'
+  task :build do
+    on roles(:app) do
+      within release_path do
+        docker_execute :build
+      end
+    end
+  end
+
+  desc 'shutdown all project services with docker-compose'
+  task :down do
+    on roles(:app) do
+      within release_path do
+        docker_execute :down
+      end
+    end
+  end
+
+  desc 'boot up all docker-compose services'
+  task :up do
+    on roles(:app) do
+      within release_path do
+        docker_execute :up, '-d'
+      end
+    end
+  end
+
+  desc 'restart services of docker-compose and if not services listed restart all services'
+  task :restart do
+    on roles(:app) do
+      within release_path do
+        services = Array(fetch(:decompose_restart))
+        if services.empty?
+          docker_execute :down
+          docker_execute :up
+        else
+          docker_execute :stop, *services
+          docker_execute :up, '-d', *services
+        end
+      end
+    end
+  end
+
+  desc 'delete docker images that are not related to current build'
+  task :clean do
+    on roles(:app) do
+      within release_path do
+        images_to_delete = capture('docker images -f "dangling=true" -q')
+        execute 'docker rmi $(docker images -f "dangling=true" -q)' unless images_to_delete.empty?
+      end
+    end
+  end
+
+  desc 'execute a set of rake tasts inside the web container'
+  task :rake_tasks do
+    on roles(:app) do
+      within release_path do
+        docker_rake(*fetch(:decompose_rake_tasks)) if fetch(:decompose_rake_tasks)
+      end
+    end
+  end
+
+  desc 'execute rake db:setup inside the web container'
+  task :db_setup do
+    on roles(:app) do
+      within release_path do
+        docker_rake('db:setup')
+      end
+    end
+  end
+
+  desc 'run an interactive command inside the web container'
+  task :run do
+    on roles(:app) do |host|
+      command = ARGV[2..-1].join(' ')
+      docker_execute_interactively host, command
+    end
+  end
+
+  namespace :load do
+    task :defaults do
+      set :decompose_restart, fetch(:decompose_restart, nil)
+      set :decompose_web_service, fetch(:decompose_web_service, :web)
+      set :decompose_rake_tasks, fetch(:decompose_rake_tasks, nil)
+    end
+  end
+
+  def docker_rake(*args)
+    docker_execute('run', '--rm', fetch(:decompose_web_service), 'rake', *args)
+  end
+
+  def docker_execute(*args)
+    execute('docker-compose', "--project-name #{fetch :application}", *args)
+  end
+
+  def docker_execute_interactively(host, command)
+    user = host.user
+    port = fetch(:port) || 22
+    docker_run = "docker-compose --project-name #{fetch :application} run --rm web #{command}"
+    exec "ssh -l #{user} #{host} -p #{port} -t 'cd #{deploy_to}/current && #{docker_run}'"
+  end
+
+  after 'deploy:updated', 'decompose:build'
+  after 'deploy:published', 'decompose:rake_tasks'
+  after 'deploy:published', 'decompose:restart'
+  after 'deploy:cleanup', 'decompose:clean'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-decompose
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Emad Elsaid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Capistrano plugin to deploy your application inside docker containers
+  using docker compose
+email:
+- blazeeboy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- capistrano-decompose.gemspec
+- lib/capistrano-decompose.rb
+- lib/capistrano/decompose.rb
+- lib/capistrano/decompose/version.rb
+- lib/capistrano/tasks/decompose.rake
+homepage: https://github.com/blazeeboy/capistrano-decompose
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin to deploy your application inside docker containers using
+  docker compose
+test_files: []
+has_rdoc: