mrsk 0.9.1 → 0.10.0

data/lib/mrsk/commands/app.rb

@@ -1,13 +1,21 @@
 class Mrsk::Commands::App < Mrsk::Commands::Base
-  def run(role: :web)
-    role = config.role(role)
+  attr_reader :role
+
+  def initialize(config, role: nil)
+    super(config)
+    @role = role
+  end
+
+  def run
+    role = config.role(self.role)
 
     docker :run,
       "--detach",
       "--restart unless-stopped",
-      "--log-opt", "max-size=#{MAX_LOG_SIZE}",
-      "--name", service_with_version,
+      "--name", container_name,
+      "-e", "MRSK_CONTAINER_NAME=\"#{container_name}\"",
       *role.env_args,
+      *config.logging_args,
       *config.volume_args,
       *role.label_args,
       *role.option_args,
@@ -16,17 +24,17 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   def start
-    docker :start, service_with_version
+    docker :start, container_name
   end
 
   def stop(version: nil)
     pipe \
       version ? container_id_for_version(version) : current_container_id,
-      xargs(docker(:stop))
+      xargs(config.stop_wait_time ? docker(:stop, "-t", config.stop_wait_time) : docker(:stop))
   end
 
   def info
-    docker :ps, *service_filter
+    docker :ps, *filter_args
   end
 
 
@@ -51,7 +59,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   def execute_in_existing_container(*command, interactive: false)
     docker :exec,
       ("-it" if interactive),
-      config.service_with_version,
+      container_name,
       *command
   end
 
@@ -75,32 +83,23 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
 
 
   def current_container_id
-    docker :ps, "--quiet", *service_filter
+    docker :ps, "--quiet", *filter_args
+  end
+
+  def container_id_for_version(version)
+    container_id_for(container_name: container_name(version))
   end
 
   def current_running_version
     # FIXME: Find more graceful way to extract the version from "app-version" than using sed and tail!
     pipe \
-      docker(:ps, "--filter", "label=service=#{config.service}", "--format", '"{{.Names}}"'),
+      docker(:ps, *filter_args, "--format", '"{{.Names}}"'),
       %(sed 's/-/\\n/g'),
       "tail -n 1"
   end
 
-  def most_recent_version_from_available_images
-    pipe \
-      docker(:image, :ls, "--format", '"{{.Tag}}"', config.repository),
-      "head -n 1"
-  end
-
-  def all_versions_from_available_containers
-    pipe \
-      docker(:image, :ls, "--format", '"{{.Tag}}"', config.repository),
-      "head -n 1"
-  end
-
-
   def list_containers
-    docker :container, :ls, "--all", *service_filter
+    docker :container, :ls, "--all", *filter_args
   end
 
   def list_container_names
@@ -109,12 +108,16 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
 
   def remove_container(version:)
     pipe \
-      container_id_for(container_name: service_with_version(version)),
+      container_id_for(container_name: container_name(version)),
       xargs(docker(:container, :rm))
   end
 
+  def rename_container(version:, new_version:)
+    docker :rename, container_name(version), container_name(new_version)
+  end
+
   def remove_containers
-    docker :container, :prune, "--force", *service_filter
+    docker :container, :prune, "--force", *filter_args
   end
 
   def list_images
@@ -122,24 +125,23 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   def remove_images
-    docker :image, :prune, "--all", "--force", *service_filter
+    docker :image, :prune, "--all", "--force", *filter_args
   end
 
 
   private
-    def service_with_version(version = nil)
-      if version
-        "#{config.service}-#{version}"
-      else
-        config.service_with_version
-      end
+    def container_name(version = nil)
+      [ config.service, role, config.destination, version || config.version ].compact.join("-")
     end
 
-    def container_id_for_version(version)
-      container_id_for(container_name: service_with_version(version))    
+    def filter_args
+      argumentize "--filter", filters
     end
 
-    def service_filter
-      [ "--filter", "label=service=#{config.service}" ]
+    def filters
+      [ "label=service=#{config.service}" ].tap do |filters|
+        filters << "label=destination=#{config.destination}" if config.destination
+        filters << "label=role=#{role}" if role
+      end
     end
 end

data/lib/mrsk/commands/auditor.rb

@@ -1,6 +1,13 @@
 require "active_support/core_ext/time/conversions"
 
 class Mrsk::Commands::Auditor < Mrsk::Commands::Base
+  attr_reader :role
+
+  def initialize(config, role: nil)
+    super(config)
+    @role = role
+  end
+
   # Runs remotely
   def record(line)
     append \
@@ -21,22 +28,30 @@ class Mrsk::Commands::Auditor < Mrsk::Commands::Base
 
   private
     def audit_log_file
-      "mrsk-#{config.service}-audit.log"
+      [ "mrsk", config.service, config.destination, "audit.log" ].compact.join("-")
     end
 
     def tagged_record_line(line)
-      "'#{recorded_at_tag} #{performer_tag} #{line}'"
+      tagged_line recorded_at_tag, performer_tag, role_tag, line
     end
 
     def tagged_broadcast_line(line)
-      "'#{performer_tag} #{line}'"
+      tagged_line performer_tag, role_tag, line
     end
 
-    def performer_tag
-      "[#{`whoami`.strip}]"
+    def tagged_line(*tags_and_line)
+      "'#{tags_and_line.compact.join(" ")}'"
     end
 
     def recorded_at_tag
       "[#{Time.now.to_fs(:db)}]"
     end
+
+    def performer_tag
+      "[#{`whoami`.strip}]"
+    end
+
+    def role_tag
+      "[#{role}]" if role
+    end
 end

data/lib/mrsk/commands/base.rb

@@ -1,8 +1,6 @@
 module Mrsk::Commands
   class Base
-    delegate :redact, to: Mrsk::Utils
-
-    MAX_LOG_SIZE = "10m"
+    delegate :redact, :argumentize, to: Mrsk::Utils
 
     attr_accessor :config
 
@@ -18,7 +16,7 @@ module Mrsk::Commands
     end
 
     def container_id_for(container_name:)
-      docker :container, :ls, "--all", "--filter", "name=#{container_name}", "--quiet"
+      docker :container, :ls, "--all", "--filter", "name=^#{container_name}$", "--quiet"
     end
 
     private
@@ -41,6 +39,10 @@ module Mrsk::Commands
         combine *commands, by: ">>"
       end
 
+      def write(*commands)
+        combine *commands, by: ">"
+      end
+
       def xargs(command)
         [ :xargs, command ].flatten
       end

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

@@ -7,6 +7,7 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
 
   def pull
     docker :pull, config.absolute_image
+    docker :pull, config.latest_image
   end
 
   def build_options

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

@@ -10,7 +10,8 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
   def push
     combine \
       docker(:build, *build_options, build_context),
-      docker(:push, config.absolute_image)
+      docker(:push, config.absolute_image),
+      docker(:push, config.latest_image)
   end
 
   def info

data/lib/mrsk/commands/healthcheck.rb

@@ -9,8 +9,10 @@ class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
       "--name", container_name_with_version,
       "--publish", "#{EXPOSED_PORT}:#{config.healthcheck["port"]}",
       "--label", "service=#{container_name}",
+      "-e", "MRSK_CONTAINER_NAME=\"#{container_name}\"",
       *web.env_args,
       *config.volume_args,
+      *web.option_args,
       config.absolute_image,
       web.cmd
   end
@@ -33,15 +35,15 @@ class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
 
   private
     def container_name
-      "healthcheck-#{config.service}"
+      [ "healthcheck", config.service, config.destination ].compact.join("-")
     end
 
     def container_name_with_version
-      "healthcheck-#{config.service_with_version}"
+      "#{container_name}-#{config.version}"
     end
 
     def container_id
-      container_id_for(container_name: container_name)
+      container_id_for(container_name: container_name_with_version)
     end
 
     def health_url

data/lib/mrsk/commands/lock.rb

@@ -0,0 +1,63 @@
+require "active_support/duration"
+require "active_support/core_ext/numeric/time"
+
+class Mrsk::Commands::Lock < Mrsk::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
+
+  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
+      :mrsk_lock
+    end
+
+    def lock_details_file
+      [lock_dir, :details].join("/")
+    end
+
+    def lock_details(message, version)
+      <<~DETAILS.strip
+        Locked by: #{locked_by} at #{Time.now.gmtime}
+        Version: #{version}
+        Message: #{message}
+      DETAILS
+    end
+
+    def locked_by
+      `git config user.name`.strip
+    rescue Errno::ENOENT
+      "Unknown"
+    end
+end

data/lib/mrsk/commands/traefik.rb

@@ -1,16 +1,18 @@
 class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   delegate :optionize, to: Mrsk::Utils
 
+  IMAGE = "traefik:v2.9.9"
   CONTAINER_PORT = 80
 
   def run
     docker :run, "--name traefik",
       "--detach",
       "--restart", "unless-stopped",
-      "--log-opt", "max-size=#{MAX_LOG_SIZE}",
       "--publish", port,
       "--volume", "/var/run/docker.sock:/var/run/docker.sock",
-      "traefik",
+      *config.logging_args,
+      *docker_options_args,
+      IMAGE,
       "--providers.docker",
       "--log.level=DEBUG",
       *cmd_option_args
@@ -25,7 +27,7 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   end
 
   def info
-    docker :ps, "--filter", "name=traefik"
+    docker :ps, "--filter", "name=^traefik$"
   end
 
   def logs(since: nil, lines: nil, grep: nil)
@@ -49,20 +51,24 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
     docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
   end
 
-  def port    
+  def port
     "#{host_port}:#{CONTAINER_PORT}"
   end
 
   private
+    def docker_options_args
+      optionize(config.traefik["options"] || {})
+    end
+
     def cmd_option_args
-      if args = config.raw_config.dig(:traefik, "args")
-        optionize args
+      if args = config.traefik["args"]
+        optionize args, with: "="
       else
         []
       end
     end
 
     def host_port
-      config.raw_config.dig(:traefik, "host_port") || CONTAINER_PORT
+      config.traefik["host_port"] || CONTAINER_PORT
     end
 end

data/lib/mrsk/configuration/accessory.rb

@@ -1,5 +1,5 @@
 class Mrsk::Configuration::Accessory
-  delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
+  delegate :argumentize, :argumentize_env_with_secrets, :optionize, to: Mrsk::Utils
 
   attr_accessor :name, :specifics
 
@@ -15,18 +15,24 @@ class Mrsk::Configuration::Accessory
     specifics["image"]
   end
 
-  def host
-    specifics["host"] || raise(ArgumentError, "Missing host for accessory")
+  def hosts
+    if (specifics.keys & ["host", "hosts", "roles"]).size != 1
+      raise ArgumentError, "Specify one of `host`, `hosts` or `roles` for accessory `#{name}`"
+    end
+
+    hosts_from_host || hosts_from_hosts || hosts_from_roles
   end
 
   def port
-    if specifics["port"].to_s.include?(":")
-      specifics["port"]
-    else
-      "#{specifics["port"]}:#{specifics["port"]}"
+    if port = specifics["port"]&.to_s
+      port.include?(":") ? port : "#{port}:#{port}"
     end
   end
 
+  def publish_args
+    argumentize "--publish", port if port
+  end
+
   def labels
     default_labels.merge(specifics["labels"] || {})
   end
@@ -65,6 +71,18 @@ class Mrsk::Configuration::Accessory
     argumentize "--volume", volumes
   end
 
+  def option_args
+    if args = specifics["options"]
+      optionize args
+    else
+      []
+    end
+  end
+
+  def cmd
+    specifics["cmd"]
+  end
+
   private
     attr_accessor :config
 
@@ -120,4 +138,32 @@ class Mrsk::Configuration::Accessory
     def service_data_directory
       "$PWD/#{service_name}"
     end
+
+    def hosts_from_host
+      if specifics.key?("host")
+        host = specifics["host"]
+        if host
+          [host]
+        else
+          raise ArgumentError, "Missing host for accessory `#{name}`"
+        end
+      end
+    end
+
+    def hosts_from_hosts
+      if specifics.key?("hosts")
+        hosts = specifics["hosts"]
+        if hosts.is_a?(Array)
+          hosts
+        else
+          raise ArgumentError, "Hosts should be an Array for accessory `#{name}`"
+        end
+      end
+    end
+
+    def hosts_from_roles
+      if specifics.key?("roles")
+        specifics["roles"].flat_map { |role| config.role(role).hosts }
+      end
+    end
 end

data/lib/mrsk/configuration/role.rb

@@ -7,6 +7,10 @@ class Mrsk::Configuration::Role
    @name, @config = name.inquiry, config
   end
 
+  def primary_host
+    hosts.first
+  end
+
   def hosts
     @hosts ||= extract_hosts_from_config
   end
@@ -55,12 +59,16 @@ class Mrsk::Configuration::Role
         config.servers
       else
         servers = config.servers[name]
-        servers.is_a?(Array) ? servers : servers["hosts"]
+        servers.is_a?(Array) ? servers : Array(servers["hosts"])
       end
     end
 
     def default_labels
-      { "service" => config.service, "role" => name }
+      if config.destination
+        { "service" => config.service, "role" => name, "destination" => config.destination }
+      else
+        { "service" => config.service, "role" => name }
+      end
     end
 
     def traefik_labels
@@ -69,8 +77,9 @@ class Mrsk::Configuration::Role
           "traefik.http.routers.#{config.service}.rule" => "PathPrefix(`/`)",
           "traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => config.healthcheck["path"],
           "traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
-          "traefik.http.middlewares.#{config.service}.retry.attempts" => "5",
-          "traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
+          "traefik.http.middlewares.#{config.service}-retry.retry.attempts" => "5",
+          "traefik.http.middlewares.#{config.service}-retry.retry.initialinterval" => "500ms",
+          "traefik.http.routers.#{config.service}.middlewares" => "#{config.service}-retry@docker"
         }
       else
         {}

data/lib/mrsk/configuration.rb

@@ -6,23 +6,24 @@ require "erb"
 require "net/ssh/proxy/jump"
 
 class Mrsk::Configuration
-  delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :raw_config, allow_nil: true
-  delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
+  delegate :service, :image, :servers, :env, :labels, :registry, :builder, :stop_wait_time, to: :raw_config, allow_nil: true
+  delegate :argumentize, :argumentize_env_with_secrets, :optionize, to: Mrsk::Utils
 
-  attr_accessor :version
+  attr_accessor :destination
   attr_accessor :raw_config
 
   class << self
-    def create_from(base_config_file, destination: nil, version: "missing")
-      new(load_config_file(base_config_file).tap do |config|
-        if destination
-          config.deep_merge! \
-            load_config_file destination_config_file(base_config_file, destination)
-        end
-      end, version: version)
+    def create_from(config_file:, destination: nil, version: nil)
+      raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
+
+      new raw_config, destination: destination, version: version
     end
 
     private
+      def load_config_files(*files)
+        files.inject({}) { |config, file| config.deep_merge! load_config_file(file) }
+      end
+
       def load_config_file(file)
         if file.exist?
           YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
@@ -32,18 +33,31 @@ class Mrsk::Configuration
       end
 
       def destination_config_file(base_config_file, destination)
-        dir, basename = base_config_file.split
-        dir.join basename.to_s.remove(".yml") + ".#{destination}.yml"
+        base_config_file.sub_ext(".#{destination}.yml") if destination
       end
   end
 
-  def initialize(raw_config, version: "missing", validate: true)
+  def initialize(raw_config, destination: nil, version: nil, validate: true)
     @raw_config = ActiveSupport::InheritableOptions.new(raw_config)
-    @version = version
+    @destination = destination
+    @declared_version = version
     valid? if validate
   end
 
 
+  def version=(version)
+    @declared_version = version
+  end
+
+  def version
+    @declared_version.presence || ENV["VERSION"] || current_commit_hash
+  end
+
+  def abbreviated_version
+    Mrsk::Utils.abbreviate_version(version)
+  end
+
+
   def roles
     @roles ||= role_names.collect { |role_name| Role.new(role_name, config: self) }
   end
@@ -62,15 +76,15 @@ class Mrsk::Configuration
 
 
   def all_hosts
-    roles.flat_map(&:hosts)
+    roles.flat_map(&:hosts).uniq
   end
 
   def primary_web_host
-    role(:web).hosts.first
+    role(:web).primary_host
   end
 
   def traefik_hosts
-    roles.select(&:running_traefik?).flat_map(&:hosts)
+    roles.select(&:running_traefik?).flat_map(&:hosts).uniq
   end
 
 
@@ -107,6 +121,15 @@ class Mrsk::Configuration
     end
   end
 
+  def logging_args
+    if raw_config.logging.present?
+      optionize({ "log-driver" => raw_config.logging["driver"] }.compact) +
+        argumentize("--log-opt", raw_config.logging["options"])
+    else
+      argumentize("--log-opt", { "max-size" => "10m" })
+    end
+  end
+
 
   def ssh_user
     if raw_config.ssh.present?
@@ -159,10 +182,14 @@ class Mrsk::Configuration
       ssh_options: ssh_options,
       builder: raw_config.builder,
       accessories: raw_config.accessories,
+      logging: logging_args,
       healthcheck: healthcheck
     }.compact
   end
 
+  def traefik
+    raw_config.traefik || {}
+  end
 
   private
     # Will raise ArgumentError if any required config keys are missing
@@ -179,6 +206,12 @@ class Mrsk::Configuration
         raise ArgumentError, "You must specify a password for the registry in config/deploy.yml (or set the ENV variable if that's used)"
       end
 
+      roles.each do |role|
+        if role.hosts.empty?
+          raise ArgumentError, "No servers specified for the #{role.name} role"
+        end
+      end
+
       true
     end
 
@@ -193,4 +226,13 @@ class Mrsk::Configuration
     def role_names
       raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
     end
+
+    def current_commit_hash
+      @current_commit_hash ||=
+        if system("git rev-parse")
+          `git rev-parse HEAD`.strip
+        else
+          raise "Can't use commit hash as version, no git repository found in #{Dir.pwd}"
+        end
+    end
 end