mrsk 0.1.0 → 0.2.0

data/lib/mrsk/cli/build.rb

@@ -9,22 +9,22 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
 
   desc "push", "Build locally and push app image to registry"
   def push
+    verbose = options[:verbose]
+
     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
+        MRSK.verbosity(:debug) { 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
+        MRSK.verbosity(:debug) { 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 }
+    on(MRSK.hosts) { execute *MRSK.builder.pull }
   end
 
   desc "create", "Create a local build setup"
@@ -46,7 +46,7 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
   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 "Builder: #{MRSK.builder.name}"
       puts capture(*MRSK.builder.info)
     end
   end

data/lib/mrsk/cli/main.rb

@@ -1,5 +1,6 @@
 require "mrsk/cli/base"
 
+require "mrsk/cli/accessory"
 require "mrsk/cli/app"
 require "mrsk/cli/build"
 require "mrsk/cli/prune"
@@ -32,7 +33,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
 
   desc "rollback [VERSION]", "Rollback the app to VERSION (that must already be on servers)"
   def rollback(version)
-    on(MRSK.config.hosts) do
+    on(MRSK.hosts) do
       execute *MRSK.app.stop, raise_on_non_zero_exit: false
       execute *MRSK.app.start(version: version)
     end
@@ -44,6 +45,13 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     invoke "mrsk:cli:app:details"
   end
 
+  desc "config", "Show combined config"
+  def config
+    run_locally do
+      pp MRSK.config.to_h
+    end
+  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
@@ -79,6 +87,9 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
     puts Mrsk::VERSION
   end
 
+  desc "accessory", "Manage the accessories"
+  subcommand "accessory", Mrsk::Cli::Accessory
+
   desc "app", "Manage the application"
   subcommand "app", Mrsk::Cli::App
 

data/lib/mrsk/cli/prune.rb

@@ -9,11 +9,11 @@ class Mrsk::Cli::Prune < Mrsk::Cli::Base
 
   desc "images", "Prune unused images older than 30 days"
   def images
-    on(MRSK.config.hosts) { execute *MRSK.prune.images }
+    on(MRSK.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 }
+    on(MRSK.hosts) { execute *MRSK.prune.containers }
   end
 end

data/lib/mrsk/cli/registry.rb

@@ -4,11 +4,15 @@ 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 }
+    on(MRSK.hosts) { execute *MRSK.registry.login }
+  rescue ArgumentError => e
+    puts e.message
   end
 
   desc "logout", "Logout of the registry remotely"
   def logout
-    on(MRSK.config.hosts) { execute *MRSK.registry.logout }
+    on(MRSK.hosts) { execute *MRSK.registry.logout }
+  rescue ArgumentError => e
+    puts e.message
   end
 end

data/lib/mrsk/cli/server.rb

@@ -3,6 +3,6 @@ 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" }
+    on(MRSK.hosts) { execute "which docker || (apt-get update -y && apt-get install docker.io -y)" }
   end
 end

data/lib/mrsk/cli/traefik.rb

@@ -3,17 +3,24 @@ 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 }
+    on(MRSK.traefik_hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
+  end
+
+  desc "reboot", "Reboot Traefik on servers (stop container, remove container, start new container)"
+  def reboot
+    invoke :stop
+    invoke :remove_container
+    invoke :boot
   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 }
+    on(MRSK.traefik_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 }
+    on(MRSK.traefik_hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
   end
 
   desc "restart", "Restart Traefik on servers"
@@ -24,21 +31,47 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
 
   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" }
+    on(MRSK.traefik_hosts) { |host| puts_by_host host, capture_with_info(*MRSK.traefik.info), type: "Traefik" }
   end
 
-  desc "logs", "Show last 100 log lines from Traefik on servers"
+  desc "logs", "Show log lines from Traefik on servers"
+  option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
+  option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
+  option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
+  option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
   def logs
-    on(MRSK.config.hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.logs) + "\n\n" }
+    grep = options[:grep]
+
+    if options[:follow]
+      run_locally do
+        info "Following logs on #{MRSK.primary_host}..."
+        info MRSK.traefik.follow_logs(host: MRSK.primary_host, grep: grep)
+        exec MRSK.traefik.follow_logs(host: MRSK.primary_host, grep: grep)
+      end
+    else
+      since = options[:since]
+      lines = options[:lines]
+
+      on(MRSK.traefik_hosts) do |host|
+        puts_by_host host, capture(*MRSK.traefik.logs(since: since, lines: lines, grep: grep)), type: "Traefik"
+      end
+    end
   end
 
   desc "remove", "Remove Traefik container and image from servers"
   def remove
     invoke :stop
+    invoke :remove_container
+    invoke :remove_image
+  end
 
-    on(MRSK.config.role(:web).hosts) do
-      execute *MRSK.traefik.remove_container
-      execute *MRSK.traefik.remove_image
-    end
+  desc "remove_container", "Remove Traefik container from servers"
+  def remove_container
+    on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_container }
+  end
+
+  desc "remove_container", "Remove Traefik image from servers"
+  def remove_image
+    on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_image }
   end
 end

data/lib/mrsk/cli.rb

@@ -1,9 +1,9 @@
 require "mrsk"
 
-MRSK = Mrsk::Commander.new \
-  config_file: Pathname.new(File.expand_path("config/deploy.yml"))
-
 module Mrsk::Cli
 end
 
+# SSHKit uses instance eval, so we need a global const for ergonomics
+MRSK = Mrsk::Commander.new
+
 require "mrsk/cli/main"

data/lib/mrsk/commander.rb

@@ -1,4 +1,7 @@
+require "active_support/core_ext/enumerable"
+
 require "mrsk/configuration"
+require "mrsk/commands/accessory"
 require "mrsk/commands/app"
 require "mrsk/commands/builder"
 require "mrsk/commands/prune"
@@ -6,15 +9,43 @@ require "mrsk/commands/traefik"
 require "mrsk/commands/registry"
 
 class Mrsk::Commander
-  attr_reader :config
-  attr_accessor :verbose
+  attr_accessor :config_file, :destination, :verbose, :version
 
-  def initialize(config_file:)
-    @config_file = config_file
+  def initialize(config_file: nil, destination: nil, verbose: false)
+    @config_file, @destination, @verbose = config_file, destination, verbose
   end
 
   def config
-    @config ||= Mrsk::Configuration.load_file(@config_file).tap { |config| setup_with(config) }
+    @config ||= \
+      Mrsk::Configuration
+        .create_from(config_file, destination: destination, version: cascading_version)
+        .tap { |config| configure_sshkit_with(config) }
+  end
+
+  attr_accessor :specific_hosts
+
+  def specific_primary!
+    self.specific_hosts = [ config.primary_web_host ]
+  end
+
+  def specific_roles=(role_names)
+    self.specific_hosts = config.roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts) if role_names.present?
+  end
+
+  def primary_host
+    specific_hosts&.sole || config.primary_web_host
+  end
+
+  def hosts
+    specific_hosts || config.all_hosts
+  end
+
+  def traefik_hosts
+    specific_hosts || config.traefik_hosts
+  end
+
+  def accessory_hosts
+    specific_hosts || config.accessories.collect(&:host)
   end
 
 
@@ -38,6 +69,10 @@ class Mrsk::Commander
     @prune ||= Mrsk::Commands::Prune.new(config)
   end
 
+  def accessory(name)
+    (@accessories ||= {})[name] ||= Mrsk::Commands::Accessory.new(config, name: name)
+  end
+
 
   def verbosity(level) 
     old_level = SSHKit.config.output_verbosity
@@ -48,8 +83,12 @@ class Mrsk::Commander
   end
 
   private
+    def cascading_version
+      version.presence || ENV["VERSION"] || `git rev-parse HEAD`.strip
+    end
+
     # Lazy setup of SSHKit
-    def setup_with(config)
+    def configure_sshkit_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

data/lib/mrsk/commands/accessory.rb

