dlss-capistrano 3.7.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 877a173e1e6e8e32cd4c48df5cf8b59011114d87994f5e747924cab409bf37d2
-  data.tar.gz: 5a0cc74142192b5e4c4a77809d318f0b4dcd138ecd488ff787e78de3ce2a8486
+  metadata.gz: 80eb28bbf5c58cf57b561882ef7a7f3cffed327710fb733ac0a4450fa275fd15
+  data.tar.gz: a3ae9e2feb13dd590e599a786ed7cbe2e1453ffae78124b7026eef45c1ae53b9
 SHA512:
-  metadata.gz: 21fbedcc886454cd536e083edc07a73e38842e1bbd9dbaba00b1de9e8912b8eac2f7ef3bf902d5885f960199be7224ec6709c05c6b2da295d90118cfe6e54f21
-  data.tar.gz: 9dc3c858babe7710cef6f6a5b50878206bff508977048e226a54387b1f58cd84a5ccc9328e34b01a9c0f2a1a79e484b780d45aca23247db7e14a5ca46791a0d1
+  metadata.gz: 8f13360fdbe742cf471edab521728b79a2f685fb4e98182875b951b29d65d42487cb0ccc79fd589afff5f5226d100774ff9438c25c5a724fe54ac38e6214bab8
+  data.tar.gz: 1eb046a6aca94b7d5e5ede77d06624d601dcb9548d4648bae559cb404fc4932e5d9564f0e600d352766e9a114362a0ff52632c9ffc478727efbc8ef6a9c81b89

data/README.md

@@ -35,12 +35,46 @@ Set this in `config/deploy.rb` to automate the symlink creation, and then use `X
 
 `cap ENV ssh` establishes an SSH connection to the host running in `ENV` environment, and changes into the current deployment directory
 
+### SSH Connection Checking
+
+`cap ENV ssh_check` establishes an SSH connection to all app servers running in `ENV` environment and prints environment information to confirm the connection was made. This is used by [sdr-deploy](https://github.com/sul-dlss-labs/sdr-deploy/) to check SSH connections can be made in bulk before proceeding with a mass deploy.
+
+### Display Revision (and branches)
+
+`cap ENV deployed_branch` displays the currently deployed revision (commit ID) and any branches containing the revision for each server in `ENV`.
+
+### Resque-Pool hot swap (OPTIONAL)
+
+The `dlss-capistrano` gem provides a set of tasks for managing `resque-pool` workers when deployed in `hot_swap` mode. (If you are using `resque-pool` without `hot_swap`, we recommend continuing to use the `capistrano-resque-pool` gem instead of what `dlss-capistrano` provides.) The tasks are:
+
+```shell
+$ cap ENV resque:pool:hot_swap # this gracefully replaces the current pool with a new pool
+$ cap ENV resque:pool:stop     # this gracefully stops the current pool
+```
+
+By default, these tasks are not provided; instead, they must be explicitly enabled via adding a new `require` statement to the application's `Capfile`:
+
+```ruby
+require 'dlss/capistrano/resque_pool'
+```
+
+This is the hook provided if you opt in:
+
+```ruby
+after 'deploy:publishing', 'resque:pool:hot_swap'
+```
+
 ### Sidekiq via systemd
 
 `cap ENV sidekiq_systemd:{quiet,stop,start,restart}`: quiets, stops, starts, restarts Sidekiq via systemd.
 
 These tasks are intended to replace those provided by `capistrano-sidekiq` gem, which has assumptions about systemd that do not apply to our deployed environments.
 
+### Sneakers via systemd
+
+`cap ENV sneakers_systemd:{quiet,stop,start,restart}`: quiets, stops, starts, restarts Sneakers via systemd.
+
+
 #### Capistrano role
 
 The sidekiq_systemd tasks assume a Capistrano role of `:app`. If your application uses a different Capistrano role for hosts that run Sidekiq workers, you can configure this in `config/deploy.rb`, *e.g.*:
@@ -76,7 +110,6 @@ dlss-capistrano makes the following assumptions about your Ruby project
 - You do not have an .rvmrc checked into git (should be in your .gitignore)
 - You will not use rvm gemsets on the server you deploy to
 - Bundler will install specified gems into {your_project_home}/shared/bundle directory
-- Will deploy from the master branch, unless you set :branch to another branch or tag
 
 ## Copyright
 

data/dlss-capistrano.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "dlss-capistrano"
-  s.version     = "3.7.0"
+  s.version     = '3.11.0'
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

data/lib/dlss/capistrano/resque_pool.rb

@@ -0,0 +1 @@
+import "#{__dir__}/resque_pool/tasks/resque_pool.rake"

data/lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# These tasks are a drop-in replacement for capistrano-resque-pool when using
+# hot-swappable pools. We replace these tasks because the upstream ones assume a
+# pidfile is present, which is not the case with hot-swappable pools.
+
+namespace :load do
+  task :defaults do
+    # Same capistrano variable used by capistrano-resque-pool for compatibility
+    set :resque_server_roles, fetch(:resque_server_roles, [:app])
+  end
+end
+
+# Integrate hook into Capistrano
+namespace :deploy do
+  before :starting, :add_resque_pool_hotswap_hook do
+    invoke 'resque:pool:add_hook'
+  end
+end
+
+namespace :resque do
+  namespace :pool do
+    # Lifted from capistrano-resque-pool
+    def rails_env
+      fetch(:resque_rails_env) ||
+        fetch(:rails_env) ||       # capistrano-rails doesn't automatically set this (yet),
+        fetch(:stage)              # so we need to fall back to the stage.
+    end
+
+    # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+    task :add_hook do
+      after 'deploy:publishing', 'resque:pool:hot_swap'
+    end
+
+    desc 'Swap in a new pool, then shut down the old pool'
+    task :hot_swap do
+      on roles(fetch(:resque_server_roles)) do
+        within current_path do
+          execute :bundle, :exec, 'resque-pool', "--daemon --hot-swap --environment #{rails_env}"
+        end
+      end
+    end
+
+    desc 'Gracefully shut down current pool'
+    task :stop do
+      on roles(fetch(:resque_server_roles)) do
+        # This will usually return a single pid, but if you do multiple quick
+        # deployments, you may pick up multiple pids here, in which case we only
+        # kill the oldest one
+        pid = capture(:pgrep, '-f resque-pool-master').split.first
+
+        if test "kill -0 #{pid} > /dev/null 2>&1"
+          execute :kill, "-s QUIT #{pid}"
+        else
+          warn "Process #{pid} is not running"
+        end
+      end
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/deployed_branch.rake

@@ -0,0 +1,10 @@
+desc 'display the deployed branch and commit'
+task :deployed_branch do
+  on roles(:app) do |host|
+    within current_path do
+      revision = capture :cat, 'REVISION'
+      branches = `git branch -r --contains #{revision}`.strip
+      info "#{host}: #{revision} (#{branches})"
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/sneakers_systemd.rake

@@ -0,0 +1,52 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :sneakers_systemd_role, fetch(:sneakers_systemd_role, :app)
+    set :sneakers_systemd_use_hooks, fetch(:sneakers_systemd_use_hooks, false)
+  end
+end
+
+# Integrate sneakers hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_sneakers_systemd_hooks do
+    invoke 'sneakers_systemd:add_hooks' if fetch(:sneakers_systemd_use_hooks)
+  end
+end
+
+namespace :sneakers_systemd do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hooks do
+    after 'deploy:failed', 'sneakers_systemd:restart'
+    after 'deploy:published', 'sneakers_systemd:start'
+    after 'deploy:starting', 'sneakers_systemd:quiet'
+    after 'deploy:updated', 'sneakers_systemd:stop'
+  end
+
+  desc 'Stop workers from picking up new jobs'
+  task :quiet do
+    on roles fetch(:sneakers_systemd_role) do
+      sudo :systemctl, 'reload', 'sneakers', raise_on_non_zero_exit: false
+    end
+  end
+
+  desc 'Stop running workers gracefully'
+  task :stop do
+    on roles fetch(:sneakers_systemd_role) do
+      sudo :systemctl, 'stop', 'sneakers'
+    end
+  end
+
+  desc 'Start workers'
+  task :start do
+    on roles fetch(:sneakers_systemd_role) do
+      sudo :systemctl, 'start', 'sneakers'
+    end
+  end
+
+  desc 'Restart workers'
+  task :restart do
+    on roles fetch(:sneakers_systemd_role) do
+      sudo :systemctl, 'restart', 'sneakers', raise_on_non_zero_exit: false
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/ssh_check.rake

@@ -0,0 +1,6 @@
+desc "check ssh connections to all app servers"
+task :ssh_check do
+  on roles(:app), in: :sequence do
+    execute
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -85,10 +85,15 @@ files:
 - dlss-capistrano.gemspec
 - lib/dlss.rb
 - lib/dlss/capistrano.rb
+- lib/dlss/capistrano/resque_pool.rb
+- lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake
 - lib/dlss/capistrano/tasks/bundle_config.rake
 - lib/dlss/capistrano/tasks/bundled_sidekiq.rake
+- lib/dlss/capistrano/tasks/deployed_branch.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
+- lib/dlss/capistrano/tasks/sneakers_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
+- lib/dlss/capistrano/tasks/ssh_check.rake
 - lib/lyberteam-capistrano-devel.rb
 homepage: 
 licenses:
@@ -109,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects