capistrano-sidekiq 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f252aeda1b342db98d4e78c48a596f62a08854b
-  data.tar.gz: c8b03baafafcee0e6dc3ee5299a15684f8752c7e
+  metadata.gz: 48c5d99cac41dcbb290d8d230db6ca3ea78d4390
+  data.tar.gz: 3b715312a4ab804f6a512cc85dbb532b5275a64c
 SHA512:
-  metadata.gz: ee796988057a1bb571c48366007131c778f70dbc20f0e2d64b7660e17144584d32a403f0a914aa4ead634d5b5d0f7fe3227d9aabb8decae26f229a723afc5f82
-  data.tar.gz: 94d89cd024d5fc60cdccd529bf8bc2195c4bf8bbf654204d2117e1147ded1e63d1a4111df9a504aca771161419e11965cb5dac7279277b3e84d214a27d194124
+  metadata.gz: e74d344619f3f9adca9b6f81cdd58c9a8ceba9332f06c5b33d06d50cec57f83c7e45e357582b9ba5a9497987ad6b89aa16b044706dcff848568255fcae158407
+  data.tar.gz: 1cb59160d9c6b1fc20c6645f12ce1b3272f82c6ea4e364d0f5cf979c4eeae7253ab6cba40cf8be96e8e73808bfb391a3f2b74b04c4bfeb16034be1e3e82fbb95

data/README.md

@@ -9,11 +9,11 @@ Sidekiq integration for Capistrano
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-sidekiq' , github: 'seuros/capistrano-sidekiq'
+    gem 'capistrano-sidekiq', github: 'seuros/capistrano-sidekiq'
 
 or:
 
-    gem 'capistrano-sidekiq' , group: :development
+    gem 'capistrano-sidekiq', group: :development
 
 And then execute:
 
@@ -32,20 +32,22 @@ And then execute:
 Configurable options, shown here with defaults:
 
 ```ruby
-    :sidekiq_default_hooks =>  true
-    :sidekiq_pid =>  File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid')
-    :sidekiq_env =>  fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
-    :sidekiq_log =>  File.join(shared_path, 'log', 'sidekiq.log')
-    :sidekiq_options =>  nil
+    :sidekiq_default_hooks => true
+    :sidekiq_pid => File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid')
+    :sidekiq_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
+    :sidekiq_log => File.join(shared_path, 'log', 'sidekiq.log')
+    :sidekiq_options => nil
     :sidekiq_require => nil
     :sidekiq_tag => nil
     :sidekiq_config => nil
     :sidekiq_queue => nil
-    :sidekiq_timeout =>  10
-    :sidekiq_role =>  :app
-    :sidekiq_processes =>  1
+    :sidekiq_timeout => 10
+    :sidekiq_role => :app
+    :sidekiq_processes => 1
+    :sidekiq_options_per_process => nil
     :sidekiq_concurrency => nil
-    :sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq"  # Only for capistrano2.5
+    :sidekiq_monit_templates_path => 'config/deploy/templates'
+    :sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq" # Only for capistrano2.5
     :sidekiqctl_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" # Only for capistrano2.5
 ```
 
@@ -53,7 +55,31 @@ There is a known bug that prevents sidekiq from starting when pty is true
 ```ruby
 set :pty,  false
 ```
+
+## Multiple processes
+
+You can configure sidekiq to start with multiple processes. Just set the proper amount in `sidekiq_processes`.
+
+You can also customize the configuration for every process. If you want to do that, just set
+`sidekiq_options_per_process` with an array of the configuration options that you want in string format.
+This example should boot the first process with the queue `high` and the second one with the queues `default`
+and `low`:
+
+```ruby
+set :sidekiq_options_per_process, ["--queue high", "--queue default --queue low"]
+```
+
+## Customizing the monit sidekiq templates
+
+If you need change some config in redactor, you can
+
+```
+    bundle exec rails generate capistrano:sidekiq:monit:template
+
+```
+
 ## Changelog
+- 0.5.0: Multiple processes @mrsimo
 - 0.3.9: Restore daemon flag from Monit template
 - 0.3.8:
         * Update monit template: use su instead of sudo / permit all Sidekiq options @bensie
