capistrano-sidekiq-docker 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 838a4bfdb70383fcb2048771e6634d4a5df1f8bf
+  data.tar.gz: 4023ec21c60ee13eec1dac9c42182522dbff4d1b
+SHA512:
+  metadata.gz: 85f4ec27b53c0870cec3909a4f80f66da2479b7abd72418aa598b65635f615f8adf4103c5cc8715e4c53db6034857f6811f3f6748061dd65b6287a95088e0029
+  data.tar.gz: b3eaf8411b484e9d8d05dcd51715e1bd546a8568a687cdcaab9c821afd33429f9f78a55252282775f44e67c49b8dd6efb4e05209507c2eb98ba099cb5e18da4e

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-sidekiq-docker.gemspec
+gemspec

data/README.md

@@ -0,0 +1,42 @@
+# Capistrano-sidekiq-docker
+
+Added capistrano support to deploy sidekiq on the docker containers.
+
+## Installation
+
+    gem 'capistrano-sidekiq-docker', group: :development
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+```ruby
+# Capfile
+require 'capistrano/sidekiq'
+```
+
+
+Configurable options:
+
+```ruby
+set :sidekiq_release_path, -> { nil }
+set :sidekiq_shared_path, -> { nil }
+set :sidekiq_pid, -> { File.join(fetch(:sidekiq_shared_path) || fetch(:shared_path), 'tmp', 'pids', 'sidekiq.pid') }
+set :sidekiq_role, -> { :app }
+set :sidekiq_processes, -> { 1 }
+set :sidekiq_user, -> { nil }
+set :sidekiq_docker_compose_file_path, -> { '/etc/docker/sidekiq/docker-compose.yml' }
+set :sidekiq_docker_env_options, -> { nil }
+set :sidekiq_docker_container_name, -> { nil }
+set :sidekiq_docker_image_name, -> { 'sidekiq' }
+```
+
+## 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-sidekiq-docker.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/sidekiq/docker/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'capistrano-sidekiq-docker'
+  spec.version = Capistrano::Sidekiq::Docker::VERSION
+  spec.authors = ['Vasu Adari']
+  spec.email = ['vasuakeel@gmail.com']
+  spec.summary = %q{Capistrano support to deploy sidekiq on docker}
+  spec.description = %q{Deploy sidekiq on docker}
+  spec.homepage = 'https://github.com/vasuadari/capistrano-sidekiq-docker'
+  spec.license = 'LGPL-3.0'
+
+  spec.required_ruby_version     = '>= 1.9.3'
+  spec.files = `git ls-files`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '>= 3.0'
+  spec.add_dependency 'sidekiq', '>= 3.4'
+end

data/lib/capistrano/sidekiq.rb

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

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

@@ -0,0 +1,7 @@
+module Capistrano
+  module Sidekiq
+    module Docker
+      VERSION = '0.1'
+    end
+  end
+end

data/lib/capistrano/tasks/sidekiq.rake

