Compare commits
303 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0c03216fdf | ||
|
|
1973f55c58 | ||
|
|
0a51cd0899 | ||
|
|
4b0a8728f1 | ||
|
|
3075f8daf1 | ||
|
|
9985834bd6 | ||
|
|
94b4461c76 | ||
|
|
7afa9e0815 | ||
|
|
933ece35ab | ||
|
|
2f80b300f0 | ||
|
|
2e06bf59a4 | ||
|
|
854795c2b6 | ||
|
|
4fe7fb705a | ||
|
|
270e0d0e2c | ||
|
|
6ddc9cf017 | ||
|
|
2dcd76b2de | ||
|
|
a6eabd0b67 | ||
|
|
fb9357b5ba | ||
|
|
d484cfcc31 | ||
|
|
5c93642f2a | ||
|
|
8ff206ba7e | ||
|
|
e36a5e111c | ||
|
|
72522001e5 | ||
|
|
50c4bb83cb | ||
|
|
b2875ad056 | ||
|
|
8ec94f105c | ||
|
|
90f4212a68 | ||
|
|
648894f9a9 | ||
|
|
dc68639dfa | ||
|
|
244cf8b3b7 | ||
|
|
f25f506d77 | ||
|
|
c29a177a7a | ||
|
|
03328a998c | ||
|
|
ec5fad5bea | ||
|
|
c671acf68f | ||
|
|
4f2cb5e184 | ||
|
|
63a065237a | ||
|
|
0f4e1888d9 | ||
|
|
d4d3308c34 | ||
|
|
b9c6d2966b | ||
|
|
f371cda8d8 | ||
|
|
9eaf0f3b8f | ||
|
|
a80289d046 | ||
|
|
aae45afb1b | ||
|
|
f4157c95c4 | ||
|
|
bb5176673b | ||
|
|
e9cb5b64b3 | ||
|
|
0433619518 | ||
|
|
110bf44a3b | ||
|
|
fbdf39a733 | ||
|
|
f99ff47f75 | ||
|
|
bb18189b01 | ||
|
|
18bdb33de2 | ||
|
|
1ec016ecad | ||
|
|
bd61e04088 | ||
|
|
0da2a6408b | ||
|
|
9697a9a6e0 | ||
|
|
32d52b024c | ||
|
|
2fe01f13df | ||
|
|
554a3558ab | ||
|
|
9aa57dd0c7 | ||
|
|
cb9f57356e | ||
|
|
02a5726072 | ||
|
|
e865e823d5 | ||
|
|
10cad5c459 | ||
|
|
ebcb297582 | ||
|
|
0a293ae4d6 | ||
|
|
bdff11e1fc | ||
|
|
9cfb6fb0a9 | ||
|
|
9ec6f9d74f | ||
|
|
45207f0c4f | ||
|
|
cf9a402ad8 | ||
|
|
64a5a790a7 | ||
|
|
78d4e1e1e9 | ||
|
|
74c7a6d5de | ||
|
|
340929e7e7 | ||
|
|
6f1a3f5524 | ||
|
|
7077da5a64 | ||
|
|
77c63dcd04 | ||
|
|
e7ac73be5a | ||
|
|
dfca9d8c48 | ||
|
|
6032d5651a | ||
|
|
539752e9bd | ||
|
|
94b28a1b29 | ||
|
|
5911914e95 | ||
|
|
3daecf696a | ||
|
|
497c57e3e5 | ||
|
|
8a42fd2f30 | ||
|
|
2182cfb5c7 | ||
|
|
5c9a602d76 | ||
|
|
b964e04f93 | ||
|
|
1fb2c71f65 | ||
|
|
58417f610f | ||
|
|
5856a77a53 | ||
|
|
5ed3ea9d26 | ||
|
|
59199cc69a | ||
|
|
c453b947e0 | ||
|
|
87e54d41e4 | ||
|
|
64b91daab1 | ||
|
|
13e22f8a34 | ||
|
|
8848335fbc | ||
|
|
a3fe8856c9 | ||
|
|
d263b0ffa5 | ||
|
|
3c1053fedd | ||
|
|
a3d998508b | ||
|
|
3d71ecdf80 | ||
|
|
37e216f2b7 | ||
|
|
17e75ec2c9 | ||
|
|
7621784235 | ||
|
|
687b8c9def | ||
|
|
13d4eb4017 | ||
|
|
78f0be9c76 | ||
|
|
839a0df40e | ||
|
|
74c493def4 | ||
|
|
7d95472543 | ||
|
|
71681cb8be | ||
|
|
1fef6ba505 | ||
|
|
22bbedf298 | ||
|
|
15a213eec6 | ||
|
|
67f9ffe961 | ||
|
|
25e52d6c93 | ||
|
|
2023c377ab | ||
|
|
3bd2559c03 | ||
|
|
ad26bce5a2 | ||
|
|
aed7425b42 | ||
|
|
fadb73da39 | ||
|
|
8024949fe7 | ||
|
|
004c154abb | ||
|
|
35b42cc885 | ||
|
|
6d80005f5d | ||
|
|
c8f673ef7c | ||
|
|
212d5ec783 | ||
|
|
f88685a525 | ||
|
|
08908c3925 | ||
|
|
48a9f599b8 | ||
|
|
7cc64299c8 | ||
|
|
7494f08978 | ||
|
|
2b232b41ce | ||
|
|
c28065fd42 | ||
|
|
80b90ab689 | ||
|
|
d71950f5e4 | ||
|
|
00d194e3f3 | ||
|
|
3f44e25b63 | ||
|
|
4c8b1a3e04 | ||
|
|
f06d639583 | ||
|
|
cdd77445d0 | ||
|
|
71f8f164ca | ||
|
|
1840f667d3 | ||
|
|
00afd5c6fc | ||
|
|
e17a7e28cb | ||
|
|
88b5e52b9f | ||
|
|
bc0ae84eb1 | ||
|
|
cb6fdbefc8 | ||
|
|
5bf3c36001 | ||
|
|
afb7b43f1a | ||
|
|
4f57976efe | ||
|
|
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 |
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
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,2 +1,4 @@
|
|||||||
.byebug_history
|
.byebug_history
|
||||||
*.gem
|
*.gem
|
||||||
|
coverage/*
|
||||||
|
.DS_Store
|
||||||
1
Gemfile
1
Gemfile
@@ -4,4 +4,5 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
|||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
gem "debug"
|
gem "debug"
|
||||||
|
gem "mocha"
|
||||||
gem "railties"
|
gem "railties"
|
||||||
|
|||||||
10
Gemfile.lock
10
Gemfile.lock
@@ -1,10 +1,12 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
mrsk (0.1.0)
|
mrsk (0.7.1)
|
||||||
activesupport (>= 7.0)
|
activesupport (>= 7.0)
|
||||||
|
dotenv (~> 2.8)
|
||||||
sshkit (~> 1.21)
|
sshkit (~> 1.21)
|
||||||
thor (~> 1.2)
|
thor (~> 1.2)
|
||||||
|
zeitwerk (~> 2.5)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
@@ -33,6 +35,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)
|
||||||
@@ -44,6 +47,8 @@ GEM
|
|||||||
nokogiri (>= 1.5.9)
|
nokogiri (>= 1.5.9)
|
||||||
method_source (1.0.0)
|
method_source (1.0.0)
|
||||||
minitest (5.17.0)
|
minitest (5.17.0)
|
||||||
|
mocha (2.0.2)
|
||||||
|
ruby2_keywords (>= 0.0.5)
|
||||||
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)
|
||||||
@@ -72,6 +77,7 @@ GEM
|
|||||||
rake (13.0.6)
|
rake (13.0.6)
|
||||||
reline (0.3.2)
|
reline (0.3.2)
|
||||||
io-console (~> 0.5)
|
io-console (~> 0.5)
|
||||||
|
ruby2_keywords (0.0.5)
|
||||||
sshkit (1.21.3)
|
sshkit (1.21.3)
|
||||||
net-scp (>= 1.1.2)
|
net-scp (>= 1.1.2)
|
||||||
net-ssh (>= 2.8.0)
|
net-ssh (>= 2.8.0)
|
||||||
@@ -86,10 +92,12 @@ PLATFORMS
|
|||||||
arm64-darwin-22
|
arm64-darwin-22
|
||||||
x86_64-darwin-20
|
x86_64-darwin-20
|
||||||
x86_64-darwin-21
|
x86_64-darwin-21
|
||||||
|
x86_64-darwin-22
|
||||||
x86_64-linux
|
x86_64-linux
|
||||||
|
|
||||||
DEPENDENCIES
|
DEPENDENCIES
|
||||||
debug
|
debug
|
||||||
|
mocha
|
||||||
mrsk!
|
mrsk!
|
||||||
railties
|
railties
|
||||||
|
|
||||||
|
|||||||
365
README.md
365
README.md
@@ -1,10 +1,10 @@
|
|||||||
# MRSK
|
# MRSK
|
||||||
|
|
||||||
MRSK deploys Rails apps in containers to servers running Docker with zero downtime. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is stopped. It works seamlessly across multiple hosts, using SSHKit to execute commands.
|
MRSK deploys web apps in containers to servers running Docker with zero downtime. It uses the dynamic reverse-proxy Traefik to hold requests while the new application container is started and the old one is stopped. It works seamlessly across multiple hosts, using SSHKit to execute commands. It was built for Rails applications, but works with any type of web app that can be bundled with Docker.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install MRSK globally with `gem install mrsk`. Then, inside your app directory, run `mrsk install`. Now edit the new file `config/deploy.yml`. It could look as simple as this:
|
Install MRSK globally with `gem install mrsk`. Then, inside your app directory, run `mrsk init` (or `mrsk init --bundle` within Rails apps where you want a bin/mrsk binstub). Now edit the new file `config/deploy.yml`. It could look as simple as this:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service: hey
|
service: hey
|
||||||
@@ -14,10 +14,15 @@ servers:
|
|||||||
- 192.168.0.2
|
- 192.168.0.2
|
||||||
registry:
|
registry:
|
||||||
username: registry-user-name
|
username: registry-user-name
|
||||||
password: <%= ENV["MRSK_REGISTRY_PASSWORD"] %>
|
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
||||||
|
env:
|
||||||
|
secret:
|
||||||
|
- RAILS_MASTER_KEY
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you're ready to deploy a multi-arch image to the servers:
|
Then edit your `.env` file to add your registry password as `MRSK_REGISTRY_PASSWORD` (and your `RAILS_MASTER_KEY` for production with a Rails app).
|
||||||
|
|
||||||
|
Now you're ready to deploy to the servers:
|
||||||
|
|
||||||
```
|
```
|
||||||
mrsk deploy
|
mrsk deploy
|
||||||
@@ -25,42 +30,88 @@ mrsk deploy
|
|||||||
|
|
||||||
This will:
|
This will:
|
||||||
|
|
||||||
1. Install Docker on any server that might be missing it (using apt-get)
|
1. Connect to the servers over SSH (using root by default, authenticated by your loaded ssh key)
|
||||||
2. Log into the registry both locally and remotely
|
2. Install Docker on any server that might be missing it (using apt-get)
|
||||||
3. Build the image using the standard Dockerfile in the root of the application.
|
3. Log into the registry both locally and remotely
|
||||||
4. Push the image to the registry.
|
4. Build the image using the standard Dockerfile in the root of the application.
|
||||||
5. Pull the image from the registry on the servers.
|
5. Push the image to the registry.
|
||||||
6. Ensure Traefik is running and accepting traffic on port 80.
|
6. Pull the image from the registry on the servers.
|
||||||
7. Stop any containers running a previous versions of the app.
|
7. Ensure Traefik is running and accepting traffic on port 80.
|
||||||
8. Start a new container with the version of the app that matches the current git version hash.
|
8. Ensure your app responds with `200 OK` to `GET /up`.
|
||||||
9. Prune unused images and stopped containers to ensure servers don't fill up.
|
9. Stop any containers running a previous versions of the app.
|
||||||
|
10. Start a new container with the version of the app that matches the current git version hash.
|
||||||
|
11. Prune unused images and stopped containers to ensure servers don't fill up.
|
||||||
|
|
||||||
Voila! All the servers are now serving the app on port 80. If you're just running a single server, you're ready to go. If you're running multiple servers, you need to put a load balancer in front of them.
|
Voila! All the servers are now serving the app on port 80. If you're just running a single server, you're ready to go. If you're running multiple servers, you need to put a load balancer in front of them.
|
||||||
|
|
||||||
|
## Vision
|
||||||
|
|
||||||
|
In the past decade+, there's been an explosion in commercial offerings that make deploying web apps easier. Heroku kicked it off with an incredible offering that stayed ahead of the competition seemingly forever. These days we have excellent alternatives like Fly.io and Render. And hosted Kubernetes is making things easier too on AWS, GCP, Digital Ocean, and elsewhere. But these are all offerings that have you renting computers in the cloud at a premium. If you want to run on our own hardware, or even just have a clear migration path to do so, you need to carefully consider how locked in you get to these commercial platforms. Preferably before the bills swallow your business whole!
|
||||||
|
|
||||||
|
MRSK seeks to bring the advance in ergonomics pioneered by these commercial offerings to deploying web apps anywhere. Whether that's low-cost cloud options without the managed-service markup from the likes of Digital Ocean, Hetzner, OVH, etc, or it's your own colocated metal. To MRSK, it's all the same. Feed the config file a list of IP addresses with vanilla Ubuntu servers that have seen no prep beyond an added SSH key, and you'll be running in literally minutes.
|
||||||
|
|
||||||
|
This structure also gives you enormous portability. You can have your web app deployed on several clouds at ease like this. Or you can buy the baseline with your own hardware, then deploy to a cloud before a big seasonal spike to get more capacity. When you're not locked into a single provider from a tooling perspective, there's a lot of compelling options available.
|
||||||
|
|
||||||
|
Ultimately, MRSK is meant to compress the complexity of going to production using open source tooling that isn't tied to any commercial offering. Not to zero, though. You're probably still better off with a fully managed service if basic Linux or Docker is still difficult, but from an early stage when those concepts are familiar.
|
||||||
|
|
||||||
|
## Why not just run Capistrano, Kubernetes or Docker Swarm?
|
||||||
|
|
||||||
|
MRSK basically is Capistrano for Containers, which allow us to use vanilla servers as the hosts. No need to ensure that the servers have just the right version of Ruby or other dependencies you need. That all lives in the Docker image now. You can boot a brand new Ubuntu (or whatever) server, add it to the deploy servers of MRSK, and it'll be auto-provisioned with Docker, and run right away. Docker's layer caching also allows for quicker deployments with less mucking about on the server. And the images built for MRSK can be used for CI or later introspection.
|
||||||
|
|
||||||
|
Kubernetes is a beast. Running it yourself on your own hardware is not for the faint of heart. It's a fine option if you want to run on someone else's platform, either transparently [like Render](https://thenewstack.io/render-cloud-deployment-with-less-engineering/) or explicitly on AWS/GCP, but if you'd like the freedom to move between cloud and your own hardware, or even mix the two, MRSK is much simpler. You can see everything that's going on, it's just basic Docker commands being called.
|
||||||
|
|
||||||
|
Docker Swarm is much simpler than Kubernetes, but it's still built on the same declarative model that uses state reconciliation. MRSK is intentionally designed to around imperative commands, like Capistrano.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
### 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: registry-user-name
|
username: registry-user-name
|
||||||
password: <%= ENV["MRSK_REGISTRY_PASSWORD"] %>
|
password: <%= ENV.fetch("MRSK_REGISTRY_PASSWORD") %>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Using a different SSH user than root
|
### Using a different SSH user than root
|
||||||
|
|
||||||
The default SSH user is root, but you can change it using `ssh_user`:
|
The default SSH user is root, but you can change it using `ssh/user`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
ssh_user: app
|
ssh:
|
||||||
|
user: app
|
||||||
```
|
```
|
||||||
|
|
||||||
### Adding custom env variables
|
### Using a proxy SSH host
|
||||||
|
|
||||||
You can inject custom env variables into the app containers using `env`:
|
If you need to connect to server through a proxy host, you can use `ssh/proxy`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ssh:
|
||||||
|
proxy: "192.168.0.1" # defaults to root as the user
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with specific user:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ssh:
|
||||||
|
proxy: "app@192.168.0.1"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using env variables
|
||||||
|
|
||||||
|
You can inject env variables into the app containers using `env`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
env:
|
env:
|
||||||
@@ -68,9 +119,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:
|
||||||
@@ -84,23 +164,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 escaped backticks are needed to ensure the rule is passed in correctly and not treated as command substitution by Bash!
|
||||||
|
|
||||||
This allows you to run multiple applications on the same server sharing the same Traefik instance and port.
|
This allows you to run multiple applications on the same server sharing the same Traefik instance and port.
|
||||||
See https://doc.traefik.io/traefik/routing/routers/#rule for a full list of available routing rules.
|
See https://doc.traefik.io/traefik/routing/routers/#rule for a full list of available routing rules.
|
||||||
|
|
||||||
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:
|
||||||
@@ -113,60 +205,205 @@ 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 `mrsk build create`. If you wish to remove the contexts and buildx instances again, you can run `mrsk build remove`. If you had already built using the standard emulation setup, run `mrsk build remove` before doing `mrsk build remote`.
|
### 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:
|
||||||
|
|
||||||
|
```dockerfile
|
||||||
|
# Copy Gemfiles
|
||||||
|
COPY Gemfile Gemfile.lock ./
|
||||||
|
|
||||||
|
# Install dependencies, including private repositories via access token (then remove bundle cache with exposed GITHUB_TOKEN)
|
||||||
|
RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||||
|
BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||||
|
bundle install && \
|
||||||
|
rm -rf /usr/local/bundle/cache
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using command arguments for Traefik
|
||||||
|
|
||||||
|
You can customize the traefik command line:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
traefik:
|
||||||
|
args:
|
||||||
|
accesslog: true
|
||||||
|
accesslog.format: json
|
||||||
|
```
|
||||||
|
|
||||||
|
This will start the traefik container with `--accesslog=true accesslog.format=json`.
|
||||||
|
|
||||||
|
### 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 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.
|
||||||
|
|
||||||
|
### Using a generated .env file
|
||||||
|
|
||||||
|
If you're using a centralized secret store, like 1Password, you can create `.env.erb` as a template which looks up the secrets. Example of a .env.erb file:
|
||||||
|
|
||||||
|
```erb
|
||||||
|
<% if (session_token = `op signin --account my-one-password-account --raw`.strip) != "" %># Generated by mrsk envify
|
||||||
|
GITHUB_TOKEN=<%= `gh config get -h github.com oauth_token`.strip %>
|
||||||
|
MRSK_REGISTRY_PASSWORD=<%= `op read "op://Vault/Docker Hub/password" -n --session #{session_token}` %>
|
||||||
|
RAILS_MASTER_KEY=<%= `op read "op://Vault/My App/RAILS_MASTER_SECRET" -n --session #{session_token}` %>
|
||||||
|
MYSQL_ROOT_PASSWORD=<%= `op read "op://Vault/My App/MYSQL_ROOT_PASSWORD" -n --session #{session_token}` %>
|
||||||
|
<% else raise ArgumentError, "Session token missing" end %>
|
||||||
|
```
|
||||||
|
|
||||||
|
This template can safely be checked into git. Then everyone deploying the app can run `mrsk envify` when they setup the app for the first time or passwords change to get the correct `.env` file.
|
||||||
|
|
||||||
|
If you need separate env variables for different destinations, you can set them with `.env.destination.erb` for the template, which will generate `.env.staging` when run with `mrsk envify -d staging`.
|
||||||
|
|
||||||
|
### Using audit broadcasts
|
||||||
|
|
||||||
|
If you'd like to broadcast audits of deploys, rollbacks, etc to a chatroom or elsewhere, you can configure the `audit_broadcast_cmd` setting with the path to a bin file that reads the audit line from STDIN, and then does whatever with it:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
audit_broadcast_cmd:
|
||||||
|
bin/audit_broadcast
|
||||||
|
```
|
||||||
|
|
||||||
|
The broadcast command could look something like:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
read
|
||||||
|
curl -q -d content="[My app] ${REPLY}" https://3.basecamp.com/XXXXX/integrations/XXXXX/buckets/XXXXX/chats/XXXXX/lines
|
||||||
|
```
|
||||||
|
|
||||||
|
That'll post a line like follows to a preconfigured chatbot in Basecamp:
|
||||||
|
|
||||||
|
```
|
||||||
|
[My App] [2023-02-18 11:29:52] [dhh] Rolled back to version d264c4e92470ad1bd18590f04466787262f605de
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using custom healthcheck path or port
|
||||||
|
|
||||||
|
MRSK defaults to checking the health of your application again `/up` on port 3000. You can tailor both with the `healthcheck` setting:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
healthcheck:
|
||||||
|
path: /healthz
|
||||||
|
port: 4000
|
||||||
|
```
|
||||||
|
|
||||||
|
This will ensure your application is configured with a traefik label for the healthcheck against `/healthz` and that the pre-deploy healthcheck that MRSK performs is done against the same path on port 4000.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### Remote execution
|
### Running commands on servers
|
||||||
|
|
||||||
If you need to execute commands inside the Rails containers, you can use `mrsk app exec`, `mrsk app exec --once`, `mrsk app runner`, and `mrsk app runner --once`. Examples:
|
You can execute one-off commands on the servers:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Runs command on all servers
|
# Runs command on all servers
|
||||||
mrsk app exec '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
|
||||||
mrsk app exec --once '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
|
||||||
mrsk app exec 'bin/rails 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]
|
||||||
@@ -178,7 +415,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]
|
||||||
@@ -190,50 +427,62 @@ Environment production
|
|||||||
Database adapter sqlite3
|
Database adapter sqlite3
|
||||||
Database schema version 20221231233303
|
Database schema version 20221231233303
|
||||||
|
|
||||||
# Runs Rails runner on first server
|
# Run Rails runner on primary server
|
||||||
mrsk app runner 'puts Rails.application.config.time_zone'
|
mrsk app exec -p 'bin/rails runner "puts Rails.application.config.time_zone"'
|
||||||
UTC
|
UTC
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running a Rails console on the primary host
|
### Running interactive commands over SSH
|
||||||
|
|
||||||
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.
|
You can run interactive commands, like a Rails console or a bash session, on a server (default is primary, use `--hosts` to connect to another):
|
||||||
|
|
||||||
### Inspecting
|
```bash
|
||||||
|
# Starts a bash session in a new container made from the most recent app image
|
||||||
|
mrsk app exec -i bash
|
||||||
|
|
||||||
You can see the state of your servers by running `mrsk details`. It'll show something like this:
|
# Starts a bash session in the currently running container for the app
|
||||||
|
mrsk app exec -i --reuse bash
|
||||||
|
|
||||||
|
# Starts a Rails console in a new container made from the most recent app image
|
||||||
|
mrsk app exec -i 'bin/rails console'
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Running details to see state of containers
|
||||||
|
|
||||||
|
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 `mrsk app details` or just for Traefik with `mrsk traefik details`.
|
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 `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:
|
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
|
||||||
@@ -243,7 +492,7 @@ From the example above, we can see that `e5d9d7c2b898289dfbc5f7f1334140d984eedae
|
|||||||
|
|
||||||
Note that by default old containers are pruned after 3 days when you run `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 `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.
|
||||||
|
|
||||||
|
|||||||
15
bin/mrsk
15
bin/mrsk
@@ -1,5 +1,16 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env ruby
|
||||||
|
|
||||||
require "mrsk/cli"
|
# Prevent failures from being reported twice.
|
||||||
|
Thread.report_on_exception = false
|
||||||
|
|
||||||
Mrsk::Cli::Main.start(ARGV)
|
require "mrsk"
|
||||||
|
|
||||||
|
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
|
||||||
|
|||||||
@@ -1,5 +1,9 @@
|
|||||||
module Mrsk
|
module Mrsk
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/version"
|
require "zeitwerk"
|
||||||
require "mrsk/commander"
|
|
||||||
|
loader = Zeitwerk::Loader.for_gem
|
||||||
|
loader.ignore("#{__dir__}/mrsk/sshkit_with_ext.rb")
|
||||||
|
loader.setup
|
||||||
|
loader.eager_load # We need all commands loaded.
|
||||||
|
|||||||
@@ -1,9 +1,5 @@
|
|||||||
require "mrsk"
|
|
||||||
|
|
||||||
MRSK = Mrsk::Commander.new \
|
|
||||||
config_file: Pathname.new(File.expand_path("config/deploy.yml"))
|
|
||||||
|
|
||||||
module Mrsk::Cli
|
module Mrsk::Cli
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/cli/main"
|
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||||
|
MRSK = Mrsk::Commander.new
|
||||||
|
|||||||
211
lib/mrsk/cli/accessory.rb
Normal file
211
lib/mrsk/cli/accessory.rb
Normal file
@@ -0,0 +1,211 @@
|
|||||||
|
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) do
|
||||||
|
execute *MRSK.auditor.record("Booted #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.run
|
||||||
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Booted accessory #{name}"
|
||||||
|
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) do
|
||||||
|
execute *MRSK.auditor.record("Started #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.start
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "stop [NAME]", "Stop accessory on host"
|
||||||
|
def stop(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
||||||
|
execute *accessory.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
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 servers"
|
||||||
|
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||||
|
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||||
|
def exec(name, cmd)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
case
|
||||||
|
when options[:interactive] && options[:reuse]
|
||||||
|
say "Launching interactive command with via SSH from existing container...", :magenta
|
||||||
|
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
||||||
|
|
||||||
|
when options[:interactive]
|
||||||
|
say "Launching interactive command via SSH from new container...", :magenta
|
||||||
|
run_locally { exec accessory.execute_in_new_container_over_ssh(cmd) }
|
||||||
|
|
||||||
|
when options[:reuse]
|
||||||
|
say "Launching command from existing container...", :magenta
|
||||||
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
|
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||||
|
end
|
||||||
|
|
||||||
|
else
|
||||||
|
say "Launching command from new container...", :magenta
|
||||||
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
|
capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
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) do
|
||||||
|
execute *MRSK.auditor.record("Remove #{name} accessory container"), verbosity: :debug
|
||||||
|
execute *accessory.remove_container
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_image [NAME]", "Remove accessory image from host"
|
||||||
|
def remove_image(name)
|
||||||
|
with_accessory(name) do |accessory|
|
||||||
|
on(accessory.host) do
|
||||||
|
execute *MRSK.auditor.record("Removed #{name} accessory image"), verbosity: :debug
|
||||||
|
execute *accessory.remove_image
|
||||||
|
end
|
||||||
|
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) do
|
||||||
|
execute *accessory.remove_service_directory
|
||||||
|
end
|
||||||
|
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
|
||||||
@@ -1,97 +1,195 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::App < Mrsk::Cli::Base
|
class Mrsk::Cli::App < Mrsk::Cli::Base
|
||||||
desc "boot", "Boot app on servers (or start them if they've already been booted)"
|
desc "boot", "Boot app on servers (or reboot app if already running)"
|
||||||
def boot
|
def boot
|
||||||
MRSK.config.roles.each do |role|
|
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||||
on(role.hosts) do |host|
|
using_version(options[:version] || most_recent_version_available) do |version|
|
||||||
begin
|
say "Start container with version #{version} (or reboot if already running)...", :magenta
|
||||||
execute *MRSK.app.run(role: role.name)
|
|
||||||
rescue SSHKit::Command::Failed => e
|
MRSK.config.roles.each do |role|
|
||||||
if e.message =~ /already in use/
|
on(role.hosts) do |host|
|
||||||
error "Container with same version already deployed on #{host}, starting that instead"
|
execute *MRSK.auditor.record("Booted app version #{version}"), verbosity: :debug
|
||||||
execute *MRSK.app.start, host: host
|
|
||||||
else
|
begin
|
||||||
raise
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
|
execute *MRSK.app.run(role: role.name)
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /already in use/
|
||||||
|
error "Rebooting container with same version already deployed on #{host}"
|
||||||
|
execute *MRSK.auditor.record("Rebooted app version #{version}"), verbosity: :debug
|
||||||
|
|
||||||
|
execute *MRSK.app.remove_container(version: version)
|
||||||
|
execute *MRSK.app.run(role: role.name)
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
|
desc "start", "Start existing app on servers (use --version=<git-hash> to designate specific version)"
|
||||||
option :version, desc: "Defaults to the most recent git-hash in local repository"
|
|
||||||
def start
|
def start
|
||||||
if (version = options[:version]).present?
|
on(MRSK.hosts) do
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.start(version: version) }
|
execute *MRSK.auditor.record("Started app version #{MRSK.version}"), verbosity: :debug
|
||||||
else
|
execute *MRSK.app.start, raise_on_non_zero_exit: false
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.start, raise_on_non_zero_exit: false }
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "stop", "Stop app on servers"
|
desc "stop", "Stop app on servers"
|
||||||
def stop
|
def stop
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.stop, raise_on_non_zero_exit: false }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Stopped app"), verbosity: :debug
|
||||||
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "details", "Display details about app containers"
|
desc "details", "Display details about app containers"
|
||||||
def details
|
def details
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.info, verbosity: Logger::INFO) + "\n\n" }
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.info) }
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "exec [CMD]", "Execute a custom task on servers passed in as CMD='bin/rake some:task'"
|
desc "exec [CMD]", "Execute a custom command on servers"
|
||||||
option :once, type: :boolean, default: false
|
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||||
|
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||||
def exec(cmd)
|
def exec(cmd)
|
||||||
if options[:once]
|
case
|
||||||
on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec(cmd), verbosity: Logger::INFO) }
|
when options[:interactive] && options[:reuse]
|
||||||
else
|
say "Get current version of running container...", :magenta unless options[:version]
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec(cmd), verbosity: Logger::INFO) + "\n\n" }
|
using_version(options[:version] || current_running_version) do |version|
|
||||||
end
|
say "Launching interactive command with version #{version} via SSH from existing container on #{MRSK.primary_host}...", :magenta
|
||||||
end
|
run_locally { exec MRSK.app.execute_in_existing_container_over_ssh(cmd, host: MRSK.primary_host) }
|
||||||
|
end
|
||||||
desc "console", "Start Rails Console on primary host"
|
|
||||||
option :host, desc: "Start console on a different host"
|
|
||||||
def console
|
|
||||||
host = options[:host] || MRSK.config.primary_host
|
|
||||||
|
|
||||||
run_locally do
|
when options[:interactive]
|
||||||
puts "Launching Rails console on #{host}..."
|
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||||
exec MRSK.app.console(host: host)
|
using_version(options[:version] || most_recent_version_available) do |version|
|
||||||
end
|
say "Launching interactive command with version #{version} via SSH from new container on #{MRSK.primary_host}...", :magenta
|
||||||
end
|
run_locally { exec MRSK.app.execute_in_new_container_over_ssh(cmd, host: MRSK.primary_host) }
|
||||||
|
end
|
||||||
|
|
||||||
|
when options[:reuse]
|
||||||
|
say "Get current version of running container...", :magenta unless options[:version]
|
||||||
|
using_version(options[:version] || current_running_version) do |version|
|
||||||
|
say "Launching command with version #{version} from existing container...", :magenta
|
||||||
|
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.app.execute_in_existing_container(cmd))
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
desc "runner [EXPRESSION]", "Execute Rails runner with given expression"
|
|
||||||
option :once, type: :boolean, default: false, desc:
|
|
||||||
def runner(expression)
|
|
||||||
if options[:once]
|
|
||||||
on(MRSK.config.primary_host) { puts capture(*MRSK.app.exec("bin/rails", "runner", "'#{expression}'"), verbosity: Logger::INFO) }
|
|
||||||
else
|
else
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.exec("bin/rails", "runner", "'#{expression}'"), verbosity: Logger::INFO) + "\n\n" }
|
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||||
|
using_version(options[:version] || most_recent_version_available) do |version|
|
||||||
|
say "Launching command with version #{version} from new container...", :magenta
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
execute *MRSK.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.app.execute_in_new_container(cmd))
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "containers", "List all the app containers currently on servers"
|
desc "containers", "List all the app containers currently on servers"
|
||||||
def containers
|
def containers
|
||||||
on(MRSK.config.hosts) { |host| puts "App Host: #{host}\n" + capture(*MRSK.app.list_containers, verbosity: Logger::INFO) + "\n\n" }
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_containers) }
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "logs", "Show last 100 log lines from app on servers"
|
desc "images", "List all the app images currently on servers"
|
||||||
|
def images
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.list_images) }
|
||||||
|
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
|
def logs
|
||||||
# FIXME: Catch when app containers aren't running
|
# 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
|
grep = options[:grep]
|
||||||
|
|
||||||
desc "remove", "Remove app containers and images from servers"
|
if options[:follow]
|
||||||
option :only, default: "", desc: "Use 'containers' or 'images'"
|
run_locally do
|
||||||
def remove
|
info "Following logs on #{MRSK.primary_host}..."
|
||||||
case options[:only]
|
info MRSK.app.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
when "containers"
|
exec MRSK.app.follow_logs(host: MRSK.primary_host, grep: grep)
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
|
end
|
||||||
when "images"
|
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
|
|
||||||
else
|
else
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_containers }
|
since = options[:since]
|
||||||
on(MRSK.config.hosts) { execute *MRSK.app.remove_images }
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "remove", "Remove app containers and images from servers"
|
||||||
|
def remove
|
||||||
|
remove_containers
|
||||||
|
remove_images
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container [VERSION]", "Remove app container with given version from servers"
|
||||||
|
def remove_container(version)
|
||||||
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed app container with version #{version}"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_container(version: version)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_containers", "Remove all app containers from servers"
|
||||||
|
def remove_containers
|
||||||
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed all app containers"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_containers
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_images", "Remove all app images from servers"
|
||||||
|
def remove_images
|
||||||
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed all app images"), verbosity: :debug
|
||||||
|
execute *MRSK.app.remove_images
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "current_version", "Shows the version currently running"
|
||||||
|
def current_version
|
||||||
|
on(MRSK.hosts) { |host| puts_by_host host, capture_with_info(*MRSK.app.current_running_version).strip }
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def using_version(new_version)
|
||||||
|
if new_version
|
||||||
|
begin
|
||||||
|
old_version = MRSK.config.version
|
||||||
|
MRSK.config.version = new_version
|
||||||
|
yield new_version
|
||||||
|
ensure
|
||||||
|
MRSK.config.version = old_version
|
||||||
|
end
|
||||||
|
else
|
||||||
|
yield MRSK.config.version
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def most_recent_version_available(host: MRSK.primary_host)
|
||||||
|
version = nil
|
||||||
|
on(host) { version = capture_with_info(*MRSK.app.most_recent_version_from_available_images).strip }
|
||||||
|
version.presence
|
||||||
|
end
|
||||||
|
|
||||||
|
def current_running_version(host: MRSK.primary_host)
|
||||||
|
version = nil
|
||||||
|
on(host) { version = capture_with_info(*MRSK.app.current_running_version).strip }
|
||||||
|
version.presence
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
require "thor"
|
require "thor"
|
||||||
require "sshkit"
|
require "dotenv"
|
||||||
require "sshkit/dsl"
|
require "mrsk/sshkit_with_ext"
|
||||||
|
|
||||||
module Mrsk::Cli
|
module Mrsk::Cli
|
||||||
class Base < Thor
|
class Base < Thor
|
||||||
@@ -9,19 +9,64 @@ module Mrsk::Cli
|
|||||||
def self.exit_on_failure?() true end
|
def self.exit_on_failure?() true end
|
||||||
|
|
||||||
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
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(*)
|
def initialize(*)
|
||||||
super
|
super
|
||||||
MRSK.verbose = options[:verbose]
|
load_envs
|
||||||
|
initialize_commander(options)
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def load_envs
|
||||||
|
if destination = options[:destination]
|
||||||
|
Dotenv.load(".env.#{destination}", ".env")
|
||||||
|
else
|
||||||
|
Dotenv.load(".env")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def initialize_commander(options)
|
||||||
|
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
|
def print_runtime
|
||||||
started_at = Time.now
|
started_at = Time.now
|
||||||
yield
|
yield
|
||||||
|
return Time.now - started_at
|
||||||
ensure
|
ensure
|
||||||
runtime = Time.now - started_at
|
runtime = Time.now - started_at
|
||||||
puts " Finished all in #{sprintf("%.1f seconds", runtime)}"
|
puts " Finished all in #{sprintf("%.1f seconds", runtime)}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def audit_broadcast(line)
|
||||||
|
run_locally { execute *MRSK.auditor.broadcast(line), verbosity: :debug }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Build < Mrsk::Cli::Base
|
class Mrsk::Cli::Build < Mrsk::Cli::Base
|
||||||
desc "deliver", "Deliver a newly built app image to servers"
|
desc "deliver", "Deliver a newly built app image to servers"
|
||||||
def deliver
|
def deliver
|
||||||
@@ -9,29 +7,47 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "push", "Build locally and push app image to registry"
|
desc "push", "Build locally and push app image to registry"
|
||||||
def push
|
def push
|
||||||
run_locally do
|
cli = self
|
||||||
|
|
||||||
|
run_locally do
|
||||||
begin
|
begin
|
||||||
debug "Using builder: #{MRSK.builder.name}"
|
MRSK.with_verbosity(:debug) { execute *MRSK.builder.push }
|
||||||
info "Building image may take a while (run with --verbose for progress logging)"
|
|
||||||
execute *MRSK.builder.push
|
|
||||||
rescue SSHKit::Command::Failed => e
|
rescue SSHKit::Command::Failed => e
|
||||||
error "Missing compatible builder, so creating a new one first"
|
if e.message =~ /(no builder)|(no such file or directory)/
|
||||||
execute *MRSK.builder.create
|
error "Missing compatible builder, so creating a new one first"
|
||||||
execute *MRSK.builder.push
|
|
||||||
|
if cli.create
|
||||||
|
MRSK.with_verbosity(:debug) { execute *MRSK.builder.push }
|
||||||
|
end
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "pull", "Pull app image from the registry onto servers"
|
desc "pull", "Pull app image from the registry onto servers"
|
||||||
def pull
|
def pull
|
||||||
on(MRSK.config.hosts) { execute *MRSK.builder.pull }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pulled image with version #{MRSK.version}"), verbosity: :debug
|
||||||
|
execute *MRSK.builder.pull
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "create", "Create a local build setup"
|
desc "create", "Create a local build setup"
|
||||||
def create
|
def create
|
||||||
run_locally do
|
run_locally do
|
||||||
debug "Using builder: #{MRSK.builder.name}"
|
begin
|
||||||
execute *MRSK.builder.create
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -46,7 +62,7 @@ class Mrsk::Cli::Build < Mrsk::Cli::Base
|
|||||||
desc "details", "Show the name of the configured builder"
|
desc "details", "Show the name of the configured builder"
|
||||||
def details
|
def details
|
||||||
run_locally do
|
run_locally do
|
||||||
puts "Builder: #{MRSK.builder.name} (#{MRSK.builder.target.class.name})"
|
puts "Builder: #{MRSK.builder.name}"
|
||||||
puts capture(*MRSK.builder.info)
|
puts capture(*MRSK.builder.info)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
29
lib/mrsk/cli/healthcheck.rb
Normal file
29
lib/mrsk/cli/healthcheck.rb
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
class Mrsk::Cli::Healthcheck < Mrsk::Cli::Base
|
||||||
|
desc "perform", "Health check the current version of the app"
|
||||||
|
def perform
|
||||||
|
on(MRSK.primary_host) do
|
||||||
|
begin
|
||||||
|
execute *MRSK.healthcheck.run
|
||||||
|
|
||||||
|
target = "Health check against #{MRSK.config.healthcheck["path"]}"
|
||||||
|
|
||||||
|
if capture_with_info(*MRSK.healthcheck.curl) == "200"
|
||||||
|
info "#{target} succeeded with 200 OK!"
|
||||||
|
else
|
||||||
|
# Catches 1xx, 2xx, 3xx
|
||||||
|
raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
|
||||||
|
end
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
if e.message =~ /curl/
|
||||||
|
# Catches 4xx, 5xx
|
||||||
|
raise SSHKit::Command::Failed, "#{target} failed to return 200 OK!"
|
||||||
|
else
|
||||||
|
raise
|
||||||
|
end
|
||||||
|
ensure
|
||||||
|
execute *MRSK.healthcheck.stop, raise_on_non_zero_exit: false
|
||||||
|
execute *MRSK.healthcheck.remove, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,40 +1,70 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
require "mrsk/cli/app"
|
|
||||||
require "mrsk/cli/build"
|
|
||||||
require "mrsk/cli/prune"
|
|
||||||
require "mrsk/cli/registry"
|
|
||||||
require "mrsk/cli/server"
|
|
||||||
require "mrsk/cli/traefik"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Main < Mrsk::Cli::Base
|
class Mrsk::Cli::Main < Mrsk::Cli::Base
|
||||||
desc "deploy", "Deploy the app to servers"
|
desc "setup", "Setup all accessories and deploy the app to servers"
|
||||||
def deploy
|
def setup
|
||||||
print_runtime do
|
print_runtime do
|
||||||
invoke "mrsk:cli:server:bootstrap"
|
invoke "mrsk:cli:server:bootstrap"
|
||||||
|
invoke "mrsk:cli:accessory:boot", [ "all" ]
|
||||||
|
deploy
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "deploy", "Deploy the app to servers"
|
||||||
|
def deploy
|
||||||
|
runtime = print_runtime do
|
||||||
|
say "Ensure Docker is installed...", :magenta
|
||||||
|
invoke "mrsk:cli:server:bootstrap"
|
||||||
|
|
||||||
|
say "Log into image registry...", :magenta
|
||||||
invoke "mrsk:cli:registry:login"
|
invoke "mrsk:cli:registry:login"
|
||||||
|
|
||||||
|
say "Build and push app image...", :magenta
|
||||||
invoke "mrsk:cli:build:deliver"
|
invoke "mrsk:cli:build:deliver"
|
||||||
|
|
||||||
|
say "Ensure Traefik is running...", :magenta
|
||||||
invoke "mrsk:cli:traefik:boot"
|
invoke "mrsk:cli:traefik:boot"
|
||||||
invoke "mrsk:cli:app:stop"
|
|
||||||
|
say "Ensure app can pass healthcheck...", :magenta
|
||||||
|
invoke "mrsk:cli:healthcheck:perform"
|
||||||
|
|
||||||
invoke "mrsk:cli:app:boot"
|
invoke "mrsk:cli:app:boot"
|
||||||
|
|
||||||
|
say "Prune old containers and images...", :magenta
|
||||||
invoke "mrsk:cli:prune:all"
|
invoke "mrsk:cli:prune:all"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Deployed app in #{runtime.to_i} seconds"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
|
desc "redeploy", "Deploy new version of the app to servers (without bootstrapping servers, starting Traefik, pruning, and registry login)"
|
||||||
def redeploy
|
def redeploy
|
||||||
print_runtime do
|
runtime = print_runtime do
|
||||||
|
say "Build and push app image...", :magenta
|
||||||
invoke "mrsk:cli:build:deliver"
|
invoke "mrsk:cli:build:deliver"
|
||||||
invoke "mrsk:cli:app:stop"
|
|
||||||
|
say "Ensure app can pass healthcheck...", :magenta
|
||||||
|
invoke "mrsk:cli:healthcheck:perform"
|
||||||
|
|
||||||
invoke "mrsk:cli:app:boot"
|
invoke "mrsk:cli:app:boot"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Redeployed app in #{runtime.to_i} seconds"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "rollback [VERSION]", "Rollback the app to VERSION (that must already be on servers)"
|
desc "rollback [VERSION]", "Rollback the app to VERSION"
|
||||||
def rollback(version)
|
def rollback(version)
|
||||||
on(MRSK.config.hosts) do
|
MRSK.version = version
|
||||||
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
|
||||||
execute *MRSK.app.start(version: version)
|
if container_name_available?(MRSK.config.service_with_version)
|
||||||
|
say "Stop current version, then start version #{version}...", :magenta
|
||||||
|
|
||||||
|
on(MRSK.hosts) do |host|
|
||||||
|
execute *MRSK.app.stop, raise_on_non_zero_exit: false
|
||||||
|
execute *MRSK.app.start
|
||||||
|
end
|
||||||
|
|
||||||
|
audit_broadcast "Rolled back app to version #{version}"
|
||||||
|
else
|
||||||
|
say "The app version '#{version}' is not available as a container (use 'mrsk app containers' for available versions)", :red
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -42,24 +72,46 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
def details
|
def details
|
||||||
invoke "mrsk:cli:traefik:details"
|
invoke "mrsk:cli:traefik:details"
|
||||||
invoke "mrsk:cli:app:details"
|
invoke "mrsk:cli:app:details"
|
||||||
|
invoke "mrsk:cli:accessory:details", [ "all" ]
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "install", "Create config stub in config/deploy.yml and binstub in bin/mrsk"
|
desc "audit", "Show audit log from servers"
|
||||||
option :skip_binstub, type: :boolean, default: false, desc: "Skip adding MRSK to the Gemfile and creating bin/mrsk binstub"
|
def audit
|
||||||
def install
|
on(MRSK.hosts) do |host|
|
||||||
|
puts_by_host host, capture_with_info(*MRSK.auditor.reveal)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "config", "Show combined config"
|
||||||
|
def config
|
||||||
|
run_locally do
|
||||||
|
puts MRSK.config.to_h.to_yaml
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "init", "Create config stub in config/deploy.yml and env stub in .env"
|
||||||
|
option :bundle, type: :boolean, default: false, desc: "Add MRSK to the Gemfile and create a bin/mrsk binstub"
|
||||||
|
def init
|
||||||
require "fileutils"
|
require "fileutils"
|
||||||
|
|
||||||
if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
|
if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
|
||||||
puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
|
puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
|
||||||
else
|
else
|
||||||
|
FileUtils.mkdir_p deploy_file.dirname
|
||||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
|
||||||
puts "Created configuration file in config/deploy.yml"
|
puts "Created configuration file in config/deploy.yml"
|
||||||
end
|
end
|
||||||
|
|
||||||
unless options[:skip_binstub]
|
unless (deploy_file = Pathname.new(File.expand_path(".env"))).exist?
|
||||||
|
FileUtils.cp_r Pathname.new(File.expand_path("templates/template.env", __dir__)), deploy_file
|
||||||
|
puts "Created .env file"
|
||||||
|
end
|
||||||
|
|
||||||
|
if options[:bundle]
|
||||||
if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
|
if (binstub = Pathname.new(File.expand_path("bin/mrsk"))).exist?
|
||||||
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
puts "Binstub already exists in bin/mrsk (remove first to create a new one)"
|
||||||
else
|
else
|
||||||
|
puts "Adding MRSK to Gemfile and bundle..."
|
||||||
`bundle add mrsk`
|
`bundle add mrsk`
|
||||||
`bundle binstubs mrsk`
|
`bundle binstubs mrsk`
|
||||||
puts "Created binstub file in bin/mrsk"
|
puts "Created binstub file in bin/mrsk"
|
||||||
@@ -67,6 +119,19 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "envify", "Create .env by evaluating .env.erb (or .env.staging.erb -> .env.staging when using -d staging)"
|
||||||
|
def envify
|
||||||
|
if destination = options[:destination]
|
||||||
|
env_template_path = ".env.#{destination}.erb"
|
||||||
|
env_path = ".env.#{destination}"
|
||||||
|
else
|
||||||
|
env_template_path = ".env.erb"
|
||||||
|
env_path = ".env"
|
||||||
|
end
|
||||||
|
|
||||||
|
File.write(env_path, ERB.new(File.read(env_template_path)).result, perm: 0600)
|
||||||
|
end
|
||||||
|
|
||||||
desc "remove", "Remove Traefik, app, and registry session from servers"
|
desc "remove", "Remove Traefik, app, and registry session from servers"
|
||||||
def remove
|
def remove
|
||||||
invoke "mrsk:cli:traefik:remove"
|
invoke "mrsk:cli:traefik:remove"
|
||||||
@@ -79,12 +144,18 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
puts Mrsk::VERSION
|
puts Mrsk::VERSION
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "accessory", "Manage the accessories"
|
||||||
|
subcommand "accessory", Mrsk::Cli::Accessory
|
||||||
|
|
||||||
desc "app", "Manage the application"
|
desc "app", "Manage the application"
|
||||||
subcommand "app", Mrsk::Cli::App
|
subcommand "app", Mrsk::Cli::App
|
||||||
|
|
||||||
desc "build", "Build the application image"
|
desc "build", "Build the application image"
|
||||||
subcommand "build", Mrsk::Cli::Build
|
subcommand "build", Mrsk::Cli::Build
|
||||||
|
|
||||||
|
desc "healthcheck", "Healthcheck the application"
|
||||||
|
subcommand "healthcheck", Mrsk::Cli::Healthcheck
|
||||||
|
|
||||||
desc "prune", "Prune old application images and containers"
|
desc "prune", "Prune old application images and containers"
|
||||||
subcommand "prune", Mrsk::Cli::Prune
|
subcommand "prune", Mrsk::Cli::Prune
|
||||||
|
|
||||||
@@ -96,4 +167,11 @@ class Mrsk::Cli::Main < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "traefik", "Manage the Traefik load balancer"
|
desc "traefik", "Manage the Traefik load balancer"
|
||||||
subcommand "traefik", Mrsk::Cli::Traefik
|
subcommand "traefik", Mrsk::Cli::Traefik
|
||||||
|
|
||||||
|
private
|
||||||
|
def container_name_available?(container_name, host: MRSK.primary_host)
|
||||||
|
container_names = nil
|
||||||
|
on(host) { container_names = capture_with_info(*MRSK.app.list_container_names).split("\n") }
|
||||||
|
Array(container_names).include?(container_name)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
||||||
desc "all", "Prune unused images and stopped containers"
|
desc "all", "Prune unused images and stopped containers"
|
||||||
def all
|
def all
|
||||||
@@ -7,13 +5,19 @@ class Mrsk::Cli::Prune < Mrsk::Cli::Base
|
|||||||
invoke :images
|
invoke :images
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "images", "Prune unused images older than 30 days"
|
desc "images", "Prune unused images older than 7 days"
|
||||||
def images
|
def images
|
||||||
on(MRSK.config.hosts) { execute *MRSK.prune.images }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pruned images"), verbosity: :debug
|
||||||
|
execute *MRSK.prune.images
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "containers", "Prune stopped containers for the service older than 3 days"
|
desc "containers", "Prune stopped containers for the service older than 3 days"
|
||||||
def containers
|
def containers
|
||||||
on(MRSK.config.hosts) { execute *MRSK.prune.containers }
|
on(MRSK.hosts) do
|
||||||
|
execute *MRSK.auditor.record("Pruned containers"), verbosity: :debug
|
||||||
|
execute *MRSK.prune.containers
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Registry < Mrsk::Cli::Base
|
class Mrsk::Cli::Registry < Mrsk::Cli::Base
|
||||||
desc "login", "Login to the registry locally and remotely"
|
desc "login", "Login to the registry locally and remotely"
|
||||||
def login
|
def login
|
||||||
run_locally { execute *MRSK.registry.login }
|
run_locally { execute *MRSK.registry.login }
|
||||||
on(MRSK.config.hosts) { execute *MRSK.registry.login }
|
on(MRSK.hosts) { execute *MRSK.registry.login }
|
||||||
|
rescue ArgumentError => e
|
||||||
|
puts e.message
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "logout", "Logout of the registry remotely"
|
desc "logout", "Logout of the registry remotely"
|
||||||
def logout
|
def logout
|
||||||
on(MRSK.config.hosts) { execute *MRSK.registry.logout }
|
on(MRSK.hosts) { execute *MRSK.registry.logout }
|
||||||
|
rescue ArgumentError => e
|
||||||
|
puts e.message
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Server < Mrsk::Cli::Base
|
class Mrsk::Cli::Server < Mrsk::Cli::Base
|
||||||
desc "bootstrap", "Ensure Docker is installed on the servers"
|
desc "bootstrap", "Ensure Docker is installed on the servers"
|
||||||
def bootstrap
|
def bootstrap
|
||||||
on(MRSK.config.hosts) { execute "which docker || apt-get install docker.io -y" }
|
on(MRSK.hosts + MRSK.accessory_hosts) { execute "which docker || (apt-get update -y && apt-get install docker.io -y)" }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
2
lib/mrsk/cli/templates/template.env
Normal file
2
lib/mrsk/cli/templates/template.env
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
MRSK_REGISTRY_PASSWORD=change-this
|
||||||
|
RAILS_MASTER_KEY=another-env
|
||||||
@@ -1,19 +1,30 @@
|
|||||||
require "mrsk/cli/base"
|
|
||||||
|
|
||||||
class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
||||||
desc "boot", "Boot Traefik on servers"
|
desc "boot", "Boot Traefik on servers"
|
||||||
def boot
|
def boot
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.run, raise_on_non_zero_exit: false }
|
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
|
end
|
||||||
|
|
||||||
desc "start", "Start existing Traefik on servers"
|
desc "start", "Start existing Traefik on servers"
|
||||||
def start
|
def start
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.start, raise_on_non_zero_exit: false }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Started traefik"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.start, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "stop", "Stop Traefik on servers"
|
desc "stop", "Stop Traefik on servers"
|
||||||
def stop
|
def stop
|
||||||
on(MRSK.config.role(:web).hosts) { execute *MRSK.traefik.stop, raise_on_non_zero_exit: false }
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Stopped traefik"), verbosity: :debug
|
||||||
|
execute *MRSK.traefik.stop, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "restart", "Restart Traefik on servers"
|
desc "restart", "Restart Traefik on servers"
|
||||||
@@ -24,20 +35,52 @@ class Mrsk::Cli::Traefik < Mrsk::Cli::Base
|
|||||||
|
|
||||||
desc "details", "Display details about Traefik containers from servers"
|
desc "details", "Display details about Traefik containers from servers"
|
||||||
def details
|
def details
|
||||||
on(MRSK.config.role(:web).hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.info, verbosity: Logger::INFO) + "\n\n" }
|
on(MRSK.traefik_hosts) { |host| puts_by_host host, capture_with_info(*MRSK.traefik.info), type: "Traefik" }
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "logs", "Show last 100 log lines from Traefik on servers"
|
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
|
def logs
|
||||||
on(MRSK.config.hosts) { |host| puts "Traefik Host: #{host}\n" + capture(*MRSK.traefik.logs) + "\n\n" }
|
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
|
end
|
||||||
|
|
||||||
desc "remove", "Remove Traefik container and image from servers"
|
desc "remove", "Remove Traefik container and image from servers"
|
||||||
def remove
|
def remove
|
||||||
invoke :stop
|
invoke :stop
|
||||||
|
invoke :remove_container
|
||||||
|
invoke :remove_image
|
||||||
|
end
|
||||||
|
|
||||||
on(MRSK.config.role(:web).hosts) do
|
desc "remove_container", "Remove Traefik container from servers"
|
||||||
|
def remove_container
|
||||||
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed traefik container"), verbosity: :debug
|
||||||
execute *MRSK.traefik.remove_container
|
execute *MRSK.traefik.remove_container
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
desc "remove_container", "Remove Traefik image from servers"
|
||||||
|
def remove_image
|
||||||
|
on(MRSK.traefik_hosts) do
|
||||||
|
execute *MRSK.auditor.record("Removed traefik image"), verbosity: :debug
|
||||||
execute *MRSK.traefik.remove_image
|
execute *MRSK.traefik.remove_image
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,20 +1,47 @@
|
|||||||
require "mrsk/configuration"
|
require "active_support/core_ext/enumerable"
|
||||||
require "mrsk/commands/app"
|
|
||||||
require "mrsk/commands/builder"
|
|
||||||
require "mrsk/commands/prune"
|
|
||||||
require "mrsk/commands/traefik"
|
|
||||||
require "mrsk/commands/registry"
|
|
||||||
|
|
||||||
class Mrsk::Commander
|
class Mrsk::Commander
|
||||||
attr_reader :config
|
attr_accessor :config_file, :destination, :verbosity, :version
|
||||||
attr_accessor :verbose
|
|
||||||
|
|
||||||
def initialize(config_file:)
|
def initialize(config_file: nil, destination: nil, verbosity: :info)
|
||||||
@config_file = config_file
|
@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
|
||||||
|
|
||||||
|
|
||||||
@@ -38,20 +65,55 @@ 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 auditor
|
||||||
old_level = SSHKit.config.output_verbosity
|
@auditor ||= Mrsk::Commands::Auditor.new(config)
|
||||||
|
end
|
||||||
|
|
||||||
|
def healthcheck
|
||||||
|
@healthcheck ||= Mrsk::Commands::Healthcheck.new(config)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def with_verbosity(level)
|
||||||
|
old_level = self.verbosity
|
||||||
|
|
||||||
|
self.verbosity = level
|
||||||
SSHKit.config.output_verbosity = level
|
SSHKit.config.output_verbosity = level
|
||||||
|
|
||||||
yield
|
yield
|
||||||
ensure
|
ensure
|
||||||
|
self.verbosity = old_level
|
||||||
SSHKit.config.output_verbosity = old_level
|
SSHKit.config.output_verbosity = old_level
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Test-induced damage!
|
||||||
|
def reset
|
||||||
|
@config = @config_file = @destination = @version = nil
|
||||||
|
@app = @builder = @traefik = @registry = @prune = @auditor = nil
|
||||||
|
@verbosity = :info
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def cascading_version
|
||||||
|
version.presence || ENV["VERSION"] || current_commit_hash
|
||||||
|
end
|
||||||
|
|
||||||
|
def current_commit_hash
|
||||||
|
if system("git rev-parse")
|
||||||
|
`git rev-parse HEAD`.strip
|
||||||
|
else
|
||||||
|
raise "Can't use commit hash as version, no git repository found in #{Dir.pwd}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# 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
|
||||||
|
|||||||
110
lib/mrsk/commands/accessory.rb
Normal file
110
lib/mrsk/commands/accessory.rb
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
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",
|
||||||
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
|
"-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)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def execute_in_existing_container(*command, interactive: false)
|
||||||
|
docker :exec,
|
||||||
|
("-it" if interactive),
|
||||||
|
service_name,
|
||||||
|
*command
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_in_new_container(*command, interactive: false)
|
||||||
|
docker :run,
|
||||||
|
("-it" if interactive),
|
||||||
|
"--rm",
|
||||||
|
*env_args,
|
||||||
|
*volume_args,
|
||||||
|
image,
|
||||||
|
*command
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_in_existing_container_over_ssh(*command)
|
||||||
|
run_over_ssh execute_in_existing_container(*command, interactive: true)
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_in_new_container_over_ssh(*command)
|
||||||
|
run_over_ssh execute_in_new_container(*command, interactive: true)
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_over_ssh(command)
|
||||||
|
super command, host: host
|
||||||
|
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
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::App < Mrsk::Commands::Base
|
class Mrsk::Commands::App < Mrsk::Commands::Base
|
||||||
def run(role: :web)
|
def run(role: :web)
|
||||||
role = config.role(role)
|
role = config.role(role)
|
||||||
@@ -7,56 +5,133 @@ class Mrsk::Commands::App < Mrsk::Commands::Base
|
|||||||
docker :run,
|
docker :run,
|
||||||
"-d",
|
"-d",
|
||||||
"--restart unless-stopped",
|
"--restart unless-stopped",
|
||||||
"--name", config.service_with_version,
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
"-e", redact("RAILS_MASTER_KEY=#{config.master_key}"),
|
"--name", service_with_version,
|
||||||
*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(version: config.version)
|
def start
|
||||||
docker :start, "#{config.service}-#{version}"
|
docker :start, service_with_version
|
||||||
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
|
|
||||||
[ "docker ps -q #{service_filter.join(" ")} | xargs docker logs -n 100 -t" ]
|
def logs(since: nil, lines: nil, grep: nil)
|
||||||
|
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 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)
|
||||||
|
),
|
||||||
|
host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def execute_in_existing_container(*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(host: config.primary_host)
|
def execute_in_new_container(*command, interactive: false)
|
||||||
"ssh -t #{config.ssh_user}@#{host} '#{exec("bin/rails", "c", interactive: true).join(" ")}'"
|
docker :run,
|
||||||
|
("-it" if interactive),
|
||||||
|
"--rm",
|
||||||
|
*config.env_args,
|
||||||
|
*config.volume_args,
|
||||||
|
config.absolute_image,
|
||||||
|
*command
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def execute_in_existing_container_over_ssh(*command, host:)
|
||||||
|
run_over_ssh execute_in_existing_container(*command, interactive: true), host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
def execute_in_new_container_over_ssh(*command, host:)
|
||||||
|
run_over_ssh execute_in_new_container(*command, interactive: true), host: host
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def current_container_id
|
||||||
|
docker :ps, "-q", *service_filter
|
||||||
|
end
|
||||||
|
|
||||||
|
def current_running_version
|
||||||
|
# FIXME: Find more graceful way to extract the version from "app-version" than using sed and tail!
|
||||||
|
pipe \
|
||||||
|
docker(:ps, "--filter", "label=service=#{config.service}", "--format", '"{{.Names}}"'),
|
||||||
|
%(sed 's/-/\\n/g'),
|
||||||
|
"tail -n 1"
|
||||||
|
end
|
||||||
|
|
||||||
|
def most_recent_version_from_available_images
|
||||||
|
pipe \
|
||||||
|
docker(:image, :ls, "--format", '"{{.Tag}}"', config.repository),
|
||||||
|
"head -n 1"
|
||||||
|
end
|
||||||
|
|
||||||
|
def all_versions_from_available_containers
|
||||||
|
pipe \
|
||||||
|
docker(:image, :ls, "--format", '"{{.Tag}}"', config.repository),
|
||||||
|
"head -n 1"
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
def list_containers
|
def list_containers
|
||||||
docker :container, :ls, "-a", *service_filter
|
docker :container, :ls, "-a", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def list_container_names
|
||||||
|
[ *list_containers, "--format", "'{{ .Names }}'" ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_container(version:)
|
||||||
|
pipe \
|
||||||
|
container_id_for(container_name: service_with_version(version)),
|
||||||
|
xargs(docker(:container, :rm))
|
||||||
|
end
|
||||||
|
|
||||||
def remove_containers
|
def remove_containers
|
||||||
docker :container, :prune, "-f", *service_filter
|
docker :container, :prune, "-f", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def list_images
|
||||||
|
docker :image, :ls, config.repository
|
||||||
|
end
|
||||||
|
|
||||||
def remove_images
|
def remove_images
|
||||||
docker :image, :prune, "-a", "-f", *service_filter
|
docker :image, :prune, "-a", "-f", *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
def service_with_version(version = nil)
|
||||||
|
if version
|
||||||
|
"#{config.service}-#{version}"
|
||||||
|
else
|
||||||
|
config.service_with_version
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def service_filter
|
def service_filter
|
||||||
[ "--filter", "label=service=#{config.service}" ]
|
[ "--filter", "label=service=#{config.service}" ]
|
||||||
end
|
end
|
||||||
|
|||||||
44
lib/mrsk/commands/auditor.rb
Normal file
44
lib/mrsk/commands/auditor.rb
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
require "active_support/core_ext/time/conversions"
|
||||||
|
|
||||||
|
class Mrsk::Commands::Auditor < Mrsk::Commands::Base
|
||||||
|
# Runs remotely
|
||||||
|
def record(line)
|
||||||
|
append \
|
||||||
|
[ :echo, tagged_record_line(line) ],
|
||||||
|
audit_log_file
|
||||||
|
end
|
||||||
|
|
||||||
|
# Runs locally
|
||||||
|
def broadcast(line)
|
||||||
|
if broadcast_cmd = config.audit_broadcast_cmd
|
||||||
|
pipe \
|
||||||
|
[ :echo, tagged_broadcast_line(line) ],
|
||||||
|
broadcast_cmd
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def reveal
|
||||||
|
[ :tail, "-n", 50, audit_log_file ]
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def audit_log_file
|
||||||
|
"mrsk-#{config.service}-audit.log"
|
||||||
|
end
|
||||||
|
|
||||||
|
def tagged_record_line(line)
|
||||||
|
"'#{recorded_at_tag} #{performer_tag} #{line}'"
|
||||||
|
end
|
||||||
|
|
||||||
|
def tagged_broadcast_line(line)
|
||||||
|
"'#{performer_tag} #{line}'"
|
||||||
|
end
|
||||||
|
|
||||||
|
def performer_tag
|
||||||
|
"[#{`whoami`.strip}]"
|
||||||
|
end
|
||||||
|
|
||||||
|
def recorded_at_tag
|
||||||
|
"[#{Time.now.to_fs(:db)}]"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,27 +1,52 @@
|
|||||||
require "sshkit"
|
|
||||||
|
|
||||||
module Mrsk::Commands
|
module Mrsk::Commands
|
||||||
class Base
|
class Base
|
||||||
|
delegate :redact, to: Mrsk::Utils
|
||||||
|
|
||||||
|
MAX_LOG_SIZE = "10m"
|
||||||
|
|
||||||
attr_accessor :config
|
attr_accessor :config
|
||||||
|
|
||||||
def initialize(config)
|
def initialize(config)
|
||||||
@config = config
|
@config = config
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def run_over_ssh(*command, host:)
|
||||||
|
"ssh".tap do |cmd|
|
||||||
|
cmd << " -J #{config.ssh_proxy.jump_proxies}" if config.ssh_proxy
|
||||||
|
cmd << " -t #{config.ssh_user}@#{host} '#{command.join(" ")}'"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def container_id_for(container_name:)
|
||||||
|
docker :container, :ls, "-a", "-f", "name=#{container_name}", "-q"
|
||||||
|
end
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
|
def append(*commands)
|
||||||
|
combine *commands, by: ">>"
|
||||||
|
end
|
||||||
|
|
||||||
|
def xargs(command)
|
||||||
|
[ :xargs, command ].flatten
|
||||||
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
|
||||||
|
|||||||
@@ -1,23 +1,20 @@
|
|||||||
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 +22,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
|
||||||
@@ -33,7 +34,3 @@ class Mrsk::Commands::Builder < Mrsk::Commands::Base
|
|||||||
@multiarch_remote ||= Mrsk::Commands::Builder::Multiarch::Remote.new(config)
|
@multiarch_remote ||= Mrsk::Commands::Builder::Multiarch::Remote.new(config)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
require "mrsk/commands/builder/native"
|
|
||||||
require "mrsk/commands/builder/multiarch"
|
|
||||||
require "mrsk/commands/builder/multiarch/remote"
|
|
||||||
|
|||||||
36
lib/mrsk/commands/builder/base.rb
Normal file
36
lib/mrsk/commands/builder/base.rb
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
class Mrsk::Commands::Builder::Base < Mrsk::Commands::Base
|
||||||
|
delegate :argumentize, to: Mrsk::Utils
|
||||||
|
|
||||||
|
def pull
|
||||||
|
docker :pull, config.absolute_image
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_options
|
||||||
|
[ *build_tags, *build_labels, *build_args, *build_secrets ]
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def build_tags
|
||||||
|
[ "-t", config.absolute_image, "-t", config.latest_image ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_labels
|
||||||
|
argumentize "--label", { service: config.service }
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_args
|
||||||
|
argumentize "--build-arg", args, redacted: true
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_secrets
|
||||||
|
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
||||||
|
end
|
||||||
|
|
||||||
|
def args
|
||||||
|
(config.builder && config.builder["args"]) || {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def secrets
|
||||||
|
(config.builder && config.builder["secrets"]) || []
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,6 +1,4 @@
|
|||||||
require "mrsk/commands/base"
|
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Builder::Base
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
|
|
||||||
def create
|
def create
|
||||||
docker :buildx, :create, "--use", "--name", builder_name
|
docker :buildx, :create, "--use", "--name", builder_name
|
||||||
end
|
end
|
||||||
@@ -10,11 +8,12 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
|
|||||||
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
|
*build_options,
|
||||||
|
"."
|
||||||
end
|
end
|
||||||
|
|
||||||
def info
|
def info
|
||||||
@@ -25,6 +24,6 @@ class Mrsk::Commands::Builder::Multiarch < Mrsk::Commands::Base
|
|||||||
|
|
||||||
private
|
private
|
||||||
def builder_name
|
def builder_name
|
||||||
"mrsk-#{config.service}"
|
"mrsk-#{config.service}-multiarch"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/builder/multiarch"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Multiarch
|
class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Multiarch
|
||||||
def create
|
def create
|
||||||
combine \
|
combine \
|
||||||
@@ -15,8 +13,16 @@ 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", builder_name, builder_name_with_arch(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
|
||||||
@@ -50,9 +56,4 @@ class Mrsk::Commands::Builder::Multiarch::Remote < Mrsk::Commands::Builder::Mult
|
|||||||
def remote
|
def remote
|
||||||
config.builder["remote"]
|
config.builder["remote"]
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
|
||||||
def builder_name_with_arch(arch)
|
|
||||||
"#{builder_name}-#{arch}"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,6 +1,4 @@
|
|||||||
require "mrsk/commands/base"
|
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Builder::Base
|
||||||
|
|
||||||
class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
|
|
||||||
def create
|
def create
|
||||||
# No-op on native
|
# No-op on native
|
||||||
end
|
end
|
||||||
@@ -11,14 +9,10 @@ class Mrsk::Commands::Builder::Native < Mrsk::Commands::Base
|
|||||||
|
|
||||||
def push
|
def push
|
||||||
combine \
|
combine \
|
||||||
docker(:build, "-t", config.absolute_image, "."),
|
docker(:build, *build_options, "."),
|
||||||
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
|
||||||
|
|||||||
67
lib/mrsk/commands/builder/native/remote.rb
Normal file
67
lib/mrsk/commands/builder/native/remote.rb
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
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,
|
||||||
|
*build_options,
|
||||||
|
"."
|
||||||
|
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
|
||||||
46
lib/mrsk/commands/healthcheck.rb
Normal file
46
lib/mrsk/commands/healthcheck.rb
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
class Mrsk::Commands::Healthcheck < Mrsk::Commands::Base
|
||||||
|
EXPOSED_PORT = 3999
|
||||||
|
|
||||||
|
def run
|
||||||
|
web = config.role(:web)
|
||||||
|
|
||||||
|
docker :run,
|
||||||
|
"-d",
|
||||||
|
"--name", container_name_with_version,
|
||||||
|
"-p", "#{EXPOSED_PORT}:#{config.healthcheck["port"]}",
|
||||||
|
"--label", "service=#{container_name}",
|
||||||
|
*web.env_args,
|
||||||
|
*config.volume_args,
|
||||||
|
config.absolute_image,
|
||||||
|
web.cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
def curl
|
||||||
|
[ :curl, "--silent", "--output", "/dev/null", "--write-out", "'%{http_code}'", health_url ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def stop
|
||||||
|
pipe \
|
||||||
|
container_id_for(container_name: container_name),
|
||||||
|
xargs(docker(:stop))
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove
|
||||||
|
pipe \
|
||||||
|
container_id_for(container_name: container_name),
|
||||||
|
xargs(docker(:container, :rm))
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def container_name
|
||||||
|
"healthcheck-#{config.service}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def container_name_with_version
|
||||||
|
"healthcheck-#{config.service_with_version}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def health_url
|
||||||
|
"http://localhost:#{EXPOSED_PORT}#{config.healthcheck["path"]}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,17 +1,12 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
require "active_support/duration"
|
require "active_support/duration"
|
||||||
require "active_support/core_ext/numeric/time"
|
require "active_support/core_ext/numeric/time"
|
||||||
|
|
||||||
class Mrsk::Commands::Prune < Mrsk::Commands::Base
|
class Mrsk::Commands::Prune < Mrsk::Commands::Base
|
||||||
PRUNE_IMAGES_AFTER = 30.days.in_hours.to_i
|
def images(until_hours: 7.days.in_hours.to_i)
|
||||||
PRUNE_CONTAINERS_AFTER = 3.days.in_hours.to_i
|
docker :image, :prune, "--all", "--force", "--filter", "label=service=#{config.service}", "--filter", "until=#{until_hours}h"
|
||||||
|
|
||||||
def images
|
|
||||||
docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def containers
|
def containers(until_hours: 3.days.in_hours.to_i)
|
||||||
docker :image, :prune, "-f", "--filter", "until=#{PRUNE_IMAGES_AFTER}h"
|
docker :container, :prune, "--force", "--filter", "label=service=#{config.service}", "--filter", "until=#{until_hours}h"
|
||||||
docker :container, :prune, "-f", "--filter", "label=service=#{config.service}", "--filter", "'until=#{PRUNE_CONTAINERS_AFTER}h'"
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Registry < Mrsk::Commands::Base
|
class Mrsk::Commands::Registry < Mrsk::Commands::Base
|
||||||
delegate :registry, to: :config
|
delegate :registry, to: :config
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,15 @@
|
|||||||
require "mrsk/commands/base"
|
|
||||||
|
|
||||||
class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
class Mrsk::Commands::Traefik < Mrsk::Commands::Base
|
||||||
def run
|
def run
|
||||||
docker :run, "--name traefik",
|
docker :run, "--name traefik",
|
||||||
"-d",
|
"-d",
|
||||||
"--restart unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
|
"--log-opt", "max-size=#{MAX_LOG_SIZE}",
|
||||||
"-p 80:80",
|
"-p 80:80",
|
||||||
"-v /var/run/docker.sock:/var/run/docker.sock",
|
"-v /var/run/docker.sock:/var/run/docker.sock",
|
||||||
"traefik",
|
"traefik",
|
||||||
"--providers.docker"
|
"--providers.docker",
|
||||||
|
"--log.level=DEBUG",
|
||||||
|
*cmd_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def start
|
def start
|
||||||
@@ -23,8 +24,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 +44,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
|
||||||
|
|||||||
@@ -3,27 +3,44 @@ require "active_support/core_ext/string/inquiry"
|
|||||||
require "active_support/core_ext/module/delegation"
|
require "active_support/core_ext/module/delegation"
|
||||||
require "pathname"
|
require "pathname"
|
||||||
require "erb"
|
require "erb"
|
||||||
|
require "net/ssh/proxy/jump"
|
||||||
|
|
||||||
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 :version
|
||||||
|
attr_accessor :raw_config
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
def load_file(file)
|
def create_from(base_config_file, destination: nil, version: "missing")
|
||||||
if file.exist?
|
new(load_config_file(base_config_file).tap do |config|
|
||||||
new YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
|
if destination
|
||||||
else
|
config.deep_merge! \
|
||||||
raise "Configuration file not found in #{file}"
|
load_config_file destination_config_file(base_config_file, destination)
|
||||||
end
|
end
|
||||||
|
end, version: version)
|
||||||
end
|
end
|
||||||
|
|
||||||
def argumentize(argument, attributes)
|
private
|
||||||
attributes.flat_map { |k, v| [ argument, "#{k}=#{v}" ] }
|
def load_config_file(file)
|
||||||
end
|
if file.exist?
|
||||||
|
YAML.load(ERB.new(IO.read(file)).result).symbolize_keys
|
||||||
|
else
|
||||||
|
raise "Configuration file not found in #{file}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def destination_config_file(base_config_file, destination)
|
||||||
|
dir, basename = base_config_file.split
|
||||||
|
dir.join basename.to_s.remove(".yml") + ".#{destination}.yml"
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
@@ -35,84 +52,142 @@ 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::Accessory.new(name, config: self) } || []
|
||||||
case
|
|
||||||
when ENV["HOSTS"]
|
|
||||||
ENV["HOSTS"].split(",")
|
|
||||||
when ENV["ROLES"]
|
|
||||||
role_names = ENV["ROLES"].split(",")
|
|
||||||
roles.select { |r| role_names.include?(r.name) }.flat_map(&:hosts)
|
|
||||||
else
|
|
||||||
roles.flat_map(&:hosts)
|
|
||||||
end
|
|
||||||
|
|
||||||
if hosts.any?
|
|
||||||
hosts
|
|
||||||
else
|
|
||||||
raise ArgumentError, "No hosts found"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def primary_host
|
def accessory(name)
|
||||||
|
accessories.detect { |a| a.name == name.to_s }
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def all_hosts
|
||||||
|
roles.flat_map(&:hosts)
|
||||||
|
end
|
||||||
|
|
||||||
|
def primary_web_host
|
||||||
role(:web).hosts.first
|
role(:web).hosts.first
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def traefik_hosts
|
||||||
def version
|
roles.select(&:running_traefik?).flat_map(&:hosts)
|
||||||
@version ||= ENV["VERSION"] || `git rev-parse HEAD`.strip
|
|
||||||
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
|
||||||
"#{repository}:#{version}"
|
"#{repository}:#{version}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def latest_image
|
||||||
|
"#{repository}:latest"
|
||||||
|
end
|
||||||
|
|
||||||
def service_with_version
|
def service_with_version
|
||||||
"#{service}-#{version}"
|
"#{service}-#{version}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
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
|
else
|
||||||
[]
|
[]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def volume_args
|
||||||
|
if raw_config.volumes.present?
|
||||||
|
argumentize "--volume", raw_config.volumes
|
||||||
|
else
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
def ssh_user
|
def ssh_user
|
||||||
config.ssh_user || "root"
|
if raw_config.ssh.present?
|
||||||
|
raw_config.ssh["user"] || "root"
|
||||||
|
else
|
||||||
|
"root"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def ssh_proxy
|
||||||
|
if raw_config.ssh.present? && raw_config.ssh["proxy"]
|
||||||
|
Net::SSH::Proxy::Jump.new \
|
||||||
|
raw_config.ssh["proxy"].include?("@") ? raw_config.ssh["proxy"] : "root@#{raw_config.ssh["proxy"]}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def ssh_options
|
def ssh_options
|
||||||
{ user: ssh_user, auth_methods: [ "publickey" ] }
|
{ user: ssh_user, proxy: ssh_proxy, auth_methods: [ "publickey" ] }.compact
|
||||||
end
|
end
|
||||||
|
|
||||||
def master_key
|
|
||||||
ENV["RAILS_MASTER_KEY"] || File.read(Pathname.new(File.expand_path("config/master.key")))
|
def audit_broadcast_cmd
|
||||||
|
raw_config.audit_broadcast_cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
def healthcheck
|
||||||
|
{ "path" => "/up", "port" => 3000 }.merge(raw_config.healthcheck || {})
|
||||||
|
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,
|
||||||
|
healthcheck: healthcheck
|
||||||
|
}.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"
|
|
||||||
|
|||||||
123
lib/mrsk/configuration/accessory.rb
Normal file
123
lib/mrsk/configuration/accessory.rb
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
class Mrsk::Configuration::Accessory
|
||||||
|
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,13 +56,17 @@ class Mrsk::Configuration::Role
|
|||||||
end
|
end
|
||||||
|
|
||||||
def traefik_labels
|
def traefik_labels
|
||||||
{
|
if running_traefik?
|
||||||
"traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
|
{
|
||||||
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => "/up",
|
"traefik.http.routers.#{config.service}.rule" => "'PathPrefix(`/`)'",
|
||||||
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
|
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.path" => config.healthcheck["path"],
|
||||||
"traefik.http.middlewares.#{config.service}.retry.attempts" => "3",
|
"traefik.http.services.#{config.service}.loadbalancer.healthcheck.interval" => "1s",
|
||||||
"traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
|
"traefik.http.middlewares.#{config.service}.retry.attempts" => "3",
|
||||||
}
|
"traefik.http.middlewares.#{config.service}.retry.initialinterval" => "500ms"
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def custom_labels
|
def custom_labels
|
||||||
@@ -64,7 +80,28 @@ 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"])
|
||||||
|
|
||||||
|
# If there's no secret/clear split, everything is clear
|
||||||
|
clear_app_env = config.env["secret"] ? Array(config.env["clear"]) : Array(config.env["clear"] || config.env)
|
||||||
|
clear_role_env = specialized_env["secret"] ? Array(specialized_env["clear"]) : Array(specialized_env["clear"] || specialized_env)
|
||||||
|
|
||||||
|
new_env["clear"] = (clear_app_env + clear_role_env).uniq
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
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.1.0"
|
VERSION = "0.7.1"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
|
|||||||
spec.authors = [ "David Heinemeier Hansson" ]
|
spec.authors = [ "David Heinemeier Hansson" ]
|
||||||
spec.email = "dhh@hey.com"
|
spec.email = "dhh@hey.com"
|
||||||
spec.homepage = "https://github.com/rails/mrsk"
|
spec.homepage = "https://github.com/rails/mrsk"
|
||||||
spec.summary = "Deploy Rails apps in containers to servers running Docker with zero downtime."
|
spec.summary = "Deploy web apps in containers to servers running Docker with zero downtime."
|
||||||
spec.license = "MIT"
|
spec.license = "MIT"
|
||||||
|
|
||||||
spec.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
|
spec.files = Dir["lib/**/*", "MIT-LICENSE", "README.md"]
|
||||||
@@ -15,4 +15,6 @@ Gem::Specification.new do |spec|
|
|||||||
spec.add_dependency "activesupport", ">= 7.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 "thor", "~> 1.2"
|
||||||
|
spec.add_dependency "dotenv", "~> 2.8"
|
||||||
|
spec.add_dependency "zeitwerk", "~> 2.5"
|
||||||
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
|
|
||||||
38
test/cli/accessory_test.rb
Normal file
38
test/cli/accessory_test.rb
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
require_relative "cli_test_case"
|
||||||
|
|
||||||
|
class CliAccessoryTest < CliTestCase
|
||||||
|
test "upload" do
|
||||||
|
assert_match "test/fixtures/files/my.cnf app-mysql/etc/mysql/my.cnf", run_command("upload", "mysql")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "directories" do
|
||||||
|
assert_match "mkdir -p $PWD/app-mysql/data", run_command("directories", "mysql")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove service direcotry" do
|
||||||
|
assert_match "rm -rf app-mysql", run_command("remove_service_directory", "mysql")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot" do
|
||||||
|
assert_match "Running docker run --name app-mysql -d --restart unless-stopped --log-opt max-size=10m -p 3306:3306 -e [REDACTED] -e MYSQL_ROOT_HOST=% --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=app-mysql mysql:5.7 on 1.1.1.3", run_command("boot", "mysql")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec" do
|
||||||
|
run_command("exec", "mysql", "mysql -v").tap do |output|
|
||||||
|
assert_match /Launching command from new container/, output
|
||||||
|
assert_match /mysql -v/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec with reuse" do
|
||||||
|
run_command("exec", "mysql", "--reuse", "mysql -v").tap do |output|
|
||||||
|
assert_match /Launching command from existing container/, output
|
||||||
|
assert_match %r[docker exec app-mysql mysql -v], output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted { Mrsk::Cli::Accessory.start([*command, "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
end
|
||||||
|
end
|
||||||
67
test/cli/app_test.rb
Normal file
67
test/cli/app_test.rb
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
require_relative "cli_test_case"
|
||||||
|
|
||||||
|
class CliAppTest < CliTestCase
|
||||||
|
test "boot" do
|
||||||
|
assert_match /Running docker run -d --restart unless-stopped/, run_command("boot")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot will reboot if same version is already running" do
|
||||||
|
run_command("details") # Preheat MRSK const
|
||||||
|
|
||||||
|
# Prevent expected failures from outputting to terminal
|
||||||
|
Thread.report_on_exception = false
|
||||||
|
|
||||||
|
MRSK.app.stubs(:run).raises(SSHKit::Command::Failed.new("already in use")).then.returns([ :docker, :run ])
|
||||||
|
|
||||||
|
run_command("boot").tap do |output|
|
||||||
|
assert_match /Rebooting container with same version already deployed/, output # Can't start what's already running
|
||||||
|
assert_match /docker ps -q --filter label=service=app \| xargs docker stop/, output # Stop what's running
|
||||||
|
assert_match /docker container ls -a -f name=app-999 -q \| xargs docker container rm/, output # Remove old container
|
||||||
|
assert_match /docker run/, output # Start new container
|
||||||
|
end
|
||||||
|
ensure
|
||||||
|
Thread.report_on_exception = true
|
||||||
|
end
|
||||||
|
|
||||||
|
test "start" do
|
||||||
|
run_command("start").tap do |output|
|
||||||
|
assert_match /docker start app-999/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
run_command("stop").tap do |output|
|
||||||
|
assert_match /docker ps -q --filter label=service=app \| xargs docker stop/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "details" do
|
||||||
|
run_command("details").tap do |output|
|
||||||
|
assert_match /docker ps --filter label=service=app/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove_container" do
|
||||||
|
run_command("remove_container", "1234567").tap do |output|
|
||||||
|
assert_match /docker container ls -a -f name=app-1234567 -q \| xargs docker container rm/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec" do
|
||||||
|
run_command("exec", "ruby -v").tap do |output|
|
||||||
|
assert_match /ruby -v/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec with reuse" do
|
||||||
|
run_command("exec", "--reuse", "ruby -v").tap do |output|
|
||||||
|
assert_match %r[docker ps --filter label=service=app --format \"{{.Names}}\" | sed 's/-/\\n/g' | tail -n 1], output # Get current version
|
||||||
|
assert_match %r[docker exec app-999 ruby -v], output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted { Mrsk::Cli::App.start([*command, "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
end
|
||||||
|
end
|
||||||
24
test/cli/cli_test_case.rb
Normal file
24
test/cli/cli_test_case.rb
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
require "test_helper"
|
||||||
|
require "active_support/testing/stream"
|
||||||
|
|
||||||
|
class CliTestCase < ActiveSupport::TestCase
|
||||||
|
include ActiveSupport::Testing::Stream
|
||||||
|
|
||||||
|
setup do
|
||||||
|
ENV["VERSION"] = "999"
|
||||||
|
ENV["RAILS_MASTER_KEY"] = "123"
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = "secret123"
|
||||||
|
end
|
||||||
|
|
||||||
|
teardown do
|
||||||
|
ENV.delete("RAILS_MASTER_KEY")
|
||||||
|
ENV.delete("MYSQL_ROOT_PASSWORD")
|
||||||
|
ENV.delete("VERSION")
|
||||||
|
MRSK.reset
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def stdouted
|
||||||
|
capture(:stdout) { yield }.strip
|
||||||
|
end
|
||||||
|
end
|
||||||
33
test/cli/main_test.rb
Normal file
33
test/cli/main_test.rb
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
require_relative "cli_test_case"
|
||||||
|
|
||||||
|
class CliMainTest < CliTestCase
|
||||||
|
test "version" do
|
||||||
|
version = stdouted { Mrsk::Cli::Main.new.version }
|
||||||
|
assert_equal Mrsk::VERSION, version
|
||||||
|
end
|
||||||
|
|
||||||
|
test "rollback bad version" do
|
||||||
|
run_command("details") # Preheat MRSK const
|
||||||
|
|
||||||
|
run_command("rollback", "nonsense").tap do |output|
|
||||||
|
assert_match /docker container ls -a --filter label=service=app --format '{{ .Names }}'/, output
|
||||||
|
assert_match /The app version 'nonsense' is not available as a container/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "rollback good version" do
|
||||||
|
Mrsk::Cli::Main.any_instance.stubs(:container_name_available?).returns(true)
|
||||||
|
|
||||||
|
run_command("rollback", "123").tap do |output|
|
||||||
|
assert_match /Stop current version, then start version 123/, output
|
||||||
|
assert_match /docker ps -q --filter label=service=app | xargs docker stop/, output
|
||||||
|
assert_match /docker start app-123/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted { Mrsk::Cli::Main.start([*command, "-c", "test/fixtures/deploy_with_accessories.yml"]) }
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,12 +1,45 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
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 "commit hash as version" do
|
||||||
|
assert_equal `git rev-parse HEAD`.strip, @mrsk.config.version
|
||||||
|
end
|
||||||
|
|
||||||
|
test "commit hash as version but not in git" do
|
||||||
|
@mrsk.expects(:system).with("git rev-parse").returns(nil)
|
||||||
|
error = assert_raises(RuntimeError) { @mrsk.config }
|
||||||
|
assert_match /no git repository found/, error.message
|
||||||
|
end
|
||||||
|
|
||||||
|
test "overwriting hosts" do
|
||||||
|
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
|
||||||
|
|||||||
134
test/commands/accessory_test.rb
Normal file
134
test/commands/accessory_test.rb
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
ENV["MYSQL_ROOT_PASSWORD"] = "secret123"
|
||||||
|
end
|
||||||
|
|
||||||
|
teardown do
|
||||||
|
ENV.delete("MYSQL_ROOT_PASSWORD")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run --name app-mysql -d --restart unless-stopped --log-opt max-size=10m -p 3306:3306 -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% --label service=app-mysql mysql:8.0",
|
||||||
|
@mysql.run.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run --name app-redis -d --restart unless-stopped --log-opt max-size=10m -p 6379:6379 -e SOMETHING=else --volume /var/lib/redis:/data --label service=app-redis --label cache=true redis:latest",
|
||||||
|
@redis.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "start" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container start app-mysql",
|
||||||
|
@mysql.start.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container stop app-mysql",
|
||||||
|
@mysql.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "info" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app-mysql",
|
||||||
|
@mysql.info.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "execute in new container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run --rm -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% mysql:8.0 mysql -u root",
|
||||||
|
@mysql.execute_in_new_container("mysql", "-u", "root").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in existing container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker exec app-mysql mysql -u root",
|
||||||
|
@mysql.execute_in_existing_container("mysql", "-u", "root").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in new container over ssh" do
|
||||||
|
@mysql.stub(:run_over_ssh, ->(cmd) { cmd.join(" ") }) do
|
||||||
|
assert_match %r|docker run -it --rm -e MYSQL_ROOT_PASSWORD=secret123 -e MYSQL_ROOT_HOST=% mysql:8.0 mysql -u root|,
|
||||||
|
@mysql.execute_in_new_container_over_ssh("mysql", "-u", "root")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in existing container over ssh" do
|
||||||
|
@mysql.stub(:run_over_ssh, ->(cmd) { cmd.join(" ") }) do
|
||||||
|
assert_match %r|docker exec -it app-mysql mysql -u root|,
|
||||||
|
@mysql.execute_in_existing_container_over_ssh("mysql", "-u", "root")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
test "logs" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logs app-mysql -t 2>&1",
|
||||||
|
@mysql.logs.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker logs app-mysql --since 5m -n 100 -t 2>&1 | grep 'thing'",
|
||||||
|
@mysql.logs(since: "5m", lines: 100, grep: "thing").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
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.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove image" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image prune -a -f --filter label=service=app-mysql",
|
||||||
|
@mysql.remove_image.join(" ")
|
||||||
|
end
|
||||||
|
end
|
||||||
169
test/commands/app_test.rb
Normal file
169
test/commands/app_test.rb
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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" ], env: { "secret" => [ "RAILS_MASTER_KEY" ] } }
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config).tap { |c| c.version = "999" }
|
||||||
|
end
|
||||||
|
|
||||||
|
teardown do
|
||||||
|
ENV.delete("RAILS_MASTER_KEY")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/up --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with volumes" do
|
||||||
|
@config[:volumes] = ["/local/path:/container/path" ]
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --volume /local/path:/container/path --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/up --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with custom healthcheck path" do
|
||||||
|
@config[:healthcheck] = { "path" => "/healthz" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --restart unless-stopped --log-opt max-size=10m --name app-999 -e RAILS_MASTER_KEY=456 --label service=app --label role=web --label traefik.http.routers.app.rule='PathPrefix(`/`)' --label traefik.http.services.app.loadbalancer.healthcheck.path=/healthz --label traefik.http.services.app.loadbalancer.healthcheck.interval=1s --label traefik.http.middlewares.app.retry.attempts=3 --label traefik.http.middlewares.app.retry.initialinterval=500ms dhh/app:999",
|
||||||
|
@app.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "start" do
|
||||||
|
assert_equal \
|
||||||
|
"docker start app-999",
|
||||||
|
@app.start.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker stop",
|
||||||
|
@app.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "info" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app",
|
||||||
|
@app.info.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "logs" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs 2>&1",
|
||||||
|
@app.logs.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m 2>&1",
|
||||||
|
@app.logs(since: "5m").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -n 100 2>&1",
|
||||||
|
@app.logs(lines: "100").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m -n 100 2>&1",
|
||||||
|
@app.logs(since: "5m", lines: "100").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs 2>&1 | grep 'my-id'",
|
||||||
|
@app.logs(grep: "my-id").join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs --since 5m 2>&1 | grep 'my-id'",
|
||||||
|
@app.logs(since: "5m", grep: "my-id").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "follow logs" do
|
||||||
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -t -n 10 -f 2>&1",
|
||||||
|
@app.follow_logs(host: "app-1")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app | xargs docker logs -t -n 10 -f 2>&1 | grep \"Completed\"",
|
||||||
|
@app.follow_logs(host: "app-1", grep: "Completed")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "execute in new container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run --rm -e RAILS_MASTER_KEY=456 dhh/app:999 bin/rails db:setup",
|
||||||
|
@app.execute_in_new_container("bin/rails", "db:setup").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in existing container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker exec app-999 bin/rails db:setup",
|
||||||
|
@app.execute_in_existing_container("bin/rails", "db:setup").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in new container over ssh" do
|
||||||
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
|
assert_match %r|docker run -it --rm -e RAILS_MASTER_KEY=456 dhh/app:999 bin/rails c|,
|
||||||
|
@app.execute_in_new_container_over_ssh("bin/rails", "c", host: "app-1")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in existing container over ssh" do
|
||||||
|
@app.stub(:run_over_ssh, ->(cmd, host:) { cmd.join(" ") }) do
|
||||||
|
assert_match %r|docker exec -it app-999 bin/rails c|,
|
||||||
|
@app.execute_in_existing_container_over_ssh("bin/rails", "c", host: "app-1")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh" do
|
||||||
|
assert_equal "ssh -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with custom user" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "user" => "app" } })
|
||||||
|
assert_equal "ssh -t app@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with proxy" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "proxy" => "2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J root@2.2.2.2 -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with proxy user" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "proxy" => "app@2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J app@2.2.2.2 -t root@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with custom user with proxy" do
|
||||||
|
@app = Mrsk::Commands::App.new Mrsk::Configuration.new(@config.tap { |c| c[:ssh] = { "user" => "app", "proxy" => "2.2.2.2" } })
|
||||||
|
assert_equal "ssh -J root@2.2.2.2 -t app@1.1.1.1 'ls'", @app.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
test "current_container_id" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps -q --filter label=service=app",
|
||||||
|
@app.current_container_id.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "container_id_for" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=app-999 -q",
|
||||||
|
@app.container_id_for(container_name: "app-999").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "current_running_version" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter label=service=app --format \"{{.Names}}\" | sed 's/-/\\n/g' | tail -n 1",
|
||||||
|
@app.current_running_version.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "most_recent_version_from_available_images" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image ls --format \"{{.Tag}}\" dhh/app | head -n 1",
|
||||||
|
@app.most_recent_version_from_available_images.join(" ")
|
||||||
|
end
|
||||||
|
end
|
||||||
27
test/commands/auditor_test.rb
Normal file
27
test/commands/auditor_test.rb
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsAuditorTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
audit_broadcast_cmd: "bin/audit_broadcast"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "record" do
|
||||||
|
assert_match \
|
||||||
|
/echo '.* app removed container' >> mrsk-app-audit.log/,
|
||||||
|
new_command.record("app removed container").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "broadcast" do
|
||||||
|
assert_match \
|
||||||
|
/echo '.* app removed container' \| bin\/audit_broadcast/,
|
||||||
|
new_command.broadcast("app removed container").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Auditor.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
79
test/commands/builder_test.rb
Normal file
79
test/commands/builder_test.rb
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
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 -t dhh/app:latest --label service=app . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
|
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 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
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 -t dhh/app:latest --label service=app .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "build args" do
|
||||||
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
|
assert_equal \
|
||||||
|
"-t dhh/app:123 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2",
|
||||||
|
builder.target.build_options.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "build secrets" do
|
||||||
|
builder = new_builder_command(builder: { "secrets" => ["token_a", "token_b"] })
|
||||||
|
assert_equal \
|
||||||
|
"-t dhh/app:123 -t dhh/app:latest --label service=app --secret id=token_a --secret id=token_b",
|
||||||
|
builder.target.build_options.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "native push with build args" do
|
||||||
|
builder = new_builder_command(builder: { "multiarch" => false, "args" => { "a" => 1, "b" => 2 } })
|
||||||
|
assert_equal \
|
||||||
|
"docker build -t dhh/app:123 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2 . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
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 -t dhh/app:latest --label service=app --build-arg a=1 --build-arg b=2 .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "native push with with build secrets" do
|
||||||
|
builder = new_builder_command(builder: { "multiarch" => false, "secrets" => [ "a", "b" ] })
|
||||||
|
assert_equal \
|
||||||
|
"docker build -t dhh/app:123 -t dhh/app:latest --label service=app --secret id=a --secret id=b . && docker push dhh/app:123",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_builder_command(additional_config = {})
|
||||||
|
Mrsk::Commands::Builder.new(Mrsk::Configuration.new(@config.merge(additional_config), version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
55
test/commands/healthcheck_test.rb
Normal file
55
test/commands/healthcheck_test.rb
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsHealthcheckTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
traefik: { "args" => { "accesslog.format" => "json", "metrics.prometheus.buckets" => "0.1,0.3,1.2,5.0" } }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --name healthcheck-app-123 -p 3999:3000 --label service=healthcheck-app dhh/app:123",
|
||||||
|
new_command.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run with custom port" do
|
||||||
|
@config[:healthcheck] = { "port" => 3001 }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run -d --name healthcheck-app-123 -p 3999:3001 --label service=healthcheck-app dhh/app:123",
|
||||||
|
new_command.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "curl" do
|
||||||
|
assert_equal \
|
||||||
|
"curl --silent --output /dev/null --write-out '%{http_code}' http://localhost:3999/up",
|
||||||
|
new_command.curl.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "curl with custom path" do
|
||||||
|
@config[:healthcheck] = { "path" => "/healthz" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"curl --silent --output /dev/null --write-out '%{http_code}' http://localhost:3999/healthz",
|
||||||
|
new_command.curl.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=healthcheck-app -q | xargs docker stop",
|
||||||
|
new_command.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container ls -a -f name=healthcheck-app -q | xargs docker container rm",
|
||||||
|
new_command.remove.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Healthcheck.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
27
test/commands/prune_test.rb
Normal file
27
test/commands/prune_test.rb
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsPruneTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, servers: [ "1.1.1.1" ],
|
||||||
|
traefik: { "args" => { "accesslog.format" => "json", "metrics.prometheus.buckets" => "0.1,0.3,1.2,5.0" } }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
test "images" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image prune --all --force --filter label=service=app --filter until=168h",
|
||||||
|
new_command.images.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "containers" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container prune --force --filter label=service=app --filter until=72h",
|
||||||
|
new_command.containers.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Prune.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
23
test/commands/registry_test.rb
Executable file
23
test/commands/registry_test.rb
Executable file
@@ -0,0 +1,23 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class CommandsRegistryTest < ActiveSupport::TestCase
|
||||||
|
setup do
|
||||||
|
@config = { service: "app",
|
||||||
|
image: "dhh/app",
|
||||||
|
registry: { "username" => "dhh",
|
||||||
|
"password" => "secret",
|
||||||
|
"server" => "hub.docker.com"
|
||||||
|
},
|
||||||
|
servers: [ "1.1.1.1" ]
|
||||||
|
}
|
||||||
|
@registry = Mrsk::Commands::Registry.new Mrsk::Configuration.new(@config)
|
||||||
|
end
|
||||||
|
|
||||||
|
test "registry login" do
|
||||||
|
assert_equal [ :docker, :login, "hub.docker.com", "-u", "dhh", "-p", "secret" ], @registry.login
|
||||||
|
end
|
||||||
|
|
||||||
|
test "registry logout" do
|
||||||
|
assert_equal [:docker, :logout, "hub.docker.com"], @registry.logout
|
||||||
|
end
|
||||||
|
end
|
||||||
87
test/commands/traefik_test.rb
Normal file
87
test/commands/traefik_test.rb
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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 --log-opt max-size=10m -p 80:80 -v /var/run/docker.sock:/var/run/docker.sock traefik --providers.docker --log.level=DEBUG --accesslog.format json --metrics.prometheus.buckets 0.1,0.3,1.2,5.0",
|
||||||
|
new_command.run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik start" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container start traefik",
|
||||||
|
new_command.start.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik stop" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container stop traefik",
|
||||||
|
new_command.stop.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik info" do
|
||||||
|
assert_equal \
|
||||||
|
"docker ps --filter name=traefik",
|
||||||
|
new_command.info.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik logs" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logs traefik -t 2>&1",
|
||||||
|
new_command.logs.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik logs since 2h" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logs traefik --since 2h -t 2>&1",
|
||||||
|
new_command.logs(since: '2h').join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik logs last 10 lines" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logs traefik -n 10 -t 2>&1",
|
||||||
|
new_command.logs(lines: 10).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik logs with grep hello!" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logs traefik -t 2>&1 | grep 'hello!'",
|
||||||
|
new_command.logs(grep: 'hello!').join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik remove container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker container prune -f --filter label=org.opencontainers.image.title=Traefik",
|
||||||
|
new_command.remove_container.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik remove image" do
|
||||||
|
assert_equal \
|
||||||
|
"docker image prune -a -f --filter label=org.opencontainers.image.title=Traefik",
|
||||||
|
new_command.remove_image.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik follow logs" do
|
||||||
|
assert_equal \
|
||||||
|
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1'",
|
||||||
|
new_command.follow_logs(host: @config[:servers].first)
|
||||||
|
end
|
||||||
|
|
||||||
|
test "traefik follow logs with grep hello!" do
|
||||||
|
assert_equal \
|
||||||
|
"ssh -t root@1.1.1.1 'docker logs traefik -t -n 10 -f 2>&1 | grep \"hello!\"'",
|
||||||
|
new_command.follow_logs(host: @config[:servers].first, grep: 'hello!')
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def new_command
|
||||||
|
Mrsk::Commands::Traefik.new(Mrsk::Configuration.new(@config, version: "123"))
|
||||||
|
end
|
||||||
|
end
|
||||||
107
test/configuration/accessory_test.rb
Normal file
107
test/configuration/accessory_test.rb
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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
|
||||||
140
test/configuration/role_test.rb
Normal file
140
test/configuration/role_test.rb
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
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,15 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
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 +20,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 +46,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,35 +78,109 @@ 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]
|
||||||
|
|
||||||
config = Mrsk::Configuration.new(@deploy.tap { |c| c[:ssh_user] = "app" })
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "user" => "app" }) })
|
||||||
assert_equal "app", @config.ssh_options[:user]
|
assert_equal "app", @config.ssh_options[:user]
|
||||||
end
|
end
|
||||||
|
|
||||||
test "master key" do
|
test "ssh options with proxy host" do
|
||||||
assert_equal "456", @config.master_key
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "1.2.3.4" }) })
|
||||||
|
assert_equal "root@1.2.3.4", @config.ssh_options[:proxy].jump_proxies
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ssh options with proxy host and user" do
|
||||||
|
config = Mrsk::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "app@1.2.3.4" }) })
|
||||||
|
assert_equal "app@1.2.3.4", @config.ssh_options[:proxy].jump_proxies
|
||||||
|
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"], :healthcheck=>{"path"=>"/up", "port"=>3000 }}, @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,14 @@ 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 "mocha/minitest" # using #stubs that can alter returns
|
||||||
|
require "minitest/autorun" # using #stub that take args
|
||||||
|
require "sshkit"
|
||||||
|
require "mrsk"
|
||||||
|
|
||||||
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
|
||||||
end
|
end
|
||||||
|
|||||||
Reference in New Issue
Block a user