mrsk 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d90c03e2bcea1e39e38d773fd79d4154f24ec3297c5e31d0240e23d25adc6af
-  data.tar.gz: 68aac28eaef8b0246a4cef80d18da9f37069af8740cde1dd7505ef7bad7df8f1
+  metadata.gz: 0a560b5048509237f8c8440a41b35d674915ac493bcf0176256b1006a6aef004
+  data.tar.gz: d69f0682c43e62fd0574d626456bcb62452ec972b8dd1182b1780958a65aadbd
 SHA512:
-  metadata.gz: 1d491ed1430092b12de3e3a4e765f8da11f4a68c62e86b280368a96389829e1fd0b0238ff11f4811f974dc5aee3e166a5cff9cc3e85ce3ad11e34e4d37def484
-  data.tar.gz: 6e876c4c838c8ca8bcd28f1aa465d97190f6580bcad9942d2c6149346163c1289df18903cdb129c34715a06927d5945dcd988751ec2da397cf6c313781eb0911
+  metadata.gz: d670dd54f94d64b2e35f5082f3a5cd78100780b0e0c5d51d050dc25f00ca4cdca26d0a4d797c01860d04205a2cd0fa4285089a944f72977d287e1c6fd313845e
+  data.tar.gz: 6d28b436a2a0d33da1e32af340e5cd80972b57b946b6b51ec6481b5c832020867075ac53f24dd53f0d86e0d1738a78fb233986530a4ad0d9be1e83e73136522b

data/README.md

@@ -14,7 +14,8 @@ servers:
   - 192.168.0.2
 registry:
   username: registry-user-name
-  password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
+  password:
+    - MRSK_REGISTRY_PASSWORD
 env:
   secret:
     - RAILS_MASTER_KEY
