capistrano-dockerized 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c125d1e75888bd5908e7d9efe9f81a049f781f1d
+  data.tar.gz: a3168ddd8aaf10cce4177ee2b10a1d1a32595e6c
+SHA512:
+  metadata.gz: 8924e8844c5fea4811fd88ff169f2debd91701fa9a13bbb8c767da9b06b65a51de762d62eae01ea2e9c3a1ac2c3233cc8c93cb2d3d163c90796b64e95dd22a45
+  data.tar.gz: 73a4e850f24cade751b411df85493f087a1953bc24154e1ac6a1bb71583c03bcfc5d0ee694066e3383b4f9b69380c066946540597e437cc576fcc33fe10f45b8

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-dockerized (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-dockerized!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,70 @@
+# Capistrano::Dockerized
+
+Add tasks for capistrano to deploy with docker compose.
+
+## Installation
+
+Add this line to your Gemfile
+
+``` ruby
+gem 'capistrano-dockerized'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+
+``` bash
+$ gem install capistrano-dockerized
+```
+
+## Usage
+
+Add this line to your `Capfile`:
+
+``` ruby
+require 'capistrano/dockerized
+```
+
+## Options for deployment
+
+You can specify the following options in you `deploy.rb` script or the environment specific deploy file:
+
+* **dockerized_restart**: An array of services that should be restarted each deployment, if not specified dockerized will restart all services
+* **dockerized_web_service**: The web service that will be used to execute commands inside like `rake` or any interactive command from `dockerized:run`, default value: :web
+* **dockerized_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 :dockerized_restart, [:web]
+set :dockerized_web_service, :web
+set :dockerized_rake_tasks, ['db:migrate', 'assets:precompile']
+```
+
+## Defined Tasks
+
+```
+dockerized:build                # build docker-compose services
+dockerized:clean                # delete docker images that are not related to current build
+dockerized:down                 # shutdown all project services with docker-compose
+dockerized:rake_tasks           # execute a set of rake tasts inside the web container
+dockerized:restart              # restart services of docker-compose and if not services listed restart all services
+dockerized:run                  # run an interactive command inside the web container
+dockerized:up                   # boot up all docker-compose services
+```
+
+## 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:
+
+* `cap production dockerized:run rake db:setup`
+
+## General note
+
+* This gem doesn't provide a `dockerfile` nor `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-dockerized.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'capistrano/dockerized/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'capistrano-dockerized'
+  s.version     = Capistrano::Dockerized::VERSION
+  s.authors     = ['GV']
+  s.email       = ['']
+  s.homepage    = 'https://github.com/wadik/capistrano-dockerized'
+  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/dockerized.rb

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

data/lib/capistrano/dockerized/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Dockerized
+    VERSION = '0.1.0'
+  end
+end

data/lib/capistrano/tasks/dockerized.rake

@@ -0,0 +1,100 @@
+namespace :dockerized 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(:dockerized_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 -f $(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(:dockerized_rake_tasks)) if fetch(:dockerized_rake_tasks)
+      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 :dockerized_restart, fetch(:dockerized_restart, nil)
+      set :dockerized_web_service, fetch(:dockerized_web_service, :web)
+      set :dockerized_rake_tasks, fetch(:dockerized_rake_tasks, nil)
+    end
+  end
+
+  def docker_rake(*args)
+    docker_execute('run', '--rm', fetch(:dockerized_web_service), 'rake', *args)
+  end
+
+  def docker_execute(*args)
+    execute('docker-compose', "-p #{fetch :application}", *args)
+  end
+
+  def docker_execute_interactively(host, command)
+    user = host.user
+    port = fetch(:port) || 22
+    docker_run = "docker-compose -p #{fetch :application} run --rm #{fetch(:dockerized_web_service)} #{command}"
+    exec "ssh -l #{user} #{host} -p #{port} -t 'cd #{deploy_to}/current && #{docker_run}'"
+  end
+
+  after 'deploy:updated',   'dockerized:build'
+  after 'deploy:published', 'dockerized:rake_tasks'
+  after 'deploy:published', 'dockerized:restart'
+  after 'deploy:cleanup',   'dockerized:clean'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-dockerized
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-29 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:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- capistrano-dockerized.gemspec
+- lib/capistrano-dockerized.rb
+- lib/capistrano/dockerized.rb
+- lib/capistrano/dockerized/version.rb
+- lib/capistrano/tasks/dockerized.rake
+homepage: https://github.com/wadik/capistrano-dockerized
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin to deploy your application inside docker containers using
+  docker compose
+test_files: []