kamal 1.8.2 → 2.0.0.beta1

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

@@ -1,61 +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
-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

data/lib/kamal/commands/traefik.rb

@@ -1,85 +0,0 @@
-class Kamal::Commands::Traefik < Kamal::Commands::Base
-  delegate :argumentize, :optionize, to: Kamal::Utils
-  delegate :port, :publish?, :labels, :env, :image, :options, :args, to: :"config.traefik"
-
-  def run
-    docker :run, "--name traefik",
-      "--detach",
-      "--restart", "unless-stopped",
-      *publish_args,
-      "--volume", "/var/run/docker.sock:/var/run/docker.sock",
-      *env_args,
-      *config.logging_args,
-      *label_args,
-      *docker_options_args,
-      image,
-      "--providers.docker",
-      *cmd_option_args
-  end
-
-  def start
-    docker :container, :start, "traefik"
-  end
-
-  def stop
-    docker :container, :stop, "traefik"
-  end
-
-  def start_or_run
-    any start, run
-  end
-
-  def info
-    docker :ps, "--filter", "name=^traefik$"
-  end
-
-  def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
-    pipe \
-      docker(:logs, "traefik", (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
-      ("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
-  end
-
-  def follow_logs(host:, grep: nil, grep_options: nil)
-    run_over_ssh pipe(
-      docker(:logs, "traefik", "--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=Traefik"
-  end
-
-  def remove_image
-    docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
-  end
-
-  def make_env_directory
-    make_directory(env.secrets_directory)
-  end
-
-  def remove_env_file
-    [ :rm, "-f", env.secrets_file ]
-  end
-
-  private
-    def publish_args
-      argumentize "--publish", port if publish?
-    end
-
-    def label_args
-      argumentize "--label", labels
-    end
-
-    def env_args
-      env.args
-    end
-
-    def docker_options_args
-      optionize(options)
-    end
-
-    def cmd_option_args
-      optionize args, with: "="
-    end
-end

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

@@ -1,59 +0,0 @@
-# Healthcheck configuration
-#
-# On roles that are running Traefik, Kamal will supply a default healthcheck to `docker run`.
-# For other roles, by default no healthcheck is supplied.
-#
-# If no healthcheck is supplied and the image does not define one, they we wait for the container
-# to reach a running state and then pause for the readiness delay.
-#
-# The default healthcheck is `curl -f http://localhost:<port>/<path>`, so it assumes that `curl`
-# is available within the container.
-
-# Healthcheck options
-#
-# These go under the `healthcheck` key in the root or role configuration.
-healthcheck:
-
-  # Command
-  #
-  # The command to run, defaults to `curl -f http://localhost:<port>/<path>` on roles running Traefik
-  cmd: "curl -f http://localhost"
-
-  # Interval
-  #
-  # The Docker healthcheck interval, defaults to `1s`
-  interval: 10s
-
-  # Max attempts
-  #
-  # The maximum number of times we poll the container to see if it is healthy, defaults to `7`
-  # Each check is separated by an increasing interval starting with 1 second.
-  max_attempts: 3
-
-  # Port
-  #
-  # The port to use in the healthcheck, defaults to `3000`
-  port: "80"
-
-  # Path
-  #
-  # The path to use in the healthcheck, defaults to `/up`
-  path: /health
-
-  # Cords for zero-downtime deployments
-  #
-  # The cord file is used for zero-downtime deployments. The healthcheck is augmented with a check
-  # for the existance of the file. This allows us to delete the file and force the container to
-  # become unhealthy, causing Traefik to stop routing traffic to it.
-  #
-  # Kamal mounts a volume at this location and creates the file before starting the container.
-  # You can set the value to `false` to disable the cord file, but this loses the zero-downtime
-  # guarantee.
-  #
-  # The default value is `/tmp/kamal-cord`
-  cord: /cord
-
-  # Log lines
-  #
-  # Number of lines to log from the container when the healthcheck fails, defaults to `50`
-  log_lines: 100

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

@@ -1,62 +0,0 @@
-# Traefik
-#
-# Traefik is a reverse proxy, used by Kamal for zero-downtime deployments.
-#
-# We start an instance on the hosts in it's own container.
-#
-# During a deployment:
-# 1. We start a new container which Traefik automatically detects due to the labels we have applied
-# 2. Traefik starts routing traffic to the new container
-# 3. We force the old container to fail it's healthcheck, causing Traefik to stop routing traffic to it
-# 4. We stop the old container
-
-# Traefik settings
-#
-# Traekik is configured in the root configuration under `traefik`.
-traefik:
-
-  # Image
-  #
-  # The Traefik image to use, defaults to `traefik:v2.10`
-  image: traefik:v2.9
-
-  # Host port
-  #
-  # The host port to publish the Traefik container on, defaults to `80`
-  host_port: "8080"
-
-  # Disabling publishing
-  #
-  # To avoid publishing the Traefik container, set this to `false`
-  publish: false
-
-  # Labels
-  #
-  # Additional labels to apply to the Traefik container
-  labels:
-    traefik.http.routers.catchall.entryPoints: http
-    traefik.http.routers.catchall.rule: PathPrefix(`/`)
-    traefik.http.routers.catchall.service: unavailable
-    traefik.http.routers.catchall.priority: "1"
-    traefik.http.services.unavailable.loadbalancer.server.port: "0"
-
-  # Arguments
-  #
-  # Additional arguments to pass to the Traefik container
-  args:
-    entryPoints.http.address: ":80"
-    entryPoints.http.forwardedHeaders.insecure: true
-    accesslog: true
-    accesslog.format: json
-
-  # Options
-  #
-  # Additional options to pass to `docker run`
-  options:
-    cpus: 2
-
-  # Environment variables
-  #
-  # See kamal docs env
-  env:
-    ...

data/lib/kamal/configuration/healthcheck.rb

@@ -1,63 +0,0 @@
-class Kamal::Configuration::Healthcheck
-  include Kamal::Configuration::Validation
-
-  attr_reader :healthcheck_config
-
-  def initialize(healthcheck_config:, context: "healthcheck")
-    @healthcheck_config = healthcheck_config || {}
-    validate! @healthcheck_config, context: context
-  end
-
-  def merge(other)
-    self.class.new healthcheck_config: healthcheck_config.deep_merge(other.healthcheck_config)
-  end
-
-  def cmd
-    healthcheck_config.fetch("cmd", http_health_check)
-  end
-
-  def port
-    healthcheck_config.fetch("port", 3000)
-  end
-
-  def path
-    healthcheck_config.fetch("path", "/up")
-  end
-
-  def max_attempts
-    healthcheck_config.fetch("max_attempts", 7)
-  end
-
-  def interval
-    healthcheck_config.fetch("interval", "1s")
-  end
-
-  def cord
-    healthcheck_config.fetch("cord", "/tmp/kamal-cord")
-  end
-
-  def log_lines
-    healthcheck_config.fetch("log_lines", 50)
-  end
-
-  def set_port_or_path?
-    healthcheck_config["port"].present? || healthcheck_config["path"].present?
-  end
-
-  def to_h
-    {
-      "cmd" => cmd,
-      "interval" => interval,
-      "max_attempts" => max_attempts,
-      "port" => port,
-      "path" => path,
-      "cord" => cord,
-      "log_lines" => log_lines
-    }
-  end
-
-  private
-    def http_health_check
-      "curl -f #{URI.join("http://localhost:#{port}", path)} || exit 1" if path.present? || port.present?
-    end
-end

data/lib/kamal/configuration/traefik.rb

@@ -1,60 +0,0 @@
-class Kamal::Configuration::Traefik
-  DEFAULT_IMAGE = "traefik:v2.10"
-  CONTAINER_PORT = 80
-  DEFAULT_ARGS = {
-    "log.level" => "DEBUG"
-  }
-  DEFAULT_LABELS = {
-    # These ensure we serve a 502 rather than a 404 if no containers are available
-    "traefik.http.routers.catchall.entryPoints" => "http",
-    "traefik.http.routers.catchall.rule" => "PathPrefix(`/`)",
-    "traefik.http.routers.catchall.service" => "unavailable",
-    "traefik.http.routers.catchall.priority" => 1,
-    "traefik.http.services.unavailable.loadbalancer.server.port" => "0"
-  }
-
-  include Kamal::Configuration::Validation
-
-  attr_reader :config, :traefik_config
-
-  def initialize(config:)
-    @config = config
-    @traefik_config = config.raw_config.traefik || {}
-    validate! traefik_config
-  end
-
-  def publish?
-    traefik_config["publish"] != false
-  end
-
-  def labels
-    DEFAULT_LABELS.merge(traefik_config["labels"] || {})
-  end
-
-  def env
-    Kamal::Configuration::Env.new \
-      config: traefik_config.fetch("env", {}),
-      secrets_file: File.join(config.host_env_directory, "traefik", "traefik.env"),
-      context: "traefik/env"
-  end
-
-  def host_port
-    traefik_config.fetch("host_port", CONTAINER_PORT)
-  end
-
-  def options
-    traefik_config.fetch("options", {})
-  end
-
-  def port
-    "#{host_port}:#{CONTAINER_PORT}"
-  end
-
-  def args
-    DEFAULT_ARGS.merge(traefik_config.fetch("args", {}))
-  end
-
-  def image
-    traefik_config.fetch("image", DEFAULT_IMAGE)
-  end
-end