@@ -0,0 +1,61 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Accessory < Mrsk::Commands::Base
+  attr_reader :accessory_config
+  delegate :service_name, :image, :host, :port, :env_args, :volume_args, :label_args, to: :accessory_config
+
+  def initialize(config, name:)
+    super(config)
+    @accessory_config = config.accessory(name)
+  end
+
+  def run
+    docker :run, 
+      "--name", service_name,
+      "-d",
+      "--restart", "unless-stopped",
+      "-p", port,
+      *env_args,
+      *volume_args,
+      *label_args,
+      image
+  end
+
+  def start
+    docker :container, :start, service_name
+  end
+
+  def stop
+    docker :container, :stop, service_name
+  end
+
+  def info
+    docker :ps, *service_filter
+  end
+
+  def logs(since: nil, lines: nil, grep: nil)
+    pipe \
+      docker(:logs, service_name, (" --since #{since}" if since), (" -n #{lines}" if lines), "-t", "2>&1"),
+      ("grep '#{grep}'" if grep)
+  end
+
+  def follow_logs(grep: nil)
+    run_over_ssh pipe(
+      docker(:logs, service_name, "-t", "-n", "10", "-f", "2>&1"),
+      ("grep '#{grep}'" if grep)
+    ).join(" "), host: host
+  end
+
+  def remove_container
+    docker :container, :prune, "-f", *service_filter
+  end
+
+  def remove_image
+    docker :image, :prune, "-a", "-f", *service_filter
+  end
+
+  private
+    def service_filter
+      [ "--filter", "label=service=#{service_name}" ]
+    end
+end

data/lib/mrsk/commands/app.rb

@@ -8,8 +8,9 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
       "-d",
       "--restart unless-stopped",
       "--name", config.service_with_version,
-      "-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
-      *config.env_args,
+      *rails_master_key_arg,
+      *role.env_args,
+      *config.volume_args,
       *role.label_args,
       config.absolute_image,
       role.cmd
@@ -19,29 +20,60 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
     docker :start, "#{config.service}-#{version}"
   end
 
+  def current_container_id
+    docker :ps, "-q", *service_filter
+  end
+
   def stop
-    [ "docker ps -q #{service_filter.join(" ")} | xargs docker stop" ]
+    pipe current_container_id, "xargs docker stop"
   end
 
   def info
     docker :ps, *service_filter
   end
 
-  def logs
-    [ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -n 100 -t" ]
+  def logs(since: nil, lines: nil, grep: nil)
+    pipe \
+      current_container_id,
+      "xargs docker logs#{" --since #{since}" if since}#{" -n #{lines}" if lines} -t 2>&1",
+      ("grep '#{grep}'" if grep)
   end
 
   def exec(*command, interactive: false)
     docker :exec,
       ("-it" if interactive),
-      "-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
+      *rails_master_key_arg,
       *config.env_args,
+      *config.volume_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(" ")}'"
+  def run_exec(*command, interactive: false)
+    docker :run,
+      ("-it" if interactive),
+      "--rm",
+      *rails_master_key_arg,
+      *config.env_args,
+      *config.volume_args,
+      config.absolute_image,
+      *command
+  end
+
+  def follow_logs(host:, grep: nil)
+    run_over_ssh pipe(
+      current_container_id,
+      "xargs docker logs -t -n 10 -f 2>&1",
+      ("grep '#{grep}'" if grep)
+    ).join(" "), host: host
+  end
+
+  def console(host:)
+    exec_over_ssh "bin/rails", "c", host: host
+  end
+
+  def bash(host:)
+    exec_over_ssh "bash", host: host
   end
 
   def list_containers
@@ -57,7 +89,15 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
   end
 
   private
+    def exec_over_ssh(*command, host:)
+      run_over_ssh run_exec(*command, interactive: true).join(" "), host: host
+    end
+
     def service_filter
       [ "--filter", "label=service=#{config.service}" ]
     end
+
+    def rails_master_key_arg
+      [ "-e", redact("RAILS_MASTER_KEY=#{config.master_key}") ]
+    end
 end

data/lib/mrsk/commands/base.rb

@@ -1,7 +1,7 @@
-require "sshkit"
-
 module Mrsk::Commands
   class Base
+    delegate :redact, to: Mrsk::Utils
+
     attr_accessor :config
 
     def initialize(config)
@@ -9,19 +9,23 @@ module Mrsk::Commands
     end
 
     private
-      def combine(*commands)
+      def combine(*commands, by: "&&")
         commands
-          .collect { |command| command + [ "&&" ] }.flatten # Join commands with &&
-          .tap     { |commands| commands.pop } # Remove trailing &&
+          .compact
+          .collect { |command| Array(command) + [ by ] }.flatten # Join commands
+          .tap     { |commands| commands.pop } # Remove trailing combiner
+      end
+
+      def pipe(*commands)
+        combine *commands, by: "|"
       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      
+      def run_over_ssh(command, host:)
+        "ssh -t #{config.ssh_user}@#{host} '#{command}'"
+      end
   end
 end

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

@@ -0,0 +1,26 @@
+require "mrsk/commands/base"
+
+class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
+  delegate :argumentize, to: Mrsk::Utils
+
+  def pull
+    docker :pull, config.absolute_image
+  end
+
+  def build_args
+    argumentize "--build-arg", args, redacted: true
+  end
+
+  def build_secrets
+    argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
+  end
+
+  private
+    def args
+      (config.builder && config.builder["args"]) || {}
+    end
+
+    def secrets
+      (config.builder && config.builder["secrets"]) || []
+    end
+end

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

@@ -15,8 +15,16 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
   end
 
   private
+    def builder_name
+      super + "-remote"
+    end
+
+    def builder_name_with_arch(arch)
+      "#{builder_name}-#{arch}"
+    end
+
     def create_local_buildx
-      docker :buildx, :create, "--use", "--name", builder_name, builder_name_with_arch(local["arch"]), "--platform", "linux/#{local["arch"]}"
+      docker :buildx, :create, "--name", builder_name, builder_name_with_arch(local["arch"]), "--platform", "linux/#{local["arch"]}"
     end
 
     def append_remote_buildx
@@ -50,9 +58,4 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
     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

@@ -1,6 +1,6 @@
-require "mrsk/commands/base"
+require "mrsk/commands/builder/base"
 
-class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
+class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
   def create
     docker :buildx, :create, "--use", "--name", builder_name
   end
@@ -10,11 +10,14 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
   end
 
   def push
-    docker :buildx, :build, "--push", "--platform linux/amd64,linux/arm64", "-t", config.absolute_image, "."
-  end
-
-  def pull
-    docker :pull, config.absolute_image
+    docker :buildx, :build,
+      "--push",
+      "--platform", "linux/amd64,linux/arm64",
+      "--builder", builder_name,
+      "-t", config.absolute_image,
+      *build_args,
+      *build_secrets,
+      "."
   end
 
   def info
@@ -25,6 +28,6 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
 
   private
     def builder_name
-      "mrsk-#{config.service}"
+      "mrsk-#{config.service}-multiarch"
     end
 end

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

@@ -0,0 +1,71 @@
+require "mrsk/commands/builder/native"
+
+class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
+  def create
+    combine \
+      create_context,
+      create_buildx
+  end
+
+  def remove
+    combine \
+      remove_context,
+      remove_buildx
+  end
+
+  def push
+    docker :buildx, :build,
+      "--push",
+      "--platform", platform,
+      "--builder", builder_name,
+      "-t", config.absolute_image,
+      *build_args,
+      *build_secrets,
+      "."
+  end
+
+  def info
+    combine \
+      docker(:context, :ls),
+      docker(:buildx, :ls)
+  end
+
+
+  private
+    def arch
+      config.builder["remote"]["arch"]
+    end
+
+    def host
+      config.builder["remote"]["host"]
+    end
+
+    def builder_name
+      "mrsk-#{config.service}-native-remote"
+    end
+
+    def builder_name_with_arch
+      "#{builder_name}-#{arch}"
+    end
+
+    def platform
+      "linux/#{arch}"
+    end
+
+    def create_context
+      docker :context, :create,
+        builder_name_with_arch, "--description", "'#{builder_name} #{arch} native host'", "--docker", "'host=#{host}'"
+    end
+
+    def remove_context
+      docker :context, :rm, builder_name_with_arch
+    end
+
+    def create_buildx
+      docker :buildx, :create, "--name", builder_name, builder_name_with_arch, "--platform", platform
+    end
+
+    def remove_buildx
+      docker :buildx, :rm, builder_name
+    end
+end

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

@@ -1,6 +1,6 @@
-require "mrsk/commands/base"
+require "mrsk/commands/builder/base"
 
-class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
+class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
   def create
     # No-op on native
   end
@@ -11,14 +11,10 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
 
   def push
     combine \
-      docker(:build, "-t", config.absolute_image, "."),
+      docker(:build, "-t", *build_args, *build_secrets, config.absolute_image, "."),
       docker(:push, config.absolute_image)
   end
 
-  def pull
-    docker :pull, config.absolute_image
-  end
-
   def info
     # No-op on native
   end