@@ -0,0 +1,167 @@
+namespace :load do
+  task :defaults do
+    set :sidekiq_default_hooks, -> { true }
+
+    set :sidekiq_release_path, -> { nil }
+    set :sidekiq_shared_path, -> { nil }
+    set :sidekiq_pid, -> { File.join(fetch(:sidekiq_shared_path) || fetch(:shared_path), 'tmp', 'pids', 'sidekiq.pid') }
+    set :sidekiq_role, -> { :app }
+    set :sidekiq_processes, -> { 1 }
+    set :sidekiq_user, -> { nil }
+    set :sidekiq_docker_compose_file_path, -> { '/etc/docker/sidekiq/docker-compose.yml' }
+    set :sidekiq_docker_env_options, -> { nil }
+    set :sidekiq_docker_container_name, -> { nil }
+    set :sidekiq_docker_image_name, -> { 'sidekiq' }
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_sidekiq_hooks do
+    invoke 'sidekiq:add_default_hooks' if fetch(:sidekiq_default_hooks)
+  end
+  after :publishing, :restart_sidekiq do
+    invoke 'sidekiq:restart' if fetch(:sidekiq_default_hooks)
+  end
+end
+
+namespace :sidekiq do
+  def for_each_process(reverse = false, &block)
+    pids = processes_pids
+    pids.reverse! if reverse
+    pids.each_with_index do |pid_file, idx|
+      within fetch(:sidekiq_release_path) do
+        yield(pid_file, idx)
+      end
+    end
+  end
+
+  def processes_pids
+    pids = []
+    sidekiq_roles = Array(fetch(:sidekiq_role))
+    sidekiq_roles.each do |role|
+      next unless host.roles.include?(role)
+      processes = fetch(:"#{ role }_processes") || fetch(:sidekiq_processes)
+      processes.times do |idx|
+        pids.push fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
+      end
+    end
+
+    pids
+  end
+
+  def pid_file_exists?(pid_file)
+    test(*("[ -f #{pid_file} ]").split(' '))
+  end
+
+  def stop_sidekiq(pid_file)
+    execute "docker exec -i #{fetch(:sidekiq_docker_container_name)} kill -TERM `cat #{pid_file}`"
+  end
+
+  def quiet_sidekiq(pid_file)
+    execute "docker exec -i #{fetch(:sidekiq_docker_container_name)} kill -USR1 `cat #{pid_file}`"
+  end
+
+  def start_sidekiq
+    execute "#{fetch(:sidekiq_docker_env_options)} docker-compose -f #{fetch(:sidekiq_docker_compose_file_path)} up -d"
+  end
+
+  def restart_sidekiq
+    execute "#{fetch(:sidekiq_docker_env_options)} docker-compose -f #{fetch(:sidekiq_docker_compose_file_path)} restart #{fetch(:sidekiq_docker_image_name)}"
+  end
+
+  task :add_default_hooks do
+    after 'deploy:starting', 'sidekiq:quiet'
+    after 'deploy:updated', 'sidekiq:stop'
+    after 'deploy:reverted', 'sidekiq:stop'
+    after 'deploy:published', 'sidekiq:start'
+  end
+
+  desc 'Quiet sidekiq (stop processing new tasks)'
+  task :quiet do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        if test("[ -d #{fetch(:sidekiq_release_path)} ]") # fixes #11
+          for_each_process(true) do |pid_file, idx|
+            if pid_file_exists?(pid_file)
+              quiet_sidekiq(pid_file)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Stop sidekiq'
+  task :stop do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        if test("[ -d #{fetch(:sidekiq_release_path)} ]")
+          for_each_process(true) do |pid_file, idx|
+            if pid_file_exists?(pid_file)
+              stop_sidekiq(pid_file)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        start_sidekiq
+      end
+    end
+  end
+
+  desc 'Restart sidekiq'
+  task :restart do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        restart_sidekiq
+      end
+    end
+  end
+
+  desc 'Rolling-restart sidekiq'
+  task :rolling_restart do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        restart_sidekiq
+      end
+    end
+  end
+
+  # Delete any pid file not in use
+  task :cleanup do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
+        for_each_process do |pid_file, idx|
+          if pid_file_exists?(pid_file)
+            execute "rm #{pid_file}" unless pid_file_exists?(pid_file)
+          end
+        end
+      end
+    end
+  end
+
+  def switch_user(role, &block)
+    su_user = sidekiq_user(role)
+    if su_user == role.user
+      block.call
+    else
+      as su_user do
+        block.call
+      end
+    end
+  end
+
+  def sidekiq_user(role)
+    properties = role.properties
+    properties.fetch(:sidekiq_user) ||               # local property for sidekiq only
+    fetch(:sidekiq_user) ||
+    properties.fetch(:run_as) || # global property across multiple capistrano gems
+    role.user
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-sidekiq-docker
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vasu Adari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Deploy sidekiq on docker
+email:
+- vasuakeel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- capistrano-sidekiq-docker.gemspec
+- lib/capistrano-sidekiq-docker.rb
+- lib/capistrano/.DS_Store
+- lib/capistrano/sidekiq.rb
+- lib/capistrano/sidekiq/.DS_Store
+- lib/capistrano/sidekiq/docker/version.rb
+- lib/capistrano/tasks/sidekiq.rake
+homepage: https://github.com/vasuadari/capistrano-sidekiq-docker
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Capistrano support to deploy sidekiq on docker
+test_files: []