tomo-plugin-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3303d6ffcaaa101d28fd1e3febfae1c6b7c8e9cfff5940bfc8317b1a38ca8bb
+  data.tar.gz: ef8a62f99fb77781510bec581b9f3d72b5272c42869695c68e5c75c3936a5473
+SHA512:
+  metadata.gz: c567215b96ffc0f723ab93532f3ef167fd4904132e00d693bdb0f5fe997746fb3e5f08e6c6973bb21bc164686df9e2fe6a86f4668cfb3f6586f710844634b993
+  data.tar.gz: 1fac066c500134c43872d0db603f8be576d8393ac3fa747c124c166e4f7162b29fc5dd08a167b907dc579551a70b45ca77e1e1a36aafa96bb37b5712119a5df0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matt Brictson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# tomo-plugin-sidekiq
+
+[![Gem Version](https://badge.fury.io/rb/tomo-plugin-sidekiq.svg)](https://rubygems.org/gems/tomo-plugin-sidekiq)
+[![Travis](https://img.shields.io/travis/mattbrictson/tomo-plugin-sidekiq.svg?label=travis)](https://travis-ci.org/mattbrictson/tomo-plugin-sidekiq)
+[![Circle](https://circleci.com/gh/mattbrictson/tomo-plugin-sidekiq.svg?style=shield)](https://circleci.com/gh/mattbrictson/tomo-plugin-sidekiq)
+[![Code Climate](https://codeclimate.com/github/mattbrictson/tomo-plugin-sidekiq/badges/gpa.svg)](https://codeclimate.com/github/mattbrictson/tomo-plugin-sidekiq)
+
+This is a [tomo](https://github.com/mattbrictson/tomo) plugin that provides tasks for managing [sidekiq](https://github.com/mperham/sidekiq) via [systemd](https://en.wikipedia.org/wiki/Systemd), based on the recommendations in the sidekiq documentation. This plugin assumes that you are also using the tomo `rbenv` and `env` plugins, and that you are using a systemd-based Linux distribution like Ubuntu 18 LTS.
+
+---
+
+- [Installation](#installation)
+- [Settings](#settings)
+- [Tasks](#tasks)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Installation
+
+Run:
+
+```
+$ gem install tomo-plugin-sidekiq
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem "tomo-plugin-sidekiq"
+```
+
+Then add the following to `.tomo/config.rb`:
+
+```ruby
+plugin "sidekiq"
+
+setup do
+  # ...
+  run "sidekiq:setup_systemd"
+end
+
+deploy do
+  # ...
+  # Place this task at *after* core:symlink_current
+  run "sidekiq:restart"
+end
+```
+
+### enable-linger
+
+This plugin installs sidekiq as a user-level service using systemctl --user. This allows sidekiq to be installed, started, stopped, and restarted without a root user or sudo. However, when provisioning the host you must make sure to run the following command as root to allow the sidekiq process to continue running even after the tomo deploy user disconnects:
+
+```
+# run as root
+$ loginctl enable-linger <DEPLOY_USER>
+```
+
+## Settings
+
+| Name                  | Purpose |
+| --------------------- | ------- |
+| `sidekiq_systemd_service` | Name of the systemd unit that will be used to manage sidekiq <br>**Default:** `"sidekiq_%{application}.service"`   |
+| `sidekiq_systemd_service_path` | Location where the systemd unit will be installed <br>**Default:** `".config/systemd/user/%{sidekiq_systemd_service}"`   |
+| `sidekiq_systemd_service_template_path` | Local path to the ERB template that will be used to create the systemd unit <br>**Default:** [service.erb](https://github.com/mattbrictson/tomo-plugin-sidekiq/blob/master/lib/tomo/plugin/sidekiq/service.erb)   |
+
+## Tasks
+
+### sidekiq:setup_systemd
+
+Configures systemd to manage sidekiq. This means that sidekiq will automatically be restarted if it crashes, or if the host is rebooted. This task essentially does two things:
+
+1. Installs a `sidekiq.service` systemd unit
+1. Enables it using `systemctl --user enable`
+
+Note that these units will be installed and run for the deploy user. You can use `:sidekiq_systemd_service_template_path` to provide your own template and customize how sidekiq and systemd are configured.
+
+`sidekiq:setup_systemd` is intended for use as a [setup](https://tomo-deploy.com/commands/setup/) task. It must be run before sidekiq can be started during a deploy.
+
+### sidekiq:restart
+
+Gracefully restarts the sidekiq service via systemd, or starts it if it isn't running already. Equivalent to:
+
+```
+systemctl --user restart sidekiq.service
+```
+
+### sidekiq:start
+
+Starts the sidekiq service via systemd, if it isn't running already. Equivalent to:
+
+```
+systemctl --user start sidekiq.service
+```
+
+### sidekiq:stop
+
+Stops the sidekiq service via systemd. Equivalent to:
+
+```
+systemctl --user stop sidekiq.service
+```
+
+### sidekiq:status
+
+Prints the status of the sidekiq systemd service. Equivalent to:
+
+```
+systemctl --user status sidekiq.service
+```
+
+### sidekiq:log
+
+Uses `journalctl` (part of systemd) to view the log output of the sidekiq service. This task is intended for use as a [run](https://tomo-deploy.com/commands/run/) task and accepts command-line arguments. The arguments are passed through to the `journalctl` command. For example:
+
+```
+$ tomo run -- sidekiq:log -f
+```
+
+Will run this remote script:
+
+```
+journalctl -q --user-unit=sidekiq.service -f
+```
+
+## Recommendations
+
+### Sidekiq configuration
+
+Add a `config/sidekiq.yml` file to your application (i.e. checked into git) and use that to configure sidekiq, using environment variables as necessary. For example:
+
+```yaml
+---
+:queues:
+  - default
+  - mailers
+
+:concurrency: <%= ENV.fetch("SIDEKIQ_CONCURRENCY", "1") %>
+```
+
+Now you can tune sidekiq for each environment by simply setting environment variables (e.g. using `tomo run env:set`), without hard-coding configuration in git or within systemd files.
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/mattbrictson/tomo-plugin-sidekiq/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/tomo/plugin/sidekiq.rb

@@ -0,0 +1,19 @@
+require "tomo"
+require "tomo/plugin/sidekiq/tasks"
+require "tomo/plugin/sidekiq/version"
+
+module Tomo
+  module Plugin
+    module Sidekiq
+      extend Tomo::PluginDSL
+
+      tasks Tomo::Plugin::Sidekiq::Tasks
+
+      # rubocop:disable Metrics/LineLength
+      defaults sidekiq_systemd_service: "sidekiq_%{application}.service",
+               sidekiq_systemd_service_path: ".config/systemd/user/%{sidekiq_systemd_service}",
+               sidekiq_systemd_service_template_path: File.expand_path("sidekiq/service.erb", __dir__)
+      # rubocop:enable Metrics/LineLength
+    end
+  end
+end

data/lib/tomo/plugin/sidekiq/service.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=Sidekiq for <%= settings[:application] %>
+After=syslog.target network.target
+ConditionPathExists=<%= paths.current %>
+
+[Service]
+ExecReload=/usr/bin/kill -TSTP $MAINPID
+ExecStart=/bin/bash -lc 'exec bundle exec sidekiq'
+Restart=on-failure
+RestartSec=1
+StandardError=syslog
+StandardOutput=syslog
+SyslogIdentifier=%n
+Type=simple
+WorkingDirectory=<%= paths.current %>
+
+# Greatly reduce Ruby memory fragmentation and heap usage
+# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
+Environment=MALLOC_ARENA_MAX=2
+
+[Install]
+WantedBy=multi-user.target

data/lib/tomo/plugin/sidekiq/tasks.rb

@@ -0,0 +1,52 @@
+module Tomo::Plugin::Sidekiq
+  class Tasks < Tomo::TaskLibrary
+    SystemdUnit = Struct.new(:name, :template, :path)
+
+    # rubocop:disable Metrics/AbcSize
+    def setup_systemd
+      linger_must_be_enabled!
+
+      remote.mkdir_p service.path.dirname
+      remote.write template: service.template, to: service.path
+
+      remote.run "systemctl --user daemon-reload"
+      remote.run "systemctl", "--user", "enable", service.name
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    %i[reload restart start stop status].each do |action|
+      define_method(action) do
+        remote.run "systemctl", "--user", action, service.name
+      end
+    end
+
+    def log
+      remote.attach "journalctl", "-q",
+                    raw("--user-unit=#{service.name.shellescape}"),
+                    *settings[:run_args]
+    end
+
+    private
+
+    def service
+      SystemdUnit.new(
+        settings[:sidekiq_systemd_service],
+        paths.sidekiq_systemd_service_template,
+        paths.sidekiq_systemd_service
+      )
+    end
+
+    def linger_must_be_enabled!
+      loginctl_result = remote.run "loginctl", "user-status", remote.host.user
+      return unless loginctl_result.stdout.match?(/^\s*Linger:\s*no\s*$/i)
+
+      die <<~ERROR.strip
+        Linger must be enabled for the #{remote.host.user} user in order for
+        sidekiq to stay running in the background via systemd. Run the following
+        command as root:
+
+          loginctl enable-linger #{remote.host.user}
+      ERROR
+    end
+  end
+end

data/lib/tomo/plugin/sidekiq/version.rb

@@ -0,0 +1,7 @@
+module Tomo
+  module Plugin
+    module Sidekiq
+      VERSION = "0.1.0".freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: tomo-plugin-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Brictson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-ci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.75.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.75.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: 
+email:
+- opensource@mattbrictson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tomo/plugin/sidekiq.rb
+- lib/tomo/plugin/sidekiq/service.erb
+- lib/tomo/plugin/sidekiq/tasks.rb
+- lib/tomo/plugin/sidekiq/version.rb
+homepage: https://github.com/mattbrictson/tomo-plugin-sidekiq
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/mattbrictson/tomo-plugin-sidekiq/issues
+  changelog_uri: https://github.com/mattbrictson/tomo-plugin-sidekiq/releases
+  source_code_uri: https://github.com/mattbrictson/tomo-plugin-sidekiq
+  homepage_uri: https://github.com/mattbrictson/tomo-plugin-sidekiq
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: sidekiq tasks for tomo
+test_files: []