Bump version for 0.1.0

Switch to proper standalone executable with Thor

Gemfile

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in importmap-rails.gemspec.
 gemspec
 
-group :test do
+gem "debug"
-  gem "byebug"
+gem "railties"
-end

Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    mrsk (0.0.1)
+    mrsk (0.1.0)
-      railties (>= 7.0.0)
+      activesupport (>= 7.0)
       sshkit (~> 1.21)
+      thor (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -27,12 +28,17 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     builder (3.2.4)
-    byebug (11.1.3)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
     erubi (1.12.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
     loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -41,7 +47,11 @@ GEM
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
     net-ssh (7.0.1)
-    nokogiri (1.13.10-arm64-darwin)
+    nokogiri (1.14.0-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.0-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.0-x86_64-linux)
       racc (~> 1.4)
     racc (1.6.2)
     rack (2.2.5)
@@ -60,6 +70,8 @@ GEM
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rake (13.0.6)
+    reline (0.3.2)
+      io-console (~> 0.5)
     sshkit (1.21.3)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
@@ -77,8 +89,9 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  byebug
+  debug
   mrsk!
+  railties
 
 BUNDLED WITH
-   2.2.33
+   2.4.3

README.md

@@ -1,55 +1,256 @@
 # MRSK
 
-MRSK lets you do zero-downtime deploys of Rails apps packed as containers to any host running Docker. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is wound down. It works across multiple hosts at the same time, using SSHKit to execute commands.
+MRSK deploys Rails apps in containers to servers running Docker with zero downtime. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is stopped. It works seamlessly across multiple hosts, using SSHKit to execute commands.
 
 ## Installation
 
-Create a configuration file for MRSK in `config/deploy.yml` that looks like this:
+Install MRSK globally with `gem install mrsk`. Then, inside your app directory, run `mrsk install`. Now edit the new file `config/deploy.yml`. It could look as simple as this:
 
 ```yaml
-service: my-app
+service: hey
-image: name/my-app
+image: 37s/hey
 servers:
-  - xxx.xxx.xxx.xxx
+  - 192.168.0.1
-  - xxx.xxx.xxx.xxx
+  - 192.168.0.2
-env:
+registry:
-  DATABASE_URL: mysql2://username@localhost/database_name/
+  username: registry-user-name
-  REDIS_URL: redis://host:6379/1
+  password: <%= ENV["MRSK_REGISTRY_PASSWORD"] %>
 ```
 
-Then first login to the Docker Hub registry on the servers:
+Now you're ready to deploy a multi-arch image to the servers:
 
 ```
-rake mrsk:registry:login DOCKER_USER=name DOCKER_PASSWORD=pw
+mrsk deploy
-```
-
-Now you're ready to deploy a multi-arch image (FIXME: currently you need to manually run `docker buildx create --use` once first):
-
-```
-rake mrsk:deploy
 ```
 
 This will:
 
-1. Build the image using the standard Dockerfile in the root of the application.
+1. Install Docker on any server that might be missing it (using apt-get)
-2. Push the image to the registry.
+2. Log into the registry both locally and remotely
-3. Pull the image on all the servers.
+3. Build the image using the standard Dockerfile in the root of the application.
-4. Ensure Traefik is running and accepting traffic on port 80.
+4. Push the image to the registry.
-5. Stop any containers running a previous versions of the app.
+5. Pull the image from the registry on the servers.
-6. Start a new container with the version of the app that matches the current git version hash.
+6. Ensure Traefik is running and accepting traffic on port 80.
+7. Stop any containers running a previous versions of the app.
+8. Start a new container with the version of the app that matches the current git version hash.
+9. Prune unused images and stopped containers to ensure servers don't fill up.
 
-Voila! All the servers are now serving the app on port 80, and you're ready to put them behind a load balancer to serve live traffic.
+Voila! All the servers are now serving the app on port 80. If you're just running a single server, you're ready to go. If you're running multiple servers, you need to put a load balancer in front of them.
+
+## Configuration
+
+### Using another registry than Docker Hub
+
+The default registry for Docker is Docker Hub. If you'd like to use a different one, just configure the server, like so:
+
+```yaml
+registry:
+  server: registry.digitalocean.com
+  username: registry-user-name
+  password: <%= ENV["MRSK_REGISTRY_PASSWORD"] %>
+```
+
+### Using a different SSH user than root
+
+The default SSH user is root, but you can change it using `ssh_user`:
+
+```yaml
+ssh_user: app
+```
+
+### Adding custom env variables
+
+You can inject custom env variables into the app containers using `env`:
+
+```yaml
+env:
+  DATABASE_URL: mysql2://db1/hey_production/
+  REDIS_URL: redis://redis1:6379/1
+```
+
+### Splitting servers into different roles
+
+If your application uses separate hosts for running jobs or other roles beyond the default web running, you can specify these hosts and their custom entrypoint command like so:
+
+```yaml
+servers:
+  web:
+    - 192.168.0.1
+    - 192.168.0.2
+  job:
+    hosts:
+      - 192.168.0.3
+      - 192.168.0.4
+    cmd: bin/jobs
+```
+
+Traefik will only be installed and run on the servers in the `web` role (and on all servers if no roles are defined).
+
+### Adding custom container labels
+
+You can specialize the default Traefik rules by setting custom labels on the containers that are being started:
+
+```
+labels:
+  traefik.http.routers.hey.rule: '''Host(`app.hey.com`)'''
+```
+
+(Note: The extra quotes are needed to ensure the rule is passed in correctly!)
+
+This allows you to run multiple applications on the same server sharing the same Traefik instance and port.
+See https://doc.traefik.io/traefik/routing/routers/#rule for a full list of available routing rules.
+
+The labels can even be applied on a per-role basis:
+
+```yaml
+servers:
+  web:
+    - 192.168.0.1
+    - 192.168.0.2
+  job:
+    hosts:
+      - 192.168.0.3
+      - 192.168.0.4
+    cmd: bin/jobs
+    labels:
+      my-custom-label: "50"
+```
+
+### Configuring remote builder for native multi-arch
+
+If you're developing on ARM64 (like Apple Silicon), but you want to deploy on AMD64 (x86 64-bit), you have to use multi-archecture images. By default, MRSK will setup a local buildx configuration that allows for this through QEMU emulation. This can be slow, especially on the first build.
+
+If you want to speed up this process by using a remote AMD64 host to natively build the AMD64 part of the image, while natively building the ARM64 part locally, you can do so using builder options like follows:
+
+```yaml
+builder:
+  local:
+    arch: arm64
+    host: unix:///Users/dhh/.docker/run/docker.sock
+  remote:
+    arch: amd64
+    host: ssh://root@192.168.0.1
+```
+
+Note: You must have Docker running on the remote host being used as a builder.
+
+With that configuration in place, you can setup the local/remote configuration using `mrsk build create`. If you wish to remove the contexts and buildx instances again, you can run `mrsk build remove`. If you had already built using the standard emulation setup, run `mrsk build remove` before doing `mrsk build remote`.
+
+### Configuring native builder when multi-arch isn't needed
+
+If you're developing on the same architecture as the one you're deploying on, you can speed up the build a lot by forgoing a multi-arch image. This can be done by configuring the builder like so:
+
+```yaml
+builder:
+  multiarch: false
+```
+
+## Commands
+
+### Remote execution
+
+If you need to execute commands inside the Rails containers, you can use `mrsk app exec`, `mrsk app exec --once`, `mrsk app runner`, and `mrsk app runner --once`. Examples:
+
+```bash
+# Runs command on all servers
+mrsk app exec 'ruby -v'
+App Host: xxx.xxx.xxx.xxx
+ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
+
+App Host: xxx.xxx.xxx.xxx
+ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
+
+# Runs command on first server
+mrsk app exec --once 'cat .ruby-version'
+3.1.3
+
+# Runs Rails command on all servers
+mrsk app exec 'bin/rails about'
+App Host: xxx.xxx.xxx.xxx
+About your application's environment
+Rails version             7.1.0.alpha
+Ruby version              ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
+RubyGems version          3.3.26
+Rack version              2.2.5
+Middleware                ActionDispatch::HostAuthorization, Rack::Sendfile, ActionDispatch::Static, ActionDispatch::Executor, Rack::Runtime, Rack::MethodOverride, ActionDispatch::RequestId, ActionDispatch::RemoteIp, Rails::Rack::Logger, ActionDispatch::ShowExceptions, ActionDispatch::DebugExceptions, ActionDispatch::Callbacks, ActionDispatch::Cookies, ActionDispatch::Session::CookieStore, ActionDispatch::Flash, ActionDispatch::ContentSecurityPolicy::Middleware, ActionDispatch::PermissionsPolicy::Middleware, Rack::Head, Rack::ConditionalGet, Rack::ETag, Rack::TempfileReaper
+Application root          /rails
+Environment               production
+Database adapter          sqlite3
+Database schema version   20221231233303
+
+App Host: xxx.xxx.xxx.xxx
+About your application's environment
+Rails version             7.1.0.alpha
+Ruby version              ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
+RubyGems version          3.3.26
+Rack version              2.2.5
+Middleware                ActionDispatch::HostAuthorization, Rack::Sendfile, ActionDispatch::Static, ActionDispatch::Executor, Rack::Runtime, Rack::MethodOverride, ActionDispatch::RequestId, ActionDispatch::RemoteIp, Rails::Rack::Logger, ActionDispatch::ShowExceptions, ActionDispatch::DebugExceptions, ActionDispatch::Callbacks, ActionDispatch::Cookies, ActionDispatch::Session::CookieStore, ActionDispatch::Flash, ActionDispatch::ContentSecurityPolicy::Middleware, ActionDispatch::PermissionsPolicy::Middleware, Rack::Head, Rack::ConditionalGet, Rack::ETag, Rack::TempfileReaper
+Application root          /rails
+Environment               production
+Database adapter          sqlite3
+Database schema version   20221231233303
+
+# Runs Rails runner on first server
+mrsk app runner 'puts Rails.application.config.time_zone'
+UTC
+```
+
+### Running a Rails console on the primary host
+
+If you need to interact with the production console for the app, you can use `mrsk app console`, which will start a Rails console session on the primary host. You can start the console on a different host using `mrsk app console --host 192.168.0.2`. Be mindful that this is a live wire! Any changes made to the production database will take effect immeditately.
+
+### Inspecting
+
+You can see the state of your servers by running `mrsk details`. It'll show something like this:
+
+```
+Traefik Host: xxx.xxx.xxx.xxx
+CONTAINER ID   IMAGE     COMMAND                  CREATED          STATUS          PORTS                               NAMES
+6195b2a28c81   traefik   "/entrypoint.sh --pr…"   30 minutes ago   Up 19 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp   traefik
+
+Traefik Host: 164.92.105.119
+CONTAINER ID   IMAGE     COMMAND                  CREATED          STATUS          PORTS                               NAMES
+de14a335d152   traefik   "/entrypoint.sh --pr…"   30 minutes ago   Up 19 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp   traefik
+
+App Host: 164.90.145.60
+CONTAINER ID   IMAGE                                                                         COMMAND                  CREATED          STATUS          PORTS      NAMES
+badb1aa51db3   registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123   "/rails/bin/docker-e…"   13 minutes ago   Up 13 minutes   3000/tcp   chat-6ef8a6a84c525b123c5245345a8483f86d05a123
+
+App Host: 164.92.105.119
+CONTAINER ID   IMAGE                                                                         COMMAND                  CREATED          STATUS          PORTS      NAMES
+1d3c91ed1f55   registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123   "/rails/bin/docker-e…"   13 minutes ago   Up 13 minutes   3000/tcp   chat-6ef8a6a84c525b123c5245345a8483f86d05a123
+```
+
+You can also see just info for app containers with `mrsk app details` or just for Traefik with `mrsk traefik details`.
+
+### Rollback
+
+If you've discovered a bad deploy, you can quickly rollback by reactivating the old, paused container image. You can see what old containers are available for rollback by running `mrsk app containers`. It'll give you a presentation similar to `mrsk app details`, but include all the old containers as well. Showing something like this:
+
+```
+App Host: 164.92.105.119
+CONTAINER ID   IMAGE                                                                         COMMAND                  CREATED          STATUS                      PORTS      NAMES
+1d3c91ed1f51   registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123   "/rails/bin/docker-e…"   19 minutes ago   Up 19 minutes               3000/tcp   chat-6ef8a6a84c525b123c5245345a8483f86d05a123
+539f26b28369   registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4   "/rails/bin/docker-e…"   31 minutes ago   Exited (1) 27 minutes ago              chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
+
+App Host: 164.90.145.60
+CONTAINER ID   IMAGE                                                                         COMMAND                  CREATED          STATUS                      PORTS      NAMES
+badb1aa51db4   registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123   "/rails/bin/docker-e…"   19 minutes ago   Up 19 minutes               3000/tcp   chat-6ef8a6a84c525b123c5245345a8483f86d05a123
+6f170d1172ae   registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4   "/rails/bin/docker-e…"   31 minutes ago   Exited (1) 27 minutes ago              chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
+```
+
+From the example above, we can see that `e5d9d7c2b898289dfbc5f7f1334140d984eedae4` was the last version, so it's available as a rollback target. We can perform this rollback by running `mrsk rollback e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. That'll stop `6ef8a6a84c525b123c5245345a8483f86d05a123` and then start `e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. Because the old container is still available, this is very quick. Nothing to download from the registry.
+
+Note that by default old containers are pruned after 3 days when you run `mrsk deploy`.
+
+### Removing
+
+If you wish to remove the entire application, including Traefik, containers, images, and registry session, you can run `mrsk remove`. This will leave the servers clean.
 
 ## Stage of development
 
-This is alpha software. Lots of stuff is missing. Here are some of the areas we seek to improve:
+This is alpha software. Lots of stuff is missing. Lots of stuff will keep moving around for a while.
-
-- Use of other registries than Docker Hub
-- Adapterize commands to work with Podman and other container runners
-- Better flow for secrets and ENV
-- Possibly switching to a bin/mrsk command rather than raw rake
-- Integrate wirmth cloud CI pipelines
 
 ## License
 
-Mrsk is released under the [MIT License](https://opensource.org/licenses/MIT).
+MRSK is released under the [MIT License](https://opensource.org/licenses/MIT).

bin/mrsk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "mrsk/cli"
+
+Mrsk::Cli::Main.start(ARGV)

lib/mrsk.rb

@@ -2,7 +2,4 @@ module Mrsk
 end
 
 require "mrsk/version"
-require "mrsk/engine"
+require "mrsk/commander"
-
-require "mrsk/configuration"
-require "mrsk/commands"

lib/mrsk/cli.rb

@@ -0,0 +1,9 @@
+require "mrsk"
+
+MRSK = Mrsk::Commander.new \
+  config_file: Pathname.new(File.expand_path("config/deploy.yml"))
+
+module Mrsk::Cli
+end
+
+require "mrsk/cli/main"

lib/mrsk/cli/app.rb

@@ -0,0 +1,97 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::App < Mrsk::Cli::Base
+  desc "boot", "Boot app on servers (or start them if they've already been booted)"
+  def boot
+    MRSK.config.roles.each do |role|
+      on(role.hosts) do |host|
+        begin
+          execute *MRSK.app.run(role: role.name)
+        rescue SSHKit::Command::Failed => e
+          if e.message =~ /already in use/
+            error "Container with same version already deployed on #{host}, starting that instead"
+            execute *MRSK.app.start, host: host
+          else
+            raise
+          end
+        end
+      end
+    end
+  end
+  
+  desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
+  option :version, desc: "Defaults to the most recent git-hash in local repository"
+  def start
+    if (version = options[:version]).present?
+      on(MRSK.config.hosts) { execute *MRSK.app.start(version: version) }
+    else
+      on(MRSK.config.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
+    end
+  end
+  
+  desc "stop", "Stop app on servers"
+  def stop
+    on(MRSK.config.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
+  end
+  
+  desc "details", "Display details about app containers"
+  def details
+    on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.info, verbosity: Logger::INFO) + "\n\n" }
+  end
+  
+  desc "exec [CMD]", "Execute a custom task on servers passed in as CMD='bin/rake some:task'"
+  option :once, type: :boolean, default: false
+  def exec(cmd)
+    if options[:once]
+      on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec(cmd), verbosity: Logger::INFO) }
+    else
+      on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec(cmd), verbosity: Logger::INFO) + "\n\n" }
+    end
+  end
+  
+  desc "console", "Start Rails Console on primary host"
+  option :host, desc: "Start console on a different host"
+  def console
+    host = options[:host] || MRSK.config.primary_host
+
+    run_locally do
+      puts "Launching Rails console on #{host}..."
+      exec MRSK.app.console(host: host)        
+    end
+  end
+
+  desc "runner [EXPRESSION]", "Execute Rails runner with given expression"
+  option :once, type: :boolean, default: false, desc: 
+  def runner(expression)
+    if options[:once]
+      on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec("bin/rails", "runner", "'#{expression}'"), verbosity: Logger::INFO) }
+    else
+      on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec("bin/rails", "runner", "'#{expression}'"), verbosity: Logger::INFO) + "\n\n" }
+    end
+  end
+
+  desc "containers", "List all the app containers currently on servers"
+  def containers
+    on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.list_containers, verbosity: Logger::INFO) + "\n\n" }
+  end
+  
+  desc "logs", "Show last 100 log lines from app on servers"
+  def logs
+    # FIXME: Catch when app containers aren't running
+    on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.logs) + "\n\n" }
+  end
+  
+  desc "remove", "Remove app containers and images from servers"
+  option :only, default: "", desc: "Use 'containers' or 'images'"
+  def remove
+    case options[:only]
+    when "containers"
+      on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
+    when "images"
+      on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
+    else
+      on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
+      on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
+    end
+  end
+end

lib/mrsk/cli/base.rb

@@ -0,0 +1,27 @@
+require "thor"
+require "sshkit"
+require "sshkit/dsl"
+
+module Mrsk::Cli
+  class Base < Thor
+    include SSHKit::DSL
+
+    def self.exit_on_failure?() true end
+
+    class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
+
+    def initialize(*)
+      super
+      MRSK.verbose = options[:verbose]
+    end
+
+    private
+      def print_runtime
+        started_at = Time.now
+        yield
+      ensure
+        runtime = Time.now - started_at
+        puts "  Finished all in #{sprintf("%.1f seconds", runtime)}"
+      end
+  end
+end

lib/mrsk/cli/build.rb

@@ -0,0 +1,53 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::Build < Mrsk::Cli::Base
+  desc "deliver", "Deliver a newly built app image to servers"
+  def deliver
+    invoke :push
+    invoke :pull
+  end
+
+  desc "push", "Build locally and push app image to registry"
+  def push
+    run_locally do 
+      begin
+        debug "Using builder: #{MRSK.builder.name}"
+        info "Building image may take a while (run with --verbose for progress logging)"
+        execute *MRSK.builder.push
+      rescue SSHKit::Command::Failed => e
+        error "Missing compatible builder, so creating a new one first"
+        execute *MRSK.builder.create
+        execute *MRSK.builder.push
+      end
+    end
+  end
+
+  desc "pull", "Pull app image from the registry onto servers"
+  def pull
+    on(MRSK.config.hosts) { execute *MRSK.builder.pull }
+  end
+
+  desc "create", "Create a local build setup"
+  def create
+    run_locally do
+      debug "Using builder: #{MRSK.builder.name}"
+      execute *MRSK.builder.create
+    end
+  end
+
+  desc "remove", "Remove local build setup"
+  def remove
+    run_locally do
+      debug "Using builder: #{MRSK.builder.name}"
+      execute *MRSK.builder.remove
+    end
+  end
+
+  desc "details", "Show the name of the configured builder"
+  def details
+    run_locally do
+      puts "Builder: #{MRSK.builder.name} (#{MRSK.builder.target.class.name})"
+      puts capture(*MRSK.builder.info)
+    end
+  end
+end

lib/mrsk/cli/main.rb

@@ -0,0 +1,99 @@
+require "mrsk/cli/base"
+
+require "mrsk/cli/app"
+require "mrsk/cli/build"
+require "mrsk/cli/prune"
+require "mrsk/cli/registry"
+require "mrsk/cli/server"
+require "mrsk/cli/traefik"
+
+class Mrsk::Cli::Main < Mrsk::Cli::Base
+  desc "deploy", "Deploy the app to servers"
+  def deploy
+    print_runtime do
+      invoke "mrsk:cli:server:bootstrap"
+      invoke "mrsk:cli:registry:login"
+      invoke "mrsk:cli:build:deliver"
+      invoke "mrsk:cli:traefik:boot"
+      invoke "mrsk:cli:app:stop"
+      invoke "mrsk:cli:app:boot"
+      invoke "mrsk:cli:prune:all"
+    end
+  end
+
+  desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
+  def redeploy
+    print_runtime do
+      invoke "mrsk:cli:build:deliver"
+      invoke "mrsk:cli:app:stop"
+      invoke "mrsk:cli:app:boot"
+    end
+  end
+
+  desc "rollback [VERSION]", "Rollback the app to VERSION (that must already be on servers)"
+  def rollback(version)
+    on(MRSK.config.hosts) do
+      execute *MRSK.app.stop, raise_on_non_zero_exit: false
+      execute *MRSK.app.start(version: version)
+    end
+  end
+
+  desc "details", "Display details about Traefik and app containers"
+  def details
+    invoke "mrsk:cli:traefik:details"
+    invoke "mrsk:cli:app:details"
+  end
+
+  desc "install", "Create config stub in config/deploy.yml and binstub in bin/mrsk"
+  option :skip_binstub, type: :boolean, default: false, desc: "Skip adding MRSK to the Gemfile and creating bin/mrsk binstub"
+  def install
+    require "fileutils"
+
+    if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
+      puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
+    else
+      FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
+      puts "Created configuration file in config/deploy.yml"
+    end
+
+    unless options[:skip_binstub]
+      if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
+        puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
+      else
+        `bundle add mrsk`
+        `bundle binstubs mrsk`
+        puts "Created binstub file in bin/mrsk"
+      end
+    end
+  end
+
+  desc "remove", "Remove Traefik, app, and registry session from servers"
+  def remove
+    invoke "mrsk:cli:traefik:remove"
+    invoke "mrsk:cli:app:remove"
+    invoke "mrsk:cli:registry:logout"
+  end
+
+  desc "version", "Display the MRSK version"
+  def version
+    puts Mrsk::VERSION
+  end
+
+  desc "app", "Manage the application"
+  subcommand "app", Mrsk::Cli::App
+
+  desc "build", "Build the application image"
+  subcommand "build", Mrsk::Cli::Build
+
+  desc "prune", "Prune old application images and containers"
+  subcommand "prune", Mrsk::Cli::Prune
+
+  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"
+  subcommand "traefik", Mrsk::Cli::Traefik
+end

lib/mrsk/cli/prune.rb

@@ -0,0 +1,19 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::Prune < Mrsk::Cli::Base
+  desc "all", "Prune unused images and stopped containers"
+  def all
+    invoke :containers
+    invoke :images
+  end
+
+  desc "images", "Prune unused images older than 30 days"
+  def images
+    on(MRSK.config.hosts) { execute *MRSK.prune.images }
+  end
+
+  desc "containers", "Prune stopped containers for the service older than 3 days"
+  def containers
+    on(MRSK.config.hosts) { execute *MRSK.prune.containers }
+  end
+end

lib/mrsk/cli/registry.rb

@@ -0,0 +1,14 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::Registry < Mrsk::Cli::Base
+  desc "login", "Login to the registry locally and remotely"
+  def login
+    run_locally           { execute *MRSK.registry.login }
+    on(MRSK.config.hosts) { execute *MRSK.registry.login }
+  end
+
+  desc "logout", "Logout of the registry remotely"
+  def logout
+    on(MRSK.config.hosts) { execute *MRSK.registry.logout }
+  end
+end

lib/mrsk/cli/server.rb

@@ -0,0 +1,8 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::Server < Mrsk::Cli::Base
+  desc "bootstrap", "Ensure Docker is installed on the servers"
+  def bootstrap
+    on(MRSK.config.hosts) { execute "which docker || apt-get install docker.io -y" }
+  end
+end

lib/mrsk/cli/templates/deploy.yml

@@ -0,0 +1,17 @@
+# 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.
+service: my-app
+
+# Name of the container image.
+image: user/my-app
+
+# Deploy to these servers.
+servers:
+  - 192.168.0.1
+
+# Credentials for your image host.
+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

lib/mrsk/cli/traefik.rb

@@ -0,0 +1,44 @@
+require "mrsk/cli/base"
+
+class Mrsk::Cli::Traefik < Mrsk::Cli::Base
+  desc "boot", "Boot Traefik on servers"
+  def boot
+    on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
+  end
+
+  desc "start", "Start existing Traefik on servers"
+  def start
+    on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
+  end
+
+  desc "stop", "Stop Traefik on servers"
+  def stop
+    on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
+  end
+
+  desc "restart", "Restart Traefik on servers"
+  def restart
+    invoke :stop
+    invoke :start
+  end
+
+  desc "details", "Display details about Traefik containers from servers"
+  def details
+    on(MRSK.config.role(:web).hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.info, verbosity: Logger::INFO) + "\n\n" }
+  end
+
+  desc "logs", "Show last 100 log lines from Traefik on servers"
+  def logs
+    on(MRSK.config.hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.logs) + "\n\n" }
+  end
+
+  desc "remove", "Remove Traefik container and image from servers"
+  def remove
+    invoke :stop
+
+    on(MRSK.config.role(:web).hosts) do
+      execute *MRSK.traefik.remove_container
+      execute *MRSK.traefik.remove_image
+    end
+  end
+end

lib/mrsk/commander.rb

@@ -0,0 +1,57 @@
+require "mrsk/configuration"
+require "mrsk/commands/app"
+require "mrsk/commands/builder"
+require "mrsk/commands/prune"
+require "mrsk/commands/traefik"
+require "mrsk/commands/registry"
+
+class Mrsk::Commander
+  attr_reader :config
+  attr_accessor :verbose
+
+  def initialize(config_file:)
+    @config_file = config_file
+  end
+
+  def config
+    @config ||= Mrsk::Configuration.load_file(@config_file).tap { |config| setup_with(config) }
+  end
+
+
+  def app
+    @app ||= Mrsk::Commands::App.new(config)
+  end
+
+  def builder
+    @builder ||= Mrsk::Commands::Builder.new(config)
+  end
+
+  def traefik
+    @traefik ||= Mrsk::Commands::Traefik.new(config)
+  end
+
+  def registry
+    @registry ||= Mrsk::Commands::Registry.new(config)
+  end
+
+  def prune
+    @prune ||= Mrsk::Commands::Prune.new(config)
+  end
+
+
+  def verbosity(level) 
+    old_level = SSHKit.config.output_verbosity
+    SSHKit.config.output_verbosity = level
+    yield
+  ensure
+    SSHKit.config.output_verbosity = old_level
+  end
+
+  private
+    # Lazy setup of SSHKit
+    def setup_with(config)
+      SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = config.ssh_options }
+      SSHKit.config.command_map[:docker] = "docker" # No need to use /usr/bin/env, just clogs up the logs
+      SSHKit.config.output_verbosity = :debug if verbose
+    end
+end

lib/mrsk/commands.rb

@@ -1,13 +1,2 @@
 module Mrsk::Commands
-  class Base
-    attr_accessor :config
-
-    def initialize(config)
-      @config = config
 end
-  end
-end
-
-require "mrsk/commands/app"
-require "mrsk/commands/traefik"
-require "mrsk/commands/registry"

lib/mrsk/commands/app.rb

@@ -1,22 +1,63 @@
+require "mrsk/commands/base"
+
 class Mrsk::Commands::App < Mrsk::Commands::Base
-  def push
+  def run(role: :web)
-    # TODO: Run 'docker buildx create --use' when needed
+    role = config.role(role)
-    "docker buildx build --push --platform=linux/amd64,linux/arm64 -t #{config.absolute_image} ."
+
+    docker :run,
+      "-d",
+      "--restart unless-stopped",
+      "--name", config.service_with_version,
+      "-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
+      *config.env_args,
+      *role.label_args,
+      config.absolute_image,
+      role.cmd
   end
 
-  def pull
+  def start(version: config.version)
-    "docker pull #{config.absolute_image}"
+    docker :start, "#{config.service}-#{version}"
-  end
-
-  def start
-    "docker run -d --rm --name #{config.service_with_version} #{config.envs} #{config.labels} #{config.absolute_image}"
   end
 
   def stop
-    "docker ps -q --filter label=service=#{config.service} | xargs docker stop"
+    [ "docker ps -q #{service_filter.join(" ")} | xargs docker stop" ]
   end
 
   def info
-    "docker ps --filter label=service=#{config.service}"
+    docker :ps, *service_filter
+  end
+
+  def logs
+    [ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -n 100 -t" ]
+  end
+
+  def exec(*command, interactive: false)
+    docker :exec,
+      ("-it" if interactive),
+      "-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
+      *config.env_args,
+      config.service_with_version,
+      *command
+  end
+
+  def console(host: config.primary_host)
+    "ssh -t #{config.ssh_user}@#{host} '#{exec("bin/rails", "c", interactive: true).join(" ")}'"
+  end
+
+  def list_containers
+    docker :container, :ls, "-a", *service_filter
+  end
+
+  def remove_containers
+    docker :container, :prune, "-f", *service_filter
+  end
+
+  def remove_images
+    docker :image, :prune, "-a", "-f", *service_filter
+  end
+
+  private
+    def service_filter
+      [ "--filter", "label=service=#{config.service}" ]
     end
 end

lib/mrsk/commands/base.rb

@@ -0,0 +1,27 @@
+require "sshkit"
+
+module Mrsk::Commands
+  class Base
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    private
+      def combine(*commands)
+        commands
+          .collect { |command| command + [ "&&" ] }.flatten # Join commands with &&
+          .tap     { |commands| commands.pop } # Remove trailing &&
+      end
+
+      def docker(*args)
+        args.compact.unshift :docker
+      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
+      end      
+  end
+end

lib/mrsk/commands/builder.rb

@@ -0,0 +1,39 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Builder < Mrsk::Commands::Base
+  delegate :create, :remove, :push, :pull, :info, to: :target
+  delegate :native?, :multiarch?, :remote?, to: :name
+
+  def name
+    target.class.to_s.demodulize.downcase.inquiry
+  end
+
+  def target
+    case
+    when config.builder.nil?
+      multiarch
+    when config.builder["multiarch"] == false
+      native
+    when config.builder["local"] && config.builder["local"]
+      multiarch_remote
+    else
+      raise ArgumentError, "Builder configuration incorrect: #{config.builder.inspect}"
+    end
+  end
+
+  def native
+    @native ||= Mrsk::Commands::Builder::Native.new(config)
+  end
+
+  def multiarch
+    @multiarch ||= Mrsk::Commands::Builder::Multiarch.new(config)
+  end
+
+  def multiarch_remote
+    @multiarch_remote ||= Mrsk::Commands::Builder::Multiarch::Remote.new(config)
+  end
+end
+
+require "mrsk/commands/builder/native"
+require "mrsk/commands/builder/multiarch"
+require "mrsk/commands/builder/multiarch/remote"

lib/mrsk/commands/builder/multiarch.rb

@@ -0,0 +1,30 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
+  def create
+    docker :buildx, :create, "--use", "--name", builder_name
+  end
+
+  def remove
+    docker :buildx, :rm, builder_name
+  end
+
+  def push
+    docker :buildx, :build, "--push", "--platform linux/amd64,linux/arm64", "-t", config.absolute_image, "."
+  end
+
+  def pull
+    docker :pull, config.absolute_image
+  end
+
+  def info
+    combine \
+      docker(:context, :ls),
+      docker(:buildx, :ls)
+  end
+
+  private
+    def builder_name
+      "mrsk-#{config.service}"
+    end
+end

lib/mrsk/commands/builder/multiarch/remote.rb

@@ -0,0 +1,58 @@
+require "mrsk/commands/builder/multiarch"
+
+class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Multiarch
+  def create
+    combine \
+      create_contexts,
+      create_local_buildx,
+      append_remote_buildx
+  end
+
+  def remove
+    combine \
+      remove_contexts,
+      super
+  end
+
+  private
+    def create_local_buildx
+      docker :buildx, :create, "--use", "--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
+
+    def local
+      config.builder["local"]
+    end
+
+    def remote
+      config.builder["remote"]
+    end
+
+    private
+      def builder_name_with_arch(arch)
+        "#{builder_name}-#{arch}"
+      end
+end

lib/mrsk/commands/builder/native.rb

@@ -0,0 +1,25 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
+  def create
+    # No-op on native
+  end
+
+  def remove
+    # No-op on native
+  end
+
+  def push
+    combine \
+      docker(:build, "-t", config.absolute_image, "."),
+      docker(:push, config.absolute_image)
+  end
+
+  def pull
+    docker :pull, config.absolute_image
+  end
+
+  def info
+    # No-op on native
+  end
+end

lib/mrsk/commands/prune.rb

@@ -0,0 +1,17 @@
+require "mrsk/commands/base"
+require "active_support/duration"
+require "active_support/core_ext/numeric/time"
+
+class Mrsk::Commands::Prune < Mrsk::Commands::Base
+  PRUNE_IMAGES_AFTER     = 30.days.in_hours.to_i
+  PRUNE_CONTAINERS_AFTER =  3.days.in_hours.to_i
+
+  def images
+    docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
+  end
+
+  def containers
+    docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
+    docker :container, :prune, "-f", "--filter", "label=service=#{config.service}", "--filter", "'until=#{PRUNE_CONTAINERS_AFTER}h'"
+  end
+end

lib/mrsk/commands/registry.rb

@@ -1,5 +1,13 @@
+require "mrsk/commands/base"
+
 class Mrsk::Commands::Registry < Mrsk::Commands::Base
+  delegate :registry, to: :config
+
   def login
-    "docker login #{config.registry["server"]} -u #{config.registry["username"]} -p #{config.registry["password"]}"
+    docker :login, registry["server"], "-u", redact(registry["username"]), "-p", redact(registry["password"])
+  end
+
+  def logout
+    docker :logout, registry["server"]
   end
 end

lib/mrsk/commands/traefik.rb

@@ -1,17 +1,37 @@
+require "mrsk/commands/base"
+
 class Mrsk::Commands::Traefik < Mrsk::Commands::Base
+  def run
+    docker :run, "--name traefik",
+      "-d",
+      "--restart unless-stopped",
+      "-p 80:80",
+      "-v /var/run/docker.sock:/var/run/docker.sock",
+      "traefik",
+      "--providers.docker"
+  end
+
   def start
-    "docker run --name traefik " + 
+    docker :container, :start, "traefik"
-      "--rm -d " +
-      "-p 80:80 " +
-      "-v /var/run/docker.sock:/var/run/docker.sock " +
-      "traefik --providers.docker"
   end
 
   def stop
-    "docker container stop traefik"
+    docker :container, :stop, "traefik"
   end
 
   def info
-    "docker ps --filter name=traefik"
+    docker :ps, "--filter", "name=traefik"
+  end
+
+  def logs
+    docker :logs, "traefik", "-n", "100", "-t"
+  end
+
+  def remove_container
+    docker :container, :prune, "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
+  end
+
+  def remove_image
+    docker :image, :prune, "-a", "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
   end
 end

lib/mrsk/configuration.rb

@@ -1,60 +1,102 @@
 require "active_support/ordered_options"
+require "active_support/core_ext/string/inquiry"
+require "active_support/core_ext/module/delegation"
+require "pathname"
+require "erb"
 
 class Mrsk::Configuration
-  delegate :service, :image, :env, :registry, :ssh_user, to: :config, allow_nil: true
+  delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :config, allow_nil: true
 
-  def self.load_file(file)
+  class << self
+    def load_file(file)
       if file.exist?
-      new YAML.load_file(file).symbolize_keys
+        new YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
       else
         raise "Configuration file not found in #{file}"
       end
     end
 
-  def initialize(config)
+    def argumentize(argument, attributes)
-    @config = ActiveSupport::InheritableOptions.new(config)
+      attributes.flat_map { |k, v| [ argument, "#{k}=#{v}" ] }
-    ensure_required_keys_present
+    end
   end
 
-  def servers
+  def initialize(config, validate: true)
-    ENV["SERVERS"] || config.servers
+    @config = ActiveSupport::InheritableOptions.new(config)
+    ensure_required_keys_present if validate
   end
 
+
+  def roles
+    @roles ||= role_names.collect { |role_name| Role.new(role_name, config: self) }
+  end
+
+  def role(name)
+    roles.detect { |r| r.name == name.to_s }
+  end
+
+  def hosts
+    hosts =
+      case
+      when ENV["HOSTS"]
+        ENV["HOSTS"].split(",")
+      when ENV["ROLES"]
+        role_names = ENV["ROLES"].split(",")
+        roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts)
+      else
+        roles.flat_map(&:hosts)
+      end
+
+      if hosts.any?
+        hosts
+      else
+        raise ArgumentError, "No hosts found"
+      end
+  end
+
+  def primary_host
+    role(:web).hosts.first
+  end
+
+
   def version
     @version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
   end
 
-  def absolute_image
+  def repository
-    [ config.registry["server"], image_with_version ].compact.join("/")
+    [ config.registry["server"], image ].compact.join("/")
   end
 
-  def image_with_version
+  def absolute_image
-    "#{image}:#{version}"
+    "#{repository}:#{version}"
   end
 
   def service_with_version
     "#{service}-#{version}"
   end
 
-  def envs
+
-    parameterize "-e", \
+  def env_args
-      { "RAILS_MASTER_KEY" => master_key }.merge(env || {})
+    if config.env.present?
+      self.class.argumentize "-e", config.env
+    else
+      []
+    end
   end
 
-  def labels
+  def ssh_user
-    parameterize "--label", \
+    config.ssh_user || "root"
-      "service" => service,
-      "traefik.http.routers.#{service}.rule" => "'PathPrefix(`/`)'",
-      "traefik.http.services.#{service}.loadbalancer.healthcheck.path" => "/up",
-      "traefik.http.services.#{service}.loadbalancer.healthcheck.interval" => "1s",
-      "traefik.http.middlewares.#{service}.retry.attempts" => "3",
-      "traefik.http.middlewares.#{service}.retry.initialinterval" => "500ms"
   end
 
   def ssh_options
-    { user: config.ssh_user || "root", auth_methods: [ "publickey" ] }
+    { user: ssh_user, auth_methods: [ "publickey" ] }
   end
 
+  def master_key
+    ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
+  end
+
+
   private
     attr_accessor :config
 
@@ -68,11 +110,9 @@ class Mrsk::Configuration
       end      
     end
 
-    def parameterize(param, hash)
+    def role_names
-      hash.collect { |k, v| "#{param} #{k}=#{v}" }.join(" ")
+      config.servers.is_a?(Array) ? [ "web" ] : config.servers.keys.sort
+    end
 end
 
-    def master_key
+require "mrsk/configuration/role"
-      ENV["RAILS_MASTER_KEY"] || File.read(Rails.root.join("config/master.key"))
-    end
-end

lib/mrsk/configuration/role.rb

@@ -0,0 +1,70 @@
+class Mrsk::Configuration::Role
+  delegate :argumentize, to: Mrsk::Configuration
+
+  attr_accessor :name
+
+  def initialize(name, config:)
+   @name, @config = name.inquiry, config
+  end
+
+  def hosts
+    @hosts ||= extract_hosts_from_config
+  end
+
+  def labels
+    if name.web?
+      default_labels.merge(traefik_labels).merge(custom_labels)
+    else
+      default_labels.merge(custom_labels)
+    end
+  end
+
+  def label_args
+    argumentize "--label", labels
+  end
+
+  def cmd
+    specializations["cmd"]
+  end
+
+  private
+    attr_accessor :config
+
+    def extract_hosts_from_config
+      if config.servers.is_a?(Array)
+        config.servers
+      else
+        servers = config.servers[name]
+        servers.is_a?(Array) ? servers : servers["hosts"]
+      end
+    end
+
+    def default_labels
+      { "service" => config.service, "role" => name }
+    end
+
+    def traefik_labels
+      {
+        "traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
+        "traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => "/up",
+        "traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
+        "traefik.http.middlewares.#{config.service}.retry.attempts" => "3",
+        "traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
+      }
+    end
+
+    def custom_labels
+      Hash.new.tap do |labels|
+        labels.merge!(config.labels) if config.labels.present?
+        labels.merge!(specializations["labels"]) if specializations["labels"].present?
+      end
+    end
+
+    def specializations
+      if config.servers.is_a?(Array) || config.servers[name].is_a?(Array)
+        { }
+      else
+        config.servers[name].without("hosts")
+      end
+    end
+end

lib/mrsk/engine.rb

@@ -1,4 +0,0 @@
-module Mrsk
-  class Engine < ::Rails::Engine
-  end
-end

lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

lib/tasks/mrsk/app.rake

@@ -1,31 +0,0 @@
-require_relative "setup"
-
-app = Mrsk::Commands::App.new(MRSK_CONFIG)
-
-namespace :mrsk do
-  namespace :app do
-    desc "Build and push app image to servers"
-    task :push do
-      run_locally             { execute app.push }
-      on(MRSK_CONFIG.servers) { execute app.pull }
-    end
-
-    desc "Start app on servers"
-    task :start do
-      on(MRSK_CONFIG.servers) { execute app.start }
-    end
-
-    desc "Stop app on servers"
-    task :stop do
-      on(MRSK_CONFIG.servers) { execute app.stop, raise_on_non_zero_exit: false }
-    end
-
-    desc "Restart app on servers"
-    task restart: %i[ stop start ]
-
-    desc "Display information about app containers"
-    task :info do
-      on(MRSK_CONFIG.servers) { |host| puts "Host: #{host}\n" + capture(app.info) + "\n\n" }
-    end
-  end
-end

lib/tasks/mrsk/mrsk.rake

@@ -1,12 +0,0 @@
-namespace :mrsk do
-  desc "Push the latest version of the app, ensure Traefik is running, then restart app"
-  task deploy: [ "app:push", "traefik:start", "app:restart" ]
-
-  desc "Display information about Traefik and app containers"
-  task info: [ "traefik:info", "app:info" ]
-
-  desc "Create config stub"
-  task :init do
-    Rails.root.join("config/deploy.yml")
-  end
-end

lib/tasks/mrsk/registry.rake

@@ -1,13 +0,0 @@
-require_relative "setup"
-
-registry = Mrsk::Commands::Registry.new(MRSK_CONFIG)
-
-namespace :mrsk do
-  namespace :registry do
-    desc "Login to the registry locally and remotely"
-    task :login do
-      run_locally             { execute registry.login }
-      on(MRSK_CONFIG.servers) { execute registry.login }
-    end
-  end
-end

lib/tasks/mrsk/setup.rb

@@ -1,8 +0,0 @@
-require "sshkit"
-require "sshkit/dsl"
-
-include SSHKit::DSL
-
-MRSK_CONFIG = Mrsk::Configuration.load_file(Rails.root.join("config/deploy.yml"))
-
-SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = MRSK_CONFIG.ssh_options }

lib/tasks/mrsk/traefik.rake

@@ -1,25 +0,0 @@
-require_relative "setup"
-
-traefik = Mrsk::Commands::Traefik.new(MRSK_CONFIG)
-
-namespace :mrsk do
-  namespace :traefik do
-    desc "Start Traefik"
-    task :start do
-      on(MRSK_CONFIG.servers) { execute traefik.start, raise_on_non_zero_exit: false }
-    end
-
-    desc "Stop Traefik"
-    task :stop do
-      on(MRSK_CONFIG.servers) { execute traefik.stop, raise_on_non_zero_exit: false }
-    end
-
-    desc "Restart Traefik"
-    task restart: %i[ stop start ]
-
-    desc "Display information about Traefik containers"
-    task :info do
-      on(MRSK_CONFIG.servers) { |host| puts "Host: #{host}\n" + capture(traefik.info) + "\n\n" }
-    end
-  end
-end

mrsk.gemspec

@@ -6,11 +6,13 @@ Gem::Specification.new do |spec|
   spec.authors     = [ "David Heinemeier Hansson" ]
   spec.email       = "dhh@hey.com"
   spec.homepage    = "https://github.com/rails/mrsk"
-  spec.summary     = "Deploy Docker containers with zero downtime to any host."
+  spec.summary     = "Deploy Rails apps in containers to servers running Docker with zero downtime."
   spec.license     = "MIT"
 
   spec.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
+  spec.executables = %w[ mrsk ]
 
-  spec.add_dependency "railties", ">= 7.0.0"
+  spec.add_dependency "activesupport", ">= 7.0"
   spec.add_dependency "sshkit", "~> 1.21"
+  spec.add_dependency "thor", "~> 1.2"
 end

test/app_command_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+require "mrsk/configuration"
+require "mrsk/commands/app"
+
+ENV["VERSION"] = "123"
+ENV["RAILS_MASTER_KEY"] = "456"
+
+class AppCommandTest < ActiveSupport::TestCase
+  setup do
+    @config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
+    @app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config)
+  end
+
+  test "run" do
+    assert_equal \
+      [:docker, :run, "-d", "--restart unless-stopped", "--name", "app-123", "-e", "RAILS_MASTER_KEY=456", "--label", "service=app", "--label", "role=web", "--label", "traefik.http.routers.app.rule='PathPrefix(`/`)'", "--label", "traefik.http.services.app.loadbalancer.healthcheck.path=/up", "--label", "traefik.http.services.app.loadbalancer.healthcheck.interval=1s", "--label", "traefik.http.middlewares.app.retry.attempts=3", "--label", "traefik.http.middlewares.app.retry.initialinterval=500ms", "dhh/app:123"], @app.run
+  end
+end

test/builder_command_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+require "mrsk/configuration"
+require "mrsk/commands/builder"
+
+class BuilderCommandTest < ActiveSupport::TestCase
+  setup do
+    @config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
+  end
+
+  test "target multiarch by default" do
+    builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config))
+    assert builder.multiarch?
+  end
+
+  test "target native when multiarch is off" do
+    builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge({ builder: { "multiarch" => false } })))
+    assert builder.native?
+  end
+
+  test "target multiarch remote when local and remote is set" do
+    builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge({ builder: { "local" => { }, "remote" => { } } })))
+    assert builder.remote?
+  end
+end

test/commander_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+require "mrsk/commander"
+
+class CommanderTest < ActiveSupport::TestCase
+  setup do
+    @mrsk = Mrsk::Commander.new config_file: Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
+  end
+
+  test "lazy configuration" do
+    assert_equal Mrsk::Configuration, @mrsk.config.class
+  end
+end

test/configuration_role_test.rb

@@ -0,0 +1,61 @@
+require "test_helper"
+require "mrsk/configuration"
+
+ENV["VERSION"] = "123"
+
+class ConfigurationRoleTest < ActiveSupport::TestCase
+  setup do
+    @deploy = {
+      service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
+      servers: [ "1.1.1.1", "1.1.1.2" ]
+    }
+
+    @config = Mrsk::Configuration.new(@deploy)
+
+    @deploy_with_roles = @deploy.dup.merge({
+      servers: {
+        "web" => [ "1.1.1.1", "1.1.1.2" ],
+        "workers" => {
+          "hosts" => [ "1.1.1.3", "1.1.1.4" ],
+          "cmd" => "bin/jobs"
+        }
+      }
+    })
+
+    @config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
+  end
+
+  test "hosts" do
+    assert_equal [ "1.1.1.1", "1.1.1.2" ], @config.role(:web).hosts
+    assert_equal [ "1.1.1.3", "1.1.1.4" ], @config_with_roles.role(:workers).hosts
+  end
+
+  test "cmd" do
+    assert_nil @config.role(:web).cmd
+    assert_equal "bin/jobs", @config_with_roles.role(:workers).cmd
+  end
+
+  test "label args" do
+    assert_equal [ "--label", "service=app", "--label", "role=workers" ], @config_with_roles.role(:workers).label_args
+  end
+
+  test "special label args for web" do
+    assert_equal [ "--label", "service=app", "--label", "role=web", "--label", "traefik.http.routers.app.rule='PathPrefix(`/`)'", "--label", "traefik.http.services.app.loadbalancer.healthcheck.path=/up", "--label", "traefik.http.services.app.loadbalancer.healthcheck.interval=1s", "--label", "traefik.http.middlewares.app.retry.attempts=3", "--label", "traefik.http.middlewares.app.retry.initialinterval=500ms"], @config.role(:web).label_args
+  end
+
+  test "custom labels" do
+    @deploy[:labels] = { "my.custom.label" => "50" }
+    assert_equal "50", @config.role(:web).labels["my.custom.label"]
+  end
+
+  test "custom labels via role specialization" do
+    @deploy_with_roles[:labels] = { "my.custom.label" => "50" }
+    @deploy_with_roles[:servers]["workers"]["labels"] = { "my.custom.label" => "70" }
+    assert_equal "70", @config_with_roles.role(:workers).labels["my.custom.label"]
+  end
+
+  test "overwriting default traefik label" do
+    @deploy[:labels] = { "traefik.http.routers.app.rule" => "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'" }
+    assert_equal "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'", @config.role(:web).labels["traefik.http.routers.app.rule"]
+  end
+end

test/configuration_test.rb

@@ -2,28 +2,116 @@ require "test_helper"
 require "mrsk/configuration"
 
 ENV["VERSION"] = "123"
+ENV["RAILS_MASTER_KEY"] = "456"
 
 class ConfigurationTest < ActiveSupport::TestCase
   setup do
-    @config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" } }
+    @deploy = {
+      service: "app", image: "dhh/app",
+      registry: { "username" => "dhh", "password" => "secret" },
+      env: { "REDIS_URL" => "redis://x/y" },
+      servers: [ "1.1.1.1", "1.1.1.2" ]
+    }
+
+    @config = Mrsk::Configuration.new(@deploy)
+
+    @deploy_with_roles = @deploy.dup.merge({
+      servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => { "hosts" => [ "1.1.1.3", "1.1.1.4" ] } } })
+
+    @config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
   end
 
   test "ensure valid keys" do
     assert_raise(ArgumentError) do
-      Mrsk::Configuration.new(@config.tap { _1.delete(:service) })
+      Mrsk::Configuration.new(@deploy.tap { _1.delete(:service) })
-      Mrsk::Configuration.new(@config.tap { _1.delete(:image) })
+      Mrsk::Configuration.new(@deploy.tap { _1.delete(:image) })
-      Mrsk::Configuration.new(@config.tap { _1.delete(:registry) })
+      Mrsk::Configuration.new(@deploy.tap { _1.delete(:registry) })
 
-      Mrsk::Configuration.new(@config.tap { _1[:registry].delete("username") })
+      Mrsk::Configuration.new(@deploy.tap { _1[:registry].delete("username") })
-      Mrsk::Configuration.new(@config.tap { _1[:registry].delete("password") })
+      Mrsk::Configuration.new(@deploy.tap { _1[:registry].delete("password") })
     end
   end
 
+  test "roles" do
+    assert_equal %w[ web ], @config.roles.collect(&:name)
+    assert_equal %w[ web workers ], @config_with_roles.roles.collect(&:name)
+  end
+
+  test "role" do
+    assert_equal "web", @config.role(:web).name
+    assert_equal "workers", @config_with_roles.role(:workers).name
+    assert_nil @config.role(:missing)
+  end
+
+  test "hosts" do
+    assert_equal [ "1.1.1.1", "1.1.1.2"], @config.hosts
+    assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
+  end
+
+  test "hosts from ENV" do
+    ENV["HOSTS"] = "1.1.1.5,1.1.1.6"
+    assert_equal [ "1.1.1.5", "1.1.1.6"], @config.hosts
+  ensure
+    ENV["HOSTS"] = nil
+  end
+
+  test "hosts from ENV roles" do
+    ENV["ROLES"] = "web,workers"
+    assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
+
+    ENV["ROLES"] = "workers"
+    assert_equal [ "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
+  ensure
+    ENV["ROLES"] = nil
+  end
+
+  test "primary host" do
+    assert_equal "1.1.1.1", @config.primary_host
+    assert_equal "1.1.1.1", @config_with_roles.primary_host
+  end
+
+
+  test "version" do
+    assert_equal "123", @config.version
+  end
+
+  test "repository" do
+    assert_equal "dhh/app", @config.repository
+
+    config = Mrsk::Configuration.new(@deploy.tap { |c| c[:registry].merge!({ "server" => "ghcr.io" }) })
+    assert_equal "ghcr.io/dhh/app", config.repository
+  end
+
   test "absolute image" do
-    configuration = Mrsk::Configuration.new(@config)
+    assert_equal "dhh/app:123", @config.absolute_image
-    assert_equal "dhh/app:123", configuration.absolute_image
 
-    configuration = Mrsk::Configuration.new(@config.tap { |c| c[:registry].merge!({ "server" => "ghcr.io" }) })
+    config = Mrsk::Configuration.new(@deploy.tap { |c| c[:registry].merge!({ "server" => "ghcr.io" }) })
-    assert_equal "ghcr.io/dhh/app:123", configuration.absolute_image
+    assert_equal "ghcr.io/dhh/app:123", config.absolute_image
+  end
+
+  test "service with version" do
+    assert_equal "app-123", @config.service_with_version
+  end
+
+
+  test "env args" do
+    assert_equal [ "-e", "REDIS_URL=redis://x/y" ], @config.env_args
+  end
+
+  test "ssh options" do
+    assert_equal "root", @config.ssh_options[:user]
+
+    config = Mrsk::Configuration.new(@deploy.tap { |c| c[:ssh_user] = "app" })
+    assert_equal "app", @config.ssh_options[:user]
+  end
+
+  test "master key" do
+    assert_equal "456", @config.master_key
+  end
+
+
+  test "erb evaluation of yml config" do
+    config = Mrsk::Configuration.load_file Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
+    assert_equal "my-user", config.registry["username"]
   end
 end

test/fixtures/deploy.erb.yml

@@ -0,0 +1,11 @@
+service: app
+image: dhh/app
+servers:
+  - 1.1.1.1
+  - 1.1.1.2
+env:
+  REDIS_URL: redis://x/y
+registry:
+  server: registry.digitalocean.com
+  username: <%= "my-user" %>
+  password: <%= "my-password" %>

test/test_helper.rb

@@ -1,6 +1,7 @@
 require "bundler/setup"
 require "active_support/test_case"
 require "active_support/testing/autorun"
+require "debug"
 
 ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]