capistrano-docker-compose 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 417530036951e12bdae99b9831027203d072d12b
-  data.tar.gz: cdaac309914c1549e288c9fec881eb3dfbdfb6de
+  metadata.gz: 3a78b926b2d20c381ed686e1ca9597e4578a3f4f
+  data.tar.gz: c42472026088ce99c022ae0b2771fb8331944ee3
 SHA512:
-  metadata.gz: 3430986a6503bf22c18f7f2a993075c782edd5d57368433b7ef49e7b606c7a958a773b0054fb6958321b2b7a6613bd5cf485151dcda0a5bacabd2b57b969c3ed
-  data.tar.gz: 600eb2f61fce082ba51569d7a8423fc086d7171b74921a8f01fd4f864fd203e8dd828bbad157911414742f16a55a6f3239656ac320ef8c2e01f23ab44fff175d
+  metadata.gz: 0f2ffacd8175a840f923c1b870fa7e30fcc7dc24ec393b2d16d0955ffb551a455fbd73f3f76b9c50cb3843ee73baa16145e733f54a80f7c198a74a0480ee0229
+  data.tar.gz: bbf5d000ad735710e747c716fb612bec5945013883e50e32881f688498bff6d07a32423825ac310deb2a73d4378e5358f96f5356ca910b3b4acb6bac89ca6a32

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 
 rvm:
-  - 2.3.1
+  - 2.3.3
+  - 2.4.0
 
 install:
   - bundle

data/README.md

@@ -2,13 +2,20 @@
 
 Docker Compose specific tasks for Capistrano allowing seamless zero downtime containerised deployments.
 
-## Requirements
+## Minimum requirements
 
 - Capistrano 3.5
 - Docker Engine 1.11
 - Docker Compose 1.7
 - HAProxy 1.6
 
+## Supported databases
+
+| Database    | Versions tested |
+| --------    | --------------- |
+| PostgreSQL  | 9.5             |
+| MariaDB     | 5.5             |
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,50 +34,76 @@ Or install it yourself as:
 
 ## Usage
 
-Create Docker Compose descriptors for each environment leaving `docker-compose.yml` as default for development environment, e.g.:
+1. Create Docker Compose descriptors for each environment leaving `docker-compose.yml` as default for development environment, e.g.:
 
   - `docker-compose.yml`
   - `docker-compose-staging.yml`
   - `docker-compose-production.yml`
 
-Make Compose YAML with `web` service using following environment variables:
+2. Make Compose YAML with `web` service (name is conventional) using following environment variables:
 
-- `CAP_DOCKER_COMPOSE_ROOT_PATH` for shared path
-- `CAP_DOCKER_COMPOSE_PORT` for port range
+  - `CAP_DOCKER_COMPOSE_ROOT_PATH` for shared path
+  - `CAP_DOCKER_COMPOSE_PORT` for port range
 
-See also [Compose YAML example](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/docker-compose-staging.example.yml).
+3. If you're using database service with migrations in Ruby on Rails, make sure to name database service as `db` (name is conventional). See also [Compose YAML example](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/docker-compose-staging.example.yml).
 
-Add `capistrano-docker-compose` to `Capfile`:
+4. Add `capistrano-docker-compose` to `Capfile`:
 
-``` ruby
-# Capfile
-require 'capistrano/docker/compose'
-```
+    ``` ruby
+    # Capfile
+    require 'capistrano/docker/compose'
+    ```
 
-Configure following Docker Compose specific options in `config/deploy.rb` and/or `config/deploy/<environment>.rb`:
+5. Configure following Docker Compose specific options in `config/deploy.rb` and/or `config/deploy/<environment>.rb`:
 
-```ruby
-# Define port range in respect to load balancer on server
-# If 2 or more environments reside on same server, configure port range as per environment
-# Ruby's Range object is expected, see http://ruby-doc.org/core-2.3.0/Range.html
-# Example: set :docker_compose_port_range, 2070..2071
-set :docker_compose_port_range, <port>..<port>
-
-# OPTIONAL
-# User name when running the Docker image (reflecting Docker's USER instruction)
-# Example: set :docker_compose_user, 'pioneer'
-set :docker_compose_user, '<username>'
-
-# OPTIONAL
-# Roles considered
-# Defaults to :all
-# Example: set :docker_compose_roles, :web
-set :docker_compose_roles, <roles>
-```
+    ```ruby
+    # Define port range in respect to load balancer on server
+    # If 2 or more environments reside on same server, configure port range as per environment
+    # Ruby's Range object is expected, see http://ruby-doc.org/core-2.3.0/Range.html
+    # Example: set :docker_compose_port_range, 2070..2071
+    set :docker_compose_port_range, <port>..<port>
+
+    # OPTIONAL
+    # User name when running the Docker image (reflecting Docker's USER instruction)
+    # Example: set :docker_compose_user, 'pioneer'
+    set :docker_compose_user, '<username>'
+
+    # OPTIONAL
+    # Roles considered
+    # Defaults to :all
+    # Example: set :docker_compose_roles, :web
+    set :docker_compose_roles, <roles>
+    ```
+
+6. Configure HAProxy load balancer with port range defined in `docker_compose_port_range`, see [example configuration](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/haproxy.example.cfg).
 
