mrsk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8f29ada17aea2f0a3dbabe3a9b8917c4e951353eb7ada2022c5aa0c98a2dea
-  data.tar.gz: 817eb173b1ea66238f868ddbb7683e651844767cda3ac5f74ce3bc933cb74cd8
+  metadata.gz: 0f5260e6f41ed0ae04931d800b7c2da3b0bc32f0042d2e140fcb2860b1a9e12a
+  data.tar.gz: 0c94b286b4a9ce9339678a4a4662c65dcefd6947795227c2464db50e7bf727e0
 SHA512:
-  metadata.gz: 722b4f4b740c3110c620053e105a7ed32e3c185ef46b5b4ed08b8092c6b53b2baff5400340e102647a24db476c32d52dd262dd706895c1ae243ce490cd5a4a61
-  data.tar.gz: 3e8abd162d7255a96fec5febab21f406bfc8f964a82b71f9c7f105b80807e46c07d6027f75abec515768eb22fd989af392e43b4bf2b0d7a811afe68d89372c0e
+  metadata.gz: 0f980ac1468ac3581f1b8bd8206c2471b5e79d7bc84c274f1bef2a761ceccc25905308774770a04156e68e5b1fd73d8d83926d235d287a11118fb9ea8f7fb619
+  data.tar.gz: 720ac72cfd88a494049a237140e774b37288f3a142cb70e3a672a91aa7094a019c0eb938c3ca9a146cd64b1d33d811b2c4b8d0373d7b9457bfaf8499bfd86943

data/README.md

@@ -1,22 +1,18 @@
 # MRSK
 
-MRSK ships zero-downtime deploys of Rails apps packed as containers to any host. 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 ships zero-downtime deploys of Rails apps packed as containers to any host. 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 seamlessly across multiple hosts, using SSHKit to execute commands.
 
 ## Installation
 
-Add the gem with `bundle add mrsk`, then run `rake mrsk:init`, and then edit the new file in `config/deploy.yml` to use the proper service name, image reference, servers to deploy on, and so on. It could look something like this:
+Add the gem with `bundle add mrsk`, then run `rake mrsk:init`, and then edit the new file in `config/deploy.yml`. It could look as simple as this:
 
 ```yaml
 service: hey
 image: 37s/hey
 servers:
-  - xxx.xxx.xxx.xxx
-  - xxx.xxx.xxx.xxx
-env:
-  DATABASE_URL: mysql2://db1/hey_production/
-  REDIS_URL: redis://redis1:6379/1
+  - 192.168.0.1
+  - 192.168.0.2
 registry:
-  server: registry.digitalocean.com
   username: <%= Rails.application.credentials.registry["username"] %>
   password: <%= Rails.application.credentials.registry["password"] %>
 ```
@@ -26,13 +22,13 @@ Then ensure your encrypted credentials have the registry username + password by
 ```
 registry:
   username: real-user-name
-  password: real-password
+  password: real-registry-password-or-token
 ```
 
-Now you're ready to deploy a multi-arch image (FIXME: currently you need to manually run `docker buildx create --use` once first):
+Now you're ready to deploy a multi-arch image to the servers:
 
 ```
-rake mrsk:deploy
+./bin/mrsk deploy
 ```
 
 This will:
@@ -48,33 +44,123 @@ This will:
 
 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.
 
-## Operations
+## 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: <%= Rails.application.credentials.registry["username"] %>
+  password: <%= Rails.application.credentials.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).
 
-### Running job hosts separately
+### Adding custom container labels
 
-If your application uses separate job running hosts, or other roles beyond the default web running, you can specify these hosts and their custom command like so:
+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:
-    - xxx.xxx.xxx.xxx
-    - xxx.xxx.xxx.xxx
+    - 192.168.0.1
+    - 192.168.0.2
   job:
     hosts:
-      - xxx.xxx.xxx.xxx
-      - xxx.xxx.xxx.xxx
+      - 192.168.0.3
+      - 192.168.0.4
     cmd: bin/jobs
