dlss-capistrano-docker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b180b31a5354ceec3029befccbdeac4ba5c86321eb75a1beb369d0c24a5ebbd
+  data.tar.gz: 30865848d3ef1b7c5e86565641aed355c011cf85e5219999c112a1d234d353eb
+SHA512:
+  metadata.gz: f90641ba2d8b8c60c7f22e45dfc477f163732e9aeb3b89244b5b1563e09f10913c51cdb59464dc8d015c7b5f558655d01d7b9729fbe11b541603ab0504828a53
+  data.tar.gz: dddb973eaecac7511a4a6128cdf6a0e2b065226e0e8c40547204b191ae101cb5eb3010669551831ce1a8685fb10b8e86f5854ada8044815f3d548c59c71524c8

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,178 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  DisplayCopNames: true
+  Include:
+    - './Rakefile'              # rake only
+    - '**/*.rb'
+    - '**/*.rake'               # rake only
+
+Bundler/GemComment:
+  OnlyFor:
+    - restrictive_version_specifiers
+    - branch
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 120
+
+# consider if refactoring will improve adherence to SOLID and/or improve readability
+#  Sometimes splitting the class up won't improve readablity, it just makes reader jump around in the code.
+Metrics/ClassLength:
+  Max: 150 # default 100
+
+# consider if refactoring will improve adherence to SOLID and/or improve readability
+#  Sometimes splitting the method up won't improve readablity, it just makes reader jump around in the code.
+#  Good method names help.
+Metrics/MethodLength:
+  Max: 15 # default 10
+
+# capistrano tasks tend to be long.
+Metrics/BlockLength:
+  Enabled: false
+
+# "> 0", "== 0", "< 0" are not less readable than ".positive?", ".zero?" or ".negative?"
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SymbolArray:
+  MinSize: 4 # default 2
+
+Style/WordArray:
+  MinSize: 4 # default 2
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Dependencies are defined in dlss-capistrano-docker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    dlss-capistrano-docker (1.0.0)
+      capistrano (~> 3.0)
+      capistrano-one_time_key
+      capistrano-shared_configs
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.1)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    capistrano (3.17.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-one_time_key (0.1.0)
+      capistrano (~> 3.0)
+    capistrano-shared_configs (0.2.2)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (7.0.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    sshkit (1.21.3)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  bundler
+  byebug
+  dlss-capistrano-docker!
+  rake (>= 12.3.3)
+  rubocop (~> 1.0)
+
+BUNDLED WITH
+   2.3.22

data/README.md

@@ -0,0 +1,98 @@
+# dlss-capistrano-docker
+
+[![Gem Version](https://badge.fury.io/rb/dlss-capistrano-docker.svg)](https://badge.fury.io/rb/dlss-capistrano-docker)
+
+This gem provides Capistrano Docker deployment tasks used by Stanford Libraries' Digital Library Systems and Services group.
+
+It requires that the services to be run on a server be specified by a docker compose configuration file.
+
+## Included Tasks
+* `ssh`: establishes an SSH connection to the host running in environment, and changes into the current deployment directory.
+* `honeybadger:notify`: notifies Honeybadger of deploy using curl (thus, ruby is not required on host).
+* `docker:login`: log into Docker Hub. Logging in is required to avoid strict image download limits.
+* `docker:logout`: log out of Docker Hub.
+* `docker:prune`: prune docker artifacts to avoid filling disk space.
+* `docker_compose:migrate`: migrate the database.
+* `docker_compose:seed`: seed the database.
+* `docker_compose:build`: build images for the services.
+* `docker_compose:setup_rabbit`: create channel, queues, etc for RabbitMQ.
+* `docker_compose:restart`: down then up services.
+* `docker_compose:up`: stop services.
+* `docker_compose:down`: tear down services.
+* `docker_compose:copy_assets`: copy assets from a container to the server so they can be served by Apache.
+* `docker_compose:dereference_linked_files`: turn linked files into actual files.
+* `docker_compose:dereference_linked_dirs`: turn linked directories into actual directories containing actual files.
+
+## Hooks
+Hooks into the Capistrano lifecycle are provided for most of these tasks. These hooks can be controlled with variables, e.g., `docker_hub_use_hooks` to control the hooks for `docker:login` and `docker:logout`.
+
+In addition to tasks included in this gem, a hook is provided for `shared_configs:update`.
+
+## Usage
+For an example of any of the following, see https://github.com/sul-dlss/happy-heron
+
+### `Gemfile`
+* Add `gem 'dlss-capistrano-docker', require: false` to the deployment group.
+* Remove any gems that are removed from `Capfile` below.
+* Move puma gem from development/test dependencies to the application dependencies. (Puma will be used as the application server instead of Passenger.)
+
+### `Capfile`
+* Remove any of the following:
+```
+require 'capistrano/bundler'
+require 'capistrano/rails'
+require 'capistrano/honeybadger'
+require 'capistrano/passenger'
+require 'whenever/capistrano'
+require 'dlss/capistrano'
+```
+* Add `require 'dlss/docker/capistrano`
+
+### `config/deploy.rb`
+* For `:linked_files` remove `config/database.yml` and `config/secrets.yml` if present. Both of these will be provided by environment variables.
+* For `:linked_dirs` remove `tmp/pids`, `tmp/cache`, `tmp/sockets`, `public/system` if present. `log` and `config/settings` should remain.
+* Remove any sidekiq, sneakers, passenger, whenever, or shared_configs related settings.
+* Add `set :docker_compose_file, 'docker-compose.prod.yml'` to reference the production docker-compose file.
+* Optionally, add `set :docker_compose_seed_use_hooks, true` to perform seeding.
+* Optionally, add `set :docker_compose_rabbitmq_use_hooks, true` to perform Rabbitmq setup.
+* Note that there are other settings supported by this gem for additional configuration.
+
+### `config/deploy/<environment>.rb`
+* Each server should have the `app` role and any roles that correspond with profiles in the docker-compose file. This is what controls what services are run on the server.
+
+### `config/puma.rb`
+* Change `RAILS_MAX_THREAD` to `PUMA_MAX_THREAD` and `RAILS_MIN_THREAD` to `PUMA_MIN_THREAD`.
+* Enable workers with `workers ENV.fetch('PUMA_WORKERS', 2)`
+* Enable preload with `preload_app!`.
+
+### `config/schedule.rb`
+* Add `set :job_template, nil` to execute with sh instead of bash.
+
+### `Dockerfile`
+* When possible, base the image on Alpine (e.g., `FROM ruby:3.1-alpine`).
+* Processes should run as the application user (e.g., `h2`) not root, with user id and group id set to match the server.
+* If using Whenever, install Supercronic (which does not have to run as root) and write the crontab file during the build with `RUN sh -c 'bundle exec whenever . | tee -a config/crontab'`.
+* When possible, write to both a log file and stdout.
+* Precompile assets (`RUN bin/rails assets:precompile`) as part of the build. `SECRET_KEY_BASE` will need to be available for precompiling.
+
+### `docker-compose.prod.yml`
+* Duplicate configuration can be shared with fragments (e.g., `&environment` / `*environment`).
+* The command for a container can be overridden with `command:`, e.g., `command: bin/bundle exec rake sneakers:run 2>&1 | tee -a log/sneakers.log`.
+* Each service should be assigned to one or more profiles. These correspond to capistrano roles. For example:
+```
+profiles:
+  - cron
+```
+* Containers should link in the shared logs directory. For example:
+```
+volumes:
+  - /opt/app/h2/happy-heron/shared/log:/app/log
+```
+* Environment variables provided by the server should be passed through to the container. For example:
+```
+environment:
+ - HONEYBADGER_API_KEY
+```
+
+### `.dockerignore`
+Ignore `public.assets`

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require "bundler/gem_tasks"

data/dlss-capistrano-docker.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = "dlss-capistrano-docker"
+  s.version     = '1.0.0'
+
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Justin Littman']
+  s.email       = ['justinlittman@stanford.edu']
+  s.summary     = "Capistrano recipes for use in SUL/DLSS projects for docker deployment"
+  s.homepage    = 'https://github.com/sul-dlss/dlss-capistrano-docker'
+  s.license     = "Apache-2.0"
+
+  s.required_ruby_version = '>= 3.0', '< 4'
+
+  # All dependencies are runtime dependencies, since this gem's "runtime" is
+  # the dependent gem's development-time.
+  s.add_dependency "capistrano", "~> 3.0"
+  s.add_dependency "capistrano-one_time_key"
+  s.add_dependency "capistrano-shared_configs"
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'rake', '>= 12.3.3'
+  s.add_development_dependency 'rubocop', '~> 1.0'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :docker_prune_use_hooks, fetch(:docker_prune_use_hooks, true)
+    set :docker_hub_use_hooks, fetch(:docker_hub_use_hooks, true)
+  end
+end
+
+# Integrate hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_docker_hooks do
+    invoke 'docker:add_prune_hooks' if fetch(:docker_prune_use_hooks)
+    invoke 'docker:add_hub_hooks' if fetch(:docker_hub_use_hooks)
+  end
+end
+
+namespace :docker do
+  task :add_prune_hooks do
+    # Cleaning up docker on start so that images/logs are available for troubleshooting.
+    after 'deploy:starting', 'docker:prune'
+  end
+
+  task :add_hub_hooks do
+    after 'deploy:starting', 'docker:login'
+    after 'deploy:finishing', 'docker:logout'
+  end
+
+  desc 'Log in to Docker Hub'
+  task :login do
+    on roles(:app) do
+      execute(:docker, 'login', '-u', '$DOCKER_USERNAME', '-p', '$DOCKER_PASSWORD')
+    end
+  end
+
+  desc 'Log out of Docker Hub'
+  task :logout do
+    on roles(:app) do
+      execute(:docker, 'logout')
+    end
+  end
+
+  desc 'Prune unused images/containers'
+  task :prune do
+    on roles(:app) do
+      execute(:docker, 'system', 'prune', '-af')
+    end
+  end
+end

data/lib/dlss/docker/capistrano/tasks/docker_compose.rake

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :docker_compose_file, fetch(:docker_compose_file, 'docker-compose.yml')
+
+    set :docker_compose_migrate_use_hooks, fetch(:docker_compose_migrate_use_hooks, true)
+    set :migration_role, fetch(:migration_role, :db)
+    set :migration_servers, -> { primary(fetch(:migration_role)) }
+    set :migration_command, fetch(:migration_command, 'db:migrate')
+
+    set :docker_compose_seed_use_hooks, fetch(:docker_compose_seed_use_hooks, false)
+    set :seed_command, fetch(:migration_command, 'db:seed')
+
+    set :docker_compose_build_use_hooks, fetch(:docker_compose_build_use_hooks, true)
+    set :build_roles, fetch(:build_roles, [:app])
+    set :dereference_files, fetch(:dereference_files)
+    set :dereference_dirs, fetch(:dereference_dirs, [])
+
+    set :docker_compose_rabbitmq_use_hooks, fetch(:docker_compose_rabbit_use_hooks, false)
+    set :rabbitmq_role, fetch(:rabbitmq_role, :app)
+    set :rabbitmq_servers, -> { primary(fetch(:rabbitmq_role)) }
+    set :rabbitmq_command, fetch(:rabbitmq_command, 'rabbitmq:setup')
+
+    set :docker_compose_restart_use_hooks, fetch(:docker_compose_restart_use_hooks, true)
+
+    set :copy_assets_role, fetch(:copy_assets_role, :app)
+    set :assets_path, fetch(:assets_path, 'public/assets')
+    set :docker_compose_copy_assets_use_hooks, fetch(:docker_compose_copy_assets_use_hooks, true)
+  end
+end
+
+# Integrate hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_docker_hooks do
+    invoke 'docker_compose:add_migrate_hooks' if fetch(:docker_compose_migrate_use_hooks)
+    invoke 'docker_compose:add_seed_hooks' if fetch(:docker_compose_seed_use_hooks)
+    invoke 'docker_compose:add_build_hooks' if fetch(:docker_compose_build_use_hooks)
+    invoke 'docker_compose:add_rabbitmq_hooks' if fetch(:docker_compose_rabbitmq_use_hooks)
+    invoke 'docker_compose:add_restart_hooks' if fetch(:docker_compose_restart_use_hooks)
+    invoke 'docker_compose:add_copy_assets_hooks' if fetch(:docker_compose_copy_assets_use_hooks)
+  end
+end
+
+namespace :docker_compose do
+  task :add_migrate_hooks do
+    after 'deploy:publishing', 'docker_compose:migrate'
+  end
+
+  task :add_seed_hooks do
+    after 'deploy:publishing', 'docker_compose:seed'
+  end
+
+  task :add_build_hooks do
+    after 'deploy:updating', 'docker_compose:build'
+  end
+
+  task :add_rabbitmq_hooks do
+    after 'deploy:publishing', 'docker_compose:setup_rabbitmq'
+  end
+
+  task :add_restart_hooks do
+    after 'deploy:publishing', 'docker_compose:restart'
+  end
+
+  task :add_copy_assets_hooks do
+    after 'deploy:publishing', 'docker_compose:copy_assets'
+  end
+
+  desc 'Migrate database'
+  task :migrate do
+    on fetch(:migration_servers) do
+      within current_path do
+        execute(:docker, 'compose', '-f', fetch(:docker_compose_file), 'run', 'app', 'bin/rails',
+                fetch(:migration_command))
+      end
+      info 'Db migrated'
+    end
+  end
+
+  desc 'Seed database'
+  task :seed do
+    on fetch(:migration_servers) do
+      within current_path do
+        execute(:docker, 'compose', '-f', fetch(:docker_compose_file), 'run', 'app', 'bin/rails',
+                fetch(:seed_command))
+      end
+      info 'Db migrated'
+    end
+  end
+
+  desc 'Build images'
+  # Docker build does not dereference symlinks.
+  task build: [:dereference_linked_files, :dereference_linked_dirs] do
+    on roles(fetch(:build_roles)) do
+      info 'Building images'
+      within release_path do
+        execute(:docker, 'compose', '-f', fetch(:docker_compose_file), 'build')
+      end
+      info 'Docker images built'
+    end
+  end
+
+  desc 'Setup RabbitMQ'
+  task :setup_rabbitmq do
+    on fetch(:rabbitmq_servers) do
+      within current_path do
+        execute(:docker, 'compose', '-f', fetch(:docker_compose_file), 'run', 'app', 'bin/rake',
+                fetch(:rabbitmq_command))
+      end
+      info 'RabbitMQ setup'
+    end
+  end
+
+  desc 'Restart containers (down then up)'
+  task restart: [:down, :up]
+
+  desc 'Start containers'
+  task :up do
+    on roles(:app) do |server|
+      cmd = cmd_with_profiles(server)
+      cmd.concat(['up', '-d'])
+      within current_path do
+        execute(*cmd)
+        info 'Containers started'
+      end
+    end
+  end
+
+  desc 'Tear down containers'
+  task :down do
+    on roles(:app) do |server|
+      cmd = cmd_with_profiles(server)
+      cmd.concat(['down'])
+      within current_path do
+        execute(*cmd)
+        info 'Containers down'
+      end
+    end
+  end
+
+  desc 'Copy assets'
+  task :copy_assets do
+    assets_path = fetch(:assets_path)
+    on roles(fetch(:copy_assets_role)) do
+      within current_path do
+        # Can't do a direct copy to public/assets because it is a symlink.
+        execute(:docker, 'compose', '-f', fetch(:docker_compose_file), 'cp',
+                'app:/app/public/assets', '.')
+        execute(:rm, '-fr', "#{assets_path}/*")
+        execute(:mkdir, assets_path)
+        execute(:cp, 'assets/*', "#{assets_path}/")
+      end
+      info 'Assets copied'
+    end
+  end
+
+  desc 'Dereference linked files'
+  task :dereference_linked_files do
+    dereference_files = fetch(:dereference_files) || fetch(:linked_files, [])
+    next if dereference_files.empty?
+
+    on roles(fetch(:build_roles)) do
+      dereference_files.each do |file|
+        target = release_path.join(file)
+        source = shared_path.join(file)
+        execute :rm, target if test "[ -L #{target} ]"
+        execute :cp, source, target
+      end
+    end
+  end
+
+  desc 'Dereference linked directories'
+  task :dereference_linked_dirs do
+    dereference_dirs = fetch(:dereference_dirs)
+    next if dereference_dirs.empty?
+
+    on roles(fetch(:build_roles)) do
+      dereference_dirs.each do |dir|
+        target = release_path.join(dir)
+        source = shared_path.join(dir)
+        next unless test "[ -L #{target} ]"
+
+        execute :rm, target
+        execute :cp, '-r', source, target
+      end
+    end
+  end
+
+  def cmd_with_profiles(server)
+    cmd = [:docker, 'compose', '-f', fetch(:docker_compose_file)]
+    server.roles.each do |role|
+      cmd.concat(['--profile', role.to_s])
+    end
+    cmd
+  end
+end

data/lib/dlss/docker/capistrano/tasks/honeybadger.rake

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :honeybadger_use_hooks, fetch(:honeybadger_use_hooks, true)
+  end
+end
+
+# Integrate hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_honeybadger_hooks do
+    invoke 'honeybadger:add_hooks' if fetch(:honeybadger_use_hooks)
+  end
+end
+
+namespace :honeybadger do
+  task :add_hooks do
+    after 'deploy:finishing', 'honeybadger:notify'
+  end
+
+  # Replaces honeybadger:deploy to use curl instead of invoking ruby.
+  # Adapted from https://github.com/honeybadger-io/honeybadger-ruby/blob/master/vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap
+  desc 'Notify Honeybadger of a deploy (using the API via curl)'
+  task notify: %i[deploy:set_current_revision] do
+    fetch(:honeybadger_server) do
+      if (s = primary(:app))
+        set(:honeybadger_server, s.select?({ exclude: :no_release }) ? s : nil)
+      end
+    end
+
+    if (server = fetch(:honeybadger_server))
+      revision = fetch(:current_revision)
+
+      on server do |_host|
+        info 'Notifying Honeybadger of deploy.'
+
+        honeybadger_config = nil
+        within release_path do
+          honeybadger_config = capture(:cat, 'config/honeybadger.yml')
+        end
+        remote_api_key = YAML.safe_load(honeybadger_config)['api_key']
+        remote_api_key = capture(:echo, '$HONEYBADGER_API_KEY') if remote_api_key.nil?
+
+        options = {
+          'deploy[environment]' => fetch(:honeybadger_env, fetch(:rails_env, 'production')),
+          'deploy[local_username]' => fetch(:honeybadger_user, ENV['USER'] || ENV.fetch('USERNAME', nil)),
+          'deploy[revision]' => revision,
+          'deploy[repository]' => fetch(:repo_url),
+          'api_key' => fetch(:honeybadger_api_key, ENV.fetch('HONEYBADGER_API_KEY', nil)) || remote_api_key
+        }
+        data = options.to_a.map { |pair| pair.join('=') }.join('&')
+        execute(:curl, '--no-progress-meter', '--data', "\"#{data}\"", 'https://api.honeybadger.io/v1/deploys')
+        info 'Honeybadger notification complete.'
+      end
+    end
+  end
+end

data/lib/dlss/docker/capistrano/tasks/shared_configs.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :shared_configs_use_hooks, fetch(:shared_configs_use_hooks, true)
+  end
+end
+
+# Integrate hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_shared_configs_hooks do
+    invoke 'shared_configs:add_hooks' if fetch(:shared_configs_use_hooks)
+  end
+end
+
+namespace :shared_configs do
+  task :add_hooks do
+    before 'deploy:updating', 'shared_configs:update'
+  end
+end

data/lib/dlss/docker/capistrano/tasks/ssh.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+desc 'ssh to the current directory on the server'
+task :ssh do
+  on roles(:app), primary: true do |host|
+    command = "cd #{fetch(:deploy_to)}/current && exec $SHELL -l"
+    puts command if fetch(:log_level) == :debug
+    exec "ssh -l #{host.user} #{host.hostname} -p #{host.port || 22} -t '#{command}'"
+  end
+end

data/lib/dlss/docker/capistrano.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'capistrano/one_time_key'
+require 'capistrano/shared_configs'
+
+Dir.glob("#{__dir__}/capistrano/tasks/*.rake").each { |r| import r }

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: dlss-capistrano-docker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Littman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-one_time_key
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-shared_configs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- justinlittman@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- dlss-capistrano-docker.gemspec
+- lib/dlss/docker/capistrano.rb
+- lib/dlss/docker/capistrano/tasks/docker.rake
+- lib/dlss/docker/capistrano/tasks/docker_compose.rake
+- lib/dlss/docker/capistrano/tasks/honeybadger.rake
+- lib/dlss/docker/capistrano/tasks/shared_configs.rake
+- lib/dlss/docker/capistrano/tasks/ssh.rake
+homepage: https://github.com/sul-dlss/dlss-capistrano-docker
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Capistrano recipes for use in SUL/DLSS projects for docker deployment
+test_files: []