mrsk 0.0.2 → 0.1.0

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

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

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

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)
 
@@ -23,8 +15,8 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
       role.cmd
   end
 
-  def start
-    docker :start, config.service_with_version
+  def start(version: config.version)
+    docker :start, "#{config.service}-#{version}"
   end
 
   def stop
@@ -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(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

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,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

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

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

@@ -1,9 +1,11 @@
 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, :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,15 +77,23 @@ 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
-    ENV["RAILS_MASTER_KEY"] || File.read(Rails.root.join("config/master.key"))
+    ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
   end
 
 

data/lib/mrsk/version.rb

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

data/lib/mrsk.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
@@ -38,31 +38,55 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description:
 email: dhh@hey.com
-executables: []
+executables:
+- mrsk
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- bin/mrsk
 - lib/mrsk.rb
+- lib/mrsk/cli.rb
+- lib/mrsk/cli/app.rb
+- lib/mrsk/cli/base.rb
+- lib/mrsk/cli/build.rb
+- lib/mrsk/cli/main.rb
+- lib/mrsk/cli/prune.rb
+- lib/mrsk/cli/registry.rb
+- lib/mrsk/cli/server.rb
+- lib/mrsk/cli/templates/deploy.yml
+- lib/mrsk/cli/traefik.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
 - lib/mrsk/configuration/role.rb
-- lib/mrsk/engine.rb
 - lib/mrsk/version.rb
-- lib/tasks/mrsk/app.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/traefik.rake
 homepage: https://github.com/rails/mrsk
 licenses:
 - MIT
@@ -85,5 +109,5 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
-summary: Deploy Docker containers with zero downtime to any host.
+summary: Deploy Rails apps in containers to servers running Docker with zero downtime.
 test_files: []

data/lib/mrsk/engine.rb

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