capistrano-cookbook 0.2.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f162871e5691b88542a956397a7b4df77c2271c
-  data.tar.gz: 9952c146e703099ad3c7010c6bd33e99e20be20e
+SHA256:
+  metadata.gz: 6196d2ecf217984aa66e19657b8ebfd58b0202b70d5c33bbcdf7b3e5385ccddd
+  data.tar.gz: 84eaad2671892ed175d1cc8e605fb7f7a935a484a310d3ae8a29355acee50050
 SHA512:
-  metadata.gz: 486676444621788abd40123422b1cf26eb729191b338295c3372d276c35811b7f7b1e3e8be5e723481728fd46c3fd7c803077bf5ca5c6657b0a388de2df63856
-  data.tar.gz: 446e750c72872ec6f84a9b52e7fddb5158673e552c221503d8d93844864cfcbbfa8dcde01fc9aee69f581825d9fa0615309cb28aea33c055a1fb008a8b4af46b
+  metadata.gz: 11507790fa3e84d2897565a729714cbe766b97e1d33169bd796901ac26fefdf4fc01253df4508d5a9929cb6fafdbe5397e8214a10abdb4484685409d62515b09
+  data.tar.gz: 0e218729f6040493dc87f900e8af733c31fa913ee1ac916d7da0138c459efe6a23cd6163871a308c1b4efcdcc8f55d967c9e111223398ac0f01f782f49dbf47a

data/README.md

@@ -16,9 +16,44 @@ Or install it yourself as:
 
     $ gem install capistrano-cookbook
 