+    labels:
+      my-custom-label: "50"
 ```
 
-The application will be deployed to all hosts, but only those in the `web` role will be labeled to run under traefik. If you want to run custom commands on all hosts in a role, you can use `rake mrsk:app:exec:rails CMD=about ROLES=job`.
+### Configuring remote builder for native multi-arch
 
-### Executing commands
+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 need to execute commands inside the Rails containers, you can use `rake mrsk:app:exec`, `rake mrsk:app:exec:once`, `rake mrsk:app:exec:rails`, and `rake mrsk:app:exec:once:rails`. Examples:
+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 `./bin/mrsk build:remote:create`. If you wish to remove the contexts and buildx instances again, you can run `./bin/mrsk build:remote:remove`. If you had already built using the standard emulation setup, run `./bin/mrsk build:remove` before doing `./bin/mrsk build:remote:create`.
+
+### 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 `./bin/mrsk app:exec`, `./bin/mrsk app:exec:once`, `./bin/mrsk app:exec:rails`, and `./bin/mrsk app:exec:once:rails`. Examples:
 
 ```bash
 # Runs command on all servers
-rake mrsk:app:exec CMD='ruby -v'
+./bin/mrsk app:exec CMD='ruby -v'
 App Host: xxx.xxx.xxx.xxx
 ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
 
@@ -82,11 +168,11 @@ App Host: xxx.xxx.xxx.xxx
 ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
 
 # Runs command on first server
-rake mrsk:app:exec:once CMD='cat .ruby-version'
+./bin/mrsk app:exec:once CMD='cat .ruby-version'
 3.1.3
 
 # Runs Rails command on all servers
-rake mrsk:app:exec:rails CMD=about
+./bin/mrsk app:exec:rails CMD=about
 App Host: xxx.xxx.xxx.xxx
 About your application's environment
 Rails version             7.1.0.alpha
@@ -112,14 +198,18 @@ Database adapter          sqlite3
 Database schema version   20221231233303
 
 # Runs Rails command on first server
-rake mrsk:app:exec:once:rails CMD='db:version'
+./bin/mrsk app:exec:once:rails CMD='db:version'
 database: storage/production.sqlite3
 Current version: 20221231233303
 ```
 
+### Running a Rails console on the primary host
+
+If you need to interact with the production console for the app, you can use `./bin/mrsk app:console`, which will start a Rails console session on the primary host. 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 `rake mrsk:info`. It'll show something like this:
+You can see the state of your servers by running `./bin/mrsk info`. It'll show something like this:
 
 ```
 Traefik Host: xxx.xxx.xxx.xxx
@@ -139,11 +229,11 @@ CONTAINER ID   IMAGE
 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 `rake mrsk:app:info` or just for Traefik with `rake mrsk:traefik:info`.
+You can also see just info for app containers with `./bin/mrsk app:info` or just for Traefik with `./bin/mrsk traefik:info`.
 
 ### 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 `rake mrsk:app:containers`. It'll give you a presentation similar to `rake mrsk:app:info`, but include all the old containers as well. Showing something like this:
+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 `./bin/mrsk app:containers`. It'll give you a presentation similar to `./bin/mrsk app:info`, but include all the old containers as well. Showing something like this:
 
 ```
 App Host: 164.92.105.119
@@ -157,20 +247,19 @@ badb1aa51db4   registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483
 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 `rake mrsk:rollback VERSION=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.
+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 `./bin/mrsk rollback VERSION=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 `rake mrsk:deploy`.
+Note that by default old containers are pruned after 3 days when you run `./bin/mrsk deploy`.
 
 ### Removing
 
-If you wish to remove the entire application, including Traefik, containers, images, and registry session, you can run `rake mrsk:remove`. This will leave the servers clean.
+If you wish to remove the entire application, including Traefik, containers, images, and registry session, you can run `./bin/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:
 
 - Adapterize commands to work with Podman and other container runners
-- Possibly switching to a bin/mrsk command rather than raw rake
 - Integrate with cloud CI pipelines
 
 ## License

data/lib/mrsk/commander.rb

@@ -0,0 +1,56 @@
+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_file, :config, :verbose
+
+  def initialize(config_file:, verbose: false)
+    @config_file, @verbose = config_file, verbose
+  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

data/lib/mrsk/commands/app.rb

@@ -1,14 +1,6 @@
-class Mrsk::Commands::App < Mrsk::Commands::Base
-  def push
-    # TODO: Run 'docker buildx create --use' when needed
-    # TODO: Make multiarch an option so Linux users can enjoy speedier builds
-    docker :buildx, :build, "--push", "--platform linux/amd64,linux/arm64", "-t", config.absolute_image, "."
-  end
-
-  def pull
-    docker :pull, config.absolute_image
-  end
+require "mrsk/commands/base"
 
+class Mrsk::Commands::App < Mrsk::Commands::Base
   def run(role: :web)
     role = config.role(role)
 
@@ -36,17 +28,22 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   def logs
-    [ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -f" ]
+    [ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -n 100 -t" ]
   end
 
-  def exec(*command)
-    docker :exec, 
+  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
+    "ssh -t #{config.ssh_user}@#{config.primary_host} '#{exec("bin/rails", "c", interactive: true).join(" ")}'"
+  end
+
   def list_containers
     docker :container, :ls, "-a", *service_filter
   end

data/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

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

@@ -0,0 +1,53 @@
+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", "mrsk", "mrsk-#{local["arch"]}", "--platform", "linux/#{local["arch"]}"
+    end
+
+    def append_remote_buildx
+      docker :buildx, :create, "--append", "--name", "mrsk", "mrsk-#{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, "mrsk-#{arch}", "--description", "'MRSK #{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, "mrsk-#{arch}"
+    end
+
+    def local
+      config.builder["local"]
+    end
+
+    def remote
+      config.builder["remote"]
+    end
+end

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

@@ -0,0 +1,25 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
+  def create
+    docker :buildx, :create, "--use", "--name", "mrsk"
+  end
+
+  def remove
+    docker :buildx, :rm, "mrsk"
+  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
+end

data/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

data/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"

data/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

data/lib/mrsk/commands/registry.rb

@@ -1,3 +1,5 @@
+require "mrsk/commands/base"
+
 class Mrsk::Commands::Registry < Mrsk::Commands::Base
   delegate :registry, to: :config
 

data/lib/mrsk/commands/traefik.rb

@@ -1,3 +1,5 @@
+require "mrsk/commands/base"
+
 class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   def run
     docker :run, "--name traefik",
@@ -22,7 +24,7 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
   end
 
   def logs
-    docker :logs, "traefik"
+    docker :logs, "traefik", "-n", "100", "-t"
   end
 
   def remove_container

data/lib/mrsk/commands.rb

@@ -1,25 +1,2 @@
-require "sshkit"
-
 module Mrsk::Commands
-  class Base
-    attr_accessor :config
-
-    def initialize(config)
-      @config = config
-    end
-
-    private
-      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
-
-require "mrsk/commands/app"
-require "mrsk/commands/traefik"
-require "mrsk/commands/registry"

data/lib/mrsk/configuration/role.rb

@@ -11,6 +11,14 @@ class Mrsk::Configuration::Role
     @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
@@ -31,14 +39,6 @@ class Mrsk::Configuration::Role
       end
     end
 
-    def labels
-      if name.web?
-        default_labels.merge(traefik_labels) 
-      else
-        default_labels
-      end
-    end
-
     def default_labels
       { "service" => config.service, "role" => name }
     end
@@ -53,6 +53,13 @@ class Mrsk::Configuration::Role
       }
     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)
         { }

data/lib/mrsk/configuration.rb

