SRCH-5370: Add capistrano configurations.

Capfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# Load the SCM plugin appropriate to your project:
+#
+# require "capistrano/scm/hg"
+# install_plugin Capistrano::SCM::Hg
+# or
+# require "capistrano/scm/svn"
+# install_plugin Capistrano::SCM::Svn
+# or
+require 'capistrano/scm/git'
+install_plugin Capistrano::SCM::Git
+
+SSHKit.config.command_map[:bundle] = 'bin/bundle'
+
+# Include tasks from other gems included in your Gemfile
+#
+require "capistrano/rbenv"
+require "capistrano/bundler"
+# require "capistrano/rails/assets"
+# require "capistrano/rails/migrations"
+# require "capistrano/passenger"
+# require 'capistrano/rails'
+
+# Web server plugins
+require 'capistrano/puma'
+require 'capistrano/puma/workers'
+
+
+install_plugin Capistrano::Puma, load_hooks: false
+install_plugin Capistrano::Puma::Systemd
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

Gemfile

@@ -21,14 +21,24 @@ gem 'rake', '~> 13.0.0'
 
 gem "rails_semantic_logger", "~> 4.14"
 
+gem 'puma', '~> 5.6'
+
+gem 'dotenv', '~> 3.1'
+
 group :development, :test do
   gem 'rspec-rails', '~> 3.7'
   gem 'pry-byebug', '~> 3.4'
   gem 'pry-rails', '~> 0.3'
   gem 'awesome_print', '~> 1.8' #To enable in Pry: https://github.com/awesome-print/awesome_print#pry-integration
   gem 'listen'
-  gem 'puma',  '~> 5.6'
   gem 'debug'
+
+  # Deployment
+  gem 'capistrano', require: false
+  gem 'capistrano-rails', require: false
+  gem 'capistrano-rbenv', require: false
+  gem 'capistrano3-puma', require: false
+  gem 'capistrano-newrelic', require: false
 end
 
 group :development do

Gemfile.lock

@@ -75,6 +75,8 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
+    airbrussh (1.5.2)
+      sshkit (>= 1.6.1, != 1.7.0)
     ast (2.4.2)
     awesome_print (1.9.2)
     axiom-types (0.1.1)
@@ -85,6 +87,26 @@ GEM
     bigdecimal (3.1.7)
     builder (3.2.4)
     byebug (11.1.3)