-Configure load balancer with port range defined in `docker_compose_port_range`, see [example configuration](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/haproxy.example.cfg).
+  NB! Ensure load balancer's HTTP health check uses Layer 7 and corresponds to the needs of the particular application.
 
-NB! Ensure load balancer's HTTP health check uses Layer 7 and corresponds to the needs of the particular application.
+### PHP projects
+
+To use `capistrano-docker-compose` on PHP project, such as Wordpress or Drupal:
+
+1. Add `Gemfile` to project root:
+
+	```ruby
+	# Gemfile
+	source 'https://rubygems.org'
+
+	group :capistrano do
+		gem 'capistrano-bundler'
+		gem 'capistrano-docker-compose'
+	end
+	```
+2. Run `bundle` to install
+
+If bundling is not desired during deployment (no RubyGems dependencies), Capistrano flow can be altered by removing bundler task:
+
+```ruby
+# config/deploy.rb
+namespace :deploy do
+  Rake::Task["bundler:install"].clear_actions
+end
+```
 
 ## Contributing
 
@@ -78,4 +111,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/intera
 
 ## Licence
 
-Copyright © 2016 Ain Tohvri, Interactive Pioneers GmbH. Licenced under [GPL-3](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/LICENSE).
+Copyright © 2016, 2017 Ain Tohvri, Interactive Pioneers GmbH. Licenced under [GPL-3](https://github.com/interactive-pioneers/capistrano-docker-compose/blob/master/LICENSE).

data/capistrano-docker-compose.gemspec

@@ -20,8 +20,4 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 2.0"
 
   spec.add_dependency 'capistrano', '~> 3.5'
-
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/capistrano/docker/compose/version.rb

@@ -1,7 +1,7 @@
 module Capistrano
   module Docker
     module Compose
-      VERSION = "0.1.8"
+      VERSION = "0.1.9"
     end
   end
 end

data/lib/capistrano/docker/tasks/compose.rake

@@ -25,7 +25,7 @@ namespace :deploy do
         with cap_docker_compose_root_path: fetch(:deploy_to), cap_docker_compose_port: detect_available_port do
           execute :'docker-compose', '-f', "docker-compose-#{fetch(:rails_env)}.yml", 'up', '-d'
           # Give services 3s to come up
-          # TODO: implement flexibly into options
+          # TODO: implement flexibly into options as timeout
           sleep 3
         end
       end
@@ -46,24 +46,13 @@ namespace :deploy do
   task :purge_old_containers do
     on roles(fetch(:docker_compose_roles)) do
       if fetch(:previous_release_path, false)
-        info "Purging previous release containers at #{fetch(:previous_release_path)}"
-
-        release_name = Pathname.new(release_path).basename.to_s
-        web_container_id = capture("docker ps -q --filter 'name=#{release_name}_web'")
-        execute :docker, 'pause', web_container_id
-
         within fetch(:previous_release_path) do
-          execute :'docker-compose', 'down'
+          containers = capture :'docker-compose', 'ps', '-q'
+          unless containers.empty?
+            info "Purging containers of previous release at #{fetch(:previous_release_path)}"
+            execute :'docker-compose', 'down'
+          end
         end
-
-        db_container_id = capture("docker ps -q --filter 'name=#{release_name}_db'")
-        execute :docker, 'restart', db_container_id
-
-        # Give services 3s to come up
-        # TODO: implement flexibly into options
-        sleep 3
-
-        execute :docker, 'unpause', web_container_id
       end
     end
   end
@@ -72,8 +61,30 @@ namespace :deploy do
     set :cap_docker_compose_failed, true
     on roles(fetch(:docker_compose_roles)) do
       within release_path do
+        info "Purging failed containers at #{release_path}"
         execute :'docker-compose', 'down'
       end
+      within fetch(:previous_release_path) do
+        containers = capture :'docker-compose', 'ps', '-q'
+        unless containers.empty?
+          info "Restarting containers of previous release"
+          execute :'docker-compose', 'start'
+        end
+      end
+    end
+  end
+
+  task :stop_previous_release do
+    on roles(fetch(:docker_compose_roles)) do
+      if fetch(:previous_release_path, false)
+        within fetch(:previous_release_path) do
+          containers = capture :'docker-compose', 'ps', '-q'
+          unless containers.empty?
+            info "Stopping containers of previous release"
+            execute :'docker-compose', 'stop'
+          end
+        end
+      end
     end
   end
 
@@ -100,6 +111,7 @@ namespace :deploy do
 
   after :updating, :pull_images
   after :updating, :start_containers
+  before :migrate, :stop_previous_release
   before :publishing, :claim_files_by_container
   before :failed, :claim_files_by_container
   after :failed, :purge_failed_containers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-docker-compose
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Ain Tohvri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,48 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: Docker Compose specific tasks for Capistrano allowing seamless zero downtime
   containerised deployments.
 email: