kamal 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a154bea7b15565394f37d8cbbfc8860e3d6ef337526779390ebd96d917d2d7e
-  data.tar.gz: a08c4cd341c5404cd9a5401b24918cdd32d498dbb778a655e1cb7f667030e519
+  metadata.gz: c8f7525b3ed804be2810d0af353c254b8c7ebf4d5cf5916dbfa97d5bf4615d54
+  data.tar.gz: adfac172b3e4b45bc00092317bde87395fcedecf107b30c8500ab58097ef22d8
 SHA512:
-  metadata.gz: b09103e638d6d14d9605d3327928cf0343a80ff213e9e7f5f42d0c372c60ab78b13e30a983b1dc47e75cb17d7b705e94c98ea73077b8a2e1f87959f684e7a71d
-  data.tar.gz: db80e53f84048c1ee6a5f2d3a010469578cbeedb94826b2393dcd4552f9e063c70b42242b3ea705c659c02a9cc87b7311c8e372d106148bea5baaa261cf7811d
+  metadata.gz: 05150f9253685ce18dd910cf809a99e51449b7452536e6c3f39c8e37d5ce3db4806bd8e198ed3e29aa872523eb8937db5b58faee036619f8e5b43d1084eebffc
+  data.tar.gz: 47e77a8d347c44aff4326f9927a0933c0240b5bfdb90f1b623e85ecdad8ba48c0e3443d43cd062b265aa29e2dbd47d778499be39a079d3cb93d8856cb0388108

data/README.md

@@ -6,7 +6,7 @@ From bare metal to cloud VMs, deploy web apps anywhere with zero downtime. Kamal
 
 ## Contributing to the documentation
 
-Please help us improve Kamal's documentation on the [the basecamp/kamal-site repository](https://github.com/basecamp/kamal-site).
+Please help us improve Kamal's documentation on [the basecamp/kamal-site repository](https://github.com/basecamp/kamal-site).
 
 ## License
 

data/lib/kamal/cli/alias/command.rb

@@ -1,8 +1,8 @@
 class Kamal::Cli::Alias::Command < Thor::DynamicCommand
   def run(instance, args = [])
-    if (_alias = KAMAL.config.aliases[name])
+    if (command = KAMAL.resolve_alias(name))
       KAMAL.reset
-      Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
+      Kamal::Cli::Main.start(Shellwords.split(command) + ARGV[1..-1])
     else
       super
     end

data/lib/kamal/cli/base.rb

@@ -5,6 +5,8 @@ module Kamal::Cli
   class Base < Thor
     include SSHKit::DSL
 
+    VERBOSITY = { verbose: :debug, quiet: :error }.freeze
+
     def self.exit_on_failure?() true end
     def self.dynamic_command_class() Kamal::Cli::Alias::Command end
 
@@ -43,11 +45,11 @@ module Kamal::Cli
         KAMAL.tap do |commander|
           if options[:verbose]
             ENV["VERBOSE"] = "1" # For backtraces via cli/start
-            commander.verbosity = :debug
+            commander.verbosity = VERBOSITY[:verbose]
           end
 
           if options[:quiet]
-            commander.verbosity = :error
+            commander.verbosity = VERBOSITY[:quiet]
           end
 
           commander.configure \
@@ -141,10 +143,21 @@ module Kamal::Cli
             subcommand: subcommand
           }.compact
 
-          say "Running the #{hook} hook...", :magenta
+          hooks_output = KAMAL.config.hooks_output_for(hook)
+
+          # CLI flags override config: -q hides all, -v shows all
+          # Config setting :verbose forces output, :quiet forces silence
+          hook_verbosity = if KAMAL.verbosity == :info && hooks_output
+            VERBOSITY.fetch(hooks_output)
+          else
+            KAMAL.verbosity
+          end
+
           with_env KAMAL.hook.env(**details, **extra_details) do
-            run_locally do
-              execute *KAMAL.hook.run(hook)
+            KAMAL.with_verbosity(hook_verbosity) do
+              run_locally do
+                execute *KAMAL.hook.run(hook)
+              end
             end
           rescue SSHKit::Command::Failed => e
             raise HookError.new("Hook `#{hook}` failed:\n#{e.message}")
@@ -160,7 +173,7 @@ module Kamal::Cli
 
       def pre_connect_if_required
         if !KAMAL.connected?
-          run_hook "pre-connect"
+          run_hook "pre-connect", secrets: true unless options[:skip_hooks]
           KAMAL.connected = true
         end
       end

data/lib/kamal/cli/build.rb

@@ -13,7 +13,7 @@ class Kamal::Cli::Build < Kamal::Cli::Base
   def push
     cli = self
 
-    # Ensure pre-connect hooks run before the build, they may needed for a remote builder
+    # Ensure pre-connect hooks run before the build, they may be needed for a remote builder
     # or the pre-build hooks.
     pre_connect_if_required
 

data/lib/kamal/cli/server.rb

@@ -35,6 +35,16 @@ class Kamal::Cli::Server < Kamal::Cli::Base
           if execute(*KAMAL.docker.superuser?, raise_on_non_zero_exit: false)
             info "Missing Docker on #{host}. Installing…"
             execute *KAMAL.docker.install
+
+            unless execute(*KAMAL.docker.root?, raise_on_non_zero_exit: false) ||
+                   execute(*KAMAL.docker.in_docker_group?, raise_on_non_zero_exit: false)
+              execute *KAMAL.docker.add_to_docker_group
+              begin
+                execute *KAMAL.docker.refresh_session
+              rescue IOError
+                info "Session refreshed due to group change."
+              end
+            end
           else
             missing << host
           end

data/lib/kamal/commander.rb

@@ -46,27 +46,19 @@ class Kamal::Commander
 
   def specific_roles=(role_names)
     @specifics = nil
-    if role_names.present?
-      @specific_roles = Kamal::Utils.filter_specific_items(role_names, config.roles)
-
-      if @specific_roles.empty?
-        raise ArgumentError, "No --roles match for #{role_names.join(',')}"
-      end
-
-      @specific_roles
+    @specific_roles = if role_names.present?
+      filtered = Kamal::Utils.filter_specific_items(role_names, config.roles)
+      raise ArgumentError, "No --roles match for #{role_names.join(',')}" if filtered.empty?
+      filtered
     end
   end
 
   def specific_hosts=(hosts)
     @specifics = nil
-    if hosts.present?
-      @specific_hosts = Kamal::Utils.filter_specific_items(hosts, config.all_hosts)
-
-      if @specific_hosts.empty?
-        raise ArgumentError, "No --hosts match for #{hosts.join(',')}"
-      end
-
-      @specific_hosts
+    @specific_hosts = if hosts.present?
+      filtered = Kamal::Utils.filter_specific_items(hosts, config.all_hosts)
+      raise ArgumentError, "No --hosts match for #{hosts.join(',')}" if filtered.empty?
+      filtered
     end
   end
 
@@ -129,6 +121,15 @@ class Kamal::Commander
     config.aliases[name]
   end
 
+  def resolve_alias(name)
+    if @config
+      @config.aliases[name]&.command
+    else
+      raw_config = Kamal::Configuration.load_raw_config(**@config_kwargs.to_h.slice(:config_file, :destination))
+      raw_config[:aliases]&.dig(name)
+    end
+  end
+
   def with_verbosity(level)
     old_level = self.verbosity
 

data/lib/kamal/commands/accessory.rb

@@ -68,6 +68,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
       *network_args,
       *env_args,
       *volume_args,
+      *option_args,
       image,
       *command
   end

data/lib/kamal/commands/base.rb

@@ -11,11 +11,11 @@ module Kamal::Commands
     end
 
     def run_over_ssh(*command, host:)
-      "ssh#{ssh_proxy_args}#{ssh_keys_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
+      "ssh#{ssh_config_args}#{ssh_proxy_args}#{ssh_keys_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
     end
 
     def container_id_for(container_name:, only_running: false)