@@ -64,7 +90,7 @@ set :pty,  false
 - 0.3.5: Added :sidekiq_tag for capistrano2 @OscarBarrett
 - 0.3.4: fix bug in sidekiq:start for capistrano 2 task
 - 0.3.3: sidekiq:restart after deploy:restart added to default hooks
-- 0.3.2: :sidekiq_queue accept an array 
+- 0.3.2: :sidekiq_queue accept an array
 - 0.3.1: Fix logs @rottman, add concurrency option support @ungsophy
 - 0.3.0: Fix monit task @andreygerasimchuk
 - 0.2.9: Check if current directory exist @alexdunae

data/lib/capistrano/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Sidekiq
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/capistrano/tasks/capistrano2.rb

@@ -7,7 +7,9 @@ Capistrano::Configuration.instance.load do
   _cset(:sidekiq_tag) { nil }
   _cset(:sidekiq_log) { File.join(shared_path, 'log', 'sidekiq.log') }
 
+  _cset(:sidekiq_config) { "#{current_path}/config/sidekiq.yml" }
   _cset(:sidekiq_options) { nil }
+  _cset(:sidekiq_queue) { nil }
 
   _cset(:sidekiq_cmd) { "#{fetch(:bundle_cmd, 'bundle')} exec sidekiq" }
   _cset(:sidekiqctl_cmd) { "#{fetch(:bundle_cmd, 'bundle')} exec sidekiqctl" }
@@ -15,6 +17,7 @@ Capistrano::Configuration.instance.load do
   _cset(:sidekiq_timeout) { 10 }
   _cset(:sidekiq_role) { :app }
   _cset(:sidekiq_processes) { 1 }
+  _cset(:sidekiq_options_per_process) { nil }
 
   if fetch(:sidekiq_default_hooks)
     before 'deploy:update_code', 'sidekiq:quiet'
@@ -50,6 +53,15 @@ Capistrano::Configuration.instance.load do
       args.push "--environment #{fetch(:sidekiq_env)}"
       args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
       args.push "--logfile #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
+      args.push "--config #{fetch(:sidekiq_config)}" if fetch(:sidekiq_config)
+      fetch(:sidekiq_queue).each do |queue|
+        args.push "--queue #{queue}"
+      end if fetch(:sidekiq_queue)
+
+      if process_options = fetch(:sidekiq_options_per_process)
+        args.push process_options[idx]
+      end
+
       args.push fetch(:sidekiq_options)
 
       if defined?(JRUBY_VERSION)

data/lib/capistrano/tasks/monit.cap

@@ -18,16 +18,26 @@ namespace :sidekiq do
   namespace :monit do
 
     task :add_default_hooks do
-      after 'deploy:check',       'sidekiq:monit:unmonitor'
-      after  'deploy:publishing', 'sidekiq:monit:monitor'
+      before 'deploy:updating',  'sidekiq:monit:unmonitor'
+      after  'deploy:published', 'sidekiq:monit:monitor'
     end
 
     desc 'Config Sidekiq monit-service'
     task :config do
       on roles(fetch(:sidekiq_role)) do |role|
         @role = role
-        template_sidekiq 'sidekiq_monit.conf', "#{fetch(:tmp_dir)}/monit.conf", @role
-        sudo "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:sidekiq_monit_conf_dir)}/#{sidekiq_service_name}.conf"
+        template_sidekiq 'sidekiq_monit', "#{fetch(:tmp_dir)}/monit.conf", @role
+
+        mv_command = "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:sidekiq_monit_conf_dir)}/#{sidekiq_service_name}.conf"
+
+        # Try execute in case the deploy user doesn't have sudo to mv
+        begin
+          execute mv_command
+        rescue
+          sudo mv_command
+        end
+
+        sudo "#{fetch(:monit_bin)} reload"
       end
     end
 
@@ -35,7 +45,12 @@ namespace :sidekiq do
     task :monitor do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
-          sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
+          begin
+            sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
+          rescue
+            invoke 'sidekiq:monit:config'
+            sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
+          end
         end
       end
     end