@@ -3,7 +3,7 @@ require "active_support/core_ext/string/inquiry"
 require "erb"
 
 class Mrsk::Configuration
-  delegate :service, :image, :servers, :env, :registry, :ssh_user, to: :config, allow_nil: true
+  delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :config, allow_nil: true
 
   class << self
     def load_file(file)
@@ -75,11 +75,19 @@ class Mrsk::Configuration
 
 
   def env_args
-    self.class.argumentize "-e", config.env if config.env.present?
+    if config.env.present?
+      self.class.argumentize "-e", config.env
+    else
+      []
+    end
+  end
+
+  def ssh_user
+    config.ssh_user || "root"
   end
 
   def ssh_options
-    { user: config.ssh_user || "root", auth_methods: [ "publickey" ] }
+    { user: ssh_user, auth_methods: [ "publickey" ] }
   end
 
   def master_key

data/lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/mrsk.rb

@@ -3,6 +3,4 @@ end
 
 require "mrsk/version"
 require "mrsk/engine"
-
-require "mrsk/configuration"
-require "mrsk/commands"
+require "mrsk/commander"

data/lib/tasks/mrsk/app.rake

@@ -1,32 +1,17 @@
 require_relative "setup"
 
-app = Mrsk::Commands::App.new(MRSK_CONFIG)
-
 namespace :mrsk do
   namespace :app do
-    desc "Deliver a newly built app image to servers"
-    task deliver: %i[ push pull ]
-
-    desc "Build locally and push app image to registry"
-    task :push do
-      run_locally { execute *app.push } unless ENV["VERSION"]
-    end
-
-    desc "Pull app image from the registry onto servers"
-    task :pull do
-      on(MRSK_CONFIG.hosts) { execute *app.pull }
-    end
-
     desc "Run app on servers (or start them if they've already been run)"
     task :run do
-      MRSK_CONFIG.roles.each do |role|
+      MRSK.config.roles.each do |role|
         on(role.hosts) do |host|
           begin
-            execute *app.run(role: role.name)
+            execute *MRSK.app.run(role: role.name)
           rescue SSHKit::Command::Failed => e
             if e.message =~ /already in use/
-              puts "Container with same version already deployed on #{host}, starting that instead"
-              execute *app.start, host: host
+              error "Container with same version already deployed on #{host}, starting that instead"
+              execute *MRSK.app.start, host: host
             else
               raise
             end
@@ -35,14 +20,14 @@ namespace :mrsk do
       end
     end
 
-    desc "Start existing app on servers"
+    desc "Start existing app on servers (use VERSION=<git-hash> to designate which version)"
     task :start do
-      on(MRSK_CONFIG.hosts) { execute *app.start, raise_on_non_zero_exit: false }
+      on(MRSK.config.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
     end
 
     desc "Stop app on servers"
     task :stop do
-      on(MRSK_CONFIG.hosts) { execute *app.stop, raise_on_non_zero_exit: false }
+      on(MRSK.config.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
     end
 
     desc "Start app on servers (use VERSION=<git-hash> to designate which version)"
@@ -50,48 +35,62 @@ namespace :mrsk do
 
     desc "Display information about app containers"
     task :info do
-      on(MRSK_CONFIG.hosts) { |host| puts "App Host: #{host}\n" + capture(*app.info) + "\n\n" }
+      on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.info) + "\n\n" }
     end
 
     desc "Execute a custom task on servers passed in as CMD='bin/rake some:task'"
     task :exec do
-      on(MRSK_CONFIG.hosts) { |host| puts "App Host: #{host}\n" + capture(*app.exec(ENV["CMD"])) + "\n\n" }
+      on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec(ENV["CMD"])) + "\n\n" }
+    end
+
+    desc "Start Rails Console on primary host"
+    task :console do
+      puts "Launching Rails console on #{MRSK.config.primary_host}..."
+      exec app.console
     end
 
     namespace :exec do
       desc "Execute Rails command on servers, like CMD='runner \"puts %(Hello World)\""
       task :rails do
-        on(MRSK_CONFIG.hosts) { |host| puts "App Host: #{host}\n" + capture(*app.exec("bin/rails", ENV["CMD"])) + "\n\n" }
+        on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec("bin/rails", ENV["CMD"])) + "\n\n" }
       end
 
       desc "Execute a custom task on the first defined server"
       task :once do
-        on(MRSK_CONFIG.primary_host) { |host| puts capture(*app.exec(ENV["CMD"])) }
+        on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec(ENV["CMD"])) }
       end
 
       namespace :once do
         desc "Execute Rails command on the first defined server, like CMD='runner \"puts %(Hello World)\""
         task :rails do
-          on(MRSK_CONFIG.primary_host) { puts capture(*app.exec("bin/rails", ENV["CMD"])) }
+          on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec("bin/rails", ENV["CMD"])) }
         end
       end
     end
 
     desc "List all the app containers currently on servers"
     task :containers do
-      on(MRSK_CONFIG.hosts) { |host| puts "App Host: #{host}\n" + capture(*app.list_containers) + "\n\n" }
+      on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.list_containers) + "\n\n" }
     end
 
-    desc "Tail logs from app containers"
+    desc "Show last 100 log lines from app on servers"
     task :logs do
-      on(MRSK_CONFIG.hosts) { execute *app.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 app containers and images from servers"
-    task remove: %i[ stop ] do
-      on(MRSK_CONFIG.hosts) do
-        execute *app.remove_containers
-        execute *app.remove_images
+    task remove: %w[ remove:containers remove:images ]
+
+    namespace :remove do
+      desc "Remove app containers from servers"
+      task :containers do
+        on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
+      end
+      
+      desc "Remove app images from servers"
+      task :images do
+        on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
       end
     end
   end

data/lib/tasks/mrsk/build.rake

@@ -0,0 +1,52 @@
+require_relative "setup"
+
+namespace :mrsk do
+  namespace :build do
+    desc "Deliver a newly built app image to servers"
+    task deliver: %i[ push pull ]
+
+    desc "Build locally and push app image to registry"
+    task :push do
+      run_locally do 
+        begin
+          debug "Using builder: #{MRSK.builder.name}"
+          info "Building image may take a while (run with VERBOSE=1 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 unless ENV["VERSION"]
+    end
+
+    desc "Pull app image from the registry onto servers"
+    task :pull do
+      on(MRSK.config.hosts) { execute *MRSK.builder.pull }
+    end
+
+    desc "Create a local build setup"
+    task :create do
+      run_locally do
+        debug "Using builder: #{MRSK.builder.name}"
+        execute *MRSK.builder.create
+      end
+    end
+
+    desc "Remove local build setup"
+    task :remove do
+      run_locally do
+        debug "Using builder: #{MRSK.builder.name}"
+        execute *MRSK.builder.remove
+      end
+    end
+
+    desc "Show the name of the configured builder"
+    task :info do
+      run_locally do
+        puts "Builder: #{MRSK.builder.name} (#{MRSK.builder.target.class.name})"
+        puts capture(*MRSK.builder.info)
+      end
+    end
+  end
+end

data/lib/tasks/mrsk/mrsk.rake

@@ -2,10 +2,10 @@ require_relative "setup"
 
 namespace :mrsk do
   desc "Deploy app for the first time to a fresh server"
-  task fresh: %w[ server:bootstrap registry:login app:deliver traefik:run app:stop app:run ]
+  task fresh: %w[ server:bootstrap registry:login build:deliver traefik:run app:stop app:run ]
 
   desc "Push the latest version of the app, ensure Traefik is running, then restart app"
-  task deploy: %w[ registry:login app:deliver traefik:run app:stop app:run prune ]
+  task deploy: %w[ registry:login build:deliver traefik:run app:stop app:run prune ]
 
   desc "Rollback to VERSION=x that was already run as a container on servers"
   task rollback: %w[ app:restart ]
@@ -16,9 +16,20 @@ namespace :mrsk do
   desc "Create config stub in config/deploy.yml"
   task :init do
     require "fileutils"
-    FileUtils.cp_r \
-      Pathname.new(File.expand_path("templates/deploy.yml", __dir__)),
-      Rails.root.join("config/deploy.yml")
+
+    if (deploy_file = Rails.root.join("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
+
+    if (binstub = Rails.root.join("bin/mrsk")).exist?
+      puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
+    else
+      FileUtils.cp_r Pathname.new(File.expand_path("templates/mrsk", __dir__)), binstub
+      puts "Created binstub file in bin/mrsk"
+    end
   end
 
   desc "Remove Traefik, app, and registry session from servers"

data/lib/tasks/mrsk/prune.rake

@@ -7,12 +7,12 @@ namespace :mrsk do
   namespace :prune do
     desc "Prune unused images older than 30 days"
     task :images do
-      on(MRSK_CONFIG.hosts) { execute "docker image prune -f --filter 'until=720h'" }
+      on(MRSK.config.hosts) { MRSK.verbosity(:debug) { execute *MRSK.prune.images } }
     end
 
     desc "Prune stopped containers for the service older than 3 days"
     task :containers do
-      on(MRSK_CONFIG.hosts) { execute "docker container prune -f --filter label=service=#{MRSK_CONFIG.service} --filter 'until=72h'" }
+      on(MRSK.config.hosts) { MRSK.verbosity(:debug) { execute *MRSK.prune.containers } }
     end
   end
 end

data/lib/tasks/mrsk/registry.rake

@@ -1,18 +1,16 @@
 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.hosts) { execute *registry.login }
+      run_locally           { execute *MRSK.registry.login }
+      on(MRSK.config.hosts) { execute *MRSK.registry.login }
     end
 
     desc "Logout of the registry remotely"
     task :logout do
-      on(MRSK_CONFIG.hosts) { execute *registry.logout }
+      on(MRSK.config.hosts) { execute *MRSK.registry.logout }
     end
   end
 end

data/lib/tasks/mrsk/server.rake

@@ -5,7 +5,7 @@ namespace :mrsk do
     desc "Setup Docker on the remote servers"
     task :bootstrap do
       # FIXME: Detect when apt-get is not available and use the appropriate alternative
-      on(MRSK_CONFIG.hosts) { execute "apt-get install docker.io -y" }
+      on(MRSK.config.hosts) { execute "apt-get install docker.io -y" }
     end
   end
 end

data/lib/tasks/mrsk/setup.rb

@@ -3,14 +3,4 @@ require "sshkit/dsl"
 
 include SSHKit::DSL
 
-if (config_file = Rails.root.join("config/deploy.yml")).exist?
-  MRSK_CONFIG = Mrsk::Configuration.load_file(config_file)
-
-  SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = MRSK_CONFIG.ssh_options }
-
-  # No need to use /usr/bin/env, just clogs up the logs
-  SSHKit.config.command_map[:docker] = "docker"
-else
-  # MRSK is missing config/deploy.yml – run 'rake mrsk:init'
-  MRSK_CONFIG = Mrsk::Configuration.new({}, validate: false)
-end
+MRSK = Mrsk::Commander.new config_file: Rails.root.join("config/deploy.yml"), verbose: ENV["VERBOSE"]

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

@@ -3,19 +3,22 @@
 service: my-app
 
 # Name of the container image
-image: user/chat
+image: user/my-app
 
-# All the servers targeted for deploy. You can reference a single server for a command by using SERVERS=xxx.xxx.xxx.xxx
+# All the servers targeted for deploy. You can reference a single server for a command by using SERVERS=192.168.0.1
 servers:
-  - xxx.xxx.xxx.xxx
+  - 192.168.0.1
 
 # The following envs are made available to the container when started
 env:
   # Remember never to put passwords or tokens directly into this file, use encrypted credentials
   # REDIS_URL: redis://x/y
 
+# Where your images will be hosted
 registry:
   # Specify the registry server, if you're not using Docker Hub
   # server: registry.digitalocean.com / ghcr.io / ...
-  username: <%= Rails.application.credentials.registry["username"] %>
-  password: <%= Rails.application.credentials.registry["password"] %>
+
+  # Set credentials with bin/rails credentials:edit
+  username: my-user
+  password: my-password-should-go-in-credentials

data/lib/tasks/mrsk/templates/mrsk

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if [ "${*}" == "" ]; then
+  # Improve so list matches
+  exec bin/rake -T mrsk
+else
+  exec bin/rake "mrsk:$@"
+fi

data/lib/tasks/mrsk/traefik.rake

@@ -1,22 +1,20 @@
 require_relative "setup"
 
-traefik = Mrsk::Commands::Traefik.new(MRSK_CONFIG)
-
 namespace :mrsk do
   namespace :traefik do
     desc "Run Traefik on servers"
     task :run do
-      on(MRSK_CONFIG.role(:web).hosts) { execute *traefik.run, raise_on_non_zero_exit: false }
+      on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
     end
 
     desc "Start existing Traefik on servers"
     task :start do
-      on(MRSK_CONFIG.role(:web).hosts) { execute *traefik.start, raise_on_non_zero_exit: false }
+      on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
     end
 
     desc "Stop Traefik on servers"
     task :stop do
-      on(MRSK_CONFIG.role(:web).hosts) { execute *traefik.stop, raise_on_non_zero_exit: false }
+      on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
     end
 
     desc "Restart Traefik on servers"
@@ -24,14 +22,19 @@ namespace :mrsk do
 
     desc "Display information about Traefik containers from servers"
     task :info do
-      on(MRSK_CONFIG.role(:web).hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*traefik.info) + "\n\n" }
+      on(MRSK.config.role(:web).hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.info) + "\n\n" }
+    end
+
+    desc "Show last 100 log lines from Traefik on servers"
+    task :logs do
+      on(MRSK.config.hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.logs) + "\n\n" }
     end
 
     desc "Remove Traefik container and image from servers"
     task remove: %i[ stop ] do