+## Versioning
+
+This gem is primarily intended to provide a batteries included approach to getting Rails applications up and running. It is tested with the server configuration in <https://github.com/TalkingQuickly/rails-server-template>.
+
+Major versions of the rails server template above and this gem stay in sync. So Version X.*.* of this gem should provide a working out of the box capistrano configuration when used with version X.*.* of the server template.
+
+Major and minor versions of this gem, the server template and the book [Reliably Deploying Rails Applications](https://leanpub.com/deploying_rails_applications) also stay in sync. Updates to the book are free for life so on a new project, it's always advisable to make sure you have the latest version.
+
 ## Usage
 
-### Including Tasks
+### Boostrap
+
+To generate a complete Capistrano configuration include the gem in your Gemfile and then use the following Rails Generator:
+
+```
+bundle exec rails g capistrano:reliably_deploying_rails:bootstrap --sidekiq --production_hostname='YOUR_PRODUCTION_DOMAIN' --production_server_address='YOUR_PRODUCTION_SERVER'
+```
+
+Replacing `YOUR_PRODUCTION_DOMAIN` with the domain name people will access the Rails app on and `YOUR_PRODUCTION_SERVER` with the address or ip that can be used to access the server via SSH, these may be the same thing but often will not be (e.g. if the domain has a CDN or Load Balancer between it and the server you're deploying to),
+
+This will generate a complete Capistrano configuration.
+
+You can then execute:
+
+```
+bundle exec cap production deploy:setup_config
+bundle exec cap production database:create
+```
+
+To perform setup tasks and create a new empty database. Followed by:
+
+```
+bundle exec cap production deploy
+```
+
+To kick off you first deploy.
+
+### Including Tasks Manually
 
 To include all tasks from the gem, add the following to your `Capfile`:
 
@@ -35,7 +70,6 @@ require 'capistrano/cookbook/create_database'
 require 'capistrano/cookbook/logs'
 require 'capistrano/cookbook/monit'
 require 'capistrano/cookbook/nginx'
-require 'capistrano/cookbook/restart'
 require 'capistrano/cookbook/run_tests'
 require 'capistrano/cookbook/setup_config'
 ```
@@ -126,20 +160,6 @@ cap STAGE nginx:restart
 cap STAGE nginx:remove_default_vhost
 ```
 
-#### Restart
-
-Provides Commands for interacting with the Unicorn app server via an `init.d` script.
-
-Usage:
-
-``` bash
-cap STAGE deploy:start
-cap STAGE deploy:stop
-cap STAGE deploy:force-stop
-cap STAGE deploy:restart
-cap STAGE deploy:upgrade
-```
-
 #### Run Tests
 
 Allows a test suite to be automatically run with `rspec`, if the tests pass the deploy will continue, if they fail, the deploy will halt and the test output will be displayed.

data/capistrano-cookbook.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'capistrano', '~>  3.2'
+  spec.add_dependency 'capistrano', '~>  3.16'
+  spec.add_dependency 'capistrano3-puma', '~>  5.0.4'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/capistrano/cookbook.rb

@@ -6,9 +6,9 @@ module Capistrano
     require 'capistrano/cookbook/logs'
     require 'capistrano/cookbook/monit'
     require 'capistrano/cookbook/nginx'
-    require 'capistrano/cookbook/restart'
     require 'capistrano/cookbook/run_tests'
     require 'capistrano/cookbook/setup_config'
     require 'capistrano/cookbook/create_database'
+    require 'capistrano/cookbook/systemd'
   end
 end

data/lib/capistrano/cookbook/helpers/setup_config_values.rb

@@ -16,42 +16,46 @@ module Capistrano
       private
 
       def symlinks_defaults
-        [
-          {
-            source: "nginx.conf",
-            link: "/etc/nginx/sites-enabled/{{full_app_name}}"
-          },
-          {
-            source: "unicorn_init.sh",
-            link: "/etc/init.d/unicorn_{{full_app_name}}"
-          },
+        base = [
           {
             source: "log_rotation",
-           link: "/etc/logrotate.d/{{full_app_name}}"
+            link: "/etc/logrotate.d/{{full_app_name}}"
+          }
+        ]
+        return base unless sidekiq_enabled?
+
+        base + [
+          {
+            source: "sidekiq.service.capistrano",
+            link: "/etc/systemd/system/#{fetch(:sidekiq_service_unit_name)}.service"
           },
           {
-            source: "monit",
-            link: "/etc/monit/conf.d/{{full_app_name}}.conf"
+            source: "sidekiq_monit",
+            link: "/etc/monit/conf.d/#{fetch(:full_app_name)}_sidekiq.conf"
           }
         ]
       end
 
       def executable_config_files_defaults
         %w(
-          unicorn_init.sh
         )
       end
 
       def config_files_defaults
-        %w(
-          nginx.conf
+        base = %w(
           database.example.yml
           log_rotation
-          monit
-          unicorn.rb
-          unicorn_init.sh
-          secrets.yml
         )
+        return base unless sidekiq_enabled?
+
+        base + %w(
+          sidekiq.service.capistrano
+          sidekiq_monit
+        )
+      end
+
+      def sidekiq_enabled?
+        defined?(Capistrano::Sidekiq) == 'constant' && Capistrano::Sidekiq.class == Class
       end
     end
   end

data/lib/capistrano/cookbook/helpers/template.rb

@@ -24,10 +24,12 @@ def smart_template(from, to=nil)
 end
 
 def template_file(name)
-  if File.exist?((file = "config/deploy/#{fetch(:full_app_name)}/#{name}.erb"))
+  if File.exist?((file = "config/deploy/#{fetch(:stage)}/#{name}.erb"))
     return file
   elsif File.exist?((file = "config/deploy/shared/#{name}.erb"))
     return file
+  elsif File.exist?((file = "config/deploy/templates/#{name}.erb"))
+    return file
   elsif File.exist?(file = File.expand_path("../templates/#{name}.erb",File.dirname(__FILE__)))
     return file    
   end

data/lib/capistrano/cookbook/systemd.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/systemd.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/tasks/check_revision.cap

@@ -12,5 +12,3 @@ namespace :deploy do
     end
   end
 end
-
-before 'deploy', 'deploy:check_revision'

data/lib/capistrano/cookbook/tasks/nginx.cap

@@ -11,11 +11,13 @@ namespace :nginx do
   desc "Remove default Nginx Virtual Host"
   task "remove_default_vhost" do 
     on roles(:app) do
-      if test("[ -f /etc/nginx/sites-enabled/default ]")
-      sudo "rm /etc/nginx/sites-enabled/default"
-      puts "removed default Nginx Virtualhost"
-      else
-        puts "No default Nginx Virtualhost to remove"
+      %w(/etc/nginx/sites-enabled/default /etc/nginx/sites-enabled/000-default).each do |default_filename|
+        if test("[ -f #{default_filename} ]")
+          sudo "rm #{default_filename}"
+          puts "Removed default Nginx Virtualhost: #{default_filename}"
+        else
+          puts "Default: #{default_filename} not found, not removed"
+        end
       end
     end
   end

data/lib/capistrano/cookbook/tasks/run_tests.cap

@@ -2,7 +2,7 @@ namespace :deploy do
   desc "Runs test before deploying, can't deploy unless they pass"
   task :run_tests do
     test_log = "log/capistrano.test.log"
-    tests = fetch(:tests, [])
+    tests = fetch(:tests)
     tests.each do |test|
       puts "--> Running tests: '#{test}', please wait ..."
       unless system "bundle exec rspec #{test} > #{test_log} 2>&1"
@@ -16,5 +16,3 @@ namespace :deploy do
     system "rm #{test_log}"
   end
 end
-
-before 'deploy', 'deploy:run_tests'

data/lib/capistrano/cookbook/tasks/setup_config.cap

@@ -9,6 +9,7 @@ require 'securerandom'
 namespace :deploy do
   task :setup_config do
     conf = ::Capistrano::Cookbook::SetupConfigValues.new
+
     on roles(:app) do
       # make the config dir
       execute :mkdir, "-p #{shared_path}/config"
@@ -28,18 +29,29 @@ namespace :deploy do
       conf.symlinks.each do |symlink|
         sudo "ln -nfs #{shared_path}/config/#{symlink[:source]} #{sub_strings(symlink[:link])}"
       end
+
+      if File.exists?(File.join('config', 'master.key'))
+        upload! File.join('config', 'master.key'), File.join(shared_path, 'config', 'master.key')
+      end
     end
   end
 end
 
-# remove the default nginx configuration as it will tend
-# to conflict with our configs.
+
+# remove the default nginx configuration as it will tend to conflict with our configs
 before 'deploy:setup_config', 'nginx:remove_default_vhost'
 
-# reload nginx to it will pick up any modified vhosts from
-# setup_config
+# After setup config has generated and setup initial files, run the Capistrano Puma
+# tasks responsible for uploading config files. Note that `setup_config` creates overrides
+# for these in `config/deploy/templates` so we're not using the default ones from the gem
+after 'deploy:setup_config', 'puma:config'
+after 'deploy:setup_config', 'puma:nginx_config'
+after 'deploy:setup_config', 'puma:monit:config'
+after 'deploy:setup_config', 'puma:systemd:config'
+
+# reload nginx to it will pick up any modified vhosts from setup_config
 after 'deploy:setup_config', 'nginx:reload'
 
-# Restart monit so it will pick up any monit configurations
-# we've added
+# Restart monit so it will pick up any monit configurations we've added
 after 'deploy:setup_config', 'monit:reload'
+

data/lib/capistrano/cookbook/tasks/systemd.cap

@@ -0,0 +1,17 @@
+namespace :puma do
+  namespace :systemd do
+    desc 'Reload the puma service via systemd by sending USR1 (e.g. trigger a zero downtime deploy)'
+    task :reload do
+      on roles(fetch(:puma_role)) do
+        if fetch(:puma_systemctl_user) == :system
+          sudo "#{fetch(:puma_systemctl_bin)} reload-or-restart #{fetch(:puma_service_unit_name)}"
+        else
+          execute "#{fetch(:puma_systemctl_bin)}", "--user", "reload", fetch(:puma_service_unit_name)
+          execute :loginctl, "enable-linger", fetch(:puma_lingering_user) if fetch(:puma_enable_lingering)
+        end
+      end
+    end
+  end
+end
+
+after 'deploy:finished', 'puma:systemd:reload'

data/lib/capistrano/cookbook/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Cookbook
-    VERSION = "0.2.1"
+    VERSION = "5.0.0"
   end
 end

data/lib/generators/capistrano/reliably_deploying_rails/bootstrap_generator.rb

@@ -0,0 +1,68 @@
+require 'fileutils'
+
+module Capistrano
+  module ReliablyDeployingRails
+    module Generators
+      class BootstrapGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+        desc "Bootstrap everything required to deploy with capistrano to a server configured with: https://github.com/TalkingQuickly/rails-server-template"
+        class_option :sidekiq, type: :boolean, default: false
+        class_option :production_hostname, type: :string, default: nil
+        class_option :production_server_address, type: :string, default: nil
+
+        def setup
+          @production_hostname = options[:production_hostname] || 'YOUR_PRODUCTION_HOSTNAME'
+          @production_server_address = options[:production_server_address] || 'YOUR_PRODUCTION_SERVER_ADDRESS'
+          @generate_sidekiq = options[:sidekiq]
+        end
+
+        def create_capfile
+          template "Capfile.erb", 'Capfile'
+        end
+
+        def create_deployment_configuration
+          FileUtils.mkdir_p 'config/deploy'
+          template "deploy.rb.erb", 'config/deploy.rb'
+          template "production.rb.erb", 'config/deploy/production.rb'
+          template "staging.rb.erb", 'config/deploy/staging.rb'
+        end
+
+        def create_local_config_templates
+          FileUtils.mkdir_p 'config/deploy/templates'
+          base_path = File.expand_path('../templates', __FILE__)
+
+          templates(@generate_sidekiq).each do |file|
+            unless File.file?(file)
+              copy_file(File.join(base_path, file), "config/deploy/templates/#{file}")
+            end
+          end
+        end
+
+        private
+
+        def templates(generate_sidekiq)
+          return puma_templates unless generate_sidekiq
+          puma_templates + sidekiq_templates
+        end
+
+        def puma_templates
+          %w(
+            nginx_conf.erb
+            puma_monit.conf.erb
+            puma.rb.erb
+            puma.service.erb
+            sidekiq_monit.erb
+            sidekiq.service.capistrano.erb
+          )
+        end
+
+        def sidekiq_templates
+          %w(
+            sidekiq_monit.erb
+            sidekiq.service.capistrano.erb
+          )
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/reliably_deploying_rails/templates/Capfile.erb

@@ -0,0 +1,46 @@
+# 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
+
+# Include tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#
+require "capistrano/rbenv"
+require "capistrano/bundler"
+require "capistrano/rails/assets"
+require "capistrano/rails/migrations"
+require 'capistrano/cookbook'
+
+require 'capistrano/puma'
+install_plugin Capistrano::Puma, load_hooks: false  # Default puma tasks
+install_plugin Capistrano::Puma::Nginx, load_hooks: false   # if you want to upload a nginx site template
+install_plugin Capistrano::Puma::Systemd, load_hooks: false # if you use SystemD 
+install_plugin Capistrano::Puma::Monit, load_hooks: false  # if you need the monit tasks
+
+<% if @generate_sidekiq %>
+require 'capistrano/sidekiq'
+install_plugin Capistrano::Sidekiq  # Default sidekiq tasks
+# Then select your service manager
+install_plugin Capistrano::Sidekiq::Systemd 
+<% end %>
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }

data/lib/generators/capistrano/reliably_deploying_rails/templates/deploy.rb.erb

@@ -0,0 +1,42 @@
+# config valid for current version and patch releases of Capistrano
+lock "~> 3.16.0"
+
+set :application, '<%= Rails.application.class.module_parent_name.underscore %>'
+set :deploy_user, 'deploy'
+
+# setup repo details
+set :repo_url, '<%= `git config --get remote.origin.url`.delete!("\n") %>'
+
+# setup rbenv.
+set :rbenv_type, :system
+set :rbenv_ruby, '3.0.0'
+set :rbenv_prefix, "RBENV_ROOT=#{fetch(:rbenv_path)} RBENV_VERSION=#{fetch(:rbenv_ruby)} #{fetch(:rbenv_path)}/bin/rbenv exec"
+set :rbenv_map_bins, %w{rake gem bundle ruby rails}
+
+<% if @generate_sidekiq %>
+# Setup sidekiq, make sure we run sidekiq as our deployment user, otherwise
+# it will default to root which a) is insecture and b) will lead to lots of
+# strange permissions issues
+set :sidekiq_service_unit_user, :system
+set :sidekiq_user, fetch(:deploy_user)
+<% end %>
+
+# setup puma to operate in clustered mode, required for zero downtime deploys
+set :puma_preload_app, false
+set :puma_init_active_record, true
+set :puma_workers, 3
+
+# how many old releases do we want to keep, not much
+set :keep_releases, 5
+
+# Directories that should be linked to the shared folder
+append :linked_dirs, 'log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', '.bundle', 'public/system', 'public/uploads'
+append :linked_files, 'config/database.yml', 'config/master.key'
+
+# this:
+# http://www.capistranorb.com/documentation/getting-started/flow/
+# is worth reading for a quick overview of what tasks are called
+# and when for `cap stage deploy`
+
+namespace :deploy do
+end

data/lib/generators/capistrano/reliably_deploying_rails/templates/nginx_conf.erb

@@ -0,0 +1,105 @@
+upstream puma_<%= fetch(:nginx_config_name) %> { <%
+  @backends = [fetch(:puma_bind)].flatten.map do |m|
+  etype, address  = /(tcp|unix|ssl):\/{1,2}(.+)/.match(m).captures
+  if etype == 'unix'
+    "server #{etype}:#{address} #{fetch(:nginx_socket_flags)};"
+  else
+    "server #{address.gsub(/0\.0\.0\.0(.+)/, "127.0.0.1\\1")} #{fetch(:nginx_http_flags)};"
+  end
+end
+%><% @backends.each do |server| %>
+  <%= server %><% end %>
+}
+<% if fetch(:nginx_use_ssl) -%>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_server_name) %>;
+  return 301 https://$host$1$request_uri;
+}
+<% end -%>
+
+server {
+<% if fetch(:nginx_use_ssl) -%>
+  <% if fetch(:nginx_use_http2) -%>
+  listen 443 ssl http2;
+  <% else -%>
+  listen 443 ssl;
+  <% end -%>
+<% if fetch(:nginx_ssl_certificate) -%>
+  ssl_certificate <%= fetch(:nginx_ssl_certificate) %>;
+<% else -%>
+  ssl_certificate /etc/ssl/certs/<%= fetch(:nginx_config_name) %>.crt;
+<% end -%>
+<% if fetch(:nginx_ssl_certificate_key) -%>
+  ssl_certificate_key <%= fetch(:nginx_ssl_certificate_key) %>;
+<% else -%>
+  ssl_certificate_key /etc/ssl/private/<%= fetch(:nginx_config_name) %>.key;
+<% end -%>
+<% else -%>
+  listen 80;
+<% end -%>
+  server_name <%= fetch(:nginx_server_name) %>;
+  root <%= current_path %>/public;
+  try_files $uri/index.html $uri @puma_<%= fetch(:nginx_config_name) %>;
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_http_version 1.1;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header Host $host;
+    proxy_redirect off;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "Upgrade";
+    proxy_headers_hash_max_size 512;
+    proxy_headers_hash_bucket_size 128;
+<% if fetch(:nginx_use_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+<% else -%>
+  <% if fetch(:nginx_downstream_uses_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+  <% else -%>
+    proxy_set_header X-Forwarded-Proto http;
+  <% end -%>
+<% end -%>
+    proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
+    # limit_req zone=one;
+    access_log <%= shared_path %>/log/nginx.access.log;
+    error_log <%= shared_path %>/log/nginx.error.log;
+  }
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  location = /50x.html {
+    root html;
+  }
+
+  location = /404.html {
+    root html;
+  }
+
+  location @503 {
+    error_page 405 = /system/maintenance.html;
+    if (-f $document_root/system/maintenance.html) {
+      rewrite ^(.*)$ /system/maintenance.html break;
+    }
+    rewrite ^(.*)$ /503.html break;
+  }
+
+  if ($request_method !~ ^(GET|HEAD|PUT|PATCH|POST|DELETE|OPTIONS)$ ){
+    return 405;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+}

data/lib/generators/capistrano/reliably_deploying_rails/templates/production.rb.erb

@@ -0,0 +1,30 @@
+set :stage, :production
+set :branch, "master"
+
+# This is used in the Nginx VirtualHost to specify which domains
+# the app should appear on. If you don't yet have DNS setup, you'll
+# need to create entries in your local Hosts file for testing.
+set :nginx_server_name, '<%= @production_hostname %>'
+
+# used in case we're deploying multiple versions of the same
+# app side by side. Also provides quick sanity checks when looking
+# at filepaths
+set :full_app_name, "#{fetch(:application)}_#{fetch(:stage)}"
+
+<% if @generate_sidekiq %>
+# Name sidekiq systemd service after the app and stage name so that
+# multiple apps and stages can co-exist on the same machine if needed
+set :sidekiq_service_unit_name, "#{fetch(:full_app_name)}_sidekiq"
+<% end %>
+
+server '<%= @production_server_address %>', user: 'deploy', roles: %w{web app db}, primary: true
+
+set :deploy_to, "/home/#{fetch(:deploy_user)}/apps/#{fetch(:full_app_name)}"
+
+# dont try and infer something as important as environment from
+# stage name.
+set :rails_env, :production
+
+# whether we're using ssl or not, used for building nginx
+# config file
+set :enable_ssl, false

data/lib/generators/capistrano/reliably_deploying_rails/templates/puma.rb.erb

@@ -0,0 +1,53 @@
+#!/usr/bin/env puma
+
+directory '<%= current_path %>'
+rackup "<%=fetch(:puma_rackup)%>"
+environment '<%= fetch(:puma_env) %>'
+<% if fetch(:puma_tag) %>
+tag '<%= fetch(:puma_tag)%>'
+<% end %>
+pidfile "<%=fetch(:puma_pid)%>"
+state_path "<%=fetch(:puma_state)%>"
+
+
+threads <%=fetch(:puma_threads).join(',')%>
+
+<%= puma_plugins %>
+
+<%= puma_bind %>
+<% if fetch(:puma_control_app) %>
+activate_control_app "<%= fetch(:puma_default_control_app) %>"
+<% end %>
+workers <%= puma_workers %>
+<% if fetch(:puma_worker_timeout) %>
+worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
+<% end %>
+
+<% if puma_daemonize? %>
+daemonize
+<% end %>
+
+restart_command '<%= fetch(:puma_restart_command) %>'
+
+<% if puma_preload_app? %>
+preload_app!
+<% else %>
+prune_bundler
+<% end %>
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{current_path}/Gemfile") %>"
+end
+
+<% if puma_preload_app? and fetch(:puma_init_active_record) %>
+before_fork do
+  ActiveRecord::Base.connection_pool.disconnect!
+end
+
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end
+<% end %>

data/lib/generators/capistrano/reliably_deploying_rails/templates/puma.service.erb

@@ -0,0 +1,29 @@
+[Unit]
+Description=Puma HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=network.target
+
+[Service]
+Type=simple
+<%="User=#{puma_user(@role)}" if fetch(:puma_systemctl_user) == :system %>
+WorkingDirectory=<%= current_path %>
+ExecStart=/usr/local/rbenv/bin/rbenv exec bundle exec puma -C <%= fetch(:puma_conf) %>
+ExecReload=/bin/kill -USR1 $MAINPID
+ExecStop=/bin/kill -TSTP $MAINPID
+StandardOutput=append:<%= fetch(:puma_access_log) %>
+StandardError=append:<%= fetch(:puma_error_log) %>
+<%="EnvironmentFile=#{fetch(:puma_service_unit_env_file)}" if fetch(:puma_service_unit_env_file) %>
+
+<% fetch(:puma_service_unit_env_vars, []).each do |environment_variable| %>
+<%="Environment=#{environment_variable}" %>
+<% end %>
+
+Environment=RBENV_VERSION=<%= fetch(:rbenv_ruby) %>
+Environment=RBENV_ROOT=/usr/local/rbenv
+
+Restart=always
+RestartSec=1
+
+SyslogIdentifier=puma_<%= fetch(:application) %>_<%= fetch(:stage) %>
+
+[Install]
+WantedBy=<%=(fetch(:puma_systemctl_user) == :system) ? "multi-user.target" : "default.target"%>

data/lib/generators/capistrano/reliably_deploying_rails/templates/puma_monit.conf.erb

@@ -0,0 +1,7 @@
+# Monit configuration for Puma
+# Service name: <%= puma_monit_service_name %>
+#
+check process <%= puma_monit_service_name %>
+  with pidfile "<%= fetch(:puma_pid) %>"
+  start program = "/usr/bin/systemctl start <%= fetch(:puma_service_unit_name) %>"
+  stop program = "/usr/bin/systemctl stop <%= fetch(:puma_service_unit_name) %>"

data/lib/generators/capistrano/reliably_deploying_rails/templates/sidekiq.service.capistrano.erb

@@ -0,0 +1,30 @@
+<% # Adapted from: https://github.com/seuros/capistrano-sidekiq/blob/master/lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb %>
+
+[Unit]
+Description=sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=syslog.target network.target
+
+[Service]
+Type=simple
+WorkingDirectory=<%= File.join(fetch(:deploy_to), 'current') %>
+ExecStart=/usr/local/rbenv/bin/rbenv exec bundle exec sidekiq -e <%= fetch(:sidekiq_env) %>
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+<%="StandardOutput=append:#{fetch(:sidekiq_log)}" if fetch(:sidekiq_log) %>
+<%="StandardError=append:#{fetch(:sidekiq_error_log)}" if fetch(:sidekiq_error_log) %>
+<%="User=#{fetch(:sidekiq_user)}" if fetch(:sidekiq_user) %>
+<%="EnvironmentFile=#{fetch(:sidekiq_service_unit_env_file)}" if fetch(:sidekiq_service_unit_env_file) %>
+<% fetch(:sidekiq_service_unit_env_vars, []).each do |environment_variable| %>
+  <%="Environment=#{environment_variable}" %>
+<% end %>
+
+Environment=RBENV_VERSION=<%= fetch(:rbenv_ruby) %>
+Environment=RBENV_ROOT=/usr/local/rbenv
+
+RestartSec=1
+Restart=on-failure
+
+SyslogIdentifier=sidekiq_<%= fetch(:application) %>_<%= fetch(:stage) %>
+
+[Install]
+WantedBy=default.target

data/lib/generators/capistrano/reliably_deploying_rails/templates/sidekiq_monit.erb

@@ -0,0 +1,4 @@
+check process <%= fetch(:sidekiq_service_unit_name) %> matching "sidekiq.*<%= fetch(:full_app_name) %>"  
+  start program = "/usr/bin/systemctl start <%= fetch(:sidekiq_service_unit_name) %>"
+  stop program = "/usr/bin/systemctl stop <%= fetch(:sidekiq_service_unit_name) %>"
+  group <%= fetch(:sidekiq_monit_group) || fetch(:full_app_name) %>-sidekiq

data/lib/generators/capistrano/reliably_deploying_rails/templates/staging.rb.erb

@@ -0,0 +1,30 @@
+set :stage, :staging
+set :branch, "develop"
+
+# This is used in the Nginx VirtualHost to specify which domains
+# the app should appear on. If you don't yet have DNS setup, you'll
+# need to create entries in your local Hosts file for testing.
+set :nginx_server_name, "REPLACE_WITH_YOUR_STAGING_HOSTNAME"
+
+# used in case we're deploying multiple versions of the same
+# app side by side. Also provides quick sanity checks when looking
+# at filepaths
+set :full_app_name, "#{fetch(:application)}_#{fetch(:stage)}"
+
+<% if @generate_sidekiq %>
+# Name sidekiq systemd service after the app and stage name so that
+# multiple apps and stages can co-exist on the same machine if needed
+set :sidekiq_service_unit_name, "#{fetch(:full_app_name)}_sidekiq"
+<% end %>
+
+server 'YOUR_STAGING_SERVER_IP', user: 'deploy', roles: %w{web app db}, primary: true
+
+set :deploy_to, "/home/#{fetch(:deploy_user)}/apps/#{fetch(:full_app_name)}"
+
+# dont try and infer something as important as environment from
+# stage name.
+set :rails_env, :production
+
+# whether we're using ssl or not, used for building nginx
+# config file
+set :enable_ssl, false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-cookbook
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Ben Dixon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.16'
+- !ruby/object:Gem::Dependency
+  name: capistrano3-puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,29 +91,34 @@ files:
 - lib/capistrano/cookbook/logs.rb
 - lib/capistrano/cookbook/monit.rb
 - lib/capistrano/cookbook/nginx.rb
-- lib/capistrano/cookbook/restart.rb
 - lib/capistrano/cookbook/run_tests.rb
 - lib/capistrano/cookbook/setup_config.rb
+- lib/capistrano/cookbook/systemd.rb
 - lib/capistrano/cookbook/tasks/check_revision.cap
 - lib/capistrano/cookbook/tasks/compile_assets_locally.cap
 - lib/capistrano/cookbook/tasks/create_database.cap
 - lib/capistrano/cookbook/tasks/logs.cap
 - lib/capistrano/cookbook/tasks/monit.cap
 - lib/capistrano/cookbook/tasks/nginx.cap
-- lib/capistrano/cookbook/tasks/restart.cap
 - lib/capistrano/cookbook/tasks/run_tests.cap
 - lib/capistrano/cookbook/tasks/setup_config.cap
+- lib/capistrano/cookbook/tasks/systemd.cap
 - lib/capistrano/cookbook/templates/database.example.yml.erb
 - lib/capistrano/cookbook/templates/log_rotation.erb
-- lib/capistrano/cookbook/templates/mongoid.example.yml.erb
-- lib/capistrano/cookbook/templates/monit.erb
-- lib/capistrano/cookbook/templates/nginx.conf.erb
-- lib/capistrano/cookbook/templates/secrets.yml.erb
 - lib/capistrano/cookbook/templates/sidekiq.yml.erb
 - lib/capistrano/cookbook/templates/sidekiq_init.sh.erb
-- lib/capistrano/cookbook/templates/unicorn.rb.erb
-- lib/capistrano/cookbook/templates/unicorn_init.sh.erb
 - lib/capistrano/cookbook/version.rb
+- lib/generators/capistrano/reliably_deploying_rails/bootstrap_generator.rb
+- lib/generators/capistrano/reliably_deploying_rails/templates/Capfile.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/deploy.rb.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/nginx_conf.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/production.rb.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/puma.rb.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/puma.service.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/puma_monit.conf.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/sidekiq.service.capistrano.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/sidekiq_monit.erb
+- lib/generators/capistrano/reliably_deploying_rails/templates/staging.rb.erb
 homepage: https://github.com/TalkingQuickly/capistrano-cookbook
 licenses:
 - MIT
@@ -119,8 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Selection of Capistrano 3 tasks to reduce boilerplate required when deploying

data/lib/capistrano/cookbook/restart.rb

@@ -1 +0,0 @@
-load File.expand_path("tasks/restart.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/tasks/restart.cap

@@ -1,13 +0,0 @@
-namespace :deploy do
-  desc 'Commands for unicorn application'
-  %w(start stop force-stop restart upgrade reopen-logs).each do |command|
-    task command.to_sym do
-      on roles(:app), in: :sequence, wait: 5 do
-        sudo "/etc/init.d/unicorn_#{fetch(:full_app_name)} #{command}"
-      end
-    end
-  end
-end
-
-# Automatically restart after a deploy
-after 'deploy', 'deploy:restart'

data/lib/capistrano/cookbook/templates/mongoid.example.yml.erb

@@ -1,69 +0,0 @@
-<%= fetch(:rails_env) %>:
-  # Configure available database sessions. (required)
-  sessions:
-    # Defines the default session. (required)
-    default:
-      # Defines the name of the default database that Mongoid can connect to.
-      # (required).
-      database: <%= "#{fetch(:application)}_#{fetch(:rails_env)}" %>
-      # Provides the hosts the default session can connect to. Must be an array
-      # of host:port pairs. (required)
-      hosts:
-        - localhost
-      options:
-        # Change whether the session persists in safe mode by default.
-        # (default: false)
-         safe: true
-
-        # Change the default consistency model to :eventual or :strong.
-        # :eventual will send reads to secondaries, :strong sends everything
-        # to master. (default: :eventual)
-        # consistency: :eventual
-
-        # How many times Moped should attempt to retry an operation after
-        # failure. (default: 30)
-        # max_retries: 30
-
-        # The time in seconds that Moped should wait before retrying an
-        # operation on failure. (default: 1)
-        # retry_interval: 1
-  # Configure Mongoid specific options. (optional)
-  options:
-    # Configuration for whether or not to allow access to fields that do
-    # not have a field definition on the model. (default: true)
-    # allow_dynamic_fields: true
-
-    # Enable the identity map, needed for eager loading. (default: false)
-     identity_map_enabled: true
-
-    # Includes the root model name in json serialization. (default: false)
-    # include_root_in_json: false
-
-    # Include the _type field in serializaion. (default: false)
-    # include_type_for_serialization: false
-
-    # Preload all models in development, needed when models use
-    # inheritance. (default: false)
-    # preload_models: false
-
-    # Protect id and type from mass assignment. (default: true)
-    # protect_sensitive_fields: true
-
-    # Raise an error when performing a #find and the document is not found.
-    # (default: true)
-    # raise_not_found_error: true
-
-    # Raise an error when defining a scope with the same name as an
-    # existing method. (default: false)
-    # scope_overwrite_exception: false
-
-    # Skip the database version check, used when connecting to a db without
-    # admin access. (default: false)
-    # skip_version_check: false
-
-    # User Active Support's time zone in conversions. (default: true)
-
-    # Ensure all times are UTC in the app side. (default: false)
-     use_utc: true
-
-

data/lib/capistrano/cookbook/templates/monit.erb

@@ -1,22 +0,0 @@
-<% application = fetch(:application) %>
-set mail-format { subject: <%= "#{fetch(:full_app_name)} - #{fetch(:rails_env)}" %> $SERVICE $EVENT at $DATE }
-
-check process unicorn_<%=application%>
-  with pidfile <%= current_path %>/tmp/pids/unicorn.pid
-  start program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> start"
-  stop program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> stop"
-  if mem is greater than 300.0 MB for 1 cycles then restart       # eating up memory?
-  if cpu is greater than 50% for 2 cycles then alert                  # send an email to admin
-  if cpu is greater than 80% for 30 cycles then restart                # hung process?
-  group unicorn
-
-<% (0..(fetch(:unicorn_worker_count) -1)).each do |worker| %>
-  check process unicorn_<%= application %>_worker_<%= (5000 + worker).to_s %>
-    with pidfile <%= current_path %>/tmp/pids/unicorn.<%= (5000 + worker).to_s %>.pid
-    start program = "/bin/true"
-    stop program = "/etc/init.d/unicorn_<%= application %>_<%= fetch(:rails_env)%> kill_worker <%= (5000 + worker).to_s %>"
-    if mem is greater than 350.0 MB for 1 cycles then restart
-    if cpu is greater than 80% for 30 cycles then restart
-
-    group unicorn_workers
-<% end %>

data/lib/capistrano/cookbook/templates/nginx.conf.erb

@@ -1,57 +0,0 @@
-upstream unicorn_<%= fetch(:full_app_name) %> {
-  server unix:/tmp/unicorn.<%= fetch(:full_app_name) %>.sock fail_timeout=0;
-}
-
-server {
-  listen 80;
-  root <%= fetch(:deploy_to) %>/current/public;
-  server_name <%= fetch(:server_name) %>;
-
-  location ^~ /assets/ {
-    gzip_static on;
-    expires max;
-    add_header Cache-Control public;
-  }
-
-  try_files $uri/index.html $uri @unicorn;
-  location @unicorn {
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header Host $http_host;
-    proxy_redirect off;
-    proxy_pass http://unicorn_<%= fetch(:full_app_name) %>;
-  }
-
-  error_page 500 502 503 504 /500.html;
-  client_max_body_size 4G;
-  keepalive_timeout 10;
-}
-
-<% if fetch(:enable_ssl) %>
-server {
-  listen 443 default deferred;
-  root <%= fetch(:deploy_to) %>/current/public;
-  server_name <%= fetch(:server_name) %>;
-
-  location ^~ /assets/ {
-    gzip_static on;
-    expires max;
-    add_header Cache-Control public;
-  }
-
-  try_files $uri/index.html $uri @unicorn;
-  location @unicorn {
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header   X-Forwarded-Proto https;
-    proxy_set_header Host $http_host;
-    proxy_redirect off;
-    proxy_pass http://unicorn_<%= fetch(:full_app_name) %>;
-  }
-
-  error_page 500 502 503 504 /500.html;
-  client_max_body_size 4G;
-  keepalive_timeout 10;
-  ssl on;
-  ssl_certificate <%= fetch(:deploy_to) %>/shared/ssl_cert.crt;
-  ssl_certificate_key <%= fetch(:deploy_to) %>/shared/ssl_private_key.key;
-}
-<% end %>

data/lib/capistrano/cookbook/templates/secrets.yml.erb

@@ -1,2 +0,0 @@
-<%= fetch(:rails_env) %>:
-  secret_key_base: <%= SecureRandom.hex(60) %>

data/lib/capistrano/cookbook/templates/unicorn.rb.erb

@@ -1,41 +0,0 @@
-root = "<%= current_path %>"
-working_directory root
-pid "#{root}/tmp/pids/unicorn.pid"
-stderr_path "#{root}/log/unicorn.log"
-stdout_path "#{root}/log/unicorn.log"
-
-listen "/tmp/unicorn.<%= fetch(:full_app_name) %>.sock"
-worker_processes <%= fetch(:unicorn_worker_count) %>
-timeout 40
-preload_app true
-
-# Force unicorn to look at the Gemfile in the current_path
-# otherwise once we've first started a master process, it
-# will always point to the first one it started.
-before_exec do |server|
-  ENV['BUNDLE_GEMFILE'] = "<%= current_path %>/Gemfile"
-end
-
-before_fork do |server, worker|
-   defined?(ActiveRecord::Base) and
-    ActiveRecord::Base.connection.disconnect!
-  # Quit the old unicorn process
-  old_pid = "#{server.config[:pid]}.oldbin"
-  if File.exists?(old_pid) && server.pid != old_pid
-    puts "We've got an old pid and server pid is not the old pid"
-    begin
-      Process.kill("QUIT", File.read(old_pid).to_i)
-      puts "killing master process (good thing tm)"
-    rescue Errno::ENOENT, Errno::ESRCH
-      puts "unicorn master already killed"
-    end
-  end
-end
-
-after_fork do |server, worker|
-  port = 5000 + worker.nr
-  child_pid = server.config[:pid].sub('.pid', ".#{port}.pid")
-  system("echo #{Process.pid} > #{child_pid}")
-   defined?(ActiveRecord::Base) and
-    ActiveRecord::Base.establish_connection
-end

data/lib/capistrano/cookbook/templates/unicorn_init.sh.erb

@@ -1,86 +0,0 @@
-#!/bin/sh
-set -e
-
-# Feel free to change any of the following variables for your app:
-TIMEOUT=${TIMEOUT-60}
-APP_ROOT=<%= current_path %>
-PID_DIR=$APP_ROOT/tmp/pids
-PID=$PID_DIR/unicorn.pid
-CMD="cd $APP_ROOT;  bundle exec unicorn -D -c <%= "#{shared_path}/config/unicorn.rb" %> -E <%= fetch(:rails_env) %>"
-AS_USER=deploy
-set -u
-
-OLD_PIN="$PID.oldbin"
-
-sig () {
-  test -s "$PID" && kill -$1 `cat $PID`
-}
-
-oldsig () {
-  test -s $OLD_PIN && kill -$1 `cat $OLD_PIN`
-}
-
-workersig () {
-  workerpid="$APP_ROOT/tmp/pids/unicorn.$2.pid"
-  
-  test -s "$workerpid" && kill -$1 `cat $workerpid`
-}
-
-run () {
-  if [ "$(id -un)" = "$AS_USER" ]; then
-    eval $1
-  else
-    su -c "$1" - $AS_USER
-  fi
-}
-
-case "$1" in
-start)
-  sig 0 && echo >&2 "Already running" && exit 0
-  run "$CMD"
-  ;;
-stop)
-  sig QUIT && exit 0
-  echo >&2 "Not running"
-  ;;
-force-stop)
-  sig TERM && exit 0
-  echo >&2 "Not running"
-  ;;
-kill_worker)
-  workersig QUIT $2 && exit 0
-  echo >&2 "Worker not running"
-  ;;
-restart|reload)
-  sig USR2 && echo reloaded OK && exit 0
-  echo >&2 "Couldn't reload, starting '$CMD' instead"
-  run "$CMD"
-  ;;
-upgrade)
-  if sig USR2 && sleep 2 && sig 0 && oldsig QUIT
-  then
-    n=$TIMEOUT
-    while test -s $OLD_PIN && test $n -ge 0
-    do
-      printf '.' && sleep 1 && n=$(( $n - 1 ))
-    done
-    echo
-
-    if test $n -lt 0 && test -s $OLD_PIN
-    then
-      echo >&2 "$OLD_PIN still exists after $TIMEOUT seconds"
-      exit 1
-    fi
-    exit 0
-  fi
-  echo >&2 "Couldn't upgrade, starting '$CMD' instead"
-  run "$CMD"
-  ;;
-reopen-logs)
-  sig USR1
-  ;;
-*)
-  echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop|reopen-logs>"
-  exit 1
-  ;;
-esac