mrsk 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fccda4eb164533a6d31837fb7dbfc01eadb2ff51d6205d604a23c18c9acb594c
-  data.tar.gz: 94d1822f909dd32c3432d07fed8710b9476855b0bf47faf0bcca844058e0901e
+  metadata.gz: c57766d24180e114034c8c4e241eb2c5fd62774097b00b37f81bdf000643a078
+  data.tar.gz: cac9390c76fd4dad89a8dd37e099c64df29db16126a4417ea3ab7d9cae586055
 SHA512:
-  metadata.gz: f4343eb5062fc6d3da82d6b10e35940a2574aa5913da3104398f5272f5e695fe6b9b97da5cc0d59635ea9c6b2d0758615d77d0974d6a69e086c96ebb3f21cb5b
-  data.tar.gz: 360e59e8d5646b67e45f4576c9bec3d771e38a5eae96e53ea3489bc3f51fe7607542b8c92f74b9d7a59257b85976444c3e8b648fa7858be2dfdd5fe508a623da
+  metadata.gz: 6c5bfd3bc0663ada2ae40bd6f8298081d3bbfc7522002cd69ac564ff14d27819881bffdf5cbe7967d5cb7a7128341a8b500750e8dbae435432fca2c33d17680b
+  data.tar.gz: e82f424d51621b6460ec4b477799f31b265dbe0356f448f178c70c44eafd865fc326156a6be55f341f0a59294e50d40402cb98559ac1cad9ab58bbd840d4d51e

data/README.md

@@ -2,6 +2,8 @@
 
 MRSK deploys web apps anywhere from bare metal to cloud VMs using Docker with zero downtime. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is stopped. It works seamlessly across multiple hosts, using SSHKit to execute commands. It was built for Rails applications, but works with any type of web app that can be containerized with Docker.
 
+Watch the screencast: https://www.youtube.com/watch?v=LL1cV2FXZ5I
+
 ## Installation
 
 Install MRSK globally with `gem install mrsk`. Then, inside your app directory, run `mrsk init` (or `mrsk init --bundle` within Rails apps where you want a bin/mrsk binstub). Now edit the new file `config/deploy.yml`. It could look as simple as this:
@@ -47,21 +49,21 @@ Voila! All the servers are now serving the app on port 80. If you're just runnin
 
 ## Vision
 
-In the past decade+, there's been an explosion in commercial offerings that make deploying web apps easier. Heroku kicked it off with an incredible offering that stayed ahead of the competition seemingly forever. These days we have excellent alternatives like Fly.io and Render. And hosted Kubernetes is making things easier too on AWS, GCP, Digital Ocean, and elsewhere. But these are all offerings that have you renting computers in the cloud at a premium. If you want to run on our own hardware, or even just have a clear migration path to do so in the future, you need to carefully consider how locked in you get to these commercial platforms. Preferably before the bills swallow your business whole!
+In the past decade+, there's been an explosion in commercial offerings that make deploying web apps easier. Heroku kicked it off with an incredible offering that stayed ahead of the competition seemingly forever. These days we have excellent alternatives like Fly.io and Render. And hosted Kubernetes is making things easier too on AWS, GCP, Digital Ocean, and elsewhere. But these are all offerings that have you renting computers in the cloud at a premium. If you want to run on your own hardware, or even just have a clear migration path to do so in the future, you need to carefully consider how locked in you get to these commercial platforms. Preferably before the bills swallow your business whole!
 
 MRSK seeks to bring the advance in ergonomics pioneered by these commercial offerings to deploying web apps anywhere. Whether that's low-cost cloud options without the managed-service markup from the likes of Digital Ocean, Hetzner, OVH, etc, or it's your own colocated bare metal. To MRSK, it's all the same. Feed the config file a list of IP addresses with vanilla Ubuntu servers that have seen no prep beyond an added SSH key, and you'll be running in literally minutes.
 
-This approach gives you enormous portability. You can have your web app deployed on several clouds at ease like this. Or you can buy the baseline with your own hardware, then deploy to a cloud before a big seasonal spike to get more capacity. When you're not locked into a single provider from a tooling perspective, there's a lot of compelling options available.
+This approach gives you enormous portability. You can have your web app deployed on several clouds at ease like this. Or you can buy the baseline with your own hardware, then deploy to a cloud before a big seasonal spike to get more capacity. When you're not locked into a single provider from a tooling perspective, there are a lot of compelling options available.
 
 Ultimately, MRSK is meant to compress the complexity of going to production using open source tooling that isn't tied to any commercial offering. Not to zero, mind you. You're probably still better off with a fully managed service if basic Linux or Docker is still difficult, but as soon as those concepts are familiar, you'll be ready to go with MRSK.
 
 ## Why not just run Capistrano, Kubernetes or Docker Swarm?
 
-MRSK basically is Capistrano for Containers, without the need to carefully prepare servers in advance. No need to ensure that the servers have just the right version of Ruby or other dependencies you need. That all lives in the Docker image now. You can boot a brand new Ubuntu (or whatever) server, add it to the list servers in MRSK, and it'll be auto-provisioned with Docker, and run right away. Docker's layer caching also speeds up deployments with less mucking about on the server. And the images built for MRSK can be used for CI or later introspection.
+MRSK basically is Capistrano for Containers, without the need to carefully prepare servers in advance. No need to ensure that the servers have just the right version of Ruby or other dependencies you need. That all lives in the Docker image now. You can boot a brand new Ubuntu (or whatever) server, add it to the list of servers in MRSK, and it'll be auto-provisioned with Docker, and run right away. Docker's layer caching also speeds up deployments with less mucking about on the server. And the images built for MRSK can be used for CI or later introspection.
 
 Kubernetes is a beast. Running it yourself on your own hardware is not for the faint of heart. It's a fine option if you want to run on someone else's platform, either transparently [like Render](https://thenewstack.io/render-cloud-deployment-with-less-engineering/) or explicitly on AWS/GCP, but if you'd like the freedom to move between cloud and your own hardware, or even mix the two, MRSK is much simpler. You can see everything that's going on, it's just basic Docker commands being called.
 
-Docker Swarm is much simpler than Kubernetes, but it's still built on the same declarative model that uses state reconciliation. MRSK is intentionally designed to around imperative commands, like Capistrano.
+Docker Swarm is much simpler than Kubernetes, but it's still built on the same declarative model that uses state reconciliation. MRSK is intentionally designed around imperative commands, like Capistrano.
 
 Ultimately, there are a myriad of ways to deploy web apps, but this is the toolkit we're using at [37signals](https://37signals.com) to bring [HEY](https://www.hey.com) [home from the cloud](https://world.hey.com/dhh/why-we-re-leaving-the-cloud-654b47e0) without losing the advantages of modern containerization tooling.
 
@@ -78,6 +80,8 @@ DB_PASSWORD=secret123
 
 ### Using a generated .env file
 
+#### 1Password as a secret store
+
 If you're using a centralized secret store, like 1Password, you can create `.env.erb` as a template which looks up the secrets. Example of a .env.erb file:
 
 ```erb
@@ -93,6 +97,52 @@ This template can safely be checked into git. Then everyone deploying the app ca
 
 If you need separate env variables for different destinations, you can set them with `.env.destination.erb` for the template, which will generate `.env.staging` when run with `mrsk envify -d staging`.
 
+#### Bitwarden as a secret store
+
+If you are using open source secret store like bitwarden, you can create `.env.erb` as a template which looks up the secrets. 
+
+You can store `SOME_SECRET` in a secure note in bitwarden vault. 
+
+```
+$ bw list items --search SOME_SECRET | jq
+? Master password: [hidden]
+
+[
+  {
+    "object": "item",
+    "id": "123123123-1232-4224-222f-234234234234",
+    "organizationId": null,
+    "folderId": null,
+    "type": 2,
+    "reprompt": 0,
+    "name": "SOME_SECRET",
+    "notes": "yyy",
+    "favorite": false,
+    "secureNote": {
+      "type": 0
+    },
+    "collectionIds": [],
+    "revisionDate": "2023-02-28T23:54:47.868Z",
+    "creationDate": "2022-11-07T03:16:05.828Z",
+    "deletedDate": null
+  }
+]
+```
+
+and extract the `id` of `SOME_SECRET` from the `json` above and use in the `erb` below.
+
+
+Example `.env.erb` file:
+
+```erb
+<% if (session_token=`bw unlock --raw`.strip) != "" %># Generated by mrsk envify
+SOME_SECRET=<%= `bw get notes 123123123-1232-4224-222f-234234234234 --session #{session_token}` %>
+<% else raise ArgumentError, "session_token token missing" end %>
+```
+
+Then everyone deploying the app can run `mrsk envify` and mrsk will generate `.env` 
+
+
 ### Using another registry than Docker Hub
 
 The default registry is Docker Hub, but you can change it using `registry/server`:
@@ -100,10 +150,14 @@ The default registry is Docker Hub, but you can change it using `registry/server
 ```yaml
 registry:
   server: registry.digitalocean.com
-  username: registry-user-name
-  password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
+  username:  
+    - DOCKER_REGISTRY_TOKEN
+  password: 
+    - DOCKER_REGISTRY_TOKEN
 ```
 
+A reference to secret `DOCKER_REGISTRY_TOKEN` will look for `ENV["DOCKER_REGISTRY_TOKEN"]` on the machine running MRSK.
+
 ### Using a different SSH user than root
 
 The default SSH user is root, but you can change it using `ssh/user`:
@@ -228,9 +282,30 @@ servers:
       my-label: "50"
 ```
 
+### Using container options
+
+You can specialize the options used to start containers using the `options` definitions:
+
+```yaml
+servers:
+  web:
+    - 192.168.0.1
+    - 192.168.0.2
+  job:
+    hosts:
+      - 192.168.0.3
+      - 192.168.0.4
+    cmd: bin/jobs
+    options:
+      cap-add: true
+      cpu-count: 4
+```
+
+That'll start the job containers with `docker run ... --cap-add --cpu-count 4 ...`.
+
 ### Using remote builder for native multi-arch
 
-If you're developing on ARM64 (like Apple Silicon), but you want to deploy on AMD64 (x86 64-bit), you can use multi-archecture images. By default, MRSK will setup a local buildx configuration that does this through QEMU emulation. But this can be quite slow, especially on the first build.
+If you're developing on ARM64 (like Apple Silicon), but you want to deploy on AMD64 (x86 64-bit), you can use multi-architecture images. By default, MRSK will setup a local buildx configuration that does this through QEMU emulation. But this can be quite slow, especially on the first build.
 
 If you want to speed up this process by using a remote AMD64 host to natively build the AMD64 part of the image, while natively building the ARM64 part locally, you can do so using builder options:
 
@@ -268,9 +343,29 @@ builder:
 
 This is also a good option if you're running MRSK from a CI server that shares architecture with the deployment servers.
 
+### Using a different Dockerfile or context when building
+
+If you need to pass a different Dockerfile or context to the build command (e.g. if you're using a monorepo or you have
+different Dockerfiles), you can do so in the builder options:
+
+```yaml
+# Use a different Dockerfile
+builder:
+  dockerfile: Dockerfile.xyz
+
+# Set context
+builder:
+  context: ".."
+
+# Set Dockerfile and context
+builder:
+  dockerfile: "../Dockerfile.xyz"
+  context: ".."
+```
+
 ### Using build secrets for new images
 
-Some images need a secret passed in during build time, like a GITHUB_TOKEN to give access to private gem repositories. This can be done by having the secret in ENV, then referencing it in the builder configuration:
+Some images need a secret passed in during build time, like a GITHUB_TOKEN, to give access to private gem repositories. This can be done by having the secret in ENV, then referencing it in the builder configuration:
 
 ```yaml
 builder:
@@ -304,6 +399,15 @@ traefik:
 
 This will start the traefik container with `--accesslog=true accesslog.format=json`.
 
+### Traefik's host port binding
+
+By default Traefik binds to port 80 of the host machine, it can be configured to use an alternative port:
+
+```yaml
+traefik:
+  host_port: 8080
+```
+
 ### Configuring build args for new images
 
 Build arguments that aren't secret can also be configured:
@@ -317,7 +421,6 @@ builder:
 This build argument can then be used in the Dockerfile:
 
 ```
-# Private repositories need an access token during the build
 ARG RUBY_VERSION
 FROM ruby:$RUBY_VERSION-slim as base
 ```

data/lib/mrsk/cli/main.rb

@@ -11,7 +11,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
   desc "deploy", "Deploy app to servers"
   def deploy
     runtime = print_runtime do
-      say "Ensure Docker is installed...", :magenta
+      say "Ensure curl and Docker are installed...", :magenta
       invoke "mrsk:cli:server:bootstrap"
 
       say "Log into image registry...", :magenta
@@ -173,7 +173,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
   desc "registry", "Login and -out of the image registry"
   subcommand "registry", Mrsk::Cli::Registry
 
-  desc "server", "Bootstrap servers with Docker"
+  desc "server", "Bootstrap servers with curl and Docker"
   subcommand "server", Mrsk::Cli::Server
 
   desc "traefik", "Manage Traefik load balancer"

data/lib/mrsk/cli/server.rb

@@ -1,6 +1,15 @@
 class Mrsk::Cli::Server < Mrsk::Cli::Base
-  desc "bootstrap", "Ensure Docker is installed on servers"
+  desc "bootstrap", "Ensure curl and Docker are installed on servers"
   def bootstrap
-    on(MRSK.hosts + MRSK.accessory_hosts) { execute "which docker || (apt-get update -y && apt-get install docker.io -y)" }
+    on(MRSK.hosts + MRSK.accessory_hosts) do
+      dependencies_to_install = Array.new.tap do |dependencies|
+        dependencies << "curl" unless execute "which curl", raise_on_non_zero_exit: false
+        dependencies << "docker.io" unless execute "which docker", raise_on_non_zero_exit: false
+      end
+
+      if dependencies_to_install.any?
+        execute "apt-get update -y && apt-get install #{dependencies_to_install.join(" ")} -y)"
+      end
+    end
   end
 end

data/lib/mrsk/commander.rb

@@ -25,7 +25,7 @@ class Mrsk::Commander
   end
 
   def primary_host
-    specific_hosts&.sole || config.primary_web_host
+    specific_hosts&.first || config.primary_web_host
   end
 
   def hosts

data/lib/mrsk/commands/app.rb

@@ -10,6 +10,7 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
       *role.env_args,
       *config.volume_args,
       *role.label_args,
+      *role.option_args,
       config.absolute_image,
       role.cmd
   end

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

@@ -10,7 +10,11 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
   end
 
   def build_options
-    [ *build_tags, *build_labels, *build_args, *build_secrets ]
+    [ *build_tags, *build_labels, *build_args, *build_secrets, *build_dockerfile ]
+  end
+
+  def build_context
+    context
   end
 
   private
@@ -30,6 +34,10 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
       argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
     end
 
+    def build_dockerfile
+      argumentize "--file", dockerfile
+    end
+
     def args
       (config.builder && config.builder["args"]) || {}
     end
@@ -37,4 +45,12 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
     def secrets
       (config.builder && config.builder["secrets"]) || []
     end
+
+    def dockerfile
+      (config.builder && config.builder["dockerfile"]) || "Dockerfile"
+    end
+
+    def context
+      (config.builder && config.builder["context"]) || "."
+    end
 end

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

@@ -13,7 +13,7 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
       "--platform", "linux/amd64,linux/arm64",
       "--builder", builder_name,
       *build_options,
-      "."
+      build_context
   end
 
   def info

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

@@ -17,7 +17,7 @@ class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
       "--platform", platform,
       "--builder", builder_name,
       *build_options,
-      "."
+      build_context
   end
 
   def info

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

@@ -9,7 +9,7 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
 
   def push
     combine \
-      docker(:build, *build_options, "."),
+      docker(:build, *build_options, build_context),
       docker(:push, config.absolute_image)
   end
 

data/lib/mrsk/commands/registry.rb

@@ -2,7 +2,7 @@ class Mrsk::Commands::Registry < Mrsk::Commands::Base
   delegate :registry, to: :config
 
   def login
-    docker :login, registry["server"], "-u", redact(registry["username"]), "-p", redact(lookup_password)
+    docker :login, registry["server"], "-u", redact(lookup("username")), "-p", redact(lookup("password"))
   end
 
   def logout
@@ -10,11 +10,11 @@ class Mrsk::Commands::Registry < Mrsk::Commands::Base
   end
 
   private
-    def lookup_password
-      if registry["password"].is_a?(Array)
-        ENV.fetch(registry["password"].first).dup
+    def lookup(key)
+      if registry[key].is_a?(Array)
+        ENV.fetch(registry[key].first).dup
       else
-        registry["password"]
+        registry[key]
       end
     end
 end

data/lib/mrsk/commands/traefik.rb

@@ -1,15 +1,19 @@
 class Mrsk::Commands::Traefik < Mrsk::Commands::Base
+  delegate :optionize, to: Mrsk::Utils
+
+  CONTAINER_PORT = 80
+
   def run
     docker :run, "--name traefik",
       "--detach",
       "--restart", "unless-stopped",
       "--log-opt", "max-size=#{MAX_LOG_SIZE}",
-      "--publish", "80:80",
+      "--publish", port,
       "--volume", "/var/run/docker.sock:/var/run/docker.sock",
       "traefik",
       "--providers.docker",
       "--log.level=DEBUG",
-      *cmd_args
+      *cmd_option_args
   end
 
   def start
@@ -45,8 +49,20 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
     docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
   end
 
+  def port    
+    "#{host_port}:#{CONTAINER_PORT}"
+  end
+
   private
-    def cmd_args
-      (config.raw_config.dig(:traefik, "args") || { }).collect { |(key, value)| [ "--#{key}", value ] }.flatten
+    def cmd_option_args
+      if args = config.raw_config.dig(:traefik, "args")
+        optionize args
+      else
+        []
+      end
+    end
+
+    def host_port
+      config.raw_config.dig(:traefik, "host_port") || CONTAINER_PORT
     end
 end

data/lib/mrsk/configuration/role.rb

@@ -1,5 +1,5 @@
 class Mrsk::Configuration::Role
-  delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
+  delegate :argumentize, :argumentize_env_with_secrets, :optionize, to: Mrsk::Utils
 
   attr_accessor :name
 
@@ -35,6 +35,14 @@ class Mrsk::Configuration::Role
     specializations["cmd"]
   end
 
+  def option_args
+    if args = specializations["options"]
+      optionize args
+    else
+      []
+    end
+  end
+
   def running_traefik?
     name.web? || specializations["traefik"]
   end

data/lib/mrsk/utils.rb

@@ -5,7 +5,7 @@ module Mrsk::Utils
   def argumentize(argument, attributes, redacted: false)
     Array(attributes).flat_map do |key, value|
       if value.present?
-        escaped_pair = [ key, value.to_s.dump.gsub(/`/, '\\\\`') ].join("=")
+        escaped_pair = [ key, escape_shell_value(value) ].join("=")
         [ argument, redacted ? redact(escaped_pair) : escaped_pair ]
       else
         [ argument, key ]
@@ -23,8 +23,18 @@ module Mrsk::Utils
     end
   end
 
+  # Returns a list of shell-dashed option arguments. If the value is true, it's treated like a value-less option.
+  def optionize(args)
+    args.collect { |(key, value)| [ "--#{key}", value == true ? nil : escape_shell_value(value) ] }.flatten.compact
+  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
+
+  # Escape a value to make it safe for shell use.
+  def escape_shell_value(value)
+    value.to_s.dump.gsub(/`/, '\\\\`')
+  end
 end

data/lib/mrsk/version.rb

@@ -1,3 +1,3 @@
 module Mrsk
-  VERSION = "0.8.4"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrsk
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  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'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description:
 email: dhh@hey.com
 executables: