mrsk 0.0.3 → 0.2.0

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-23 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,40 +38,62 @@ 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/accessory.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/accessory.rb
 - lib/mrsk/commands/app.rb
 - lib/mrsk/commands/base.rb
 - lib/mrsk/commands/builder.rb
+- lib/mrsk/commands/builder/base.rb
 - lib/mrsk/commands/builder/multiarch.rb
 - lib/mrsk/commands/builder/multiarch/remote.rb
 - lib/mrsk/commands/builder/native.rb
+- lib/mrsk/commands/builder/native/remote.rb
 - lib/mrsk/commands/prune.rb
 - lib/mrsk/commands/registry.rb
 - lib/mrsk/commands/traefik.rb
 - lib/mrsk/configuration.rb
+- lib/mrsk/configuration/accessory.rb
 - lib/mrsk/configuration/role.rb
-- lib/mrsk/engine.rb
+- lib/mrsk/sshkit_with_ext.rb
+- lib/mrsk/utils.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:
 - MIT
@@ -94,5 +116,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

data/lib/tasks/mrsk/app.rake

@@ -1,97 +0,0 @@
-require_relative "setup"
-
-namespace :mrsk do
-  namespace :app do
-    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 existing app on servers (use VERSION=<git-hash> to designate which version)"
-    task :start do
-      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 *MRSK.app.stop, raise_on_non_zero_exit: false }
-    end
-
-    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.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

@@ -1,52 +0,0 @@
-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,37 +0,0 @@
-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: %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: %w[ traefik:info app:info ]
-
-  desc "Create config stub in config/deploy.yml"
-  task :init do
-    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

@@ -1,18 +0,0 @@
-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,16 +0,0 @@
-require_relative "setup"
-
-namespace :mrsk do
-  namespace :registry do
-    desc "Login to the registry locally and remotely"
-    task :login do
-      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

@@ -1,11 +0,0 @@
-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

@@ -1,6 +0,0 @@
-require "sshkit"
-require "sshkit/dsl"
-
-include SSHKit::DSL
-
-MRSK = Mrsk::Commander.new config_file: Rails.root.join("config/deploy.yml"), verbose: ENV["VERBOSE"]

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

@@ -1,24 +0,0 @@
-# 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

@@ -1,8 +0,0 @@
-#!/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,41 +0,0 @@
-require_relative "setup"
-
-namespace :mrsk do
-  namespace :traefik do
-    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.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 *MRSK.traefik.stop, raise_on_non_zero_exit: false }
-    end
-
-    desc "Restart Traefik on servers"
-    task restart: %i[ stop start ]
-
-    desc "Display information about Traefik containers from servers"
-    task :info do
-      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