kamal 1.9.1 → 2.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d09c1f0d8df9701e126a4c0f806ca07077ce110198e0f2e1af29bd44777fccc
-  data.tar.gz: bfc5b1313e0da24ae3e5ab00bf46da27100c81d9476ae3130903d98870480778
+  metadata.gz: 4df682847a5becbc623450203537d42aa29fb4b001026a6b39ab266913660d4d
+  data.tar.gz: 97ceb4c375f99605f1d874637273168f7274e95c615611d1d324cb0d635523e3
 SHA512:
-  metadata.gz: bab2487f89e87f0ffd9da8f9e106db29ca6e373ca9bd45de4234f11864c04b9e7ce5c7cc68bacbdcc74e6a1f22e5c2542fee1647c4ab8102087366e83bd9d0e2
-  data.tar.gz: 50336374e58077f4d60ef074e8d247f2981d6aca032ab781e0116936e5a7353ad95b925b2ed9bac3d7111d9aecd6d4c2f79167ac920640cf88352accd467258d
+  metadata.gz: 619e959821a7bd1590f0dcf6d3d3956e02c0832a51528b8f15d655ddcfe636a29a6c82fd0080a2d7d3104437368c63f607fd2f61623f230e547693a4accf65ea
+  data.tar.gz: 1733b8db747dd71b1cb41ef7ca359856af278e5fb7ef29b0ed0cb677f67cdc82039246fb836bfd7c4260e992830f9a309315d5f98e83dcc3a2a7c5a2656e47a3

data/lib/kamal/cli/accessory.rb

@@ -222,25 +222,6 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
     end
   end
 
-  desc "downgrade", "Downgrade accessories from Kamal 2 to 1.9"
-  option :rolling, type: :boolean, default: false, desc: "Upgrade one host at a time"
-  option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
-  def downgrade(name)
-    confirming "This will restart all accessories" do
-      with_lock do
-        host_groups = options[:rolling] ? KAMAL.accessory_hosts : [ KAMAL.accessory_hosts ]
-        host_groups.each do |hosts|
-          host_list = Array(hosts).join(",")
-          KAMAL.with_specific_hosts(hosts) do
-            say "Downgrading #{name} accessories on #{host_list}...", :magenta
-            reboot name
-            say "Downgraded #{name} accessories on #{host_list}...", :magenta
-          end
-        end
-      end
-    end
-  end
-
   private
     def with_accessory(name)
       if KAMAL.config.accessory(name)

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

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

data/lib/kamal/cli/app.rb

@@ -71,11 +71,12 @@ class Kamal::Cli::App < Kamal::Cli::Base
     end
   end
 
-  desc "exec [CMD]", "Execute a custom command on servers within the app container (use --help to show options)"
+  desc "exec [CMD...]", "Execute a custom command on servers within the app container (use --help to show options)"
   option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
   option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
   option :env, aliases: "-e", type: :hash, desc: "Set environment variables for the command"
-  def exec(cmd)
+  def exec(*cmd)
+    cmd = Kamal::Utils.join_commands(cmd)
     env = options[:env]
     case
     when options[:interactive] && options[:reuse]

data/lib/kamal/cli/base.rb

@@ -6,7 +6,8 @@ module Kamal::Cli
   class Base < Thor
     include SSHKit::DSL
 
-    def self.exit_on_failure?() true end
+    def self.exit_on_failure?() false end
+    def self.dynamic_command_class() Kamal::Cli::Alias::Command end
 
     class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
     class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal logging"
@@ -22,8 +23,14 @@ module Kamal::Cli
 
     class_option :skip_hooks, aliases: "-H", type: :boolean, default: false, desc: "Don't run hooks"
 
-    def initialize(*)
-      super
+    def initialize(args = [], local_options = {}, config = {})
+      if config[:current_command].is_a?(Kamal::Cli::Alias::Command)
+        # When Thor generates a dynamic command, it doesn't attempt to parse the arguments.
+        # For our purposes, it means the arguments are passed in args rather than local_options.
+        super([], args, config)
+      else
+        super
+      end
       @original_env = ENV.to_h.dup
       load_env
       initialize_commander(options_with_subcommand_class_options)
@@ -206,10 +213,6 @@ module Kamal::Cli
         instance_variable_get("@_invocations").first
       end
 
-      def reset_invocation(cli_class)
-        instance_variable_get("@_invocations")[cli_class].pop
-      end
-
       def ensure_run_and_locks_directory
         on(KAMAL.hosts) do
           execute(*KAMAL.server.ensure_run_directory)

data/lib/kamal/cli/build.rb

@@ -30,18 +30,9 @@ class Kamal::Cli::Build < Kamal::Cli::Base
       say "Building with uncommitted changes:\n #{uncommitted_changes}", :yellow
     end
 
-    # Get the command here to ensure the Dir.chdir doesn't interfere with it
-    push = KAMAL.builder.push
-
     run_locally do
       begin
-        context_hosts = capture_with_info(*KAMAL.builder.context_hosts).split("\n")
-
-        if context_hosts != KAMAL.builder.config_context_hosts
-          warn "Context hosts have changed, so re-creating builder, was: #{context_hosts.join(", ")}], now: #{KAMAL.builder.config_context_hosts.join(", ")}"
-          cli.remove
-          cli.create
-        end
+        execute *KAMAL.builder.buildx_inspect
       rescue SSHKit::Command::Failed => e
         if e.message =~ /(context not found|no builder|does not exist)/
           warn "Missing compatible builder, so creating a new one first"
@@ -51,6 +42,9 @@ class Kamal::Cli::Build < Kamal::Cli::Base
         end
       end
 
+      # Get the command here to ensure the Dir.chdir doesn't interfere with it
+      push = KAMAL.builder.push
+
       KAMAL.with_verbosity(:debug) do
         Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
       end
@@ -72,7 +66,7 @@ class Kamal::Cli::Build < Kamal::Cli::Base
 
   desc "create", "Create a build setup"
   def create
-    if (remote_host = KAMAL.config.builder.remote_host)
+    if (remote_host = KAMAL.config.builder.remote)
       connect_to_remote_host(remote_host)
     end
 

data/lib/kamal/cli/main.rb

@@ -217,37 +217,6 @@ class Kamal::Cli::Main < Kamal::Cli::Base
     end
   end
 
-  desc "downgrade", "Downgrade from Kamal 2 to 1.9"
-  option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
-  option :rolling, type: :boolean, default: false, desc: "Downgrade one host at a time"
-  def downgrade
-    confirming "This will replace Traefik with kamal-proxy and restart all accessories" do
-      with_lock do
-        if options[:rolling]
-          (KAMAL.hosts | KAMAL.accessory_hosts).each do |host|
-            KAMAL.with_specific_hosts(host) do
-              say "Downgrading #{host}...", :magenta
-              if KAMAL.hosts.include?(host)
-                invoke "kamal:cli:traefik:downgrade", [], options.merge(confirmed: true, rolling: false)
-                reset_invocation(Kamal::Cli::Traefik)
-              end
-              if KAMAL.accessory_hosts.include?(host)
-                invoke "kamal:cli:accessory:downgrade", [ "all" ], options.merge(confirmed: true, rolling: false)
-                reset_invocation(Kamal::Cli::Accessory)
-              end
-              say "Downgraded #{host}", :magenta
-            end
-          end
-        else
-          say "Downgrading all hosts...", :magenta
-          invoke "kamal:cli:traefik:downgrade", [], options.merge(confirmed: true)
-          invoke "kamal:cli:accessory:downgrade", [ "all" ], options.merge(confirmed: true)
-          say "Downgraded all hosts", :magenta
-        end
-      end
-    end
-  end
-
   desc "version", "Show Kamal version"
   def version
     puts Kamal::VERSION

data/lib/kamal/cli/server.rb

@@ -1,7 +1,8 @@
 class Kamal::Cli::Server < Kamal::Cli::Base
   desc "exec", "Run a custom command on the server (use --help to show options)"
   option :interactive, type: :boolean, aliases: "-i", default: false, desc: "Run the command interactively (use for console/bash)"
-  def exec(cmd)
+  def exec(*cmd)
+    cmd = Kamal::Utils.join_commands(cmd)
     hosts = KAMAL.hosts | KAMAL.accessory_hosts
 
     case

data/lib/kamal/cli/templates/deploy.yml

@@ -18,6 +18,10 @@ registry:
   password:
     - KAMAL_REGISTRY_PASSWORD
 
+# Configure builder setup.
+builder:
+  arch: amd64
+
 # Inject ENV variables into containers (secrets come from .env).
 # Remember to run `kamal env push` after making changes!
 # env:
@@ -30,16 +34,6 @@ registry:
 # ssh:
 #   user: app
 
-# Configure builder setup.
-# builder:
-#   args:
-#     RUBY_VERSION: 3.2.0
-#   secrets:
-#     - GITHUB_TOKEN
-#   remote:
-#     arch: amd64
-#     host: ssh://app@192.168.0.1
-
 # Use accessory services (secrets come from .env).
 # accessories:
 #   db:

data/lib/kamal/cli/traefik.rb

@@ -119,44 +119,4 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
       end
     end
   end
-
-  desc "downgrade", "Downgrade to Traefik on servers (stop container, remove container, start new container, reboot app)"
-  option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel"
-  option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
-  def downgrade
-    invoke_options = { "version" => KAMAL.config.latest_tag }.merge(options)
-
-    confirming "This will cause a brief outage on each host. Are you sure?" do
-      host_groups = options[:rolling] ? KAMAL.hosts : [ KAMAL.hosts ]
-      host_groups.each do |hosts|
-        host_list = Array(hosts).join(",")
-        say "Downgrading to Traefik on #{host_list}...", :magenta
-        run_hook "pre-traefik-reboot", hosts: host_list
-        on(hosts) do |host|
-          execute *KAMAL.auditor.record("Rebooted Traefik"), verbosity: :debug
-          execute *KAMAL.registry.login
-
-          "Stopping and removing kamal-proxy on #{host}, if running..."
-          execute *KAMAL.traefik.cleanup_kamal_proxy
-
-          "Stopping and removing Traefik on #{host}, if running..."
-          execute *KAMAL.traefik.stop, raise_on_non_zero_exit: false
-          execute *KAMAL.traefik.remove_container
-          execute *KAMAL.traefik.remove_image
-        end
-
-        KAMAL.with_specific_hosts(hosts) do
-          invoke "kamal:cli:traefik:boot", [], invoke_options
-          reset_invocation(Kamal::Cli::Traefik)
-          invoke "kamal:cli:app:boot", [], invoke_options
-          reset_invocation(Kamal::Cli::App)
-          invoke "kamal:cli:prune:all", [], invoke_options
-          reset_invocation(Kamal::Cli::Prune)
-        end
-
-        run_hook "post-traefik-reboot", hosts: host_list
-        say "Downgraded to Traefik on #{host_list}", :magenta
-      end
-    end
-  end
 end

data/lib/kamal/commander/specifics.rb

@@ -23,7 +23,7 @@ class Kamal::Commander::Specifics
   end
 
   def accessory_hosts
-    config.accessories.flat_map(&:hosts) & specified_hosts
+    specific_hosts || config.accessories.flat_map(&:hosts)
   end
 
   private

data/lib/kamal/commander.rb

@@ -27,7 +27,11 @@ class Kamal::Commander
 
   def specific_primary!
     @specifics = nil
-    self.specific_hosts = [ config.primary_host ]
+    if specific_roles.present?
+      self.specific_hosts = [ specific_roles.first.primary_host ]
+    else
+      self.specific_hosts = [ config.primary_host ]
+    end
   end
 
   def specific_roles=(role_names)
@@ -56,13 +60,6 @@ class Kamal::Commander
     end
   end
 
-  def with_specific_hosts(hosts)
-    original_hosts, self.specific_hosts = specific_hosts, hosts
-    yield
-  ensure
-    self.specific_hosts = original_hosts
-  end
-
   def accessory_names
     config.accessories&.collect(&:name) || []
   end
@@ -120,6 +117,10 @@ class Kamal::Commander
     @traefik ||= Kamal::Commands::Traefik.new(config)
   end
 
+  def alias(name)
+    config.aliases[name]
+  end
+
 
   def with_verbosity(level)
     old_level = self.verbosity

data/lib/kamal/commands/builder/base.rb

@@ -1,20 +1,41 @@
-
 class Kamal::Commands::Builder::Base < Kamal::Commands::Base
   class BuilderError < StandardError; end
 
   ENDPOINT_DOCKER_HOST_INSPECT = "'{{.Endpoints.docker.Host}}'"
 
   delegate :argumentize, to: Kamal::Utils
-  delegate :args, :secrets, :dockerfile, :target, :local_arch, :local_host, :remote_arch, :remote_host, :cache_from, :cache_to, :ssh, to: :builder_config
+  delegate \
+    :args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
+    :cache_from, :cache_to, :ssh, :driver, :docker_driver?,
+    to: :builder_config
 
   def clean
     docker :image, :rm, "--force", config.absolute_image
   end
 
+  def push
+    docker :buildx, :build,
+      "--push",
+      *platform_options(arches),
+      *([ "--builder", builder_name ] unless docker_driver?),
+      *build_options,
+      build_context
+  end
+
   def pull
     docker :pull, config.absolute_image
   end
 
+  def info
+    combine \
+      docker(:context, :ls),
+      docker(:buildx, :ls)
+  end
+
+  def buildx_inspect
+    docker :buildx, :inspect, builder_name unless docker_driver?
+  end
+
   def build_options
     [ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
   end
@@ -32,14 +53,6 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
       )
   end
 
-  def context_hosts
-    :true
-  end
-
-  def config_context_hosts
-    []
-  end
-
   def first_mirror
     docker(:info, "--format '{{index .RegistryConfig.Mirrors 0}}'")
   end
@@ -91,4 +104,8 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
     def context_host(builder_name)
       docker :context, :inspect, builder_name, "--format", ENDPOINT_DOCKER_HOST_INSPECT
     end
+
+    def platform_options(arches)
+      argumentize "--platform", arches.map { |arch| "linux/#{arch}" }.join(",") if arches.any?
+    end
 end

data/lib/kamal/commands/builder/hybrid.rb

@@ -0,0 +1,21 @@
+class Kamal::Commands::Builder::Hybrid < Kamal::Commands::Builder::Remote
+  def create
+    combine \
+      create_local_buildx,
+      create_remote_context,
+      append_remote_buildx
+  end
+
+  private
+    def builder_name
+      "kamal-hybrid-#{driver}-#{remote.gsub(/[^a-z0-9_-]/, "-")}"
+    end
+
+    def create_local_buildx
+      docker :buildx, :create, *platform_options(local_arches), "--name", builder_name, "--driver=#{driver}"
+    end
+
+    def append_remote_buildx
+      docker :buildx, :create, *platform_options(remote_arches), "--append", "--name", builder_name, builder_name
+    end
+end

data/lib/kamal/commands/builder/local.rb

@@ -0,0 +1,14 @@
+class Kamal::Commands::Builder::Local < Kamal::Commands::Builder::Base
+  def create
+    docker :buildx, :create, "--name", builder_name, "--driver=#{driver}" unless docker_driver?
+  end
+
+  def remove
+    docker :buildx, :rm, builder_name unless docker_driver?
+  end
+
+  private
+    def builder_name
+      "kamal-local-#{driver}"
+    end
+end

data/lib/kamal/commands/builder/remote.rb

@@ -0,0 +1,40 @@
+class Kamal::Commands::Builder::Remote < Kamal::Commands::Builder::Base
+  def create
+    chain \
+      create_remote_context,
+      create_buildx
+  end
+
+  def remove
+    chain \
+      remove_remote_context,
+      remove_buildx
+  end
+
+  def info
+    chain \
+      docker(:context, :ls),
+      docker(:buildx, :ls)
+  end
+
+  private
+    def builder_name
+      "kamal-remote-#{driver}-#{remote.gsub(/[^a-z0-9_-]/, "-")}"
+    end
+
+    def create_remote_context
+      docker :context, :create, builder_name, "--description", "'#{builder_name} host'", "--docker", "'host=#{remote}'"
+    end
+
+    def remove_remote_context
+      docker :context, :rm, builder_name
+    end
+
+    def create_buildx
+      docker :buildx, :create, "--name", builder_name, builder_name
+    end
+
+    def remove_buildx
+      docker :buildx, :rm, builder_name
+    end
+end

data/lib/kamal/commands/builder.rb

@@ -1,8 +1,8 @@
 require "active_support/core_ext/string/filters"
 
 class Kamal::Commands::Builder < Kamal::Commands::Base
-  delegate :create, :remove, :push, :clean, :pull, :info, :context_hosts, :config_context_hosts, :validate_image,
-           :first_mirror, to: :target
+  delegate :create, :remove, :push, :clean, :pull, :info, :buildx_inspect, :validate_image, :first_mirror, to: :target
+  delegate :local?, :remote?, to: "config.builder"
 
   include Clone
 
@@ -11,43 +11,27 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
   end
 
   def target
-    if config.builder.multiarch?
-      if config.builder.remote?
-        if config.builder.local?
-          multiarch_remote
-        else
-          native_remote
-        end
+    if remote?
+      if local?
+        hybrid
       else
-        multiarch
+        remote
       end
     else
-      if config.builder.cached?
-        native_cached
-      else
-        native
-      end
+      local
     end
   end
 
-  def native
-    @native ||= Kamal::Commands::Builder::Native.new(config)
-  end
-
-  def native_cached
-    @native ||= Kamal::Commands::Builder::Native::Cached.new(config)
-  end
-
-  def native_remote
-    @native ||= Kamal::Commands::Builder::Native::Remote.new(config)
+  def remote
+    @remote ||= Kamal::Commands::Builder::Remote.new(config)
   end
 
-  def multiarch
-    @multiarch ||= Kamal::Commands::Builder::Multiarch.new(config)
+  def local
+    @local ||= Kamal::Commands::Builder::Local.new(config)
   end
 
-  def multiarch_remote
-    @multiarch_remote ||= Kamal::Commands::Builder::Multiarch::Remote.new(config)
+  def hybrid
+    @hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
   end
 
 

data/lib/kamal/commands/traefik.rb

@@ -62,15 +62,6 @@ class Kamal::Commands::Traefik < Kamal::Commands::Base
     [ :rm, "-f", env.secrets_file ]
   end
 
-  def cleanup_kamal_proxy
-    chain \
-      docker(:container, :stop, "kamal-proxy"),
-      combine(
-        docker(:container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy"),
-        docker(:image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy")
-      )
-  end
-
   private
     def publish_args
       argumentize "--publish", port if publish?

data/lib/kamal/configuration/alias.rb

@@ -0,0 +1,15 @@
+class Kamal::Configuration::Alias
+  include Kamal::Configuration::Validation
+
+  attr_reader :name, :command
+
+  def initialize(name, config:)
+    @name, @command = name.inquiry, config.raw_config["aliases"][name]
+
+    validate! \
+      command,
+      example: validation_yml["aliases"]["uname"],
+      context: "aliases/#{name}",
+      with: Kamal::Configuration::Validator::Alias
+  end
+end

data/lib/kamal/configuration/builder.rb

@@ -19,16 +19,36 @@ class Kamal::Configuration::Builder
     builder_config
   end
 
-  def multiarch?
-    builder_config["multiarch"] != false
+  def remote
+    builder_config["remote"]
   end
 
-  def local?
-    !!builder_config["local"]
+  def arches
+    Array(builder_config.fetch("arch", default_arch))
+  end
+
+  def local_arches
+    @local_arches ||= if remote
+      arches & [ Kamal::Utils.docker_arch ]
+    else
+      arches
+    end
+  end
+
+  def remote_arches
+    @remote_arches ||= if remote
+      arches - local_arches
+    else
+      []
+    end
   end
 
   def remote?
-    !!builder_config["remote"]
+    remote_arches.any?
+  end
+
+  def local?
+    arches.empty? || local_arches.any?
   end
 
   def cached?
@@ -55,20 +75,8 @@ class Kamal::Configuration::Builder
     builder_config["context"] || "."
   end
 
-  def local_arch
-    builder_config["local"]["arch"] if local?
-  end
-
-  def local_host
-    builder_config["local"]["host"] if local?
-  end
-
-  def remote_arch
-    builder_config["remote"]["arch"] if remote?
-  end
-
-  def remote_host
-    builder_config["remote"]["host"] if remote?
+  def driver
+    builder_config.fetch("driver", "docker-container")
   end
 
   def cache_from
@@ -114,7 +122,23 @@ class Kamal::Configuration::Builder
       end
   end
 
+  def docker_driver?
+    driver == "docker"
+  end
+
   private
+    def valid?
+      if docker_driver?
+        raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support remote builders" if remote
+        raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support caching" if cached?
+        raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support multiple arches" if arches.many?
+      end
+
+      if @options["cache"] && @options["cache"]["type"]
+        raise ArgumentError, "Invalid cache type: #{@options["cache"]["type"]}" unless [ "gha", "registry" ].include?(@options["cache"]["type"])
+      end
+    end
+
     def cache_image
       builder_config["cache"]&.fetch("image", nil) || "#{image}-build-cache"
     end
@@ -150,4 +174,8 @@ class Kamal::Configuration::Builder
     def pwd_sha
       Digest::SHA256.hexdigest(Dir.pwd)[0..12]
     end
+
+    def default_arch
+      docker_driver? ? [] : [ "amd64", "arm64" ]
+    end
 end

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

@@ -0,0 +1,26 @@
+# Aliases
+#
+# Aliases are shortcuts for Kamal commands.
+#
+# For example, for a Rails app, you might open a console with:
+#
+# ```shell
+# kamal app exec -i -r console "rails console"
+# ```
+#
+# By defining an alias, like this:
+aliases:
+  console: app exec -r console -i "rails console"
+# You can now open the console with:
+# ```shell
+# kamal console
+# ```
+
+# Configuring aliases
+#
+# Aliases are defined in the root config under the alias key
+#
+# Each alias is named and can only contain lowercase letters, numbers, dashes and underscores.
+
+aliases:
+  uname: app exec -p -q -r web "uname -a"

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

@@ -1,10 +1,10 @@
 # Builder
 #
-# The builder configuration controls how the application is built with `docker build` or `docker buildx build`
+# The builder configuration controls how the application is built with `docker build`
 #
 # If no configuration is specified, Kamal will:
-# 1. Create a buildx context called `kamal-<service>-multiarch`
-# 2. Use `docker buildx build` to build a multiarch image for linux/amd64,linux/arm64 with that context
+# 1. Create a buildx context called `kamal-local-docker-container`, using the docker-container driver
+# 2. Use `docker build` to build a multiarch image for linux/amd64,linux/arm64 with that context
 #
 # See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information
 
@@ -12,36 +12,29 @@
 #
 # Options go under the builder key in the root configuration.
 builder:
-
-  # Multiarch
+  # Driver
   #
-  # Enables multiarch builds, defaults to `true`
-  multiarch: false
+  # The build driver to use, defaults to `docker-container`
+  driver: docker
 
-  # Local configuration
-  #
-  # The build configuration for local builds, only used if multiarch is enabled (the default)
+  # Arch
   #
-  # If there is no remote configuration, by default we build for amd64 and arm64.
-  # If you only want to build for one architecture, you can specify it here.
-  # The docker socket is optional and uses the default docker host socket when not specified
-  local:
-    arch: amd64
-    host: /var/run/docker.sock
+  # The architectures to build for, defaults to `[ amd64, arm64 ]`
+  # Unless you are using the docker driver, when it defaults to the local architecture
+  # You can set an array or just a single value
+  arch:
+    - amd64
 
   # Remote configuration
   #
-  # The build configuration for remote builds, also only used if multiarch is enabled.
-  # The arch is required and can be either amd64 or arm64.
-  remote:
-    arch: arm64
-    host: ssh://docker@docker-builder
+  # If you have a remote builder, you can configure it here
+  remote: ssh://docker@docker-builder
 
   # Builder cache
   #
   # The type must be either 'gha' or 'registry'
   #
-  # The image is only used for registry cache
+  # The image is only used for registry cache. Not compatible with the docker driver
   cache:
     type: registry
     options: mode=max

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

@@ -166,3 +166,9 @@ healthcheck:
 # Docker logging configuration, see kamal docs logging
 logging:
   ...
+
+# Aliases
+#
+# Alias configuration, see kamal docs alias
+aliases:
+  ...

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

@@ -17,8 +17,8 @@ traefik:
 
   # Image
   #
-  # The Traefik image to use, defaults to `traefik:v2.11`
-  image: traefik:v2.11
+  # The Traefik image to use, defaults to `traefik:v2.10`
+  image: traefik:v2.9
 
   # Host port
   #

data/lib/kamal/configuration/traefik.rb

@@ -1,5 +1,5 @@
 class Kamal::Configuration::Traefik
-  DEFAULT_IMAGE = "traefik:v2.11"
+  DEFAULT_IMAGE = "traefik:v2.10"
   CONTAINER_PORT = 80
   DEFAULT_ARGS = {
     "log.level" => "DEBUG"

data/lib/kamal/configuration/validator/alias.rb

@@ -0,0 +1,15 @@
+class Kamal::Configuration::Validator::Alias < Kamal::Configuration::Validator
+  def validate!
+    super
+
+    name = context.delete_prefix("aliases/")
+
+    if name !~ /\A[a-z0-9_-]+\z/
+      error "Invalid alias name: '#{name}'. Must only contain lowercase letters, alphanumeric, hyphens and underscores."
+    end
+
+    if Kamal::Cli::Main.commands.include?(name)
+      error "Alias '#{name}' conflicts with a built-in command."
+    end
+  end
+end

data/lib/kamal/configuration/validator/builder.rb

@@ -5,5 +5,7 @@ class Kamal::Configuration::Validator::Builder < Kamal::Configuration::Validator
     if config["cache"] && config["cache"]["type"]
       error "Invalid cache type: #{config["cache"]["type"]}" unless [ "gha", "registry" ].include?(config["cache"]["type"])
     end
+
+    error "Builder arch not set" unless config["arch"].present?
   end
 end

data/lib/kamal/configuration/validator.rb

@@ -13,32 +13,38 @@ class Kamal::Configuration::Validator
 
   private
     def validate_against_example!(validation_config, example)
-      validate_type! validation_config, Hash
-
-      check_unknown_keys! validation_config, example
-
-      validation_config.each do |key, value|
-        next if extension?(key)
-        with_context(key) do
-          example_value = example[key]
-
-          if example_value == "..."
-            validate_type! value, *(Array if key == :servers), Hash
-          elsif key == "hosts"
-            validate_servers! value
-          elsif example_value.is_a?(Array)
-            validate_array_of! value, example_value.first.class
-          elsif example_value.is_a?(Hash)
-            case key.to_s
-            when "options", "args"
-              validate_type! value, Hash
-            when "labels"
-              validate_hash_of! value, example_value.first[1].class
+      validate_type! validation_config, example.class
+
+      if example.class == Hash
+        check_unknown_keys! validation_config, example
+
+        validation_config.each do |key, value|
+          next if extension?(key)
+          with_context(key) do
+            example_value = example[key]
+
+            if example_value == "..."
+              validate_type! value, *(Array if key == :servers), Hash
+            elsif key == "hosts"
+              validate_servers! value
+            elsif example_value.is_a?(Array)
+              if key == "arch"
+                validate_array_of_or_type! value, example_value.first.class
+              else
+                validate_array_of! value, example_value.first.class
+              end
+            elsif example_value.is_a?(Hash)
+              case key.to_s
+              when "options", "args"
+                validate_type! value, Hash
+              when "labels"
+                validate_hash_of! value, example_value.first[1].class
+              else
+                validate_against_example! value, example_value
+              end
             else
-              validate_against_example! value, example_value
+              validate_type! value, example_value.class
             end
-          else
-            validate_type! value, example_value.class
           end
         end
       end
@@ -69,6 +75,16 @@ class Kamal::Configuration::Validator
       value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
     end
 
+    def validate_array_of_or_type!(value, type)
+      if value.is_a?(Array)
+        validate_array_of! value, type
+      else
+        validate_type! value, type
+      end
+    rescue Kamal::ConfigurationError
+      type_error(Array, type)
+    end
+
     def validate_array_of!(array, type)
       validate_type! array, Array
 

data/lib/kamal/configuration.rb

@@ -11,7 +11,7 @@ class Kamal::Configuration
   delegate :argumentize, :optionize, to: Kamal::Utils
 
   attr_reader :destination, :raw_config
-  attr_reader :accessories, :boot, :builder, :env, :healthcheck, :logging, :traefik, :servers, :ssh, :sshkit, :registry
+  attr_reader :accessories, :aliases, :boot, :builder, :env, :healthcheck, :logging, :traefik, :servers, :ssh, :sshkit, :registry
 
   include Validation
 
@@ -54,6 +54,7 @@ class Kamal::Configuration
     @registry = Registry.new(config: self)
 
     @accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
+    @aliases = @raw_config.aliases&.keys&.to_h { |name| [ name, Alias.new(name, config: self) ] } || {}
     @boot = Boot.new(config: self)
     @builder = Builder.new(config: self)
     @env = Env.new(config: @raw_config.env || {})

data/lib/kamal/utils.rb

@@ -77,4 +77,20 @@ module Kamal::Utils
   def stable_sort!(elements, &block)
     elements.sort_by!.with_index { |element, index| [ block.call(element), index ] }
   end
+
+  def join_commands(commands)
+    commands.map(&:strip).join(" ")
+  end
+
+  def docker_arch
+    arch = `docker info --format '{{.Architecture}}'`.strip
+    case arch
+    when /aarch64/
+      "arm64"
+    when /x86_64/
+      "amd64"
+    else
+      arch
+    end
+  end
 end

data/lib/kamal/version.rb

@@ -1,3 +1,3 @@
 module Kamal
-  VERSION = "1.9.1"
+  VERSION = "2.0.0.alpha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamal
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 2.0.0.alpha
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +211,7 @@ files:
 - lib/kamal.rb
 - lib/kamal/cli.rb
 - lib/kamal/cli/accessory.rb
+- lib/kamal/cli/alias/command.rb
 - lib/kamal/cli/app.rb
 - lib/kamal/cli/app/boot.rb
 - lib/kamal/cli/app/prepare_assets.rb
@@ -252,11 +253,9 @@ files:
 - lib/kamal/commands/builder.rb
 - lib/kamal/commands/builder/base.rb
 - lib/kamal/commands/builder/clone.rb
-- lib/kamal/commands/builder/multiarch.rb
-- lib/kamal/commands/builder/multiarch/remote.rb
-- lib/kamal/commands/builder/native.rb
-- lib/kamal/commands/builder/native/cached.rb
-- lib/kamal/commands/builder/native/remote.rb
+- lib/kamal/commands/builder/hybrid.rb
+- lib/kamal/commands/builder/local.rb
+- lib/kamal/commands/builder/remote.rb
 - lib/kamal/commands/docker.rb
 - lib/kamal/commands/hook.rb
 - lib/kamal/commands/lock.rb
@@ -266,9 +265,11 @@ files:
 - lib/kamal/commands/traefik.rb
 - lib/kamal/configuration.rb
 - lib/kamal/configuration/accessory.rb
+- lib/kamal/configuration/alias.rb
 - lib/kamal/configuration/boot.rb
 - lib/kamal/configuration/builder.rb
 - lib/kamal/configuration/docs/accessory.yml
+- lib/kamal/configuration/docs/alias.yml
 - lib/kamal/configuration/docs/boot.yml
 - lib/kamal/configuration/docs/builder.yml
 - lib/kamal/configuration/docs/configuration.yml
@@ -294,6 +295,7 @@ files:
 - lib/kamal/configuration/validation.rb
 - lib/kamal/configuration/validator.rb
 - lib/kamal/configuration/validator/accessory.rb
+- lib/kamal/configuration/validator/alias.rb
 - lib/kamal/configuration/validator/builder.rb
 - lib/kamal/configuration/validator/configuration.rb
 - lib/kamal/configuration/validator/env.rb
@@ -327,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Deploy web apps in containers to servers running Docker with zero downtime.

data/lib/kamal/commands/builder/multiarch/remote.rb

@@ -1,65 +0,0 @@
-class Kamal::Commands::Builder::Multiarch::Remote < Kamal::Commands::Builder::Multiarch
-  def create
-    combine \
-      create_contexts,
-      create_local_buildx,
-      append_remote_buildx
-  end
-
-  def remove
-    combine \
-      remove_contexts,
-      super
-  end
-
-  def context_hosts
-    chain \
-      context_host(builder_name_with_arch(local_arch)),
-      context_host(builder_name_with_arch(remote_arch))
-  end
-
-  def config_context_hosts
-    [ local_host, remote_host ].compact
-  end
-
-  private
-    def builder_name
-      super + "-remote"
-    end
-
-    def builder_name_with_arch(arch)
-      "#{builder_name}-#{arch}"
-    end
-
-    def create_local_buildx
-      docker :buildx, :create, "--name", builder_name, builder_name_with_arch(local_arch), "--platform", "linux/#{local_arch}"
-    end
-
-    def append_remote_buildx
-      docker :buildx, :create, "--append", "--name", builder_name, builder_name_with_arch(remote_arch), "--platform", "linux/#{remote_arch}"
-    end
-
-    def create_contexts
-      combine \
-        create_context(local_arch, local_host),
-        create_context(remote_arch, remote_host)
-    end
-
-    def create_context(arch, host)
-      docker :context, :create, builder_name_with_arch(arch), "--description", "'#{builder_name} #{arch} native host'", "--docker", "'host=#{host}'"
-    end
-
-    def remove_contexts
-      combine \
-        remove_context(local_arch),
-        remove_context(remote_arch)
-    end
-
-    def remove_context(arch)
-      docker :context, :rm, builder_name_with_arch(arch)
-    end
-
-    def platform_names
-      "linux/#{local_arch},linux/#{remote_arch}"
-    end
-end

data/lib/kamal/commands/builder/multiarch.rb

@@ -1,41 +0,0 @@
-class Kamal::Commands::Builder::Multiarch < Kamal::Commands::Builder::Base
-  def create
-    docker :buildx, :create, "--use", "--name", builder_name
-  end
-
-  def remove
-    docker :buildx, :rm, builder_name
-  end
-
-  def info
-    combine \
-      docker(:context, :ls),
-      docker(:buildx, :ls)
-  end
-
-  def push
-    docker :buildx, :build,
-      "--push",
-      "--platform", platform_names,
-      "--builder", builder_name,
-      *build_options,
-      build_context
-  end
-
-  def context_hosts
-    docker :buildx, :inspect, builder_name, "> /dev/null"
-  end
-
-  private
-    def builder_name
-      "kamal-#{config.service}-multiarch"
-    end
-
-    def platform_names
-      if local_arch
-        "linux/#{local_arch}"
-      else
-        "linux/amd64,linux/arm64"
-      end
-    end
-end

data/lib/kamal/commands/builder/native/cached.rb

@@ -1,25 +0,0 @@
-class Kamal::Commands::Builder::Native::Cached < Kamal::Commands::Builder::Native
-  def create
-    docker :buildx, :create, "--name", builder_name, "--use", "--driver=docker-container"
-  end
-
-  def remove
-    docker :buildx, :rm, builder_name
-  end
-
-  def push
-    docker :buildx, :build,
-      "--push",
-      *build_options,
-      build_context
-  end
-
-  def context_hosts
-    docker :buildx, :inspect, builder_name, "> /dev/null"
-  end
-
-  private
-    def builder_name
-      "kamal-#{config.service}-native-cached"
-    end
-end

data/lib/kamal/commands/builder/native/remote.rb

@@ -1,67 +0,0 @@
-class Kamal::Commands::Builder::Native::Remote < Kamal::Commands::Builder::Native
-  def create
-    chain \
-      create_context,
-      create_buildx
-  end
-
-  def remove
-    chain \
-      remove_context,
-      remove_buildx
-  end
-
-  def info
-    chain \
-      docker(:context, :ls),
-      docker(:buildx, :ls)
-  end
-
-  def push
-    docker :buildx, :build,
-    "--push",
-    "--platform", platform,
-    "--builder", builder_name,
-    *build_options,
-    build_context
-  end
-
-  def context_hosts
-    context_host(builder_name_with_arch)
-  end
-
-  def config_context_hosts
-    [ remote_host ]
-  end
-
-
-  private
-    def builder_name
-      "kamal-#{config.service}-native-remote"
-    end
-
-    def builder_name_with_arch
-      "#{builder_name}-#{remote_arch}"
-    end
-
-    def platform
-      "linux/#{remote_arch}"
-    end
-
-    def create_context
-      docker :context, :create,
-        builder_name_with_arch, "--description", "'#{builder_name} #{remote_arch} native host'", "--docker", "'host=#{remote_host}'"
-    end
-
-    def remove_context
-      docker :context, :rm, builder_name_with_arch
-    end
-
-    def create_buildx
-      docker :buildx, :create, "--name", builder_name, builder_name_with_arch, "--platform", platform
-    end
-
-    def remove_buildx
-      docker :buildx, :rm, builder_name
-    end
-end

data/lib/kamal/commands/builder/native.rb

@@ -1,20 +0,0 @@
-class Kamal::Commands::Builder::Native < Kamal::Commands::Builder::Base
-  def create
-    # No-op on native without cache
-  end
-
-  def remove
-    # No-op on native without cache
-  end
-
-  def info
-    # No-op on native
-  end
-
-  def push
-    combine \
-      docker(:build, *build_options, build_context),
-      docker(:push, config.absolute_image),
-      docker(:push, config.latest_image)
-  end
-end