@@ -447,7 +448,7 @@ mrsk app exec -i 'bin/rails console'
 ```
 
 
-### Running details to see state of containers
+### Running details to show state of containers
 
 You can see the state of your servers by running `mrsk details`:
 

data/lib/mrsk/cli/accessory.rb

@@ -1,5 +1,5 @@
 class Mrsk::Cli::Accessory < Mrsk::Cli::Base
-  desc "boot [NAME]", "Boot accessory service on host (use NAME=all to boot all accessories)"
+  desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
   def boot(name)
     if name == "all"
       MRSK.accessory_names.each { |accessory_name| boot(accessory_name) }
@@ -18,7 +18,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "upload [NAME]", "Upload accessory files to host"
+  desc "upload [NAME]", "Upload accessory files to host", hide: true
   def upload(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -33,7 +33,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "directories [NAME]", "Create accessory directories on host"
+  desc "directories [NAME]", "Create accessory directories on host", hide: true
   def directories(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -44,7 +44,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "reboot [NAME]", "Reboot accessory on host (stop container, remove container, start new container)"
+  desc "reboot [NAME]", "Reboot existing accessory on host (stop container, remove container, start new container)"
   def reboot(name)
     with_accessory(name) do |accessory|
       stop(name)
@@ -53,7 +53,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "start [NAME]", "Start existing accessory on host"
+  desc "start [NAME]", "Start existing accessory container on host"
   def start(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -63,7 +63,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "stop [NAME]", "Stop accessory on host"
+  desc "stop [NAME]", "Stop existing accessory container on host"
   def stop(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -73,7 +73,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "restart [NAME]", "Restart accessory on host"
+  desc "restart [NAME]", "Restart existing accessory container on host"
   def restart(name)
     with_accessory(name) do
       stop(name)
@@ -81,7 +81,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "details [NAME]", "Display details about accessory on host (use NAME=all to boot all accessories)"
+  desc "details [NAME]", "Show details about accessory on host (use NAME=all to show all accessories)"
   def details(name)
     if name == "all"
       MRSK.accessory_names.each { |accessory_name| details(accessory_name) }
@@ -92,7 +92,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "exec [NAME] [CMD]", "Execute a custom command on servers"
+  desc "exec [NAME] [CMD]", "Execute a custom command on servers (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"
   def exec(name, cmd)
@@ -123,7 +123,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "logs [NAME]", "Show log lines from accessory on host"
+  desc "logs [NAME]", "Show log lines from accessory on host (use --help to show options)"
   option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
   option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
   option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
@@ -149,21 +149,26 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "remove [NAME]", "Remove accessory container and image from host (use NAME=all to boot all accessories)"
+  desc "remove [NAME]", "Remove accessory container and image from host (use NAME=all to remove all accessories)"
+  option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
   def remove(name)
     if name == "all"
-      MRSK.accessory_names.each { |accessory_name| remove(accessory_name) }
+      if options[:confirmed] || ask("This will remove all containers and images for all accessories. Are you sure?", limited_to: %w( y N ), default: "N") == "y"
+        MRSK.accessory_names.each { |accessory_name| remove(accessory_name) }
+      end
     else
-      with_accessory(name) do
-        stop(name)
-        remove_container(name)
-        remove_image(name)
-        remove_service_directory(name)
+      if options[:confirmed] || ask("This will remove all containers and images for #{name}. Are you sure?", limited_to: %w( y N ), default: "N") == "y"
+        with_accessory(name) do
+          stop(name)
+          remove_container(name)
+          remove_image(name)
+          remove_service_directory(name)
+        end
       end
     end
   end
 
-  desc "remove_container [NAME]", "Remove accessory container from host"
+  desc "remove_container [NAME]", "Remove accessory container from host", hide: true
   def remove_container(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -173,7 +178,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "remove_image [NAME]", "Remove accessory image from host"
+  desc "remove_image [NAME]", "Remove accessory image from host", hide: true
   def remove_image(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do
@@ -183,7 +188,7 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
     end
   end
 
-  desc "remove_service_directory [NAME]", "Remove accessory directory used for uploaded files and data directories from host"
+  desc "remove_service_directory [NAME]", "Remove accessory directory used for uploaded files and data directories from host", hide: true
   def remove_service_directory(name)
     with_accessory(name) do |accessory|
       on(accessory.host) do

data/lib/mrsk/cli/app.rb

@@ -28,7 +28,7 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
+  desc "start", "Start existing app container on servers"
   def start
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Started app version #{MRSK.version}"), verbosity: :debug
@@ -36,7 +36,7 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "stop", "Stop app on servers"
+  desc "stop", "Stop app container on servers"
   def stop
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Stopped app"), verbosity: :debug
@@ -44,12 +44,13 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "details", "Display details about app containers"
+  # FIXME: Drop in favor of just containers?
+  desc "details", "Show details about app containers"
   def details
     on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.info) }
   end
 
-  desc "exec [CMD]", "Execute a custom command on servers"
+  desc "exec [CMD]", "Execute a custom command on servers (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"
   def exec(cmd)
@@ -91,21 +92,21 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "containers", "List all the app containers currently on servers"
+  desc "containers", "Show app containers on servers"
   def containers
     on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_containers) }
   end
 
-  desc "images", "List all the app images currently on servers"
+  desc "images", "Show app images on servers"
   def images
     on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_images) }
   end
 
-  desc "logs", "Show lines from app on servers"
-  option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
-  option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
+  desc "logs", "Show log lines from app on servers (use --help to show options)"
+  option :since, aliases: "-s", desc: "Show lines since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
+  option :lines, type: :numeric, aliases: "-n", desc: "Number of lines to show from each server"
   option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
-  option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
+  option :follow, aliases: "-f", desc: "Follow log on primary server (or specific host set by --hosts)"
   def logs
     # FIXME: Catch when app containers aren't running
 
@@ -133,11 +134,12 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
 
   desc "remove", "Remove app containers and images from servers"
   def remove
+    stop
     remove_containers
     remove_images
   end
 
-  desc "remove_container [VERSION]", "Remove app container with given version from servers"
+  desc "remove_container [VERSION]", "Remove app container with given version from servers", hide: true
   def remove_container(version)
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Removed app container with version #{version}"), verbosity: :debug
@@ -145,7 +147,7 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "remove_containers", "Remove all app containers from servers"
+  desc "remove_containers", "Remove all app containers from servers", hide: true
   def remove_containers
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Removed all app containers"), verbosity: :debug
@@ -153,7 +155,7 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "remove_images", "Remove all app images from servers"
+  desc "remove_images", "Remove all app images from servers", hide: true
   def remove_images
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Removed all app images"), verbosity: :debug
@@ -161,8 +163,8 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     end
   end
 
-  desc "current_version", "Shows the version currently running"
-  def current_version
+  desc "version", "Show app version currently running on servers"
+  def version
     on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.current_running_version).strip }
   end
 
@@ -184,7 +186,12 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
     def most_recent_version_available(host: MRSK.primary_host)
       version = nil
       on(host) { version = capture_with_info(*MRSK.app.most_recent_version_from_available_images).strip }
-      version.presence
+      
+      if version == "<none>"
+        raise "Most recent image available was not tagged with a version (returned <none>)"
+      else
+        version.presence
+      end
     end
 
     def current_running_version(host: MRSK.primary_host)

data/lib/mrsk/cli/base.rb

@@ -17,8 +17,8 @@ module Mrsk::Cli
     class_option :hosts, aliases: "-h", desc: "Run commands on these hosts instead of all (separate by comma)"
     class_option :roles, aliases: "-r", desc: "Run commands on these roles instead of all (separate by comma)"
 
-    class_option :config_file, aliases: "-c", default: "config/deploy.yml", desc: "Path to config file (default: config/deploy.yml)"
-    class_option :destination, aliases: "-d", desc: "Specify destination to be used for config file (west -> deploy.west.yml)"
+    class_option :config_file, aliases: "-c", default: "config/deploy.yml", desc: "Path to config file"
+    class_option :destination, aliases: "-d", desc: "Specify destination to be used for config file (staging -> deploy.staging.yml)"
 
     def initialize(*)
       super

data/lib/mrsk/cli/build.rb

@@ -1,11 +1,11 @@
 class Mrsk::Cli::Build < Mrsk::Cli::Base
-  desc "deliver", "Deliver a newly built app image to servers"
+  desc "deliver", "Build app and push app image to registry then pull image on servers"
   def deliver
-    invoke :push
-    invoke :pull
+    push
+    pull
   end
 
-  desc "push", "Build locally and push app image to registry"
+  desc "push", "Build and push app image to registry"
   def push
     cli = self
 
@@ -26,15 +26,16 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
     end
   end
 
-  desc "pull", "Pull app image from the registry onto servers"
+  desc "pull", "Pull app image from registry onto servers"
   def pull
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Pulled image with version #{MRSK.version}"), verbosity: :debug
+      execute *MRSK.builder.clean, raise_on_non_zero_exit: false
       execute *MRSK.builder.pull
     end
   end
 
-  desc "create", "Create a local build setup"
+  desc "create", "Create a build setup"
   def create
     run_locally do
       begin
@@ -51,7 +52,7 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
     end
   end
 
-  desc "remove", "Remove local build setup"
+  desc "remove", "Remove build setup"
   def remove
     run_locally do
       debug "Using builder: #{MRSK.builder.name}"
@@ -59,7 +60,7 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
     end
   end
 
-  desc "details", "Show the name of the configured builder"
+  desc "details", "Show build setup"
   def details
     run_locally do
       puts "Builder: #{MRSK.builder.name}"

data/lib/mrsk/cli/healthcheck.rb

@@ -1,21 +1,40 @@
 class Mrsk::Cli::Healthcheck < Mrsk::Cli::Base
-  desc "perform", "Health check the current version of the app"
+  MAX_ATTEMPTS = 5
+
+  default_command :perform
+
+  desc "perform", "Health check current app version"
   def perform
     on(MRSK.primary_host) do
       begin
         execute *MRSK.healthcheck.run
 
         target = "Health check against #{MRSK.config.healthcheck["path"]}"
+        attempt = 1
 
-        if capture_with_info(*MRSK.healthcheck.curl) == "200"
-          info "#{target} succeeded with 200 OK!"
-        else
-          # Catches 1xx, 2xx, 3xx
-          raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
+        begin
+          status = capture_with_info(*MRSK.healthcheck.curl)
+
+          if status == "200"
+            info "#{target} succeeded with 200 OK!"
+          else
+            raise "#{target} failed with status #{status}"
+          end
+        rescue SSHKit::Command::Failed
+          if attempt <= MAX_ATTEMPTS
+            info "#{target} failed to respond, retrying in #{attempt}s..."
+            sleep attempt
+            attempt += 1
+
+            retry
+          else
+            raise
+          end
         end
       rescue SSHKit::Command::Failed => e
+        error capture_with_info(*MRSK.healthcheck.logs)
+
         if e.message =~ /curl/
-          # Catches 4xx, 5xx
           raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
         else
           raise

data/lib/mrsk/cli/main.rb

@@ -1,5 +1,5 @@
 class Mrsk::Cli::Main < Mrsk::Cli::Base
-  desc "setup", "Setup all accessories and deploy the app to servers"
+  desc "setup", "Setup all accessories and deploy app to servers"
   def setup
     print_runtime do
       invoke "mrsk:cli:server:bootstrap"
@@ -8,7 +8,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     end
   end
 
-  desc "deploy", "Deploy the app to servers"
+  desc "deploy", "Deploy app to servers"
   def deploy
     runtime = print_runtime do
       say "Ensure Docker is installed...", :magenta
@@ -35,7 +35,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     audit_broadcast "Deployed app in #{runtime.to_i} seconds"
   end
 
-  desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
+  desc "redeploy", "Deploy app to servers without bootstrapping servers, starting Traefik, pruning, and registry login"
   def redeploy
     runtime = print_runtime do
       say "Build and push app image...", :magenta
@@ -50,7 +50,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     audit_broadcast "Redeployed app in #{runtime.to_i} seconds"
   end
 
-  desc "rollback [VERSION]", "Rollback the app to VERSION"
+  desc "rollback [VERSION]", "Rollback app to VERSION"
   def rollback(version)
     MRSK.version = version
 
@@ -68,7 +68,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     end
   end
 
-  desc "details", "Display details about Traefik and app containers"
+  desc "details", "Show details about all containers"
   def details
     invoke "mrsk:cli:traefik:details"
     invoke "mrsk:cli:app:details"
@@ -82,7 +82,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     end
   end
 
-  desc "config", "Show combined config"
+  desc "config", "Show combined config (including secrets!)"
   def config
     run_locally do
       puts MRSK.config.to_h.to_yaml
@@ -132,40 +132,44 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     File.write(env_path, ERB.new(File.read(env_template_path)).result, perm: 0600)
   end
 
-  desc "remove", "Remove Traefik, app, and registry session from servers"
+  desc "remove", "Remove Traefik, app, accessories, and registry session from servers"
+  option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
   def remove
-    invoke "mrsk:cli:traefik:remove"
-    invoke "mrsk:cli:app:remove"
-    invoke "mrsk:cli:registry:logout"
+    if options[:confirmed] || ask(remove_confirmation_question, limited_to: %w( y N ), default: "N") == "y"
+      invoke "mrsk:cli:traefik:remove", [], options.without(:confirmed)
+      invoke "mrsk:cli:app:remove", [], options.without(:confirmed)
+      invoke "mrsk:cli:accessory:remove", [ "all" ]
+      invoke "mrsk:cli:registry:logout", [], options.without(:confirmed)
+    end
   end
 
-  desc "version", "Display the MRSK version"
+  desc "version", "Show MRSK version"
   def version
     puts Mrsk::VERSION
   end
 
-  desc "accessory", "Manage the accessories"
+  desc "accessory", "Manage accessories (db/redis/search)"
   subcommand "accessory", Mrsk::Cli::Accessory
 
-  desc "app", "Manage the application"
+  desc "app", "Manage application"
   subcommand "app", Mrsk::Cli::App
 
-  desc "build", "Build the application image"
+  desc "build", "Build application image"
   subcommand "build", Mrsk::Cli::Build
 
-  desc "healthcheck", "Healthcheck the application"
+  desc "healthcheck", "Healthcheck application"
   subcommand "healthcheck", Mrsk::Cli::Healthcheck
 
   desc "prune", "Prune old application images and containers"
   subcommand "prune", Mrsk::Cli::Prune
 
-  desc "registry", "Login and out of the image registry"
+  desc "registry", "Login and -out of the image registry"
   subcommand "registry", Mrsk::Cli::Registry
 
   desc "server", "Bootstrap servers with Docker"
   subcommand "server", Mrsk::Cli::Server
 
-  desc "traefik", "Manage the Traefik load balancer"
+  desc "traefik", "Manage Traefik load balancer"
   subcommand "traefik", Mrsk::Cli::Traefik
 
   private
@@ -174,4 +178,10 @@ 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 remove_confirmation_question      
+      "This will remove all containers and images. " +
+      (MRSK.config.accessories.any? ? "Including #{MRSK.config.accessories.collect(&:name).to_sentence}. " : "") +
+      "Are you sure?"
+    end
 end

data/lib/mrsk/cli/prune.rb

@@ -1,8 +1,8 @@
 class Mrsk::Cli::Prune < Mrsk::Cli::Base
   desc "all", "Prune unused images and stopped containers"
   def all
-    invoke :containers
-    invoke :images
+    containers
+    images
   end
 
   desc "images", "Prune unused images older than 7 days"
@@ -13,7 +13,7 @@ class Mrsk::Cli::Prune < Mrsk::Cli::Base
     end
   end
 
-  desc "containers", "Prune stopped containers for the service older than 3 days"
+  desc "containers", "Prune stopped containers older than 3 days"
   def containers
     on(MRSK.hosts) do
       execute *MRSK.auditor.record("Pruned containers"), verbosity: :debug

data/lib/mrsk/cli/registry.rb

@@ -1,15 +1,17 @@
 class Mrsk::Cli::Registry < Mrsk::Cli::Base
-  desc "login", "Login to the registry locally and remotely"
+  desc "login", "Log in to registry locally and remotely"
   def login
     run_locally    { execute *MRSK.registry.login }
     on(MRSK.hosts) { execute *MRSK.registry.login }
+  # FIXME: This rescue needed?
   rescue ArgumentError => e
     puts e.message
   end
 
-  desc "logout", "Logout of the registry remotely"
+  desc "logout", "Log out of registry remotely"
   def logout
     on(MRSK.hosts) { execute *MRSK.registry.logout }
+  # FIXME: This rescue needed?
   rescue ArgumentError => e
     puts e.message
   end

data/lib/mrsk/cli/server.rb

@@ -1,5 +1,5 @@
 class Mrsk::Cli::Server < Mrsk::Cli::Base
-  desc "bootstrap", "Ensure Docker is installed on the servers"
+  desc "bootstrap", "Ensure Docker is installed on servers"
   def bootstrap
     on(MRSK.hosts + MRSK.accessory_hosts) { execute "which docker || (apt-get update -y && apt-get install docker.io -y)" }
   end

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

@@ -1,5 +1,4 @@
-# Name of your application. Used to uniquely configuring Traefik and app containers.
-# Your Dockerfile should set LABEL service=the-same-value to ensure image pruning works.
+# Name of your application. Used to uniquely configure containers.
 service: my-app
 
 # Name of the container image.
@@ -14,4 +13,64 @@ registry:
   # Specify the registry server, if you're not using Docker Hub
   # server: registry.digitalocean.com / ghcr.io / ...
   username: my-user
-  password: my-password-should-go-somewhere-safe
+  password:
+    - MRSK_REGISTRY_PASSWORD
+
+# Inject ENV variables into containers (secrets come from .env).
+# env:
+#   clear:
+#     DB_HOST: 192.168.0.2
+#   secret:
+#     - RAILS_MASTER_KEY
+
+# Call a broadcast command on deploys.
+# audit_broadcast_cmd:
+#   bin/broadcast_to_bc
+
+# Use a different ssh user than root
+# 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:
+#     image: mysql:8.0
+#     host: 192.168.0.2
+#     port: 3306
+#     env:
+#       clear:
+#         MYSQL_ROOT_HOST: '%'
+#       secret:
+#         - MYSQL_ROOT_PASSWORD
+#     files:
+#       - config/mysql/production.cnf:/etc/mysql/my.cnf
+#       - db/production.sql.erb:/docker-entrypoint-initdb.d/setup.sql
+#     directories:
+#       - data:/var/lib/mysql
+#   redis:
+#     image: redis:7.0
+#     host: 192.168.0.2
+#     port: 6379
+#     directories:
+#       - data:/data
+
+# Configure custom arguments for Traefik
+# traefik:
+#   args:
+#     accesslog: true
+#     accesslog.format: json
+
+# Configure a custom healthcheck (default is /up on port 3000)
+# healthcheck:
+#   path: /healthz
+#   port: 4000

data/lib/mrsk/cli/traefik.rb

@@ -6,12 +6,12 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
 
   desc "reboot", "Reboot Traefik on servers (stop container, remove container, start new container)"
   def reboot
-    invoke :stop
-    invoke :remove_container
-    invoke :boot
+    stop
+    remove_container
+    boot
   end
 
-  desc "start", "Start existing Traefik on servers"
+  desc "start", "Start existing Traefik container on servers"
   def start
     on(MRSK.traefik_hosts) do
       execute *MRSK.auditor.record("Started traefik"), verbosity: :debug
@@ -19,7 +19,7 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
     end
   end
 
-  desc "stop", "Stop Traefik on servers"
+  desc "stop", "Stop existing Traefik container on servers"
   def stop
     on(MRSK.traefik_hosts) do
       execute *MRSK.auditor.record("Stopped traefik"), verbosity: :debug
@@ -27,13 +27,13 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
     end
   end
 
-  desc "restart", "Restart Traefik on servers"
+  desc "restart", "Restart existing Traefik container on servers"
   def restart
-    invoke :stop
-    invoke :start
+    stop
+    start
   end
 
-  desc "details", "Display details about Traefik containers from servers"
+  desc "details", "Show details about Traefik container from servers"
   def details
     on(MRSK.traefik_hosts) { |host| puts_by_host host, capture_with_info(*MRSK.traefik.info), type: "Traefik" }
   end
@@ -64,12 +64,12 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
 
   desc "remove", "Remove Traefik container and image from servers"
   def remove
-    invoke :stop
-    invoke :remove_container
-    invoke :remove_image
+    stop
+    remove_container
+    remove_image
   end
 
-  desc "remove_container", "Remove Traefik container from servers"
+  desc "remove_container", "Remove Traefik container from servers", hide: true
   def remove_container
     on(MRSK.traefik_hosts) do
       execute *MRSK.auditor.record("Removed traefik container"), verbosity: :debug
@@ -77,7 +77,7 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
     end
   end
 
-  desc "remove_container", "Remove Traefik image from servers"
+  desc "remove_container", "Remove Traefik image from servers", hide: true
   def remove_image
     on(MRSK.traefik_hosts) do
       execute *MRSK.auditor.record("Removed traefik image"), verbosity: :debug

data/lib/mrsk/commander.rb

@@ -49,32 +49,32 @@ class Mrsk::Commander
     @app ||= Mrsk::Commands::App.new(config)
   end
 
-  def builder
-    @builder ||= Mrsk::Commands::Builder.new(config)
+  def accessory(name)
+    Mrsk::Commands::Accessory.new(config, name: name)
   end
 
-  def traefik
-    @traefik ||= Mrsk::Commands::Traefik.new(config)
+  def auditor
+    @auditor ||= Mrsk::Commands::Auditor.new(config)
   end
 
-  def registry
-    @registry ||= Mrsk::Commands::Registry.new(config)
+  def builder
+    @builder ||= Mrsk::Commands::Builder.new(config)
   end
 
-  def prune
-    @prune ||= Mrsk::Commands::Prune.new(config)
+  def healthcheck
+    @healthcheck ||= Mrsk::Commands::Healthcheck.new(config)
   end
 
-  def accessory(name)
-    Mrsk::Commands::Accessory.new(config, name: name)
+  def prune
+    @prune ||= Mrsk::Commands::Prune.new(config)
   end
 
-  def auditor
-    @auditor ||= Mrsk::Commands::Auditor.new(config)
+  def registry
+    @registry ||= Mrsk::Commands::Registry.new(config)
   end
 
-  def healthcheck
-    @healthcheck ||= Mrsk::Commands::Healthcheck.new(config)
+  def traefik
+    @traefik ||= Mrsk::Commands::Traefik.new(config)
   end
 
 

data/lib/mrsk/commands/accessory.rb

@@ -10,10 +10,10 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
   def run
     docker :run,
       "--name", service_name,
-      "-d",
+      "--detach",
       "--restart", "unless-stopped",
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
-      "-p", port,
+      "--publish", port,
       *env_args,
       *volume_args,
       *label_args,
@@ -35,14 +35,14 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
 
   def logs(since: nil, lines: nil, grep: nil)
     pipe \
-      docker(:logs, service_name, (" --since #{since}" if since), (" -n #{lines}" if lines), "-t", "2>&1"),
+      docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
       ("grep '#{grep}'" if grep)
   end
 
   def follow_logs(grep: nil)
     run_over_ssh \
       pipe \
-        docker(:logs, service_name, "-t", "-n", "10", "-f", "2>&1"),
+        docker(:logs, service_name, "--timestamps", "--tail", "10", "--follow", "2>&1"),
         (%(grep "#{grep}") if grep)
   end
 
@@ -96,11 +96,11 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
   end
 
   def remove_container
-    docker :container, :prune, "-f", *service_filter
+    docker :container, :prune, "--force", *service_filter
   end
 
   def remove_image
-    docker :image, :prune, "-a", "-f", *service_filter
+    docker :image, :prune, "--all", "--force", *service_filter
   end
 
   private

data/lib/mrsk/commands/app.rb

@@ -3,7 +3,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
     role = config.role(role)
 
     docker :run,
-      "-d",
+      "--detach",
       "--restart unless-stopped",
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
       "--name", service_with_version,
@@ -30,7 +30,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   def logs(since: nil, lines: nil, grep: nil)
     pipe \
       current_container_id,
-      "xargs docker logs#{" --since #{since}" if since}#{" -n #{lines}" if lines} 2>&1",
+      "xargs docker logs#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
       ("grep '#{grep}'" if grep)
   end
 
@@ -38,7 +38,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
     run_over_ssh \
       pipe(
         current_container_id,
-        "xargs docker logs -t -n 10 -f 2>&1",
+        "xargs docker logs --timestamps --tail 10 --follow 2>&1",
         (%(grep "#{grep}") if grep)
       ),
       host: host
@@ -72,7 +72,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
 
 
   def current_container_id
-    docker :ps, "-q", *service_filter
+    docker :ps, "--quiet", *service_filter
   end
 
   def current_running_version
@@ -97,7 +97,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
 
 
   def list_containers
-    docker :container, :ls, "-a", *service_filter
+    docker :container, :ls, "--all", *service_filter
   end
 
   def list_container_names
@@ -111,7 +111,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   def remove_containers
-    docker :container, :prune, "-f", *service_filter
+    docker :container, :prune, "--force", *service_filter
   end
 
   def list_images
@@ -119,7 +119,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   def remove_images
-    docker :image, :prune, "-a", "-f", *service_filter
+    docker :image, :prune, "--all", "--force", *service_filter
   end
 
 

data/lib/mrsk/commands/base.rb

@@ -18,7 +18,7 @@ module Mrsk::Commands
     end
 
     def container_id_for(container_name:)
-      docker :container, :ls, "-a", "-f", "name=#{container_name}", "-q"
+      docker :container, :ls, "--all", "--filter", "name=#{container_name}", "--quiet"
     end
 
     private

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

@@ -1,6 +1,10 @@
 class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
   delegate :argumentize, to: Mrsk::Utils
 
+  def clean
+    docker :image, :rm, "--force", config.absolute_image
+  end
+
   def pull
     docker :pull, config.absolute_image
   end

data/lib/mrsk/commands/builder.rb

@@ -1,5 +1,5 @@
 class Mrsk::Commands::Builder < Mrsk::Commands::Base
-  delegate :create, :remove, :push, :pull, :info, to: :target
+  delegate :create, :remove, :push, :clean, :pull, :info, to: :target
 
   def name
     target.class.to_s.remove("Mrsk::Commands::Builder::").underscore

data/lib/mrsk/commands/healthcheck.rb

@@ -5,9 +5,9 @@ class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
     web = config.role(:web)
 
     docker :run,
-      "-d",
+      "--detach",
       "--name", container_name_with_version,
-      "-p", "#{EXPOSED_PORT}:#{config.healthcheck["port"]}",
+      "--publish", "#{EXPOSED_PORT}:#{config.healthcheck["port"]}",
       "--label", "service=#{container_name}",
       *web.env_args,
       *config.volume_args,
@@ -16,19 +16,19 @@ class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
   end
 
   def curl
-    [ :curl, "--silent", "--output", "/dev/null", "--write-out", "'%{http_code}'", health_url ]
+    [ :curl, "--silent", "--output", "/dev/null", "--write-out", "'%{http_code}'", "--max-time", "2", health_url ]
+  end
+
+  def logs
+    pipe container_id, xargs(docker(:logs, "--tail", 50, "2>&1"))
   end
 
   def stop
-    pipe \
-      container_id_for(container_name: container_name),
-      xargs(docker(:stop))
+    pipe container_id, xargs(docker(:stop))
   end
 
   def remove
-    pipe \
-      container_id_for(container_name: container_name),
-      xargs(docker(:container, :rm))
+    pipe container_id, xargs(docker(:container, :rm))
   end
 
   private
@@ -40,6 +40,10 @@ class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
       "healthcheck-#{config.service_with_version}"
     end
 
+    def container_id
+      container_id_for(container_name: container_name)
+    end
+
     def health_url
       "http://localhost:#{EXPOSED_PORT}#{config.healthcheck["path"]}"
     end

data/lib/mrsk/commands/registry.rb

@@ -2,10 +2,19 @@ class Mrsk::Commands::Registry < Mrsk::Commands::Base
   delegate :registry, to: :config
 
   def login
-    docker :login, registry["server"], "-u", redact(registry["username"]), "-p", redact(registry["password"])
+    docker :login, registry["server"], "-u", redact(registry["username"]), "-p", redact(lookup_password)
   end
 
   def logout
     docker :logout, registry["server"]
   end
+
+  private
+    def lookup_password
+      if registry["password"].is_a?(Array)
+        ENV.fetch(registry["password"].first).dup
+      else
+        registry["password"]
+      end
+    end
 end

data/lib/mrsk/commands/traefik.rb

@@ -1,11 +1,11 @@
 class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   def run
     docker :run, "--name traefik",
-      "-d",
+      "--detach",
       "--restart", "unless-stopped",
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
-      "-p 80:80",
-      "-v /var/run/docker.sock:/var/run/docker.sock",
+      "--publish", "80:80",
+      "--volume", "/var/run/docker.sock:/var/run/docker.sock",
       "traefik",
       "--providers.docker",
       "--log.level=DEBUG",
@@ -26,23 +26,23 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
 
   def logs(since: nil, lines: nil, grep: nil)
     pipe \
-      docker(:logs, "traefik", (" --since #{since}" if since), (" -n #{lines}" if lines), "-t", "2>&1"),
+      docker(:logs, "traefik", (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
       ("grep '#{grep}'" if grep)
   end
 
   def follow_logs(host:, grep: nil)
     run_over_ssh pipe(
-      docker(:logs, "traefik", "-t", "-n", "10", "-f", "2>&1"),
+      docker(:logs, "traefik", "--timestamps", "--tail", "10", "--follow", "2>&1"),
       (%(grep "#{grep}") if grep)
     ).join(" "), host: host
   end
 
   def remove_container
-    docker :container, :prune, "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
+    docker :container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
   end
 
   def remove_image
-    docker :image, :prune, "-a", "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
+    docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
   end
 
   private

data/lib/mrsk/configuration/role.rb

@@ -58,7 +58,7 @@ class Mrsk::Configuration::Role
     def traefik_labels
       if running_traefik?
         {
-          "traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
+          "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" => "3",

data/lib/mrsk/utils.rb

@@ -1,13 +1,14 @@
 module Mrsk::Utils
   extend self
 
-  # Return a list of shell arguments using the same named argument against the passed attributes (hash or array).
+  # Return a list of escaped shell arguments using the same named argument against the passed attributes (hash or array).
   def argumentize(argument, attributes, redacted: false)
-    Array(attributes).flat_map do |k, v|
-      if v.present?
-        [ argument, redacted ? redact("#{k}=#{v}") : "#{k}=#{v}" ]
+    Array(attributes).flat_map do |key, value|
+      if value.present?
+        escaped_pair = [ key, value.to_s.dump.gsub(/`/, '\\\\`') ].join("=")
+        [ argument, redacted ? redact(escaped_pair) : escaped_pair ]
       else
-        [ argument, k ]
+        [ argument, key ]
       end
     end
   end

data/lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.7.2"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport