Compare commits
180 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
00d194e3f3 | ||
|
|
3f44e25b63 | ||
|
|
4c8b1a3e04 | ||
|
|
f06d639583 | ||
|
|
cdd77445d0 | ||
|
|
71f8f164ca | ||
|
|
1840f667d3 | ||
|
|
00afd5c6fc | ||
|
|
e17a7e28cb | ||
|
|
88b5e52b9f | ||
|
|
bc0ae84eb1 | ||
|
|
cb6fdbefc8 | ||
|
|
444e33721a | ||
|
|
ca86573d89 | ||
|
|
e317935ab3 | ||
|
|
767991afe3 | ||
|
|
7e191dc267 | ||
|
|
0f0529c785 | ||
|
|
3ebf8d7777 | ||
|
|
cd8570d776 | ||
|
|
7c72dfcb5d | ||
|
|
52d75508ea | ||
|
|
ea6144e664 | ||
|
|
d1559949ba | ||
|
|
60c2d45bdc | ||
|
|
afefd32379 | ||
|
|
c23928348b | ||
|
|
4937673aac | ||
|
|
979b7d80ba | ||
|
|
c1cf834dfc | ||
|
|
0111fcc4e4 | ||
|
|
407e1cc028 | ||
|
|
f58e5e0935 | ||
|
|
03fdb9a9ac | ||
|
|
a5ebb30de2 | ||
|
|
ec18a2a1c4 | ||
|
|
9af09256d9 | ||
|
|
29a8a52cef | ||
|
|
de0a3f8ee8 | ||
|
|
08cac72475 | ||
|
|
200f12a4a1 | ||
|
|
f0d88a5ffe | ||
|
|
d6a6f000f9 | ||
|
|
15495fb48c | ||
|
|
05f84cdbef | ||
|
|
03488bc67a | ||
|
|
eceafbedf4 | ||
|
|
e1d518216a | ||
|
|
52d10394f7 | ||
|
|
ddf52da132 | ||
|
|
747e0fd4c2 | ||
|
|
6177673870 | ||
|
|
78e50f23cd | ||
|
|
699f271e6e | ||
|
|
148c43fe29 | ||
|
|
cd44014069 | ||
|
|
1bcc65bc56 | ||
|
|
62cc986c54 | ||
|
|
7b1ffbfd6d | ||
|
|
8af7e48a90 | ||
|
|
92565d58d5 | ||
|
|
2d0a1c33ae | ||
|
|
75bfdaa702 | ||
|
|
c69d6e1569 | ||
|
|
25fb08791a | ||
|
|
6231a8668c | ||
|
|
b74ce02f31 | ||
|
|
1099b6fa84 | ||
|
|
247aaeb6ef | ||
|
|
7ec7520d6d | ||
|
|
5e15de0394 | ||
|
|
bb15f98496 | ||
|
|
beb77fd3ef | ||
|
|
6b19a0b6d4 | ||
|
|
6b98eb3677 | ||
|
|
48f8f7cb57 | ||
|
|
86ac1dd2d5 | ||
|
|
4432067585 | ||
|
|
a1c0cf39cb | ||
|
|
2213739156 | ||
|
|
936d346ca6 | ||
|
|
2af4885b39 | ||
|
|
e9f8eea6c9 | ||
|
|
82067cd077 | ||
|
|
48c45a0cf8 | ||
|
|
3a9c8455ec | ||
|
|
598e7ab97f | ||
|
|
6eb0abbb30 | ||
|
|
34652ca321 | ||
|
|
917d429901 | ||
|
|
a16e5ce886 | ||
|
|
e783950825 | ||
|
|
e4dc4c300e | ||
|
|
925ac86459 | ||
|
|
1795c7c6a4 | ||
|
|
a3a7fce1e8 | ||
|
|
bfec21c00f | ||
|
|
2ad135c237 | ||
|
|
287798ad57 | ||
|
|
5c75404fe9 | ||
|
|
2dc0f7cb66 | ||
|
|
652e17f260 | ||
|
|
ff636c3df6 | ||
|
|
885fd5d2c9 | ||
|
|
578bf79a7d | ||
|
|
fd23fc1dfd | ||
|
|
dda20eec11 | ||
|
|
f6ca864e06 | ||
|
|
3bf56c2fdb | ||
|
|
3d66e9ed33 | ||
|
|
31389bc7b5 | ||
|
|
79b5ed179e | ||
|
|
0388495819 | ||
|
|
5d629d0600 | ||
|
|
73c53dd138 | ||
|
|
cdc06dff11 | ||
|
|
95d8e7a75c | ||
|
|
9551837c17 | ||
|
|
5f125f509f | ||
|
|
435b558260 | ||
|
|
ef9259fdd8 | ||
|
|
af22c32c94 | ||
|
|
8e69514b78 | ||
|
|
8a32cc9c84 | ||
|
|
2cb09be0cd | ||
|
|
135fcdd9d3 | ||
|
|
c4006ee373 | ||
|
|
4434b6e09b | ||
|
|
9bb1fb7166 | ||
|
|
454015b294 | ||
|
|
52fe8d358e | ||
|
|
fe453ed38e | ||
|
|
a8779f7055 | ||
|
|
c16d950136 | ||
|
|
e516f427cd | ||
|
|
84597e2fcd | ||
|
|
611fbd1dab | ||
|
|
77fc10defb | ||
|
|
5d641b932c | ||
|
|
a342b565e8 | ||
|
|
d580630ad2 | ||
|
|
7c844bf61d | ||
|
|
3c6309b4dd | ||
|
|
9a84460754 | ||
|
|
98af1d3d96 | ||
|
|
668b4060cb | ||
|
|
cb26fb9dca | ||
|
|
9833a41382 | ||
|
|
8e58a9385a | ||
|
|
89161b66a1 | ||
|
|
8fac321973 | ||
|
|
b96d760b9b | ||
|
|
760a87fe06 | ||
|
|
bb8a8d3399 | ||
|
|
2a0bcaf776 | ||
|
|
bafbde52fe | ||
|
|
53cd13a0fa | ||
|
|
15b0cc1df3 | ||
|
|
3c42d73ea7 | ||
|
|
f32ae43138 | ||
|
|
c3d2888c51 | ||
|
|
6d1a166fdc | ||
|
|
59be40cf12 | ||
|
|
78494bdb0f | ||
|
|
cce3d9ccfb | ||
|
|
f0a3466d9d | ||
|
|
e19e7f9bde | ||
|
|
0b7af9ac14 | ||
|
|
4551a2b9d7 | ||
|
|
e78da2a925 | ||
|
|
94b3cfd0f4 | ||
|
|
e3c1992ae9 | ||
|
|
ec31e931bf | ||
|
|
e1e768d7cf | ||
|
|
c44e224587 | ||
|
|
fed64ef244 | ||
|
|
bf98a0308c | ||
|
|
5179d0db37 | ||
|
|
100d68d67e | ||
|
|
eed8165ec1 |
27
.github/workflows/ci.yml
vendored
Normal file
27
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
name: CI
|
||||||
|
on: [push, pull_request]
|
||||||
|
jobs:
|
||||||
|
tests:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
ruby-version:
|
||||||
|
- "2.7"
|
||||||
|
- "3.1"
|
||||||
|
- "3.2"
|
||||||
|
continue-on-error: [false]
|
||||||
|
|
||||||
|
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: ${{ matrix.continue-on-error }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Install Ruby
|
||||||
|
uses: ruby/setup-ruby@v1
|
||||||
|
with:
|
||||||
|
ruby-version: ${{ matrix.ruby-version }}
|
||||||
|
bundler-cache: true
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: bin/test
|
||||||
1
Gemfile
1
Gemfile
@@ -4,3 +4,4 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
|||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
gem "debug"
|
gem "debug"
|
||||||
|
gem "railties"
|
||||||
|
|||||||
14
Gemfile.lock
14
Gemfile.lock
@@ -1,9 +1,11 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
mrsk (0.0.3)
|
mrsk (0.4.0)
|
||||||
railties (>= 7.0.0)
|
activesupport (>= 7.0)
|
||||||
|
dotenv (~> 2.8)
|
||||||
sshkit (~> 1.21)
|
sshkit (~> 1.21)
|
||||||
|
thor (~> 1.2)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
@@ -32,6 +34,7 @@ GEM
|
|||||||
debug (1.7.1)
|
debug (1.7.1)
|
||||||
irb (>= 1.5.0)
|
irb (>= 1.5.0)
|
||||||
reline (>= 0.3.1)
|
reline (>= 0.3.1)
|
||||||
|
dotenv (2.8.1)
|
||||||
erubi (1.12.0)
|
erubi (1.12.0)
|
||||||
i18n (1.12.0)
|
i18n (1.12.0)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
@@ -46,11 +49,11 @@ GEM
|
|||||||
net-scp (4.0.0)
|
net-scp (4.0.0)
|
||||||
net-ssh (>= 2.6.5, < 8.0.0)
|
net-ssh (>= 2.6.5, < 8.0.0)
|
||||||
net-ssh (7.0.1)
|
net-ssh (7.0.1)
|
||||||
nokogiri (1.14.0.rc1-arm64-darwin)
|
nokogiri (1.14.0-arm64-darwin)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
nokogiri (1.14.0.rc1-x86_64-darwin)
|
nokogiri (1.14.0-x86_64-darwin)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
nokogiri (1.14.0.rc1-x86_64-linux)
|
nokogiri (1.14.0-x86_64-linux)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
racc (1.6.2)
|
racc (1.6.2)
|
||||||
rack (2.2.5)
|
rack (2.2.5)
|
||||||
@@ -90,6 +93,7 @@ PLATFORMS
|
|||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
debug
|
debug
|
||||||
mrsk!
|
mrsk!
|
||||||
|
railties
|
||||||
|
|
||||||
BUNDLED WITH
|
BUNDLED WITH
|
||||||
2.4.3
|
2.4.3
|
||||||
|
|||||||
299
README.md
299
README.md
@@ -1,10 +1,10 @@
|
|||||||
# MRSK
|
# MRSK
|
||||||
|
|
||||||
MRSK ships zero-downtime deploys of Rails apps packed as containers to any host. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is wound down. It works seamlessly across multiple hosts, using SSHKit to execute commands.
|
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.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Add the gem with `bundle add mrsk`, then run `rake mrsk:init`, and then edit the new file in `config/deploy.yml`. It could look as simple as this:
|
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:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service: hey
|
service: hey
|
||||||
@@ -13,48 +13,57 @@ servers:
|
|||||||
- 192.168.0.1
|
- 192.168.0.1
|
||||||
- 192.168.0.2
|
- 192.168.0.2
|
||||||
registry:
|
registry:
|
||||||
username: <%= Rails.application.credentials.registry["username"] %>
|
username: registry-user-name
|
||||||
password: <%= Rails.application.credentials.registry["password"] %>
|
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
||||||
```
|
|
||||||
|
|
||||||
Then ensure your encrypted credentials have the registry username + password by editing them with `rails credentials:edit`:
|
|
||||||
|
|
||||||
```
|
|
||||||
registry:
|
|
||||||
username: real-user-name
|
|
||||||
password: real-registry-password-or-token
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you're ready to deploy a multi-arch image to the servers:
|
Now you're ready to deploy a multi-arch image to the servers:
|
||||||
|
|
||||||
```
|
```
|
||||||
./bin/mrsk deploy
|
MRSK_REGISTRY_PASSWORD=pw mrsk deploy
|
||||||
```
|
```
|
||||||
|
|
||||||
This will:
|
This will:
|
||||||
|
|
||||||
1. Log into the registry both locally and remotely
|
1. Connect to the servers over SSH (using root by default, authenticated by your loaded ssh key)
|
||||||
2. Build the image using the standard Dockerfile in the root of the application.
|
2. Install Docker on any server that might be missing it (using apt-get)
|
||||||
3. Push the image to the registry.
|
3. Log into the registry both locally and remotely
|
||||||
4. Pull the image from the registry on the servers.
|
4. Build the image using the standard Dockerfile in the root of the application.
|
||||||
5. Ensure Traefik is running and accepting traffic on port 80.
|
5. Push the image to the registry.
|
||||||
6. Stop any containers running a previous versions of the app.
|
6. Pull the image from the registry on the servers.
|
||||||
7. Start a new container with the version of the app that matches the current git version hash.
|
7. Ensure Traefik is running and accepting traffic on port 80.
|
||||||
8. Prune unused images and stopped containers to ensure servers don't fill up.
|
8. Stop any containers running a previous versions of the app.
|
||||||
|
9. Start a new container with the version of the app that matches the current git version hash.
|
||||||
|
10. 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?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
### Using .env file to load required environment variables
|
||||||
|
|
||||||
|
MRSK uses [dotenv](https://github.com/bkeepers/dotenv) to automatically load environment variables set in the `.env` file present in the application root. This file can be used to set variables like `MRSK_REGISTRY_PASSWORD` or database passwords. But for this reason you must ensure that .env files are not checked into Git or included in your Dockerfile! The format is just key-value like:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
MRSK_REGISTRY_PASSWORD=pw
|
||||||
|
DB_PASSWORD=secret123
|
||||||
|
```
|
||||||
|
|
||||||
### Using another registry than Docker Hub
|
### Using another registry than Docker Hub
|
||||||
|
|
||||||
The default registry for Docker is Docker Hub. If you'd like to use a different one, just configure the server, like so:
|
The default registry is Docker Hub, but you can change it using `registry/server`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
registry:
|
registry:
|
||||||
server: registry.digitalocean.com
|
server: registry.digitalocean.com
|
||||||
username: <%= Rails.application.credentials.registry["username"] %>
|
username: registry-user-name
|
||||||
password: <%= Rails.application.credentials.registry["password"] %>
|
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using a different SSH user than root
|
### Using a different SSH user than root
|
||||||
@@ -65,9 +74,9 @@ The default SSH user is root, but you can change it using `ssh_user`:
|
|||||||
ssh_user: app
|
ssh_user: app
|
||||||
```
|
```
|
||||||
|
|
||||||
### Adding custom env variables
|
### Using env variables
|
||||||
|
|
||||||
You can inject custom env variables into the app containers using `env`:
|
You can inject env variables into the app containers using `env`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
env:
|
env:
|
||||||
@@ -75,9 +84,38 @@ env:
|
|||||||
REDIS_URL: redis://redis1:6379/1
|
REDIS_URL: redis://redis1:6379/1
|
||||||
```
|
```
|
||||||
|
|
||||||
### Splitting servers into different roles
|
### Using secret env variables
|
||||||
|
|
||||||
If your application uses separate hosts for running jobs or other roles beyond the default web running, you can specify these hosts and their custom entrypoint command like so:
|
If you have env variables that are secret, you can divide the `env` block into `clear` and `secret`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
env:
|
||||||
|
clear:
|
||||||
|
DATABASE_URL: mysql2://db1/hey_production/
|
||||||
|
REDIS_URL: redis://redis1:6379/1
|
||||||
|
secret:
|
||||||
|
- DATABASE_PASSWORD
|
||||||
|
- REDIS_PASSWORD
|
||||||
|
```
|
||||||
|
|
||||||
|
The list of secret env variables will be expanded at run time from your local machine. So a reference to a secret `DATABASE_PASSWORD` will look for `ENV["DATABASE_PASSWORD"]` on the machine running MRSK. Just like with build secrets.
|
||||||
|
|
||||||
|
If the referenced secret ENVs are missing, the configuration will be halted with a `KeyError` exception.
|
||||||
|
|
||||||
|
Note: Marking an ENV as secret currently only redacts its value in the output for MRSK. The ENV is still injected in the clear into the container at runtime.
|
||||||
|
|
||||||
|
### Using volumes
|
||||||
|
|
||||||
|
You can add custom volumes into the app containers using `volumes`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
volumes:
|
||||||
|
- "/local/path:/container/path"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using different roles for servers
|
||||||
|
|
||||||
|
If your application uses separate hosts for running jobs or other roles beyond the default web running, you can specify these hosts in a dedicated role with a new entrypoint command like so:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
servers:
|
servers:
|
||||||
@@ -91,23 +129,35 @@ servers:
|
|||||||
cmd: bin/jobs
|
cmd: bin/jobs
|
||||||
```
|
```
|
||||||
|
|
||||||
Traefik will only be installed and run on the servers in the `web` role (and on all servers if no roles are defined).
|
Note: Traefik will only by default be installed and run on the servers in the `web` role (and on all servers if no roles are defined). If you need Traefik on hosts in other roles than `web`, add `traefik: true`:
|
||||||
|
|
||||||
### Adding custom container labels
|
```yaml
|
||||||
|
servers:
|
||||||
|
web:
|
||||||
|
- 192.168.0.1
|
||||||
|
- 192.168.0.2
|
||||||
|
web2:
|
||||||
|
traefik: true
|
||||||
|
hosts:
|
||||||
|
- 192.168.0.3
|
||||||
|
- 192.168.0.4
|
||||||
|
```
|
||||||
|
|
||||||
You can specialize the default Traefik rules by setting custom labels on the containers that are being started:
|
### Using container labels
|
||||||
|
|
||||||
|
You can specialize the default Traefik rules by setting labels on the containers that are being started:
|
||||||
|
|
||||||
```
|
```
|
||||||
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 extra quotes are needed to ensure the rule is passed in correctly!
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
The labels can even be applied on a per-role basis:
|
The labels can also be applied on a per-role basis:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
servers:
|
servers:
|
||||||
@@ -120,60 +170,159 @@ servers:
|
|||||||
- 192.168.0.4
|
- 192.168.0.4
|
||||||
cmd: bin/jobs
|
cmd: bin/jobs
|
||||||
labels:
|
labels:
|
||||||
my-custom-label: "50"
|
my-label: "50"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuring remote builder for native multi-arch
|
### Using remote builder for native multi-arch
|
||||||
|
|
||||||
If you're developing on ARM64 (like Apple Silicon), but you want to deploy on AMD64 (x86 64-bit), you have to use multi-archecture images. By default, MRSK will setup a local buildx configuration that allows for this through QEMU emulation. This can be slow, especially on the first build.
|
If you're developing on ARM64 (like Apple Silicon), but you want to deploy on AMD64 (x86 64-bit), you can use multi-archecture images. By default, MRSK will setup a local buildx configuration that does this through QEMU emulation. But this can be quite slow, especially on the first build.
|
||||||
|
|
||||||
If you want to speed up this process by using a remote AMD64 host to natively build the AMD64 part of the image, while natively building the ARM64 part locally, you can do so using builder options like follows:
|
If you want to speed up this process by using a remote AMD64 host to natively build the AMD64 part of the image, while natively building the ARM64 part locally, you can do so using builder options:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
builder:
|
builder:
|
||||||
local:
|
local:
|
||||||
arch: arm64
|
arch: arm64
|
||||||
host: unix:///Users/dhh/.docker/run/docker.sock
|
host: unix:///Users/<%= `whoami`.strip %>/.docker/run/docker.sock
|
||||||
remote:
|
remote:
|
||||||
arch: amd64
|
arch: amd64
|
||||||
host: ssh://root@192.168.0.1
|
host: ssh://root@192.168.0.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: You must have Docker running on the remote host being used as a builder.
|
Note: You must have Docker running on the remote host being used as a builder. This instance should only be shared for builds using the same registry and credentials.
|
||||||
|
|
||||||
With that configuration in place, you can setup the local/remote configuration using `./bin/mrsk build:remote:create`. If you wish to remove the contexts and buildx instances again, you can run `./bin/mrsk build:remote:remove`. If you had already built using the standard emulation setup, run `./bin/mrsk build:remove` before doing `./bin/mrsk build:remote:create`.
|
### Using remote builder for single-arch
|
||||||
|
|
||||||
### Configuring native builder when multi-arch isn't needed
|
If you're developing on ARM64 (like Apple Silicon), want to deploy on AMD64 (x86 64-bit), but don't need to run the image locally (or on other ARM64 hosts), you can configure a remote builder that just targets AMD64. This is a bit faster than building with multi-arch, as there's nothing to build locally.
|
||||||
|
|
||||||
If you're developing on the same architecture as the one you're deploying on, you can speed up the build a lot by forgoing a multi-arch image. This can be done by configuring the builder like so:
|
```yaml
|
||||||
|
builder:
|
||||||
|
remote:
|
||||||
|
arch: amd64
|
||||||
|
host: ssh://root@192.168.0.1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using native builder when multi-arch isn't needed
|
||||||
|
|
||||||
|
If you're developing on the same architecture as the one you're deploying on, you can speed up the build by forgoing both multi-arch and remote building:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
builder:
|
builder:
|
||||||
multiarch: false
|
multiarch: false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This is also a good option if you're running MRSK from a CI server that shares architecture with the deployment servers.
|
||||||
|
|
||||||
|
### Using build secrets for new images
|
||||||
|
|
||||||
|
Some images need a secret passed in during build time, like a GITHUB_TOKEN to give access to private gem repositories. This can be done by having the secret in ENV, then referencing it in the builder configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
builder:
|
||||||
|
secrets:
|
||||||
|
- GITHUB_TOKEN
|
||||||
|
```
|
||||||
|
|
||||||
|
This build secret can then be referenced in the Dockerfile:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Copy Gemfiles
|
||||||
|
COPY Gemfile Gemfile.lock ./
|
||||||
|
|
||||||
|
# Install dependencies, including private repositories via access token
|
||||||
|
RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||||
|
BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||||
|
bundle install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using command arguments for Traefik
|
||||||
|
|
||||||
|
You can customize the traefik command line:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
traefik:
|
||||||
|
accesslog: true
|
||||||
|
accesslog.format: json
|
||||||
|
metrics.prometheus: true
|
||||||
|
metrics.prometheus.buckets: 0.1,0.3,1.2,5.0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuring build args for new images
|
||||||
|
|
||||||
|
Build arguments that aren't secret can also be configured:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
builder:
|
||||||
|
args:
|
||||||
|
RUBY_VERSION: 3.2.0
|
||||||
|
```
|
||||||
|
|
||||||
|
This build argument can then be used in the Dockerfile:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Private repositories need an access token during the build
|
||||||
|
ARG RUBY_VERSION
|
||||||
|
FROM ruby:$RUBY_VERSION-slim as base
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
accessories:
|
||||||
|
mysql:
|
||||||
|
image: mysql:5.7
|
||||||
|
host: 1.1.1.3
|
||||||
|
port: 3306
|
||||||
|
env:
|
||||||
|
clear:
|
||||||
|
MYSQL_ROOT_HOST: '%'
|
||||||
|
secret:
|
||||||
|
- MYSQL_ROOT_PASSWORD
|
||||||
|
volumes:
|
||||||
|
- /var/lib/mysql:/var/lib/mysql
|
||||||
|
redis:
|
||||||
|
image: redis:latest
|
||||||
|
host: 1.1.1.4
|
||||||
|
port: "36379:6379"
|
||||||
|
volumes:
|
||||||
|
- /var/lib/redis:/data
|
||||||
|
```
|
||||||
|
|
||||||
|
Now run `mrsk accessory start mysql` to start the MySQL server on 1.1.1.3. See `mrsk accessory` for all the commands possible.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### Remote execution
|
### Running remote execution and runners
|
||||||
|
|
||||||
If you need to execute commands inside the Rails containers, you can use `./bin/mrsk app:exec`, `./bin/mrsk app:exec:once`, `./bin/mrsk app:exec:rails`, and `./bin/mrsk app:exec:once:rails`. Examples:
|
If you need to execute commands inside the Rails containers, you can use `mrsk app exec` and `mrsk app runner`. Examples:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Runs command on all servers
|
# Runs command on all servers
|
||||||
./bin/mrsk app:exec CMD='ruby -v'
|
mrsk app exec 'ruby -v'
|
||||||
App Host: xxx.xxx.xxx.xxx
|
App Host: 192.168.0.1
|
||||||
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
||||||
|
|
||||||
App Host: xxx.xxx.xxx.xxx
|
App Host: 192.168.0.2
|
||||||
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
||||||
|
|
||||||
# Runs command on first server
|
# Runs command on primary server
|
||||||
./bin/mrsk app:exec:once CMD='cat .ruby-version'
|
mrsk app exec --primary 'cat .ruby-version'
|
||||||
|
App Host: 192.168.0.1
|
||||||
3.1.3
|
3.1.3
|
||||||
|
|
||||||
# Runs Rails command on all servers
|
# Runs Rails command on all servers
|
||||||
./bin/mrsk app:exec:rails CMD=about
|
mrsk app exec 'bin/rails about'
|
||||||
App Host: xxx.xxx.xxx.xxx
|
App Host: 192.168.0.1
|
||||||
About your application's environment
|
About your application's environment
|
||||||
Rails version 7.1.0.alpha
|
Rails version 7.1.0.alpha
|
||||||
Ruby version ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
Ruby version ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
||||||
@@ -185,7 +334,7 @@ Environment production
|
|||||||
Database adapter sqlite3
|
Database adapter sqlite3
|
||||||
Database schema version 20221231233303
|
Database schema version 20221231233303
|
||||||
|
|
||||||
App Host: xxx.xxx.xxx.xxx
|
App Host: 192.168.0.2
|
||||||
About your application's environment
|
About your application's environment
|
||||||
Rails version 7.1.0.alpha
|
Rails version 7.1.0.alpha
|
||||||
Ruby version ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
Ruby version ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x86_64-linux]
|
||||||
@@ -197,70 +346,66 @@ Environment production
|
|||||||
Database adapter sqlite3
|
Database adapter sqlite3
|
||||||
Database schema version 20221231233303
|
Database schema version 20221231233303
|
||||||
|
|
||||||
# Runs Rails command on first server
|
# Run Rails runner on primary server
|
||||||
./bin/mrsk app:exec:once:rails CMD='db:version'
|
mrsk app runner -p 'puts Rails.application.config.time_zone'
|
||||||
database: storage/production.sqlite3
|
UTC
|
||||||
Current version: 20221231233303
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running a Rails console on the primary host
|
### Running a Rails console
|
||||||
|
|
||||||
If you need to interact with the production console for the app, you can use `./bin/mrsk app:console`, which will start a Rails console session on the primary host. Be mindful that this is a live wire! Any changes made to the production database will take effect immeditately.
|
If you need to interact with the production console for the app, you can use `mrsk app console`, which will start a Rails console session on the primary host. You can start the console on a different host using `mrsk app console --host 192.168.0.2`. Be mindful that this is a live wire! Any changes made to the production database will take effect immeditately.
|
||||||
|
|
||||||
### Inspecting
|
### Running details to see state of containers
|
||||||
|
|
||||||
You can see the state of your servers by running `./bin/mrsk info`. It'll show something like this:
|
You can see the state of your servers by running `mrsk details`:
|
||||||
|
|
||||||
```
|
```
|
||||||
Traefik Host: xxx.xxx.xxx.xxx
|
Traefik Host: 192.168.0.1
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
6195b2a28c81 traefik "/entrypoint.sh --pr…" 30 minutes ago Up 19 minutes 0.0.0.0:80->80/tcp, :::80->80/tcp traefik
|
6195b2a28c81 traefik "/entrypoint.sh --pr…" 30 minutes ago Up 19 minutes 0.0.0.0:80->80/tcp, :::80->80/tcp traefik
|
||||||
|
|
||||||
Traefik Host: 164.92.105.119
|
Traefik Host: 192.168.0.2
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
de14a335d152 traefik "/entrypoint.sh --pr…" 30 minutes ago Up 19 minutes 0.0.0.0:80->80/tcp, :::80->80/tcp traefik
|
de14a335d152 traefik "/entrypoint.sh --pr…" 30 minutes ago Up 19 minutes 0.0.0.0:80->80/tcp, :::80->80/tcp traefik
|
||||||
|
|
||||||
App Host: 164.90.145.60
|
App Host: 192.168.0.1
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
badb1aa51db3 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 13 minutes ago Up 13 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
badb1aa51db3 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 13 minutes ago Up 13 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
||||||
|
|
||||||
App Host: 164.92.105.119
|
App Host: 192.168.0.2
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
1d3c91ed1f55 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 13 minutes ago Up 13 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
1d3c91ed1f55 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 13 minutes ago Up 13 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also see just info for app containers with `./bin/mrsk app:info` or just for Traefik with `./bin/mrsk traefik:info`.
|
You can also see just info for app containers with `mrsk app details` or just for Traefik with `mrsk traefik details`.
|
||||||
|
|
||||||
### Rollback
|
### Running rollback to fix a bad deploy
|
||||||
|
|
||||||
If you've discovered a bad deploy, you can quickly rollback by reactivating the old, paused container image. You can see what old containers are available for rollback by running `./bin/mrsk app:containers`. It'll give you a presentation similar to `./bin/mrsk app:info`, but include all the old containers as well. Showing something like this:
|
If you've discovered a bad deploy, you can quickly rollback by reactivating the old, paused container image. You can see what old containers are available for rollback by running `mrsk app containers`. It'll give you a presentation similar to `mrsk app details`, but include all the old containers as well. Showing something like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
App Host: 164.92.105.119
|
App Host: 192.168.0.1
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
1d3c91ed1f51 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 19 minutes ago Up 19 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
1d3c91ed1f51 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 19 minutes ago Up 19 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
||||||
539f26b28369 registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4 "/rails/bin/docker-e…" 31 minutes ago Exited (1) 27 minutes ago chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
|
539f26b28369 registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4 "/rails/bin/docker-e…" 31 minutes ago Exited (1) 27 minutes ago chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
|
||||||
|
|
||||||
App Host: 164.90.145.60
|
App Host: 192.168.0.2
|
||||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||||
badb1aa51db4 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 19 minutes ago Up 19 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
badb1aa51db4 registry.digitalocean.com/user/app:6ef8a6a84c525b123c5245345a8483f86d05a123 "/rails/bin/docker-e…" 19 minutes ago Up 19 minutes 3000/tcp chat-6ef8a6a84c525b123c5245345a8483f86d05a123
|
||||||
6f170d1172ae registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4 "/rails/bin/docker-e…" 31 minutes ago Exited (1) 27 minutes ago chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
|
6f170d1172ae registry.digitalocean.com/user/app:e5d9d7c2b898289dfbc5f7f1334140d984eedae4 "/rails/bin/docker-e…" 31 minutes ago Exited (1) 27 minutes ago chat-e5d9d7c2b898289dfbc5f7f1334140d984eedae4
|
||||||
```
|
```
|
||||||
|
|
||||||
From the example above, we can see that `e5d9d7c2b898289dfbc5f7f1334140d984eedae4` was the last version, so it's available as a rollback target. We can perform this rollback by running `./bin/mrsk rollback VERSION=e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. That'll stop `6ef8a6a84c525b123c5245345a8483f86d05a123` and then start `e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. Because the old container is still available, this is very quick. Nothing to download from the registry.
|
From the example above, we can see that `e5d9d7c2b898289dfbc5f7f1334140d984eedae4` was the last version, so it's available as a rollback target. We can perform this rollback by running `mrsk rollback e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. That'll stop `6ef8a6a84c525b123c5245345a8483f86d05a123` and then start `e5d9d7c2b898289dfbc5f7f1334140d984eedae4`. Because the old container is still available, this is very quick. Nothing to download from the registry.
|
||||||
|
|
||||||
Note that by default old containers are pruned after 3 days when you run `./bin/mrsk deploy`.
|
Note that by default old containers are pruned after 3 days when you run `mrsk deploy`.
|
||||||
|
|
||||||
### Removing
|
### Running removal to clean up servers
|
||||||
|
|
||||||
If you wish to remove the entire application, including Traefik, containers, images, and registry session, you can run `./bin/mrsk remove`. This will leave the servers clean.
|
If you wish to remove the entire application, including Traefik, containers, images, and registry session, you can run `mrsk remove`. This will leave the servers clean.
|
||||||
|
|
||||||
## Stage of development
|
## Stage of development
|
||||||
|
|
||||||
This is alpha software. Lots of stuff is missing. Here are some of the areas we seek to improve:
|
This is alpha software. Lots of stuff is missing. Lots of stuff will keep moving around for a while.
|
||||||
|
|
||||||
- Adapterize commands to work with Podman and other container runners
|
|
||||||
- Integrate with cloud CI pipelines
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
17
bin/mrsk
Executable file
17
bin/mrsk
Executable file
@@ -0,0 +1,17 @@
|
|||||||
|
#!/usr/bin/env ruby
|
||||||
|
|
||||||
|
# Prevent failures from being reported twice.
|
||||||
|
Thread.report_on_exception = false
|
||||||
|
|
||||||
|
require "dotenv/load"
|
||||||
|
require "mrsk/cli"
|
||||||
|
|
||||||
|
begin
|
||||||
|
Mrsk::Cli::Main.start(ARGV)
|
||||||
|
rescue SSHKit::Runner::ExecuteError => e
|
||||||
|
puts " \e[31mERROR (#{e.cause.class}): #{e.cause.message}\e[0m"
|
||||||
|
puts e.cause.backtrace if ENV["VERBOSE"]
|
||||||
|
rescue => e
|
||||||
|
puts " \e[31mERROR (#{e.class}): #{e.message}\e[0m"
|
||||||
|
puts e.backtrace if ENV["VERBOSE"]
|
||||||
|
end
|
||||||
@@ -2,5 +2,4 @@ module Mrsk
|
|||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/version"
|
require "mrsk/version"
|
||||||
require "mrsk/engine"
|
|
||||||
require "mrsk/commander"
|
require "mrsk/commander"
|
||||||
|
|||||||
9
lib/mrsk/cli.rb
Normal file
9
lib/mrsk/cli.rb
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
require "mrsk"
|
||||||
|
|
||||||
|
module Mrsk::Cli
|
||||||
|
end
|
||||||
|
|
||||||
|
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||||
|
MRSK = Mrsk::Commander.new
|
||||||
|
|
||||||
|
require "mrsk/cli/main"
|
||||||
199
lib/mrsk/cli/accessory.rb
Normal file
199
lib/mrsk/cli/accessory.rb
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
require "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)"
|
||||||
|
def boot(name)
|
||||||
|
if name == "all"
|
||||||
|
MRSK.accessory_names.each { |accessory_name| boot(accessory_name) }
|
||||||
|
else
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
directories(name)
|
||||||
|
upload(name)
|
||||||
|
on(accessory.host) { execute *accessory.run }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "upload [NAME]", "Upload accessory files to host"
|
||||||
|
def upload(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) do
|
||||||
|
accessory.files.each do |(local, remote)|
|
||||||
|
accessory.ensure_local_file_present(local)
|
||||||
|
|
||||||
|
execute *accessory.make_directory_for(remote)
|
||||||
|
upload! local, remote
|
||||||
|
execute :chmod, "755", remote
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "directories [NAME]", "Create accessory directories on host"
|
||||||
|
def directories(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) do
|
||||||
|
accessory.directories.keys.each do |host_path|
|
||||||
|
execute *accessory.make_directory(host_path)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "reboot [NAME]", "Reboot accessory on host (stop container, remove container, start new container)"
|
||||||
|
def reboot(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
stop(name)
|
||||||
|
remove_container(name)
|
||||||
|
boot(name)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "start [NAME]", "Start existing accessory on host"
|
||||||
|
def start(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { execute *accessory.start }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "stop [NAME]", "Stop accessory on host"
|
||||||
|
def stop(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { execute *accessory.stop, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "restart [NAME]", "Restart accessory on host"
|
||||||
|
def restart(name)
|
||||||
|
with_accessory(name) do
|
||||||
|
stop(name)
|
||||||
|
start(name)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "details [NAME]", "Display details about accessory on host (use NAME=all to boot all accessories)"
|
||||||
|
def details(name)
|
||||||
|
if name == "all"
|
||||||
|
MRSK.accessory_names.each { |accessory_name| details(accessory_name) }
|
||||||
|
else
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { puts capture_with_info(*accessory.info) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "exec [NAME] [CMD]", "Execute a custom command on accessory host"
|
||||||
|
option :method, aliases: "-m", default: "exec", desc: "Execution method: [exec] perform inside container / [run] perform in new container / [ssh] perform over ssh"
|
||||||
|
def exec(name, cmd)
|
||||||
|
runner = \
|
||||||
|
case options[:method]
|
||||||
|
when "exec" then "exec"
|
||||||
|
when "run" then "run_exec"
|
||||||
|
when "ssh_exec" then "exec_over_ssh"
|
||||||
|
when "ssh_run" then "run_over_ssh"
|
||||||
|
else raise "Unknown method: #{options[:method]}"
|
||||||
|
end.inquiry
|
||||||
|
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
if runner.exec_over_ssh? || runner.run_over_ssh?
|
||||||
|
run_locally do
|
||||||
|
info "Launching command on #{accessory.host}"
|
||||||
|
exec accessory.send(runner, cmd)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
on(accessory.host) do
|
||||||
|
info "Launching command on #{accessory.host}"
|
||||||
|
execute *accessory.send(runner, cmd)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "bash [NAME]", "Start a bash session on primary host (or specific host set by --hosts)"
|
||||||
|
def bash(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
run_locally do
|
||||||
|
info "Launching bash session on #{accessory.host}"
|
||||||
|
exec accessory.bash
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "logs [NAME]", "Show log lines from accessory on host"
|
||||||
|
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 :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||||
|
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||||
|
def logs(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
grep = options[:grep]
|
||||||
|
|
||||||
|
if options[:follow]
|
||||||
|
run_locally do
|
||||||
|
info "Following logs on #{accessory.host}..."
|
||||||
|
info accessory.follow_logs(grep: grep)
|
||||||
|
exec accessory.follow_logs(grep: grep)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
since = options[:since]
|
||||||
|
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||||
|
|
||||||
|
on(accessory.host) do
|
||||||
|
puts capture_with_info(*accessory.logs(since: since, lines: lines, grep: grep))
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove [NAME]", "Remove accessory container and image from host (use NAME=all to boot all accessories)"
|
||||||
|
def remove(name)
|
||||||
|
if name == "all"
|
||||||
|
MRSK.accessory_names.each { |accessory_name| remove(accessory_name) }
|
||||||
|
else
|
||||||
|
with_accessory(name) do
|
||||||
|
stop(name)
|
||||||
|
remove_container(name)
|
||||||
|
remove_image(name)
|
||||||
|
remove_service_directory(name)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container [NAME]", "Remove accessory container from host"
|
||||||
|
def remove_container(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { execute *accessory.remove_container }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container [NAME]", "Remove accessory image from host"
|
||||||
|
def remove_image(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { execute *accessory.remove_image }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_service_directory [NAME]", "Remove accessory directory used for uploaded files and data directories from host"
|
||||||
|
def remove_service_directory(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) { execute *accessory.remove_service_directory }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def with_accessory(name)
|
||||||
|
if accessory = MRSK.accessory(name)
|
||||||
|
yield accessory
|
||||||
|
else
|
||||||
|
error_on_missing_accessory(name)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def error_on_missing_accessory(name)
|
||||||
|
options = MRSK.accessory_names.presence
|
||||||
|
|
||||||
|
error \
|
||||||
|
"No accessory by the name of '#{name}'" +
|
||||||
|
(options ? " (options: #{options.to_sentence})" : "")
|
||||||
|
end
|
||||||
|
end
|
||||||
137
lib/mrsk/cli/app.rb
Normal file
137
lib/mrsk/cli/app.rb
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::App < Mrsk::Cli::Base
|
||||||
|
desc "boot", "Boot app on servers (or start them if they've already been booted)"
|
||||||
|
def boot
|
||||||
|
MRSK.config.roles.each do |role|
|
||||||
|
on(role.hosts) do |host|
|
||||||
|
begin
|
||||||
|
execute *MRSK.app.run(role: role.name)
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /already in use/
|
||||||
|
error "Container with same version already deployed on #{host}, starting that instead"
|
||||||
|
execute *MRSK.app.start, host: host
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
|
||||||
|
option :version, desc: "Defaults to the most recent git-hash in local repository"
|
||||||
|
def start
|
||||||
|
if (version = options[:version]).present?
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.start(version: version) }
|
||||||
|
else
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "stop", "Stop app on servers"
|
||||||
|
def stop
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "details", "Display details about app containers"
|
||||||
|
def details
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.info) }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "exec [CMD]", "Execute a custom command on servers"
|
||||||
|
option :method, aliases: "-m", default: "exec", desc: "Execution method: [exec] perform inside app container / [run] perform in new container / [ssh] perform over ssh"
|
||||||
|
def exec(cmd)
|
||||||
|
runner = \
|
||||||
|
case options[:method]
|
||||||
|
when "exec" then "exec"
|
||||||
|
when "run" then "run_exec"
|
||||||
|
when "ssh" then "exec_over_ssh"
|
||||||
|
else raise "Unknown method: #{options[:method]}"
|
||||||
|
end.inquiry
|
||||||
|
|
||||||
|
if runner.exec_over_ssh?
|
||||||
|
run_locally do
|
||||||
|
info "Launching command on #{MRSK.primary_host}"
|
||||||
|
exec MRSK.app.exec_over_ssh(cmd, host: MRSK.primary_host)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.send(runner, cmd)) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "console", "Start Rails Console on primary host (or specific host set by --hosts)"
|
||||||
|
def console
|
||||||
|
run_locally do
|
||||||
|
info "Launching Rails console on #{MRSK.primary_host}"
|
||||||
|
exec MRSK.app.console(host: MRSK.primary_host)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "bash", "Start a bash session on primary host (or specific host set by --hosts)"
|
||||||
|
def bash
|
||||||
|
run_locally do
|
||||||
|
info "Launching bash session on #{MRSK.primary_host}"
|
||||||
|
exec MRSK.app.bash(host: MRSK.primary_host)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "runner [EXPRESSION]", "Execute Rails runner with given expression"
|
||||||
|
def runner(expression)
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.exec("bin/rails", "runner", "'#{expression}'")) }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "containers", "List all the app containers currently on servers"
|
||||||
|
def containers
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_containers) }
|
||||||
|
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"
|
||||||
|
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 :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||||
|
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||||
|
def logs
|
||||||
|
# FIXME: Catch when app containers aren't running
|
||||||
|
|
||||||
|
grep = options[:grep]
|
||||||
|
|
||||||
|
if options[:follow]
|
||||||
|
run_locally do
|
||||||
|
info "Following logs on #{MRSK.primary_host}..."
|
||||||
|
info MRSK.app.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
|
exec MRSK.app.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
since = options[:since]
|
||||||
|
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||||
|
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
begin
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.app.logs(since: since, lines: lines, grep: grep))
|
||||||
|
rescue SSHKit::Command::Failed
|
||||||
|
puts_by_host host, "Nothing found"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove", "Remove app containers and images from servers"
|
||||||
|
option :only, default: "", desc: "Use 'containers' or 'images'"
|
||||||
|
def remove
|
||||||
|
case options[:only]
|
||||||
|
when "containers"
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.remove_containers }
|
||||||
|
when "images"
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.remove_images }
|
||||||
|
else
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.remove_containers }
|
||||||
|
on(MRSK.hosts) { execute *MRSK.app.remove_images }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
57
lib/mrsk/cli/base.rb
Normal file
57
lib/mrsk/cli/base.rb
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
require "thor"
|
||||||
|
require "mrsk/sshkit_with_ext"
|
||||||
|
|
||||||
|
module Mrsk::Cli
|
||||||
|
class Base < Thor
|
||||||
|
include SSHKit::DSL
|
||||||
|
|
||||||
|
def self.exit_on_failure?() true end
|
||||||
|
|
||||||
|
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
||||||
|
class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal logging"
|
||||||
|
|
||||||
|
class_option :version, desc: "Run commands against a specific app version"
|
||||||
|
|
||||||
|
class_option :primary, type: :boolean, aliases: "-p", desc: "Run commands only on primary host instead of all"
|
||||||
|
class_option :hosts, aliases: "-h", desc: "Run commands on these hosts instead of all (separate by comma)"
|
||||||
|
class_option :roles, aliases: "-r", desc: "Run commands on these roles instead of all (separate by comma)"
|
||||||
|
|
||||||
|
class_option :config_file, aliases: "-c", default: "config/deploy.yml", desc: "Path to config file (default: config/deploy.yml)"
|
||||||
|
class_option :destination, aliases: "-d", desc: "Specify destination to be used for config file (west -> deploy.west.yml)"
|
||||||
|
|
||||||
|
def initialize(*)
|
||||||
|
super
|
||||||
|
initialize_commander(options)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def initialize_commander(options)
|
||||||
|
MRSK.tap do |commander|
|
||||||
|
commander.config_file = Pathname.new(File.expand_path(options[:config_file]))
|
||||||
|
commander.destination = options[:destination]
|
||||||
|
commander.version = options[:version]
|
||||||
|
|
||||||
|
commander.specific_hosts = options[:hosts]&.split(",")
|
||||||
|
commander.specific_roles = options[:roles]&.split(",")
|
||||||
|
commander.specific_primary! if options[:primary]
|
||||||
|
|
||||||
|
if options[:verbose]
|
||||||
|
ENV["VERBOSE"] = "1" # For backtraces via cli/start
|
||||||
|
commander.verbosity = :debug
|
||||||
|
end
|
||||||
|
|
||||||
|
if options[:quiet]
|
||||||
|
commander.verbosity = :error
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def print_runtime
|
||||||
|
started_at = Time.now
|
||||||
|
yield
|
||||||
|
ensure
|
||||||
|
runtime = Time.now - started_at
|
||||||
|
puts " Finished all in #{sprintf("%.1f seconds", runtime)}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
68
lib/mrsk/cli/build.rb
Normal file
68
lib/mrsk/cli/build.rb
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::Build < Mrsk::Cli::Base
|
||||||
|
desc "deliver", "Deliver a newly built app image to servers"
|
||||||
|
def deliver
|
||||||
|
invoke :push
|
||||||
|
invoke :pull
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "push", "Build locally and push app image to registry"
|
||||||
|
def push
|
||||||
|
cli = self
|
||||||
|
|
||||||
|
run_locally do
|
||||||
|
begin
|
||||||
|
MRSK.with_verbosity(:debug) { execute *MRSK.builder.push }
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /(no builder)|(no such file or directory)/
|
||||||
|
error "Missing compatible builder, so creating a new one first"
|
||||||
|
|
||||||
|
if cli.create
|
||||||
|
MRSK.with_verbosity(:debug) { execute *MRSK.builder.push }
|
||||||
|
end
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "pull", "Pull app image from the registry onto servers"
|
||||||
|
def pull
|
||||||
|
on(MRSK.hosts) { execute *MRSK.builder.pull }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "create", "Create a local build setup"
|
||||||
|
def create
|
||||||
|
run_locally do
|
||||||
|
begin
|
||||||
|
debug "Using builder: #{MRSK.builder.name}"
|
||||||
|
execute *MRSK.builder.create
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /stderr=(.*)/
|
||||||
|
error "Couldn't create remote builder: #{$1}"
|
||||||
|
false
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove", "Remove local build setup"
|
||||||
|
def remove
|
||||||
|
run_locally do
|
||||||
|
debug "Using builder: #{MRSK.builder.name}"
|
||||||
|
execute *MRSK.builder.remove
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "details", "Show the name of the configured builder"
|
||||||
|
def details
|
||||||
|
run_locally do
|
||||||
|
puts "Builder: #{MRSK.builder.name}"
|
||||||
|
puts capture(*MRSK.builder.info)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
120
lib/mrsk/cli/main.rb
Normal file
120
lib/mrsk/cli/main.rb
Normal file
@@ -0,0 +1,120 @@
|
|||||||
|
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
|
||||||
|
desc "setup", "Setup all accessories and deploy the app to servers"
|
||||||
|
def setup
|
||||||
|
print_runtime do
|
||||||
|
invoke "mrsk:cli:server:bootstrap"
|
||||||
|
invoke "mrsk:cli:accessory:boot", [ "all" ]
|
||||||
|
deploy
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "deploy", "Deploy the app to servers"
|
||||||
|
def deploy
|
||||||
|
print_runtime do
|
||||||
|
invoke "mrsk:cli:server:bootstrap"
|
||||||
|
invoke "mrsk:cli:registry:login"
|
||||||
|
invoke "mrsk:cli:build:deliver"
|
||||||
|
invoke "mrsk:cli:traefik:boot"
|
||||||
|
invoke "mrsk:cli:app:stop"
|
||||||
|
invoke "mrsk:cli:app:boot"
|
||||||
|
invoke "mrsk:cli:prune:all"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
|
||||||
|
def redeploy
|
||||||
|
print_runtime do
|
||||||
|
invoke "mrsk:cli:build:deliver"
|
||||||
|
invoke "mrsk:cli:app:stop"
|
||||||
|
invoke "mrsk:cli:app:boot"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "rollback [VERSION]", "Rollback the app to VERSION (that must already be on servers)"
|
||||||
|
def rollback(version)
|
||||||
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
|
execute *MRSK.app.start(version: version)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "details", "Display details about Traefik and app containers"
|
||||||
|
def details
|
||||||
|
invoke "mrsk:cli:traefik:details"
|
||||||
|
invoke "mrsk:cli:app:details"
|
||||||
|
invoke "mrsk:cli:accessory:details", [ "all" ]
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "config", "Show combined config"
|
||||||
|
def config
|
||||||
|
run_locally do
|
||||||
|
puts MRSK.config.to_h.to_yaml
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "install", "Create config stub in config/deploy.yml and binstub in bin/mrsk"
|
||||||
|
option :skip_binstub, type: :boolean, default: false, desc: "Skip adding MRSK to the Gemfile and creating bin/mrsk binstub"
|
||||||
|
def install
|
||||||
|
require "fileutils"
|
||||||
|
|
||||||
|
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)"
|
||||||
|
else
|
||||||
|
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
||||||
|
puts "Created configuration file in config/deploy.yml"
|
||||||
|
end
|
||||||
|
|
||||||
|
unless options[:skip_binstub]
|
||||||
|
if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
|
||||||
|
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
||||||
|
else
|
||||||
|
`bundle add mrsk`
|
||||||
|
`bundle binstubs mrsk`
|
||||||
|
puts "Created binstub file in bin/mrsk"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove", "Remove Traefik, app, and registry session from servers"
|
||||||
|
def remove
|
||||||
|
invoke "mrsk:cli:traefik:remove"
|
||||||
|
invoke "mrsk:cli:app:remove"
|
||||||
|
invoke "mrsk:cli:registry:logout"
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "version", "Display the MRSK version"
|
||||||
|
def version
|
||||||
|
puts Mrsk::VERSION
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "accessory", "Manage the accessories"
|
||||||
|
subcommand "accessory", Mrsk::Cli::Accessory
|
||||||
|
|
||||||
|
desc "app", "Manage the application"
|
||||||
|
subcommand "app", Mrsk::Cli::App
|
||||||
|
|
||||||
|
desc "build", "Build the application image"
|
||||||
|
subcommand "build", Mrsk::Cli::Build
|
||||||
|
|
||||||
|
desc "prune", "Prune old application images and containers"
|
||||||
|
subcommand "prune", Mrsk::Cli::Prune
|
||||||
|
|
||||||
|
desc "registry", "Login and out of the image registry"
|
||||||
|
subcommand "registry", Mrsk::Cli::Registry
|
||||||
|
|
||||||
|
desc "server", "Bootstrap servers with Docker"
|
||||||
|
subcommand "server", Mrsk::Cli::Server
|
||||||
|
|
||||||
|
desc "traefik", "Manage the Traefik load balancer"
|
||||||
|
subcommand "traefik", Mrsk::Cli::Traefik
|
||||||
|
end
|
||||||
19
lib/mrsk/cli/prune.rb
Normal file
19
lib/mrsk/cli/prune.rb
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
||||||
|
desc "all", "Prune unused images and stopped containers"
|
||||||
|
def all
|
||||||
|
invoke :containers
|
||||||
|
invoke :images
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "images", "Prune unused images older than 30 days"
|
||||||
|
def images
|
||||||
|
on(MRSK.hosts) { execute *MRSK.prune.images }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "containers", "Prune stopped containers for the service older than 3 days"
|
||||||
|
def containers
|
||||||
|
on(MRSK.hosts) { execute *MRSK.prune.containers }
|
||||||
|
end
|
||||||
|
end
|
||||||
18
lib/mrsk/cli/registry.rb
Normal file
18
lib/mrsk/cli/registry.rb
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::Registry < Mrsk::Cli::Base
|
||||||
|
desc "login", "Login to the registry locally and remotely"
|
||||||
|
def login
|
||||||
|
run_locally { execute *MRSK.registry.login }
|
||||||
|
on(MRSK.hosts) { execute *MRSK.registry.login }
|
||||||
|
rescue ArgumentError => e
|
||||||
|
puts e.message
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "logout", "Logout of the registry remotely"
|
||||||
|
def logout
|
||||||
|
on(MRSK.hosts) { execute *MRSK.registry.logout }
|
||||||
|
rescue ArgumentError => e
|
||||||
|
puts e.message
|
||||||
|
end
|
||||||
|
end
|
||||||
8
lib/mrsk/cli/server.rb
Normal file
8
lib/mrsk/cli/server.rb
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::Server < Mrsk::Cli::Base
|
||||||
|
desc "bootstrap", "Ensure Docker is installed on the servers"
|
||||||
|
def bootstrap
|
||||||
|
on(MRSK.hosts + MRSK.accessory_hosts) { execute "which docker || (apt-get update -y && apt-get install docker.io -y)" }
|
||||||
|
end
|
||||||
|
end
|
||||||
17
lib/mrsk/cli/templates/deploy.yml
Normal file
17
lib/mrsk/cli/templates/deploy.yml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# Name of your application. Used to uniquely configuring Traefik and app containers.
|
||||||
|
# Your Dockerfile should set LABEL service=the-same-value to ensure image pruning works.
|
||||||
|
service: my-app
|
||||||
|
|
||||||
|
# Name of the container image.
|
||||||
|
image: user/my-app
|
||||||
|
|
||||||
|
# Deploy to these servers.
|
||||||
|
servers:
|
||||||
|
- 192.168.0.1
|
||||||
|
|
||||||
|
# Credentials for your image host.
|
||||||
|
registry:
|
||||||
|
# Specify the registry server, if you're not using Docker Hub
|
||||||
|
# server: registry.digitalocean.com / ghcr.io / ...
|
||||||
|
username: my-user
|
||||||
|
password: my-password-should-go-somewhere-safe
|
||||||
77
lib/mrsk/cli/traefik.rb
Normal file
77
lib/mrsk/cli/traefik.rb
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
require "mrsk/cli/base"
|
||||||
|
|
||||||
|
class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
||||||
|
desc "boot", "Boot Traefik on servers"
|
||||||
|
def boot
|
||||||
|
on(MRSK.traefik_hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "reboot", "Reboot Traefik on servers (stop container, remove container, start new container)"
|
||||||
|
def reboot
|
||||||
|
invoke :stop
|
||||||
|
invoke :remove_container
|
||||||
|
invoke :boot
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "start", "Start existing Traefik on servers"
|
||||||
|
def start
|
||||||
|
on(MRSK.traefik_hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "stop", "Stop Traefik on servers"
|
||||||
|
def stop
|
||||||
|
on(MRSK.traefik_hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "restart", "Restart Traefik on servers"
|
||||||
|
def restart
|
||||||
|
invoke :stop
|
||||||
|
invoke :start
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "details", "Display details about Traefik containers from servers"
|
||||||
|
def details
|
||||||
|
on(MRSK.traefik_hosts) { |host| puts_by_host host, capture_with_info(*MRSK.traefik.info), type: "Traefik" }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "logs", "Show log lines from Traefik 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 :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||||
|
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||||
|
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||||
|
def logs
|
||||||
|
grep = options[:grep]
|
||||||
|
|
||||||
|
if options[:follow]
|
||||||
|
run_locally do
|
||||||
|
info "Following logs on #{MRSK.primary_host}..."
|
||||||
|
info MRSK.traefik.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
|
exec MRSK.traefik.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
since = options[:since]
|
||||||
|
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||||
|
|
||||||
|
on(MRSK.traefik_hosts) do |host|
|
||||||
|
puts_by_host host, capture(*MRSK.traefik.logs(since: since, lines: lines, grep: grep)), type: "Traefik"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove", "Remove Traefik container and image from servers"
|
||||||
|
def remove
|
||||||
|
invoke :stop
|
||||||
|
invoke :remove_container
|
||||||
|
invoke :remove_image
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container", "Remove Traefik container from servers"
|
||||||
|
def remove_container
|
||||||
|
on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_container }
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container", "Remove Traefik image from servers"
|
||||||
|
def remove_image
|
||||||
|
on(MRSK.traefik_hosts) { execute *MRSK.traefik.remove_image }
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,4 +1,7 @@
|
|||||||
|
require "active_support/core_ext/enumerable"
|
||||||
|
|
||||||
require "mrsk/configuration"
|
require "mrsk/configuration"
|
||||||
|
require "mrsk/commands/accessory"
|
||||||
require "mrsk/commands/app"
|
require "mrsk/commands/app"
|
||||||
require "mrsk/commands/builder"
|
require "mrsk/commands/builder"
|
||||||
require "mrsk/commands/prune"
|
require "mrsk/commands/prune"
|
||||||
@@ -6,14 +9,47 @@ require "mrsk/commands/traefik"
|
|||||||
require "mrsk/commands/registry"
|
require "mrsk/commands/registry"
|
||||||
|
|
||||||
class Mrsk::Commander
|
class Mrsk::Commander
|
||||||
attr_reader :config_file, :config, :verbose
|
attr_accessor :config_file, :destination, :verbosity, :version
|
||||||
|
|
||||||
def initialize(config_file:, verbose: false)
|
def initialize(config_file: nil, destination: nil, verbosity: :info)
|
||||||
@config_file, @verbose = config_file, verbose
|
@config_file, @destination, @verbosity = config_file, destination, verbosity
|
||||||
end
|
end
|
||||||
|
|
||||||
def config
|
def config
|
||||||
@config ||= Mrsk::Configuration.load_file(config_file).tap { |config| setup_with(config) }
|
@config ||= \
|
||||||
|
Mrsk::Configuration
|
||||||
|
.create_from(config_file, destination: destination, version: cascading_version)
|
||||||
|
.tap { |config| configure_sshkit_with(config) }
|
||||||
|
end
|
||||||
|
|
||||||
|
attr_accessor :specific_hosts
|
||||||
|
|
||||||
|
def specific_primary!
|
||||||
|
self.specific_hosts = [ config.primary_web_host ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def specific_roles=(role_names)
|
||||||
|
self.specific_hosts = config.roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts) if role_names.present?
|
||||||
|
end
|
||||||
|
|
||||||
|
def primary_host
|
||||||
|
specific_hosts&.sole || config.primary_web_host
|
||||||
|
end
|
||||||
|
|
||||||
|
def hosts
|
||||||
|
specific_hosts || config.all_hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
def traefik_hosts
|
||||||
|
specific_hosts || config.traefik_hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
def accessory_hosts
|
||||||
|
specific_hosts || config.accessories.collect(&:host)
|
||||||
|
end
|
||||||
|
|
||||||
|
def accessory_names
|
||||||
|
config.accessories&.collect(&:name) || []
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -37,8 +73,12 @@ class Mrsk::Commander
|
|||||||
@prune ||= Mrsk::Commands::Prune.new(config)
|
@prune ||= Mrsk::Commands::Prune.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def accessory(name)
|
||||||
|
Mrsk::Commands::Accessory.new(config, name: name)
|
||||||
|
end
|
||||||
|
|
||||||
def verbosity(level)
|
|
||||||
|
def with_verbosity(level)
|
||||||
old_level = SSHKit.config.output_verbosity
|
old_level = SSHKit.config.output_verbosity
|
||||||
SSHKit.config.output_verbosity = level
|
SSHKit.config.output_verbosity = level
|
||||||
yield
|
yield
|
||||||
@@ -47,10 +87,14 @@ class Mrsk::Commander
|
|||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def cascading_version
|
||||||
|
version.presence || ENV["VERSION"] || `git rev-parse HEAD`.strip
|
||||||
|
end
|
||||||
|
|
||||||
# Lazy setup of SSHKit
|
# Lazy setup of SSHKit
|
||||||
def setup_with(config)
|
def configure_sshkit_with(config)
|
||||||
SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = config.ssh_options }
|
SSHKit::Backend::Netssh.configure { |ssh| ssh.ssh_options = config.ssh_options }
|
||||||
SSHKit.config.command_map[:docker] = "docker" # No need to use /usr/bin/env, just clogs up the logs
|
SSHKit.config.command_map[:docker] = "docker" # No need to use /usr/bin/env, just clogs up the logs
|
||||||
SSHKit.config.output_verbosity = :debug if verbose
|
SSHKit.config.output_verbosity = verbosity
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
108
lib/mrsk/commands/accessory.rb
Normal file
108
lib/mrsk/commands/accessory.rb
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
require "mrsk/commands/base"
|
||||||
|
|
||||||
|
class Mrsk::Commands::Accessory < Mrsk::Commands::Base
|
||||||
|
attr_reader :accessory_config
|
||||||
|
delegate :service_name, :image, :host, :port, :files, :directories, :env_args, :volume_args, :label_args, to: :accessory_config
|
||||||
|
|
||||||
|
def initialize(config, name:)
|
||||||
|
super(config)
|
||||||
|
@accessory_config = config.accessory(name)
|
||||||
|
end
|
||||||
|
|
||||||
|
def run
|
||||||
|
docker :run,
|
||||||
|
"--name", service_name,
|
||||||
|
"-d",
|
||||||
|
"--restart", "unless-stopped",
|
||||||
|
"-p", port,
|
||||||
|
*env_args,
|
||||||
|
*volume_args,
|
||||||
|
*label_args,
|
||||||
|
image
|
||||||
|
end
|
||||||
|
|
||||||
|
def start
|
||||||
|
docker :container, :start, service_name
|
||||||
|
end
|
||||||
|
|
||||||
|
def stop
|
||||||
|
docker :container, :stop, service_name
|
||||||
|
end
|
||||||
|
|
||||||
|
def info
|
||||||
|
docker :ps, *service_filter
|
||||||
|
end
|
||||||
|
|
||||||
|
def logs(since: nil, lines: nil, grep: nil)
|
||||||
|
pipe \
|
||||||
|
docker(:logs, service_name, (" --since #{since}" if since), (" -n #{lines}" if lines), "-t", "2>&1"),
|
||||||
|
("grep '#{grep}'" if grep)
|
||||||
|
end
|
||||||
|
|
||||||
|
def follow_logs(grep: nil)
|
||||||
|
run_over_ssh pipe(
|
||||||
|
docker(:logs, service_name, "-t", "-n", "10", "-f", "2>&1"),
|
||||||
|
(%(grep "#{grep}") if grep)
|
||||||
|
).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
def exec(*command, interactive: false)
|
||||||
|
docker :exec,
|
||||||
|
("-it" if interactive),
|
||||||
|
service_name,
|
||||||
|
*command
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_exec(*command, interactive: false)
|
||||||
|
docker :run,
|
||||||
|
("-it" if interactive),
|
||||||
|
"--rm",
|
||||||
|
*env_args,
|
||||||
|
*volume_args,
|
||||||
|
image,
|
||||||
|
*command
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_over_ssh(command)
|
||||||
|
super command, host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
def exec_over_ssh(*command)
|
||||||
|
run_over_ssh run_exec(*command, interactive: true).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
def bash
|
||||||
|
exec_over_ssh "bash"
|
||||||
|
end
|
||||||
|
|
||||||
|
def ensure_local_file_present(local_file)
|
||||||
|
if !local_file.is_a?(StringIO) && !Pathname.new(local_file).exist?
|
||||||
|
raise "Missing file: #{local_file}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def make_directory_for(remote_file)
|
||||||
|
make_directory Pathname.new(remote_file).dirname.to_s
|
||||||
|
end
|
||||||
|
|
||||||
|
def make_directory(path)
|
||||||
|
[ :mkdir, "-p", path ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_service_directory
|
||||||
|
[ :rm, "-rf", service_name ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_container
|
||||||
|
docker :container, :prune, "-f", *service_filter
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_image
|
||||||
|
docker :image, :prune, "-a", "-f", *service_filter
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def service_filter
|
||||||
|
[ "--filter", "label=service=#{service_name}" ]
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -8,40 +8,73 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
"-d",
|
"-d",
|
||||||
"--restart unless-stopped",
|
"--restart unless-stopped",
|
||||||
"--name", config.service_with_version,
|
"--name", config.service_with_version,
|
||||||
"-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
|
*rails_master_key_arg,
|
||||||
*config.env_args,
|
*role.env_args,
|
||||||
|
*config.volume_args,
|
||||||
*role.label_args,
|
*role.label_args,
|
||||||
config.absolute_image,
|
config.absolute_image,
|
||||||
role.cmd
|
role.cmd
|
||||||
end
|
end
|
||||||
|
|
||||||
def start
|
def start(version: config.version)
|
||||||
docker :start, config.service_with_version
|
docker :start, "#{config.service}-#{version}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def current_container_id
|
||||||
|
docker :ps, "-q", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
def stop
|
def stop
|
||||||
[ "docker ps -q #{service_filter.join(" ")} | xargs docker stop" ]
|
pipe current_container_id, "xargs docker stop"
|
||||||
end
|
end
|
||||||
|
|
||||||
def info
|
def info
|
||||||
docker :ps, *service_filter
|
docker :ps, *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
def logs
|
def logs(since: nil, lines: nil, grep: nil)
|
||||||
[ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -n 100 -t" ]
|
pipe \
|
||||||
|
current_container_id,
|
||||||
|
"xargs docker logs#{" --since #{since}" if since}#{" -n #{lines}" if lines} 2>&1",
|
||||||
|
("grep '#{grep}'" if grep)
|
||||||
end
|
end
|
||||||
|
|
||||||
def exec(*command, interactive: false)
|
def exec(*command, interactive: false)
|
||||||
docker :exec,
|
docker :exec,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
"-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
|
|
||||||
*config.env_args,
|
|
||||||
config.service_with_version,
|
config.service_with_version,
|
||||||
*command
|
*command
|
||||||
end
|
end
|
||||||
|
|
||||||
def console
|
def run_exec(*command, interactive: false)
|
||||||
"ssh -t #{config.ssh_user}@#{config.primary_host} '#{exec("bin/rails", "c", interactive: true).join(" ")}'"
|
docker :run,
|
||||||
|
("-it" if interactive),
|
||||||
|
"--rm",
|
||||||
|
*rails_master_key_arg,
|
||||||
|
*config.env_args,
|
||||||
|
*config.volume_args,
|
||||||
|
config.absolute_image,
|
||||||
|
*command
|
||||||
|
end
|
||||||
|
|
||||||
|
def exec_over_ssh(*command, host:)
|
||||||
|
run_over_ssh run_exec(*command, interactive: true).join(" "), host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
def follow_logs(host:, grep: nil)
|
||||||
|
run_over_ssh pipe(
|
||||||
|
current_container_id,
|
||||||
|
"xargs docker logs -t -n 10 -f 2>&1",
|
||||||
|
(%(grep "#{grep}") if grep)
|
||||||
|
).join(" "), host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
def console(host:)
|
||||||
|
exec_over_ssh "bin/rails", "c", host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
def bash(host:)
|
||||||
|
exec_over_ssh "bash", host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
def list_containers
|
def list_containers
|
||||||
@@ -60,4 +93,12 @@ 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
|
||||||
|
|||||||
@@ -1,27 +1,35 @@
|
|||||||
require "sshkit"
|
|
||||||
|
|
||||||
module Mrsk::Commands
|
module Mrsk::Commands
|
||||||
class Base
|
class Base
|
||||||
|
delegate :redact, to: Mrsk::Utils
|
||||||
|
|
||||||
attr_accessor :config
|
attr_accessor :config
|
||||||
|
|
||||||
def initialize(config)
|
def initialize(config)
|
||||||
@config = config
|
@config = config
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def run_over_ssh(command, host:)
|
||||||
|
"ssh -t #{config.ssh_user}@#{host} '#{command}'"
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def combine(*commands)
|
def combine(*commands, by: "&&")
|
||||||
commands
|
commands
|
||||||
.collect { |command| command + [ "&&" ] }.flatten # Join commands with &&
|
.compact
|
||||||
.tap { |commands| commands.pop } # Remove trailing &&
|
.collect { |command| Array(command) + [ by ] }.flatten # Join commands
|
||||||
|
.tap { |commands| commands.pop } # Remove trailing combiner
|
||||||
|
end
|
||||||
|
|
||||||
|
def chain(*commands)
|
||||||
|
combine *commands, by: ";"
|
||||||
|
end
|
||||||
|
|
||||||
|
def pipe(*commands)
|
||||||
|
combine *commands, by: "|"
|
||||||
end
|
end
|
||||||
|
|
||||||
def docker(*args)
|
def docker(*args)
|
||||||
args.compact.unshift :docker
|
args.compact.unshift :docker
|
||||||
end
|
end
|
||||||
|
|
||||||
# Copied from SSHKit::Backend::Abstract#redact to be available inside Commands classes
|
|
||||||
def redact(arg) # Used in execute_command to hide redact() args a user passes in
|
|
||||||
arg.to_s.extend(SSHKit::Redaction) # to_s due to our inability to extend Integer, etc
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,22 +2,21 @@ 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
|
||||||
delegate :native?, :multiarch?, :remote?, to: :name
|
|
||||||
|
|
||||||
def name
|
def name
|
||||||
target.class.to_s.demodulize.downcase.inquiry
|
target.class.to_s.remove("Mrsk::Commands::Builder::").underscore
|
||||||
end
|
end
|
||||||
|
|
||||||
def target
|
def target
|
||||||
case
|
case
|
||||||
when config.builder.nil?
|
when config.builder && config.builder["multiarch"] == false
|
||||||
multiarch
|
|
||||||
when config.builder["multiarch"] == false
|
|
||||||
native
|
native
|
||||||
when config.builder["local"] && config.builder["local"]
|
when config.builder && config.builder["local"] && config.builder["remote"]
|
||||||
multiarch_remote
|
multiarch_remote
|
||||||
|
when config.builder && config.builder["remote"]
|
||||||
|
native_remote
|
||||||
else
|
else
|
||||||
raise ArgumentError, "Builder configuration incorrect: #{config.builder.inspect}"
|
multiarch
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -25,6 +24,10 @@ class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
|||||||
@native ||= Mrsk::Commands::Builder::Native.new(config)
|
@native ||= Mrsk::Commands::Builder::Native.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def native_remote
|
||||||
|
@native ||= Mrsk::Commands::Builder::Native::Remote.new(config)
|
||||||
|
end
|
||||||
|
|
||||||
def multiarch
|
def multiarch
|
||||||
@multiarch ||= Mrsk::Commands::Builder::Multiarch.new(config)
|
@multiarch ||= Mrsk::Commands::Builder::Multiarch.new(config)
|
||||||
end
|
end
|
||||||
@@ -35,5 +38,6 @@ class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/commands/builder/native"
|
require "mrsk/commands/builder/native"
|
||||||
|
require "mrsk/commands/builder/native/remote"
|
||||||
require "mrsk/commands/builder/multiarch"
|
require "mrsk/commands/builder/multiarch"
|
||||||
require "mrsk/commands/builder/multiarch/remote"
|
require "mrsk/commands/builder/multiarch/remote"
|
||||||
|
|||||||
26
lib/mrsk/commands/builder/base.rb
Normal file
26
lib/mrsk/commands/builder/base.rb
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
require "mrsk/commands/base"
|
||||||
|
|
||||||
|
class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
||||||
|
delegate :argumentize, to: Mrsk::Utils
|
||||||
|
|
||||||
|
def pull
|
||||||
|
docker :pull, config.absolute_image
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_args
|
||||||
|
argumentize "--build-arg", args, redacted: true
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_secrets
|
||||||
|
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def args
|
||||||
|
(config.builder && config.builder["args"]) || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def secrets
|
||||||
|
(config.builder && config.builder["secrets"]) || []
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,20 +1,23 @@
|
|||||||
require "mrsk/commands/base"
|
require "mrsk/commands/builder/base"
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
|
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
|
||||||
def create
|
def create
|
||||||
docker :buildx, :create, "--use", "--name", "mrsk"
|
docker :buildx, :create, "--use", "--name", builder_name
|
||||||
end
|
end
|
||||||
|
|
||||||
def remove
|
def remove
|
||||||
docker :buildx, :rm, "mrsk"
|
docker :buildx, :rm, builder_name
|
||||||
end
|
end
|
||||||
|
|
||||||
def push
|
def push
|
||||||
docker :buildx, :build, "--push", "--platform linux/amd64,linux/arm64", "-t", config.absolute_image, "."
|
docker :buildx, :build,
|
||||||
end
|
"--push",
|
||||||
|
"--platform", "linux/amd64,linux/arm64",
|
||||||
def pull
|
"--builder", builder_name,
|
||||||
docker :pull, config.absolute_image
|
"-t", config.absolute_image,
|
||||||
|
*build_args,
|
||||||
|
*build_secrets,
|
||||||
|
"."
|
||||||
end
|
end
|
||||||
|
|
||||||
def info
|
def info
|
||||||
@@ -22,4 +25,9 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
|
|||||||
docker(:context, :ls),
|
docker(:context, :ls),
|
||||||
docker(:buildx, :ls)
|
docker(:buildx, :ls)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def builder_name
|
||||||
|
"mrsk-#{config.service}-multiarch"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -15,12 +15,20 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
|
|||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def builder_name
|
||||||
|
super + "-remote"
|
||||||
|
end
|
||||||
|
|
||||||
|
def builder_name_with_arch(arch)
|
||||||
|
"#{builder_name}-#{arch}"
|
||||||
|
end
|
||||||
|
|
||||||
def create_local_buildx
|
def create_local_buildx
|
||||||
docker :buildx, :create, "--use", "--name", "mrsk", "mrsk-#{local["arch"]}", "--platform", "linux/#{local["arch"]}"
|
docker :buildx, :create, "--name", builder_name, builder_name_with_arch(local["arch"]), "--platform", "linux/#{local["arch"]}"
|
||||||
end
|
end
|
||||||
|
|
||||||
def append_remote_buildx
|
def append_remote_buildx
|
||||||
docker :buildx, :create, "--append", "--name", "mrsk", "mrsk-#{remote["arch"]}", "--platform", "linux/#{remote["arch"]}"
|
docker :buildx, :create, "--append", "--name", builder_name, builder_name_with_arch(remote["arch"]), "--platform", "linux/#{remote["arch"]}"
|
||||||
end
|
end
|
||||||
|
|
||||||
def create_contexts
|
def create_contexts
|
||||||
@@ -30,7 +38,7 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
|
|||||||
end
|
end
|
||||||
|
|
||||||
def create_context(arch, host)
|
def create_context(arch, host)
|
||||||
docker :context, :create, "mrsk-#{arch}", "--description", "'MRSK #{arch} Native Host'", "--docker", "'host=#{host}'"
|
docker :context, :create, builder_name_with_arch(arch), "--description", "'#{builder_name} #{arch} native host'", "--docker", "'host=#{host}'"
|
||||||
end
|
end
|
||||||
|
|
||||||
def remove_contexts
|
def remove_contexts
|
||||||
@@ -40,7 +48,7 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
|
|||||||
end
|
end
|
||||||
|
|
||||||
def remove_context(arch)
|
def remove_context(arch)
|
||||||
docker :context, :rm, "mrsk-#{arch}"
|
docker :context, :rm, builder_name_with_arch(arch)
|
||||||
end
|
end
|
||||||
|
|
||||||
def local
|
def local
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
require "mrsk/commands/base"
|
require "mrsk/commands/builder/base"
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
|
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
|
||||||
def create
|
def create
|
||||||
# No-op on native
|
# No-op on native
|
||||||
end
|
end
|
||||||
@@ -11,14 +11,10 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
|
|||||||
|
|
||||||
def push
|
def push
|
||||||
combine \
|
combine \
|
||||||
docker(:build, "-t", config.absolute_image, "."),
|
docker(:build, "-t", *build_args, *build_secrets, config.absolute_image, "."),
|
||||||
docker(:push, config.absolute_image)
|
docker(:push, config.absolute_image)
|
||||||
end
|
end
|
||||||
|
|
||||||
def pull
|
|
||||||
docker :pull, config.absolute_image
|
|
||||||
end
|
|
||||||
|
|
||||||
def info
|
def info
|
||||||
# No-op on native
|
# No-op on native
|
||||||
end
|
end
|
||||||
|
|||||||
71
lib/mrsk/commands/builder/native/remote.rb
Normal file
71
lib/mrsk/commands/builder/native/remote.rb
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
require "mrsk/commands/builder/native"
|
||||||
|
|
||||||
|
class Mrsk::Commands::Builder::Native::Remote < Mrsk::Commands::Builder::Native
|
||||||
|
def create
|
||||||
|
chain \
|
||||||
|
create_context,
|
||||||
|
create_buildx
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove
|
||||||
|
chain \
|
||||||
|
remove_context,
|
||||||
|
remove_buildx
|
||||||
|
end
|
||||||
|
|
||||||
|
def push
|
||||||
|
docker :buildx, :build,
|
||||||
|
"--push",
|
||||||
|
"--platform", platform,
|
||||||
|
"--builder", builder_name,
|
||||||
|
"-t", config.absolute_image,
|
||||||
|
*build_args,
|
||||||
|
*build_secrets,
|
||||||
|
"."
|
||||||
|
end
|
||||||
|
|
||||||
|
def info
|
||||||
|
chain \
|
||||||
|
docker(:context, :ls),
|
||||||
|
docker(:buildx, :ls)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
private
|
||||||
|
def arch
|
||||||
|
config.builder["remote"]["arch"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def host
|
||||||
|
config.builder["remote"]["host"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def builder_name
|
||||||
|
"mrsk-#{config.service}-native-remote"
|
||||||
|
end
|
||||||
|
|
||||||
|
def builder_name_with_arch
|
||||||
|
"#{builder_name}-#{arch}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def platform
|
||||||
|
"linux/#{arch}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_context
|
||||||
|
docker :context, :create,
|
||||||
|
builder_name_with_arch, "--description", "'#{builder_name} #{arch} native host'", "--docker", "'host=#{host}'"
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_context
|
||||||
|
docker :context, :rm, builder_name_with_arch
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_buildx
|
||||||
|
docker :buildx, :create, "--name", builder_name, builder_name_with_arch, "--platform", platform
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_buildx
|
||||||
|
docker :buildx, :rm, builder_name
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -8,7 +8,9 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
|||||||
"-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",
|
||||||
"--providers.docker"
|
"--providers.docker",
|
||||||
|
"--log.level=DEBUG",
|
||||||
|
*cmd_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def start
|
def start
|
||||||
@@ -23,8 +25,17 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
|||||||
docker :ps, "--filter", "name=traefik"
|
docker :ps, "--filter", "name=traefik"
|
||||||
end
|
end
|
||||||
|
|
||||||
def logs
|
def logs(since: nil, lines: nil, grep: nil)
|
||||||
docker :logs, "traefik", "-n", "100", "-t"
|
pipe \
|
||||||
|
docker(:logs, "traefik", (" --since #{since}" if since), (" -n #{lines}" if lines), "-t", "2>&1"),
|
||||||
|
("grep '#{grep}'" if grep)
|
||||||
|
end
|
||||||
|
|
||||||
|
def follow_logs(host:, grep: nil)
|
||||||
|
run_over_ssh pipe(
|
||||||
|
docker(:logs, "traefik", "-t", "-n", "10", "-f", "2>&1"),
|
||||||
|
(%(grep "#{grep}") if grep)
|
||||||
|
).join(" "), host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
def remove_container
|
def remove_container
|
||||||
@@ -34,4 +45,9 @@ class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
|||||||
def remove_image
|
def remove_image
|
||||||
docker :image, :prune, "-a", "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
|
docker :image, :prune, "-a", "-f", "--filter", "label=org.opencontainers.image.title=Traefik"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def cmd_args
|
||||||
|
(config.raw_config.dig(:traefik, "args") || { }).collect { |(key, value)| [ "--#{key}", value ] }.flatten
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,27 +1,45 @@
|
|||||||
require "active_support/ordered_options"
|
require "active_support/ordered_options"
|
||||||
require "active_support/core_ext/string/inquiry"
|
require "active_support/core_ext/string/inquiry"
|
||||||
|
require "active_support/core_ext/module/delegation"
|
||||||
|
require "pathname"
|
||||||
require "erb"
|
require "erb"
|
||||||
|
require "mrsk/utils"
|
||||||
|
|
||||||
class Mrsk::Configuration
|
class Mrsk::Configuration
|
||||||
delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :config, allow_nil: true
|
delegate :service, :image, :servers, :env, :labels, :registry, :builder, to: :raw_config, allow_nil: true
|
||||||
|
delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
|
||||||
|
|
||||||
|
attr_accessor :raw_config
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
def load_file(file)
|
def create_from(base_config_file, destination: nil, version: "missing")
|
||||||
|
new(load_config_file(base_config_file).tap do |config|
|
||||||
|
if destination
|
||||||
|
config.deep_merge! \
|
||||||
|
load_config_file destination_config_file(base_config_file, destination)
|
||||||
|
end
|
||||||
|
end, version: version)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def load_config_file(file)
|
||||||
if file.exist?
|
if file.exist?
|
||||||
new YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
|
YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
|
||||||
else
|
else
|
||||||
raise "Configuration file not found in #{file}"
|
raise "Configuration file not found in #{file}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def argumentize(argument, attributes)
|
def destination_config_file(base_config_file, destination)
|
||||||
attributes.flat_map { |k, v| [ argument, "#{k}=#{v}" ] }
|
dir, basename = base_config_file.split
|
||||||
|
dir.join basename.to_s.remove(".yml") + ".#{destination}.yml"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def initialize(config, validate: true)
|
def initialize(raw_config, version: "missing", validate: true)
|
||||||
@config = ActiveSupport::InheritableOptions.new(config)
|
@raw_config = ActiveSupport::InheritableOptions.new(raw_config)
|
||||||
ensure_required_keys_present if validate
|
@version = version
|
||||||
|
valid? if validate
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -33,36 +51,34 @@ class Mrsk::Configuration
|
|||||||
roles.detect { |r| r.name == name.to_s }
|
roles.detect { |r| r.name == name.to_s }
|
||||||
end
|
end
|
||||||
|
|
||||||
def hosts
|
def accessories
|
||||||
hosts =
|
@accessories ||= raw_config.accessories&.keys&.collect { |name| Mrsk::Configuration::Assessory.new(name, config: self) } || []
|
||||||
case
|
end
|
||||||
when ENV["HOSTS"]
|
|
||||||
ENV["HOSTS"].split(",")
|
def accessory(name)
|
||||||
when ENV["ROLES"]
|
accessories.detect { |a| a.name == name.to_s }
|
||||||
role_names = ENV["ROLES"].split(",")
|
end
|
||||||
roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts)
|
|
||||||
else
|
|
||||||
|
def all_hosts
|
||||||
roles.flat_map(&:hosts)
|
roles.flat_map(&:hosts)
|
||||||
end
|
end
|
||||||
|
|
||||||
if hosts.any?
|
def primary_web_host
|
||||||
hosts
|
role(:web).hosts.first
|
||||||
else
|
|
||||||
raise ArgumentError, "No hosts found"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def primary_host
|
def traefik_hosts
|
||||||
role(:web).hosts.first
|
roles.select(&:running_traefik?).flat_map(&:hosts)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def version
|
def version
|
||||||
@version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
|
@version
|
||||||
end
|
end
|
||||||
|
|
||||||
def repository
|
def repository
|
||||||
[ config.registry["server"], image ].compact.join("/")
|
[ raw_config.registry["server"], image ].compact.join("/")
|
||||||
end
|
end
|
||||||
|
|
||||||
def absolute_image
|
def absolute_image
|
||||||
@@ -75,15 +91,23 @@ class Mrsk::Configuration
|
|||||||
|
|
||||||
|
|
||||||
def env_args
|
def env_args
|
||||||
if config.env.present?
|
if raw_config.env.present?
|
||||||
self.class.argumentize "-e", config.env
|
argumentize_env_with_secrets(raw_config.env)
|
||||||
|
else
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def volume_args
|
||||||
|
if raw_config.volumes.present?
|
||||||
|
argumentize "--volume", raw_config.volumes
|
||||||
else
|
else
|
||||||
[]
|
[]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def ssh_user
|
def ssh_user
|
||||||
config.ssh_user || "root"
|
raw_config.ssh_user || "root"
|
||||||
end
|
end
|
||||||
|
|
||||||
def ssh_options
|
def ssh_options
|
||||||
@@ -91,26 +115,65 @@ class Mrsk::Configuration
|
|||||||
end
|
end
|
||||||
|
|
||||||
def master_key
|
def master_key
|
||||||
ENV["RAILS_MASTER_KEY"] || File.read(Rails.root.join("config/master.key"))
|
unless raw_config.skip_master_key
|
||||||
|
ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def valid?
|
||||||
|
ensure_required_keys_present && ensure_env_available
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def to_h
|
||||||
|
{
|
||||||
|
roles: role_names,
|
||||||
|
hosts: all_hosts,
|
||||||
|
primary_host: primary_web_host,
|
||||||
|
version: version,
|
||||||
|
repository: repository,
|
||||||
|
absolute_image: absolute_image,
|
||||||
|
service_with_version: service_with_version,
|
||||||
|
env_args: env_args,
|
||||||
|
volume_args: volume_args,
|
||||||
|
ssh_options: ssh_options,
|
||||||
|
builder: raw_config.builder,
|
||||||
|
accessories: raw_config.accessories
|
||||||
|
}.compact
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
private
|
private
|
||||||
attr_accessor :config
|
# Will raise ArgumentError if any required config keys are missing
|
||||||
|
|
||||||
def ensure_required_keys_present
|
def ensure_required_keys_present
|
||||||
%i[ service image registry ].each do |key|
|
%i[ service image registry servers ].each do |key|
|
||||||
raise ArgumentError, "Missing required configuration for #{key}" unless config[key].present?
|
raise ArgumentError, "Missing required configuration for #{key}" unless raw_config[key].present?
|
||||||
end
|
end
|
||||||
|
|
||||||
%w[ username password ].each do |key|
|
if raw_config.registry["username"].blank?
|
||||||
raise ArgumentError, "Missing required configuration for registry/#{key}" unless config.registry[key].present?
|
raise ArgumentError, "You must specify a username for the registry in config/deploy.yml"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if raw_config.registry["password"].blank?
|
||||||
|
raise ArgumentError, "You must specify a password for the registry in config/deploy.yml (or set the ENV variable if that's used)"
|
||||||
|
end
|
||||||
|
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
|
# Will raise KeyError if any secret ENVs are missing
|
||||||
|
def ensure_env_available
|
||||||
|
env_args
|
||||||
|
roles.each(&:env_args)
|
||||||
|
|
||||||
|
true
|
||||||
end
|
end
|
||||||
|
|
||||||
def role_names
|
def role_names
|
||||||
config.servers.is_a?(Array) ? [ "web" ] : 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/role"
|
||||||
|
require "mrsk/configuration/accessory"
|
||||||
|
|||||||
123
lib/mrsk/configuration/accessory.rb
Normal file
123
lib/mrsk/configuration/accessory.rb
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
class Mrsk::Configuration::Assessory
|
||||||
|
delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
|
||||||
|
|
||||||
|
attr_accessor :name, :specifics
|
||||||
|
|
||||||
|
def initialize(name, config:)
|
||||||
|
@name, @config, @specifics = name.inquiry, config, config.raw_config["accessories"][name]
|
||||||
|
end
|
||||||
|
|
||||||
|
def service_name
|
||||||
|
"#{config.service}-#{name}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def image
|
||||||
|
specifics["image"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def host
|
||||||
|
specifics["host"] || raise(ArgumentError, "Missing host for accessory")
|
||||||
|
end
|
||||||
|
|
||||||
|
def port
|
||||||
|
if specifics["port"].to_s.include?(":")
|
||||||
|
specifics["port"]
|
||||||
|
else
|
||||||
|
"#{specifics["port"]}:#{specifics["port"]}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def labels
|
||||||
|
default_labels.merge(specifics["labels"] || {})
|
||||||
|
end
|
||||||
|
|
||||||
|
def label_args
|
||||||
|
argumentize "--label", labels
|
||||||
|
end
|
||||||
|
|
||||||
|
def env
|
||||||
|
specifics["env"] || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def env_args
|
||||||
|
argumentize_env_with_secrets env
|
||||||
|
end
|
||||||
|
|
||||||
|
def files
|
||||||
|
specifics["files"]&.to_h do |local_to_remote_mapping|
|
||||||
|
local_file, remote_file = local_to_remote_mapping.split(":")
|
||||||
|
[ expand_local_file(local_file), expand_remote_file(remote_file) ]
|
||||||
|
end || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def directories
|
||||||
|
specifics["directories"]&.to_h do |host_to_container_mapping|
|
||||||
|
host_relative_path, container_path = host_to_container_mapping.split(":")
|
||||||
|
[ expand_host_path(host_relative_path), container_path ]
|
||||||
|
end || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def volumes
|
||||||
|
specific_volumes + remote_files_as_volumes + remote_directories_as_volumes
|
||||||
|
end
|
||||||
|
|
||||||
|
def volume_args
|
||||||
|
argumentize "--volume", volumes
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
attr_accessor :config
|
||||||
|
|
||||||
|
def default_labels
|
||||||
|
{ "service" => service_name }
|
||||||
|
end
|
||||||
|
|
||||||
|
def expand_local_file(local_file)
|
||||||
|
if local_file.end_with?("erb")
|
||||||
|
with_clear_env_loaded { read_dynamic_file(local_file) }
|
||||||
|
else
|
||||||
|
Pathname.new(File.expand_path(local_file)).to_s
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_clear_env_loaded
|
||||||
|
(env["clear"] || env).each { |k, v| ENV[k] = v }
|
||||||
|
yield
|
||||||
|
ensure
|
||||||
|
(env["clear"] || env).each { |k, v| ENV.delete(k) }
|
||||||
|
end
|
||||||
|
|
||||||
|
def read_dynamic_file(local_file)
|
||||||
|
StringIO.new(ERB.new(IO.read(local_file)).result)
|
||||||
|
end
|
||||||
|
|
||||||
|
def expand_remote_file(remote_file)
|
||||||
|
service_name + remote_file
|
||||||
|
end
|
||||||
|
|
||||||
|
def specific_volumes
|
||||||
|
specifics["volumes"] || []
|
||||||
|
end
|
||||||
|
|
||||||
|
def remote_files_as_volumes
|
||||||
|
specifics["files"]&.collect do |local_to_remote_mapping|
|
||||||
|
_, remote_file = local_to_remote_mapping.split(":")
|
||||||
|
"#{service_data_directory + remote_file}:#{remote_file}"
|
||||||
|
end || []
|
||||||
|
end
|
||||||
|
|
||||||
|
def remote_directories_as_volumes
|
||||||
|
specifics["directories"]&.collect do |host_to_container_mapping|
|
||||||
|
host_relative_path, container_path = host_to_container_mapping.split(":")
|
||||||
|
[ expand_host_path(host_relative_path), container_path ].join(":")
|
||||||
|
end || []
|
||||||
|
end
|
||||||
|
|
||||||
|
def expand_host_path(host_relative_path)
|
||||||
|
"#{service_data_directory}/#{host_relative_path}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def service_data_directory
|
||||||
|
"$PWD/#{service_name}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
class Mrsk::Configuration::Role
|
class Mrsk::Configuration::Role
|
||||||
delegate :argumentize, to: Mrsk::Configuration
|
delegate :argumentize, :argumentize_env_with_secrets, to: Mrsk::Utils
|
||||||
|
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
@@ -12,21 +12,33 @@ class Mrsk::Configuration::Role
|
|||||||
end
|
end
|
||||||
|
|
||||||
def labels
|
def labels
|
||||||
if name.web?
|
|
||||||
default_labels.merge(traefik_labels).merge(custom_labels)
|
default_labels.merge(traefik_labels).merge(custom_labels)
|
||||||
else
|
|
||||||
default_labels.merge(custom_labels)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def label_args
|
def label_args
|
||||||
argumentize "--label", labels
|
argumentize "--label", labels
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def env
|
||||||
|
if config.env && config.env["secret"]
|
||||||
|
merged_env_with_secrets
|
||||||
|
else
|
||||||
|
merged_env
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def env_args
|
||||||
|
argumentize_env_with_secrets env
|
||||||
|
end
|
||||||
|
|
||||||
def cmd
|
def cmd
|
||||||
specializations["cmd"]
|
specializations["cmd"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def running_traefik?
|
||||||
|
name.web? || specializations["traefik"]
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
attr_accessor :config
|
attr_accessor :config
|
||||||
|
|
||||||
@@ -44,6 +56,7 @@ class Mrsk::Configuration::Role
|
|||||||
end
|
end
|
||||||
|
|
||||||
def traefik_labels
|
def traefik_labels
|
||||||
|
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" => "/up",
|
||||||
@@ -51,6 +64,9 @@ class Mrsk::Configuration::Role
|
|||||||
"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"
|
||||||
}
|
}
|
||||||
|
else
|
||||||
|
{}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def custom_labels
|
def custom_labels
|
||||||
@@ -64,7 +80,23 @@ class Mrsk::Configuration::Role
|
|||||||
if config.servers.is_a?(Array) || config.servers[name].is_a?(Array)
|
if config.servers.is_a?(Array) || config.servers[name].is_a?(Array)
|
||||||
{ }
|
{ }
|
||||||
else
|
else
|
||||||
config.servers[name].without("hosts")
|
config.servers[name].except("hosts")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def specialized_env
|
||||||
|
specializations["env"] || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def merged_env
|
||||||
|
config.env&.merge(specialized_env) || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
# Secrets are stored in an array, which won't merge by default, so have to do it by hand.
|
||||||
|
def merged_env_with_secrets
|
||||||
|
merged_env.tap do |new_env|
|
||||||
|
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
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
module Mrsk
|
|
||||||
class Engine < ::Rails::Engine
|
|
||||||
end
|
|
||||||
end
|
|
||||||
12
lib/mrsk/sshkit_with_ext.rb
Normal file
12
lib/mrsk/sshkit_with_ext.rb
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
require "sshkit"
|
||||||
|
require "sshkit/dsl"
|
||||||
|
|
||||||
|
class SSHKit::Backend::Abstract
|
||||||
|
def capture_with_info(*args)
|
||||||
|
capture(*args, verbosity: Logger::INFO)
|
||||||
|
end
|
||||||
|
|
||||||
|
def puts_by_host(host, output, type: "App")
|
||||||
|
puts "#{type} Host: #{host}\n#{output}\n\n"
|
||||||
|
end
|
||||||
|
end
|
||||||
29
lib/mrsk/utils.rb
Normal file
29
lib/mrsk/utils.rb
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
module Mrsk::Utils
|
||||||
|
extend self
|
||||||
|
|
||||||
|
# Return a list of shell arguments using the same named argument against the passed attributes (hash or array).
|
||||||
|
def argumentize(argument, attributes, redacted: false)
|
||||||
|
Array(attributes).flat_map do |k, v|
|
||||||
|
if v.present?
|
||||||
|
[ argument, redacted ? redact("#{k}=#{v}") : "#{k}=#{v}" ]
|
||||||
|
else
|
||||||
|
[ argument, k ]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Return a list of shell arguments using the same named argument against the passed attributes,
|
||||||
|
# but redacts and expands secrets.
|
||||||
|
def argumentize_env_with_secrets(env)
|
||||||
|
if (secrets = env["secret"]).present?
|
||||||
|
argumentize("-e", secrets.to_h { |key| [ key, ENV.fetch(key) ] }, redacted: true) + argumentize("-e", env["clear"])
|
||||||
|
else
|
||||||
|
argumentize "-e", env.fetch("clear", env)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Copied from SSHKit::Backend::Abstract#redact to be available inside Commands classes
|
||||||
|
def redact(arg) # Used in execute_command to hide redact() args a user passes in
|
||||||
|
arg.to_s.extend(SSHKit::Redaction) # to_s due to our inability to extend Integer, etc
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
module Mrsk
|
module Mrsk
|
||||||
VERSION = "0.0.3"
|
VERSION = "0.4.0"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,97 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
namespace :app do
|
|
||||||
desc "Run app on servers (or start them if they've already been run)"
|
|
||||||
task :run do
|
|
||||||
MRSK.config.roles.each do |role|
|
|
||||||
on(role.hosts) do |host|
|
|
||||||
begin
|
|
||||||
execute *MRSK.app.run(role: role.name)
|
|
||||||
rescue SSHKit::Command::Failed => e
|
|
||||||
if e.message =~ /already in use/
|
|
||||||
error "Container with same version already deployed on #{host}, starting that instead"
|
|
||||||
execute *MRSK.app.start, host: host
|
|
||||||
else
|
|
||||||
raise
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Start existing app on servers (use VERSION=<git-hash> to designate which version)"
|
|
||||||
task :start do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Stop app on servers"
|
|
||||||
task :stop do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Start app on servers (use VERSION=<git-hash> to designate which version)"
|
|
||||||
task restart: %i[ stop start ]
|
|
||||||
|
|
||||||
desc "Display information about app containers"
|
|
||||||
task :info do
|
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.info) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Execute a custom task on servers passed in as CMD='bin/rake some:task'"
|
|
||||||
task :exec do
|
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec(ENV["CMD"])) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Start Rails Console on primary host"
|
|
||||||
task :console do
|
|
||||||
puts "Launching Rails console on #{MRSK.config.primary_host}..."
|
|
||||||
exec app.console
|
|
||||||
end
|
|
||||||
|
|
||||||
namespace :exec do
|
|
||||||
desc "Execute Rails command on servers, like CMD='runner \"puts %(Hello World)\""
|
|
||||||
task :rails do
|
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec("bin/rails", ENV["CMD"])) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Execute a custom task on the first defined server"
|
|
||||||
task :once do
|
|
||||||
on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec(ENV["CMD"])) }
|
|
||||||
end
|
|
||||||
|
|
||||||
namespace :once do
|
|
||||||
desc "Execute Rails command on the first defined server, like CMD='runner \"puts %(Hello World)\""
|
|
||||||
task :rails do
|
|
||||||
on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec("bin/rails", ENV["CMD"])) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "List all the app containers currently on servers"
|
|
||||||
task :containers do
|
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.list_containers) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Show last 100 log lines from app on servers"
|
|
||||||
task :logs do
|
|
||||||
# FIXME: Catch when app containers aren't running
|
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.logs) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Remove app containers and images from servers"
|
|
||||||
task remove: %w[ remove:containers remove:images ]
|
|
||||||
|
|
||||||
namespace :remove do
|
|
||||||
desc "Remove app containers from servers"
|
|
||||||
task :containers do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Remove app images from servers"
|
|
||||||
task :images do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
namespace :build do
|
|
||||||
desc "Deliver a newly built app image to servers"
|
|
||||||
task deliver: %i[ push pull ]
|
|
||||||
|
|
||||||
desc "Build locally and push app image to registry"
|
|
||||||
task :push do
|
|
||||||
run_locally do
|
|
||||||
begin
|
|
||||||
debug "Using builder: #{MRSK.builder.name}"
|
|
||||||
info "Building image may take a while (run with VERBOSE=1 for progress logging)"
|
|
||||||
execute *MRSK.builder.push
|
|
||||||
rescue SSHKit::Command::Failed => e
|
|
||||||
error "Missing compatible builder, so creating a new one first"
|
|
||||||
execute *MRSK.builder.create
|
|
||||||
execute *MRSK.builder.push
|
|
||||||
end
|
|
||||||
end unless ENV["VERSION"]
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Pull app image from the registry onto servers"
|
|
||||||
task :pull do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.builder.pull }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Create a local build setup"
|
|
||||||
task :create do
|
|
||||||
run_locally do
|
|
||||||
debug "Using builder: #{MRSK.builder.name}"
|
|
||||||
execute *MRSK.builder.create
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Remove local build setup"
|
|
||||||
task :remove do
|
|
||||||
run_locally do
|
|
||||||
debug "Using builder: #{MRSK.builder.name}"
|
|
||||||
execute *MRSK.builder.remove
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Show the name of the configured builder"
|
|
||||||
task :info do
|
|
||||||
run_locally do
|
|
||||||
puts "Builder: #{MRSK.builder.name} (#{MRSK.builder.target.class.name})"
|
|
||||||
puts capture(*MRSK.builder.info)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
desc "Deploy app for the first time to a fresh server"
|
|
||||||
task fresh: %w[ server:bootstrap registry:login build:deliver traefik:run app:stop app:run ]
|
|
||||||
|
|
||||||
desc "Push the latest version of the app, ensure Traefik is running, then restart app"
|
|
||||||
task deploy: %w[ registry:login build:deliver traefik:run app:stop app:run prune ]
|
|
||||||
|
|
||||||
desc "Rollback to VERSION=x that was already run as a container on servers"
|
|
||||||
task rollback: %w[ app:restart ]
|
|
||||||
|
|
||||||
desc "Display information about Traefik and app containers"
|
|
||||||
task info: %w[ traefik:info app:info ]
|
|
||||||
|
|
||||||
desc "Create config stub in config/deploy.yml"
|
|
||||||
task :init do
|
|
||||||
require "fileutils"
|
|
||||||
|
|
||||||
if (deploy_file = Rails.root.join("config/deploy.yml")).exist?
|
|
||||||
puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
|
|
||||||
else
|
|
||||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
|
||||||
puts "Created configuration file in config/deploy.yml"
|
|
||||||
end
|
|
||||||
|
|
||||||
if (binstub = Rails.root.join("bin/mrsk")).exist?
|
|
||||||
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
|
||||||
else
|
|
||||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/mrsk", __dir__)), binstub
|
|
||||||
puts "Created binstub file in bin/mrsk"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Remove Traefik, app, and registry session from servers"
|
|
||||||
task remove: %w[ traefik:remove app:remove registry:logout ]
|
|
||||||
end
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
desc "Prune unused images and stopped containers"
|
|
||||||
task prune: %w[ prune:containers prune:images ]
|
|
||||||
|
|
||||||
namespace :prune do
|
|
||||||
desc "Prune unused images older than 30 days"
|
|
||||||
task :images do
|
|
||||||
on(MRSK.config.hosts) { MRSK.verbosity(:debug) { execute *MRSK.prune.images } }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Prune stopped containers for the service older than 3 days"
|
|
||||||
task :containers do
|
|
||||||
on(MRSK.config.hosts) { MRSK.verbosity(:debug) { execute *MRSK.prune.containers } }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
namespace :registry do
|
|
||||||
desc "Login to the registry locally and remotely"
|
|
||||||
task :login do
|
|
||||||
run_locally { execute *MRSK.registry.login }
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.registry.login }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Logout of the registry remotely"
|
|
||||||
task :logout do
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.registry.logout }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
namespace :server do
|
|
||||||
desc "Setup Docker on the remote servers"
|
|
||||||
task :bootstrap do
|
|
||||||
# FIXME: Detect when apt-get is not available and use the appropriate alternative
|
|
||||||
on(MRSK.config.hosts) { execute "apt-get install docker.io -y" }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
require "sshkit"
|
|
||||||
require "sshkit/dsl"
|
|
||||||
|
|
||||||
include SSHKit::DSL
|
|
||||||
|
|
||||||
MRSK = Mrsk::Commander.new config_file: Rails.root.join("config/deploy.yml"), verbose: ENV["VERBOSE"]
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
# Name of your application will be used for uniquely configuring Traefik and app containers.
|
|
||||||
# Your Dockerfile should set LABEL service=the-same-value to ensure image pruning works.
|
|
||||||
service: my-app
|
|
||||||
|
|
||||||
# Name of the container image
|
|
||||||
image: user/my-app
|
|
||||||
|
|
||||||
# All the servers targeted for deploy. You can reference a single server for a command by using SERVERS=192.168.0.1
|
|
||||||
servers:
|
|
||||||
- 192.168.0.1
|
|
||||||
|
|
||||||
# The following envs are made available to the container when started
|
|
||||||
env:
|
|
||||||
# Remember never to put passwords or tokens directly into this file, use encrypted credentials
|
|
||||||
# REDIS_URL: redis://x/y
|
|
||||||
|
|
||||||
# Where your images will be hosted
|
|
||||||
registry:
|
|
||||||
# Specify the registry server, if you're not using Docker Hub
|
|
||||||
# server: registry.digitalocean.com / ghcr.io / ...
|
|
||||||
|
|
||||||
# Set credentials with bin/rails credentials:edit
|
|
||||||
username: my-user
|
|
||||||
password: my-password-should-go-in-credentials
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
if [ "${*}" == "" ]; then
|
|
||||||
# Improve so list matches
|
|
||||||
exec bin/rake -T mrsk
|
|
||||||
else
|
|
||||||
exec bin/rake "mrsk:$@"
|
|
||||||
fi
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
require_relative "setup"
|
|
||||||
|
|
||||||
namespace :mrsk do
|
|
||||||
namespace :traefik do
|
|
||||||
desc "Run Traefik on servers"
|
|
||||||
task :run do
|
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Start existing Traefik on servers"
|
|
||||||
task :start do
|
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Stop Traefik on servers"
|
|
||||||
task :stop do
|
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Restart Traefik on servers"
|
|
||||||
task restart: %i[ stop start ]
|
|
||||||
|
|
||||||
desc "Display information about Traefik containers from servers"
|
|
||||||
task :info do
|
|
||||||
on(MRSK.config.role(:web).hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.info) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Show last 100 log lines from Traefik on servers"
|
|
||||||
task :logs do
|
|
||||||
on(MRSK.config.hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.logs) + "\n\n" }
|
|
||||||
end
|
|
||||||
|
|
||||||
desc "Remove Traefik container and image from servers"
|
|
||||||
task remove: %i[ stop ] do
|
|
||||||
on(MRSK.config.role(:web).hosts) do
|
|
||||||
execute *MRSK.traefik.remove_container
|
|
||||||
execute *MRSK.traefik.remove_image
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -6,11 +6,14 @@ 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 Docker containers with zero downtime to any host."
|
spec.summary = "Deploy Rails 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"]
|
||||||
|
spec.executables = %w[ mrsk ]
|
||||||
|
|
||||||
spec.add_dependency "railties", ">= 7.0.0"
|
spec.add_dependency "activesupport", ">= 7.0"
|
||||||
spec.add_dependency "sshkit", "~> 1.21"
|
spec.add_dependency "sshkit", "~> 1.21"
|
||||||
|
spec.add_dependency "thor", "~> 1.2"
|
||||||
|
spec.add_dependency "dotenv", "~> 2.8"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
require "test_helper"
|
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/app"
|
|
||||||
|
|
||||||
ENV["VERSION"] = "123"
|
|
||||||
ENV["RAILS_MASTER_KEY"] = "456"
|
|
||||||
|
|
||||||
class AppCommandTest < ActiveSupport::TestCase
|
|
||||||
setup do
|
|
||||||
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
|
|
||||||
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config)
|
|
||||||
end
|
|
||||||
|
|
||||||
test "run" do
|
|
||||||
assert_equal \
|
|
||||||
[:docker, :run, "-d", "--restart unless-stopped", "--name", "app-123", "-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:123"], @app.run
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
require "test_helper"
|
|
||||||
require "mrsk/configuration"
|
|
||||||
require "mrsk/commands/builder"
|
|
||||||
|
|
||||||
class BuilderCommandTest < ActiveSupport::TestCase
|
|
||||||
setup do
|
|
||||||
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
|
|
||||||
end
|
|
||||||
|
|
||||||
test "target multiarch by default" do
|
|
||||||
builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config))
|
|
||||||
assert builder.multiarch?
|
|
||||||
end
|
|
||||||
|
|
||||||
test "target native when multiarch is off" do
|
|
||||||
builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge({ builder: { "multiarch" => false } })))
|
|
||||||
assert builder.native?
|
|
||||||
end
|
|
||||||
|
|
||||||
test "target multiarch remote when local and remote is set" do
|
|
||||||
builder = Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge({ builder: { "local" => { }, "remote" => { } } })))
|
|
||||||
assert builder.remote?
|
|
||||||
end
|
|
||||||
end
|
|
||||||
34
test/cli/accessory_test.rb
Normal file
34
test/cli/accessory_test.rb
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "active_support/testing/stream"
|
||||||
|
require "mrsk/cli"
|
||||||
|
|
||||||
|
class CliAccessoryTest < ActiveSupport::TestCase
|
||||||
|
include ActiveSupport::Testing::Stream
|
||||||
|
|
||||||
|
setup { ENV["MYSQL_ROOT_PASSWORD"] = "secret123" }
|
||||||
|
teardown { ENV["MYSQL_ROOT_PASSWORD"] = nil }
|
||||||
|
|
||||||
|
test "upload" do
|
||||||
|
command = stdouted { Mrsk::Cli::Accessory.start(["upload", "mysql", "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
|
||||||
|
assert_match "test/fixtures/files/my.cnf app-mysql/etc/mysql/my.cnf", command
|
||||||
|
end
|
||||||
|
|
||||||
|
test "directories" do
|
||||||
|
command = stdouted { Mrsk::Cli::Accessory.start(["directories", "mysql", "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
|
||||||
|
assert_match "mkdir -p $PWD/app-mysql/data", command
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove service direcotry" do
|
||||||
|
command = stdouted { Mrsk::Cli::Accessory.start(["remove_service_directory", "mysql", "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
|
||||||
|
assert_match "rm -rf app-mysql", command
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot" do
|
||||||
|
command = stdouted { Mrsk::Cli::Accessory.start(["boot", "mysql", "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
|
||||||
|
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", command
|
||||||
|
end
|
||||||
|
end
|
||||||
15
test/cli/main_test.rb
Normal file
15
test/cli/main_test.rb
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "active_support/testing/stream"
|
||||||
|
require "mrsk/cli"
|
||||||
|
|
||||||
|
class CliMainTest < ActiveSupport::TestCase
|
||||||
|
include ActiveSupport::Testing::Stream
|
||||||
|
|
||||||
|
setup do
|
||||||
|
end
|
||||||
|
|
||||||
|
test "version" do
|
||||||
|
version = stdouted { Mrsk::Cli::Main.new.version }
|
||||||
|
assert_equal Mrsk::VERSION, version
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -3,10 +3,34 @@ require "mrsk/commander"
|
|||||||
|
|
||||||
class CommanderTest < ActiveSupport::TestCase
|
class CommanderTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@mrsk = Mrsk::Commander.new config_file: Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
|
@mrsk = Mrsk::Commander.new config_file: Pathname.new(File.expand_path("fixtures/deploy_with_roles.yml", __dir__))
|
||||||
end
|
end
|
||||||
|
|
||||||
test "lazy configuration" do
|
test "lazy configuration" do
|
||||||
assert_equal Mrsk::Configuration, @mrsk.config.class
|
assert_equal Mrsk::Configuration, @mrsk.config.class
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "overwriting hosts" do
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
|
||||||
|
@mrsk.specific_hosts = [ "1.2.3.4", "1.2.3.5" ]
|
||||||
|
assert_equal [ "1.2.3.4", "1.2.3.5" ], @mrsk.hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
test "overwriting hosts with roles" do
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
|
||||||
|
@mrsk.specific_roles = [ "workers", "web" ]
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
|
||||||
|
@mrsk.specific_roles = [ "workers" ]
|
||||||
|
assert_equal [ "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
test "overwriting hosts with primary" do
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @mrsk.hosts
|
||||||
|
|
||||||
|
@mrsk.specific_primary!
|
||||||
|
assert_equal [ "1.1.1.1" ], @mrsk.hosts
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
86
test/commands/accessory_test.rb
Normal file
86
test/commands/accessory_test.rb
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
require "mrsk/commands/accessory"
|
||||||
|
|
||||||
|
class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||||
|
servers: [ "1.1.1.1" ],
|
||||||
|
accessories: {
|
||||||
|
"mysql" => {
|
||||||
|
"image" => "mysql:8.0",
|
||||||
|
"host" => "1.1.1.5",
|
||||||
|
"port" => "3306",
|
||||||
|
"env" => {
|
||||||
|
"clear" => {
|
||||||
|
"MYSQL_ROOT_HOST" => "%"
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"MYSQL_ROOT_PASSWORD"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"redis" => {
|
||||||
|
"image" => "redis:latest",
|
||||||
|
"host" => "1.1.1.6",
|
||||||
|
"port" => "6379:6379",
|
||||||
|
"labels" => {
|
||||||
|
"cache" => true
|
||||||
|
},
|
||||||
|
"env" => {
|
||||||
|
"SOMETHING" => "else"
|
||||||
|
},
|
||||||
|
"volumes" => [
|
||||||
|
"/var/lib/redis:/data"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@config = Mrsk::Configuration.new(@config)
|
||||||
|
@mysql = Mrsk::Commands::Accessory.new(@config, name: :mysql)
|
||||||
|
@redis = Mrsk::Commands::Accessory.new(@config, name: :redis)
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = "secret123"
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
ensure
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "start" do
|
||||||
|
assert_equal [:docker, :container, :start, "app-mysql"], @mysql.start
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal [:docker, :container, :stop, "app-mysql"], @mysql.stop
|
||||||
|
end
|
||||||
|
|
||||||
|
test "info" do
|
||||||
|
assert_equal [:docker, :ps, "--filter", "label=service=app-mysql"], @mysql.info
|
||||||
|
end
|
||||||
|
|
||||||
|
test "logs" do
|
||||||
|
assert_equal [:docker, :logs, "app-mysql", "-t", "2>&1"], @mysql.logs
|
||||||
|
assert_equal [:docker, :logs, "app-mysql", " --since 5m", " -n 100", "-t", "2>&1", "|", "grep 'thing'"], @mysql.logs(since: "5m", lines: 100, grep: "thing")
|
||||||
|
end
|
||||||
|
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove container" do
|
||||||
|
assert_equal [:docker, :container, :prune, "-f", "--filter", "label=service=app-mysql"], @mysql.remove_container
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove image" do
|
||||||
|
assert_equal [:docker, :image, :prune, "-a", "-f", "--filter", "label=service=app-mysql"], @mysql.remove_image
|
||||||
|
end
|
||||||
|
end
|
||||||
41
test/commands/app_test.rb
Normal file
41
test/commands/app_test.rb
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
require "mrsk/commands/app"
|
||||||
|
|
||||||
|
class CommandsAppTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
ENV["RAILS_MASTER_KEY"] = "456"
|
||||||
|
|
||||||
|
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config)
|
||||||
|
end
|
||||||
|
|
||||||
|
teardown do
|
||||||
|
ENV["RAILS_MASTER_KEY"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with volumes" do
|
||||||
|
@config[:volumes] = ["/local/path:/container/path" ]
|
||||||
|
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with" do
|
||||||
|
assert_equal \
|
||||||
|
[ :docker, :run, "--rm", "-e", "RAILS_MASTER_KEY=456", "dhh/app:missing", "bin/rails", "db:setup" ],
|
||||||
|
@app.run_exec("bin/rails", "db:setup")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run without master key" do
|
||||||
|
ENV["RAILS_MASTER_KEY"] = nil
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:skip_master_key] = true })
|
||||||
|
|
||||||
|
assert @app.run.exclude?("RAILS_MASTER_KEY=456")
|
||||||
|
end
|
||||||
|
end
|
||||||
63
test/commands/builder_test.rb
Normal file
63
test/commands/builder_test.rb
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
require "mrsk/commands/builder"
|
||||||
|
|
||||||
|
class CommandsBuilderTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = { service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ] }
|
||||||
|
end
|
||||||
|
|
||||||
|
test "target multiarch by default" do
|
||||||
|
builder = new_builder_command
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "target native when multiarch is off" do
|
||||||
|
builder = new_builder_command(builder: { "multiarch" => false })
|
||||||
|
assert_equal "native", builder.name
|
||||||
|
assert_equal [:docker, :build, "-t", "dhh/app:123", ".", "&&", :docker, :push, "dhh/app:123"], builder.push
|
||||||
|
end
|
||||||
|
|
||||||
|
test "target multiarch remote when local and remote is set" do
|
||||||
|
builder = new_builder_command(builder: { "local" => { }, "remote" => { } })
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "target native remote when only remote is set" do
|
||||||
|
builder = new_builder_command(builder: { "remote" => { "arch" => "amd64" } })
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "build args" do
|
||||||
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
|
assert_equal [ "--build-arg", "a=1", "--build-arg", "b=2" ], builder.target.build_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "build secrets" do
|
||||||
|
builder = new_builder_command(builder: { "secrets" => ["token_a", "token_b"] })
|
||||||
|
assert_equal [ "--secret", "id=token_a", "--secret", "id=token_b" ], builder.target.build_secrets
|
||||||
|
end
|
||||||
|
|
||||||
|
test "native push with build args" do
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "multiarch push with build args" do
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
test "native push with with build secrets" do
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_builder_command(additional_config = {})
|
||||||
|
Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge(additional_config), version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
23
test/commands/traefik_test.rb
Normal file
23
test/commands/traefik_test.rb
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
require "mrsk/commands/traefik"
|
||||||
|
|
||||||
|
class CommandsTraefikTest < 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, "--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"],
|
||||||
|
new_command.run
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Traefik.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
108
test/configuration/accessory_test.rb
Normal file
108
test/configuration/accessory_test.rb
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
|
||||||
|
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||||
|
servers: [ "1.1.1.1", "1.1.1.2" ],
|
||||||
|
env: { "REDIS_URL" => "redis://x/y" },
|
||||||
|
accessories: {
|
||||||
|
"mysql" => {
|
||||||
|
"image" => "mysql:8.0",
|
||||||
|
"host" => "1.1.1.5",
|
||||||
|
"port" => "3306",
|
||||||
|
"env" => {
|
||||||
|
"clear" => {
|
||||||
|
"MYSQL_ROOT_HOST" => "%"
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"MYSQL_ROOT_PASSWORD"
|
||||||
|
],
|
||||||
|
},
|
||||||
|
"files" => [
|
||||||
|
"config/mysql/my.cnf:/etc/mysql/my.cnf",
|
||||||
|
"db/structure.sql:/docker-entrypoint-initdb.d/structure.sql"
|
||||||
|
],
|
||||||
|
"directories" => [
|
||||||
|
"data:/var/lib/mysql"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"redis" => {
|
||||||
|
"image" => "redis:latest",
|
||||||
|
"host" => "1.1.1.6",
|
||||||
|
"port" => "6379:6379",
|
||||||
|
"labels" => {
|
||||||
|
"cache" => true
|
||||||
|
},
|
||||||
|
"env" => {
|
||||||
|
"SOMETHING" => "else"
|
||||||
|
},
|
||||||
|
"volumes" => [
|
||||||
|
"/var/lib/redis:/data"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@config = Mrsk::Configuration.new(@deploy)
|
||||||
|
end
|
||||||
|
|
||||||
|
test "service name" do
|
||||||
|
assert_equal "app-mysql", @config.accessory(:mysql).service_name
|
||||||
|
assert_equal "app-redis", @config.accessory(:redis).service_name
|
||||||
|
end
|
||||||
|
|
||||||
|
test "port" do
|
||||||
|
assert_equal "3306:3306", @config.accessory(:mysql).port
|
||||||
|
assert_equal "6379:6379", @config.accessory(:redis).port
|
||||||
|
end
|
||||||
|
|
||||||
|
test "host" do
|
||||||
|
assert_equal "1.1.1.5", @config.accessory(:mysql).host
|
||||||
|
assert_equal "1.1.1.6", @config.accessory(:redis).host
|
||||||
|
end
|
||||||
|
|
||||||
|
test "missing host" do
|
||||||
|
@deploy[:accessories]["mysql"]["host"] = nil
|
||||||
|
@config = Mrsk::Configuration.new(@deploy)
|
||||||
|
|
||||||
|
assert_raises(ArgumentError) do
|
||||||
|
@config.accessory(:mysql).host
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "label args" do
|
||||||
|
assert_equal ["--label", "service=app-mysql"], @config.accessory(:mysql).label_args
|
||||||
|
assert_equal ["--label", "service=app-redis", "--label", "cache=true"], @config.accessory(:redis).label_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env args with secret" do
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = "secret123"
|
||||||
|
assert_equal ["-e", "MYSQL_ROOT_PASSWORD=secret123", "-e", "MYSQL_ROOT_HOST=%"], @config.accessory(:mysql).env_args
|
||||||
|
assert @config.accessory(:mysql).env_args[1].is_a?(SSHKit::Redaction)
|
||||||
|
ensure
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env args without secret" do
|
||||||
|
assert_equal ["-e", "SOMETHING=else"], @config.accessory(:redis).env_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "volume args" do
|
||||||
|
assert_equal ["--volume", "$PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf", "--volume", "$PWD/app-mysql/docker-entrypoint-initdb.d/structure.sql:/docker-entrypoint-initdb.d/structure.sql", "--volume", "$PWD/app-mysql/data:/var/lib/mysql"], @config.accessory(:mysql).volume_args
|
||||||
|
assert_equal ["--volume", "/var/lib/redis:/data"], @config.accessory(:redis).volume_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "dynamic file expansion" do
|
||||||
|
@deploy[:accessories]["mysql"]["files"] << "test/fixtures/files/structure.sql.erb:/docker-entrypoint-initdb.d/structure.sql"
|
||||||
|
@config = Mrsk::Configuration.new(@deploy)
|
||||||
|
|
||||||
|
assert_match "This was dynamically expanded", @config.accessory(:mysql).files.keys[2].read
|
||||||
|
assert_match "%", @config.accessory(:mysql).files.keys[2].read
|
||||||
|
end
|
||||||
|
|
||||||
|
test "directories" do
|
||||||
|
assert_equal({"$PWD/app-mysql/data"=>"/var/lib/mysql"}, @config.accessory(:mysql).directories)
|
||||||
|
end
|
||||||
|
end
|
||||||
141
test/configuration/role_test.rb
Normal file
141
test/configuration/role_test.rb
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "mrsk/configuration"
|
||||||
|
|
||||||
|
class ConfigurationRoleTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||||
|
servers: [ "1.1.1.1", "1.1.1.2" ],
|
||||||
|
env: { "REDIS_URL" => "redis://x/y" }
|
||||||
|
}
|
||||||
|
|
||||||
|
@config = Mrsk::Configuration.new(@deploy)
|
||||||
|
|
||||||
|
@deploy_with_roles = @deploy.dup.merge({
|
||||||
|
servers: {
|
||||||
|
"web" => [ "1.1.1.1", "1.1.1.2" ],
|
||||||
|
"workers" => {
|
||||||
|
"hosts" => [ "1.1.1.3", "1.1.1.4" ],
|
||||||
|
"cmd" => "bin/jobs",
|
||||||
|
"env" => {
|
||||||
|
"REDIS_URL" => "redis://a/b",
|
||||||
|
"WEB_CONCURRENCY" => 4
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
@config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
|
||||||
|
end
|
||||||
|
|
||||||
|
test "hosts" do
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2" ], @config.role(:web).hosts
|
||||||
|
assert_equal [ "1.1.1.3", "1.1.1.4" ], @config_with_roles.role(:workers).hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
test "cmd" do
|
||||||
|
assert_nil @config.role(:web).cmd
|
||||||
|
assert_equal "bin/jobs", @config_with_roles.role(:workers).cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
test "label args" do
|
||||||
|
assert_equal [ "--label", "service=app", "--label", "role=workers" ], @config_with_roles.role(:workers).label_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "special label args for web" do
|
||||||
|
assert_equal [ "--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"], @config.role(:web).label_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "custom labels" do
|
||||||
|
@deploy[:labels] = { "my.custom.label" => "50" }
|
||||||
|
assert_equal "50", @config.role(:web).labels["my.custom.label"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "custom labels via role specialization" do
|
||||||
|
@deploy_with_roles[:labels] = { "my.custom.label" => "50" }
|
||||||
|
@deploy_with_roles[:servers]["workers"]["labels"] = { "my.custom.label" => "70" }
|
||||||
|
assert_equal "70", @config_with_roles.role(:workers).labels["my.custom.label"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "overwriting default traefik label" do
|
||||||
|
@deploy[:labels] = { "traefik.http.routers.app.rule" => "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'" }
|
||||||
|
assert_equal "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'", @config.role(:web).labels["traefik.http.routers.app.rule"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "default traefik label on non-web role" do
|
||||||
|
config = Mrsk::Configuration.new(@deploy_with_roles.tap { |c|
|
||||||
|
c[:servers]["beta"] = { "traefik" => "true", "hosts" => [ "1.1.1.5" ] }
|
||||||
|
})
|
||||||
|
|
||||||
|
assert_equal [ "--label", "service=app", "--label", "role=beta", "--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" ], config.role(:beta).label_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env overwritten by role" do
|
||||||
|
assert_equal "redis://a/b", @config_with_roles.role(:workers).env["REDIS_URL"]
|
||||||
|
assert_equal ["-e", "REDIS_URL=redis://a/b", "-e", "WEB_CONCURRENCY=4"], @config_with_roles.role(:workers).env_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env secret overwritten by role" do
|
||||||
|
@deploy_with_roles[:env] = {
|
||||||
|
"clear" => {
|
||||||
|
"REDIS_URL" => "redis://a/b"
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"REDIS_PASSWORD"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
@deploy_with_roles[:servers]["workers"]["env"] = {
|
||||||
|
"clear" => {
|
||||||
|
"REDIS_URL" => "redis://a/b",
|
||||||
|
"WEB_CONCURRENCY" => 4
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"DB_PASSWORD"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
ENV["REDIS_PASSWORD"] = "secret456"
|
||||||
|
ENV["DB_PASSWORD"] = "secret123"
|
||||||
|
|
||||||
|
assert_equal ["-e", "REDIS_PASSWORD=secret456", "-e", "DB_PASSWORD=secret123", "-e", "REDIS_URL=redis://a/b", "-e", "WEB_CONCURRENCY=4"], @config_with_roles.role(:workers).env_args
|
||||||
|
ensure
|
||||||
|
ENV["REDIS_PASSWORD"] = nil
|
||||||
|
ENV["DB_PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env secrets only in role" do
|
||||||
|
@deploy_with_roles[:servers]["workers"]["env"] = {
|
||||||
|
"clear" => {
|
||||||
|
"REDIS_URL" => "redis://a/b",
|
||||||
|
"WEB_CONCURRENCY" => 4
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"DB_PASSWORD"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
ENV["DB_PASSWORD"] = "secret123"
|
||||||
|
|
||||||
|
assert_equal ["-e", "DB_PASSWORD=secret123", "-e", "REDIS_URL=redis://a/b", "-e", "WEB_CONCURRENCY=4"], @config_with_roles.role(:workers).env_args
|
||||||
|
ensure
|
||||||
|
ENV["DB_PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env secrets only at top level" do
|
||||||
|
@deploy_with_roles[:env] = {
|
||||||
|
"clear" => {
|
||||||
|
"REDIS_URL" => "redis://a/b"
|
||||||
|
},
|
||||||
|
"secret" => [
|
||||||
|
"REDIS_PASSWORD"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
ENV["REDIS_PASSWORD"] = "secret456"
|
||||||
|
|
||||||
|
assert_equal ["-e", "REDIS_PASSWORD=secret456", "-e", "REDIS_URL=redis://a/b", "-e", "WEB_CONCURRENCY=4"], @config_with_roles.role(:workers).env_args
|
||||||
|
ensure
|
||||||
|
ENV["REDIS_PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
require "test_helper"
|
|
||||||
require "mrsk/configuration"
|
|
||||||
|
|
||||||
ENV["VERSION"] = "123"
|
|
||||||
|
|
||||||
class ConfigurationRoleTest < ActiveSupport::TestCase
|
|
||||||
setup do
|
|
||||||
@deploy = {
|
|
||||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
|
||||||
servers: [ "1.1.1.1", "1.1.1.2" ]
|
|
||||||
}
|
|
||||||
|
|
||||||
@config = Mrsk::Configuration.new(@deploy)
|
|
||||||
|
|
||||||
@deploy_with_roles = @deploy.dup.merge({
|
|
||||||
servers: {
|
|
||||||
"web" => [ "1.1.1.1", "1.1.1.2" ],
|
|
||||||
"workers" => {
|
|
||||||
"hosts" => [ "1.1.1.3", "1.1.1.4" ],
|
|
||||||
"cmd" => "bin/jobs"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
@config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
|
|
||||||
end
|
|
||||||
|
|
||||||
test "hosts" do
|
|
||||||
assert_equal [ "1.1.1.1", "1.1.1.2" ], @config.role(:web).hosts
|
|
||||||
assert_equal [ "1.1.1.3", "1.1.1.4" ], @config_with_roles.role(:workers).hosts
|
|
||||||
end
|
|
||||||
|
|
||||||
test "cmd" do
|
|
||||||
assert_nil @config.role(:web).cmd
|
|
||||||
assert_equal "bin/jobs", @config_with_roles.role(:workers).cmd
|
|
||||||
end
|
|
||||||
|
|
||||||
test "label args" do
|
|
||||||
assert_equal [ "--label", "service=app", "--label", "role=workers" ], @config_with_roles.role(:workers).label_args
|
|
||||||
end
|
|
||||||
|
|
||||||
test "special label args for web" do
|
|
||||||
assert_equal [ "--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"], @config.role(:web).label_args
|
|
||||||
end
|
|
||||||
|
|
||||||
test "custom labels" do
|
|
||||||
@deploy[:labels] = { "my.custom.label" => "50" }
|
|
||||||
assert_equal "50", @config.role(:web).labels["my.custom.label"]
|
|
||||||
end
|
|
||||||
|
|
||||||
test "custom labels via role specialization" do
|
|
||||||
@deploy_with_roles[:labels] = { "my.custom.label" => "50" }
|
|
||||||
@deploy_with_roles[:servers]["workers"]["labels"] = { "my.custom.label" => "70" }
|
|
||||||
assert_equal "70", @config_with_roles.role(:workers).labels["my.custom.label"]
|
|
||||||
end
|
|
||||||
|
|
||||||
test "overwriting default traefik label" do
|
|
||||||
@deploy[:labels] = { "traefik.http.routers.app.rule" => "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'" }
|
|
||||||
assert_equal "'Host(`example.com`) || (Host(`example.org`) && Path(`/traefik`))'", @config.role(:web).labels["traefik.http.routers.app.rule"]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,16 +1,16 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
require "mrsk/configuration"
|
require "mrsk/configuration"
|
||||||
|
|
||||||
ENV["VERSION"] = "123"
|
|
||||||
ENV["RAILS_MASTER_KEY"] = "456"
|
|
||||||
|
|
||||||
class ConfigurationTest < ActiveSupport::TestCase
|
class ConfigurationTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
|
ENV["RAILS_MASTER_KEY"] = "456"
|
||||||
|
|
||||||
@deploy = {
|
@deploy = {
|
||||||
service: "app", image: "dhh/app",
|
service: "app", image: "dhh/app",
|
||||||
registry: { "username" => "dhh", "password" => "secret" },
|
registry: { "username" => "dhh", "password" => "secret" },
|
||||||
env: { "REDIS_URL" => "redis://x/y" },
|
env: { "REDIS_URL" => "redis://x/y" },
|
||||||
servers: [ "1.1.1.1", "1.1.1.2" ]
|
servers: [ "1.1.1.1", "1.1.1.2" ],
|
||||||
|
volumes: ["/local/path:/container/path"]
|
||||||
}
|
}
|
||||||
|
|
||||||
@config = Mrsk::Configuration.new(@deploy)
|
@config = Mrsk::Configuration.new(@deploy)
|
||||||
@@ -21,6 +21,10 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
@config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
|
@config_with_roles = Mrsk::Configuration.new(@deploy_with_roles)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
teardown do
|
||||||
|
ENV["RAILS_MASTER_KEY"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
test "ensure valid keys" do
|
test "ensure valid keys" do
|
||||||
assert_raise(ArgumentError) do
|
assert_raise(ArgumentError) do
|
||||||
Mrsk::Configuration.new(@deploy.tap { _1.delete(:service) })
|
Mrsk::Configuration.new(@deploy.tap { _1.delete(:service) })
|
||||||
@@ -43,36 +47,28 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
assert_nil @config.role(:missing)
|
assert_nil @config.role(:missing)
|
||||||
end
|
end
|
||||||
|
|
||||||
test "hosts" do
|
test "all hosts" do
|
||||||
assert_equal [ "1.1.1.1", "1.1.1.2"], @config.hosts
|
assert_equal [ "1.1.1.1", "1.1.1.2"], @config.all_hosts
|
||||||
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @config_with_roles.all_hosts
|
||||||
end
|
end
|
||||||
|
|
||||||
test "hosts from ENV" do
|
test "primary web host" do
|
||||||
ENV["HOSTS"] = "1.1.1.5,1.1.1.6"
|
assert_equal "1.1.1.1", @config.primary_web_host
|
||||||
assert_equal [ "1.1.1.5", "1.1.1.6"], @config.hosts
|
assert_equal "1.1.1.1", @config_with_roles.primary_web_host
|
||||||
ensure
|
|
||||||
ENV["HOSTS"] = nil
|
|
||||||
end
|
end
|
||||||
|
|
||||||
test "hosts from ENV roles" do
|
test "traefik hosts" do
|
||||||
ENV["ROLES"] = "web,workers"
|
assert_equal [ "1.1.1.1", "1.1.1.2" ], @config_with_roles.traefik_hosts
|
||||||
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
|
|
||||||
|
|
||||||
ENV["ROLES"] = "workers"
|
@deploy_with_roles[:servers]["workers"]["traefik"] = true
|
||||||
assert_equal [ "1.1.1.3", "1.1.1.4" ], @config_with_roles.hosts
|
config = Mrsk::Configuration.new(@deploy_with_roles)
|
||||||
ensure
|
|
||||||
ENV["ROLES"] = nil
|
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], config.traefik_hosts
|
||||||
end
|
end
|
||||||
|
|
||||||
test "primary host" do
|
|
||||||
assert_equal "1.1.1.1", @config.primary_host
|
|
||||||
assert_equal "1.1.1.1", @config_with_roles.primary_host
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
test "version" do
|
test "version" do
|
||||||
assert_equal "123", @config.version
|
assert_equal "missing", @config.version
|
||||||
|
assert_equal "123", Mrsk::Configuration.new(@deploy, version: "123").version
|
||||||
end
|
end
|
||||||
|
|
||||||
test "repository" do
|
test "repository" do
|
||||||
@@ -83,21 +79,64 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "absolute image" do
|
test "absolute image" do
|
||||||
assert_equal "dhh/app:123", @config.absolute_image
|
assert_equal "dhh/app:missing", @config.absolute_image
|
||||||
|
|
||||||
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:registry].merge!({ "server" => "ghcr.io" }) })
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:registry].merge!({ "server" => "ghcr.io" }) })
|
||||||
assert_equal "ghcr.io/dhh/app:123", config.absolute_image
|
assert_equal "ghcr.io/dhh/app:missing", config.absolute_image
|
||||||
end
|
end
|
||||||
|
|
||||||
test "service with version" do
|
test "service with version" do
|
||||||
assert_equal "app-123", @config.service_with_version
|
assert_equal "app-missing", @config.service_with_version
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "env args" do
|
test "env args" do
|
||||||
assert_equal [ "-e", "REDIS_URL=redis://x/y" ], @config.env_args
|
assert_equal [ "-e", "REDIS_URL=redis://x/y" ], @config.env_args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "env args with clear and secrets" do
|
||||||
|
ENV["PASSWORD"] = "secret123"
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!({
|
||||||
|
env: { "clear" => { "PORT" => "3000" }, "secret" => [ "PASSWORD" ] }
|
||||||
|
}) })
|
||||||
|
|
||||||
|
assert_equal [ "-e", "PASSWORD=secret123", "-e", "PORT=3000" ], config.env_args
|
||||||
|
assert config.env_args[1].is_a?(SSHKit::Redaction)
|
||||||
|
ensure
|
||||||
|
ENV["PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env args with only clear" do
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!({
|
||||||
|
env: { "clear" => { "PORT" => "3000" } }
|
||||||
|
}) })
|
||||||
|
|
||||||
|
assert_equal [ "-e", "PORT=3000" ], config.env_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env args with only secrets" do
|
||||||
|
ENV["PASSWORD"] = "secret123"
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!({
|
||||||
|
env: { "secret" => [ "PASSWORD" ] }
|
||||||
|
}) })
|
||||||
|
|
||||||
|
assert_equal [ "-e", "PASSWORD=secret123" ], config.env_args
|
||||||
|
assert config.env_args[1].is_a?(SSHKit::Redaction)
|
||||||
|
ensure
|
||||||
|
ENV["PASSWORD"] = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
test "env args with missing secret" do
|
||||||
|
assert_raises(KeyError) do
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!({
|
||||||
|
env: { "secret" => [ "PASSWORD" ] }
|
||||||
|
}) })
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "valid config" do
|
||||||
|
assert @config.valid?
|
||||||
|
end
|
||||||
|
|
||||||
test "ssh options" do
|
test "ssh options" do
|
||||||
assert_equal "root", @config.ssh_options[:user]
|
assert_equal "root", @config.ssh_options[:user]
|
||||||
|
|
||||||
@@ -109,9 +148,39 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
assert_equal "456", @config.master_key
|
assert_equal "456", @config.master_key
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "skip master key" do
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:skip_master_key] = true })
|
||||||
|
assert_nil @config.master_key
|
||||||
|
end
|
||||||
|
|
||||||
|
test "volume_args" do
|
||||||
|
assert_equal ["--volume", "/local/path:/container/path"], @config.volume_args
|
||||||
|
end
|
||||||
|
|
||||||
test "erb evaluation of yml config" do
|
test "erb evaluation of yml config" do
|
||||||
config = Mrsk::Configuration.load_file Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
|
config = Mrsk::Configuration.create_from Pathname.new(File.expand_path("fixtures/deploy.erb.yml", __dir__))
|
||||||
assert_equal "my-user", config.registry["username"]
|
assert_equal "my-user", config.registry["username"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "destination yml config merge" do
|
||||||
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
|
config = Mrsk::Configuration.create_from dest_config_file, destination: "world"
|
||||||
|
assert_equal "1.1.1.1", config.all_hosts.first
|
||||||
|
|
||||||
|
config = Mrsk::Configuration.create_from dest_config_file, destination: "mars"
|
||||||
|
assert_equal "1.1.1.3", config.all_hosts.first
|
||||||
|
end
|
||||||
|
|
||||||
|
test "destination yml config file missing" do
|
||||||
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
|
assert_raises(RuntimeError) do
|
||||||
|
config = Mrsk::Configuration.create_from dest_config_file, destination: "missing"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "to_h" do
|
||||||
|
assert_equal({ :roles=>["web"], :hosts=>["1.1.1.1", "1.1.1.2"], :primary_host=>"1.1.1.1", :version=>"missing", :repository=>"dhh/app", :absolute_image=>"dhh/app:missing", :service_with_version=>"app-missing", :env_args=>["-e", "REDIS_URL=redis://x/y"], :ssh_options=>{:user=>"root", :auth_methods=>["publickey"]}, :volume_args=>["--volume", "/local/path:/container/path"] }, @config.to_h)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
5
test/fixtures/deploy_for_dest.mars.yml
vendored
Normal file
5
test/fixtures/deploy_for_dest.mars.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
servers:
|
||||||
|
- 1.1.1.3
|
||||||
|
- 1.1.1.4
|
||||||
|
env:
|
||||||
|
REDIS_URL: redis://a/b
|
||||||
5
test/fixtures/deploy_for_dest.world.yml
vendored
Normal file
5
test/fixtures/deploy_for_dest.world.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
servers:
|
||||||
|
- 1.1.1.1
|
||||||
|
- 1.1.1.2
|
||||||
|
env:
|
||||||
|
REDIS_URL: redis://x/y
|
||||||
6
test/fixtures/deploy_for_dest.yml
vendored
Normal file
6
test/fixtures/deploy_for_dest.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
service: app
|
||||||
|
image: dhh/app
|
||||||
|
registry:
|
||||||
|
server: registry.digitalocean.com
|
||||||
|
username: <%= "my-user" %>
|
||||||
|
password: <%= "my-password" %>
|
||||||
29
test/fixtures/deploy_with_accessories.yml
vendored
Normal file
29
test/fixtures/deploy_with_accessories.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
service: app
|
||||||
|
image: dhh/app
|
||||||
|
servers:
|
||||||
|
- 1.1.1.1
|
||||||
|
- 1.1.1.2
|
||||||
|
registry:
|
||||||
|
username: user
|
||||||
|
password: pw
|
||||||
|
|
||||||
|
accessories:
|
||||||
|
mysql:
|
||||||
|
image: mysql:5.7
|
||||||
|
host: 1.1.1.3
|
||||||
|
port: 3306
|
||||||
|
env:
|
||||||
|
clear:
|
||||||
|
MYSQL_ROOT_HOST: '%'
|
||||||
|
secret:
|
||||||
|
- MYSQL_ROOT_PASSWORD
|
||||||
|
files:
|
||||||
|
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
|
||||||
|
directories:
|
||||||
|
- data:/var/lib/mysql
|
||||||
|
redis:
|
||||||
|
image: redis:latest
|
||||||
|
host: 1.1.1.4
|
||||||
|
port: 6379
|
||||||
|
directories:
|
||||||
|
- data:/data
|
||||||
15
test/fixtures/deploy_with_roles.yml
vendored
Normal file
15
test/fixtures/deploy_with_roles.yml
vendored
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
service: app
|
||||||
|
image: dhh/app
|
||||||
|
servers:
|
||||||
|
web:
|
||||||
|
- 1.1.1.1
|
||||||
|
- 1.1.1.2
|
||||||
|
workers:
|
||||||
|
- 1.1.1.3
|
||||||
|
- 1.1.1.4
|
||||||
|
env:
|
||||||
|
REDIS_URL: redis://x/y
|
||||||
|
registry:
|
||||||
|
server: registry.digitalocean.com
|
||||||
|
username: user
|
||||||
|
password: pw
|
||||||
1
test/fixtures/files/my.cnf
vendored
Normal file
1
test/fixtures/files/my.cnf
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# MySQL Config
|
||||||
2
test/fixtures/files/structure.sql.erb
vendored
Normal file
2
test/fixtures/files/structure.sql.erb
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
<%= "This was dynamically expanded" %>
|
||||||
|
<%= ENV["MYSQL_ROOT_HOST"] %>
|
||||||
@@ -2,8 +2,15 @@ require "bundler/setup"
|
|||||||
require "active_support/test_case"
|
require "active_support/test_case"
|
||||||
require "active_support/testing/autorun"
|
require "active_support/testing/autorun"
|
||||||
require "debug"
|
require "debug"
|
||||||
|
require "sshkit"
|
||||||
|
|
||||||
ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
|
ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
|
||||||
|
|
||||||
|
SSHKit.config.backend = SSHKit::Backend::Printer
|
||||||
|
|
||||||
class ActiveSupport::TestCase
|
class ActiveSupport::TestCase
|
||||||
|
private
|
||||||
|
def stdouted
|
||||||
|
capture(:stdout) { yield }.strip
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
Reference in New Issue
Block a user