capistrano-sidekiq 2.0.0.beta1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 115e140182e27990ccdc85a27c67a2788c4d74724edff94e4786318a0fe5d05c
-  data.tar.gz: d0adf318dc8d25845d00d0601b383b54be2327da37cd1e791ac767492b2b55d9
+  metadata.gz: 1c3bd1a14a2effd1ef907aaab6d7cb391d25d5125ec22d7ff338f0e98e475e28
+  data.tar.gz: f8a97dcfe1ecdbfecf0ad5ffbb90df8cf5653a4b67f3e6e745cfc91a295c546e
 SHA512:
-  metadata.gz: 56b1fcd34fa970a62c517016551fa7e68193c35f9c3187e8abbfbffbd7adf3ad2e2766b98ff5b5dbff67d982de8adb687aec4657f70d1a7583f3f89feff2e5fd
-  data.tar.gz: d6e43d4fce3e9812b62449bc029820b856742ae8f8aed458bbf461c88984725b02987161964ec432935a5d1f9a58c15bc67ded351f5aea242890f5b34597ce35
+  metadata.gz: 776cc57678b6b04bb80f94470c90cf7690b44a0cea4ead9abb543c99726104ad2218c87308ba273f7304defd0fe6e61a14bbb1c7b1edb003a8012abb58f7f135
+  data.tar.gz: 0fb423476f90dbece2f3107196392e168b9bfd17e47eef25a94a47fb1f34dab4bb839317aa2f30c1b8acc2d7c23a76e35f7477567c1417d52f111900fd9759ca

data/README.md

@@ -37,6 +37,12 @@ Configurable options, shown here with defaults:
 :sidekiq_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
 :sidekiq_log => File.join(shared_path, 'log', 'sidekiq.log')
 
+# sidekiq systemd options
+:sidekiq_service_unit_name => 'sidekiq'
+:sidekiq_service_unit_user => :user # :system
+:sidekiq_enable_lingering => true
+:sidekiq_lingering_user => nil
+
 # sidekiq monit
 :sidekiq_monit_templates_path => 'config/deploy/templates'
 :sidekiq_monit_conf_dir => '/etc/monit/conf.d'

data/lib/capistrano/sidekiq.rb

@@ -13,6 +13,7 @@ module Capistrano
       set_if_empty :sidekiq_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:rake_env, fetch(:stage)))) }
       set_if_empty :sidekiq_roles, fetch(:sidekiq_role, :app)
       set_if_empty :sidekiq_log, -> { File.join(shared_path, 'log', 'sidekiq.log') }
+      set_if_empty :sidekiq_error_log, -> { File.join(shared_path, 'log', 'sidekiq.error.log') }
       # Rbenv, Chruby, and RVM integration
       append :rbenv_map_bins, 'sidekiq', 'sidekiqctl'
       append :rvm_map_bins, 'sidekiq', 'sidekiqctl'

data/lib/capistrano/sidekiq/systemd.rb

@@ -3,6 +3,8 @@ module Capistrano
     def set_defaults
       set_if_empty :sidekiq_service_unit_name, 'sidekiq'
       set_if_empty :sidekiq_service_unit_user, :user # :system
+      set_if_empty :sidekiq_enable_lingering, true
+      set_if_empty :sidekiq_lingering_user, nil
     end
 
     def define_tasks

data/lib/capistrano/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  SidekiqVERSION = '2.0.0.beta1'
+  SidekiqVERSION = '2.0.0'
 end

data/lib/capistrano/tasks/systemd.rake

@@ -49,6 +49,7 @@ namespace :sidekiq do
           execute :sudo, :systemctl, "enable", fetch(:sidekiq_service_unit_name)
         else
           execute :systemctl, "--user", "enable", fetch(:sidekiq_service_unit_name)
+          execute :loginctl, "enable-linger", fetch(:sidekiq_lingering_user) if fetch(:sidekiq_enable_lingering)
         end
       end
     end
@@ -112,7 +113,7 @@ namespace :sidekiq do
       backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
       backend.execute :sudo, :systemctl, "daemon-reload"
     else
-      backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
+      backend.execute :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
       backend.execute :systemctl, "--user", "daemon-reload"
     end
   end
@@ -122,7 +123,7 @@ namespace :sidekiq do
     if su_user != role.user
       yield
     else
-      as su_user do
+      backend.as su_user do
         yield
       end
     end

data/lib/capistrano/tasks/upstart.rake

@@ -1,9 +1,13 @@
+git_plugin = self
+
+SUPPRESS_FAILURE = %w[|| echo NO_RUNNING_INSTANCE].freeze
+
 namespace :sidekiq do
   desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
   task :quiet do
     on roles fetch(:sidekiq_roles) do |role|
       git_plugin.switch_user(role) do
-        sudo :service, fetch(:sidekiq_service_unit_name), :reload
+        sudo :service, fetch(:sidekiq_service_unit_name), :reload, *SUPPRESS_FAILURE
       end
     end
   end
@@ -12,7 +16,7 @@ namespace :sidekiq do
   task :stop do
     on roles fetch(:sidekiq_roles) do |role|
       git_plugin.switch_user(role) do
-        sudo :service, fetch(:sidekiq_service_unit_name), :stop
+        sudo :service, fetch(:sidekiq_service_unit_name), :stop, *SUPPRESS_FAILURE
       end
     end
   end
@@ -26,6 +30,74 @@ namespace :sidekiq do
     end
   end
 
+  desc 'Install upstart sidekiq service'
+  task :install do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        git_plugin.create_upstart_template
+      end
+    end
+  end
+
+  desc 'UnInstall upstart sidekiq service'
+  task :uninstall do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        execute :rm, '-f', File.join(fetch(:service_unit_path, fetch_upstart_unit_path), fetch(:sidekiq_service_unit_name))
+      end
+    end
+  end
+
+  desc 'Generate service_locally'
+  task :generate_service_locally do
+    run_locally do
+      File.write('sidekiq.conf', git_plugin.compiled_template)
+    end
+  end
+
+  def fetch_upstart_unit_path
+    if fetch(:sidekiq_service_unit_user) == :system
+      # if the path is not standard `set :service_unit_path`
+      "/etc/init"
+    else
+      home_dir = backend.capture :pwd
+      File.join(home_dir, '.config', 'upstart')
+    end
+  end
+
+  def compiled_template
+    search_paths = [
+      File.expand_path(
+        File.join(*%w[.. .. .. generators capistrano sidekiq upstart templates sidekiq.conf.erb]),
+        __FILE__
+      ),
+    ]
+    template_path = search_paths.detect { |path| File.file?(path) }
+    template = File.read(template_path)
+    ERB.new(template).result(binding)
+  end
+
+  def create_upstart_template
+    ctemplate = compiled_template
+    upstart_path = fetch(:service_unit_path, fetch_upstart_unit_path)
+
+    if fetch(:sidekiq_service_unit_user) != :system
+      backend.execute :mkdir, "-p", upstart_path
+    end
+    conf_filename = "#{fetch :sidekiq_service_unit_name}.conf"
+    backend.upload!(
+      StringIO.new(ctemplate),
+      "/tmp/#{conf_filename}"
+    )
+    if fetch(:sidekiq_service_unit_user) == :system
+      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
+      backend.execute :sudo, :initctl,  'reload-configuration'
+    else
+      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
+      #backend.execute :sudo, :initctl,  'reload-configuration' #TODO
+    end
+  end
+
   def switch_user(role)
     su_user = sidekiq_user(role)
     if su_user == role.user
@@ -37,11 +109,38 @@ namespace :sidekiq do
     end
   end
 
-  def sidekiq_user(role)
-    properties = role.properties
-    properties.fetch(:sidekiq_user) || # local property for sidekiq only
+  def sidekiq_user(role = nil)
+    if role.nil?
+      fetch(:sidekiq_user)
+    else
+      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
+
+  def num_workers
+    fetch(:sidekiq_upstart_num_workers, nil)
+  end
+
+  def sidekiq_config
+    if fetch(:sidekiq_config)
+      "--config #{fetch(:sidekiq_config)}"
+    end
+  end
+
+  def sidekiq_concurrency
+    if fetch(:sidekiq_concurrency)
+      "--concurrency #{fetch(:sidekiq_concurrency)}"
+    end
+  end
+
+  def sidekiq_queues
+    Array(fetch(:sidekiq_queue)).map do |queue|
+      "--queue #{queue}"
+    end.join(' ')
+  end
+
 end

data/lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb

@@ -5,12 +5,18 @@ After=syslog.target network.target
 [Service]
 Type=simple
 WorkingDirectory=<%= File.join(fetch(:deploy_to), 'current') %>
-ExecStart=<%= SSHKit.config.command_map[:bundler] %> exec sidekiq -e <%= fetch(:sidekiq_env) %> -l <%= fetch(:sidekiq_log) %>
+ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %>
 ExecReload=/bin/kill -TSTP $MAINPID
 ExecStop=/bin/kill -TERM $MAINPID
+<%="StandardOutput=append:#{fetch(:sidekiq_log)}" if fetch(:sidekiq_log) %>
+<%="StandardError=append:#{fetch(:sidekiq_error_log)}" if fetch(:sidekiq_error_log) %>
 <%="User=#{sidekiq_user}" if sidekiq_user %>
 <%="EnvironmentFile=#{fetch(:sidekiq_service_unit_env_file)}" if fetch(:sidekiq_service_unit_env_file) %>
 
+<% fetch(:sidekiq_service_unit_env_vars, []).each do |environment_variable| %>
+  <%="Environment=#{environment_variable}" %>
+<% end %>
+
 RestartSec=1
 Restart=on-failure
 

data/lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb

@@ -0,0 +1,78 @@
+# /etc/init/sidekiq.conf - Sidekiq config | https://github.com/mperham/sidekiq/blob/master/examples/upstart/sidekiq.conf
+
+# This example config should work with Ubuntu 12.04+.  It
+# allows you to manage multiple Sidekiq instances with
+# Upstart, Ubuntu's native service management tool.
+#
+# See workers.conf for how to manage all Sidekiq instances at once.
+#
+# Save this config as /etc/init/sidekiq.conf then manage sidekiq with:
+#   sudo start <%= fetch(:sidekiq_service_unit_name) %> index=0
+#   sudo stop <%= fetch(:sidekiq_service_unit_name) %> index=0
+#   sudo status <%= fetch(:sidekiq_service_unit_name) %> index=0
+#
+# Hack Upstart's reload command to 'quiet' Sidekiq:
+#
+#   sudo reload <%= fetch(:sidekiq_service_unit_name) %> index=0
+#
+# or use the service command:
+#   sudo service <%= fetch(:sidekiq_service_unit_name) %> {start,stop,restart,status}
+#
+
+description "Sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>"
+
+# This script is not meant to start on bootup, workers.conf
+# will start all sidekiq instances explicitly when it starts.
+#start on runlevel [2345]
+#stop on runlevel [06]
+<% if sidekiq_user %>
+
+# change to match your deployment user
+setuid <%= sidekiq_user %>
+setgid <%= sidekiq_user %>
+env HOME=/home/<%= sidekiq_user %>
+<% end %>
+
+# Greatly reduce Ruby memory fragmentation and heap usage
+# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
+env MALLOC_ARENA_MAX=2
+
+respawn
+respawn limit 3 30
+
+# TERM is used when stopping sidekiq. Without declaring these as
+# normal exit codes, it just respawns.
+normal exit 0 TERM
+
+# Older versions of Upstart might not support the reload command and need
+# this commented out.
+reload signal TSTP
+
+# Upstart waits 5 seconds by default to kill a process. Increase timeout to
+# give sidekiq process enough time to exit.
+kill timeout 30
+<% if num_workers %>
+
+instance $index
+<% end %>
+script
+# this script runs in /bin/sh by default
+# respawn as bash so we can source in rbenv
+exec /bin/bash <<'EOT'
+  # Pick your poison :) Or none if you're using a system wide installed Ruby.
+  # rbenv
+  # source /home/apps/.bash_profile
+  # OR
+  # source /home/apps/.profile
+  # OR system:
+  # source /etc/profile.d/rbenv.sh
+  #
+  # rvm
+  # source /home/apps/.rvm/scripts/rvm
+
+  # Logs out to /var/log/upstart/<%= fetch(:sidekiq_service_unit_name) %>.log by default
+
+  cd <%= File.join(fetch(:deploy_to), 'current') %>
+  exec <%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %> <%= sidekiq_config %> <%= sidekiq_concurrency %> <%= sidekiq_queues %>
+EOT
+end script

data/lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb

@@ -0,0 +1,37 @@
+# /etc/init/workers.conf - manage a set of Sidekiqs | https://github.com/mperham/sidekiq/blob/master/examples/upstart/workers.conf
+
+# This example config should work with Ubuntu 14.10 and below  It
+# allows you to manage multiple Sidekiq instances with
+# Upstart, Ubuntu's native service management tool.
+#
+# See sidekiq.conf for how to manage a single Sidekiq instance.
+#
+# Use "stop workers" to stop all Sidekiq instances.
+# Use "start workers" to start all instances.
+# Use "restart workers" to restart all instances.
+# Crazy, right?
+#
+
+description "manages the set of sidekiq processes"
+
+# This starts upon bootup and stops on shutdown
+start on runlevel [2345]
+stop on runlevel [06]
+
+# Set this to the number of Sidekiq processes you want
+# to run on this machine
+env NUM_WORKERS=2
+
+pre-start script
+  for i in `seq 1 ${NUM_WORKERS}`
+  do
+    start sidekiq index=$i
+  done
+end script
+
+post-stop script
+  for i in `seq 1 ${NUM_WORKERS}`
+  do
+    stop sidekiq index=$i
+  done
+end script

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -81,11 +81,13 @@ files:
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb
 - lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
 - lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb
+- lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb
+- lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,12 +98,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Sidekiq integration for Capistrano
 test_files: []