+    capistrano (3.19.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-bundler (2.1.0)
+      capistrano (~> 3.1)
+    capistrano-newrelic (0.10.1)
+      capistrano (~> 3.0)
+      newrelic_rpm
+    capistrano-rails (1.6.3)
+      capistrano (~> 3.1)
+      capistrano-bundler (>= 1.1, < 3)
+    capistrano-rbenv (2.2.0)
+      capistrano (~> 3.1)
+      sshkit (~> 1.3)
+    capistrano3-puma (5.2.0)
+      capistrano (~> 3.7)
+      capistrano-bundler
+      puma (>= 4.0, < 6.0)
     codeclimate-test-reporter (1.0.9)
       simplecov (<= 0.13)
     coderay (1.1.3)
@@ -216,8 +238,13 @@ GEM
       net-protocol
     net-protocol (0.2.2)
       timeout
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-sftp (4.0.0)
+      net-ssh (>= 5.0.0, < 8.0.0)
     net-smtp (0.5.0)
       net-protocol
+    net-ssh (7.2.3)
     newrelic_rpm (9.10.2)
     nio4r (2.7.1)
     nokogiri (1.16.5)
@@ -368,6 +395,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    sshkit (1.23.0)
+      base64
+      net-scp (>= 1.1.2)
+      net-sftp (>= 2.1.2)
+      net-ssh (>= 2.8.0)
     stringio (3.1.0)
     strscan (3.1.0)
     thor (1.3.1)
@@ -394,6 +426,11 @@ PLATFORMS
 
 DEPENDENCIES
   awesome_print (~> 1.8)
+  capistrano
+  capistrano-newrelic
+  capistrano-rails
+  capistrano-rbenv
+  capistrano3-puma
   codeclimate-test-reporter (~> 1.0.8)
   debug
   dotenv

config/application.rb

@@ -49,6 +49,6 @@ class Application < Rails::Application
     # Middleware like session, flash, cookies can be added back manually.
     # Skip views, helpers and assets when generating a new resource.
     config.api_only = true
-    config.hosts    << "i14y" if ENV["DOCKER"]
+    config.secret_key_base = ENV["i14y_SECRET_KEY_BASE"]
   end
 end

config/deploy.rb

@@ -0,0 +1,21 @@
+# config valid for current version and patch releases of Capistrano
+lock '~> 3.19.1'
+
+# Set the directory to deploy to
+set :deploy_to, ENV['DEPLOYMENT_PATH']
+
+# Use rbenv to manage Ruby versions
+set :rbenv_type, :user
+set :rbenv_ruby, '3.1.4'
+
+set :linked_dirs, %w{
+  log
+  tmp/pids
+  tmp/sockets
+  tmp/cache
+}
+
+set :linked_files, %w{
+  config/secrets.yml
+  .env
+}

config/deploy/production.rb

@@ -0,0 +1,61 @@
+# server-based syntax
+# ======================
+# Defines a single server with a list of roles and multiple properties.
+# You can define all roles on a single server, or split them:
+
+# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value
+# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value
+# server "db.example.com", user: "deploy", roles: %w{db}
+
+
+
+# role-based syntax
+# ==================
+
+# Defines a role with one or multiple servers. The primary server in each
+# group is considered to be the first unless any hosts have the primary
+# property set. Specify the username and a domain or IP for the server.
+# Don't use `:all`, it's a meta role.
+
+# role :app, %w{[email protected]}, my_property: :my_value
+# role :web, %w{[email protected] [email protected]}, other_property: :other_value
+# role :db,  %w{[email protected]}
+
+
+
+# Configuration
+# =============
+# You can set any configuration variable like in config/deploy.rb
+# These variables are then only loaded and set in this stage.
+# For available Capistrano configuration variables see the documentation page.
+# http://capistranorb.com/documentation/getting-started/configuration/
+# Feel free to add new variables to customise your setup.
+
+
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a
+# limited set of options, consult the Net::SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+#
+# Global options
+# --------------
+#  set :ssh_options, {
+#    keys: %w(/home/user_name/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+#
+# The server-based syntax can be used to override options:
+# ------------------------------------
+# server "example.com",
+#   user: "user_name",
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: "user_name", # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: "please use keys"
+#   }

config/deploy/staging.rb

@@ -0,0 +1,50 @@
+# config/deploy/staging.rb
+
+# Server-based syntax
+# ======================
+# Defines a single server with a list of roles and multiple properties.
+# You can define all roles on a single server, or split them:
+
+server ENV['SERVER_ADDRESS'], user: ENV['SERVER_DEPLOYMENT_USER'], roles: %w{app db web}
+
+set :application, 'i14y'
+set :repo_url, 'https://github.com/luisgmetzger/i14y'
+set :branch, 'SRCH-5370'
+
+# Configuration
+# =============
+# You can set any configuration variable like in config/deploy.rb.
+# These variables are then only loaded and set in this stage.
+# For available Capistrano configuration variables see the documentation page.
+# http://capistranorb.com/documentation/getting-started/configuration/
+# Feel free to add new variables to customize your setup.
+
+set :rails_env, 'production'
+set :bundle_without, %w{development test}.join(' ')
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a limited set of options, consult the Net/SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+
+# Global options
+# --------------
+set :ssh_options, {
+  keys: [ENV['SSH_KEY_PATH']],
+  forward_agent: false,
+  auth_methods: %w(publickey)
+}
+
+# Keep only the last 5 releases to save disk space
+set :keep_releases, 5
+set :puma_rackup, -> { File.join(current_path, 'config.ru') }
+set :puma_state, "#{shared_path}/tmp/pids/puma.state"
+set :puma_pid, "#{shared_path}/tmp/pids/puma.pid"
+set :puma_access_log, "#{release_path}/log/puma.access.log"
+set :puma_error_log, "#{release_path}/log/puma.error.log"
+set :puma_threads, [0, 8]
+set :puma_workers, 0
+set :puma_worker_timeout, nil
+set :puma_init_active_record, true
+set :puma_preload_app, false
+set :puma_bind, "tcp://0.0.0.0:8081"

config/environments/development.rb

@@ -42,4 +42,9 @@
 
   # Annotate rendered view with file names.
   # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Enable DNS rebinding protection and other `Host` header attacks.
+  config.hosts << "i14y.staging.search.usa.gov"
+  # Skip DNS rebinding protection for the default health check endpoint.
+  config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
 end

config/environments/production.rb

@@ -71,10 +71,7 @@
   end
 
   # Enable DNS rebinding protection and other `Host` header attacks.
-  # config.hosts = [
-  #   "example.com",     # Allow requests from example.com
-  #   /.*\.example\.com/ # Allow requests from subdomains like `www.example.com`
-  # ]
+  config.hosts << "i14y.staging.search.usa.gov"
   # Skip DNS rebinding protection for the default health check endpoint.
-  # config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
+  config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
 end

config/puma.rb

@@ -10,34 +10,20 @@
 
 # Specifies the `worker_timeout` threshold that Puma will use to wait before
 # terminating a worker in development environments.
-#
 worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
 
+# Comment out the port setting if you are using bind
 # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
-#
-port ENV.fetch("PORT") { 3000 }
+# port ENV.fetch("PORT") { 3000 }
 
 # Specifies the `environment` that Puma will run in.
-#
 environment ENV.fetch("RAILS_ENV") { "development" }
 
 # Specifies the `pidfile` that Puma will use.
 pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
 
-# Specifies the number of `workers` to boot in clustered mode.
-# Workers are forked web server processes. If using threads and workers together
-# the concurrency of the application would be max `threads` * `workers`.
-# Workers do not work on JRuby or Windows (both of which do not support
-# processes).
-#
-# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
-
-# Use the `preload_app!` method when specifying a `workers` number.
-# This directive tells Puma to first boot the application and load code
-# before forking the application. This takes advantage of Copy On Write
-# process behavior so workers use less memory.
-#
-# preload_app!
+# Use the bind directive to specify the address and port to listen on
+bind "tcp://0.0.0.0:8081"
 
-# Allow puma to be restarted by `rails restart` command.
+# Allow puma to be restarted by `bin/rails restart` command.
 plugin :tmp_restart