-      on(MRSK_CONFIG.role(:web).hosts) do
-        execute *traefik.remove_container
-        execute *traefik.remove_image
+      on(MRSK.config.role(:web).hosts) do
+        execute *MRSK.traefik.remove_container
+        execute *MRSK.traefik.remove_image
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -47,8 +47,15 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/mrsk.rb
+- lib/mrsk/commander.rb
 - lib/mrsk/commands.rb
 - lib/mrsk/commands/app.rb
+- lib/mrsk/commands/base.rb
+- lib/mrsk/commands/builder.rb
+- lib/mrsk/commands/builder/multiarch.rb
+- lib/mrsk/commands/builder/multiarch/remote.rb
+- lib/mrsk/commands/builder/native.rb
+- lib/mrsk/commands/prune.rb
 - lib/mrsk/commands/registry.rb
 - lib/mrsk/commands/traefik.rb
 - lib/mrsk/configuration.rb
@@ -56,12 +63,14 @@ files:
 - lib/mrsk/engine.rb
 - lib/mrsk/version.rb
 - lib/tasks/mrsk/app.rake
+- lib/tasks/mrsk/build.rake
 - lib/tasks/mrsk/mrsk.rake
 - lib/tasks/mrsk/prune.rake
 - lib/tasks/mrsk/registry.rake
 - lib/tasks/mrsk/server.rake
 - lib/tasks/mrsk/setup.rb
 - lib/tasks/mrsk/templates/deploy.yml
+- lib/tasks/mrsk/templates/mrsk
 - lib/tasks/mrsk/traefik.rake
 homepage: https://github.com/rails/mrsk
 licenses: