dash 2.12.0

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

@@ -0,0 +1,143 @@
+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, :arches, :local_arches, :remote_arches, :remote,
+    :pack?, :pack_builder, :pack_buildpacks,
+    :cache_from, :cache_to, :ssh, :provenance, :sbom, :driver, :docker_driver?,
+    to: :builder_config
+
+  def clean
+    docker :image, :rm, "--force", config.absolute_image
+  end
+
+  def push(export_action = "registry", tag_as_dirty: false, no_cache: false)
+    docker :buildx, :build,
+      "--output=type=#{export_action}",
+      *platform_options(arches),
+      *([ "--builder", builder_name ] unless docker_driver?),
+      *build_tag_options(tag_as_dirty: tag_as_dirty),
+      *build_options,
+      *([ "--no-cache" ] if no_cache),
+      build_context,
+      "2>&1"
+  end
+
+  def pull
+    docker :pull, config.absolute_image
+  end
+
+  def info
+    combine \
+      docker(:context, :ls),
+      docker(:buildx, :ls)
+  end
+
+  def inspect_builder
+    docker :buildx, :inspect, builder_name unless docker_driver?
+  end
+
+  def build_options
+    [ *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
+  end
+
+  def build_context
+    config.builder.context
+  end
+
+  def validate_image
+    pipe \
+      docker(:inspect, "-f", "'{{ .Config.Labels.service }}'", config.absolute_image),
+      any(
+        [ :grep, "-x", config.service ],
+        "(echo \"Image #{config.absolute_image} is missing the 'service' label\" && exit 1)"
+      )
+  end
+
+  def first_mirror
+    docker(:info, "--format '{{index .RegistryConfig.Mirrors 0}}'")
+  end
+
+  def login_to_registry_locally?
+    true
+  end
+
+  def push_env
+    {}
+  end
+
+  private
+    def build_tag_names(tag_as_dirty: false)
+      tag_names = [ config.absolute_image, config.latest_image ]
+      tag_names.map! { |t| "#{t}-dirty" } if tag_as_dirty
+      tag_names
+    end
+
+    def build_tag_options(tag_as_dirty: false)
+      build_tag_names(tag_as_dirty: tag_as_dirty).flat_map { |name| [ "-t", name ] }
+    end
+
+    def build_cache
+      if cache_to && cache_from
+        [ "--cache-to", cache_to,
+          "--cache-from", cache_from ]
+      end
+    end
+
+    def build_labels
+      argumentize "--label", { service: config.service }
+    end
+
+    def build_args
+      argumentize "--build-arg", args, sensitive: true
+    end
+
+    def build_secrets
+      argumentize "--secret", secrets.keys.collect { |secret| [ "id", secret ] }
+    end
+
+    def build_dockerfile
+      if Pathname.new(File.expand_path(dockerfile)).exist?
+        argumentize "--file", dockerfile
+      else
+        raise BuilderError, "Missing #{dockerfile}"
+      end
+    end
+
+    def build_target
+      argumentize "--target", target if target.present?
+    end
+
+    def build_ssh
+      argumentize "--ssh", ssh if ssh.present?
+    end
+
+    def builder_provenance
+      argumentize "--provenance", provenance unless provenance.nil?
+    end
+
+    def builder_sbom
+      argumentize "--sbom", sbom unless sbom.nil?
+    end
+
+    def builder_config
+      config.builder
+    end
+
+    def registry_config
+      config.registry
+    end
+
+    def driver_options
+      if registry_config.local?
+        [ "--driver-opt", "network=host" ]
+      end
+    end
+
+    def platform_options(arches)
+      argumentize "--platform", arches.map { |arch| "linux/#{arch}" }.join(",") if arches.any?
+    end
+end

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

@@ -0,0 +1,32 @@
+module Kamal::Commands::Builder::Clone
+  def clone
+    git :clone, escaped_root, "--recurse-submodules", path: config.builder.clone_directory.shellescape
+  end
+
+  def clone_reset_steps
+    [
+      git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory),
+      git(:fetch, :origin, path: escaped_build_directory),
+      git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory),
+      git(:clean, "-fdx", path: escaped_build_directory),
+      git(:submodule, :update, "--init", path: escaped_build_directory),
+      git(:gc, "--auto", "--quiet", path: escaped_build_directory)
+    ]
+  end
+
+  def clone_status
+    git :status, "--porcelain", path: escaped_build_directory
+  end
+
+  def clone_revision
+    git :"rev-parse", :HEAD, path: escaped_build_directory
+  end
+
+  def escaped_root
+    Kamal::Git.root.shellescape
+  end
+
+  def escaped_build_directory
+    config.builder.build_directory.shellescape
+  end
+end

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