-      docker :container, :ls, *("--all" unless only_running), "--filter", "name=^#{container_name}$", "--quiet"
+      docker :container, :ls, *("--all" unless only_running), "--filter", "'name=^#{container_name}$'", "--quiet"
     end
 
     def make_directory_for(remote_file)
@@ -100,6 +100,19 @@ module Kamal::Commands
         Kamal::Tags.from_config(config, **details)
       end
 
+      def ssh_config_args
+        case config.ssh.config
+        when Array
+          config.ssh.config.map { |file| " -F #{file}" }.join
+        when String
+          " -F #{config.ssh.config}"
+        when true
+          "" # Use default SSH config
+        when false
+          " -F /dev/null" # Ignore SSH config
+        end
+      end
+
       def ssh_proxy_args
         case config.ssh.proxy
         when Net::SSH::Proxy::Jump

data/lib/kamal/commands/docker.rb

@@ -16,7 +16,23 @@ class Kamal::Commands::Docker < Kamal::Commands::Base
 
   # Do we have superuser access to install Docker and start system services?
   def superuser?
-    [ '[ "${EUID:-$(id -u)}" -eq 0 ] || command -v sudo >/dev/null || command -v su >/dev/null' ]
+    [ '[ "${EUID:-$(id -u)}" -eq 0 ] || sudo -nl usermod >/dev/null' ]
+  end
+
+  def root?
+    [ '[ "${EUID:-$(id -u)}" -eq 0 ]' ]
+  end
+
+  def in_docker_group?
+    [ 'id -nG "${USER:-$(id -un)}" | grep -qw docker' ]
+  end
+
+  def add_to_docker_group
+    [ 'sudo -n usermod -aG docker "${USER:-$(id -un)}"' ]
+  end
+
+  def refresh_session
+    [ "kill -HUP $PPID" ]
   end
 
   def create_network

data/lib/kamal/commands/proxy.rb

@@ -37,7 +37,7 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
   end
 
   def info
-    docker :ps, "--filter", "name=^#{container_name}$"
+    docker :ps, "--filter", "'name=^#{container_name}$'"
   end
 
   def version

data/lib/kamal/configuration/docs/alias.yml

@@ -24,3 +24,6 @@ aliases:
 # Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores:
 aliases:
   uname: app exec -p -q -r web "uname -a"
+#
+# Aliases can include a destination with the `-d` flag:
+  staging_deploy: deploy -d staging

data/lib/kamal/configuration/docs/configuration.yml

@@ -85,6 +85,26 @@ asset_path: /path/to/assets
 # See https://kamal-deploy.org/docs/hooks for more information:
 hooks_path: /user_home/kamal/hooks
 
+# Hook output
+#
+# Hook output visibility. Can be set globally or per-hook.
+# CLI flags (`-v`, `-q`) override these settings.
+#
+# - `:quiet` - hook output is hidden
+# - `:verbose` - hook output is shown
+#
+# With no setting, hook output follows CLI verbosity flags.
+#
+# Note: Failed hooks always show output in the error message regardless of setting.
+#
+# Global setting for all hooks:
+hooks_output: :verbose
+
+# Or per-hook settings:
+hooks_output:
+  pre-deploy: :verbose
+  pre-build: :quiet
+
 # Secrets path
 #
 # Path to secrets, defaults to `.kamal/secrets`.

data/lib/kamal/configuration/proxy/run.rb

@@ -1,5 +1,5 @@
 class Kamal::Configuration::Proxy::Run
-  MINIMUM_VERSION = "v0.9.0"
+  MINIMUM_VERSION = "v0.9.2"
   DEFAULT_HTTP_PORT = 80
   DEFAULT_HTTPS_PORT = 443
   DEFAULT_LOG_MAX_SIZE = "10m"

data/lib/kamal/configuration/validator.rb

@@ -29,6 +29,8 @@ class Kamal::Configuration::Validator
               end
             elsif key.to_s == "ssl"
                 validate_type! value, TrueClass, FalseClass, Hash
+            elsif key.to_s == "hooks_output"
+                validate_hooks_output!(value)
             elsif key == "hosts"
               validate_servers! value
             elsif example_value.is_a?(Array)
@@ -161,6 +163,19 @@ class Kamal::Configuration::Validator
       end
     end
 
+    def validate_hooks_output!(value)
+      # hooks_output can be either a symbol/string (global) or a hash (per-hook)
+      if value.is_a?(Hash)
+        value.each do |hook, level|
+          with_context(hook) do
+            validate_type! level, String, Symbol
+          end
+        end
+      else
+        validate_type! value, String, Symbol
+      end
+    end
+
     def validate_type!(value, *types)
       type_error(*types) unless types.any? { |type| valid_type?(value, type) }
     end

data/lib/kamal/configuration.rb

@@ -6,6 +6,8 @@ require "erb"
 require "net/ssh/proxy/jump"
 
 class Kamal::Configuration
+  HOOKS_OUTPUT_LEVELS = [ :quiet, :verbose ].freeze
+
   delegate :service, :labels, :hooks_path, to: :raw_config, allow_nil: true
   delegate :argumentize, :optionize, to: Kamal::Utils
 
@@ -18,11 +20,15 @@ class Kamal::Configuration
     def create_from(config_file:, destination: nil, version: nil)
       ENV["KAMAL_DESTINATION"] = destination
 
-      raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
+      raw_config = load_raw_config(config_file: config_file, destination: destination)
 
       new raw_config, destination: destination, version: version
     end
 
+    def load_raw_config(config_file:, destination: nil)
+      load_config_files(config_file, *destination_config_file(config_file, destination))
+    end
+
     private
       def load_config_files(*files)
         files.inject({}) { |config, file| config.deep_merge! load_config_file(file) }
@@ -32,7 +38,9 @@ class Kamal::Configuration
         if file.exist?
           # Newer Psych doesn't load aliases by default
           load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
-          YAML.send(load_method, ERB.new(File.read(file)).result).symbolize_keys
+          template = File.read(file)
+          rendered = ERB.new(template, trim_mode: "-").result
+          YAML.send(load_method, rendered).symbolize_keys
         else
           raise "Configuration file not found in #{file}"
         end
@@ -78,6 +86,7 @@ class Kamal::Configuration
     ensure_unique_hosts_for_ssl_roles
     ensure_local_registry_remote_builder_has_ssh_url
     ensure_no_conflicting_proxy_runs
+    ensure_valid_hooks_output!
   end
 
   def version=(version)
@@ -279,6 +288,15 @@ class Kamal::Configuration
     env_tags.detect { |t| t.name == name.to_s }
   end
 
+  def hooks_output_for(hook)
+    case raw_config.hooks_output
+    when Symbol, String
+      raw_config.hooks_output.to_sym
+    when Hash
+      raw_config.hooks_output[hook]&.to_sym
+    end
+  end
+
   def to_h
     {
       roles: role_names,
@@ -409,6 +427,21 @@ class Kamal::Configuration
       raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
     end
 
+    def ensure_valid_hooks_output!
+      case raw_config.hooks_output
+      when Symbol, String
+        validate_hooks_output_level!(raw_config.hooks_output.to_sym)
+      when Hash
+        raw_config.hooks_output.each { |hook, level| validate_hooks_output_level!(level.to_sym, hook) }
+      end
+    end
+
+    def validate_hooks_output_level!(level, hook = nil)
+      return if HOOKS_OUTPUT_LEVELS.include?(level)
+      context = hook ? " for hook '#{hook}'" : ""
+      raise Kamal::ConfigurationError, "Invalid hooks_output '#{level}'#{context}, must be one of: #{HOOKS_OUTPUT_LEVELS.join(', ')}"
+    end
+
     def git_version
       @git_version ||=
         if Kamal::Git.used?

data/lib/kamal/version.rb

@@ -1,3 +1,3 @@
 module Kamal
-  VERSION = "2.10.1"
+  VERSION = "2.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -175,6 +175,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement