rails_deploy 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3564ba244acf948ea7a9a9f7d3267faaf0b3f929f6c314a12c28e03fdcf64a8
-  data.tar.gz: abf70d1b3794309104729fe9af3c3f9e11dd81011e26e2f9f5b6c8c8f7968442
+  metadata.gz: fc86da3ccbf20d40bbfeb23a3806759997bc07c4f2fdfbfeb553be928a6e2afa
+  data.tar.gz: d808a59ae840e3876ca3668281f379b20131a434d010182fdac3f034236132d2
 SHA512:
-  metadata.gz: e96093aa30cc79be72038a03ebc348b1f327d20a41b4aca97bef076dee9ec2cc2cb239ceef25b8e9b94bcb20a0a97f96efb79cd368e9e5eedca98dd55a12a3c0
-  data.tar.gz: e4d20823dea402f665db01f98fdae6c69050104feab692fbb4f6e0fa1a03d957dbb51455e4cbeebcce420fb31b4a0ed7550eefb88da1312bf1c8f18a7ce8012b
+  metadata.gz: 4a258554d1c65717261826f4cf3a5b578203938e843b0701b09b85eb9913f04b9b1534a3214ae8f904792e7d0bf7f9a17528796d52c3c843d59dbbe02fa67955
+  data.tar.gz: ac4d3ab32456ca0750f342500c99f22b79201febe7173cf8135a5c445e10650961cdfa02f731cb243246ec787f76659b4cbc039ebcf5fa03b857f8d5e9211c8e

data/lib/kamal_override/configuration/docs/proxy.yml

@@ -0,0 +1,116 @@
+# Proxy
+#
+# Kamal uses [kamal-proxy](https://github.com/basecamp/kamal-proxy) to provide
+# gapless deployments. It runs on ports 80 and 443 and forwards requests to the
+# application container.
+#
+# The proxy is configured in the root configuration under `proxy`. These are
+# options that are set when deploying the application, not when booting the proxy.
+#
+# They are application-specific, so they are not shared when multiple applications
+# run on the same proxy.
+#
+# The proxy is enabled by default on the primary role but can be disabled by
+# setting `proxy: false`.
+#
+# It is disabled by default on all other roles but can be enabled by setting
+# `proxy: true` or providing a proxy configuration.
+proxy:
+
+  # Hosts
+  #
+  # The hosts that will be used to serve the app. The proxy will only route requests
+  # to this host to your app.
+  #
+  # If no hosts are set, then all requests will be forwarded, except for matching
+  # requests for other apps deployed on that server that do have a host set.
+  #
+  # Specify one of `host` or `hosts`.
+  host: foo.example.com
+  hosts:
+    - foo.example.com
+    - bar.example.com
+
+  # App port
+  #
+  # The port the application container is exposed on.
+  #
+  # Defaults to 80:
+  app_port: 3000
+
+  # SSL
+  #
+  # kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
+  #
+  # This requires that we are deploying to one server and the host option is set.
+  # The host value must point to the server we are deploying to, and port 443 must be
+  # open for the Let's Encrypt challenge to succeed.
+  #
+  # Defaults to `false`:
+  ssl: true
+
+  # Custom SSL certificate
+  #
+  # In scenarios where Let's Encrypt is not an option, or you already have your own
+  # certificates from a different Certificate Authority, you can configure kamal-proxy
+  # to load the certificate and the corresponding private key from disk.
+  #
+  # The certificate must be in PEM format and contain the full chain. The private key
+  # must also be in PEM format.
+  ssl_certificate_path: /data/cert/foo.example.com/fullchain.pem
+  ssl_private_key_path: /data/cert/foo.example.com/privkey.pem
+
+  # Response timeout
+  #
+  # How long to wait for requests to complete before timing out, defaults to 30 seconds:
+  response_timeout: 10
+
+  # Healthcheck
+  #
+  # When deploying, the proxy will by default hit `/up` once every second until we hit
+  # the deploy timeout, with a 5-second timeout for each request.
+  #
+  # Once the app is up, the proxy will stop hitting the healthcheck endpoint.
+  healthcheck:
+    interval: 3
+    path: /health
+    timeout: 3
+
+  # Buffering
+  #
+  # Whether to buffer request and response bodies in the proxy.
+  #
+  # By default, buffering is enabled with a max request body size of 1GB and no limit
+  # for response size.
+  #
+  # You can also set the memory limit for buffering, which defaults to 1MB; anything
+  # larger than that is written to disk.
+  buffering:
+    requests: true
+    responses: true
+    max_request_body: 40_000_000
+    max_response_body: 0
+    memory: 2_000_000
+
+  # Logging
+  #
+  # Configure request logging for the proxy.
+  # You can specify request and response headers to log.
+  # By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged:
+  logging:
+    request_headers:
+      - Cache-Control
+      - X-Forwarded-Proto
+    response_headers:
+      - X-Request-ID
+      - X-Request-Start
+
+  # Forward headers
+  #
+  # Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
+  #
+  # If you are behind a trusted proxy, you can set this to `true` to forward the headers.
+  #
+  # By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
+  # will forward them if it is set to `false`.
+  forward_headers: true

data/lib/kamal_override/configuration/validator/proxy.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module KamalOverride::Configuration::Validator
+  module Proxy
+
+    def validate!
+      super
+
+      if config['ssl_certificate_path'].present? && config['ssl_private_key_path'].blank?
+        error 'Must set a private key path to use a custom SSL certificate'
+      end
+
+      if config['ssl_private_key_path'].present? && config['ssl_certificate_path'].blank?
+        error 'Must set a certificate path to use a custom SSL private key'
+      end
+    end
+
+  end
+end
+
+Kamal::Configuration::Validator::Proxy.prepend KamalOverride::Configuration::Validator::Proxy

data/lib/kamal_override.rb

@@ -7,3 +7,5 @@ require 'kamal_override/commands/proxy'
 
 require 'kamal_override/configuration/proxy'
 require 'kamal_override/configuration/role'
+
+require 'kamal_override/configuration/validator/proxy'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_deploy
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Mingyuan Qin
@@ -54,8 +54,10 @@ files:
 - lib/kamal_override/commands/docker.rb
 - lib/kamal_override/commands/proxy.rb
 - lib/kamal_override/configuration.rb
+- lib/kamal_override/configuration/docs/proxy.yml
 - lib/kamal_override/configuration/proxy.rb
 - lib/kamal_override/configuration/role.rb
+- lib/kamal_override/configuration/validator/proxy.rb
 homepage: https://github.com/work-design/rails_deploy
 licenses:
 - MIT