@@ -0,0 +1,22 @@
+class Kamal::Commands::Builder::Cloud < Kamal::Commands::Builder::Base
+  # Expects `driver` to be of format "cloud docker-org-name/builder-name"
+
+  def create
+    docker :buildx, :create, "--driver", driver
+  end
+
+  def remove
+    docker :buildx, :rm, builder_name
+  end
+
+  private
+    def builder_name
+      driver.gsub(/[ \/]/, "-")
+    end
+
+    def inspect_buildx
+      pipe \
+        docker(:buildx, :inspect, builder_name),
+        grep("-q", "Endpoint:.*cloud://.*")
+    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_builder_name_suffix}"
+    end
+
+    def create_local_buildx
+      docker :buildx, :create, *platform_options(local_arches), "--name", builder_name, "--driver=#{driver}", *driver_options
+    end
+
+    def append_remote_buildx
+      docker :buildx, :create, *platform_options(remote_arches), "--append", "--name", builder_name, *driver_options, remote_context_name
+    end
+end

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

@@ -0,0 +1,20 @@
+class Kamal::Commands::Builder::Local < Kamal::Commands::Builder::Base
+  def create
+    return if docker_driver?
+
+    docker :buildx, :create, "--name", builder_name, "--driver=#{driver}", *driver_options
+  end
+
+  def remove
+    docker :buildx, :rm, builder_name unless docker_driver?
+  end
+
+  private
+    def builder_name
+      if registry_config.local?
+        "kamal-local-registry-#{driver}"
+      else
+        "kamal-local-#{driver}"
+      end
+    end
+end

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

@@ -0,0 +1,46 @@
+class Kamal::Commands::Builder::Pack < Kamal::Commands::Builder::Base
+  def push(export_action = "registry", tag_as_dirty: false, no_cache: false)
+    combine \
+      build(tag_as_dirty: tag_as_dirty, no_cache: no_cache),
+      export(export_action)
+  end
+
+  def remove;end
+
+  def info
+    pack :builder, :inspect, pack_builder
+  end
+  alias_method :inspect_builder, :info
+
+  private
+    def build(tag_as_dirty: false, no_cache: false)
+      pack(:build,
+        config.repository,
+        "--platform", platform,
+        "--creation-time", "now",
+        "--builder", pack_builder,
+        buildpacks,
+        *build_tag_options(tag_as_dirty: tag_as_dirty),
+        *([ "--clear-cache" ] if no_cache),
+        "--env", "BP_IMAGE_LABELS=service=#{config.service}",
+        *argumentize("--env", args),
+        *argumentize("--env", secrets, sensitive: true),
+        "--path", build_context)
+    end
+
+    def export(export_action)
+      return unless export_action == "registry"
+
+      combine \
+        docker(:push, config.absolute_image),
+        docker(:push, config.latest_image)
+    end
+
+    def platform
+      "linux/#{local_arches.first}"
+    end
+
+    def buildpacks
+      (pack_buildpacks << "paketo-buildpacks/image-labels").map { |buildpack| [ "--buildpack", buildpack ] }
+    end
+end

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

@@ -0,0 +1,75 @@
+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
+
+  def inspect_builder
+    combine \
+      combine(inspect_buildx, inspect_remote_context),
+      [ "(echo no compatible builder && exit 1)" ],
+      by: "||"
+  end
+
+  def login_to_registry_locally?
+    false
+  end
+
+  def push_env
+    { "BUILDKIT_NO_CLIENT_TOKEN" => "1" }
+  end
+
+  private
+    def builder_name
+      "kamal-remote-#{remote_builder_name_suffix}"
+    end
+
+    def remote_context_name
+      "#{builder_name}-context"
+    end
+
+    def remote_builder_name_suffix
+      "#{remote.gsub(/[^a-z0-9_-]/, "-")}#{registry_config.local? ? "-local-registry" : "" }"
+    end
+
+    def inspect_buildx
+      pipe \
+        docker(:buildx, :inspect, builder_name),
+        grep("-q", "Endpoint:.*#{remote_context_name}")
+    end
+
+    def inspect_remote_context
+      pipe \
+        docker(:context, :inspect, remote_context_name, "--format", ENDPOINT_DOCKER_HOST_INSPECT),
+        grep("-xq", remote)
+    end
+
+    def create_remote_context
+      docker :context, :create, remote_context_name, "--description", "'#{builder_name} host'", "--docker", "'host=#{remote}'"
+    end
+
+    def remove_remote_context
+      docker :context, :rm, remote_context_name
+    end
+
+    def create_buildx
+      docker :buildx, :create, "--name", builder_name, *driver_options, remote_context_name
+    end
+
+    def remove_buildx
+      docker :buildx, :rm, builder_name
+    end
+end

data/lib/kamal/commands/builder.rb

@@ -0,0 +1,54 @@
+require "active_support/core_ext/string/filters"
+
+class Kamal::Commands::Builder < Kamal::Commands::Base
+  delegate \
+    :create, :remove, :dev, :push, :clean, :pull, :info, :inspect_builder,
+    :validate_image, :first_mirror, :login_to_registry_locally?, :push_env,
+    to: :target
+
+  delegate \
+    :local?, :remote?, :pack?, :cloud?,
+    to: "config.builder"
+
+  include Clone
+
+  def name
+    target.class.to_s.remove("Kamal::Commands::Builder::").underscore.inquiry
+  end
+
+  def target
+    if remote?
+      if local?
+        hybrid
+      else
+        remote
+      end
+    elsif pack?
+      pack
+    elsif cloud?
+      cloud
+    else
+      local
+    end
+  end
+
+  def remote
+    @remote ||= Kamal::Commands::Builder::Remote.new(config)
+  end
+
+  def local
+    @local ||= Kamal::Commands::Builder::Local.new(config)
+  end
+
+  def hybrid
+    @hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
+  end
+
+  def pack
+    @pack ||= Kamal::Commands::Builder::Pack.new(config)
+  end
+
+  def cloud
+    @cloud ||= Kamal::Commands::Builder::Cloud.new(config)
+  end
+end

data/lib/kamal/commands/docker.rb

@@ -0,0 +1,50 @@
+class Kamal::Commands::Docker < Kamal::Commands::Base
+  # Install Docker using the https://github.com/docker/docker-install convenience script.
+  def install
+    pipe get_docker, :sh
+  end
+
+  # Checks the Docker client version. Fails if Docker is not installed.
+  def installed?
+    docker "-v"
+  end
+
+  # Checks the Docker server version. Fails if Docker is not running.
+  def running?
+    docker :version
+  end
+
+  # Do we have superuser access to install Docker and start system services?
+  def superuser?
+    [ '[ "${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
+    docker :network, :create, :kamal
+  end
+
+  private
+    def get_docker
+      shell \
+        any \
+          [ :curl, "-fsSL", "https://get.docker.com" ],
+          [ :wget, "-O -", "https://get.docker.com" ],
+          [ :echo, "\"exit 1\"" ]
+    end
+end

data/lib/kamal/commands/hook.rb

@@ -0,0 +1,20 @@
+class Kamal::Commands::Hook < Kamal::Commands::Base
+  def run(hook)
+    [ hook_file(hook) ]
+  end
+
+  def env(secrets: false, **details)
+    tags(**details).env.tap do |env|
+      env.merge!(config.secrets.to_h) if secrets
+    end
+  end
+
+  def hook_exists?(hook)
+    Pathname.new(hook_file(hook)).exist?
+  end
+
+  private
+    def hook_file(hook)
+      File.join(config.hooks_path, hook)
+    end
+end

data/lib/kamal/commands/loadbalancer.rb

@@ -0,0 +1,130 @@
+class Kamal::Commands::Loadbalancer < Kamal::Commands::Base
+  delegate :argumentize, :optionize, to: Kamal::Utils
+
+  attr_reader :loadbalancer_config
+
+  def initialize(config, loadbalancer_config: nil)
+    super(config)
+    @loadbalancer_config = loadbalancer_config
+  end
+
+  def run
+    pipe \
+      [ :echo, proxy_image ],
+      xargs(docker(:run,
+        "--name", container_name,
+        "--network", "kamal",
+        "--detach",
+        "--restart", "unless-stopped",
+        "--publish", "80:80",
+        "--publish", "443:443",
+        "--label", label,
+        *volume_mounts))
+  end
+
+  def start
+    docker :container, :start, container_name
+  end
+
+  def stop(name: container_name)
+    docker :container, :stop, name
+  end
+
+  def start_or_run
+    combine start, run, by: "||"
+  end
+
+  def deploy(targets: [])
+    target_args = targets.map { |t| "#{t}:80" }
+
+    hosts = loadbalancer_config.hosts
+
+    options = []
+    options << "--target=#{target_args.join(',')}"
+    options << "--host=#{hosts.join(',')}"
+    options << "--tls" if loadbalancer_config.ssl?
+
+    docker :exec, container_name, "kamal-proxy", "deploy", loadbalancer_config.config.service, *options
+  end
+
+  def info
+    docker :ps, "--filter", "'name=^#{container_name}$'"
+  end
+
+  def version
+    pipe \
+      docker(:inspect, container_name, "--format '{{.Config.Image}}'"),
+      [ :cut, "-d:", "-f2" ]
+  end
+
+  def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
+    pipe \
+      docker(:logs, container_name, ("--since #{since}" if since), ("--tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
+      ("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
+  end
+
+  def follow_logs(host:, timestamps: true, grep: nil, grep_options: nil)
+    run_over_ssh pipe(
+      docker(:logs, container_name, ("--timestamps" if timestamps), "--tail", "10", "--follow", "2>&1"),
+      (%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
+    ).join(" "), host: host
+  end
+
+  def remove_container
+    docker :container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=kamal-loadbalancer"
+  end
+
+  def remove_image
+    docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=kamal-loadbalancer"
+  end
+
+  def ensure_directory
+    make_directory loadbalancer_config.directory
+  end
+
+  def ensure_apps_config_directory
+    make_directory config.proxy_boot.apps_directory
+  end
+
+  def remove_directory
+    super(loadbalancer_config.directory)
+  end
+
+  def container_name
+    loadbalancer_config.container_name
+  end
+
+  private
+    def proxy_image
+      [
+        loadbalancer_config.config.proxy_boot.image_default,
+        Kamal::Configuration::Proxy::Run::MINIMUM_VERSION
+      ].join(":")
+    end
+
+    def on_proxy_host?
+      loadbalancer_config.on_proxy_host?
+    end
+
+    def label
+      if on_proxy_host?
+        "org.opencontainers.image.title=kamal-proxy"
+      else
+        "org.opencontainers.image.title=kamal-loadbalancer"
+      end
+    end
+
+    def volume_mounts
+      if on_proxy_host?
+        # When on a proxy host, use same volume mounts as proxy for app deployments
+        [
+          "--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
+          "--volume", "$PWD/#{config.proxy_boot.apps_directory}:/home/kamal-proxy/.apps-config"
+        ]
+      else
+        [
+          "--volume", "kamal-loadbalancer-config:/home/kamal-loadbalancer/.config/kamal-loadbalancer"
+        ]
+      end
+    end
+end

data/lib/kamal/commands/lock.rb

@@ -0,0 +1,70 @@
+require "active_support/duration"
+require "time"
+require "base64"
+
+class Kamal::Commands::Lock < Kamal::Commands::Base
+  def acquire(message, version)
+    combine \
+      [ :mkdir, lock_dir ],
+      write_lock_details(message, version)
+  end
+
+  def release
+    combine \
+      [ :rm, lock_details_file ],
+      [ :rm, "-r", lock_dir ]
+  end
+
+  def status
+    combine \
+      stat_lock_dir,
+      read_lock_details
+  end
+
+  def ensure_locks_directory
+    [ :mkdir, "-p", locks_dir ]
+  end
+
+  private
+    def write_lock_details(message, version)
+      write \
+        [ :echo, "\"#{Base64.encode64(lock_details(message, version))}\"" ],
+        lock_details_file
+    end
+
+    def read_lock_details
+      pipe \
+        [ :cat, lock_details_file ],
+        [ :base64, "-d" ]
+    end
+
+    def stat_lock_dir
+      write \
+        [ :stat, lock_dir ],
+        "/dev/null"
+    end
+
+    def lock_dir
+      dir_name = [ "lock", config.service, config.destination ].compact.join("-")
+
+      File.join(config.run_directory, dir_name)
+    end
+
+    def lock_details_file
+      File.join(lock_dir, "details")
+    end
+
+    def lock_details(message, version)
+      <<~DETAILS.strip
+        Locked by: #{locked_by} at #{Time.now.utc.iso8601}
+        Version: #{version}
+        Message: #{message}
+      DETAILS
+    end
+
+    def locked_by
+      Kamal::Git.user_name
+    rescue Errno::ENOENT
+      "Unknown"
+    end
+end