dlss-capistrano 3.10.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f3e0a3a28fd4c039e6e2a861b16603911fe806ad71ca1aee18ffedb6e17ef9
-  data.tar.gz: c272545718a09a47b2cc2cd523edc55a6cd43c6b71453d390a14da1464d756d5
+  metadata.gz: 931006fc1c1c2b1bd0edad5c66284a68646ded0b1eb86977a9f456f5967d0aa1
+  data.tar.gz: 7d9be758e297514f2783c09ead222dd3a5ff56cdb7832a98c2582c4774583660
 SHA512:
-  metadata.gz: 5cbb9b707d0ff42c95c15e97f08a70bfd02a19cdc7fda35ca112571c907e911e43a1451a8ca3cccebe902db757fa5f4a6f31fc86fd63ef5976cf8047a525021e
-  data.tar.gz: a9b908df522ad9696ca5b99b9235c77016fc3eaf9c7665fba277c5b3f48bb4ccf964c9c7c696339cbd204b99245587713e75fc8af24913a5c72d9732de14408e
+  metadata.gz: 8455409ed588234cb13623dd80231a6dfb8976f1d17a2de2c46086f7327d5616920fd4b3724d7d928dc4bdf0dbe0ffc3ec88668177c94c85f886ee047dc69a16
+  data.tar.gz: 1a7e14b5f5e83dba8b59f85f22074e76b4298a8e43756dc4b6fe57e9de9639c89d60c7f9a4bf15a6ae17043bf6690640b1d4be3d9bea87754433b284276dce33

data/README.md

@@ -6,20 +6,21 @@ This gem provides Capistrano deployment tasks used by Stanford Libraries' Digita
 
 ## Included Tasks
 
-### Bundle 2-style Configuration
+### Remote Execution
 
-To override the capistrano-bundler gem and use Bundler 2-style configuration without using deprecated arguments, you can set the following settings in `config/deploy.rb`:
+Sometimes you want to execute a command on all boxes in a given environment, and dlss-capistrano's got your back:
 
-```ruby
-set :bundler2_config_use_hook, true # this is how to opt-in to bundler 2-style config. it's false by default
-set :bundler2_config_roles, [:app] # feel free to add roles to this array if you need them
-set :bundler2_config_deployment, true # this is true by default
-set :bundler2_config_without, 'production' # exclude development, and test bundle groups by default
-set :bundler2_config_path, '/tmp' # set to '#{shared_path}/bundle' by default
+```shell
+$ cap qa remote_execute["ps -ef | grep rolling | grep -v grep"]
+00:00 remote_execute
+      ps -ef | grep rolling | grep -v grep
+      ps -ef | grep rolling | grep -v grep
+      dor-indexing-app-qa-a.stanford.edu:
+dor_ind+  9159     1 20 Feb18 ?        14:15:03 rolling index
+      dor-indexing-app-qa-b.stanford.edu:
+dor_ind+ 29689     1 20 Feb18 ?        14:24:53 rolling index
 ```
 
-Note that only `bundler2_config_use_hook` **must** be set in order to use this functionality.
-
 ### Sidekiq symlink
 
 Every time the version of Sidekiq or Ruby changes, a corresponding Puppet PR must be made in order to update the XSendFilePath that allows Apache to access the bundled Sidekiq gem's assets. dlss-capistrano provides a hook to create a symlink to the bundled Sidekiq to avoid having to do this:
@@ -70,6 +71,11 @@ after 'deploy:publishing', 'resque:pool:hot_swap'
 
 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:{stop,start,restart}`: 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.*:
@@ -105,7 +111,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.10.1"
+  s.version     = '4.0.0'
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

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

@@ -0,0 +1,9 @@
+desc "execute command on all servers"
+task :remote_execute, :command do |_task, args|
+  raise ArgumentError, 'remote_execute task requires an argument' unless args[:command]
+
+  on roles(:all) do |host|
+    info args[:command] if fetch(:log_level) == :debug
+    info "#{host}:\n#{capture(args[:command])}"
+  end
+end

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

@@ -0,0 +1,44 @@
+# 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:stop'
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -87,10 +87,11 @@ files:
 - 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/remote_execute.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
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-# These tasks exist because capistrano-bundler does not yet have a built-in
-# mechanism for configuring bundler 2 without deprecation warnings. We can dump
-# this if/when https://github.com/capistrano/bundler/issues/115 is resolved.
-
-def default_bundle_path
-  Pathname.new("#{shared_path}/bundle")
-end
-
-namespace :load do
-  task :defaults do
-    # This provides opt-in behavior. Do nothing if not requested.
-    set :bundler2_config_use_hook, fetch(:bundler2_config_use_hook, false)
-    set :bundler2_config_roles, fetch(:bundler2_config_roles, [:app])
-    set :bundler2_config_deployment, fetch(:bundler2_config_deployment, true)
-    set :bundler2_config_without, fetch(:bundler2_config_without, 'development:test')
-    # NOTE: `shared_path` is not defined at this point, so we can't set the default value to `default_bundle_path`
-    set :bundler2_config_path, fetch(:bundler2_config_path, nil)
-  end
-end
-
-# Integrate bundle config hook into Capistrano
-namespace :deploy do
-  before :starting, :add_bundler2_config_hook do
-    invoke 'bundler2:add_hook' if fetch(:bundler2_config_use_hook)
-  end
-end
-
-namespace :bundler2 do
-  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
-  task :add_hook do
-    # Override capistrano-bundler settings
-    # HT: https://github.com/capistrano/bundler/issues/115#issuecomment-616570236
-    set :bundle_flags, '--quiet' # this unsets --deployment, see details in config_bundler task details
-    set :bundle_path, nil
-    set :bundle_without, nil
-
-    before 'bundler:install', 'bundler2:config'
-  end
-
-  # NOTE: This task lacks a `desc` to avoid publishing it, since we do not
-  #       foresee needing to run this task manually. It should run via hook.
-  #
-  # Configure bundler 2 without using deprecated arguments (overrides capistrano-bundler
-  task :config do
-    on roles fetch(:bundler2_config_roles) do
-      execute "bundle config --local deployment #{fetch(:bundler2_config_deployment)}"
-      execute "bundle config --local without '#{fetch(:bundler2_config_without)}'"
-      execute "bundle config --local path #{fetch(:bundler2_config_path) || default_bundle_path}"
-    end
-  end
-end