mina-sidekiq 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e83a12846c227f7fb2556d7f7b790b2fe202a50a
-  data.tar.gz: 4dbb611c7f3d9f859d2dfdff30520059e52c17f8
+SHA256:
+  metadata.gz: b6b58dc398da8db743c4f5f063cf60cabc54e546463c8ca9504afed5855ee4a5
+  data.tar.gz: 46cd45d6d4ef1ab10a93892baf0fab90d7899b4520e2afd1a068e0fb90ab7dae
 SHA512:
-  metadata.gz: 8599964fe653f428528e1932b63b4409f0470e1c795f6bc9b3e4238a92b1be8e41907c7015a258b8aca032116f287488f8bafab631e56a2ca03b896a2e867cd3
-  data.tar.gz: 2e64560593ce53ad5bcb9e7c05b928d1d67a6cb0bd96d71c03972094c101e01102169695a2662a5e7528dda96144c3b97740499c8cc54d39281e9ec81345d260
+  metadata.gz: d8902d7d2b9f28020b5049dcaf661fbf7ab07b644b9e4da7a5b737a628acbd38de5480386bd281430a9fbc7d3c7c28f7e4d63a48cd10030805b89af9bd18feee
+  data.tar.gz: dbff1c1aea66bb4a111e29fc3c9f5c368d22819b0e7e9329d558f99cefa9ce4bc199bc2bd8035ccd1b7b23b68f7a9fc7df5e1c9a3e2b5fd69b0f8aedf43a9f79

data/Changelog.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+1.1.0 2020-07-18
+----------------
+* Add sidekiq 6 support, including support for unprivileged deployments
+* Allow multiple sidekiq process with different configs
+
 1.0.3 2017-11-05
 ----------------
 * replace deprecated dependency on environment task with remote_environment

data/README.md

@@ -1,13 +1,13 @@
 mina-sidekiq
 ============
 
-[![Build Status](https://travis-ci.org/Mic92/mina-sidekiq.png?branch=master)](https://travis-ci.org/Mic92/mina-sidekiq)
-
 mina-sidekiq is a gem that adds tasks to aid in the deployment of [Sidekiq](http://mperham.github.com/sidekiq/)
 using [Mina](http://nadarei.co/mina).
 
 Starting with 1.0.0 this gem requires Mina 1.0! (thanks [@devvmh](https://github.com/devvmh))
 
+Support sidekiq > 6.0, reference project capistrano-sidekiq, github: https://github.com/seuros/capistrano-sidekiq
+
 # Getting Start
 
 ## Installation
@@ -43,6 +43,71 @@ task :deploy do
   end
 end
 ```
+## Support sidekiq > 6.0
+
+Set init system to systemd in the mina deploy config:
+
+```ruby
+  set :init_system, :systemd
+```
+
+Enable lingering for systemd user account
+
+```
+  loginctl enable-linger USERACCOUNT
+```
+
+Install systemd.service template file and enable the service with:
+
+```
+  bundle exec mina sidekiq:install
+```
+
+Default name for the service file is sidekiq-env.service. This can be changed as needed, for example:
+
+```ruby
+  set :service_unit_name, "sidekiq-#{fetch(:rails_env)}.service"
+```
+
+Default systemctl command is ```systemctl --user```, this can be changed, for example:
+
+```ruby
+  set :systemctl_command, 'systemctl --user'
+```
+For non privileged user (non sudo) usage set up path for systemctl unit file:
+
+```ruby
+  set :service_unit_path, '/home/www/.config/systemd/user'
+```
+
+where ```www``` is the username. For details see systemctl [doc page](https://www.freedesktop.org/software/systemd/man/systemd.unit.html) 
+
+To use systemctl integration with rbenv bundler path must be setted:
+
+```ruby
+  set :bundler_path, '/home/www/.rbenv/shims/bundler'
+```
+
+To get bundler path use:
+
+```bash
+  which bundler
+```
+
+
+## Integration with upstart
+
+Set init system to upstart in the cap deploy config:
+
+```ruby
+  set :init_system, :upstart
+```
+
+Set upstart service name:
+
+```ruby
+  set :upstart_service_name, 'sidekiq'
+```
 
 
 ## Available Tasks
@@ -53,16 +118,22 @@ end
 * sidekiq:quiet
 * sidekiq:log
 
+sidekiq > 6.0
+* sidekiq:install
+* sidekiq:uninstall
+
 ## Available Options
 
-| Option              | Description                                                                    |
-| ------------------- | ------------------------------------------------------------------------------ |
-| *sidekiq*           | Sets the path to sidekiq.                                                      |
-| *sidekiqctl*        | Sets the path to sidekiqctl.                                                   |
-| *sidekiq\_timeout*  | Sets a upper limit of time a worker is allowed to finish, before it is killed. |
-| *sidekiq\_log*      | Sets the path to the log file of sidekiq.                                      |
-| *sidekiq\_pid*      | Sets the path to the pid file of a sidekiq worker.                             |
-| *sidekiq_processes* | Sets the number of sidekiq processes launched.                                 |
+| Option              | Description                                                                                       |
+| ------------------- | ------------------------------------------------------------------------------------------------- |
+| *sidekiq*           | Sets the path to sidekiq.                                                                         |
+| *sidekiqctl*        | Sets the path to sidekiqctl.                                                                      |
+| *sidekiq\_timeout*  | Sets a upper limit of time a worker is allowed to finish, before it is killed.                    |
+| *sidekiq\_log*      | Sets the path to the log file of sidekiq.                                                         |
+| *sidekiq\_pid*      | Sets the path to the pid file of a sidekiq worker.                                                |
+| *sidekiq_processes* | Sets the number of sidekiq processes launched.                                                    |
+| *sidekiq_config*    | Sets the config file path.                                                                        |
+| *sidekiq_configs*   | Sets the config file paths when using more than one sidekiq process with different configuration. |
 
 ## Testing
 

data/lib/mina_sidekiq/tasks.rb

@@ -33,16 +33,26 @@ set :sidekiq, -> { "#{fetch(:bundle_bin)} exec sidekiq" }
 
 # ### sidekiqctl
 # Sets the path to sidekiqctl.
-set :sidekiqctl, -> { "#{fetch(:bundle_prefix)} sidekiqctl" }
+set :sidekiqctl, -> { "#{fetch(:bundle_bin)} exec sidekiqctl" }
 
 # ### sidekiq_timeout
 # Sets a upper limit of time a process is allowed to finish, before it is killed by sidekiqctl.
 set :sidekiq_timeout, 11
 
 # ### sidekiq_config
-# Sets the path to the configuration file of sidekiq
+# Sets the path to the configuration file of sidekiq.
 set :sidekiq_config, -> { "#{fetch(:current_path)}/config/sidekiq.yml" }
 
+# ### sidekiq_configs
+# A list of configuration file paths. Each file path will be assigned to one sidekiq
+# instance in order. When specified sidekiq_config will be ignored.
+set :sidekiq_configs, -> {
+  [
+    # "#{fetch(:current_path)}/config/sidekiq_1.yml",
+    # "#{fetch(:current_path)}/config/sidekiq_2.yml"
+  ]
+}
+
 # ### sidekiq_log
 # Sets the path to the log file of sidekiq
 #
@@ -61,6 +71,16 @@ set :sidekiq_processes, 1
 # Sets the number of sidekiq threads per process (overrides value in sidekiq.yml)
 set :sidekiq_concurrency, nil
 
+set :sidekiq_user, nil
+
+# Init system integration
+set :init_system, -> { nil }
+# systemd integration
+set :service_unit_name, "sidekiq-#{fetch(:rails_env)}.service"
+set :systemctl_command, 'systemctl --user'
+
+set :upstart_service_name, "sidekiq"
+
 # ## Control Tasks
 namespace :sidekiq do
   def for_each_process(&block)
@@ -78,15 +98,22 @@ namespace :sidekiq do
   desc "Quiet sidekiq (stop accepting new work)"
   task :quiet => :remote_environment do
     comment 'Quiet sidekiq (stop accepting new work)'
-    in_path(fetch(:current_path)) do
-      for_each_process do |pid_file, idx|
-        command %{
-          if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}` > /dev/null 2>&1; then
-            #{fetch(:sidekiqctl)} quiet #{pid_file}
-          else
-            echo 'Skip quiet command (no pid file found)'
-          fi
-        }.strip
+    case fetch(:init_system)
+    when :systemd
+      command %{ #{ fetch(:systemctl_command) } reload #{ fetch(:service_unit_name) } }
+    when :upstart
+      command %{ sudo service #{ fetch(:upstart_service_name) } reload }
+    else
+      in_path(fetch(:current_path)) do
+        for_each_process do |pid_file, idx|
+          command %{
+            if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}` > /dev/null 2>&1; then
+              #{fetch(:sidekiqctl)} quiet #{pid_file}
+            else
+              echo 'Skip quiet command (no pid file found)'
+            fi
+          }.strip
+        end
       end
     end
   end
@@ -95,15 +122,22 @@ namespace :sidekiq do
   desc "Stop sidekiq"
   task :stop => :remote_environment do
     comment 'Stop sidekiq'
-    in_path(fetch(:current_path)) do
-      for_each_process do |pid_file, idx|
-        command %{
-          if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
-            #{fetch(:sidekiqctl)} stop #{pid_file} #{fetch(:sidekiq_timeout)}
-          else
-            echo 'Skip stopping sidekiq (no pid file found)'
-          fi
-        }.strip
+    case fetch(:init_system)
+    when :systemd
+      command %{ #{ fetch(:systemctl_command) } stop #{ fetch(:service_unit_name) } }
+    when :upstart
+      command %{ sudo service #{ fetch(:upstart_service_name) } stop }
+    else
+      in_path(fetch(:current_path)) do
+        for_each_process do |pid_file, idx|
+          command %{
+            if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
+              #{fetch(:sidekiqctl)} stop #{pid_file} #{fetch(:sidekiq_timeout)}
+            else
+              echo 'Skip stopping sidekiq (no pid file found)'
+            fi
+          }.strip
+        end
       end
     end
   end
@@ -112,19 +146,85 @@ namespace :sidekiq do
   desc "Start sidekiq"
   task :start => :remote_environment do
     comment 'Start sidekiq'
-    in_path(fetch(:current_path)) do
-      for_each_process do |pid_file, idx|
-        sidekiq_concurrency = fetch(:sidekiq_concurrency)
-        concurrency_arg = if sidekiq_concurrency.nil?
-                            ""
-                          else
-                            "-c #{sidekiq_concurrency}"
-                          end
-        command %[#{fetch(:sidekiq)} -d -e #{fetch(:rails_env)} #{concurrency_arg} -C #{fetch(:sidekiq_config)} -i #{idx} -P #{pid_file} -L #{fetch(:sidekiq_log)}]
+    case fetch(:init_system)
+    when :systemd
+      command %{ #{ fetch(:systemctl_command) } start #{ fetch(:service_unit_name) } }
+    when :upstart
+      command %{ sudo service #{ fetch(:upstart_service_name) } start }
+    else
+      in_path(fetch(:current_path)) do
+        for_each_process do |pid_file, idx|
+          sidekiq_config = fetch(:sidekiq_configs)[idx] || fetch(:sidekiq_config)
+          sidekiq_concurrency = fetch(:sidekiq_concurrency)
+          concurrency_arg = if sidekiq_concurrency.nil?
+                              ""
+                            else
+                              "-c #{sidekiq_concurrency}"
+                            end
+          command_line = %[#{fetch(:sidekiq)} -d -e #{fetch(:rails_env)} #{concurrency_arg} -C #{sidekiq_config} -i #{idx} -P #{pid_file}]
+          command_line += " -L #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
+
+          command command_line
+        end
       end
     end
   end
 
+  task :install do
+    case fetch(:init_system)
+    when :systemd
+      create_systemd_template
+    end
+  end
+
+  task :uninstall do
+    case fetch(:init_system)
+    when :systemd
+      command %{ #{ fetch(:systemctl_command) } disable #{fetch(:service_unit_name)} }
+      command %{ rm #{File.join(fetch(:service_unit_path, fetch_systemd_unit_path),fetch(:service_unit_name))}  }
+    end
+  end
+
+  def create_systemd_template
+    template =  %{
+[Unit]
+Description=sidekiq for #{fetch(:application)} #{fetch(:app_name)}
+After=syslog.target network.target
+
+[Service]
+Type=simple
+Environment=RAILS_ENV=#{ fetch(:rails_env) }
+StandardOutput=append:#{fetch(:deploy_to)}/current/log/sidekiq.log
+StandardError=append:#{fetch(:deploy_to)}/current/log/sidekiq.log
+WorkingDirectory=#{fetch(:deploy_to)}/current
+ExecStart=#{fetch(:bundler_path, '/usr/local/bin/bundler')} exec sidekiq -e #{fetch(:rails_env)}
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+RestartSec=1
+Restart=on-failure
+
+SyslogIdentifier=sidekiq
+
+[Install]
+WantedBy=default.target
+}
+    systemd_path = fetch(:service_unit_path, fetch_systemd_unit_path)
+    service_path = systemd_path + "/" + fetch(:service_unit_name)
+    comment %{Creating systemctl unit file}
+    command %{ mkdir -p #{systemd_path} }
+    command %{ touch #{service_path} }
+    command %{ echo "#{ template }" > #{ service_path } }
+    comment %{Reloading systemctl daemon}
+    command %{ #{ fetch(:systemctl_command) } daemon-reload }
+    comment %{Enabling sidekiq service}
+    command %{ #{ fetch(:systemctl_command) } enable #{ service_path } }
+  end
+
+  def fetch_systemd_unit_path
+    home_dir = '/usr'
+    File.join(home_dir, "lib", "systemd", "user")
+  end
+
   # ### sidekiq:restart
   desc "Restart sidekiq"
   task :restart do
@@ -136,4 +236,5 @@ namespace :sidekiq do
   task :log => :remote_environment do
     command %[tail -f #{fetch(:sidekiq_log)}]
   end
+
 end

data/lib/mina_sidekiq/version.rb

@@ -1,5 +1,5 @@
 module MinaSidekiq
   def self.version
-    '1.0.3'
+    '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mina-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Joerg Thalheim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina
@@ -77,7 +77,7 @@ homepage: http://github.com/Mic92/mina-sidekiq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Tasks to deploy Sidekiq with mina.
 test_files: