Merge branch 'main' into pr/99

* main:
  Ask for access token
  Style
  Style
  config.traefik is already nil safe
  Update README.md
  Bump dev deps and consolidate platform matches
  Deploys mention the released service@version
  Accessories aren't required to publish a port
  Accessories may be pulled from authenticated registries
  Polish destination config loading
  Allow arbitrary docker options for traefik
  Fixed typos
  Fixed readme
  Rebased on main
  Added volume configuration in response to issue coments
  Modified in response to PR comments
  Added the additional_ports configuration

lib/mrsk/cli/accessory.rb

@@ -9,6 +9,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
         upload(name)
 
         on(accessory.host) do
+          execute *MRSK.registry.login
           execute *MRSK.auditor.record("Booted #{name} accessory"), verbosity: :debug
           execute *accessory.run
         end

lib/mrsk/cli/main.rb

@@ -40,7 +40,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
       invoke "mrsk:cli:prune:all", [], invoke_options
     end
 
-    audit_broadcast "Deployed app in #{runtime.to_i} seconds" unless options[:skip_broadcast]
+    audit_broadcast "Deployed #{service_version} in #{runtime.round} seconds" unless options[:skip_broadcast]
   end
 
   desc "redeploy", "Deploy app to servers without bootstrapping servers, starting Traefik, pruning, and registry login"
@@ -63,7 +63,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
       invoke "mrsk:cli:app:boot", [], invoke_options
     end
 
-    audit_broadcast "Redeployed app in #{runtime.to_i} seconds" unless options[:skip_broadcast]
+    audit_broadcast "Redeployed #{service_version} in #{runtime.round} seconds" unless options[:skip_broadcast]
   end
 
   desc "rollback [VERSION]", "Rollback app to VERSION"
@@ -74,18 +74,21 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
       say "Start version #{version}, then wait #{MRSK.config.readiness_delay}s for app to boot before stopping the old version...", :magenta
 
       cli = self
+      old_version = nil
 
       on(MRSK.hosts) do |host|
         old_version = capture_with_info(*MRSK.app.current_running_version).strip.presence
 
         execute *MRSK.app.start
 
-        sleep MRSK.config.readiness_delay
+        if old_version
+          sleep MRSK.config.readiness_delay
 
-        execute *MRSK.app.stop(version: old_version), raise_on_non_zero_exit: false
+          execute *MRSK.app.stop(version: old_version), raise_on_non_zero_exit: false
+        end
       end
 
-      audit_broadcast "Rolled back app to version #{version}" unless options[:skip_broadcast]
+      audit_broadcast "Rolled back #{service_version(Mrsk::Utils.abbreviate_version(old_version))} to #{service_version}" unless options[:skip_broadcast]
     else
       say "The app version '#{version}' is not available as a container (use 'mrsk app containers' for available versions)", :red
     end
@@ -203,4 +206,8 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
       on(host) { container_names = capture_with_info(*MRSK.app.list_container_names).split("\n") }
       Array(container_names).include?(container_name)
     end
+
+    def service_version(version = MRSK.config.abbreviated_version)
+      [ MRSK.config.service, version ].compact.join("@")
+    end
 end

lib/mrsk/cli/templates/deploy.yml

@@ -13,6 +13,8 @@ registry:
   # Specify the registry server, if you're not using Docker Hub
   # server: registry.digitalocean.com / ghcr.io / ...
   username: my-user
+
+  # Always use an access token rather than real password when possible.
   password:
     - MRSK_REGISTRY_PASSWORD
 

lib/mrsk/commands/accessory.rb

@@ -1,6 +1,6 @@
 class Mrsk::Commands::Accessory < Mrsk::Commands::Base
   attr_reader :accessory_config
-  delegate :service_name, :image, :host, :port, :files, :directories, :env_args, :volume_args, :label_args, to: :accessory_config
+  delegate :service_name, :image, :host, :port, :files, :directories, :publish_args, :env_args, :volume_args, :label_args, to: :accessory_config
 
   def initialize(config, name:)
     super(config)
@@ -13,7 +13,7 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
       "--detach",
       "--restart", "unless-stopped",
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
-      "--publish", port,
+      *publish_args,
       *env_args,
       *volume_args,
       *label_args,

lib/mrsk/commands/traefik.rb

@@ -10,6 +10,7 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
       "--publish", port,
       "--volume", "/var/run/docker.sock:/var/run/docker.sock",
+      *docker_options_args,
       "traefik",
       "--providers.docker",
       "--log.level=DEBUG",
@@ -54,6 +55,10 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   end
 
   private
+    def docker_options_args
+      optionize(config.traefik["options"] || {})
+    end
+
     def cmd_option_args
       if args = config.traefik["args"]
         optionize args, with: "="

lib/mrsk/configuration.rb

@@ -15,15 +15,16 @@ class Mrsk::Configuration
 
   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, destination: destination, version: version)
+      raw_config = load_config_files(base_config_file, *destination_config_file(base_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
@@ -33,8 +34,7 @@ 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
 
@@ -46,6 +46,11 @@ class Mrsk::Configuration
   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

lib/mrsk/configuration/accessory.rb

@@ -20,13 +20,15 @@ class Mrsk::Configuration::Accessory
   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

lib/mrsk/utils.rb

@@ -26,14 +26,19 @@ module Mrsk::Utils
   # Returns a list of shell-dashed option arguments. If the value is true, it's treated like a value-less option.
   def optionize(args, with: nil)
     options = if with
-      args.collect { |(key, value)| value == true ? "--#{key}" : "--#{key}#{with}#{escape_shell_value(value)}" }
+      flatten_args(args).collect { |(key, value)| value == true ? "--#{key}" : "--#{key}#{with}#{escape_shell_value(value)}" }
     else
-      args.collect { |(key, value)| [ "--#{key}", value == true ? nil : escape_shell_value(value) ] }
+      flatten_args(args).collect { |(key, value)| [ "--#{key}", value == true ? nil : escape_shell_value(value) ] }
     end
 
     options.flatten.compact
   end
 
+  # Flattens a one-to-many structure into an array of two-element arrays each containing a key-value pair
+  def flatten_args(args)
+    args.flat_map { |key, value| value.try(:map) { |entry| [key, entry] } || [ [ key, value ] ] }
+  end
+
   # Copied from SSHKit::Backend::Abstract#redact to be available inside Commands classes
   def redact(arg) # Used in execute_command to hide redact() args a user passes in
     arg.to_s.extend(SSHKit::Redaction) # to_s due to our inability to extend Integer, etc
@@ -43,4 +48,9 @@ module Mrsk::Utils
   def escape_shell_value(value)
     value.to_s.dump.gsub(/`/, '\\\\`')
   end
+
+  # Abbreviate a git revhash for concise display
+  def abbreviate_version(version)
+    version[0...7] if version
+  end
 end