Compare commits
88 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4b0a8728f1 | ||
|
|
3075f8daf1 | ||
|
|
9985834bd6 | ||
|
|
94b4461c76 | ||
|
|
7afa9e0815 | ||
|
|
933ece35ab | ||
|
|
2f80b300f0 | ||
|
|
2e06bf59a4 | ||
|
|
854795c2b6 | ||
|
|
4fe7fb705a | ||
|
|
270e0d0e2c | ||
|
|
6ddc9cf017 | ||
|
|
2dcd76b2de | ||
|
|
a6eabd0b67 | ||
|
|
fb9357b5ba | ||
|
|
d484cfcc31 | ||
|
|
5c93642f2a | ||
|
|
8ff206ba7e | ||
|
|
e36a5e111c | ||
|
|
72522001e5 | ||
|
|
50c4bb83cb | ||
|
|
b2875ad056 | ||
|
|
8ec94f105c | ||
|
|
90f4212a68 | ||
|
|
648894f9a9 | ||
|
|
dc68639dfa | ||
|
|
244cf8b3b7 | ||
|
|
f25f506d77 | ||
|
|
c29a177a7a | ||
|
|
03328a998c | ||
|
|
ec5fad5bea | ||
|
|
c671acf68f | ||
|
|
4f2cb5e184 | ||
|
|
63a065237a | ||
|
|
0f4e1888d9 | ||
|
|
d4d3308c34 | ||
|
|
b9c6d2966b | ||
|
|
f371cda8d8 | ||
|
|
9eaf0f3b8f | ||
|
|
a80289d046 | ||
|
|
aae45afb1b | ||
|
|
f4157c95c4 | ||
|
|
bb5176673b | ||
|
|
e9cb5b64b3 | ||
|
|
0433619518 | ||
|
|
110bf44a3b | ||
|
|
fbdf39a733 | ||
|
|
f99ff47f75 | ||
|
|
bb18189b01 | ||
|
|
18bdb33de2 | ||
|
|
1ec016ecad | ||
|
|
bd61e04088 | ||
|
|
0da2a6408b | ||
|
|
9697a9a6e0 | ||
|
|
32d52b024c | ||
|
|
2fe01f13df | ||
|
|
554a3558ab | ||
|
|
9aa57dd0c7 | ||
|
|
cb9f57356e | ||
|
|
02a5726072 | ||
|
|
e865e823d5 | ||
|
|
10cad5c459 | ||
|
|
ebcb297582 | ||
|
|
0a293ae4d6 | ||
|
|
bdff11e1fc | ||
|
|
9cfb6fb0a9 | ||
|
|
9ec6f9d74f | ||
|
|
45207f0c4f | ||
|
|
cf9a402ad8 | ||
|
|
64a5a790a7 | ||
|
|
78d4e1e1e9 | ||
|
|
74c7a6d5de | ||
|
|
340929e7e7 | ||
|
|
6f1a3f5524 | ||
|
|
7077da5a64 | ||
|
|
77c63dcd04 | ||
|
|
e7ac73be5a | ||
|
|
dfca9d8c48 | ||
|
|
6032d5651a | ||
|
|
539752e9bd | ||
|
|
94b28a1b29 | ||
|
|
5911914e95 | ||
|
|
3daecf696a | ||
|
|
497c57e3e5 | ||
|
|
8a42fd2f30 | ||
|
|
7d95472543 | ||
|
|
71681cb8be | ||
|
|
1fef6ba505 |
@@ -1,11 +1,12 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
mrsk (0.5.0)
|
mrsk (0.7.0)
|
||||||
activesupport (>= 7.0)
|
activesupport (>= 7.0)
|
||||||
dotenv (~> 2.8)
|
dotenv (~> 2.8)
|
||||||
sshkit (~> 1.21)
|
sshkit (~> 1.21)
|
||||||
thor (~> 1.2)
|
thor (~> 1.2)
|
||||||
|
zeitwerk (~> 2.5)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
@@ -91,6 +92,7 @@ PLATFORMS
|
|||||||
arm64-darwin-22
|
arm64-darwin-22
|
||||||
x86_64-darwin-20
|
x86_64-darwin-20
|
||||||
x86_64-darwin-21
|
x86_64-darwin-21
|
||||||
|
x86_64-darwin-22
|
||||||
x86_64-linux
|
x86_64-linux
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
|
|||||||
133
README.md
133
README.md
@@ -1,10 +1,10 @@
|
|||||||
# MRSK
|
# MRSK
|
||||||
|
|
||||||
MRSK deploys Rails apps in containers to servers running 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.
|
MRSK deploys web apps in containers to servers running 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 bundled with Docker.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install MRSK globally with `gem install mrsk`. Then, inside your app directory, run `mrsk install`. Now edit the new file `config/deploy.yml`. It could look as simple as this:
|
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:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service: hey
|
service: hey
|
||||||
@@ -15,12 +15,17 @@ servers:
|
|||||||
registry:
|
registry:
|
||||||
username: registry-user-name
|
username: registry-user-name
|
||||||
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
||||||
|
env:
|
||||||
|
secret:
|
||||||
|
- RAILS_MASTER_KEY
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you're ready to deploy a multi-arch image to the servers:
|
Then edit your `.env` file to add your registry password as `MRSK_REGISTRY_PASSWORD` (and your `RAILS_MASTER_KEY` for production with a Rails app).
|
||||||
|
|
||||||
|
Now you're ready to deploy to the servers:
|
||||||
|
|
||||||
```
|
```
|
||||||
MRSK_REGISTRY_PASSWORD=pw mrsk deploy
|
mrsk deploy
|
||||||
```
|
```
|
||||||
|
|
||||||
This will:
|
This will:
|
||||||
@@ -32,17 +37,30 @@ This will:
|
|||||||
5. Push the image to the registry.
|
5. Push the image to the registry.
|
||||||
6. Pull the image from the registry on the servers.
|
6. Pull the image from the registry on the servers.
|
||||||
7. Ensure Traefik is running and accepting traffic on port 80.
|
7. Ensure Traefik is running and accepting traffic on port 80.
|
||||||
8. Stop any containers running a previous versions of the app.
|
8. Ensure your app responds with `200 OK` to `GET /up`.
|
||||||
9. Start a new container with the version of the app that matches the current git version hash.
|
9. Stop any containers running a previous versions of the app.
|
||||||
10. Prune unused images and stopped containers to ensure servers don't fill up.
|
10. Start a new container with the version of the app that matches the current git version hash.
|
||||||
|
11. Prune unused images and stopped containers to ensure servers don't fill up.
|
||||||
|
|
||||||
Voila! All the servers are now serving the app on port 80. If you're just running a single server, you're ready to go. If you're running multiple servers, you need to put a load balancer in front of them.
|
Voila! All the servers are now serving the app on port 80. If you're just running a single server, you're ready to go. If you're running multiple servers, you need to put a load balancer in front of them.
|
||||||
|
|
||||||
## Why not just run Capistrano or Kubernetes?
|
## 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, 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 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 structure also 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.
|
||||||
|
|
||||||
|
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, though. You're probably still better off with a fully managed service if basic Linux or Docker is still difficult, but from an early stage when those concepts are familiar.
|
||||||
|
|
||||||
|
## Why not just run Capistrano, Kubernetes or Docker Swarm?
|
||||||
|
|
||||||
MRSK basically is Capistrano for Containers, which allow us to use vanilla servers as the hosts. 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 deploy servers of MRSK, and it'll be auto-provisioned with Docker, and run right away. Docker's layer caching also allows for quicker 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, which allow us to use vanilla servers as the hosts. 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 deploy servers of MRSK, and it'll be auto-provisioned with Docker, and run right away. Docker's layer caching also allows for quicker 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, like Render or Fly, 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.
|
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.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -68,10 +86,27 @@ registry:
|
|||||||
|
|
||||||
### Using a different SSH user than root
|
### Using a different SSH user than root
|
||||||
|
|
||||||
The default SSH user is root, but you can change it using `ssh_user`:
|
The default SSH user is root, but you can change it using `ssh/user`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
ssh_user: app
|
ssh:
|
||||||
|
user: app
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using a proxy SSH host
|
||||||
|
|
||||||
|
If you need to connect to server through a proxy host, you can use `ssh/proxy`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ssh:
|
||||||
|
proxy: "192.168.0.1" # defaults to root as the user
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with specific user:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ssh:
|
||||||
|
proxy: "app@192.168.0.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using env variables
|
### Using env variables
|
||||||
@@ -149,10 +184,10 @@ You can specialize the default Traefik rules by setting labels on the containers
|
|||||||
|
|
||||||
```
|
```
|
||||||
labels:
|
labels:
|
||||||
traefik.http.routers.hey.rule: '''Host(`app.hey.com`)'''
|
traefik.http.routers.hey.rule: Host(\`app.hey.com\`)
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: The extra quotes are needed to ensure the rule is passed in correctly!
|
Note: The escaped backticks are needed to ensure the rule is passed in correctly and not treated as command substitution by Bash!
|
||||||
|
|
||||||
This allows you to run multiple applications on the same server sharing the same Traefik instance and port.
|
This allows you to run multiple applications on the same server sharing the same Traefik instance and port.
|
||||||
See https://doc.traefik.io/traefik/routing/routers/#rule for a full list of available routing rules.
|
See https://doc.traefik.io/traefik/routing/routers/#rule for a full list of available routing rules.
|
||||||
@@ -225,14 +260,15 @@ builder:
|
|||||||
|
|
||||||
This build secret can then be referenced in the Dockerfile:
|
This build secret can then be referenced in the Dockerfile:
|
||||||
|
|
||||||
```
|
```dockerfile
|
||||||
# Copy Gemfiles
|
# Copy Gemfiles
|
||||||
COPY Gemfile Gemfile.lock ./
|
COPY Gemfile Gemfile.lock ./
|
||||||
|
|
||||||
# Install dependencies, including private repositories via access token
|
# Install dependencies, including private repositories via access token (then remove bundle cache with exposed GITHUB_TOKEN)
|
||||||
RUN --mount=type=secret,id=GITHUB_TOKEN \
|
RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||||
BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||||
bundle install
|
bundle install && \
|
||||||
|
rm -rf /usr/local/bundle/cache
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using command arguments for Traefik
|
### Using command arguments for Traefik
|
||||||
@@ -241,12 +277,13 @@ You can customize the traefik command line:
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
traefik:
|
traefik:
|
||||||
|
args:
|
||||||
accesslog: true
|
accesslog: true
|
||||||
accesslog.format: json
|
accesslog.format: json
|
||||||
metrics.prometheus: true
|
|
||||||
metrics.prometheus.buckets: 0.1,0.3,1.2,5.0
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This will start the traefik container with `--accesslog=true accesslog.format=json`.
|
||||||
|
|
||||||
### Configuring build args for new images
|
### Configuring build args for new images
|
||||||
|
|
||||||
Build arguments that aren't secret can also be configured:
|
Build arguments that aren't secret can also be configured:
|
||||||
@@ -265,14 +302,6 @@ ARG RUBY_VERSION
|
|||||||
FROM ruby:$RUBY_VERSION-slim as base
|
FROM ruby:$RUBY_VERSION-slim as base
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using without RAILS_MASTER_KEY
|
|
||||||
|
|
||||||
If you're using MRSK with older Rails apps that predate RAILS_MASTER_KEY, or with a non-Rails app, you can skip the default usage and reference:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
skip_master_key: true
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using accessories for database, cache, search services
|
### Using accessories for database, cache, search services
|
||||||
|
|
||||||
You can manage your accessory services via MRSK as well. The services will build off public images, and will not be automatically updated when you deploy:
|
You can manage your accessory services via MRSK as well. The services will build off public images, and will not be automatically updated when you deploy:
|
||||||
@@ -300,6 +329,58 @@ accessories:
|
|||||||
|
|
||||||
Now run `mrsk accessory start mysql` to start the MySQL server on 1.1.1.3. See `mrsk accessory` for all the commands possible.
|
Now run `mrsk accessory start mysql` to start the MySQL server on 1.1.1.3. See `mrsk accessory` for all the commands possible.
|
||||||
|
|
||||||
|
### Using a generated .env file
|
||||||
|
|
||||||
|
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
|
||||||
|
<% if (session_token = `op signin --account my-one-password-account --raw`.strip) != "" %># Generated by mrsk envify
|
||||||
|
GITHUB_TOKEN=<%= `gh config get -h github.com oauth_token`.strip %>
|
||||||
|
MRSK_REGISTRY_PASSWORD=<%= `op read "op://Vault/Docker Hub/password" -n --session #{session_token}` %>
|
||||||
|
RAILS_MASTER_KEY=<%= `op read "op://Vault/My App/RAILS_MASTER_SECRET" -n --session #{session_token}` %>
|
||||||
|
MYSQL_ROOT_PASSWORD=<%= `op read "op://Vault/My App/MYSQL_ROOT_PASSWORD" -n --session #{session_token}` %>
|
||||||
|
<% else raise ArgumentError, "Session token missing" end %>
|
||||||
|
```
|
||||||
|
|
||||||
|
This template can safely be checked into git. Then everyone deploying the app can run `mrsk envify` when they setup the app for the first time or passwords change to get the correct `.env` file.
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
### Using audit broadcasts
|
||||||
|
|
||||||
|
If you'd like to broadcast audits of deploys, rollbacks, etc to a chatroom or elsewhere, you can configure the `audit_broadcast_cmd` setting with the path to a bin file that reads the audit line from STDIN, and then does whatever with it:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
audit_broadcast_cmd:
|
||||||
|
bin/audit_broadcast
|
||||||
|
```
|
||||||
|
|
||||||
|
The broadcast command could look something like:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
read
|
||||||
|
curl -q -d content="[My app] ${REPLY}" https://3.basecamp.com/XXXXX/integrations/XXXXX/buckets/XXXXX/chats/XXXXX/lines
|
||||||
|
```
|
||||||
|
|
||||||
|
That'll post a line like follows to a preconfigured chatbot in Basecamp:
|
||||||
|
|
||||||
|
```
|
||||||
|
[My App] [2023-02-18 11:29:52] [dhh] Rolled back to version d264c4e92470ad1bd18590f04466787262f605de
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using custom healthcheck path or port
|
||||||
|
|
||||||
|
MRSK defaults to checking the health of your application again `/up` on port 3000. You can tailor both with the `healthcheck` setting:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
healthcheck:
|
||||||
|
path: /healthz
|
||||||
|
port: 4000
|
||||||
|
```
|
||||||
|
|
||||||
|
This will ensure your application is configured with a traefik label for the healthcheck against `/healthz` and that the pre-deploy healthcheck that MRSK performs is done against the same path on port 4000.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### Running commands on servers
|
### Running commands on servers
|
||||||
|
|||||||
3
bin/mrsk
3
bin/mrsk
@@ -3,8 +3,7 @@
|
|||||||
# Prevent failures from being reported twice.
|
# Prevent failures from being reported twice.
|
||||||
Thread.report_on_exception = false
|
Thread.report_on_exception = false
|
||||||
|
|
||||||
require "dotenv/load"
|
require "mrsk"
|
||||||
require "mrsk/cli"
|
|
||||||
|
|
||||||
begin
|
begin
|
||||||
Mrsk::Cli::Main.start(ARGV)
|
Mrsk::Cli::Main.start(ARGV)
|
||||||
|
|||||||
@@ -1,5 +1,9 @@
|
|||||||
module Mrsk
|
module Mrsk
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/version"
|
require "zeitwerk"
|
||||||
require "mrsk/commander"
|
|
||||||
|
loader = Zeitwerk::Loader.for_gem
|
||||||
|
loader.ignore("#{__dir__}/mrsk/sshkit_with_ext.rb")
|
||||||
|
loader.setup
|
||||||
|
loader.eager_load # We need all commands loaded.
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
require "mrsk"
|
|
||||||
|
|
||||||
module Mrsk::Cli
|
module Mrsk::Cli
|
||||||
end
|
end
|
||||||
|
|
||||||
# SSHKit uses instance eval, so we need a global const for ergonomics
|
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||||
MRSK = Mrsk::Commander.new
|
MRSK = Mrsk::Commander.new
|
||||||
|
|
||||||
require "mrsk/cli/main"
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
||||||
desc "boot [NAME]", "Boot accessory service on host (use NAME=all to boot all accessories)"
|
desc "boot [NAME]", "Boot accessory service on host (use NAME=all to boot all accessories)"
|
||||||
def boot(name)
|
def boot(name)
|
||||||
@@ -9,7 +7,13 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
|||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
directories(name)
|
directories(name)
|
||||||
upload(name)
|
upload(name)
|
||||||
on(accessory.host) { execute *accessory.run }
|
|
||||||
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Booted #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.run
|
||||||
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Booted accessory #{name}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -52,14 +56,20 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
|||||||
desc "start [NAME]", "Start existing accessory on host"
|
desc "start [NAME]", "Start existing accessory on host"
|
||||||
def start(name)
|
def start(name)
|
||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
on(accessory.host) { execute *accessory.start }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Started #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.start
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "stop [NAME]", "Stop accessory on host"
|
desc "stop [NAME]", "Stop accessory on host"
|
||||||
def stop(name)
|
def stop(name)
|
||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
on(accessory.host) { execute *accessory.stop, raise_on_non_zero_exit: false }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -98,11 +108,17 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
|||||||
|
|
||||||
when options[:reuse]
|
when options[:reuse]
|
||||||
say "Launching command from existing container...", :magenta
|
say "Launching command from existing container...", :magenta
|
||||||
on(accessory.host) { capture_with_info(*accessory.execute_in_existing_container(cmd)) }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
|
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||||
|
end
|
||||||
|
|
||||||
else
|
else
|
||||||
say "Launching command from new container...", :magenta
|
say "Launching command from new container...", :magenta
|
||||||
on(accessory.host) { capture_with_info(*accessory.execute_in_new_container(cmd)) }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
|
capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -150,21 +166,29 @@ class Mrsk::Cli::Accessory < Mrsk::Cli::Base
|
|||||||
desc "remove_container [NAME]", "Remove accessory container from host"
|
desc "remove_container [NAME]", "Remove accessory container from host"
|
||||||
def remove_container(name)
|
def remove_container(name)
|
||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
on(accessory.host) { execute *accessory.remove_container }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Remove #{name} accessory container"), verbosity: :debug
|
||||||
|
execute *accessory.remove_container
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "remove_image [NAME]", "Remove accessory image from host"
|
desc "remove_image [NAME]", "Remove accessory image from host"
|
||||||
def remove_image(name)
|
def remove_image(name)
|
||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
on(accessory.host) { execute *accessory.remove_image }
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Removed #{name} accessory image"), verbosity: :debug
|
||||||
|
execute *accessory.remove_image
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "remove_service_directory [NAME]", "Remove accessory directory used for uploaded files and data directories from host"
|
desc "remove_service_directory [NAME]", "Remove accessory directory used for uploaded files and data directories from host"
|
||||||
def remove_service_directory(name)
|
def remove_service_directory(name)
|
||||||
with_accessory(name) do |accessory|
|
with_accessory(name) do |accessory|
|
||||||
on(accessory.host) { execute *accessory.remove_service_directory }
|
on(accessory.host) do
|
||||||
|
execute *accessory.remove_service_directory
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,26 +1,23 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::App < Mrsk::Cli::Base
|
class Mrsk::Cli::App < Mrsk::Cli::Base
|
||||||
desc "boot", "Boot app on servers (or reboot app if already running)"
|
desc "boot", "Boot app on servers (or reboot app if already running)"
|
||||||
def boot
|
def boot
|
||||||
cli = self
|
|
||||||
|
|
||||||
say "Ensure no other version of the app is running...", :magenta
|
|
||||||
stop
|
|
||||||
|
|
||||||
say "Get most recent version available as an image...", :magenta unless options[:version]
|
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||||
using_version(options[:version] || most_recent_version_available) do |version|
|
using_version(options[:version] || most_recent_version_available) do |version|
|
||||||
say "Start container with version #{version} (or reboot if already running)...", :magenta
|
say "Start container with version #{version} (or reboot if already running)...", :magenta
|
||||||
|
|
||||||
MRSK.config.roles.each do |role|
|
MRSK.config.roles.each do |role|
|
||||||
on(role.hosts) do |host|
|
on(role.hosts) do |host|
|
||||||
|
execute *MRSK.auditor.record("Booted app version #{version}"), verbosity: :debug
|
||||||
|
|
||||||
begin
|
begin
|
||||||
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
execute *MRSK.app.run(role: role.name)
|
execute *MRSK.app.run(role: role.name)
|
||||||
rescue SSHKit::Command::Failed => e
|
rescue SSHKit::Command::Failed => e
|
||||||
if e.message =~ /already in use/
|
if e.message =~ /already in use/
|
||||||
error "Rebooting container with same version already deployed on #{host}"
|
error "Rebooting container with same version already deployed on #{host}"
|
||||||
|
execute *MRSK.auditor.record("Rebooted app version #{version}"), verbosity: :debug
|
||||||
|
|
||||||
cli.remove_container version
|
execute *MRSK.app.remove_container(version: version)
|
||||||
execute *MRSK.app.run(role: role.name)
|
execute *MRSK.app.run(role: role.name)
|
||||||
else
|
else
|
||||||
raise
|
raise
|
||||||
@@ -33,12 +30,18 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
|
desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
|
||||||
def start
|
def start
|
||||||
on(MRSK.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Started app version #{MRSK.version}"), verbosity: :debug
|
||||||
|
execute *MRSK.app.start, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "stop", "Stop app on servers"
|
desc "stop", "Stop app on servers"
|
||||||
def stop
|
def stop
|
||||||
on(MRSK.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Stopped app"), verbosity: :debug
|
||||||
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "details", "Display details about app containers"
|
desc "details", "Display details about app containers"
|
||||||
@@ -68,15 +71,22 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
|
|||||||
when options[:reuse]
|
when options[:reuse]
|
||||||
say "Get current version of running container...", :magenta unless options[:version]
|
say "Get current version of running container...", :magenta unless options[:version]
|
||||||
using_version(options[:version] || current_running_version) do |version|
|
using_version(options[:version] || current_running_version) do |version|
|
||||||
say "Launching command with version #{version} from existing container on #{MRSK.primary_host}...", :magenta
|
say "Launching command with version #{version} from existing container...", :magenta
|
||||||
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.execute_in_existing_container(cmd)) }
|
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.app.execute_in_existing_container(cmd))
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
else
|
else
|
||||||
say "Get most recent version available as an image...", :magenta unless options[:version]
|
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||||
using_version(options[:version] || most_recent_version_available) do |version|
|
using_version(options[:version] || most_recent_version_available) do |version|
|
||||||
say "Launching command with version #{version} from new container on #{MRSK.primary_host}...", :magenta
|
say "Launching command with version #{version} from new container...", :magenta
|
||||||
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.execute_in_new_container(cmd)) }
|
on(MRSK.hosts) do |host|
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.app.execute_in_new_container(cmd))
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -91,11 +101,6 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
|
|||||||
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_images) }
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_images) }
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "current", "Return the current running container ID"
|
|
||||||
def current
|
|
||||||
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.current_container_id) }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "logs", "Show lines from app on servers"
|
desc "logs", "Show lines from app 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 :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 :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||||
@@ -134,17 +139,26 @@ class Mrsk::Cli::App < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "remove_container [VERSION]", "Remove app container with given version from servers"
|
desc "remove_container [VERSION]", "Remove app container with given version from servers"
|
||||||
def remove_container(version)
|
def remove_container(version)
|
||||||
on(MRSK.hosts) { execute *MRSK.app.remove_container(version: version) }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed app container with version #{version}"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_container(version: version)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "remove_containers", "Remove all app containers from servers"
|
desc "remove_containers", "Remove all app containers from servers"
|
||||||
def remove_containers
|
def remove_containers
|
||||||
on(MRSK.hosts) { execute *MRSK.app.remove_containers }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed all app containers"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_containers
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "remove_images", "Remove all app images from servers"
|
desc "remove_images", "Remove all app images from servers"
|
||||||
def remove_images
|
def remove_images
|
||||||
on(MRSK.hosts) { execute *MRSK.app.remove_images }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed all app images"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_images
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "current_version", "Shows the version currently running"
|
desc "current_version", "Shows the version currently running"
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
require "thor"
|
require "thor"
|
||||||
|
require "dotenv"
|
||||||
require "mrsk/sshkit_with_ext"
|
require "mrsk/sshkit_with_ext"
|
||||||
|
|
||||||
module Mrsk::Cli
|
module Mrsk::Cli
|
||||||
@@ -21,10 +22,19 @@ module Mrsk::Cli
|
|||||||
|
|
||||||
def initialize(*)
|
def initialize(*)
|
||||||
super
|
super
|
||||||
|
load_envs
|
||||||
initialize_commander(options)
|
initialize_commander(options)
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def load_envs
|
||||||
|
if destination = options[:destination]
|
||||||
|
Dotenv.load(".env.#{destination}", ".env")
|
||||||
|
else
|
||||||
|
Dotenv.load(".env")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def initialize_commander(options)
|
def initialize_commander(options)
|
||||||
MRSK.tap do |commander|
|
MRSK.tap do |commander|
|
||||||
commander.config_file = Pathname.new(File.expand_path(options[:config_file]))
|
commander.config_file = Pathname.new(File.expand_path(options[:config_file]))
|
||||||
@@ -49,9 +59,14 @@ module Mrsk::Cli
|
|||||||
def print_runtime
|
def print_runtime
|
||||||
started_at = Time.now
|
started_at = Time.now
|
||||||
yield
|
yield
|
||||||
|
return Time.now - started_at
|
||||||
ensure
|
ensure
|
||||||
runtime = Time.now - started_at
|
runtime = Time.now - started_at
|
||||||
puts " Finished all in #{sprintf("%.1f seconds", runtime)}"
|
puts " Finished all in #{sprintf("%.1f seconds", runtime)}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def audit_broadcast(line)
|
||||||
|
run_locally { execute *MRSK.auditor.broadcast(line), verbosity: :debug }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Build < Mrsk::Cli::Base
|
class Mrsk::Cli::Build < Mrsk::Cli::Base
|
||||||
desc "deliver", "Deliver a newly built app image to servers"
|
desc "deliver", "Deliver a newly built app image to servers"
|
||||||
def deliver
|
def deliver
|
||||||
@@ -30,7 +28,10 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "pull", "Pull app image from the registry onto servers"
|
desc "pull", "Pull app image from the registry onto servers"
|
||||||
def pull
|
def pull
|
||||||
on(MRSK.hosts) { execute *MRSK.builder.pull }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pulled image with version #{MRSK.version}"), verbosity: :debug
|
||||||
|
execute *MRSK.builder.pull
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "create", "Create a local build setup"
|
desc "create", "Create a local build setup"
|
||||||
|
|||||||
29
lib/mrsk/cli/healthcheck.rb
Normal file
29
lib/mrsk/cli/healthcheck.rb
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
class Mrsk::Cli::Healthcheck < Mrsk::Cli::Base
|
||||||
|
desc "perform", "Health check the current version of the app"
|
||||||
|
def perform
|
||||||
|
on(MRSK.primary_host) do
|
||||||
|
begin
|
||||||
|
execute *MRSK.healthcheck.run
|
||||||
|
|
||||||
|
target = "Health check against #{MRSK.config.healthcheck["path"]}"
|
||||||
|
|
||||||
|
if capture_with_info(*MRSK.healthcheck.curl) == "200"
|
||||||
|
info "#{target} succeeded with 200 OK!"
|
||||||
|
else
|
||||||
|
# Catches 1xx, 2xx, 3xx
|
||||||
|
raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
|
||||||
|
end
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /curl/
|
||||||
|
# Catches 4xx, 5xx
|
||||||
|
raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
|
ensure
|
||||||
|
execute *MRSK.healthcheck.stop, raise_on_non_zero_exit: false
|
||||||
|
execute *MRSK.healthcheck.remove, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,13 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
require "mrsk/cli/accessory"
|
|
||||||
require "mrsk/cli/app"
|
|
||||||
require "mrsk/cli/build"
|
|
||||||
require "mrsk/cli/prune"
|
|
||||||
require "mrsk/cli/registry"
|
|
||||||
require "mrsk/cli/server"
|
|
||||||
require "mrsk/cli/traefik"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Main < Mrsk::Cli::Base
|
class Mrsk::Cli::Main < Mrsk::Cli::Base
|
||||||
desc "setup", "Setup all accessories and deploy the app to servers"
|
desc "setup", "Setup all accessories and deploy the app to servers"
|
||||||
def setup
|
def setup
|
||||||
@@ -20,7 +10,7 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "deploy", "Deploy the app to servers"
|
desc "deploy", "Deploy the app to servers"
|
||||||
def deploy
|
def deploy
|
||||||
print_runtime do
|
runtime = print_runtime do
|
||||||
say "Ensure Docker is installed...", :magenta
|
say "Ensure Docker is installed...", :magenta
|
||||||
invoke "mrsk:cli:server:bootstrap"
|
invoke "mrsk:cli:server:bootstrap"
|
||||||
|
|
||||||
@@ -33,34 +23,49 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
say "Ensure Traefik is running...", :magenta
|
say "Ensure Traefik is running...", :magenta
|
||||||
invoke "mrsk:cli:traefik:boot"
|
invoke "mrsk:cli:traefik:boot"
|
||||||
|
|
||||||
|
say "Ensure app can pass healthcheck...", :magenta
|
||||||
|
invoke "mrsk:cli:healthcheck:perform"
|
||||||
|
|
||||||
invoke "mrsk:cli:app:boot"
|
invoke "mrsk:cli:app:boot"
|
||||||
|
|
||||||
say "Prune old containers and images...", :magenta
|
say "Prune old containers and images...", :magenta
|
||||||
invoke "mrsk:cli:prune:all"
|
invoke "mrsk:cli:prune:all"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Deployed app in #{runtime.to_i} seconds"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
|
desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
|
||||||
def redeploy
|
def redeploy
|
||||||
print_runtime do
|
runtime = print_runtime do
|
||||||
say "Build and push app image...", :magenta
|
say "Build and push app image...", :magenta
|
||||||
invoke "mrsk:cli:build:deliver"
|
invoke "mrsk:cli:build:deliver"
|
||||||
|
|
||||||
|
say "Ensure app can pass healthcheck...", :magenta
|
||||||
|
invoke "mrsk:cli:healthcheck:perform"
|
||||||
|
|
||||||
invoke "mrsk:cli:app:boot"
|
invoke "mrsk:cli:app:boot"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Redeployed app in #{runtime.to_i} seconds"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "rollback [VERSION]", "Rollback the app to VERSION"
|
desc "rollback [VERSION]", "Rollback the app to VERSION"
|
||||||
def rollback(version)
|
def rollback(version)
|
||||||
MRSK.version = version
|
MRSK.version = version
|
||||||
|
|
||||||
cli = self
|
if container_name_available?(MRSK.config.service_with_version)
|
||||||
|
say "Stop current version, then start version #{version}...", :magenta
|
||||||
|
|
||||||
cli.say "Stop current version, then start version #{version}...", :magenta
|
on(MRSK.hosts) do |host|
|
||||||
on(MRSK.hosts) do
|
|
||||||
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
execute *MRSK.app.start
|
execute *MRSK.app.start
|
||||||
end
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Rolled back app to version #{version}"
|
||||||
|
else
|
||||||
|
say "The app version '#{version}' is not available as a container (use 'mrsk app containers' for available versions)", :red
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "details", "Display details about Traefik and app containers"
|
desc "details", "Display details about Traefik and app containers"
|
||||||
@@ -70,6 +75,13 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
invoke "mrsk:cli:accessory:details", [ "all" ]
|
invoke "mrsk:cli:accessory:details", [ "all" ]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "audit", "Show audit log from servers"
|
||||||
|
def audit
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.auditor.reveal)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
desc "config", "Show combined config"
|
desc "config", "Show combined config"
|
||||||
def config
|
def config
|
||||||
run_locally do
|
run_locally do
|
||||||
@@ -77,22 +89,29 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "install", "Create config stub in config/deploy.yml and binstub in bin/mrsk"
|
desc "init", "Create config stub in config/deploy.yml and env stub in .env"
|
||||||
option :skip_binstub, type: :boolean, default: false, desc: "Skip adding MRSK to the Gemfile and creating bin/mrsk binstub"
|
option :bundle, type: :boolean, default: false, desc: "Add MRSK to the Gemfile and create a bin/mrsk binstub"
|
||||||
def install
|
def init
|
||||||
require "fileutils"
|
require "fileutils"
|
||||||
|
|
||||||
if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
|
if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
|
||||||
puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
|
puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
|
||||||
else
|
else
|
||||||
|
FileUtils.mkdir_p deploy_file.dirname
|
||||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
||||||
puts "Created configuration file in config/deploy.yml"
|
puts "Created configuration file in config/deploy.yml"
|
||||||
end
|
end
|
||||||
|
|
||||||
unless options[:skip_binstub]
|
unless (deploy_file = Pathname.new(File.expand_path(".env"))).exist?
|
||||||
|
FileUtils.cp_r Pathname.new(File.expand_path("templates/template.env", __dir__)), deploy_file
|
||||||
|
puts "Created .env file"
|
||||||
|
end
|
||||||
|
|
||||||
|
if options[:bundle]
|
||||||
if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
|
if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
|
||||||
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
||||||
else
|
else
|
||||||
|
puts "Adding MRSK to Gemfile and bundle..."
|
||||||
`bundle add mrsk`
|
`bundle add mrsk`
|
||||||
`bundle binstubs mrsk`
|
`bundle binstubs mrsk`
|
||||||
puts "Created binstub file in bin/mrsk"
|
puts "Created binstub file in bin/mrsk"
|
||||||
@@ -100,6 +119,19 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "envify", "Create .env by evaluating .env.erb (or .env.staging.erb -> .env.staging when using -d staging)"
|
||||||
|
def envify
|
||||||
|
if destination = options[:destination]
|
||||||
|
env_template_path = ".env.#{destination}.erb"
|
||||||
|
env_path = ".env.#{destination}"
|
||||||
|
else
|
||||||
|
env_template_path = ".env.erb"
|
||||||
|
env_path = ".env"
|
||||||
|
end
|
||||||
|
|
||||||
|
File.write(env_path, ERB.new(File.read(env_template_path)).result, perm: 0600)
|
||||||
|
end
|
||||||
|
|
||||||
desc "remove", "Remove Traefik, app, and registry session from servers"
|
desc "remove", "Remove Traefik, app, and registry session from servers"
|
||||||
def remove
|
def remove
|
||||||
invoke "mrsk:cli:traefik:remove"
|
invoke "mrsk:cli:traefik:remove"
|
||||||
@@ -121,6 +153,9 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
desc "build", "Build the application image"
|
desc "build", "Build the application image"
|
||||||
subcommand "build", Mrsk::Cli::Build
|
subcommand "build", Mrsk::Cli::Build
|
||||||
|
|
||||||
|
desc "healthcheck", "Healthcheck the application"
|
||||||
|
subcommand "healthcheck", Mrsk::Cli::Healthcheck
|
||||||
|
|
||||||
desc "prune", "Prune old application images and containers"
|
desc "prune", "Prune old application images and containers"
|
||||||
subcommand "prune", Mrsk::Cli::Prune
|
subcommand "prune", Mrsk::Cli::Prune
|
||||||
|
|
||||||
@@ -132,4 +167,11 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "traefik", "Manage the Traefik load balancer"
|
desc "traefik", "Manage the Traefik load balancer"
|
||||||
subcommand "traefik", Mrsk::Cli::Traefik
|
subcommand "traefik", Mrsk::Cli::Traefik
|
||||||
|
|
||||||
|
private
|
||||||
|
def container_name_available?(container_name, host: MRSK.primary_host)
|
||||||
|
container_names = nil
|
||||||
|
on(host) { container_names = capture_with_info(*MRSK.app.list_container_names).split("\n") }
|
||||||
|
Array(container_names).include?(container_name)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
||||||
desc "all", "Prune unused images and stopped containers"
|
desc "all", "Prune unused images and stopped containers"
|
||||||
def all
|
def all
|
||||||
@@ -7,13 +5,19 @@ class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
|||||||
invoke :images
|
invoke :images
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "images", "Prune unused images older than 30 days"
|
desc "images", "Prune unused images older than 7 days"
|
||||||
def images
|
def images
|
||||||
on(MRSK.hosts) { execute *MRSK.prune.images }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pruned images"), verbosity: :debug
|
||||||
|
execute *MRSK.prune.images
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "containers", "Prune stopped containers for the service older than 3 days"
|
desc "containers", "Prune stopped containers for the service older than 3 days"
|
||||||
def containers
|
def containers
|
||||||
on(MRSK.hosts) { execute *MRSK.prune.containers }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pruned containers"), verbosity: :debug
|
||||||
|
execute *MRSK.prune.containers
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Registry < Mrsk::Cli::Base
|
class Mrsk::Cli::Registry < Mrsk::Cli::Base
|
||||||
desc "login", "Login to the registry locally and remotely"
|
desc "login", "Login to the registry locally and remotely"
|
||||||
def login
|
def login
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Server < Mrsk::Cli::Base
|
class Mrsk::Cli::Server < Mrsk::Cli::Base
|
||||||
desc "bootstrap", "Ensure Docker is installed on the servers"
|
desc "bootstrap", "Ensure Docker is installed on the servers"
|
||||||
def bootstrap
|
def bootstrap
|
||||||
|
|||||||
2
lib/mrsk/cli/templates/template.env
Normal file
2
lib/mrsk/cli/templates/template.env
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
MRSK_REGISTRY_PASSWORD=change-this
|
||||||
|
RAILS_MASTER_KEY=another-env
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
||||||
desc "boot", "Boot Traefik on servers"
|
desc "boot", "Boot Traefik on servers"
|
||||||
def boot
|
def boot
|
||||||
@@ -15,12 +13,18 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "start", "Start existing Traefik on servers"
|
desc "start", "Start existing Traefik on servers"
|
||||||
def start
|
def start
|
||||||
on(MRSK.traefik_hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Started traefik"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.start, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "stop", "Stop Traefik on servers"
|
desc "stop", "Stop Traefik on servers"
|
||||||
def stop
|
def stop
|
||||||
on(MRSK.traefik_hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Stopped traefik"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "restart", "Restart Traefik on servers"
|
desc "restart", "Restart Traefik on servers"
|
||||||
@@ -67,11 +71,17 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "remove_container", "Remove Traefik container from servers"
|
desc "remove_container", "Remove Traefik container from servers"
|
||||||
def remove_container
|
def remove_container
|
||||||
on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_container }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed traefik container"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.remove_container
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "remove_container", "Remove Traefik image from servers"
|
desc "remove_container", "Remove Traefik image from servers"
|
||||||
def remove_image
|
def remove_image
|
||||||
on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_image }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed traefik image"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.remove_image
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,13 +1,5 @@
|
|||||||
require "active_support/core_ext/enumerable"
|
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"
|
|
||||||
require "mrsk/commands/traefik"
|
|
||||||
require "mrsk/commands/registry"
|
|
||||||
|
|
||||||
class Mrsk::Commander
|
class Mrsk::Commander
|
||||||
attr_accessor :config_file, :destination, :verbosity, :version
|
attr_accessor :config_file, :destination, :verbosity, :version
|
||||||
|
|
||||||
@@ -77,25 +69,45 @@ class Mrsk::Commander
|
|||||||
Mrsk::Commands::Accessory.new(config, name: name)
|
Mrsk::Commands::Accessory.new(config, name: name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def auditor
|
||||||
|
@auditor ||= Mrsk::Commands::Auditor.new(config)
|
||||||
|
end
|
||||||
|
|
||||||
|
def healthcheck
|
||||||
|
@healthcheck ||= Mrsk::Commands::Healthcheck.new(config)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
def with_verbosity(level)
|
def with_verbosity(level)
|
||||||
old_level = SSHKit.config.output_verbosity
|
old_level = self.verbosity
|
||||||
|
|
||||||
|
self.verbosity = level
|
||||||
SSHKit.config.output_verbosity = level
|
SSHKit.config.output_verbosity = level
|
||||||
|
|
||||||
yield
|
yield
|
||||||
ensure
|
ensure
|
||||||
|
self.verbosity = old_level
|
||||||
SSHKit.config.output_verbosity = old_level
|
SSHKit.config.output_verbosity = old_level
|
||||||
end
|
end
|
||||||
|
|
||||||
# Test-induced damage!
|
# Test-induced damage!
|
||||||
def reset
|
def reset
|
||||||
@config = @config_file = @destination = @version = nil
|
@config = @config_file = @destination = @version = nil
|
||||||
@app = @builder = @traefik = @registry = @prune = nil
|
@app = @builder = @traefik = @registry = @prune = @auditor = nil
|
||||||
@verbosity = :info
|
@verbosity = :info
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def cascading_version
|
def cascading_version
|
||||||
version.presence || ENV["VERSION"] || `git rev-parse HEAD`.strip
|
version.presence || ENV["VERSION"] || current_commit_hash
|
||||||
|
end
|
||||||
|
|
||||||
|
def current_commit_hash
|
||||||
|
if system("git rev-parse")
|
||||||
|
`git rev-parse HEAD`.strip
|
||||||
|
else
|
||||||
|
raise "Can't use commit hash as version, no git repository found in #{Dir.pwd}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lazy setup of SSHKit
|
# Lazy setup of SSHKit
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
||||||
attr_reader :accessory_config
|
attr_reader :accessory_config
|
||||||
delegate :service_name, :image, :host, :port, :files, :directories, :env_args, :volume_args, :label_args, to: :accessory_config
|
delegate :service_name, :image, :host, :port, :files, :directories, :env_args, :volume_args, :label_args, to: :accessory_config
|
||||||
@@ -14,6 +12,7 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
|||||||
"--name", service_name,
|
"--name", service_name,
|
||||||
"-d",
|
"-d",
|
||||||
"--restart", "unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
"-p", port,
|
"-p", port,
|
||||||
*env_args,
|
*env_args,
|
||||||
*volume_args,
|
*volume_args,
|
||||||
@@ -41,10 +40,10 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def follow_logs(grep: nil)
|
def follow_logs(grep: nil)
|
||||||
run_over_ssh pipe(
|
run_over_ssh \
|
||||||
|
pipe \
|
||||||
docker(:logs, service_name, "-t", "-n", "10", "-f", "2>&1"),
|
docker(:logs, service_name, "-t", "-n", "10", "-f", "2>&1"),
|
||||||
(%(grep "#{grep}") if grep)
|
(%(grep "#{grep}") if grep)
|
||||||
).join(" ")
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -66,11 +65,11 @@ class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def execute_in_existing_container_over_ssh(*command)
|
def execute_in_existing_container_over_ssh(*command)
|
||||||
run_over_ssh execute_in_existing_container(*command, interactive: true).join(" ")
|
run_over_ssh execute_in_existing_container(*command, interactive: true)
|
||||||
end
|
end
|
||||||
|
|
||||||
def execute_in_new_container_over_ssh(*command)
|
def execute_in_new_container_over_ssh(*command)
|
||||||
run_over_ssh execute_in_new_container(*command, interactive: true).join(" ")
|
run_over_ssh execute_in_new_container(*command, interactive: true)
|
||||||
end
|
end
|
||||||
|
|
||||||
def run_over_ssh(command)
|
def run_over_ssh(command)
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::App < Mrsk::Commands::Base
|
class Mrsk::Commands::App < Mrsk::Commands::Base
|
||||||
def run(role: :web)
|
def run(role: :web)
|
||||||
role = config.role(role)
|
role = config.role(role)
|
||||||
@@ -7,8 +5,8 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
docker :run,
|
docker :run,
|
||||||
"-d",
|
"-d",
|
||||||
"--restart unless-stopped",
|
"--restart unless-stopped",
|
||||||
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
"--name", service_with_version,
|
"--name", service_with_version,
|
||||||
*rails_master_key_arg,
|
|
||||||
*role.env_args,
|
*role.env_args,
|
||||||
*config.volume_args,
|
*config.volume_args,
|
||||||
*role.label_args,
|
*role.label_args,
|
||||||
@@ -37,11 +35,13 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def follow_logs(host:, grep: nil)
|
def follow_logs(host:, grep: nil)
|
||||||
run_over_ssh pipe(
|
run_over_ssh \
|
||||||
|
pipe(
|
||||||
current_container_id,
|
current_container_id,
|
||||||
"xargs docker logs -t -n 10 -f 2>&1",
|
"xargs docker logs -t -n 10 -f 2>&1",
|
||||||
(%(grep "#{grep}") if grep)
|
(%(grep "#{grep}") if grep)
|
||||||
).join(" "), host: host
|
),
|
||||||
|
host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -56,7 +56,6 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
docker :run,
|
docker :run,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
"--rm",
|
"--rm",
|
||||||
*rails_master_key_arg,
|
|
||||||
*config.env_args,
|
*config.env_args,
|
||||||
*config.volume_args,
|
*config.volume_args,
|
||||||
config.absolute_image,
|
config.absolute_image,
|
||||||
@@ -64,11 +63,11 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def execute_in_existing_container_over_ssh(*command, host:)
|
def execute_in_existing_container_over_ssh(*command, host:)
|
||||||
run_over_ssh execute_in_existing_container(*command, interactive: true).join(" "), host: host
|
run_over_ssh execute_in_existing_container(*command, interactive: true), host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
def execute_in_new_container_over_ssh(*command, host:)
|
def execute_in_new_container_over_ssh(*command, host:)
|
||||||
run_over_ssh execute_in_new_container(*command, interactive: true).join(" "), host: host
|
run_over_ssh execute_in_new_container(*command, interactive: true), host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -76,10 +75,6 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
docker :ps, "-q", *service_filter
|
docker :ps, "-q", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
def container_id_for(container_name:)
|
|
||||||
docker :container, :ls, "-a", "-f", "name=#{container_name}", "-q"
|
|
||||||
end
|
|
||||||
|
|
||||||
def current_running_version
|
def current_running_version
|
||||||
# FIXME: Find more graceful way to extract the version from "app-version" than using sed and tail!
|
# FIXME: Find more graceful way to extract the version from "app-version" than using sed and tail!
|
||||||
pipe \
|
pipe \
|
||||||
@@ -94,11 +89,21 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
"head -n 1"
|
"head -n 1"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def all_versions_from_available_containers
|
||||||
|
pipe \
|
||||||
|
docker(:image, :ls, "--format", '"{{.Tag}}"', config.repository),
|
||||||
|
"head -n 1"
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
def list_containers
|
def list_containers
|
||||||
docker :container, :ls, "-a", *service_filter
|
docker :container, :ls, "-a", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def list_container_names
|
||||||
|
[ *list_containers, "--format", "'{{ .Names }}'" ]
|
||||||
|
end
|
||||||
|
|
||||||
def remove_container(version:)
|
def remove_container(version:)
|
||||||
pipe \
|
pipe \
|
||||||
container_id_for(container_name: service_with_version(version)),
|
container_id_for(container_name: service_with_version(version)),
|
||||||
@@ -130,12 +135,4 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
def service_filter
|
def service_filter
|
||||||
[ "--filter", "label=service=#{config.service}" ]
|
[ "--filter", "label=service=#{config.service}" ]
|
||||||
end
|
end
|
||||||
|
|
||||||
def rails_master_key_arg
|
|
||||||
if master_key = config.master_key
|
|
||||||
[ "-e", redact("RAILS_MASTER_KEY=#{master_key}") ]
|
|
||||||
else
|
|
||||||
[]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
44
lib/mrsk/commands/auditor.rb
Normal file
44
lib/mrsk/commands/auditor.rb
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
require "active_support/core_ext/time/conversions"
|
||||||
|
|
||||||
|
class Mrsk::Commands::Auditor < Mrsk::Commands::Base
|
||||||
|
# Runs remotely
|
||||||
|
def record(line)
|
||||||
|
append \
|
||||||
|
[ :echo, tagged_line(line) ],
|
||||||
|
audit_log_file
|
||||||
|
end
|
||||||
|
|
||||||
|
# Runs locally
|
||||||
|
def broadcast(line)
|
||||||
|
if broadcast_cmd = config.audit_broadcast_cmd
|
||||||
|
pipe \
|
||||||
|
[ :echo, tagged_line(line) ],
|
||||||
|
broadcast_cmd
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def reveal
|
||||||
|
[ :tail, "-n", 50, audit_log_file ]
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def audit_log_file
|
||||||
|
"mrsk-#{config.service}-audit.log"
|
||||||
|
end
|
||||||
|
|
||||||
|
def tagged_line(line)
|
||||||
|
"'#{tags} #{line}'"
|
||||||
|
end
|
||||||
|
|
||||||
|
def tags
|
||||||
|
"[#{recorded_at}] [#{performer}]"
|
||||||
|
end
|
||||||
|
|
||||||
|
def performer
|
||||||
|
@performer ||= `whoami`.strip
|
||||||
|
end
|
||||||
|
|
||||||
|
def recorded_at
|
||||||
|
Time.now.to_fs(:db)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -2,14 +2,23 @@ module Mrsk::Commands
|
|||||||
class Base
|
class Base
|
||||||
delegate :redact, to: Mrsk::Utils
|
delegate :redact, to: Mrsk::Utils
|
||||||
|
|
||||||
|
MAX_LOG_SIZE = "10m"
|
||||||
|
|
||||||
attr_accessor :config
|
attr_accessor :config
|
||||||
|
|
||||||
def initialize(config)
|
def initialize(config)
|
||||||
@config = config
|
@config = config
|
||||||
end
|
end
|
||||||
|
|
||||||
def run_over_ssh(command, host:)
|
def run_over_ssh(*command, host:)
|
||||||
"ssh -t #{config.ssh_user}@#{host} '#{command}'"
|
"ssh".tap do |cmd|
|
||||||
|
cmd << " -J #{config.ssh_proxy.jump_proxies}" if config.ssh_proxy
|
||||||
|
cmd << " -t #{config.ssh_user}@#{host} '#{command.join(" ")}'"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def container_id_for(container_name:)
|
||||||
|
docker :container, :ls, "-a", "-f", "name=#{container_name}", "-q"
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
@@ -28,6 +37,10 @@ module Mrsk::Commands
|
|||||||
combine *commands, by: "|"
|
combine *commands, by: "|"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def append(*commands)
|
||||||
|
combine *commands, by: ">>"
|
||||||
|
end
|
||||||
|
|
||||||
def xargs(command)
|
def xargs(command)
|
||||||
[ :xargs, command ].flatten
|
[ :xargs, command ].flatten
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
||||||
delegate :create, :remove, :push, :pull, :info, to: :target
|
delegate :create, :remove, :push, :pull, :info, to: :target
|
||||||
|
|
||||||
@@ -36,8 +34,3 @@ class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
|||||||
@multiarch_remote ||= Mrsk::Commands::Builder::Multiarch::Remote.new(config)
|
@multiarch_remote ||= Mrsk::Commands::Builder::Multiarch::Remote.new(config)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/commands/builder/native"
|
|
||||||
require "mrsk/commands/builder/native/remote"
|
|
||||||
require "mrsk/commands/builder/multiarch"
|
|
||||||
require "mrsk/commands/builder/multiarch/remote"
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
||||||
delegate :argumentize, to: Mrsk::Utils
|
delegate :argumentize, to: Mrsk::Utils
|
||||||
|
|
||||||
@@ -7,6 +5,19 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
|||||||
docker :pull, config.absolute_image
|
docker :pull, config.absolute_image
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def build_options
|
||||||
|
[ *build_tags, *build_labels, *build_args, *build_secrets ]
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def build_tags
|
||||||
|
[ "-t", config.absolute_image, "-t", config.latest_image ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_labels
|
||||||
|
argumentize "--label", { service: config.service }
|
||||||
|
end
|
||||||
|
|
||||||
def build_args
|
def build_args
|
||||||
argumentize "--build-arg", args, redacted: true
|
argumentize "--build-arg", args, redacted: true
|
||||||
end
|
end
|
||||||
@@ -15,7 +26,6 @@ class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
|||||||
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
|
||||||
def args
|
def args
|
||||||
(config.builder && config.builder["args"]) || {}
|
(config.builder && config.builder["args"]) || {}
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/builder/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
|
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
|
||||||
def create
|
def create
|
||||||
docker :buildx, :create, "--use", "--name", builder_name
|
docker :buildx, :create, "--use", "--name", builder_name
|
||||||
@@ -14,9 +12,7 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
|
|||||||
"--push",
|
"--push",
|
||||||
"--platform", "linux/amd64,linux/arm64",
|
"--platform", "linux/amd64,linux/arm64",
|
||||||
"--builder", builder_name,
|
"--builder", builder_name,
|
||||||
"-t", config.absolute_image,
|
*build_options,
|
||||||
*build_args,
|
|
||||||
*build_secrets,
|
|
||||||
"."
|
"."
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/builder/multiarch"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Multiarch
|
class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Multiarch
|
||||||
def create
|
def create
|
||||||
combine \
|
combine \
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/builder/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
|
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
|
||||||
def create
|
def create
|
||||||
# No-op on native
|
# No-op on native
|
||||||
@@ -11,7 +9,7 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
|
|||||||
|
|
||||||
def push
|
def push
|
||||||
combine \
|
combine \
|
||||||
docker(:build, "-t", *build_args, *build_secrets, config.absolute_image, "."),
|
docker(:build, *build_options, "."),
|
||||||
docker(:push, config.absolute_image)
|
docker(:push, config.absolute_image)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/builder/native"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
|
class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
|
||||||
def create
|
def create
|
||||||
chain \
|
chain \
|
||||||
@@ -18,9 +16,7 @@ class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
|
|||||||
"--push",
|
"--push",
|
||||||
"--platform", platform,
|
"--platform", platform,
|
||||||
"--builder", builder_name,
|
"--builder", builder_name,
|
||||||
"-t", config.absolute_image,
|
*build_options,
|
||||||
*build_args,
|
|
||||||
*build_secrets,
|
|
||||||
"."
|
"."
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
46
lib/mrsk/commands/healthcheck.rb
Normal file
46
lib/mrsk/commands/healthcheck.rb
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
|
||||||
|
EXPOSED_PORT = 3999
|
||||||
|
|
||||||
|
def run
|
||||||
|
web = config.role(:web)
|
||||||
|
|
||||||
|
docker :run,
|
||||||
|
"-d",
|
||||||
|
"--name", container_name_with_version,
|
||||||
|
"-p", "#{EXPOSED_PORT}:#{config.healthcheck["port"]}",
|
||||||
|
"--label", "service=#{container_name}",
|
||||||
|
*web.env_args,
|
||||||
|
*config.volume_args,
|
||||||
|
config.absolute_image,
|
||||||
|
web.cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
def curl
|
||||||
|
[ :curl, "--silent", "--output", "/dev/null", "--write-out", "'%{http_code}'", health_url ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def stop
|
||||||
|
pipe \
|
||||||
|
container_id_for(container_name: container_name),
|
||||||
|
xargs(docker(:stop))
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove
|
||||||
|
pipe \
|
||||||
|
container_id_for(container_name: container_name),
|
||||||
|
xargs(docker(:container, :rm))
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def container_name
|
||||||
|
"healthcheck-#{config.service}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def container_name_with_version
|
||||||
|
"healthcheck-#{config.service_with_version}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def health_url
|
||||||
|
"http://localhost:#{EXPOSED_PORT}#{config.healthcheck["path"]}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,17 +1,12 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
require "active_support/duration"
|
require "active_support/duration"
|
||||||
require "active_support/core_ext/numeric/time"
|
require "active_support/core_ext/numeric/time"
|
||||||
|
|
||||||
class Mrsk::Commands::Prune < Mrsk::Commands::Base
|
class Mrsk::Commands::Prune < Mrsk::Commands::Base
|
||||||
PRUNE_IMAGES_AFTER = 30.days.in_hours.to_i
|
def images(until_hours: 7.days.in_hours.to_i)
|
||||||
PRUNE_CONTAINERS_AFTER = 3.days.in_hours.to_i
|
docker :image, :prune, "--all", "--force", "--filter", "label=service=#{config.service}", "--filter", "until=#{until_hours}h"
|
||||||
|
|
||||||
def images
|
|
||||||
docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def containers
|
def containers(until_hours: 3.days.in_hours.to_i)
|
||||||
docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
|
docker :container, :prune, "--force", "--filter", "label=service=#{config.service}", "--filter", "until=#{until_hours}h"
|
||||||
docker :container, :prune, "-f", "--filter", "label=service=#{config.service}", "--filter", "'until=#{PRUNE_CONTAINERS_AFTER}h'"
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Registry < Mrsk::Commands::Base
|
class Mrsk::Commands::Registry < Mrsk::Commands::Base
|
||||||
delegate :registry, to: :config
|
delegate :registry, to: :config
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
||||||
def run
|
def run
|
||||||
docker :run, "--name traefik",
|
docker :run, "--name traefik",
|
||||||
"-d",
|
"-d",
|
||||||
"--restart unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
"-p 80:80",
|
"-p 80:80",
|
||||||
"-v /var/run/docker.sock:/var/run/docker.sock",
|
"-v /var/run/docker.sock:/var/run/docker.sock",
|
||||||
"traefik",
|
"traefik",
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ require "active_support/core_ext/string/inquiry"
|
|||||||
require "active_support/core_ext/module/delegation"
|
require "active_support/core_ext/module/delegation"
|
||||||
require "pathname"
|
require "pathname"
|
||||||
require "erb"
|
require "erb"
|
||||||
require "mrsk/utils"
|
require "net/ssh/proxy/jump"
|
||||||
|
|
||||||
class Mrsk::Configuration
|
class Mrsk::Configuration
|
||||||
delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :raw_config, allow_nil: true
|
delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :raw_config, allow_nil: true
|
||||||
@@ -82,6 +82,10 @@ class Mrsk::Configuration
|
|||||||
"#{repository}:#{version}"
|
"#{repository}:#{version}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def latest_image
|
||||||
|
"#{repository}:latest"
|
||||||
|
end
|
||||||
|
|
||||||
def service_with_version
|
def service_with_version
|
||||||
"#{service}-#{version}"
|
"#{service}-#{version}"
|
||||||
end
|
end
|
||||||
@@ -103,18 +107,33 @@ class Mrsk::Configuration
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def ssh_user
|
def ssh_user
|
||||||
raw_config.ssh_user || "root"
|
if raw_config.ssh.present?
|
||||||
|
raw_config.ssh["user"] || "root"
|
||||||
|
else
|
||||||
|
"root"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def ssh_proxy
|
||||||
|
if raw_config.ssh.present? && raw_config.ssh["proxy"]
|
||||||
|
Net::SSH::Proxy::Jump.new \
|
||||||
|
raw_config.ssh["proxy"].include?("@") ? raw_config.ssh["proxy"] : "root@#{raw_config.ssh["proxy"]}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def ssh_options
|
def ssh_options
|
||||||
{ user: ssh_user, auth_methods: [ "publickey" ] }
|
{ user: ssh_user, proxy: ssh_proxy, auth_methods: [ "publickey" ] }.compact
|
||||||
end
|
end
|
||||||
|
|
||||||
def master_key
|
|
||||||
unless raw_config.skip_master_key
|
def audit_broadcast_cmd
|
||||||
ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
|
raw_config.audit_broadcast_cmd
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def healthcheck
|
||||||
|
{ "path" => "/up", "port" => 3000 }.merge(raw_config.healthcheck || {})
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -136,7 +155,8 @@ class Mrsk::Configuration
|
|||||||
volume_args: volume_args,
|
volume_args: volume_args,
|
||||||
ssh_options: ssh_options,
|
ssh_options: ssh_options,
|
||||||
builder: raw_config.builder,
|
builder: raw_config.builder,
|
||||||
accessories: raw_config.accessories
|
accessories: raw_config.accessories,
|
||||||
|
healthcheck: healthcheck
|
||||||
}.compact
|
}.compact
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -171,6 +191,3 @@ class Mrsk::Configuration
|
|||||||
raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
|
raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/configuration/role"
|
|
||||||
require "mrsk/configuration/accessory"
|
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ class Mrsk::Configuration::Role
|
|||||||
if running_traefik?
|
if running_traefik?
|
||||||
{
|
{
|
||||||
"traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
|
"traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
|
||||||
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => "/up",
|
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => config.healthcheck["path"],
|
||||||
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
|
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
|
||||||
"traefik.http.middlewares.#{config.service}.retry.attempts" => "3",
|
"traefik.http.middlewares.#{config.service}.retry.attempts" => "3",
|
||||||
"traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
|
"traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
|
||||||
@@ -96,7 +96,12 @@ class Mrsk::Configuration::Role
|
|||||||
def merged_env_with_secrets
|
def merged_env_with_secrets
|
||||||
merged_env.tap do |new_env|
|
merged_env.tap do |new_env|
|
||||||
new_env["secret"] = Array(config.env["secret"]) + Array(specialized_env["secret"])
|
new_env["secret"] = Array(config.env["secret"]) + Array(specialized_env["secret"])
|
||||||
new_env["clear"] = (Array(config.env["clear"] || config.env) + Array(specialized_env["clear"] || specialized_env)).uniq
|
|
||||||
|
# If there's no secret/clear split, everything is clear
|
||||||
|
clear_app_env = config.env["secret"] ? Array(config.env["clear"]) : Array(config.env["clear"] || config.env)
|
||||||
|
clear_role_env = specialized_env["secret"] ? Array(specialized_env["clear"]) : Array(specialized_env["clear"] || specialized_env)
|
||||||
|
|
||||||
|
new_env["clear"] = (clear_app_env + clear_role_env).uniq
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
module Mrsk
|
module Mrsk
|
||||||
VERSION = "0.5.0"
|
VERSION = "0.7.0"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
|
|||||||
spec.authors = [ "David Heinemeier Hansson" ]
|
spec.authors = [ "David Heinemeier Hansson" ]
|
||||||
spec.email = "dhh@hey.com"
|
spec.email = "dhh@hey.com"
|
||||||
spec.homepage = "https://github.com/rails/mrsk"
|
spec.homepage = "https://github.com/rails/mrsk"
|
||||||
spec.summary = "Deploy Rails apps in containers to servers running Docker with zero downtime."
|
spec.summary = "Deploy web apps in containers to servers running Docker with zero downtime."
|
||||||
spec.license = "MIT"
|
spec.license = "MIT"
|
||||||
|
|
||||||
spec.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
|
spec.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
|
||||||
@@ -16,4 +16,5 @@ Gem::Specification.new do |spec|
|
|||||||
spec.add_dependency "sshkit", "~> 1.21"
|
spec.add_dependency "sshkit", "~> 1.21"
|
||||||
spec.add_dependency "thor", "~> 1.2"
|
spec.add_dependency "thor", "~> 1.2"
|
||||||
spec.add_dependency "dotenv", "~> 2.8"
|
spec.add_dependency "dotenv", "~> 2.8"
|
||||||
|
spec.add_dependency "zeitwerk", "~> 2.5"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ class CliAccessoryTest < CliTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "boot" do
|
test "boot" do
|
||||||
assert_match "Running docker run --name app-mysql -d --restart unless-stopped -p 3306:3306 -e [REDACTED] -e MYSQL_ROOT_HOST=% --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=app-mysql mysql:5.7 on 1.1.1.3", run_command("boot", "mysql")
|
assert_match "Running docker run --name app-mysql -d --restart unless-stopped --log-opt max-size=10m -p 3306:3306 -e [REDACTED] -e MYSQL_ROOT_HOST=% --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=app-mysql mysql:5.7 on 1.1.1.3", run_command("boot", "mysql")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "exec" do
|
test "exec" do
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "active_support/testing/stream"
|
require "active_support/testing/stream"
|
||||||
require "mrsk/cli"
|
|
||||||
|
|
||||||
class CliTestCase < ActiveSupport::TestCase
|
class CliTestCase < ActiveSupport::TestCase
|
||||||
include ActiveSupport::Testing::Stream
|
include ActiveSupport::Testing::Stream
|
||||||
|
|||||||
@@ -5,4 +5,29 @@ class CliMainTest < CliTestCase
|
|||||||
version = stdouted { Mrsk::Cli::Main.new.version }
|
version = stdouted { Mrsk::Cli::Main.new.version }
|
||||||
assert_equal Mrsk::VERSION, version
|
assert_equal Mrsk::VERSION, version
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "rollback bad version" do
|
||||||
|
run_command("details") # Preheat MRSK const
|
||||||
|
|
||||||
|
run_command("rollback", "nonsense").tap do |output|
|
||||||
|
assert_match /docker container ls -a --filter label=service=app --format '{{ .Names }}'/, output
|
||||||
|
assert_match /The app version 'nonsense' is not available as a container/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "rollback good version" do
|
||||||
|
Mrsk::Cli::Main.any_instance.stubs(:container_name_available?).returns(true)
|
||||||
|
|
||||||
|
run_command("rollback", "123").tap do |output|
|
||||||
|
assert_match /Stop current version, then start version 123/, output
|
||||||
|
assert_match /docker ps -q --filter label=service=app | xargs docker stop/, output
|
||||||
|
assert_match /docker start app-123/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted { Mrsk::Cli::Main.start([*command, "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/commander"
|
|
||||||
|
|
||||||
class CommanderTest < ActiveSupport::TestCase
|
class CommanderTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@@ -10,6 +9,16 @@ class CommanderTest < ActiveSupport::TestCase
|
|||||||
assert_equal Mrsk::Configuration, @mrsk.config.class
|
assert_equal Mrsk::Configuration, @mrsk.config.class
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "commit hash as version" do
|
||||||
|
assert_equal `git rev-parse HEAD`.strip, @mrsk.config.version
|
||||||
|
end
|
||||||
|
|
||||||
|
test "commit hash as version but not in git" do
|
||||||
|
@mrsk.expects(:system).with("git rev-parse").returns(nil)
|
||||||
|
error = assert_raises(RuntimeError) { @mrsk.config }
|
||||||
|
assert_match /no git repository found/, error.message
|
||||||
|
end
|
||||||
|
|
||||||
test "overwriting hosts" do
|
test "overwriting hosts" do
|
||||||
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/accessory"
|
|
||||||
|
|
||||||
class CommandsAccessoryTest < ActiveSupport::TestCase
|
class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@@ -51,46 +49,54 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "run" do
|
test "run" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :run, "--name", "app-mysql", "-d", "--restart", "unless-stopped", "-p", "3306:3306", "-e", "MYSQL_ROOT_PASSWORD=secret123", "-e", "MYSQL_ROOT_HOST=%", "--label", "service=app-mysql", "mysql:8.0"], @mysql.run
|
"docker run --name app-mysql -d --restart unless-stopped --log-opt max-size=10m -p 3306:3306 -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% --label service=app-mysql mysql:8.0",
|
||||||
|
@mysql.run.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :run, "--name", "app-redis", "-d", "--restart", "unless-stopped", "-p", "6379:6379", "-e", "SOMETHING=else", "--volume", "/var/lib/redis:/data", "--label", "service=app-redis", "--label", "cache=true", "redis:latest"], @redis.run
|
"docker run --name app-redis -d --restart unless-stopped --log-opt max-size=10m -p 6379:6379 -e SOMETHING=else --volume /var/lib/redis:/data --label service=app-redis --label cache=true redis:latest",
|
||||||
|
@redis.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "start" do
|
test "start" do
|
||||||
assert_equal [:docker, :container, :start, "app-mysql"], @mysql.start
|
assert_equal \
|
||||||
|
"docker container start app-mysql",
|
||||||
|
@mysql.start.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stop" do
|
test "stop" do
|
||||||
assert_equal [:docker, :container, :stop, "app-mysql"], @mysql.stop
|
assert_equal \
|
||||||
|
"docker container stop app-mysql",
|
||||||
|
@mysql.stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "info" do
|
test "info" do
|
||||||
assert_equal [:docker, :ps, "--filter", "label=service=app-mysql"], @mysql.info
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app-mysql",
|
||||||
|
@mysql.info.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "execute in new container" do
|
test "execute in new container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[ :docker, :run, "--rm", "-e", "MYSQL_ROOT_PASSWORD=secret123", "-e", "MYSQL_ROOT_HOST=%", "mysql:8.0", "mysql", "-u", "root" ],
|
"docker run --rm -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% mysql:8.0 mysql -u root",
|
||||||
@mysql.execute_in_new_container("mysql", "-u", "root")
|
@mysql.execute_in_new_container("mysql", "-u", "root").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in existing container" do
|
test "execute in existing container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[ :docker, :exec, "app-mysql", "mysql", "-u", "root" ],
|
"docker exec app-mysql mysql -u root",
|
||||||
@mysql.execute_in_existing_container("mysql", "-u", "root")
|
@mysql.execute_in_existing_container("mysql", "-u", "root").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container over ssh" do
|
test "execute in new container over ssh" do
|
||||||
@mysql.stub(:run_over_ssh, ->(cmd, host:) { cmd }) do
|
@mysql.stub(:run_over_ssh, ->(cmd) { cmd.join(" ") }) do
|
||||||
assert_match %r|docker run -it --rm -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% mysql:8.0 mysql -u root|,
|
assert_match %r|docker run -it --rm -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% mysql:8.0 mysql -u root|,
|
||||||
@mysql.execute_in_new_container_over_ssh("mysql", "-u", "root")
|
@mysql.execute_in_new_container_over_ssh("mysql", "-u", "root")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in existing container over ssh" do
|
test "execute in existing container over ssh" do
|
||||||
@mysql.stub(:run_over_ssh, ->(cmd, host:) { cmd }) do
|
@mysql.stub(:run_over_ssh, ->(cmd) { cmd.join(" ") }) do
|
||||||
assert_match %r|docker exec -it app-mysql mysql -u root|,
|
assert_match %r|docker exec -it app-mysql mysql -u root|,
|
||||||
@mysql.execute_in_existing_container_over_ssh("mysql", "-u", "root")
|
@mysql.execute_in_existing_container_over_ssh("mysql", "-u", "root")
|
||||||
end
|
end
|
||||||
@@ -99,19 +105,30 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
assert_equal [:docker, :logs, "app-mysql", "-t", "2>&1"], @mysql.logs
|
assert_equal \
|
||||||
assert_equal [:docker, :logs, "app-mysql", " --since 5m", " -n 100", "-t", "2>&1", "|", "grep 'thing'"], @mysql.logs(since: "5m", lines: 100, grep: "thing")
|
"docker logs app-mysql -t 2>&1",
|
||||||
|
@mysql.logs.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker logs app-mysql --since 5m -n 100 -t 2>&1 | grep 'thing'",
|
||||||
|
@mysql.logs(since: "5m", lines: 100, grep: "thing").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "follow logs" do
|
test "follow logs" do
|
||||||
assert_equal "ssh -t root@1.1.1.5 'docker logs app-mysql -t -n 10 -f 2>&1'", @mysql.follow_logs
|
assert_equal \
|
||||||
|
"ssh -t root@1.1.1.5 'docker logs app-mysql -t -n 10 -f 2>&1'",
|
||||||
|
@mysql.follow_logs
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove container" do
|
test "remove container" do
|
||||||
assert_equal [:docker, :container, :prune, "-f", "--filter", "label=service=app-mysql"], @mysql.remove_container
|
assert_equal \
|
||||||
|
"docker container prune -f --filter label=service=app-mysql",
|
||||||
|
@mysql.remove_container.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove image" do
|
test "remove image" do
|
||||||
assert_equal [:docker, :image, :prune, "-a", "-f", "--filter", "label=service=app-mysql"], @mysql.remove_image
|
assert_equal \
|
||||||
|
"docker image prune -a -f --filter label=service=app-mysql",
|
||||||
|
@mysql.remove_image.join(" ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,63 +1,169 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/app"
|
|
||||||
|
|
||||||
class CommandsAppTest < ActiveSupport::TestCase
|
class CommandsAppTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
ENV["RAILS_MASTER_KEY"] = "456"
|
ENV["RAILS_MASTER_KEY"] = "456"
|
||||||
|
|
||||||
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
|
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ], env: { "secret" => [ "RAILS_MASTER_KEY" ] } }
|
||||||
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config)
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config).tap { |c| c.version = "999" }
|
||||||
end
|
end
|
||||||
|
|
||||||
teardown do
|
teardown do
|
||||||
ENV["RAILS_MASTER_KEY"] = nil
|
ENV.delete("RAILS_MASTER_KEY")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "run" do
|
test "run" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :run, "-d", "--restart unless-stopped", "--name", "app-missing", "-e", "RAILS_MASTER_KEY=456", "--label", "service=app", "--label", "role=web", "--label", "traefik.http.routers.app.rule='PathPrefix(`/`)'", "--label", "traefik.http.services.app.loadbalancer.healthcheck.path=/up", "--label", "traefik.http.services.app.loadbalancer.healthcheck.interval=1s", "--label", "traefik.http.middlewares.app.retry.attempts=3", "--label", "traefik.http.middlewares.app.retry.initialinterval=500ms", "dhh/app:missing"], @app.run
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/up --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "run with volumes" do
|
test "run with volumes" do
|
||||||
@config[:volumes] = ["/local/path:/container/path" ]
|
@config[:volumes] = ["/local/path:/container/path" ]
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :run, "-d", "--restart unless-stopped", "--name", "app-missing", "-e", "RAILS_MASTER_KEY=456", "--volume", "/local/path:/container/path", "--label", "service=app", "--label", "role=web", "--label", "traefik.http.routers.app.rule='PathPrefix(`/`)'", "--label", "traefik.http.services.app.loadbalancer.healthcheck.path=/up", "--label", "traefik.http.services.app.loadbalancer.healthcheck.interval=1s", "--label", "traefik.http.middlewares.app.retry.attempts=3", "--label", "traefik.http.middlewares.app.retry.initialinterval=500ms", "dhh/app:missing"], @app.run
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --volume /local/path:/container/path --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/up --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with custom healthcheck path" do
|
||||||
|
@config[:healthcheck] = { "path" => "/healthz" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/healthz --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "start" do
|
||||||
|
assert_equal \
|
||||||
|
"docker start app-999",
|
||||||
|
@app.start.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker stop",
|
||||||
|
@app.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "info" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app",
|
||||||
|
@app.info.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "logs" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs 2>&1",
|
||||||
|
@app.logs.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m 2>&1",
|
||||||
|
@app.logs(since: "5m").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -n 100 2>&1",
|
||||||
|
@app.logs(lines: "100").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m -n 100 2>&1",
|
||||||
|
@app.logs(since: "5m", lines: "100").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs 2>&1 | grep 'my-id'",
|
||||||
|
@app.logs(grep: "my-id").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m 2>&1 | grep 'my-id'",
|
||||||
|
@app.logs(since: "5m", grep: "my-id").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "follow logs" do
|
||||||
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -t -n 10 -f 2>&1",
|
||||||
|
@app.follow_logs(host: "app-1")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -t -n 10 -f 2>&1 | grep \"Completed\"",
|
||||||
|
@app.follow_logs(host: "app-1", grep: "Completed")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "execute in new container" do
|
test "execute in new container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[ :docker, :run, "--rm", "-e", "RAILS_MASTER_KEY=456", "dhh/app:missing", "bin/rails", "db:setup" ],
|
"docker run --rm -e RAILS_MASTER_KEY=456 dhh/app:999 bin/rails db:setup",
|
||||||
@app.execute_in_new_container("bin/rails", "db:setup")
|
@app.execute_in_new_container("bin/rails", "db:setup").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in existing container" do
|
test "execute in existing container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[ :docker, :exec, "app-missing", "bin/rails", "db:setup" ],
|
"docker exec app-999 bin/rails db:setup",
|
||||||
@app.execute_in_existing_container("bin/rails", "db:setup")
|
@app.execute_in_existing_container("bin/rails", "db:setup").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container over ssh" do
|
test "execute in new container over ssh" do
|
||||||
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd }) do
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
assert_match %r|docker run -it --rm -e RAILS_MASTER_KEY=456 dhh/app:missing bin/rails c|,
|
assert_match %r|docker run -it --rm -e RAILS_MASTER_KEY=456 dhh/app:999 bin/rails c|,
|
||||||
@app.execute_in_new_container_over_ssh("bin/rails", "c", host: "app-1")
|
@app.execute_in_new_container_over_ssh("bin/rails", "c", host: "app-1")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in existing container over ssh" do
|
test "execute in existing container over ssh" do
|
||||||
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd }) do
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
assert_match %r|docker exec -it app-missing bin/rails c|,
|
assert_match %r|docker exec -it app-999 bin/rails c|,
|
||||||
@app.execute_in_existing_container_over_ssh("bin/rails", "c", host: "app-1")
|
@app.execute_in_existing_container_over_ssh("bin/rails", "c", host: "app-1")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "run over ssh" do
|
||||||
|
assert_equal "ssh -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
test "run without master key" do
|
test "run over ssh with custom user" do
|
||||||
ENV["RAILS_MASTER_KEY"] = nil
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "user" => "app" } })
|
||||||
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:skip_master_key] = true })
|
assert_equal "ssh -t app@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
assert @app.run.exclude?("RAILS_MASTER_KEY=456")
|
test "run over ssh with proxy" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "proxy" => "2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J root@2.2.2.2 -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with proxy user" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "proxy" => "app@2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J app@2.2.2.2 -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with custom user with proxy" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "user" => "app", "proxy" => "2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J root@2.2.2.2 -t app@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "current_container_id" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app",
|
||||||
|
@app.current_container_id.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "container_id_for" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=app-999 -q",
|
||||||
|
@app.container_id_for(container_name: "app-999").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "current_running_version" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app --format \"{{.Names}}\" | sed 's/-/\\n/g' | tail -n 1",
|
||||||
|
@app.current_running_version.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "most_recent_version_from_available_images" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image ls --format \"{{.Tag}}\" dhh/app | head -n 1",
|
||||||
|
@app.most_recent_version_from_available_images.join(" ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
27
test/commands/auditor_test.rb
Normal file
27
test/commands/auditor_test.rb
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsAuditorTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
audit_broadcast_cmd: "bin/audit_broadcast"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "record" do
|
||||||
|
assert_match \
|
||||||
|
/echo '.* app removed container' >> mrsk-app-audit.log/,
|
||||||
|
new_command.record("app removed container").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "broadcast" do
|
||||||
|
assert_match \
|
||||||
|
/echo '.* app removed container' \| bin\/audit_broadcast/,
|
||||||
|
new_command.broadcast("app removed container").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Auditor.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,6 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/builder"
|
|
||||||
|
|
||||||
class CommandsBuilderTest < ActiveSupport::TestCase
|
class CommandsBuilderTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@@ -10,50 +8,68 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
test "target multiarch by default" do
|
test "target multiarch by default" do
|
||||||
builder = new_builder_command
|
builder = new_builder_command
|
||||||
assert_equal "multiarch", builder.name
|
assert_equal "multiarch", builder.name
|
||||||
assert_equal [:docker, :buildx, :build, "--push", "--platform", "linux/amd64,linux/arm64", "--builder", "mrsk-app-multiarch", "-t", "dhh/app:123", "."], builder.push
|
assert_equal \
|
||||||
|
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder mrsk-app-multiarch -t dhh/app:123 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "target native when multiarch is off" do
|
test "target native when multiarch is off" do
|
||||||
builder = new_builder_command(builder: { "multiarch" => false })
|
builder = new_builder_command(builder: { "multiarch" => false })
|
||||||
assert_equal "native", builder.name
|
assert_equal "native", builder.name
|
||||||
assert_equal [:docker, :build, "-t", "dhh/app:123", ".", "&&", :docker, :push, "dhh/app:123"], builder.push
|
assert_equal \
|
||||||
|
"docker build -t dhh/app:123 -t dhh/app:latest --label service=app . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "target multiarch remote when local and remote is set" do
|
test "target multiarch remote when local and remote is set" do
|
||||||
builder = new_builder_command(builder: { "local" => { }, "remote" => { } })
|
builder = new_builder_command(builder: { "local" => { }, "remote" => { } })
|
||||||
assert_equal "multiarch/remote", builder.name
|
assert_equal "multiarch/remote", builder.name
|
||||||
assert_equal [:docker, :buildx, :build, "--push", "--platform", "linux/amd64,linux/arm64", "--builder", "mrsk-app-multiarch-remote", "-t", "dhh/app:123", "."], builder.push
|
assert_equal \
|
||||||
|
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder mrsk-app-multiarch-remote -t dhh/app:123 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "target native remote when only remote is set" do
|
test "target native remote when only remote is set" do
|
||||||
builder = new_builder_command(builder: { "remote" => { "arch" => "amd64" } })
|
builder = new_builder_command(builder: { "remote" => { "arch" => "amd64" } })
|
||||||
assert_equal "native/remote", builder.name
|
assert_equal "native/remote", builder.name
|
||||||
assert_equal [:docker, :buildx, :build, "--push", "--platform", "linux/amd64", "--builder", "mrsk-app-native-remote", "-t", "dhh/app:123", "."], builder.push
|
assert_equal \
|
||||||
|
"docker buildx build --push --platform linux/amd64 --builder mrsk-app-native-remote -t dhh/app:123 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "build args" do
|
test "build args" do
|
||||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
assert_equal [ "--build-arg", "a=1", "--build-arg", "b=2" ], builder.target.build_args
|
assert_equal \
|
||||||
|
"-t dhh/app:123 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2",
|
||||||
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "build secrets" do
|
test "build secrets" do
|
||||||
builder = new_builder_command(builder: { "secrets" => ["token_a", "token_b"] })
|
builder = new_builder_command(builder: { "secrets" => ["token_a", "token_b"] })
|
||||||
assert_equal [ "--secret", "id=token_a", "--secret", "id=token_b" ], builder.target.build_secrets
|
assert_equal \
|
||||||
|
"-t dhh/app:123 -t dhh/app:latest --label service=app --secret id=token_a --secret id=token_b",
|
||||||
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "native push with build args" do
|
test "native push with build args" do
|
||||||
builder = new_builder_command(builder: { "multiarch" => false, "args" => { "a" => 1, "b" => 2 } })
|
builder = new_builder_command(builder: { "multiarch" => false, "args" => { "a" => 1, "b" => 2 } })
|
||||||
assert_equal [ :docker, :build, "-t", "--build-arg", "a=1", "--build-arg", "b=2", "dhh/app:123", ".", "&&", :docker, :push, "dhh/app:123" ], builder.push
|
assert_equal \
|
||||||
|
"docker build -t dhh/app:123 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2 . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "multiarch push with build args" do
|
test "multiarch push with build args" do
|
||||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
assert_equal [ :docker, :buildx, :build, "--push", "--platform", "linux/amd64,linux/arm64", "--builder", "mrsk-app-multiarch", "-t", "dhh/app:123", "--build-arg", "a=1", "--build-arg", "b=2", "." ], builder.push
|
assert_equal \
|
||||||
|
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder mrsk-app-multiarch -t dhh/app:123 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2 .",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "native push with with build secrets" do
|
test "native push with with build secrets" do
|
||||||
builder = new_builder_command(builder: { "multiarch" => false, "secrets" => [ "a", "b" ] })
|
builder = new_builder_command(builder: { "multiarch" => false, "secrets" => [ "a", "b" ] })
|
||||||
assert_equal [ :docker, :build, "-t", "--secret", "id=a", "--secret", "id=b", "dhh/app:123", ".", "&&", :docker, :push, "dhh/app:123" ], builder.push
|
assert_equal \
|
||||||
|
"docker build -t dhh/app:123 -t dhh/app:latest --label service=app --secret id=a --secret id=b . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
55
test/commands/healthcheck_test.rb
Normal file
55
test/commands/healthcheck_test.rb
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsHealthcheckTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
traefik: { "args" => { "accesslog.format" => "json", "metrics.prometheus.buckets" => "0.1,0.3,1.2,5.0" } }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --name healthcheck-app-123 -p 3999:3000 --label service=healthcheck-app dhh/app:123",
|
||||||
|
new_command.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with custom port" do
|
||||||
|
@config[:healthcheck] = { "port" => 3001 }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --name healthcheck-app-123 -p 3999:3001 --label service=healthcheck-app dhh/app:123",
|
||||||
|
new_command.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "curl" do
|
||||||
|
assert_equal \
|
||||||
|
"curl --silent --output /dev/null --write-out '%{http_code}' http://localhost:3999/up",
|
||||||
|
new_command.curl.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "curl with custom path" do
|
||||||
|
@config[:healthcheck] = { "path" => "/healthz" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"curl --silent --output /dev/null --write-out '%{http_code}' http://localhost:3999/healthz",
|
||||||
|
new_command.curl.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=healthcheck-app -q | xargs docker stop",
|
||||||
|
new_command.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=healthcheck-app -q | xargs docker container rm",
|
||||||
|
new_command.remove.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Healthcheck.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
27
test/commands/prune_test.rb
Normal file
27
test/commands/prune_test.rb
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsPruneTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
traefik: { "args" => { "accesslog.format" => "json", "metrics.prometheus.buckets" => "0.1,0.3,1.2,5.0" } }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "images" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image prune --all --force --filter label=service=app --filter until=168h",
|
||||||
|
new_command.images.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "containers" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container prune --force --filter label=service=app --filter until=72h",
|
||||||
|
new_command.containers.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Prune.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,6 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/registry"
|
|
||||||
|
|
||||||
class CommandsRegistryTest < ActiveSupport::TestCase
|
class CommandsRegistryTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/traefik"
|
|
||||||
|
|
||||||
class CommandsTraefikTest < ActiveSupport::TestCase
|
class CommandsTraefikTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@@ -12,63 +10,74 @@ class CommandsTraefikTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "run" do
|
test "run" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :run, "--name traefik", "-d", "--restart unless-stopped", "-p 80:80", "-v /var/run/docker.sock:/var/run/docker.sock", "traefik", "--providers.docker", "--log.level=DEBUG", "--accesslog.format", "json", "--metrics.prometheus.buckets", "0.1,0.3,1.2,5.0"],
|
"docker run --name traefik -d --restart unless-stopped --log-opt max-size=10m -p 80:80 -v /var/run/docker.sock:/var/run/docker.sock traefik --providers.docker --log.level=DEBUG --accesslog.format json --metrics.prometheus.buckets 0.1,0.3,1.2,5.0",
|
||||||
new_command.run
|
new_command.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik start" do
|
test "traefik start" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :container, :start, 'traefik'], new_command.start
|
"docker container start traefik",
|
||||||
|
new_command.start.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik stop" do
|
test "traefik stop" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :container, :stop, 'traefik'], new_command.stop
|
"docker container stop traefik",
|
||||||
|
new_command.stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik info" do
|
test "traefik info" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :ps, '--filter', 'name=traefik'], new_command.info
|
"docker ps --filter name=traefik",
|
||||||
|
new_command.info.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik logs" do
|
test "traefik logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :logs, 'traefik', '-t', '2>&1'], new_command.logs
|
"docker logs traefik -t 2>&1",
|
||||||
|
new_command.logs.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik logs since 2h" do
|
test "traefik logs since 2h" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :logs, 'traefik', ' --since 2h', '-t', '2>&1'], new_command.logs(since: '2h')
|
"docker logs traefik --since 2h -t 2>&1",
|
||||||
|
new_command.logs(since: '2h').join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik logs last 10 lines" do
|
test "traefik logs last 10 lines" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :logs, 'traefik', ' -n 10', '-t', '2>&1'], new_command.logs(lines: 10)
|
"docker logs traefik -n 10 -t 2>&1",
|
||||||
|
new_command.logs(lines: 10).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik logs with grep hello!" do
|
test "traefik logs with grep hello!" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :logs, 'traefik', '-t', '2>&1', "|", "grep 'hello!'"], new_command.logs(grep: 'hello!')
|
"docker logs traefik -t 2>&1 | grep 'hello!'",
|
||||||
|
new_command.logs(grep: 'hello!').join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik remove container" do
|
test "traefik remove container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :container, :prune, "-f", "--filter", "label=org.opencontainers.image.title=Traefik"], new_command.remove_container
|
"docker container prune -f --filter label=org.opencontainers.image.title=Traefik",
|
||||||
|
new_command.remove_container.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik remove image" do
|
test "traefik remove image" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
[:docker, :image, :prune, "-a", "-f", "--filter", "label=org.opencontainers.image.title=Traefik"], new_command.remove_image
|
"docker image prune -a -f --filter label=org.opencontainers.image.title=Traefik",
|
||||||
|
new_command.remove_image.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik follow logs" do
|
test "traefik follow logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1'", new_command.follow_logs(host: @config[:servers].first)
|
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1'",
|
||||||
|
new_command.follow_logs(host: @config[:servers].first)
|
||||||
end
|
end
|
||||||
|
|
||||||
test "traefik follow logs with grep hello!" do
|
test "traefik follow logs with grep hello!" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1 | grep \"hello!\"'", new_command.follow_logs(host: @config[:servers].first, grep: 'hello!')
|
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1 | grep \"hello!\"'",
|
||||||
|
new_command.follow_logs(host: @config[:servers].first, grep: 'hello!')
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
|
|
||||||
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
|
|
||||||
class ConfigurationRoleTest < ActiveSupport::TestCase
|
class ConfigurationRoleTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
|
||||||
|
|
||||||
class ConfigurationTest < ActiveSupport::TestCase
|
class ConfigurationTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@@ -140,17 +139,18 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
test "ssh options" do
|
test "ssh options" do
|
||||||
assert_equal "root", @config.ssh_options[:user]
|
assert_equal "root", @config.ssh_options[:user]
|
||||||
|
|
||||||
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:ssh_user] = "app" })
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "user" => "app" }) })
|
||||||
assert_equal "app", @config.ssh_options[:user]
|
assert_equal "app", @config.ssh_options[:user]
|
||||||
end
|
end
|
||||||
|
|
||||||
test "master key" do
|
test "ssh options with proxy host" do
|
||||||
assert_equal "456", @config.master_key
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "1.2.3.4" }) })
|
||||||
|
assert_equal "root@1.2.3.4", @config.ssh_options[:proxy].jump_proxies
|
||||||
end
|
end
|
||||||
|
|
||||||
test "skip master key" do
|
test "ssh options with proxy host and user" do
|
||||||
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:skip_master_key] = true })
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "app@1.2.3.4" }) })
|
||||||
assert_nil @config.master_key
|
assert_equal "app@1.2.3.4", @config.ssh_options[:proxy].jump_proxies
|
||||||
end
|
end
|
||||||
|
|
||||||
test "volume_args" do
|
test "volume_args" do
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ require "debug"
|
|||||||
require "mocha/minitest" # using #stubs that can alter returns
|
require "mocha/minitest" # using #stubs that can alter returns
|
||||||
require "minitest/autorun" # using #stub that take args
|
require "minitest/autorun" # using #stub that take args
|
||||||
require "sshkit"
|
require "sshkit"
|
||||||
|
require "mrsk"
|
||||||
|
|
||||||
ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
|
ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user