@@ -44,7 +59,11 @@ namespace :sidekiq do
     task :unmonitor do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
-          sudo "#{fetch(:monit_bin)} unmonitor #{sidekiq_service_name(idx)}"
+          begin
+            sudo "#{fetch(:monit_bin)} unmonitor #{sidekiq_service_name(idx)}"
+          rescue
+            # no worries here
+          end
         end
       end
     end

data/lib/capistrano/tasks/sidekiq.cap

@@ -8,9 +8,12 @@ namespace :load do
     set :sidekiq_timeout, -> { 10 }
     set :sidekiq_role, -> { :app }
     set :sidekiq_processes, -> { 1 }
+    set :sidekiq_options_per_process, -> { nil }
     # Rbenv and RVM integration
     set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w(sidekiq sidekiqctl))
     set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w(sidekiq sidekiqctl))
+
+    set :sidekiq_monit_templates_path, -> { 'config/deploy/templates' }
   end
 end
 
@@ -92,6 +95,9 @@ namespace :sidekiq do
     end
     args.push "--config #{fetch(:sidekiq_config)}" if fetch(:sidekiq_config)
     args.push "--concurrency #{fetch(:sidekiq_concurrency)}" if fetch(:sidekiq_concurrency)
+    if process_options = fetch(:sidekiq_options_per_process)
+      args.push process_options[idx]
+    end
     # use sidekiq_options for special options
     args.push fetch(:sidekiq_options) if fetch(:sidekiq_options)
 
@@ -180,8 +186,8 @@ namespace :sidekiq do
     end
   end
 
-  # TODO : Don't start if all proccess are off, raise warning.
-  desc 'Respawn missing sidekiq proccesses'
+  # TODO : Don't start if all processes are off, raise warning.
+  desc 'Respawn missing sidekiq processes'
   task :respawn do
     invoke 'sidekiq:cleanup'
     on roles fetch(:sidekiq_role) do
@@ -195,14 +201,16 @@ namespace :sidekiq do
 
   def template_sidekiq(from, to, role)
     [
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}-#{fetch(:stage)}.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{fetch(:stage)}.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.rb.erb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.erb"),
-        File.expand_path("../../templates/#{from}.rb.erb", __FILE__),
-        File.expand_path("../../templates/#{from}.erb", __FILE__)
+        "#{fetch(:sidekiq_monit_templates_path)}/#{from}.erb",
+        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}-#{fetch(:stage)}.conf.rb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}-#{fetch(:stage)}.conf.rb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}.conf.rb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}-#{fetch(:stage)}.conf.rb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}.conf.rb.erb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}.conf.rb"),
+        File.join('lib', 'capistrano', 'templates', "#{from}.conf.erb"),
+        File.expand_path("../../../generators/capistrano/sidekiq/monit/templates/#{from}.conf.rb.erb", __FILE__),
+        File.expand_path("../../../generators/capistrano/sidekiq/monit/templates/#{from}.conf.erb", __FILE__)
     ].each do |path|
       if File.file?(path)
         erb = File.read(path)

data/lib/generators/capistrano/sidekiq/monit/template_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module Capistrano
+  module Sidekiq
+    module Monit
+      module Generators
+        class TemplateGenerator < Rails::Generators::Base
+
+          namespace "capistrano:sidekiq:monit:template"
+          desc "Create local monitrc.erb, and erb files for monitored processes for customization"
+          source_root File.expand_path('../templates', __FILE__)
+          argument :templates_path, type: :string,
+            default: "config/deploy/templates",
+            banner: "path to templates"
+
+          def copy_template
+            copy_file "sidekiq_monit.conf.erb", "#{templates_path}/sidekiq_monit.erb"
+          end
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -58,7 +58,8 @@ files:
 - lib/capistrano/tasks/capistrano2.rb
 - lib/capistrano/tasks/monit.cap
 - lib/capistrano/tasks/sidekiq.cap
-- lib/capistrano/templates/sidekiq_monit.conf.erb
+- lib/generators/capistrano/sidekiq/monit/template_generator.rb
+- lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sidekiq integration for Capistrano