mrsk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce03312fed10073e6fd3d8fe805a1088ff759674368032ef27cdc88cf1ed5658
+  data.tar.gz: e686e5c333552e06af7fedcf25a9d03ab55e0bfc12a92a40782fae4649917a8c
+SHA512:
+  metadata.gz: 5cb4e0842dccb3ebccc1e156e86151d471d3b6ab4f902a0e206f9942ab920df512cbe4c467bd052fc04aec89723c8af27bfdd70b1f6fb37d94a39e44d0fbcf03
+  data.tar.gz: 79396a77da9f1d7b4bed0658f894f3bec0e8bbf6498f4d54b15b265e599a0d8594f46963b1064d483971b2840df5a4366f3cb880d675fd41433e89bde17f4cd6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# MRSK
+
+MRSK lets you do zero-downtime deploys of Rails apps packed as containers to any host running Docker. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is wound down. It works across multiple hosts at the same time, using SSHKit to execute commands.
+
+## Installation
+
+Create a configuration file for MRSK in `config/deploy.yml` that looks like this:
+
+```yaml
+service: my-app
+image: name/my-app
+servers:
+  - xxx.xxx.xxx.xxx
+  - xxx.xxx.xxx.xxx
+env:
+  DATABASE_URL: mysql2://username@localhost/database_name/
+  REDIS_URL: redis://host:6379/1
+```
+
+Then first login to the Docker Hub registry on the servers:
+
+```
+rake mrsk:registry:login DOCKER_USER=name DOCKER_PASSWORD=pw
+```
+
+Now you're ready to deploy a multi-arch image (FIXME: currently you need to manually run `docker buildx create --use` once first):
+
+```
+rake mrsk:deploy
+```
+
+This will:
+
+1. Build the image using the standard Dockerfile in the root of the application.
+2. Push the image to the registry.
+3. Pull the image on all the servers.
+4. Ensure Traefik is running and accepting traffic on port 80.
+5. Stop any containers running a previous versions of the app.
+6. Start a new container with the version of the app that matches the current git version hash.
+
+Voila! All the servers are now serving the app on port 80, and you're ready to put them behind a load balancer to serve live traffic.
+
+## Stage of development
+
+This is alpha software. Lots of stuff is missing. Here are some of the areas we seek to improve:
+
+- Use of other registries than Docker Hub
+- Adapterize commands to work with Podman and other container runners
+- Better flow for secrets and ENV
+- Possibly switching to a bin/mrsk command rather than raw rake
+- Integrate wirmth cloud CI pipelines
+
+## License
+
+Mrsk is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/mrsk/commands/app.rb

@@ -0,0 +1,22 @@
+class Mrsk::Commands::App < Mrsk::Commands::Base
+  def push
+    # TODO: Run 'docker buildx create --use' when needed
+    "docker buildx build --push --platform=linux/amd64,linux/arm64 -t #{config.absolute_image} ."
+  end
+
+  def pull
+    "docker pull #{config.absolute_image}"
+  end
+
+  def start
+    "docker run -d --rm --name #{config.service_with_version} #{config.envs} #{config.labels} #{config.absolute_image}"
+  end
+
+  def stop
+    "docker ps -q --filter label=service=#{config.service} | xargs docker stop"
+  end
+
+  def info
+    "docker ps --filter label=service=#{config.service}"
+  end
+end

data/lib/mrsk/commands/registry.rb

@@ -0,0 +1,5 @@
+class Mrsk::Commands::Registry < Mrsk::Commands::Base
+  def login
+    "docker login #{config.registry["server"]} -u #{config.registry["username"]} -p #{config.registry["password"]}"
+  end
+end

data/lib/mrsk/commands/traefik.rb

@@ -0,0 +1,17 @@
+class Mrsk::Commands::Traefik < Mrsk::Commands::Base
+  def start
+    "docker run --name traefik " + 
+      "--rm -d " +
+      "-p 80:80 " +
+      "-v /var/run/docker.sock:/var/run/docker.sock " +
+      "traefik --providers.docker"
+  end
+
+  def stop
+    "docker container stop traefik"
+  end
+
+  def info
+    "docker ps --filter name=traefik"
+  end
+end

data/lib/mrsk/commands.rb

@@ -0,0 +1,13 @@
+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.rb

@@ -0,0 +1,78 @@
+require "active_support/ordered_options"
+
+class Mrsk::Configuration
+  delegate :service, :image, :env, :registry, :ssh_user, to: :config, allow_nil: true
+
+  def self.load_file(file)
+    if file.exist?
+      new YAML.load_file(file).symbolize_keys
+    else
+      raise "Configuration file not found in #{file}"
+    end
+  end
+
+  def initialize(config)
+    @config = ActiveSupport::InheritableOptions.new(config)
+    ensure_required_keys_present
+  end
+
+  def servers
+    ENV["SERVERS"] || config.servers
+  end
+
+  def version
+    @version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
+  end
+
+  def absolute_image
+    [ config.registry["server"], image_with_version ].compact.join("/")
+  end
+
+  def image_with_version
+    "#{image}:#{version}"
+  end
+
+  def service_with_version
+    "#{service}-#{version}"
+  end
+
+  def envs
+    parameterize "-e", \
+      { "RAILS_MASTER_KEY" => master_key }.merge(env || {})
+  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"
+  end
+
+  def ssh_options
+    { user: config.ssh_user || "root", auth_methods: [ "publickey" ] }
+  end
+
+  private
+    attr_accessor :config
+
+    def ensure_required_keys_present
+      %i[ service image registry ].each do |key|
+        raise ArgumentError, "Missing required configuration for #{key}" unless config[key].present?
+      end
+
+      %w[ username password ].each do |key|
+        raise ArgumentError, "Missing required configuration for registry/#{key}" unless config.registry[key].present?
+      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"))
+    end
+end

data/lib/mrsk/engine.rb

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

data/lib/mrsk/version.rb

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

data/lib/mrsk.rb

@@ -0,0 +1,8 @@
+module Mrsk
+end
+
+require "mrsk/version"
+require "mrsk/engine"
+
+require "mrsk/configuration"
+require "mrsk/commands"

data/lib/tasks/mrsk/app.rake

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

data/lib/tasks/mrsk/mrsk.rake

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

data/lib/tasks/mrsk/registry.rake

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

data/lib/tasks/mrsk/setup.rb

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

data/lib/tasks/mrsk/traefik.rake

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: mrsk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email: dhh@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/mrsk.rb
+- lib/mrsk/commands.rb
+- lib/mrsk/commands/app.rb
+- lib/mrsk/commands/registry.rb
+- lib/mrsk/commands/traefik.rb
+- lib/mrsk/configuration.rb
+- lib/mrsk/engine.rb
+- lib/mrsk/version.rb
+- lib/tasks/mrsk/app.rake
+- lib/tasks/mrsk/mrsk.rake
+- lib/tasks/mrsk/registry.rake
+- lib/tasks/mrsk/setup.rb
+- lib/tasks/mrsk/traefik.rake
+homepage: https://github.com/rails/mrsk
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Deploy Docker containers with zero downtime to any host.
+test_files: []