mrsk 0.0.1 → 0.0.3

data/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 " + 
-      "--rm -d " +
-      "-p 80:80 " +
-      "-v /var/run/docker.sock:/var/run/docker.sock " +
-      "traefik --providers.docker"
+    docker :container, :start, "traefik"
   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

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

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

data/lib/mrsk/configuration.rb

@@ -1,60 +1,100 @@
 require "active_support/ordered_options"
+require "active_support/core_ext/string/inquiry"
+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
+
+  class << self
+    def load_file(file)
+      if file.exist?
+        new YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
+      else
+        raise "Configuration file not found in #{file}"
+      end
+    end
 
-  def self.load_file(file)
-    if file.exist?
-      new YAML.load_file(file).symbolize_keys
-    else
-      raise "Configuration file not found in #{file}"
+    def argumentize(argument, attributes)
+      attributes.flat_map { |k, v| [ argument, "#{k}=#{v}" ] }
     end
   end
 
-  def initialize(config)
+  def initialize(config, validate: true)
     @config = ActiveSupport::InheritableOptions.new(config)
-    ensure_required_keys_present
+    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 servers
-    ENV["SERVERS"] || config.servers
+  def primary_host
+    role(:web).hosts.first
   end
 
+
   def version
     @version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
   end
 
-  def absolute_image
-    [ config.registry["server"], image_with_version ].compact.join("/")
+  def repository
+    [ config.registry["server"], image ].compact.join("/")
   end
 
-  def image_with_version
-    "#{image}:#{version}"
+  def absolute_image
+    "#{repository}:#{version}"
   end
 
   def service_with_version
     "#{service}-#{version}"
   end
 
-  def envs
-    parameterize "-e", \
-      { "RAILS_MASTER_KEY" => master_key }.merge(env || {})
+
+  def env_args
+    if config.env.present?
+      self.class.argumentize "-e", config.env
+    else
+      []
+    end
   end
 
-  def labels
-    parameterize "--label", \
-      "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"
+  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"))
+  end
+
+
   private
     attr_accessor :config
 
@@ -68,11 +108,9 @@ class Mrsk::Configuration
       end      
     end
 
-    def parameterize(param, hash)
-      hash.collect { |k, v| "#{param} #{k}=#{v}" }.join(" ")
-    end
-
-    def master_key
-      ENV["RAILS_MASTER_KEY"] || File.read(Rails.root.join("config/master.key"))
+    def role_names
+      config.servers.is_a?(Array) ? [ "web" ] : config.servers.keys.sort
     end
 end
+
+require "mrsk/configuration/role"

data/lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.0.1"
+  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,31 +1,97 @@
 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 }
+    desc "Run app on servers (or start them if they've already been run)"
+    task :run do
+      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 app on servers"
+    desc "Start existing app on servers (use VERSION=<git-hash> to designate which version)"
     task :start do
-      on(MRSK_CONFIG.servers) { execute app.start }
+      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.servers) { 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 "Restart app on servers"
+    desc "Start app on servers (use VERSION=<git-hash> to designate which version)"
     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" }
+      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(*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(*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) { 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(*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(*MRSK.app.list_containers) + "\n\n" }
+    end
+
+    desc "Show last 100 log lines from app on servers"
+    task :logs do
+      # 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: %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
 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

@@ -1,12 +1,37 @@
+require_relative "setup"
+
 namespace :mrsk do
+  desc "Deploy app for the first time to a fresh server"
+  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: [ "app:push", "traefik:start", "app:restart" ]
+  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 ]
 
   desc "Display information about Traefik and app containers"
-  task info: [ "traefik:info", "app:info" ]
+  task info: %w[ traefik:info app:info ]
 
-  desc "Create config stub"
+  desc "Create config stub in config/deploy.yml"
   task :init do
-    Rails.root.join("config/deploy.yml")
+    require "fileutils"
+
+    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"
+  task remove: %w[ traefik:remove app:remove registry:logout ]
 end

data/lib/tasks/mrsk/prune.rake

@@ -0,0 +1,18 @@
+require_relative "setup"
+
+namespace :mrsk do
+  desc "Prune unused images and stopped containers"
+  task prune: %w[ prune:containers prune:images ]
+
+  namespace :prune do
+    desc "Prune unused images older than 30 days"
+    task :images do
+      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) { MRSK.verbosity(:debug) { execute *MRSK.prune.containers } }
+    end
+  end
+end

data/lib/tasks/mrsk/registry.rake

@@ -1,13 +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.servers) { 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 *MRSK.registry.logout }
     end
   end
 end

data/lib/tasks/mrsk/server.rake

@@ -0,0 +1,11 @@
+require_relative "setup"
+
+namespace :mrsk do
+  namespace :server 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" }
+    end
+  end
+end

data/lib/tasks/mrsk/setup.rb

@@ -3,6 +3,4 @@ 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 }
+MRSK = Mrsk::Commander.new config_file: Rails.root.join("config/deploy.yml"), verbose: ENV["VERBOSE"]

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

@@ -0,0 +1,24 @@
+# Name of your application will be used for 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
+
+# All the servers targeted for deploy. You can reference a single server for a command by using SERVERS=192.168.0.1
+servers:
+  - 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 / ...
+
+  # 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,25 +1,41 @@
 require_relative "setup"
 
-traefik = Mrsk::Commands::Traefik.new(MRSK_CONFIG)
-
 namespace :mrsk do
   namespace :traefik do
-    desc "Start Traefik"
+    desc "Run Traefik on servers"
+    task :run do
+      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.servers) { 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"
+    desc "Stop Traefik on servers"
     task :stop do
-      on(MRSK_CONFIG.servers) { 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"
+    desc "Restart Traefik on servers"
     task restart: %i[ stop start ]
 
-    desc "Display information about Traefik containers"
+    desc "Display information about Traefik containers from servers"
     task :info do
-      on(MRSK_CONFIG.servers) { |host| puts "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 *MRSK.traefik.remove_container
+        execute *MRSK.traefik.remove_image
+      end
     end
   end
 end