dlss-capistrano 5.1.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69b0b30f58f3313e59a5fc7cf0d510d5c95d99fe5e077a772588e6ffdccbbd9
-  data.tar.gz: e0020c24765ddd757ee839371f962325900b147aa69a399c7ad97eb60b7babb8
+  metadata.gz: c20ce3abcea6996c7366473874dbd9b7106749c5e7b365d21e301195ead06830
+  data.tar.gz: 75a94eb0b169763cd62e7dd92bcb8b183d7621e5ea271613c06b7b4814835c7d
 SHA512:
-  metadata.gz: 9e14e482febdd209f99802e0b4b0ac6323825da0312c6e50c21e97a51746fe651c8825691a9b0d86576b5239c7ba8328113c9df18565cc82a542d5cb158e0ba4
-  data.tar.gz: ddbc21daf2f1e259764d1257a741a9fb8208e8731e693c40daf9d15c49dfb6747615ce1161ce98f34e7757ae7eacd7cce5c09c3ccfde4c9c81b8cb654f5ad837
+  metadata.gz: c18fc1a359d2bffa0f474b4e3eaa4d00010e01bddf6eb37dde993512c1f3076ed861b5ff79d955afa8a406d125c95feb5a9b91561a02d81561484c0e802a03b9
+  data.tar.gz: c03fd209a7440b754cad93ed9b671cd3554d86804c358bc7aa0b65fb2c46a99d6b518b3baab57719da1784fe42c85d03b55d5602f56a8810fbf13cb2e56a0f9b

data/README.md

@@ -8,11 +8,9 @@ This gem provides Capistrano deployment tasks used by Stanford Libraries' Digita
 
 To start, we recommend an SSH configuration like the one described in the [DeveloperPlaybook](https://github.com/sul-dlss/DeveloperPlaybook/blob/main/best-practices/ssh_configuration.md), since it has sensible defaults for Kerberos authentication and multi-factor authentication (using `ProxyJump` and `ControlMaster`, etc.).
 
-To use controlmaster, you need to opt-in by setting the environment variable `USE_CAPISTRANO_CONTROLMASTER=true` (in e.g. your `~/.zshenv` file or similar for your particular shell).
+To get `dlss-capistrano` tasks running via an existing SSH control master socket, you need to opt-in by setting the environment variable `USE_CAPISTRANO_CONTROLMASTER=true` (in e.g. your `~/.zshenv` file or similar for your particular shell).
 
-If you use values other than the defaults for  `CONTROLMASTER_HOST` (`dlss-jump`) or `CONTROLMASTER_SOCKET` (`"~/.ssh/%r@%h:%p"`), you'll want to set these environment variables locally to the values you use (in e.g. your `~/.zshenv` file or similar for your particular shell).  Otherwise, the gem will fail to connect to the appropriate host and/or won't be able to properly check the status of the control master process.
-
-The control master host is the value of the `ProxyJump` directive in your SSH config, and the control master socket is the value of the `ControlPath` directive in your SSH config.
+If your SSH client configuration (`~/.ssh/config`) uses values other than the defaults for `CONTROLMASTER_HOST` (which maps to the `ProxyJump` directive, and defaults to `dlss-jump`) or `CONTROLMASTER_SOCKET` (which maps to the `ControlPath` directive, and defaults to `~/.ssh/%r@%h:%p`), you'll want to set these environment variables locally to the values you use (in e.g. your `~/.zshenv` file or similar for your particular shell). Otherwise, the gem will fail to connect to the appropriate jump host and/or won't be able to properly check the status of the control master process.
 
 ## Included Tasks
 
@@ -83,6 +81,10 @@ These tasks are intended to replace those provided by `capistrano-sidekiq` gem,
 
 `cap ENV sneakers_systemd:{stop,start,restart}`: stops, starts, restarts Sneakers via systemd.
 
+### SolidQueue via systemd
+
+`cap ENV solid_queue_systemd:{stop,start,restart}`: stops, starts, restarts SolidQueue via systemd.
+
 ### Racecar via systemd
 
 `cap ENV racecar_systemd:{stop,start,restart}`: stops, starts, restarts Racecar via systemd.

data/dlss-capistrano.gemspec

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

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

@@ -10,13 +10,6 @@ namespace :load do
   end
 end
 
-# Integrate hook into Capistrano
-namespace :deploy do
-  before :generate_otk, :setup_controlmaster do
-    invoke 'controlmaster:setup'
-  end
-end
-
 namespace :controlmaster do
   desc 'set up an SSH controlmaster process if missing'
   task :setup do

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

@@ -1,5 +1,5 @@
 desc 'display the deployed branch and commit'
-task deployed_branch: ['controlmaster:setup', 'otk:generate'] do
+task :deployed_branch do
   # see https://github.com/mattbrictson/airbrussh/tree/v1.5.2?tab=readme-ov-file#capistrano-34x
   Airbrussh.configure do |config|
     config.truncate = false

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

@@ -10,7 +10,7 @@ namespace :load do
 end
 
 desc "execute command on all servers"
-task :remote_execute, [:command] => ['controlmaster:setup', 'otk:generate'] do |_task, args|
+task :remote_execute, :command do |_task, args|
   raise ArgumentError, 'remote_execute task requires an argument' unless args[:command]
 
   # see https://github.com/mattbrictson/airbrussh/tree/v1.5.2?tab=readme-ov-file#capistrano-34x

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

@@ -0,0 +1,20 @@
+# Setup controlmaster SSH session before generating one-time-key
+before 'otk:generate', 'controlmaster:setup'
+
+DOES_NOT_REQUIRE_OTK_LIST = [
+  'bundler:map_bins',
+  'controlmaster:setup',
+  'controlmaster:start',
+  'default',
+  'deploy:generate_otk',
+  'install',
+  'load:defaults',
+  'otk:generate',
+  *Rake.application.stages
+].freeze
+
+Rake.application.tasks.each do |task|
+  next if DOES_NOT_REQUIRE_OTK_LIST.include?(task.name)
+
+  before task, 'deploy:generate_otk'
+end

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

@@ -0,0 +1,44 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :solid_queue_systemd_role, fetch(:solid_queue_systemd_role, :app)
+    set :solid_queue_systemd_use_hooks, fetch(:solid_queue_systemd_use_hooks, false)
+  end
+end
+
+# Integrate solid_queue hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_solid_queue_systemd_hooks do
+    invoke 'solid_queue_systemd:add_hooks' if fetch(:solid_queue_systemd_use_hooks)
+  end
+end
+
+namespace :solid_queue_systemd do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hooks do
+    after 'deploy:failed', 'solid_queue_systemd:restart'
+    after 'deploy:published', 'solid_queue_systemd:start'
+    after 'deploy:starting', 'solid_queue_systemd:stop'
+  end
+
+  desc 'Stop running workers gracefully'
+  task :stop do
+    on roles(fetch(:solid_queue_systemd_role)) do
+      sudo :systemctl, 'stop', 'solid_queue'
+    end
+  end
+
+  desc 'Start workers'
+  task :start do
+    on roles(fetch(:solid_queue_systemd_role)) do
+      sudo :systemctl, 'start', 'solid_queue'
+    end
+  end
+
+  desc 'Restart workers'
+  task :restart do
+    on roles(fetch(:solid_queue_systemd_role)) do
+      sudo :systemctl, 'restart', 'solid_queue', raise_on_non_zero_exit: false
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 desc "check ssh connections to all app servers"
-task ssh_check: ['controlmaster:setup', 'otk:generate'] do
+task :ssh_check do
   on roles(:app), in: :sequence do
     execute
   end

data/lib/dlss/capistrano.rb

@@ -3,3 +3,4 @@ require 'capistrano/bundle_audit'
 require 'capistrano/shared_configs'
 
 Dir.glob("#{__dir__}/capistrano/tasks/*.rake").each { |r| import r }
+Dir.glob("#{__dir__}/capistrano/tasks/setup/*.rake").each { |r| import r }

data/lib/dlss.rb

@@ -1,3 +1,3 @@
 module DLSS
   require 'dlss/capistrano'
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -119,8 +119,10 @@ files:
 - lib/dlss/capistrano/tasks/deployed_branch.rake
 - lib/dlss/capistrano/tasks/racecar_systemd.rake
 - lib/dlss/capistrano/tasks/remote_execute.rake
+- lib/dlss/capistrano/tasks/setup/setup.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
 - lib/dlss/capistrano/tasks/sneakers_systemd.rake
+- lib/dlss/capistrano/tasks/solid_queue_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
 - lib/dlss/capistrano/tasks/ssh_check.rake
 - lib/dlss/capistrano/tasks/strscan.rake
@@ -144,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects