Compare commits
308 Commits
local-dock
...
v2.5.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
45197e46f6 | ||
|
|
6b40a64b9a | ||
|
|
9af2425fbd | ||
|
|
854dd925ba | ||
|
|
8775d202bd | ||
|
|
bae7c56e74 | ||
|
|
07d05ad58a | ||
|
|
e69611efb6 | ||
|
|
ba6dd6ff14 | ||
|
|
04a96aa5be | ||
|
|
dba3a115bd | ||
|
|
cd73cea850 | ||
|
|
09d020e9bb | ||
|
|
ff3538f81d | ||
|
|
c7d1711e30 | ||
|
|
d710b5a22b | ||
|
|
214d4fd321 | ||
|
|
5ddaa3810d | ||
|
|
3c01dc75fd | ||
|
|
2127f1708a | ||
|
|
24e4347c45 | ||
|
|
5f04e4266b | ||
|
|
35a29cc538 | ||
|
|
f187080db5 | ||
|
|
080fa49fdf | ||
|
|
34050f1036 | ||
|
|
459c7366ec | ||
|
|
f8db5de5eb | ||
|
|
4d67a1671a | ||
|
|
2c9bba3f88 | ||
|
|
a388937de8 | ||
|
|
9ef6c2f893 | ||
|
|
eee9d67691 | ||
|
|
5bd9bc8576 | ||
|
|
a5b9c69838 | ||
|
|
dc9a95db2c | ||
|
|
0174b872bf | ||
|
|
1db44c402c | ||
|
|
b420b2613d | ||
|
|
4ffa772201 | ||
|
|
e081414849 | ||
|
|
85c1c47c2f | ||
|
|
9f1688da7a | ||
|
|
2bd716ece4 | ||
|
|
f9a78f4fcb | ||
|
|
10dafc058a | ||
|
|
5e2678dece | ||
|
|
a1708f687f | ||
|
|
db7556ed99 | ||
|
|
93133cd7a9 | ||
|
|
a7b2ef56c7 | ||
|
|
06f2cb223e | ||
|
|
ea7e72d75f | ||
|
|
9035bd0d88 | ||
|
|
dd8cadf743 | ||
|
|
f1a9a09929 | ||
|
|
620b132138 | ||
|
|
2e7d0ddc44 | ||
|
|
ab8396fbb2 | ||
|
|
2cdca4596c | ||
|
|
78fcc3d88f | ||
|
|
2b9d5c2b19 | ||
|
|
d59c274208 | ||
|
|
bd8689c185 | ||
|
|
b5aee11a40 | ||
|
|
2943c4a301 | ||
|
|
32e1b6504d | ||
|
|
39e2c4f848 | ||
|
|
89db5025a0 | ||
|
|
c56edba4a9 | ||
|
|
1547089da0 | ||
|
|
ae7a4f3411 | ||
|
|
77c202ebaf | ||
|
|
063dfd9edd | ||
|
|
3e4a190173 | ||
|
|
d9c25533e4 | ||
|
|
d5ec0e6ad2 | ||
|
|
725da6aa68 | ||
|
|
84a874e63b | ||
|
|
ba567e0474 | ||
|
|
e464177349 | ||
|
|
68e6f82b30 | ||
|
|
55983c6431 | ||
|
|
b2cf3f33a7 | ||
|
|
16fb3adacb | ||
|
|
407c8b834e | ||
|
|
3468b45014 | ||
|
|
8103d68688 | ||
|
|
eb82b4a753 | ||
|
|
19b4359b17 | ||
|
|
dc64aaa0de | ||
|
|
ea170fbe5e | ||
|
|
18f2aae936 | ||
|
|
e314f38bdc | ||
|
|
1c8a56b8cf | ||
|
|
e597ae6155 | ||
|
|
495b3cd95f | ||
|
|
b04e8cd8d7 | ||
|
|
aa9fe4c525 | ||
|
|
f5391d7fe4 | ||
|
|
0bafa02e7d | ||
|
|
ffe1ac3483 | ||
|
|
2386c903ca | ||
|
|
fbc4515888 | ||
|
|
99829092b3 | ||
|
|
084d1d4a1d | ||
|
|
11e4f37409 | ||
|
|
b87bcae6a3 | ||
|
|
0c9a367efc | ||
|
|
a1596af815 | ||
|
|
69867e2650 | ||
|
|
eee47d10ee | ||
|
|
8a7843cb35 | ||
|
|
1cc5406b00 | ||
|
|
e31b98539c | ||
|
|
f367ca8ea5 | ||
|
|
14068b32b1 | ||
|
|
f52826b2d6 | ||
|
|
9204624752 | ||
|
|
006fa0de17 | ||
|
|
4d8241ebab | ||
|
|
86657b0172 | ||
|
|
aa2906086a | ||
|
|
f4b7c886fb | ||
|
|
4c778de2d9 | ||
|
|
70d2c71734 | ||
|
|
ac90ee068f | ||
|
|
75b44cd328 | ||
|
|
183fe9e06e | ||
|
|
1da882bb01 | ||
|
|
c662b8d578 | ||
|
|
dbe0c3a7f8 | ||
|
|
b9804a07aa | ||
|
|
f4d98bb67a | ||
|
|
42c3425411 | ||
|
|
57e48a33bb | ||
|
|
4acb78fff6 | ||
|
|
1a86b3ae6e | ||
|
|
a4ab34d8d9 | ||
|
|
24d03fd60e | ||
|
|
83fd2a051d | ||
|
|
a07ef64fad | ||
|
|
3793bdc2c3 | ||
|
|
72f30774ba | ||
|
|
3fa9cd5a41 | ||
|
|
c970ceebe3 | ||
|
|
79bc7584ca | ||
|
|
c9dec8c79a | ||
|
|
8d7a6403b5 | ||
|
|
b356b08069 | ||
|
|
4d09f3c242 | ||
|
|
d6c4411e97 | ||
|
|
8dd864af89 | ||
|
|
e4ab2a0d24 | ||
|
|
3069552315 | ||
|
|
77cd29f5ad | ||
|
|
d0d9dfcba9 | ||
|
|
b4d395cec9 | ||
|
|
e266945413 | ||
|
|
c9fff3cb40 | ||
|
|
cef1e53f84 | ||
|
|
9cf8da64c4 | ||
|
|
e9ba92386c | ||
|
|
685312c9f8 | ||
|
|
ca5e53404b | ||
|
|
2c14f48300 | ||
|
|
cd4e183213 | ||
|
|
7e8a8eb6e5 | ||
|
|
2465681408 | ||
|
|
b917d7cd40 | ||
|
|
1980a79e73 | ||
|
|
347eb69350 | ||
|
|
9a8a45015b | ||
|
|
8d0f4903ae | ||
|
|
57d582e3bc | ||
|
|
bf8779cef4 | ||
|
|
7142534e77 | ||
|
|
0f97e0b056 | ||
|
|
bd8c35b194 | ||
|
|
35075e2e4d | ||
|
|
53dad5f54f | ||
|
|
66f6e8b576 | ||
|
|
a3f5830728 | ||
|
|
a3e5505bb2 | ||
|
|
fdf8ef1343 | ||
|
|
3ee45d7b30 | ||
|
|
6856742eca | ||
|
|
c320343bb2 | ||
|
|
74a06b0ccd | ||
|
|
c0ca5e6dbb | ||
|
|
6f08750c3e | ||
|
|
e362b0106a | ||
|
|
8cec17dd05 | ||
|
|
0f3786781b | ||
|
|
844e3acf50 | ||
|
|
607368121e | ||
|
|
0f16ba1995 | ||
|
|
f3b8a59133 | ||
|
|
b4df51b8b4 | ||
|
|
bf79c7192f | ||
|
|
cb82767d0f | ||
|
|
3c91a83942 | ||
|
|
5cb9fb787b | ||
|
|
493c5690f1 | ||
|
|
5de55a22ff | ||
|
|
a1e40f9fec | ||
|
|
7ddf3bcb02 | ||
|
|
3654a7e1be | ||
|
|
6a7783c979 | ||
|
|
7dc2609b77 | ||
|
|
74960499c0 | ||
|
|
69b13ebc6a | ||
|
|
da2a543cbc | ||
|
|
08dacd2745 | ||
|
|
b6a10df56a | ||
|
|
c917dd82cf | ||
|
|
f04cae529a | ||
|
|
50c96e36c0 | ||
|
|
7b48648bf2 | ||
|
|
91df935d05 | ||
|
|
bbfcbfa94b | ||
|
|
440044b900 | ||
|
|
06419f8749 | ||
|
|
8d6d7ffed0 | ||
|
|
67ce1912f7 | ||
|
|
f45c754e53 | ||
|
|
d40057286d | ||
|
|
0840fdf0dd | ||
|
|
a434b10bfd | ||
|
|
e34031f70c | ||
|
|
23898a5197 | ||
|
|
1e9c9e9103 | ||
|
|
4b2c9cdc72 | ||
|
|
80191588c2 | ||
|
|
5ca806f4d3 | ||
|
|
1d04a6644f | ||
|
|
950624d667 | ||
|
|
81f3508507 | ||
|
|
9a16873f21 | ||
|
|
6d1d7a4c82 | ||
|
|
ccf32c2c1f | ||
|
|
e5ca53db6e | ||
|
|
82a436fa02 | ||
|
|
7be2e7e0ba | ||
|
|
4f7ebd73a3 | ||
|
|
279bda2770 | ||
|
|
aa15fa532a | ||
|
|
276b469c2b | ||
|
|
c10b3fb07a | ||
|
|
0ff1450a74 | ||
|
|
f47fd13e5b | ||
|
|
256933f6f3 | ||
|
|
1d8c40f5d2 | ||
|
|
73c78079bc | ||
|
|
cd12f95a97 | ||
|
|
641e9056b3 | ||
|
|
b4bcf35f78 | ||
|
|
7f6095c9eb | ||
|
|
ef1271df47 | ||
|
|
df1232d90f | ||
|
|
e75365c8c6 | ||
|
|
e441399255 | ||
|
|
af992ce755 | ||
|
|
32caf4b148 | ||
|
|
28a02262df | ||
|
|
b11fb93a6c | ||
|
|
67ad7662ab | ||
|
|
c63ec39f07 | ||
|
|
8df7d7d92d | ||
|
|
1d48a0fb0a | ||
|
|
f331605efa | ||
|
|
7ea995db91 | ||
|
|
994a8faf6b | ||
|
|
6c75fe40df | ||
|
|
7567cae964 | ||
|
|
ecd842ab9b | ||
|
|
91ae1dd7b9 | ||
|
|
0f815e17e4 | ||
|
|
a310aa8fef | ||
|
|
29b02f5c30 | ||
|
|
6d63c4e9c6 | ||
|
|
472d163cc7 | ||
|
|
dadac999d7 | ||
|
|
5036f8843f | ||
|
|
14d0396581 | ||
|
|
8c32e6af07 | ||
|
|
a765c501a3 | ||
|
|
ae990efd02 | ||
|
|
b3a6921118 | ||
|
|
325bf9a797 | ||
|
|
7bdf6cd2e8 | ||
|
|
92d82dd1a7 | ||
|
|
7633fe0293 | ||
|
|
f6851048a6 | ||
|
|
f0d7f786fa | ||
|
|
4d8387b1c9 | ||
|
|
0258ac4297 | ||
|
|
c17bdba61c | ||
|
|
13328687d1 | ||
|
|
2b0810d063 | ||
|
|
098f1855e2 | ||
|
|
88351312bf | ||
|
|
4a13803119 | ||
|
|
bda252835b | ||
|
|
0f5dfa204f | ||
|
|
9dde204480 | ||
|
|
b6cd4f8070 | ||
|
|
190f4fba28 |
12
.github/workflows/ci.yml
vendored
12
.github/workflows/ci.yml
vendored
@@ -4,6 +4,7 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
pull_request:
|
pull_request:
|
||||||
|
workflow_dispatch:
|
||||||
jobs:
|
jobs:
|
||||||
rubocop:
|
rubocop:
|
||||||
name: RuboCop
|
name: RuboCop
|
||||||
@@ -22,22 +23,29 @@ jobs:
|
|||||||
run: bundle exec rubocop --parallel
|
run: bundle exec rubocop --parallel
|
||||||
tests:
|
tests:
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
ruby-version:
|
ruby-version:
|
||||||
- "3.1"
|
- "3.1"
|
||||||
- "3.2"
|
- "3.2"
|
||||||
- "3.3"
|
- "3.3"
|
||||||
|
- "3.4"
|
||||||
gemfile:
|
gemfile:
|
||||||
- Gemfile
|
- Gemfile
|
||||||
- gemfiles/rails_edge.gemfile
|
- gemfiles/rails_edge.gemfile
|
||||||
|
exclude:
|
||||||
|
- ruby-version: "3.1"
|
||||||
|
gemfile: gemfiles/rails_edge.gemfile
|
||||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
continue-on-error: true
|
|
||||||
env:
|
env:
|
||||||
BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
|
BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Remove gemfile.lock
|
||||||
|
run: rm Gemfile.lock
|
||||||
|
|
||||||
- name: Install Ruby
|
- name: Install Ruby
|
||||||
uses: ruby/setup-ruby@v1
|
uses: ruby/setup-ruby@v1
|
||||||
with:
|
with:
|
||||||
@@ -46,3 +54,5 @@ jobs:
|
|||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: bin/test
|
run: bin/test
|
||||||
|
env:
|
||||||
|
RUBYOPT: ${{ startsWith(matrix.ruby-version, '3.4.') && '--enable=frozen-string-literal' || '' }}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
# Use the official Ruby 3.2.0 Alpine image as the base image
|
FROM ruby:3.3-alpine
|
||||||
FROM ruby:3.2.0-alpine
|
|
||||||
|
|
||||||
# Install docker/buildx-bin
|
# Install docker/buildx-bin
|
||||||
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
||||||
@@ -33,7 +32,7 @@ WORKDIR /workdir
|
|||||||
|
|
||||||
# Tell git it's safe to access /workdir/.git even if
|
# Tell git it's safe to access /workdir/.git even if
|
||||||
# the directory is owned by a different user
|
# the directory is owned by a different user
|
||||||
RUN git config --global --add safe.directory /workdir
|
RUN git config --global --add safe.directory '*'
|
||||||
|
|
||||||
# Set the entrypoint to run the installed binary in /workdir
|
# Set the entrypoint to run the installed binary in /workdir
|
||||||
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
||||||
|
|||||||
129
Gemfile.lock
129
Gemfile.lock
@@ -1,152 +1,155 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
kamal (2.0.0.rc2)
|
kamal (2.5.0)
|
||||||
activesupport (>= 7.0)
|
activesupport (>= 7.0)
|
||||||
base64 (~> 0.2)
|
base64 (~> 0.2)
|
||||||
bcrypt_pbkdf (~> 1.0)
|
bcrypt_pbkdf (~> 1.0)
|
||||||
concurrent-ruby (~> 1.2)
|
concurrent-ruby (~> 1.2)
|
||||||
dotenv (~> 3.1)
|
dotenv (~> 3.1)
|
||||||
ed25519 (~> 1.2)
|
ed25519 (~> 1.2)
|
||||||
net-ssh (~> 7.0)
|
net-ssh (~> 7.3)
|
||||||
sshkit (>= 1.23.0, < 2.0)
|
sshkit (>= 1.23.0, < 2.0)
|
||||||
thor (~> 1.3)
|
thor (~> 1.3)
|
||||||
zeitwerk (~> 2.5)
|
zeitwerk (>= 2.6.18, < 3.0)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
actionpack (7.1.3.4)
|
actionpack (8.0.0.1)
|
||||||
actionview (= 7.1.3.4)
|
actionview (= 8.0.0.1)
|
||||||
activesupport (= 7.1.3.4)
|
activesupport (= 8.0.0.1)
|
||||||
nokogiri (>= 1.8.5)
|
nokogiri (>= 1.8.5)
|
||||||
racc
|
|
||||||
rack (>= 2.2.4)
|
rack (>= 2.2.4)
|
||||||
rack-session (>= 1.0.1)
|
rack-session (>= 1.0.1)
|
||||||
rack-test (>= 0.6.3)
|
rack-test (>= 0.6.3)
|
||||||
rails-dom-testing (~> 2.2)
|
rails-dom-testing (~> 2.2)
|
||||||
rails-html-sanitizer (~> 1.6)
|
rails-html-sanitizer (~> 1.6)
|
||||||
actionview (7.1.3.4)
|
useragent (~> 0.16)
|
||||||
activesupport (= 7.1.3.4)
|
actionview (8.0.0.1)
|
||||||
|
activesupport (= 8.0.0.1)
|
||||||
builder (~> 3.1)
|
builder (~> 3.1)
|
||||||
erubi (~> 1.11)
|
erubi (~> 1.11)
|
||||||
rails-dom-testing (~> 2.2)
|
rails-dom-testing (~> 2.2)
|
||||||
rails-html-sanitizer (~> 1.6)
|
rails-html-sanitizer (~> 1.6)
|
||||||
activesupport (7.1.3.4)
|
activesupport (8.0.0.1)
|
||||||
base64
|
base64
|
||||||
|
benchmark (>= 0.3)
|
||||||
bigdecimal
|
bigdecimal
|
||||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
concurrent-ruby (~> 1.0, >= 1.3.1)
|
||||||
connection_pool (>= 2.2.5)
|
connection_pool (>= 2.2.5)
|
||||||
drb
|
drb
|
||||||
i18n (>= 1.6, < 2)
|
i18n (>= 1.6, < 2)
|
||||||
|
logger (>= 1.4.2)
|
||||||
minitest (>= 5.1)
|
minitest (>= 5.1)
|
||||||
mutex_m
|
securerandom (>= 0.3)
|
||||||
tzinfo (~> 2.0)
|
tzinfo (~> 2.0, >= 2.0.5)
|
||||||
|
uri (>= 0.13.1)
|
||||||
ast (2.4.2)
|
ast (2.4.2)
|
||||||
base64 (0.2.0)
|
base64 (0.2.0)
|
||||||
bcrypt_pbkdf (1.1.1)
|
bcrypt_pbkdf (1.1.1)
|
||||||
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
||||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||||
|
benchmark (0.4.0)
|
||||||
bigdecimal (3.1.8)
|
bigdecimal (3.1.8)
|
||||||
builder (3.3.0)
|
builder (3.3.0)
|
||||||
concurrent-ruby (1.3.3)
|
concurrent-ruby (1.3.4)
|
||||||
connection_pool (2.4.1)
|
connection_pool (2.4.1)
|
||||||
crass (1.0.6)
|
crass (1.0.6)
|
||||||
|
date (3.4.1)
|
||||||
debug (1.9.2)
|
debug (1.9.2)
|
||||||
irb (~> 1.10)
|
irb (~> 1.10)
|
||||||
reline (>= 0.3.8)
|
reline (>= 0.3.8)
|
||||||
dotenv (3.1.2)
|
dotenv (3.1.5)
|
||||||
drb (2.2.1)
|
drb (2.2.1)
|
||||||
ed25519 (1.3.0)
|
ed25519 (1.3.0)
|
||||||
erubi (1.13.0)
|
erubi (1.13.0)
|
||||||
i18n (1.14.5)
|
i18n (1.14.6)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
io-console (0.7.2)
|
io-console (0.8.0)
|
||||||
irb (1.14.0)
|
irb (1.14.2)
|
||||||
rdoc (>= 4.0.0)
|
rdoc (>= 4.0.0)
|
||||||
reline (>= 0.4.2)
|
reline (>= 0.4.2)
|
||||||
json (2.7.2)
|
json (2.9.0)
|
||||||
language_server-protocol (3.17.0.3)
|
language_server-protocol (3.17.0.3)
|
||||||
loofah (2.22.0)
|
logger (1.6.3)
|
||||||
|
loofah (2.23.1)
|
||||||
crass (~> 1.0.2)
|
crass (~> 1.0.2)
|
||||||
nokogiri (>= 1.12.0)
|
nokogiri (>= 1.12.0)
|
||||||
minitest (5.24.1)
|
minitest (5.25.4)
|
||||||
mocha (2.4.5)
|
mocha (2.7.1)
|
||||||
ruby2_keywords (>= 0.0.5)
|
ruby2_keywords (>= 0.0.5)
|
||||||
mutex_m (0.2.0)
|
|
||||||
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-sftp (4.0.0)
|
net-sftp (4.0.0)
|
||||||
net-ssh (>= 5.0.0, < 8.0.0)
|
net-ssh (>= 5.0.0, < 8.0.0)
|
||||||
net-ssh (7.2.3)
|
net-ssh (7.3.0)
|
||||||
nokogiri (1.16.7-arm64-darwin)
|
nokogiri (1.17.2-arm64-darwin)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
nokogiri (1.16.7-x86_64-darwin)
|
nokogiri (1.17.2-x86_64-darwin)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
nokogiri (1.16.7-x86_64-linux)
|
nokogiri (1.17.2-x86_64-linux)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
parallel (1.25.1)
|
ostruct (0.6.1)
|
||||||
parser (3.3.4.0)
|
parallel (1.26.3)
|
||||||
|
parser (3.3.6.0)
|
||||||
ast (~> 2.4.1)
|
ast (~> 2.4.1)
|
||||||
racc
|
racc
|
||||||
psych (5.1.2)
|
psych (5.2.1)
|
||||||
|
date
|
||||||
stringio
|
stringio
|
||||||
racc (1.8.1)
|
racc (1.8.1)
|
||||||
rack (3.1.7)
|
rack (3.1.8)
|
||||||
rack-session (2.0.0)
|
rack-session (2.0.0)
|
||||||
rack (>= 3.0.0)
|
rack (>= 3.0.0)
|
||||||
rack-test (2.1.0)
|
rack-test (2.1.0)
|
||||||
rack (>= 1.3)
|
rack (>= 1.3)
|
||||||
rackup (2.1.0)
|
rackup (2.2.1)
|
||||||
rack (>= 3)
|
rack (>= 3)
|
||||||
webrick (~> 1.8)
|
|
||||||
rails-dom-testing (2.2.0)
|
rails-dom-testing (2.2.0)
|
||||||
activesupport (>= 5.0.0)
|
activesupport (>= 5.0.0)
|
||||||
minitest
|
minitest
|
||||||
nokogiri (>= 1.6)
|
nokogiri (>= 1.6)
|
||||||
rails-html-sanitizer (1.6.0)
|
rails-html-sanitizer (1.6.2)
|
||||||
loofah (~> 2.21)
|
loofah (~> 2.21)
|
||||||
nokogiri (~> 1.14)
|
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
|
||||||
railties (7.1.3.4)
|
railties (8.0.0.1)
|
||||||
actionpack (= 7.1.3.4)
|
actionpack (= 8.0.0.1)
|
||||||
activesupport (= 7.1.3.4)
|
activesupport (= 8.0.0.1)
|
||||||
irb
|
irb (~> 1.13)
|
||||||
rackup (>= 1.0.0)
|
rackup (>= 1.0.0)
|
||||||
rake (>= 12.2)
|
rake (>= 12.2)
|
||||||
thor (~> 1.0, >= 1.2.2)
|
thor (~> 1.0, >= 1.2.2)
|
||||||
zeitwerk (~> 2.6)
|
zeitwerk (~> 2.6)
|
||||||
rainbow (3.1.1)
|
rainbow (3.1.1)
|
||||||
rake (13.2.1)
|
rake (13.2.1)
|
||||||
rdoc (6.7.0)
|
rdoc (6.8.1)
|
||||||
psych (>= 4.0.0)
|
psych (>= 4.0.0)
|
||||||
regexp_parser (2.9.2)
|
regexp_parser (2.9.3)
|
||||||
reline (0.5.9)
|
reline (0.5.12)
|
||||||
io-console (~> 0.5)
|
io-console (~> 0.5)
|
||||||
rexml (3.3.4)
|
rubocop (1.69.2)
|
||||||
strscan
|
|
||||||
rubocop (1.65.1)
|
|
||||||
json (~> 2.3)
|
json (~> 2.3)
|
||||||
language_server-protocol (>= 3.17.0)
|
language_server-protocol (>= 3.17.0)
|
||||||
parallel (~> 1.10)
|
parallel (~> 1.10)
|
||||||
parser (>= 3.3.0.2)
|
parser (>= 3.3.0.2)
|
||||||
rainbow (>= 2.2.2, < 4.0)
|
rainbow (>= 2.2.2, < 4.0)
|
||||||
regexp_parser (>= 2.4, < 3.0)
|
regexp_parser (>= 2.9.3, < 3.0)
|
||||||
rexml (>= 3.2.5, < 4.0)
|
rubocop-ast (>= 1.36.2, < 2.0)
|
||||||
rubocop-ast (>= 1.31.1, < 2.0)
|
|
||||||
ruby-progressbar (~> 1.7)
|
ruby-progressbar (~> 1.7)
|
||||||
unicode-display_width (>= 2.4.0, < 3.0)
|
unicode-display_width (>= 2.4.0, < 4.0)
|
||||||
rubocop-ast (1.32.0)
|
rubocop-ast (1.36.2)
|
||||||
parser (>= 3.3.1.0)
|
parser (>= 3.3.1.0)
|
||||||
rubocop-minitest (0.35.1)
|
rubocop-minitest (0.36.0)
|
||||||
rubocop (>= 1.61, < 2.0)
|
rubocop (>= 1.61, < 2.0)
|
||||||
rubocop-ast (>= 1.31.1, < 2.0)
|
rubocop-ast (>= 1.31.1, < 2.0)
|
||||||
rubocop-performance (1.21.1)
|
rubocop-performance (1.23.0)
|
||||||
rubocop (>= 1.48.1, < 2.0)
|
rubocop (>= 1.48.1, < 2.0)
|
||||||
rubocop-ast (>= 1.31.1, < 2.0)
|
rubocop-ast (>= 1.31.1, < 2.0)
|
||||||
rubocop-rails (2.25.1)
|
rubocop-rails (2.27.0)
|
||||||
activesupport (>= 4.2.0)
|
activesupport (>= 4.2.0)
|
||||||
rack (>= 1.1)
|
rack (>= 1.1)
|
||||||
rubocop (>= 1.33.0, < 2.0)
|
rubocop (>= 1.52.0, < 2.0)
|
||||||
rubocop-ast (>= 1.31.1, < 2.0)
|
rubocop-ast (>= 1.31.1, < 2.0)
|
||||||
rubocop-rails-omakase (1.0.0)
|
rubocop-rails-omakase (1.0.0)
|
||||||
rubocop
|
rubocop
|
||||||
@@ -155,19 +158,23 @@ GEM
|
|||||||
rubocop-rails
|
rubocop-rails
|
||||||
ruby-progressbar (1.13.0)
|
ruby-progressbar (1.13.0)
|
||||||
ruby2_keywords (0.0.5)
|
ruby2_keywords (0.0.5)
|
||||||
sshkit (1.23.0)
|
securerandom (0.4.0)
|
||||||
|
sshkit (1.23.2)
|
||||||
base64
|
base64
|
||||||
net-scp (>= 1.1.2)
|
net-scp (>= 1.1.2)
|
||||||
net-sftp (>= 2.1.2)
|
net-sftp (>= 2.1.2)
|
||||||
net-ssh (>= 2.8.0)
|
net-ssh (>= 2.8.0)
|
||||||
stringio (3.1.1)
|
ostruct
|
||||||
strscan (3.1.0)
|
stringio (3.1.2)
|
||||||
thor (1.3.1)
|
thor (1.3.2)
|
||||||
tzinfo (2.0.6)
|
tzinfo (2.0.6)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
unicode-display_width (2.5.0)
|
unicode-display_width (3.1.2)
|
||||||
webrick (1.8.1)
|
unicode-emoji (~> 4.0, >= 4.0.4)
|
||||||
zeitwerk (2.6.17)
|
unicode-emoji (4.0.4)
|
||||||
|
uri (1.0.2)
|
||||||
|
useragent (0.16.11)
|
||||||
|
zeitwerk (2.7.1)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
arm64-darwin
|
arm64-darwin
|
||||||
|
|||||||
14
bin/docs
14
bin/docs
@@ -30,6 +30,7 @@ DOCS = {
|
|||||||
"ssh" => "SSH",
|
"ssh" => "SSH",
|
||||||
"sshkit" => "SSHKit"
|
"sshkit" => "SSHKit"
|
||||||
}
|
}
|
||||||
|
DOCS_PATH = "lib/kamal/configuration/docs"
|
||||||
|
|
||||||
class DocWriter
|
class DocWriter
|
||||||
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
||||||
@@ -70,6 +71,7 @@ class DocWriter
|
|||||||
generate_line(line, heading: place == :new_section)
|
generate_line(line, heading: place == :new_section)
|
||||||
place = :in_section
|
place = :in_section
|
||||||
else
|
else
|
||||||
|
output.puts
|
||||||
output.puts "```yaml"
|
output.puts "```yaml"
|
||||||
output.puts line
|
output.puts line
|
||||||
place = :in_yaml
|
place = :in_yaml
|
||||||
@@ -77,6 +79,7 @@ class DocWriter
|
|||||||
when :in_yaml, :in_empty_line_yaml
|
when :in_yaml, :in_empty_line_yaml
|
||||||
if line =~ /^ *#/
|
if line =~ /^ *#/
|
||||||
output.puts "```"
|
output.puts "```"
|
||||||
|
output.puts
|
||||||
generate_line(line, heading: place == :in_empty_line_yaml)
|
generate_line(line, heading: place == :in_empty_line_yaml)
|
||||||
place = :in_section
|
place = :in_section
|
||||||
elsif line.empty?
|
elsif line.empty?
|
||||||
@@ -92,11 +95,12 @@ class DocWriter
|
|||||||
|
|
||||||
def generate_header
|
def generate_header
|
||||||
output.puts "---"
|
output.puts "---"
|
||||||
|
output.puts "# This file has been generated from the Kamal source, do not edit directly."
|
||||||
|
output.puts "# Find the source of this file at #{DOCS_PATH}/#{key}.yml in the Kamal repository."
|
||||||
output.puts "title: #{heading[2..-1]}"
|
output.puts "title: #{heading[2..-1]}"
|
||||||
output.puts "---"
|
output.puts "---"
|
||||||
output.puts
|
output.puts
|
||||||
output.puts heading
|
output.puts heading
|
||||||
output.puts
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_line(line, heading: false)
|
def generate_line(line, heading: false)
|
||||||
@@ -118,18 +122,20 @@ class DocWriter
|
|||||||
end
|
end
|
||||||
|
|
||||||
def linkify(text)
|
def linkify(text)
|
||||||
|
if text == "Configuration overview"
|
||||||
|
"overview"
|
||||||
|
else
|
||||||
text.downcase.gsub(" ", "-")
|
text.downcase.gsub(" ", "-")
|
||||||
end
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def titlify(text)
|
def titlify(text)
|
||||||
text.capitalize.gsub("-", " ")
|
text.capitalize.gsub("-", " ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
from_dir = File.join(File.dirname(__FILE__), "../lib/kamal/configuration/docs")
|
from_dir = File.join(File.dirname(__FILE__), "../#{DOCS_PATH}")
|
||||||
to_dir = File.join(kamal_site_repo, "docs/configuration")
|
to_dir = File.join(kamal_site_repo, "docs/configuration")
|
||||||
Dir.glob("#{from_dir}/*") do |from_file|
|
Dir.glob("#{from_dir}/*") do |from_file|
|
||||||
key = File.basename(from_file, ".yml")
|
|
||||||
|
|
||||||
DocWriter.new(from_file, to_dir).write
|
DocWriter.new(from_file, to_dir).write
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
|
|||||||
|
|
||||||
spec.add_dependency "activesupport", ">= 7.0"
|
spec.add_dependency "activesupport", ">= 7.0"
|
||||||
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
||||||
spec.add_dependency "net-ssh", "~> 7.0"
|
spec.add_dependency "net-ssh", "~> 7.3"
|
||||||
spec.add_dependency "thor", "~> 1.3"
|
spec.add_dependency "thor", "~> 1.3"
|
||||||
spec.add_dependency "dotenv", "~> 3.1"
|
spec.add_dependency "dotenv", "~> 3.1"
|
||||||
spec.add_dependency "zeitwerk", "~> 2.5"
|
spec.add_dependency "zeitwerk", ">= 2.6.18", "< 3.0"
|
||||||
spec.add_dependency "ed25519", "~> 1.2"
|
spec.add_dependency "ed25519", "~> 1.2"
|
||||||
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
||||||
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ module Kamal::Cli
|
|||||||
class BootError < StandardError; end
|
class BootError < StandardError; end
|
||||||
class HookError < StandardError; end
|
class HookError < StandardError; end
|
||||||
class LockError < StandardError; end
|
class LockError < StandardError; end
|
||||||
|
class DependencyError < StandardError; end
|
||||||
end
|
end
|
||||||
|
|
||||||
# SSHKit uses instance eval, so we need a global const for ergonomics
|
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
require "active_support/core_ext/array/conversions"
|
||||||
|
|
||||||
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||||
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
||||||
def boot(name, prepare: true)
|
def boot(name, prepare: true)
|
||||||
@@ -16,6 +18,11 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
execute *accessory.ensure_env_directory
|
execute *accessory.ensure_env_directory
|
||||||
upload! accessory.secrets_io, accessory.secrets_path, mode: "0600"
|
upload! accessory.secrets_io, accessory.secrets_path, mode: "0600"
|
||||||
execute *accessory.run
|
execute *accessory.run
|
||||||
|
|
||||||
|
if accessory.running_proxy?
|
||||||
|
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||||
|
execute *accessory.deploy(target: target)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -73,6 +80,10 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
on(hosts) do
|
on(hosts) do
|
||||||
execute *KAMAL.auditor.record("Started #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Started #{name} accessory"), verbosity: :debug
|
||||||
execute *accessory.start
|
execute *accessory.start
|
||||||
|
if accessory.running_proxy?
|
||||||
|
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||||
|
execute *accessory.deploy(target: target)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -85,6 +96,11 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
on(hosts) do
|
on(hosts) do
|
||||||
execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
||||||
execute *accessory.stop, raise_on_non_zero_exit: false
|
execute *accessory.stop, raise_on_non_zero_exit: false
|
||||||
|
|
||||||
|
if accessory.running_proxy?
|
||||||
|
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||||
|
execute *accessory.remove if target
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -110,14 +126,15 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "exec [NAME] [CMD]", "Execute a custom command on servers (use --help to show options)"
|
desc "exec [NAME] [CMD...]", "Execute a custom command on servers within the accessory container (use --help to show options)"
|
||||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
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"
|
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||||
def exec(name, cmd)
|
def exec(name, *cmd)
|
||||||
|
cmd = Kamal::Utils.join_commands(cmd)
|
||||||
with_accessory(name) do |accessory, hosts|
|
with_accessory(name) do |accessory, hosts|
|
||||||
case
|
case
|
||||||
when options[:interactive] && options[:reuse]
|
when options[:interactive] && options[:reuse]
|
||||||
say "Launching interactive command with via SSH from existing container...", :magenta
|
say "Launching interactive command via SSH from existing container...", :magenta
|
||||||
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
||||||
|
|
||||||
when options[:interactive]
|
when options[:interactive]
|
||||||
@@ -126,16 +143,16 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
|
|
||||||
when options[:reuse]
|
when options[:reuse]
|
||||||
say "Launching command from existing container...", :magenta
|
say "Launching command from existing container...", :magenta
|
||||||
on(hosts) do
|
on(hosts) do |host|
|
||||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
puts_by_host host, capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||||
end
|
end
|
||||||
|
|
||||||
else
|
else
|
||||||
say "Launching command from new container...", :magenta
|
say "Launching command from new container...", :magenta
|
||||||
on(hosts) do
|
on(hosts) do |host|
|
||||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
capture_with_info(*accessory.execute_in_new_container(cmd))
|
puts_by_host host, capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -145,7 +162,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
||||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||||
option :grep_options, aliases: "-o", desc: "Additional options supplied to grep"
|
option :grep_options, desc: "Additional options supplied to grep"
|
||||||
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||||
def logs(name)
|
def logs(name)
|
||||||
@@ -275,7 +292,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
def prepare(name)
|
def prepare(name)
|
||||||
with_accessory(name) do |accessory, hosts|
|
with_accessory(name) do |accessory, hosts|
|
||||||
on(hosts) do
|
on(hosts) do
|
||||||
execute *KAMAL.registry.login
|
execute *KAMAL.registry.login(registry_config: accessory.registry)
|
||||||
execute *KAMAL.docker.create_network
|
execute *KAMAL.docker.create_network
|
||||||
rescue SSHKit::Command::Failed => e
|
rescue SSHKit::Command::Failed => e
|
||||||
raise unless e.message.include?("already exists")
|
raise unless e.message.include?("already exists")
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
class Kamal::Cli::Alias::Command < Thor::DynamicCommand
|
class Kamal::Cli::Alias::Command < Thor::DynamicCommand
|
||||||
def run(instance, args = [])
|
def run(instance, args = [])
|
||||||
if (_alias = KAMAL.config.aliases[name])
|
if (_alias = KAMAL.config.aliases[name])
|
||||||
|
KAMAL.reset
|
||||||
Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
|
Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
|
||||||
else
|
else
|
||||||
super
|
super
|
||||||
|
|||||||
@@ -16,12 +16,20 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
# Primary hosts and roles are returned first, so they can open the barrier
|
# Primary hosts and roles are returned first, so they can open the barrier
|
||||||
barrier = Kamal::Cli::Healthcheck::Barrier.new
|
barrier = Kamal::Cli::Healthcheck::Barrier.new
|
||||||
|
|
||||||
on(KAMAL.hosts, **KAMAL.boot_strategy) do |host|
|
host_boot_groups.each do |hosts|
|
||||||
|
host_list = Array(hosts).join(",")
|
||||||
|
run_hook "pre-app-boot", hosts: host_list
|
||||||
|
|
||||||
|
on(hosts) do |host|
|
||||||
KAMAL.roles_on(host).each do |role|
|
KAMAL.roles_on(host).each do |role|
|
||||||
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
run_hook "post-app-boot", hosts: host_list
|
||||||
|
sleep KAMAL.config.boot.wait if KAMAL.config.boot.wait
|
||||||
|
end
|
||||||
|
|
||||||
# Tag once the app booted on all hosts
|
# Tag once the app booted on all hosts
|
||||||
on(KAMAL.hosts) do |host|
|
on(KAMAL.hosts) do |host|
|
||||||
execute *KAMAL.auditor.record("Tagging #{KAMAL.config.absolute_image} as the latest image"), verbosity: :debug
|
execute *KAMAL.auditor.record("Tagging #{KAMAL.config.absolute_image} as the latest image"), verbosity: :debug
|
||||||
@@ -68,7 +76,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
||||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||||
if endpoint.present?
|
if endpoint.present?
|
||||||
execute *app.remove(target: endpoint), raise_on_non_zero_exit: false
|
execute *app.remove, raise_on_non_zero_exit: false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -94,9 +102,15 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
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"
|
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||||
option :env, aliases: "-e", type: :hash, desc: "Set environment variables for the command"
|
option :env, aliases: "-e", type: :hash, desc: "Set environment variables for the command"
|
||||||
|
option :detach, type: :boolean, default: false, desc: "Execute command in a detached container"
|
||||||
def exec(*cmd)
|
def exec(*cmd)
|
||||||
|
if (incompatible_options = [ :interactive, :reuse ].select { |key| options[:detach] && options[key] }.presence)
|
||||||
|
raise ArgumentError, "Detach is not compatible with #{incompatible_options.join(" or ")}"
|
||||||
|
end
|
||||||
|
|
||||||
cmd = Kamal::Utils.join_commands(cmd)
|
cmd = Kamal::Utils.join_commands(cmd)
|
||||||
env = options[:env]
|
env = options[:env]
|
||||||
|
detach = options[:detach]
|
||||||
case
|
case
|
||||||
when options[:interactive] && options[:reuse]
|
when options[:interactive] && options[:reuse]
|
||||||
say "Get current version of running container...", :magenta unless options[:version]
|
say "Get current version of running container...", :magenta unless options[:version]
|
||||||
@@ -138,7 +152,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
|
|
||||||
roles.each do |role|
|
roles.each do |role|
|
||||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_new_container(cmd, env: env))
|
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_new_container(cmd, env: env, detach: detach))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -186,15 +200,17 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
option :since, aliases: "-s", desc: "Show lines since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
option :since, aliases: "-s", desc: "Show lines 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 lines to show from each server"
|
option :lines, type: :numeric, aliases: "-n", desc: "Number of lines to show from each server"
|
||||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||||
option :grep_options, aliases: "-o", desc: "Additional options supplied to grep"
|
option :grep_options, desc: "Additional options supplied to grep"
|
||||||
option :follow, aliases: "-f", desc: "Follow log on primary server (or specific host set by --hosts)"
|
option :follow, aliases: "-f", desc: "Follow log on primary server (or specific host set by --hosts)"
|
||||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||||
|
option :container_id, desc: "Docker container ID to fetch logs"
|
||||||
def logs
|
def logs
|
||||||
# FIXME: Catch when app containers aren't running
|
# FIXME: Catch when app containers aren't running
|
||||||
|
|
||||||
grep = options[:grep]
|
grep = options[:grep]
|
||||||
grep_options = options[:grep_options]
|
grep_options = options[:grep_options]
|
||||||
since = options[:since]
|
since = options[:since]
|
||||||
|
container_id = options[:container_id]
|
||||||
timestamps = !options[:skip_timestamps]
|
timestamps = !options[:skip_timestamps]
|
||||||
|
|
||||||
if options[:follow]
|
if options[:follow]
|
||||||
@@ -203,12 +219,12 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
run_locally do
|
run_locally do
|
||||||
info "Following logs on #{KAMAL.primary_host}..."
|
info "Following logs on #{KAMAL.primary_host}..."
|
||||||
|
|
||||||
KAMAL.specific_roles ||= [ "web" ]
|
KAMAL.specific_roles ||= [ KAMAL.primary_role.name ]
|
||||||
role = KAMAL.roles_on(KAMAL.primary_host).first
|
role = KAMAL.roles_on(KAMAL.primary_host).first
|
||||||
|
|
||||||
app = KAMAL.app(role: role, host: host)
|
app = KAMAL.app(role: role, host: host)
|
||||||
info app.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
info app.follow_logs(host: KAMAL.primary_host, container_id: container_id, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
||||||
exec app.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
exec app.follow_logs(host: KAMAL.primary_host, container_id: container_id, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||||
@@ -218,7 +234,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
|
|
||||||
roles.each do |role|
|
roles.each do |role|
|
||||||
begin
|
begin
|
||||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(container_id: container_id, timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||||
rescue SSHKit::Command::Failed
|
rescue SSHKit::Command::Failed
|
||||||
puts_by_host host, "Nothing found"
|
puts_by_host host, "Nothing found"
|
||||||
end
|
end
|
||||||
@@ -332,4 +348,8 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
yield
|
yield
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def host_boot_groups
|
||||||
|
KAMAL.config.boot.limit ? KAMAL.hosts.each_slice(KAMAL.config.boot.limit).to_a : [ KAMAL.hosts ]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ class Kamal::Cli::App::Boot
|
|||||||
|
|
||||||
def start_new_version
|
def start_new_version
|
||||||
audit "Booted app version #{version}"
|
audit "Booted app version #{version}"
|
||||||
hostname = "#{host.to_s[0...51].gsub(/\.+$/, '')}-#{SecureRandom.hex(6)}"
|
hostname = "#{host.to_s[0...51].chomp(".")}-#{SecureRandom.hex(6)}"
|
||||||
|
|
||||||
execute *app.ensure_env_directory
|
execute *app.ensure_env_directory
|
||||||
upload! role.secrets_io(host), role.secrets_path, mode: "0600"
|
upload! role.secrets_io(host), role.secrets_path, mode: "0600"
|
||||||
@@ -91,7 +91,7 @@ class Kamal::Cli::App::Boot
|
|||||||
if barrier.close
|
if barrier.close
|
||||||
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting any other roles"
|
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting any other roles"
|
||||||
begin
|
begin
|
||||||
error capture_with_info(*app.logs(version: version))
|
error capture_with_info(*app.logs(container_id: app.container_id_for_version(version)))
|
||||||
error capture_with_info(*app.container_health_log(version: version))
|
error capture_with_info(*app.container_health_log(version: version))
|
||||||
rescue SSHKit::Command::Failed
|
rescue SSHKit::Command::Failed
|
||||||
error "Could not fetch logs for #{version}"
|
error "Could not fetch logs for #{version}"
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ module Kamal::Cli
|
|||||||
class Base < Thor
|
class Base < Thor
|
||||||
include SSHKit::DSL
|
include SSHKit::DSL
|
||||||
|
|
||||||
def self.exit_on_failure?() false end
|
def self.exit_on_failure?() true end
|
||||||
def self.dynamic_command_class() Kamal::Cli::Alias::Command end
|
def self.dynamic_command_class() Kamal::Cli::Alias::Command end
|
||||||
|
|
||||||
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
||||||
@@ -30,6 +30,7 @@ module Kamal::Cli
|
|||||||
else
|
else
|
||||||
super
|
super
|
||||||
end
|
end
|
||||||
|
|
||||||
initialize_commander unless KAMAL.configured?
|
initialize_commander unless KAMAL.configured?
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -194,5 +195,19 @@ module Kamal::Cli
|
|||||||
ENV.clear
|
ENV.clear
|
||||||
ENV.update(current_env)
|
ENV.update(current_env)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ensure_docker_installed
|
||||||
|
run_locally do
|
||||||
|
begin
|
||||||
|
execute *KAMAL.builder.ensure_docker_installed
|
||||||
|
rescue SSHKit::Command::Failed => e
|
||||||
|
error = e.message =~ /command not found/ ?
|
||||||
|
"Docker is not installed locally" :
|
||||||
|
"Docker buildx plugin is not installed locally"
|
||||||
|
|
||||||
|
raise DependencyError, error
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,15 +5,16 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
|||||||
|
|
||||||
desc "deliver", "Build app and push app image to registry then pull image on servers"
|
desc "deliver", "Build app and push app image to registry then pull image on servers"
|
||||||
def deliver
|
def deliver
|
||||||
push
|
invoke :push
|
||||||
pull
|
invoke :pull
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "push", "Build and push app image to registry"
|
desc "push", "Build and push app image to registry"
|
||||||
|
option :output, type: :string, default: "registry", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||||
def push
|
def push
|
||||||
cli = self
|
cli = self
|
||||||
|
|
||||||
verify_local_dependencies
|
ensure_docker_installed
|
||||||
run_hook "pre-build"
|
run_hook "pre-build"
|
||||||
|
|
||||||
uncommitted_changes = Kamal::Git.uncommitted_changes
|
uncommitted_changes = Kamal::Git.uncommitted_changes
|
||||||
@@ -49,7 +50,7 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||||
push = KAMAL.builder.push
|
push = KAMAL.builder.push(cli.options[:output])
|
||||||
|
|
||||||
KAMAL.with_verbosity(:debug) do
|
KAMAL.with_verbosity(:debug) do
|
||||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||||
@@ -108,21 +109,42 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
desc "dev", "Build using the working directory, tag it as dirty, and push to local image store."
|
||||||
def verify_local_dependencies
|
option :output, type: :string, default: "docker", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||||
|
def dev
|
||||||
|
cli = self
|
||||||
|
|
||||||
|
ensure_docker_installed
|
||||||
|
|
||||||
|
docker_included_files = Set.new(Kamal::Docker.included_files)
|
||||||
|
git_uncommitted_files = Set.new(Kamal::Git.uncommitted_files)
|
||||||
|
git_untracked_files = Set.new(Kamal::Git.untracked_files)
|
||||||
|
|
||||||
|
docker_uncommitted_files = docker_included_files & git_uncommitted_files
|
||||||
|
if docker_uncommitted_files.any?
|
||||||
|
say "WARNING: Files with uncommitted changes will be present in the dev container:", :yellow
|
||||||
|
docker_uncommitted_files.sort.each { |f| say " #{f}", :yellow }
|
||||||
|
say
|
||||||
|
end
|
||||||
|
|
||||||
|
docker_untracked_files = docker_included_files & git_untracked_files
|
||||||
|
if docker_untracked_files.any?
|
||||||
|
say "WARNING: Untracked files will be present in the dev container:", :yellow
|
||||||
|
docker_untracked_files.sort.each { |f| say " #{f}", :yellow }
|
||||||
|
say
|
||||||
|
end
|
||||||
|
|
||||||
|
with_env(KAMAL.config.builder.secrets) do
|
||||||
run_locally do
|
run_locally do
|
||||||
begin
|
build = KAMAL.builder.push(cli.options[:output], tag_as_dirty: true)
|
||||||
execute *KAMAL.builder.ensure_local_dependencies_installed
|
KAMAL.with_verbosity(:debug) do
|
||||||
rescue SSHKit::Command::Failed => e
|
execute(*build)
|
||||||
build_error = e.message =~ /command not found/ ?
|
end
|
||||||
"Docker is not installed locally" :
|
|
||||||
"Docker buildx plugin is not installed locally"
|
|
||||||
|
|
||||||
raise BuildError, build_error
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
def connect_to_remote_host(remote_host)
|
def connect_to_remote_host(remote_host)
|
||||||
remote_uri = URI.parse(remote_host)
|
remote_uri = URI.parse(remote_host)
|
||||||
if remote_uri.scheme == "ssh"
|
if remote_uri.scheme == "ssh"
|
||||||
|
|||||||
@@ -9,15 +9,14 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
|||||||
say "Ensure Docker is installed...", :magenta
|
say "Ensure Docker is installed...", :magenta
|
||||||
invoke "kamal:cli:server:bootstrap", [], invoke_options
|
invoke "kamal:cli:server:bootstrap", [], invoke_options
|
||||||
|
|
||||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options
|
deploy(boot_accessories: true)
|
||||||
deploy
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "deploy", "Deploy app to servers"
|
desc "deploy", "Deploy app to servers"
|
||||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
||||||
def deploy
|
def deploy(boot_accessories: false)
|
||||||
runtime = print_runtime do
|
runtime = print_runtime do
|
||||||
invoke_options = deploy_options
|
invoke_options = deploy_options
|
||||||
|
|
||||||
@@ -38,6 +37,8 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
|||||||
say "Ensure kamal-proxy is running...", :magenta
|
say "Ensure kamal-proxy is running...", :magenta
|
||||||
invoke "kamal:cli:proxy:boot", [], invoke_options
|
invoke "kamal:cli:proxy:boot", [], invoke_options
|
||||||
|
|
||||||
|
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options if boot_accessories
|
||||||
|
|
||||||
say "Detect stale containers...", :magenta
|
say "Detect stale containers...", :magenta
|
||||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||||
|
|
||||||
@@ -135,7 +136,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
|||||||
puts "No documentation found for #{section}"
|
puts "No documentation found for #{section}"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "init", "Create config stub in config/deploy.yml and env stub in .env"
|
desc "init", "Create config stub in config/deploy.yml and secrets stub in .kamal"
|
||||||
option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub"
|
option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub"
|
||||||
def init
|
def init
|
||||||
require "fileutils"
|
require "fileutils"
|
||||||
|
|||||||
@@ -14,13 +14,46 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
|||||||
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
||||||
|
|
||||||
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||||
raise "kamal-proxy version #{version} is too old, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||||
end
|
end
|
||||||
execute *KAMAL.proxy.start_or_run
|
execute *KAMAL.proxy.start_or_run
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "boot_config <set|get|reset>", "Manage kamal-proxy boot configuration"
|
||||||
|
option :publish, type: :boolean, default: true, desc: "Publish the proxy ports on the host"
|
||||||
|
option :publish_host_ip, type: :string, repeatable: true, default: nil, desc: "Host IP address to bind HTTP/HTTPS traffic to. Defaults to all interfaces"
|
||||||
|
option :http_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTP_PORT, desc: "HTTP port to publish on the host"
|
||||||
|
option :https_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTPS_PORT, desc: "HTTPS port to publish on the host"
|
||||||
|
option :log_max_size, type: :string, default: Kamal::Configuration::PROXY_LOG_MAX_SIZE, desc: "Max size of proxy logs"
|
||||||
|
option :docker_options, type: :array, default: [], desc: "Docker options to pass to the proxy container", banner: "option=value option2=value2"
|
||||||
|
def boot_config(subcommand)
|
||||||
|
case subcommand
|
||||||
|
when "set"
|
||||||
|
boot_options = [
|
||||||
|
*(KAMAL.config.proxy_publish_args(options[:http_port], options[:https_port], options[:publish_host_ip]) if options[:publish]),
|
||||||
|
*(KAMAL.config.proxy_logging_args(options[:log_max_size])),
|
||||||
|
*options[:docker_options].map { |option| "--#{option}" }
|
||||||
|
]
|
||||||
|
|
||||||
|
on(KAMAL.proxy_hosts) do |host|
|
||||||
|
execute(*KAMAL.proxy.ensure_proxy_directory)
|
||||||
|
upload! StringIO.new(boot_options.join(" ")), KAMAL.config.proxy_options_file
|
||||||
|
end
|
||||||
|
when "get"
|
||||||
|
on(KAMAL.proxy_hosts) do |host|
|
||||||
|
puts "Host #{host}: #{capture_with_info(*KAMAL.proxy.get_boot_options)}"
|
||||||
|
end
|
||||||
|
when "reset"
|
||||||
|
on(KAMAL.proxy_hosts) do |host|
|
||||||
|
execute *KAMAL.proxy.reset_boot_options
|
||||||
|
end
|
||||||
|
else
|
||||||
|
raise ArgumentError, "Unknown boot_config subcommand #{subcommand}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
desc "reboot", "Reboot proxy on servers (stop container, remove container, start new container)"
|
desc "reboot", "Reboot proxy on servers (stop container, remove container, start new container)"
|
||||||
option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel"
|
option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel"
|
||||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||||
@@ -35,9 +68,6 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
|||||||
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
||||||
execute *KAMAL.registry.login
|
execute *KAMAL.registry.login
|
||||||
|
|
||||||
"Stopping and removing Traefik on #{host}, if running..."
|
|
||||||
execute *KAMAL.proxy.cleanup_traefik
|
|
||||||
|
|
||||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||||
execute *KAMAL.proxy.remove_container
|
execute *KAMAL.proxy.remove_container
|
||||||
@@ -169,6 +199,7 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
|||||||
stop
|
stop
|
||||||
remove_container
|
remove_container
|
||||||
remove_image
|
remove_image
|
||||||
|
remove_proxy_directory
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -193,6 +224,15 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "remove_proxy_directory", "Remove the proxy directory from servers", hide: true
|
||||||
|
def remove_proxy_directory
|
||||||
|
with_lock do
|
||||||
|
on(KAMAL.proxy_hosts) do
|
||||||
|
execute *KAMAL.proxy.remove_proxy_directory, raise_on_non_zero_exit: false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def removal_allowed?(force)
|
def removal_allowed?(force)
|
||||||
on(KAMAL.proxy_hosts) do |host|
|
on(KAMAL.proxy_hosts) do |host|
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ class Kamal::Cli::Registry < Kamal::Cli::Base
|
|||||||
option :skip_local, aliases: "-L", type: :boolean, default: false, desc: "Skip local login"
|
option :skip_local, aliases: "-L", type: :boolean, default: false, desc: "Skip local login"
|
||||||
option :skip_remote, aliases: "-R", type: :boolean, default: false, desc: "Skip remote login"
|
option :skip_remote, aliases: "-R", type: :boolean, default: false, desc: "Skip remote login"
|
||||||
def login
|
def login
|
||||||
|
ensure_docker_installed
|
||||||
|
|
||||||
run_locally { execute *KAMAL.registry.login } unless options[:skip_local]
|
run_locally { execute *KAMAL.registry.login } unless options[:skip_local]
|
||||||
on(KAMAL.hosts) { execute *KAMAL.registry.login } unless options[:skip_remote]
|
on(KAMAL.hosts) { execute *KAMAL.registry.login } unless options[:skip_remote]
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,11 +1,17 @@
|
|||||||
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
||||||
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
||||||
option :adapter, type: :string, aliases: "-a", required: true, desc: "Which vault adapter to use"
|
option :adapter, type: :string, aliases: "-a", required: true, desc: "Which vault adapter to use"
|
||||||
option :account, type: :string, required: true, desc: "The account identifier or username"
|
option :account, type: :string, required: false, desc: "The account identifier or username"
|
||||||
option :from, type: :string, required: false, desc: "A vault or folder to fetch the secrets from"
|
option :from, type: :string, required: false, desc: "A vault or folder to fetch the secrets from"
|
||||||
option :inline, type: :boolean, required: false, hidden: true
|
option :inline, type: :boolean, required: false, hidden: true
|
||||||
def fetch(*secrets)
|
def fetch(*secrets)
|
||||||
results = adapter(options[:adapter]).fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
adapter = initialize_adapter(options[:adapter])
|
||||||
|
|
||||||
|
if adapter.requires_account? && options[:account].blank?
|
||||||
|
return puts "No value provided for required options '--account'"
|
||||||
|
end
|
||||||
|
|
||||||
|
results = adapter.fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
||||||
|
|
||||||
return_or_puts JSON.dump(results).shellescape, inline: options[:inline]
|
return_or_puts JSON.dump(results).shellescape, inline: options[:inline]
|
||||||
end
|
end
|
||||||
@@ -21,8 +27,15 @@ class Kamal::Cli::Secrets < Kamal::Cli::Base
|
|||||||
return_or_puts value, inline: options[:inline]
|
return_or_puts value, inline: options[:inline]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "print", "Print the secrets (for debugging)"
|
||||||
|
def print
|
||||||
|
KAMAL.config.secrets.to_h.each do |key, value|
|
||||||
|
puts "#{key}=#{value}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def adapter(adapter)
|
def initialize_adapter(adapter)
|
||||||
Kamal::Secrets::Adapters.lookup(adapter)
|
Kamal::Secrets::Adapters.lookup(adapter)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -2,11 +2,26 @@
|
|||||||
service: my-app
|
service: my-app
|
||||||
|
|
||||||
# Name of the container image.
|
# Name of the container image.
|
||||||
image: user/my-app
|
image: my-user/my-app
|
||||||
|
|
||||||
# Deploy to these servers.
|
# Deploy to these servers.
|
||||||
servers:
|
servers:
|
||||||
|
web:
|
||||||
- 192.168.0.1
|
- 192.168.0.1
|
||||||
|
# job:
|
||||||
|
# hosts:
|
||||||
|
# - 192.168.0.1
|
||||||
|
# cmd: bin/jobs
|
||||||
|
|
||||||
|
# Enable SSL auto certification via Let's Encrypt and allow for multiple apps on a single web server.
|
||||||
|
# Remove this section when using multiple web servers and ensure you terminate SSL at your load balancer.
|
||||||
|
#
|
||||||
|
# Note: If using Cloudflare, set encryption mode in SSL/TLS setting to "Full" to enable CF-to-app encryption.
|
||||||
|
proxy:
|
||||||
|
ssl: true
|
||||||
|
host: app.example.com
|
||||||
|
# Proxy connects to your container on port 80 by default.
|
||||||
|
# app_port: 3000
|
||||||
|
|
||||||
# Credentials for your image host.
|
# Credentials for your image host.
|
||||||
registry:
|
registry:
|
||||||
@@ -14,27 +29,55 @@ registry:
|
|||||||
# server: registry.digitalocean.com / ghcr.io / ...
|
# server: registry.digitalocean.com / ghcr.io / ...
|
||||||
username: my-user
|
username: my-user
|
||||||
|
|
||||||
# Always use an access token rather than real password when possible.
|
# Always use an access token rather than real password (pulled from .kamal/secrets).
|
||||||
password:
|
password:
|
||||||
- KAMAL_REGISTRY_PASSWORD
|
- KAMAL_REGISTRY_PASSWORD
|
||||||
|
|
||||||
# Configure builder setup.
|
# Configure builder setup.
|
||||||
builder:
|
builder:
|
||||||
arch: amd64
|
arch: amd64
|
||||||
|
# Pass in additional build args needed for your Dockerfile.
|
||||||
|
# args:
|
||||||
|
# RUBY_VERSION: <%= ENV["RBENV_VERSION"] || ENV["rvm_ruby_string"] || "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}" %>
|
||||||
|
|
||||||
# Inject ENV variables into containers (secrets come from .env).
|
# Inject ENV variables into containers (secrets come from .kamal/secrets).
|
||||||
# Remember to run `kamal env push` after making changes!
|
#
|
||||||
# env:
|
# env:
|
||||||
# clear:
|
# clear:
|
||||||
# DB_HOST: 192.168.0.2
|
# DB_HOST: 192.168.0.2
|
||||||
# secret:
|
# secret:
|
||||||
# - RAILS_MASTER_KEY
|
# - RAILS_MASTER_KEY
|
||||||
|
|
||||||
|
# Aliases are triggered with "bin/kamal <alias>". You can overwrite arguments on invocation:
|
||||||
|
# "bin/kamal app logs -r job" will tail logs from the first server in the job section.
|
||||||
|
#
|
||||||
|
# aliases:
|
||||||
|
# shell: app exec --interactive --reuse "bash"
|
||||||
|
|
||||||
# Use a different ssh user than root
|
# Use a different ssh user than root
|
||||||
|
#
|
||||||
# ssh:
|
# ssh:
|
||||||
# user: app
|
# user: app
|
||||||
|
|
||||||
# Use accessory services (secrets come from .env).
|
# Use a persistent storage volume.
|
||||||
|
#
|
||||||
|
# volumes:
|
||||||
|
# - "app_storage:/app/storage"
|
||||||
|
|
||||||
|
# Bridge fingerprinted assets, like JS and CSS, between versions to avoid
|
||||||
|
# hitting 404 on in-flight requests. Combines all files from new and old
|
||||||
|
# version inside the asset_path.
|
||||||
|
#
|
||||||
|
# asset_path: /app/public/assets
|
||||||
|
|
||||||
|
# Configure rolling deploys by setting a wait time between batches of restarts.
|
||||||
|
#
|
||||||
|
# boot:
|
||||||
|
# limit: 10 # Can also specify as a percentage of total hosts, such as "25%"
|
||||||
|
# wait: 2
|
||||||
|
|
||||||
|
# Use accessory services (secrets come from .kamal/secrets).
|
||||||
|
#
|
||||||
# accessories:
|
# accessories:
|
||||||
# db:
|
# db:
|
||||||
# image: mysql:8.0
|
# image: mysql:8.0
|
||||||
@@ -51,34 +94,8 @@ builder:
|
|||||||
# directories:
|
# directories:
|
||||||
# - data:/var/lib/mysql
|
# - data:/var/lib/mysql
|
||||||
# redis:
|
# redis:
|
||||||
# image: redis:7.0
|
# image: valkey/valkey:8
|
||||||
# host: 192.168.0.2
|
# host: 192.168.0.2
|
||||||
# port: 6379
|
# port: 6379
|
||||||
# directories:
|
# directories:
|
||||||
# - data:/data
|
# - data:/data
|
||||||
|
|
||||||
# Bridge fingerprinted assets, like JS and CSS, between versions to avoid
|
|
||||||
# hitting 404 on in-flight requests. Combines all files from new and old
|
|
||||||
# version inside the asset_path.
|
|
||||||
#
|
|
||||||
# If your app is using the Sprockets gem, ensure it sets `config.assets.manifest`.
|
|
||||||
# See https://github.com/basecamp/kamal/issues/626 for details
|
|
||||||
#
|
|
||||||
# asset_path: /rails/public/assets
|
|
||||||
|
|
||||||
# Configure rolling deploys by setting a wait time between batches of restarts.
|
|
||||||
# boot:
|
|
||||||
# limit: 10 # Can also specify as a percentage of total hosts, such as "25%"
|
|
||||||
# wait: 2
|
|
||||||
|
|
||||||
# Configure the role used to determine the primary_host. This host takes
|
|
||||||
# deploy locks, runs health checks during the deploy, and follow logs, etc.
|
|
||||||
#
|
|
||||||
# Caution: there's no support for role renaming yet, so be careful to cleanup
|
|
||||||
# the previous role on the deployed hosts.
|
|
||||||
# primary_role: web
|
|
||||||
|
|
||||||
# Controls if we abort when see a role with no hosts. Disabling this may be
|
|
||||||
# useful for more complex deploy configurations.
|
|
||||||
#
|
|
||||||
# allow_empty_roles: false
|
|
||||||
|
|||||||
@@ -1,13 +1,3 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/bin/sh
|
||||||
|
|
||||||
# A sample docker-setup hook
|
echo "Docker set up on $KAMAL_HOSTS..."
|
||||||
#
|
|
||||||
# Sets up a Docker network on defined hosts which can then be used by the application’s containers
|
|
||||||
|
|
||||||
hosts = ENV["KAMAL_HOSTS"].split(",")
|
|
||||||
|
|
||||||
hosts.each do |ip|
|
|
||||||
destination = "root@#{ip}"
|
|
||||||
puts "Creating a Docker network \"kamal\" on #{destination}"
|
|
||||||
`ssh #{destination} docker network create kamal`
|
|
||||||
end
|
|
||||||
|
|||||||
3
lib/kamal/cli/templates/sample_hooks/post-app-boot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/post-app-boot.sample
Executable file
@@ -0,0 +1,3 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||||
3
lib/kamal/cli/templates/sample_hooks/pre-app-boot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/pre-app-boot.sample
Executable file
@@ -0,0 +1,3 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
echo "Rebooting Traefik on $KAMAL_HOSTS..."
|
echo "Rebooting kamal-proxy on $KAMAL_HOSTS..."
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
# WARNING: Avoid adding secrets directly to this file
|
# Secrets defined here are available for reference under registry/password, env/secret, builder/secrets,
|
||||||
# If you must, then add `.kamal/secrets*` to your .gitignore file
|
# and accessories/*/env/secret in config/deploy.yml. All secrets should be pulled from either
|
||||||
|
# password manager, ENV, or a file. DO NOT ENTER RAW CREDENTIALS HERE! This file needs to be safe for git.
|
||||||
|
|
||||||
# Option 1: Read secrets from the environment
|
# Option 1: Read secrets from the environment
|
||||||
KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||||
|
|||||||
@@ -4,13 +4,20 @@ require "active_support/core_ext/object/blank"
|
|||||||
|
|
||||||
class Kamal::Commander
|
class Kamal::Commander
|
||||||
attr_accessor :verbosity, :holding_lock, :connected
|
attr_accessor :verbosity, :holding_lock, :connected
|
||||||
|
attr_reader :specific_roles, :specific_hosts
|
||||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :proxy_hosts, :accessory_hosts, to: :specifics
|
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :proxy_hosts, :accessory_hosts, to: :specifics
|
||||||
|
|
||||||
def initialize
|
def initialize
|
||||||
|
reset
|
||||||
|
end
|
||||||
|
|
||||||
|
def reset
|
||||||
self.verbosity = :info
|
self.verbosity = :info
|
||||||
self.holding_lock = false
|
self.holding_lock = false
|
||||||
self.connected = false
|
self.connected = false
|
||||||
@specifics = nil
|
@specifics = @specific_roles = @specific_hosts = nil
|
||||||
|
@config = @config_kwargs = nil
|
||||||
|
@commands = {}
|
||||||
end
|
end
|
||||||
|
|
||||||
def config
|
def config
|
||||||
@@ -28,8 +35,6 @@ class Kamal::Commander
|
|||||||
@config || @config_kwargs
|
@config || @config_kwargs
|
||||||
end
|
end
|
||||||
|
|
||||||
attr_reader :specific_roles, :specific_hosts
|
|
||||||
|
|
||||||
def specific_primary!
|
def specific_primary!
|
||||||
@specifics = nil
|
@specifics = nil
|
||||||
if specific_roles.present?
|
if specific_roles.present?
|
||||||
@@ -76,11 +81,6 @@ class Kamal::Commander
|
|||||||
config.accessories&.collect(&:name) || []
|
config.accessories&.collect(&:name) || []
|
||||||
end
|
end
|
||||||
|
|
||||||
def accessories_on(host)
|
|
||||||
config.accessories.select { |accessory| accessory.hosts.include?(host.to_s) }.map(&:name)
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
def app(role: nil, host: nil)
|
def app(role: nil, host: nil)
|
||||||
Kamal::Commands::App.new(config, role: role, host: host)
|
Kamal::Commands::App.new(config, role: role, host: host)
|
||||||
end
|
end
|
||||||
@@ -94,42 +94,41 @@ class Kamal::Commander
|
|||||||
end
|
end
|
||||||
|
|
||||||
def builder
|
def builder
|
||||||
@builder ||= Kamal::Commands::Builder.new(config)
|
@commands[:builder] ||= Kamal::Commands::Builder.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def docker
|
def docker
|
||||||
@docker ||= Kamal::Commands::Docker.new(config)
|
@commands[:docker] ||= Kamal::Commands::Docker.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def hook
|
def hook
|
||||||
@hook ||= Kamal::Commands::Hook.new(config)
|
@commands[:hook] ||= Kamal::Commands::Hook.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def lock
|
def lock
|
||||||
@lock ||= Kamal::Commands::Lock.new(config)
|
@commands[:lock] ||= Kamal::Commands::Lock.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def proxy
|
def proxy
|
||||||
@proxy ||= Kamal::Commands::Proxy.new(config)
|
@commands[:proxy] ||= Kamal::Commands::Proxy.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def prune
|
def prune
|
||||||
@prune ||= Kamal::Commands::Prune.new(config)
|
@commands[:prune] ||= Kamal::Commands::Prune.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def registry
|
def registry
|
||||||
@registry ||= Kamal::Commands::Registry.new(config)
|
@commands[:registry] ||= Kamal::Commands::Registry.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def server
|
def server
|
||||||
@server ||= Kamal::Commands::Server.new(config)
|
@commands[:server] ||= Kamal::Commands::Server.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
def alias(name)
|
def alias(name)
|
||||||
config.aliases[name]
|
config.aliases[name]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def with_verbosity(level)
|
def with_verbosity(level)
|
||||||
old_level = self.verbosity
|
old_level = self.verbosity
|
||||||
|
|
||||||
@@ -142,14 +141,6 @@ class Kamal::Commander
|
|||||||
SSHKit.config.output_verbosity = old_level
|
SSHKit.config.output_verbosity = old_level
|
||||||
end
|
end
|
||||||
|
|
||||||
def boot_strategy
|
|
||||||
if config.boot.limit.present?
|
|
||||||
{ in: :groups, limit: config.boot.limit, wait: config.boot.wait }
|
|
||||||
else
|
|
||||||
{}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def holding_lock?
|
def holding_lock?
|
||||||
self.holding_lock
|
self.holding_lock
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -43,7 +43,12 @@ class Kamal::Commander::Specifics
|
|||||||
end
|
end
|
||||||
|
|
||||||
def specified_hosts
|
def specified_hosts
|
||||||
(specific_hosts || config.all_hosts) \
|
specified_hosts = specific_hosts || config.all_hosts
|
||||||
.select { |host| (specific_roles || config.roles).flat_map(&:hosts).include?(host) }
|
|
||||||
|
if (specific_role_hosts = specific_roles&.flat_map(&:hosts)).present?
|
||||||
|
specified_hosts.select { |host| specific_role_hosts.include?(host) }
|
||||||
|
else
|
||||||
|
specified_hosts
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,9 +1,12 @@
|
|||||||
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||||
|
include Proxy
|
||||||
|
|
||||||
attr_reader :accessory_config
|
attr_reader :accessory_config
|
||||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||||
:publish_args, :env_args, :volume_args, :label_args, :option_args,
|
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||||
:secrets_io, :secrets_path, :env_directory,
|
:secrets_io, :secrets_path, :env_directory, :proxy, :running_proxy?, :registry,
|
||||||
to: :accessory_config
|
to: :accessory_config
|
||||||
|
delegate :proxy_container_name, to: :config
|
||||||
|
|
||||||
def initialize(config, name:)
|
def initialize(config, name:)
|
||||||
super(config)
|
super(config)
|
||||||
@@ -15,7 +18,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
"--name", service_name,
|
"--name", service_name,
|
||||||
"--detach",
|
"--detach",
|
||||||
"--restart", "unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
"--network", "kamal",
|
*network_args,
|
||||||
*config.logging_args,
|
*config.logging_args,
|
||||||
*publish_args,
|
*publish_args,
|
||||||
*env_args,
|
*env_args,
|
||||||
@@ -38,7 +41,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
docker :ps, *service_filter
|
docker :ps, *service_filter
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||||
pipe \
|
pipe \
|
||||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||||
@@ -52,7 +54,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def execute_in_existing_container(*command, interactive: false)
|
def execute_in_existing_container(*command, interactive: false)
|
||||||
docker :exec,
|
docker :exec,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
@@ -64,7 +65,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
docker :run,
|
docker :run,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
"--rm",
|
"--rm",
|
||||||
"--network", "kamal",
|
*network_args,
|
||||||
*env_args,
|
*env_args,
|
||||||
*volume_args,
|
*volume_args,
|
||||||
image,
|
image,
|
||||||
@@ -83,7 +84,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
super command, host: hosts.first
|
super command, host: hosts.first
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def ensure_local_file_present(local_file)
|
def ensure_local_file_present(local_file)
|
||||||
if !local_file.is_a?(StringIO) && !Pathname.new(local_file).exist?
|
if !local_file.is_a?(StringIO) && !Pathname.new(local_file).exist?
|
||||||
raise "Missing file: #{local_file}"
|
raise "Missing file: #{local_file}"
|
||||||
|
|||||||
16
lib/kamal/commands/accessory/proxy.rb
Normal file
16
lib/kamal/commands/accessory/proxy.rb
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
module Kamal::Commands::Accessory::Proxy
|
||||||
|
delegate :proxy_container_name, to: :config
|
||||||
|
|
||||||
|
def deploy(target:)
|
||||||
|
proxy_exec :deploy, service_name, *proxy.deploy_command_args(target: target)
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove
|
||||||
|
proxy_exec :remove, service_name
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def proxy_exec(*command)
|
||||||
|
docker :exec, proxy_container_name, "kamal-proxy", *command
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -47,7 +47,7 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def info
|
def info
|
||||||
docker :ps, *filter_args
|
docker :ps, *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
|
|
||||||
def list_versions(*docker_args, statuses: nil)
|
def list_versions(*docker_args, statuses: nil)
|
||||||
pipe \
|
pipe \
|
||||||
docker(:ps, *filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
docker(:ps, *container_filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
||||||
extract_version_from_name
|
extract_version_from_name
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -91,11 +91,15 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def latest_container(format:, filters: nil)
|
def latest_container(format:, filters: nil)
|
||||||
docker :ps, "--latest", *format, *filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
docker :ps, "--latest", *format, *container_filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
||||||
end
|
end
|
||||||
|
|
||||||
def filter_args(statuses: nil)
|
def container_filter_args(statuses: nil)
|
||||||
argumentize "--filter", filters(statuses: statuses)
|
argumentize "--filter", container_filters(statuses: statuses)
|
||||||
|
end
|
||||||
|
|
||||||
|
def image_filter_args
|
||||||
|
argumentize "--filter", image_filters
|
||||||
end
|
end
|
||||||
|
|
||||||
def extract_version_from_name
|
def extract_version_from_name
|
||||||
@@ -103,13 +107,17 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
%(while read line; do echo ${line##{role.container_prefix}-}; done)
|
%(while read line; do echo ${line##{role.container_prefix}-}; done)
|
||||||
end
|
end
|
||||||
|
|
||||||
def filters(statuses: nil)
|
def container_filters(statuses: nil)
|
||||||
[ "label=service=#{config.service}" ].tap do |filters|
|
[ "label=service=#{config.service}" ].tap do |filters|
|
||||||
filters << "label=destination=#{config.destination}" if config.destination
|
filters << "label=destination=#{config.destination}"
|
||||||
filters << "label=role=#{role}" if role
|
filters << "label=role=#{role}" if role
|
||||||
statuses&.each do |status|
|
statuses&.each do |status|
|
||||||
filters << "status=#{status}"
|
filters << "status=#{status}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def image_filters
|
||||||
|
[ "label=service=#{config.service}" ]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,10 +4,10 @@ module Kamal::Commands::App::Assets
|
|||||||
|
|
||||||
combine \
|
combine \
|
||||||
make_directory(role.asset_extracted_directory),
|
make_directory(role.asset_extracted_directory),
|
||||||
[ *docker(:stop, "-t 1", asset_container, "2> /dev/null"), "|| true" ],
|
[ *docker(:container, :rm, asset_container, "2> /dev/null"), "|| true" ],
|
||||||
docker(:run, "--name", asset_container, "--detach", "--rm", "--entrypoint", "sleep", config.absolute_image, "1000000"),
|
docker(:container, :create, "--name", asset_container, config.absolute_image),
|
||||||
docker(:cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_directory),
|
docker(:container, :cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_directory),
|
||||||
docker(:stop, "-t 1", asset_container),
|
docker(:container, :rm, asset_container),
|
||||||
by: "&&"
|
by: "&&"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ module Kamal::Commands::App::Containers
|
|||||||
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
||||||
|
|
||||||
def list_containers
|
def list_containers
|
||||||
docker :container, :ls, "--all", *filter_args
|
docker :container, :ls, "--all", *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def list_container_names
|
def list_container_names
|
||||||
@@ -20,7 +20,7 @@ module Kamal::Commands::App::Containers
|
|||||||
end
|
end
|
||||||
|
|
||||||
def remove_containers
|
def remove_containers
|
||||||
docker :container, :prune, "--force", *filter_args
|
docker :container, :prune, "--force", *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def container_health_log(version:)
|
def container_health_log(version:)
|
||||||
|
|||||||
@@ -7,13 +7,15 @@ module Kamal::Commands::App::Execution
|
|||||||
*command
|
*command
|
||||||
end
|
end
|
||||||
|
|
||||||
def execute_in_new_container(*command, interactive: false, env:)
|
def execute_in_new_container(*command, interactive: false, detach: false, env:)
|
||||||
docker :run,
|
docker :run,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
"--rm",
|
("--detach" if detach),
|
||||||
|
("--rm" unless detach),
|
||||||
"--network", "kamal",
|
"--network", "kamal",
|
||||||
*role&.env_args(host),
|
*role&.env_args(host),
|
||||||
*argumentize("--env", env),
|
*argumentize("--env", env),
|
||||||
|
*role.logging_args,
|
||||||
*config.volume_args,
|
*config.volume_args,
|
||||||
*role&.option_args,
|
*role&.option_args,
|
||||||
config.absolute_image,
|
config.absolute_image,
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ module Kamal::Commands::App::Images
|
|||||||
end
|
end
|
||||||
|
|
||||||
def remove_images
|
def remove_images
|
||||||
docker :image, :prune, "--all", "--force", *filter_args
|
docker :image, :prune, "--all", "--force", *image_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def tag_latest_image
|
def tag_latest_image
|
||||||
|
|||||||
@@ -1,18 +1,28 @@
|
|||||||
module Kamal::Commands::App::Logging
|
module Kamal::Commands::App::Logging
|
||||||
def logs(version: nil, timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
def logs(container_id: nil, timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||||
pipe \
|
pipe \
|
||||||
version ? container_id_for_version(version) : current_running_container_id,
|
container_id_command(container_id),
|
||||||
"xargs docker logs#{" --timestamps" if timestamps}#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
|
"xargs docker logs#{" --timestamps" if timestamps}#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
|
||||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||||
end
|
end
|
||||||
|
|
||||||
def follow_logs(host:, timestamps: true, lines: nil, grep: nil, grep_options: nil)
|
def follow_logs(host:, container_id: nil, timestamps: true, lines: nil, grep: nil, grep_options: nil)
|
||||||
run_over_ssh \
|
run_over_ssh \
|
||||||
pipe(
|
pipe(
|
||||||
current_running_container_id,
|
container_id_command(container_id),
|
||||||
"xargs docker logs#{" --timestamps" if timestamps}#{" --tail #{lines}" if lines} --follow 2>&1",
|
"xargs docker logs#{" --timestamps" if timestamps}#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||||
),
|
),
|
||||||
host: host
|
host: host
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def container_id_command(container_id)
|
||||||
|
case container_id
|
||||||
|
when Array then container_id
|
||||||
|
when String, Symbol then "echo #{container_id}"
|
||||||
|
else current_running_container_id
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ module Kamal::Commands::App::Proxy
|
|||||||
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
||||||
end
|
end
|
||||||
|
|
||||||
def remove(target:)
|
def remove
|
||||||
proxy_exec :remove, role.container_prefix, *role.proxy.remove_command_args(target: target)
|
proxy_exec :remove, role.container_prefix
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
@@ -11,14 +11,7 @@ module Kamal::Commands
|
|||||||
end
|
end
|
||||||
|
|
||||||
def run_over_ssh(*command, host:)
|
def run_over_ssh(*command, host:)
|
||||||
"ssh".tap do |cmd|
|
"ssh#{ssh_proxy_args}#{ssh_keys_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
|
||||||
if config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Jump)
|
|
||||||
cmd << " -J #{config.ssh.proxy.jump_proxies}"
|
|
||||||
elsif config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Command)
|
|
||||||
cmd << " -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
|
|
||||||
end
|
|
||||||
cmd << " -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def container_id_for(container_name:, only_running: false)
|
def container_id_for(container_name:, only_running: false)
|
||||||
@@ -41,6 +34,12 @@ module Kamal::Commands
|
|||||||
[ :rm, path ]
|
[ :rm, path ]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ensure_docker_installed
|
||||||
|
combine \
|
||||||
|
ensure_local_docker_installed,
|
||||||
|
ensure_local_buildx_installed
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def combine(*commands, by: "&&")
|
def combine(*commands, by: "&&")
|
||||||
commands
|
commands
|
||||||
@@ -92,5 +91,32 @@ module Kamal::Commands
|
|||||||
def tags(**details)
|
def tags(**details)
|
||||||
Kamal::Tags.from_config(config, **details)
|
Kamal::Tags.from_config(config, **details)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ssh_proxy_args
|
||||||
|
case config.ssh.proxy
|
||||||
|
when Net::SSH::Proxy::Jump
|
||||||
|
" -J #{config.ssh.proxy.jump_proxies}"
|
||||||
|
when Net::SSH::Proxy::Command
|
||||||
|
" -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def ssh_keys_args
|
||||||
|
"#{ ssh_keys.join("") if ssh_keys}" + "#{" -o IdentitiesOnly=yes" if config.ssh&.keys_only}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def ssh_keys
|
||||||
|
config.ssh.keys&.map do |key|
|
||||||
|
" -i #{key}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def ensure_local_docker_installed
|
||||||
|
docker "--version"
|
||||||
|
end
|
||||||
|
|
||||||
|
def ensure_local_buildx_installed
|
||||||
|
docker :buildx, "version"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
require "active_support/core_ext/string/filters"
|
require "active_support/core_ext/string/filters"
|
||||||
|
|
||||||
class Kamal::Commands::Builder < Kamal::Commands::Base
|
class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||||
delegate :create, :remove, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
delegate :create, :remove, :dev, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
||||||
delegate :local?, :remote?, to: "config.builder"
|
delegate :local?, :remote?, :cloud?, to: "config.builder"
|
||||||
|
|
||||||
include Clone
|
include Clone
|
||||||
|
|
||||||
@@ -17,6 +17,8 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
|||||||
else
|
else
|
||||||
remote
|
remote
|
||||||
end
|
end
|
||||||
|
elsif cloud?
|
||||||
|
cloud
|
||||||
else
|
else
|
||||||
local
|
local
|
||||||
end
|
end
|
||||||
@@ -34,23 +36,7 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
|||||||
@hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
|
@hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def cloud
|
||||||
def ensure_local_dependencies_installed
|
@cloud ||= Kamal::Commands::Builder::Cloud.new(config)
|
||||||
if name.native?
|
|
||||||
ensure_local_docker_installed
|
|
||||||
else
|
|
||||||
combine \
|
|
||||||
ensure_local_docker_installed,
|
|
||||||
ensure_local_buildx_installed
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
def ensure_local_docker_installed
|
|
||||||
docker "--version"
|
|
||||||
end
|
|
||||||
|
|
||||||
def ensure_local_buildx_installed
|
|
||||||
docker :buildx, "version"
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,18 +6,19 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
delegate :argumentize, to: Kamal::Utils
|
delegate :argumentize, to: Kamal::Utils
|
||||||
delegate \
|
delegate \
|
||||||
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
||||||
:cache_from, :cache_to, :ssh, :driver, :docker_driver?,
|
:cache_from, :cache_to, :ssh, :provenance, :sbom, :driver, :docker_driver?,
|
||||||
to: :builder_config
|
to: :builder_config
|
||||||
|
|
||||||
def clean
|
def clean
|
||||||
docker :image, :rm, "--force", config.absolute_image
|
docker :image, :rm, "--force", config.absolute_image
|
||||||
end
|
end
|
||||||
|
|
||||||
def push
|
def push(export_action = "registry", tag_as_dirty: false)
|
||||||
docker :buildx, :build,
|
docker :buildx, :build,
|
||||||
"--push",
|
"--output=type=#{export_action}",
|
||||||
*platform_options(arches),
|
*platform_options(arches),
|
||||||
*([ "--builder", builder_name ] unless docker_driver?),
|
*([ "--builder", builder_name ] unless docker_driver?),
|
||||||
|
*build_tag_options(tag_as_dirty: tag_as_dirty),
|
||||||
*build_options,
|
*build_options,
|
||||||
build_context
|
build_context
|
||||||
end
|
end
|
||||||
@@ -37,7 +38,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def build_options
|
def build_options
|
||||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
|
[ *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_context
|
def build_context
|
||||||
@@ -58,8 +59,14 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def build_tags
|
def build_tag_names(tag_as_dirty: false)
|
||||||
[ "-t", config.absolute_image, "-t", config.latest_image ]
|
tag_names = [ config.absolute_image, config.latest_image ]
|
||||||
|
tag_names.map! { |t| "#{t}-dirty" } if tag_as_dirty
|
||||||
|
tag_names
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_tag_options(tag_as_dirty: false)
|
||||||
|
build_tag_names(tag_as_dirty: tag_as_dirty).flat_map { |name| [ "-t", name ] }
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_cache
|
def build_cache
|
||||||
@@ -97,6 +104,14 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
argumentize "--ssh", ssh if ssh.present?
|
argumentize "--ssh", ssh if ssh.present?
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def builder_provenance
|
||||||
|
argumentize "--provenance", provenance unless provenance.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
def builder_sbom
|
||||||
|
argumentize "--sbom", sbom unless sbom.nil?
|
||||||
|
end
|
||||||
|
|
||||||
def builder_config
|
def builder_config
|
||||||
config.builder
|
config.builder
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,29 +1,31 @@
|
|||||||
module Kamal::Commands::Builder::Clone
|
module Kamal::Commands::Builder::Clone
|
||||||
extend ActiveSupport::Concern
|
|
||||||
|
|
||||||
included do
|
|
||||||
delegate :clone_directory, :build_directory, to: :"config.builder"
|
|
||||||
end
|
|
||||||
|
|
||||||
def clone
|
def clone
|
||||||
git :clone, Kamal::Git.root, "--recurse-submodules", path: clone_directory
|
git :clone, escaped_root, "--recurse-submodules", path: config.builder.clone_directory.shellescape
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_reset_steps
|
def clone_reset_steps
|
||||||
[
|
[
|
||||||
git(:remote, "set-url", :origin, Kamal::Git.root, path: build_directory),
|
git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory),
|
||||||
git(:fetch, :origin, path: build_directory),
|
git(:fetch, :origin, path: escaped_build_directory),
|
||||||
git(:reset, "--hard", Kamal::Git.revision, path: build_directory),
|
git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory),
|
||||||
git(:clean, "-fdx", path: build_directory),
|
git(:clean, "-fdx", path: escaped_build_directory),
|
||||||
git(:submodule, :update, "--init", path: build_directory)
|
git(:submodule, :update, "--init", path: escaped_build_directory)
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_status
|
def clone_status
|
||||||
git :status, "--porcelain", path: build_directory
|
git :status, "--porcelain", path: escaped_build_directory
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_revision
|
def clone_revision
|
||||||
git :"rev-parse", :HEAD, path: build_directory
|
git :"rev-parse", :HEAD, path: escaped_build_directory
|
||||||
|
end
|
||||||
|
|
||||||
|
def escaped_root
|
||||||
|
Kamal::Git.root.shellescape
|
||||||
|
end
|
||||||
|
|
||||||
|
def escaped_build_directory
|
||||||
|
config.builder.build_directory.shellescape
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
22
lib/kamal/commands/builder/cloud.rb
Normal file
22
lib/kamal/commands/builder/cloud.rb
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
class Kamal::Commands::Builder::Cloud < Kamal::Commands::Builder::Base
|
||||||
|
# Expects `driver` to be of format "cloud docker-org-name/builder-name"
|
||||||
|
|
||||||
|
def create
|
||||||
|
docker :buildx, :create, "--driver", driver
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove
|
||||||
|
docker :buildx, :rm, builder_name
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def builder_name
|
||||||
|
driver.gsub(/[ \/]/, "-")
|
||||||
|
end
|
||||||
|
|
||||||
|
def inspect_buildx
|
||||||
|
pipe \
|
||||||
|
docker(:buildx, :inspect, builder_name),
|
||||||
|
grep("-q", "Endpoint:.*cloud://.*")
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -7,9 +7,8 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
|||||||
"--network", "kamal",
|
"--network", "kamal",
|
||||||
"--detach",
|
"--detach",
|
||||||
"--restart", "unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
*config.proxy_publish_args,
|
|
||||||
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
||||||
*config.logging_args,
|
"\$\(#{get_boot_options.join(" ")}\)",
|
||||||
config.proxy_image
|
config.proxy_image
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -65,6 +64,22 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
|||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ensure_proxy_directory
|
||||||
|
make_directory config.proxy_directory
|
||||||
|
end
|
||||||
|
|
||||||
|
def remove_proxy_directory
|
||||||
|
remove_directory config.proxy_directory
|
||||||
|
end
|
||||||
|
|
||||||
|
def get_boot_options
|
||||||
|
combine [ :cat, config.proxy_options_file ], [ :echo, "\"#{config.proxy_options_default.join(" ")}\"" ], by: "||"
|
||||||
|
end
|
||||||
|
|
||||||
|
def reset_boot_options
|
||||||
|
remove_file config.proxy_options_file
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def container_name
|
def container_name
|
||||||
config.proxy_container_name
|
config.proxy_container_name
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
class Kamal::Commands::Registry < Kamal::Commands::Base
|
class Kamal::Commands::Registry < Kamal::Commands::Base
|
||||||
delegate :registry, to: :config
|
def login(registry_config: nil)
|
||||||
|
registry_config ||= config.registry
|
||||||
|
|
||||||
def login
|
|
||||||
docker :login,
|
docker :login,
|
||||||
registry.server,
|
registry_config.server,
|
||||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry.username)),
|
"-u", sensitive(Kamal::Utils.escape_shell_value(registry_config.username)),
|
||||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry.password))
|
"-p", sensitive(Kamal::Utils.escape_shell_value(registry_config.password))
|
||||||
end
|
end
|
||||||
|
|
||||||
def logout
|
def logout(registry_config: nil)
|
||||||
docker :logout, registry.server
|
registry_config ||= config.registry
|
||||||
|
|
||||||
|
docker :logout, registry_config.server
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -14,12 +14,15 @@ class Kamal::Configuration
|
|||||||
|
|
||||||
include Validation
|
include Validation
|
||||||
|
|
||||||
PROXY_MINIMUM_VERSION = "v0.4.0"
|
PROXY_MINIMUM_VERSION = "v0.8.4"
|
||||||
PROXY_HTTP_PORT = 80
|
PROXY_HTTP_PORT = 80
|
||||||
PROXY_HTTPS_PORT = 443
|
PROXY_HTTPS_PORT = 443
|
||||||
|
PROXY_LOG_MAX_SIZE = "10m"
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
def create_from(config_file:, destination: nil, version: nil)
|
def create_from(config_file:, destination: nil, version: nil)
|
||||||
|
ENV["KAMAL_DESTINATION"] = destination
|
||||||
|
|
||||||
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
|
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
|
||||||
|
|
||||||
new raw_config, destination: destination, version: version
|
new raw_config, destination: destination, version: version
|
||||||
@@ -34,7 +37,7 @@ class Kamal::Configuration
|
|||||||
if file.exist?
|
if file.exist?
|
||||||
# Newer Psych doesn't load aliases by default
|
# Newer Psych doesn't load aliases by default
|
||||||
load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
|
load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
|
||||||
YAML.send(load_method, ERB.new(IO.read(file)).result).symbolize_keys
|
YAML.send(load_method, ERB.new(File.read(file)).result).symbolize_keys
|
||||||
else
|
else
|
||||||
raise "Configuration file not found in #{file}"
|
raise "Configuration file not found in #{file}"
|
||||||
end
|
end
|
||||||
@@ -56,7 +59,7 @@ class Kamal::Configuration
|
|||||||
|
|
||||||
# Eager load config to validate it, these are first as they have dependencies later on
|
# Eager load config to validate it, these are first as they have dependencies later on
|
||||||
@servers = Servers.new(config: self)
|
@servers = Servers.new(config: self)
|
||||||
@registry = Registry.new(config: self)
|
@registry = Registry.new(config: @raw_config, secrets: secrets)
|
||||||
|
|
||||||
@accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
|
@accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
|
||||||
@aliases = @raw_config.aliases&.keys&.to_h { |name| [ name, Alias.new(name, config: self) ] } || {}
|
@aliases = @raw_config.aliases&.keys&.to_h { |name| [ name, Alias.new(name, config: self) ] } || {}
|
||||||
@@ -79,7 +82,6 @@ class Kamal::Configuration
|
|||||||
ensure_unique_hosts_for_ssl_roles
|
ensure_unique_hosts_for_ssl_roles
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def version=(version)
|
def version=(version)
|
||||||
@declared_version = version
|
@declared_version = version
|
||||||
end
|
end
|
||||||
@@ -103,7 +105,6 @@ class Kamal::Configuration
|
|||||||
raw_config.minimum_version
|
raw_config.minimum_version
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def roles
|
def roles
|
||||||
servers.roles
|
servers.roles
|
||||||
end
|
end
|
||||||
@@ -116,7 +117,6 @@ class Kamal::Configuration
|
|||||||
accessories.detect { |a| a.name == name.to_s }
|
accessories.detect { |a| a.name == name.to_s }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def all_hosts
|
def all_hosts
|
||||||
(roles + accessories).flat_map(&:hosts).uniq
|
(roles + accessories).flat_map(&:hosts).uniq
|
||||||
end
|
end
|
||||||
@@ -177,7 +177,6 @@ class Kamal::Configuration
|
|||||||
raw_config.retain_containers || 5
|
raw_config.retain_containers || 5
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def volume_args
|
def volume_args
|
||||||
if raw_config.volumes.present?
|
if raw_config.volumes.present?
|
||||||
argumentize "--volume", raw_config.volumes
|
argumentize "--volume", raw_config.volumes
|
||||||
@@ -190,7 +189,6 @@ class Kamal::Configuration
|
|||||||
logging.args
|
logging.args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def readiness_delay
|
def readiness_delay
|
||||||
raw_config.readiness_delay || 7
|
raw_config.readiness_delay || 7
|
||||||
end
|
end
|
||||||
@@ -203,7 +201,6 @@ class Kamal::Configuration
|
|||||||
raw_config.drain_timeout || 30
|
raw_config.drain_timeout || 30
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def run_directory
|
def run_directory
|
||||||
".kamal"
|
".kamal"
|
||||||
end
|
end
|
||||||
@@ -224,7 +221,6 @@ class Kamal::Configuration
|
|||||||
File.join app_directory, "assets"
|
File.join app_directory, "assets"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def hooks_path
|
def hooks_path
|
||||||
raw_config.hooks_path || ".kamal/hooks"
|
raw_config.hooks_path || ".kamal/hooks"
|
||||||
end
|
end
|
||||||
@@ -233,7 +229,6 @@ class Kamal::Configuration
|
|||||||
raw_config.asset_path
|
raw_config.asset_path
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def env_tags
|
def env_tags
|
||||||
@env_tags ||= if (tags = raw_config.env["tags"])
|
@env_tags ||= if (tags = raw_config.env["tags"])
|
||||||
tags.collect { |name, config| Env::Tag.new(name, config: config, secrets: secrets) }
|
tags.collect { |name, config| Env::Tag.new(name, config: config, secrets: secrets) }
|
||||||
@@ -246,8 +241,24 @@ class Kamal::Configuration
|
|||||||
env_tags.detect { |t| t.name == name.to_s }
|
env_tags.detect { |t| t.name == name.to_s }
|
||||||
end
|
end
|
||||||
|
|
||||||
def proxy_publish_args
|
def proxy_publish_args(http_port, https_port, bind_ips = nil)
|
||||||
argumentize "--publish", [ "#{PROXY_HTTP_PORT}:#{PROXY_HTTP_PORT}", "#{PROXY_HTTPS_PORT}:#{PROXY_HTTPS_PORT}" ]
|
ensure_valid_bind_ips(bind_ips)
|
||||||
|
|
||||||
|
(bind_ips || [ nil ]).map do |bind_ip|
|
||||||
|
bind_ip = format_bind_ip(bind_ip)
|
||||||
|
publish_http = [ bind_ip, http_port, PROXY_HTTP_PORT ].compact.join(":")
|
||||||
|
publish_https = [ bind_ip, https_port, PROXY_HTTPS_PORT ].compact.join(":")
|
||||||
|
|
||||||
|
argumentize "--publish", [ publish_http, publish_https ]
|
||||||
|
end.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
def proxy_logging_args(max_size)
|
||||||
|
argumentize "--log-opt", "max-size=#{max_size}" if max_size.present?
|
||||||
|
end
|
||||||
|
|
||||||
|
def proxy_options_default
|
||||||
|
[ *proxy_publish_args(PROXY_HTTP_PORT, PROXY_HTTPS_PORT), *proxy_logging_args(PROXY_LOG_MAX_SIZE) ]
|
||||||
end
|
end
|
||||||
|
|
||||||
def proxy_image
|
def proxy_image
|
||||||
@@ -258,6 +269,13 @@ class Kamal::Configuration
|
|||||||
"kamal-proxy"
|
"kamal-proxy"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def proxy_directory
|
||||||
|
File.join run_directory, "proxy"
|
||||||
|
end
|
||||||
|
|
||||||
|
def proxy_options_file
|
||||||
|
File.join proxy_directory, "options"
|
||||||
|
end
|
||||||
|
|
||||||
def to_h
|
def to_h
|
||||||
{
|
{
|
||||||
@@ -325,6 +343,15 @@ class Kamal::Configuration
|
|||||||
true
|
true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ensure_valid_bind_ips(bind_ips)
|
||||||
|
bind_ips.present? && bind_ips.each do |ip|
|
||||||
|
next if ip =~ Resolv::IPv4::Regex || ip =~ Resolv::IPv6::Regex
|
||||||
|
raise ArgumentError, "Invalid publish IP address: #{ip}"
|
||||||
|
end
|
||||||
|
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
def ensure_retain_containers_valid
|
def ensure_retain_containers_valid
|
||||||
raise Kamal::ConfigurationError, "Must retain at least 1 container" if retain_containers < 1
|
raise Kamal::ConfigurationError, "Must retain at least 1 container" if retain_containers < 1
|
||||||
|
|
||||||
@@ -348,7 +375,7 @@ class Kamal::Configuration
|
|||||||
end
|
end
|
||||||
|
|
||||||
def ensure_unique_hosts_for_ssl_roles
|
def ensure_unique_hosts_for_ssl_roles
|
||||||
hosts = roles.select(&:ssl?).map { |role| role.proxy.host }
|
hosts = roles.select(&:ssl?).flat_map { |role| role.proxy.hosts }
|
||||||
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
|
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
|
||||||
|
|
||||||
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
||||||
@@ -356,6 +383,15 @@ class Kamal::Configuration
|
|||||||
true
|
true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def format_bind_ip(ip)
|
||||||
|
# Ensure IPv6 address inside square brackets - e.g. [::1]
|
||||||
|
if ip =~ Resolv::IPv6::Regex && ip !~ /\[.*\]/
|
||||||
|
"[#{ip}]"
|
||||||
|
else
|
||||||
|
ip
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def role_names
|
def role_names
|
||||||
raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
|
raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
class Kamal::Configuration::Accessory
|
class Kamal::Configuration::Accessory
|
||||||
include Kamal::Configuration::Validation
|
include Kamal::Configuration::Validation
|
||||||
|
|
||||||
|
DEFAULT_NETWORK = "kamal"
|
||||||
|
|
||||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||||
|
|
||||||
attr_reader :name, :accessory_config, :env
|
attr_reader :name, :env, :proxy, :registry
|
||||||
|
|
||||||
def initialize(name, config:)
|
def initialize(name, config:)
|
||||||
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
||||||
@@ -14,10 +16,11 @@ class Kamal::Configuration::Accessory
|
|||||||
context: "accessories/#{name}",
|
context: "accessories/#{name}",
|
||||||
with: Kamal::Configuration::Validator::Accessory
|
with: Kamal::Configuration::Validator::Accessory
|
||||||
|
|
||||||
@env = Kamal::Configuration::Env.new \
|
ensure_valid_roles
|
||||||
config: accessory_config.fetch("env", {}),
|
|
||||||
secrets: config.secrets,
|
@env = initialize_env
|
||||||
context: "accessories/#{name}/env"
|
@proxy = initialize_proxy if running_proxy?
|
||||||
|
@registry = initialize_registry if accessory_config["registry"].present?
|
||||||
end
|
end
|
||||||
|
|
||||||
def service_name
|
def service_name
|
||||||
@@ -25,7 +28,7 @@ class Kamal::Configuration::Accessory
|
|||||||
end
|
end
|
||||||
|
|
||||||
def image
|
def image
|
||||||
accessory_config["image"]
|
[ registry&.server, accessory_config["image"] ].compact.join("/")
|
||||||
end
|
end
|
||||||
|
|
||||||
def hosts
|
def hosts
|
||||||
@@ -38,6 +41,10 @@ class Kamal::Configuration::Accessory
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def network_args
|
||||||
|
argumentize "--network", network
|
||||||
|
end
|
||||||
|
|
||||||
def publish_args
|
def publish_args
|
||||||
argumentize "--publish", port if port
|
argumentize "--publish", port if port
|
||||||
end
|
end
|
||||||
@@ -100,8 +107,33 @@ class Kamal::Configuration::Accessory
|
|||||||
accessory_config["cmd"]
|
accessory_config["cmd"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def running_proxy?
|
||||||
|
accessory_config["proxy"].present?
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
attr_accessor :config
|
attr_reader :config, :accessory_config
|
||||||
|
|
||||||
|
def initialize_env
|
||||||
|
Kamal::Configuration::Env.new \
|
||||||
|
config: accessory_config.fetch("env", {}),
|
||||||
|
secrets: config.secrets,
|
||||||
|
context: "accessories/#{name}/env"
|
||||||
|
end
|
||||||
|
|
||||||
|
def initialize_proxy
|
||||||
|
Kamal::Configuration::Proxy.new \
|
||||||
|
config: config,
|
||||||
|
proxy_config: accessory_config["proxy"],
|
||||||
|
context: "accessories/#{name}/proxy"
|
||||||
|
end
|
||||||
|
|
||||||
|
def initialize_registry
|
||||||
|
Kamal::Configuration::Registry.new \
|
||||||
|
config: accessory_config,
|
||||||
|
secrets: config.secrets,
|
||||||
|
context: "accessories/#{name}/registry"
|
||||||
|
end
|
||||||
|
|
||||||
def default_labels
|
def default_labels
|
||||||
{ "service" => service_name }
|
{ "service" => service_name }
|
||||||
@@ -123,7 +155,7 @@ class Kamal::Configuration::Accessory
|
|||||||
end
|
end
|
||||||
|
|
||||||
def read_dynamic_file(local_file)
|
def read_dynamic_file(local_file)
|
||||||
StringIO.new(ERB.new(IO.read(local_file)).result)
|
StringIO.new(ERB.new(File.read(local_file)).result)
|
||||||
end
|
end
|
||||||
|
|
||||||
def expand_remote_file(remote_file)
|
def expand_remote_file(remote_file)
|
||||||
@@ -170,7 +202,17 @@ class Kamal::Configuration::Accessory
|
|||||||
|
|
||||||
def hosts_from_roles
|
def hosts_from_roles
|
||||||
if accessory_config.key?("roles")
|
if accessory_config.key?("roles")
|
||||||
accessory_config["roles"].flat_map { |role| config.role(role).hosts }
|
accessory_config["roles"].flat_map { |role| config.role(role)&.hosts }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def network
|
||||||
|
accessory_config["network"] || DEFAULT_NETWORK
|
||||||
|
end
|
||||||
|
|
||||||
|
def ensure_valid_roles
|
||||||
|
if accessory_config["roles"] && (missing_roles = accessory_config["roles"] - config.roles.map(&:name)).any?
|
||||||
|
raise Kamal::ConfigurationError, "accessories/#{name}: unknown roles #{missing_roles.join(", ")}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -53,6 +53,10 @@ class Kamal::Configuration::Builder
|
|||||||
!local_disabled? && (arches.empty? || local_arches.any?)
|
!local_disabled? && (arches.empty? || local_arches.any?)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def cloud?
|
||||||
|
driver.start_with? "cloud"
|
||||||
|
end
|
||||||
|
|
||||||
def cached?
|
def cached?
|
||||||
!!builder_config["cache"]
|
!!builder_config["cache"]
|
||||||
end
|
end
|
||||||
@@ -111,6 +115,14 @@ class Kamal::Configuration::Builder
|
|||||||
builder_config["ssh"]
|
builder_config["ssh"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def provenance
|
||||||
|
builder_config["provenance"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def sbom
|
||||||
|
builder_config["sbom"]
|
||||||
|
end
|
||||||
|
|
||||||
def git_clone?
|
def git_clone?
|
||||||
Kamal::Git.used? && builder_config["context"].nil?
|
Kamal::Git.used? && builder_config["context"].nil?
|
||||||
end
|
end
|
||||||
@@ -166,7 +178,7 @@ class Kamal::Configuration::Builder
|
|||||||
end
|
end
|
||||||
|
|
||||||
def cache_to_config_for_registry
|
def cache_to_config_for_registry
|
||||||
[ "type=registry", builder_config["cache"]&.fetch("options", nil), "ref=#{cache_image_ref}" ].compact.join(",")
|
[ "type=registry", "ref=#{cache_image_ref}", builder_config["cache"]&.fetch("options", nil) ].compact.join(",")
|
||||||
end
|
end
|
||||||
|
|
||||||
def repo_basename
|
def repo_basename
|
||||||
|
|||||||
@@ -3,32 +3,50 @@
|
|||||||
# Accessories can be booted on a single host, a list of hosts, or on specific roles.
|
# Accessories can be booted on a single host, a list of hosts, or on specific roles.
|
||||||
# The hosts do not need to be defined in the Kamal servers configuration.
|
# The hosts do not need to be defined in the Kamal servers configuration.
|
||||||
#
|
#
|
||||||
# Accessories are managed separately from the main service - they are not updated
|
# Accessories are managed separately from the main service — they are not updated
|
||||||
# when you deploy and they do not have zero-downtime deployments.
|
# when you deploy, and they do not have zero-downtime deployments.
|
||||||
#
|
#
|
||||||
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
||||||
# See `kamal accessory --help` for more information.
|
# See `kamal accessory --help` for more information.
|
||||||
|
|
||||||
# Configuring accessories
|
# Configuring accessories
|
||||||
#
|
#
|
||||||
# First define the accessory in the `accessories`
|
# First, define the accessory in the `accessories`:
|
||||||
accessories:
|
accessories:
|
||||||
mysql:
|
mysql:
|
||||||
|
|
||||||
# Service name
|
# Service name
|
||||||
#
|
#
|
||||||
# This is used in the service label and defaults to `<service>-<accessory>`
|
# This is used in the service label and defaults to `<service>-<accessory>`,
|
||||||
# where `<service>` is the main service name from the root configuration
|
# where `<service>` is the main service name from the root configuration:
|
||||||
service: mysql
|
service: mysql
|
||||||
|
|
||||||
# Image
|
# Image
|
||||||
#
|
#
|
||||||
# The Docker image to use, prefix with a registry if not using Docker hub
|
# The Docker image to use.
|
||||||
|
# Prefix it with its server when using root level registry different from Docker Hub.
|
||||||
|
# Define registry directly or via anchors when it differs from root level registry.
|
||||||
image: mysql:8.0
|
image: mysql:8.0
|
||||||
|
|
||||||
|
# Registry
|
||||||
|
#
|
||||||
|
# By default accessories use Docker Hub registry.
|
||||||
|
# You can specify different registry per accessory with this option.
|
||||||
|
# Don't prefix image with this registry server.
|
||||||
|
# Use anchors if you need to set the same specific registry for several accessories.
|
||||||
|
#
|
||||||
|
# ```yml
|
||||||
|
# registry:
|
||||||
|
# <<: *specific-registry
|
||||||
|
# ```
|
||||||
|
#
|
||||||
|
# See kamal docs registry for more information:
|
||||||
|
registry:
|
||||||
|
...
|
||||||
|
|
||||||
# Accessory hosts
|
# Accessory hosts
|
||||||
#
|
#
|
||||||
# Specify one of `host`, `hosts` or `roles`
|
# Specify one of `host`, `hosts`, or `roles`:
|
||||||
host: mysql-db1
|
host: mysql-db1
|
||||||
hosts:
|
hosts:
|
||||||
- mysql-db1
|
- mysql-db1
|
||||||
@@ -38,13 +56,13 @@ accessories:
|
|||||||
|
|
||||||
# Custom command
|
# Custom command
|
||||||
#
|
#
|
||||||
# You can set a custom command to run in the container, if you do not want to use the default
|
# You can set a custom command to run in the container if you do not want to use the default:
|
||||||
cmd: "bin/mysqld"
|
cmd: "bin/mysqld"
|
||||||
|
|
||||||
# Port mappings
|
# Port mappings
|
||||||
#
|
#
|
||||||
# See https://docs.docker.com/network/, especially note the warning about the security
|
# See [https://docs.docker.com/network/](https://docs.docker.com/network/), and
|
||||||
# implications of exposing ports publicly.
|
# especially note the warning about the security implications of exposing ports publicly.
|
||||||
port: "127.0.0.1:3306:3306"
|
port: "127.0.0.1:3306:3306"
|
||||||
|
|
||||||
# Labels
|
# Labels
|
||||||
@@ -52,20 +70,22 @@ accessories:
|
|||||||
app: myapp
|
app: myapp
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
# These are passed to the Docker run command in the form `--<name> <value>`
|
#
|
||||||
|
# These are passed to the Docker run command in the form `--<name> <value>`:
|
||||||
options:
|
options:
|
||||||
restart: always
|
restart: always
|
||||||
cpus: 2
|
cpus: 2
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
# See kamal docs env for more information
|
#
|
||||||
|
# See kamal docs env for more information:
|
||||||
env:
|
env:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Copying files
|
# Copying files
|
||||||
#
|
#
|
||||||
# You can specify files to mount into the container.
|
# You can specify files to mount into the container.
|
||||||
# The format is `local:remote` where `local` is the path to the file on the local machine
|
# The format is `local:remote`, where `local` is the path to the file on the local machine
|
||||||
# and `remote` is the path to the file in the container.
|
# and `remote` is the path to the file in the container.
|
||||||
#
|
#
|
||||||
# They will be uploaded from the local repo to the host and then mounted.
|
# They will be uploaded from the local repo to the host and then mounted.
|
||||||
@@ -78,13 +98,26 @@ accessories:
|
|||||||
# Directories
|
# Directories
|
||||||
#
|
#
|
||||||
# You can specify directories to mount into the container. They will be created on the host
|
# You can specify directories to mount into the container. They will be created on the host
|
||||||
# before being mounted
|
# before being mounted:
|
||||||
directories:
|
directories:
|
||||||
- mysql-logs:/var/log/mysql
|
- mysql-logs:/var/log/mysql
|
||||||
|
|
||||||
# Volumes
|
# Volumes
|
||||||
#
|
#
|
||||||
# Any other volumes to mount, in addition to the files and directories.
|
# Any other volumes to mount, in addition to the files and directories.
|
||||||
# They are not created or copied before mounting
|
# They are not created or copied before mounting:
|
||||||
volumes:
|
volumes:
|
||||||
- /path/to/mysql-logs:/var/log/mysql
|
- /path/to/mysql-logs:/var/log/mysql
|
||||||
|
|
||||||
|
# Network
|
||||||
|
#
|
||||||
|
# The network the accessory will be attached to.
|
||||||
|
#
|
||||||
|
# Defaults to kamal:
|
||||||
|
network: custom
|
||||||
|
|
||||||
|
# Proxy
|
||||||
|
#
|
||||||
|
# You can run your accessory behind the Kamal proxy. See kamal docs proxy for more information
|
||||||
|
proxy:
|
||||||
|
...
|
||||||
|
|||||||
@@ -5,22 +5,22 @@
|
|||||||
# For example, for a Rails app, you might open a console with:
|
# For example, for a Rails app, you might open a console with:
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# kamal app exec -i -r console "rails console"
|
# kamal app exec -i --reuse "bin/rails console"
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# By defining an alias, like this:
|
# By defining an alias, like this:
|
||||||
aliases:
|
aliases:
|
||||||
console: app exec -r console -i "rails console"
|
console: app exec -i --reuse "bin/rails console"
|
||||||
# You can now open the console with:
|
# You can now open the console with:
|
||||||
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# kamal console
|
# kamal console
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
# Configuring aliases
|
# Configuring aliases
|
||||||
#
|
#
|
||||||
# Aliases are defined in the root config under the alias key
|
# Aliases are defined in the root config under the alias key.
|
||||||
#
|
#
|
||||||
# Each alias is named and can only contain lowercase letters, numbers, dashes and underscores.
|
# Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores:
|
||||||
|
|
||||||
aliases:
|
aliases:
|
||||||
uname: app exec -p -q -r web "uname -a"
|
uname: app exec -p -q -r web "uname -a"
|
||||||
|
|||||||
@@ -2,18 +2,18 @@
|
|||||||
#
|
#
|
||||||
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
||||||
#
|
#
|
||||||
# Kamal’s default is to boot new containers on all hosts in parallel. But you can control this with the boot configuration.
|
# Kamal’s default is to boot new containers on all hosts in parallel. However, you can control this with the boot configuration.
|
||||||
|
|
||||||
# Fixed group sizes
|
# Fixed group sizes
|
||||||
#
|
#
|
||||||
# Here we boot 2 hosts at a time with a 10 second gap between each group.
|
# Here, we boot 2 hosts at a time with a 10-second gap between each group:
|
||||||
boot:
|
boot:
|
||||||
limit: 2
|
limit: 2
|
||||||
wait: 10
|
wait: 10
|
||||||
|
|
||||||
# Percentage of hosts
|
# Percentage of hosts
|
||||||
#
|
#
|
||||||
# Here we boot 25% of the hosts at a time with a 2 second gap between each group.
|
# Here, we boot 25% of the hosts at a time with a 2-second gap between each group:
|
||||||
boot:
|
boot:
|
||||||
limit: 25%
|
limit: 25%
|
||||||
wait: 2
|
wait: 2
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Builder
|
# Builder
|
||||||
#
|
#
|
||||||
# The builder configuration controls how the application is built with `docker build`
|
# The builder configuration controls how the application is built with `docker build`.
|
||||||
#
|
#
|
||||||
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information
|
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information.
|
||||||
|
|
||||||
# Builder options
|
# Builder options
|
||||||
#
|
#
|
||||||
@@ -11,15 +11,15 @@ builder:
|
|||||||
|
|
||||||
# Arch
|
# Arch
|
||||||
#
|
#
|
||||||
# The architectures to build for - you can set an array or just a single value.
|
# The architectures to build for — you can set an array or just a single value.
|
||||||
#
|
#
|
||||||
# Allowed values are `amd64` and `arm64`
|
# Allowed values are `amd64` and `arm64`:
|
||||||
arch:
|
arch:
|
||||||
- amd64
|
- amd64
|
||||||
|
|
||||||
# Remote
|
# Remote
|
||||||
#
|
#
|
||||||
# The connection string for a remote builder. If supplied Kamal will use this
|
# The connection string for a remote builder. If supplied, Kamal will use this
|
||||||
# for builds that do not match the local architecture of the deployment host.
|
# for builds that do not match the local architecture of the deployment host.
|
||||||
remote: ssh://docker@docker-builder
|
remote: ssh://docker@docker-builder
|
||||||
|
|
||||||
@@ -28,14 +28,14 @@ builder:
|
|||||||
# If set to false, Kamal will always use the remote builder even when building
|
# If set to false, Kamal will always use the remote builder even when building
|
||||||
# the local architecture.
|
# the local architecture.
|
||||||
#
|
#
|
||||||
# Defaults to true
|
# Defaults to true:
|
||||||
local: true
|
local: true
|
||||||
|
|
||||||
# Builder cache
|
# Builder cache
|
||||||
#
|
#
|
||||||
# The type must be either 'gha' or 'registry'
|
# The type must be either 'gha' or 'registry'.
|
||||||
#
|
#
|
||||||
# The image is only used for registry cache. Not compatible with the docker driver
|
# The image is only used for registry cache and is not compatible with the Docker driver:
|
||||||
cache:
|
cache:
|
||||||
type: registry
|
type: registry
|
||||||
options: mode=max
|
options: mode=max
|
||||||
@@ -43,25 +43,25 @@ builder:
|
|||||||
|
|
||||||
# Build context
|
# Build context
|
||||||
#
|
#
|
||||||
# If this is not set, then a local git clone of the repo is used.
|
# If this is not set, then a local Git clone of the repo is used.
|
||||||
# This ensures a clean build with no uncommitted changes.
|
# This ensures a clean build with no uncommitted changes.
|
||||||
#
|
#
|
||||||
# To use the local checkout instead you can set the context to `.`, or a path to another directory.
|
# To use the local checkout instead, you can set the context to `.`, or a path to another directory.
|
||||||
context: .
|
context: .
|
||||||
|
|
||||||
# Dockerfile
|
# Dockerfile
|
||||||
#
|
#
|
||||||
# The Dockerfile to use for building, defaults to `Dockerfile`
|
# The Dockerfile to use for building, defaults to `Dockerfile`:
|
||||||
dockerfile: Dockerfile.production
|
dockerfile: Dockerfile.production
|
||||||
|
|
||||||
# Build target
|
# Build target
|
||||||
#
|
#
|
||||||
# If not set, then the default target is used
|
# If not set, then the default target is used:
|
||||||
target: production
|
target: production
|
||||||
|
|
||||||
# Build Arguments
|
# Build arguments
|
||||||
#
|
#
|
||||||
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`
|
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`:
|
||||||
args:
|
args:
|
||||||
ENVIRONMENT: production
|
ENVIRONMENT: production
|
||||||
|
|
||||||
@@ -74,33 +74,46 @@ builder:
|
|||||||
|
|
||||||
# Build secrets
|
# Build secrets
|
||||||
#
|
#
|
||||||
# Values are read from .kamal/secrets.
|
# Values are read from `.kamal/secrets`:
|
||||||
#
|
|
||||||
secrets:
|
secrets:
|
||||||
- SECRET1
|
- SECRET1
|
||||||
- SECRET2
|
- SECRET2
|
||||||
|
|
||||||
# Referencing Build Secrets
|
# Referencing build secrets
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# # Copy Gemfiles
|
# # Copy Gemfiles
|
||||||
# COPY Gemfile Gemfile.lock ./
|
# COPY Gemfile Gemfile.lock ./
|
||||||
#
|
#
|
||||||
# # Install dependencies, including private repositories via access token
|
# # Install dependencies, including private repositories via access token
|
||||||
# # Then remove bundle cache with exposed GITHUB_TOKEN)
|
# # Then remove bundle cache with exposed GITHUB_TOKEN
|
||||||
# RUN --mount=type=secret,id=GITHUB_TOKEN \
|
# RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||||
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||||
# bundle install && \
|
# bundle install && \
|
||||||
# rm -rf /usr/local/bundle/cache
|
# rm -rf /usr/local/bundle/cache
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
|
|
||||||
# SSH
|
# SSH
|
||||||
#
|
#
|
||||||
# SSH agent socket or keys to expose to the build
|
# SSH agent socket or keys to expose to the build:
|
||||||
ssh: default=$SSH_AUTH_SOCK
|
ssh: default=$SSH_AUTH_SOCK
|
||||||
|
|
||||||
# Driver
|
# Driver
|
||||||
#
|
#
|
||||||
# The build driver to use, defaults to `docker-container`
|
# The build driver to use, defaults to `docker-container`:
|
||||||
driver: docker
|
driver: docker
|
||||||
|
#
|
||||||
|
# If you want to use Docker Build Cloud (https://www.docker.com/products/build-cloud/), you can set the driver to:
|
||||||
|
driver: cloud org-name/builder-name
|
||||||
|
|
||||||
|
# Provenance
|
||||||
|
#
|
||||||
|
# It is used to configure provenance attestations for the build result.
|
||||||
|
# The value can also be a boolean to enable or disable provenance attestations.
|
||||||
|
provenance: mode=max
|
||||||
|
|
||||||
|
# SBOM (Software Bill of Materials)
|
||||||
|
#
|
||||||
|
# It is used to configure SBOM generation for the build result.
|
||||||
|
# The value can also be a boolean to enable or disable SBOM generation.
|
||||||
|
sbom: true
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
# Kamal Configuration
|
# Kamal Configuration
|
||||||
#
|
#
|
||||||
# Configuration is read from the `config/deploy.yml`
|
# Configuration is read from the `config/deploy.yml`.
|
||||||
#
|
|
||||||
|
|
||||||
# Destinations
|
# Destinations
|
||||||
#
|
#
|
||||||
# When running commands, you can specify a destination with the `-d` flag,
|
# When running commands, you can specify a destination with the `-d` flag,
|
||||||
# e.g. `kamal deploy -d staging`
|
# e.g., `kamal deploy -d staging`.
|
||||||
#
|
#
|
||||||
# In this case the configuration will also be read from `config/deploy.staging.yml`
|
# In this case, the configuration will also be read from `config/deploy.staging.yml`
|
||||||
# and merged with the base configuration.
|
# and merged with the base configuration.
|
||||||
|
|
||||||
# Extensions
|
# Extensions
|
||||||
@@ -18,10 +17,11 @@
|
|||||||
# However, you might want to declare a configuration block using YAML anchors
|
# However, you might want to declare a configuration block using YAML anchors
|
||||||
# and aliases to avoid repetition.
|
# and aliases to avoid repetition.
|
||||||
#
|
#
|
||||||
# You can use prefix a configuration section with `x-` to indicate that it is an
|
# You can prefix a configuration section with `x-` to indicate that it is an
|
||||||
# extension. Kamal will ignore the extension and not raise an error.
|
# extension. Kamal will ignore the extension and not raise an error.
|
||||||
|
|
||||||
# The service name
|
# The service name
|
||||||
|
#
|
||||||
# This is a required value. It is used as the container name prefix.
|
# This is a required value. It is used as the container name prefix.
|
||||||
service: myapp
|
service: myapp
|
||||||
|
|
||||||
@@ -32,147 +32,147 @@ image: my-image
|
|||||||
|
|
||||||
# Labels
|
# Labels
|
||||||
#
|
#
|
||||||
# Additional labels to add to the container
|
# Additional labels to add to the container:
|
||||||
labels:
|
labels:
|
||||||
my-label: my-value
|
my-label: my-value
|
||||||
|
|
||||||
# Volumes
|
# Volumes
|
||||||
#
|
#
|
||||||
# Additional volumes to mount into the container
|
# Additional volumes to mount into the container:
|
||||||
volumes:
|
volumes:
|
||||||
- /path/on/host:/path/in/container:ro
|
- /path/on/host:/path/in/container:ro
|
||||||
|
|
||||||
# Registry
|
# Registry
|
||||||
#
|
#
|
||||||
# The Docker registry configuration, see kamal docs registry
|
# The Docker registry configuration, see kamal docs registry:
|
||||||
registry:
|
registry:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Servers
|
# Servers
|
||||||
#
|
#
|
||||||
# The servers to deploy to, optionally with custom roles, see kamal docs servers
|
# The servers to deploy to, optionally with custom roles, see kamal docs servers:
|
||||||
servers:
|
servers:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
#
|
#
|
||||||
# See kamal docs env
|
# See kamal docs env:
|
||||||
env:
|
env:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Asset Path
|
# Asset path
|
||||||
#
|
#
|
||||||
# Used for asset bridging across deployments, default to `nil`
|
# Used for asset bridging across deployments, default to `nil`.
|
||||||
#
|
#
|
||||||
# If there are changes to CSS or JS files, we may get requests
|
# If there are changes to CSS or JS files, we may get requests
|
||||||
# for the old versions on the new container and vice-versa.
|
# for the old versions on the new container, and vice versa.
|
||||||
#
|
#
|
||||||
# To avoid 404s we can specify an asset path.
|
# To avoid 404s, we can specify an asset path.
|
||||||
# Kamal will replace that path in the container with a mapped
|
# Kamal will replace that path in the container with a mapped
|
||||||
# volume containing both sets of files.
|
# volume containing both sets of files.
|
||||||
# This requires that file names change when the contents change
|
# This requires that file names change when the contents change
|
||||||
# (e.g. by including a hash of the contents in the name).
|
# (e.g., by including a hash of the contents in the name).
|
||||||
#
|
#
|
||||||
# To configure this, set the path to the assets:
|
# To configure this, set the path to the assets:
|
||||||
asset_path: /path/to/assets
|
asset_path: /path/to/assets
|
||||||
|
|
||||||
# Hooks path
|
# Hooks path
|
||||||
#
|
#
|
||||||
# Path to hooks, defaults to `.kamal/hooks`
|
# Path to hooks, defaults to `.kamal/hooks`.
|
||||||
# See https://kamal-deploy.org/docs/hooks for more information
|
# See https://kamal-deploy.org/docs/hooks for more information:
|
||||||
hooks_path: /user_home/kamal/hooks
|
hooks_path: /user_home/kamal/hooks
|
||||||
|
|
||||||
# Require destinations
|
# Require destinations
|
||||||
#
|
#
|
||||||
# Whether deployments require a destination to be specified, defaults to `false`
|
# Whether deployments require a destination to be specified, defaults to `false`:
|
||||||
require_destination: true
|
require_destination: true
|
||||||
|
|
||||||
# Primary role
|
# Primary role
|
||||||
#
|
#
|
||||||
# This defaults to `web`, but if you have no web role, you can change this
|
# This defaults to `web`, but if you have no web role, you can change this:
|
||||||
primary_role: workers
|
primary_role: workers
|
||||||
|
|
||||||
# Allowing empty roles
|
# Allowing empty roles
|
||||||
#
|
#
|
||||||
# Whether roles with no servers are allowed. Defaults to `false`.
|
# Whether roles with no servers are allowed. Defaults to `false`:
|
||||||
allow_empty_roles: false
|
allow_empty_roles: false
|
||||||
|
|
||||||
# Retain containers
|
# Retain containers
|
||||||
#
|
#
|
||||||
# How many old containers and images we retain, defaults to 5
|
# How many old containers and images we retain, defaults to 5:
|
||||||
retain_containers: 3
|
retain_containers: 3
|
||||||
|
|
||||||
# Minimum version
|
# Minimum version
|
||||||
#
|
#
|
||||||
# The minimum version of Kamal required to deploy this configuration, defaults to nil
|
# The minimum version of Kamal required to deploy this configuration, defaults to `nil`:
|
||||||
minimum_version: 1.3.0
|
minimum_version: 1.3.0
|
||||||
|
|
||||||
# Readiness delay
|
# Readiness delay
|
||||||
#
|
#
|
||||||
# Seconds to wait for a container to boot after is running, default 7
|
# Seconds to wait for a container to boot after it is running, default 7.
|
||||||
#
|
#
|
||||||
# This only applies to containers that do not run a proxy or specify a healthcheck
|
# This only applies to containers that do not run a proxy or specify a healthcheck:
|
||||||
readiness_delay: 4
|
readiness_delay: 4
|
||||||
|
|
||||||
# Deploy timeout
|
# Deploy timeout
|
||||||
#
|
#
|
||||||
# How long to wait for a container to become ready, default 30
|
# How long to wait for a container to become ready, default 30:
|
||||||
deploy_timeout: 10
|
deploy_timeout: 10
|
||||||
|
|
||||||
# Drain timeout
|
# Drain timeout
|
||||||
#
|
#
|
||||||
# How long to wait for a containers to drain, default 30
|
# How long to wait for a container to drain, default 30:
|
||||||
drain_timeout: 10
|
drain_timeout: 10
|
||||||
|
|
||||||
# Run directory
|
# Run directory
|
||||||
#
|
#
|
||||||
# Directory to store kamal runtime files in on the host, default `.kamal`
|
# Directory to store kamal runtime files in on the host, default `.kamal`:
|
||||||
run_directory: /etc/kamal
|
run_directory: /etc/kamal
|
||||||
|
|
||||||
# SSH options
|
# SSH options
|
||||||
#
|
#
|
||||||
# See kamal docs ssh
|
# See kamal docs ssh:
|
||||||
ssh:
|
ssh:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Builder options
|
# Builder options
|
||||||
#
|
#
|
||||||
# See kamal docs builder
|
# See kamal docs builder:
|
||||||
builder:
|
builder:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Accessories
|
# Accessories
|
||||||
#
|
#
|
||||||
# Additionals services to run in Docker, see kamal docs accessory
|
# Additional services to run in Docker, see kamal docs accessory:
|
||||||
accessories:
|
accessories:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Proxy
|
# Proxy
|
||||||
#
|
#
|
||||||
# Configuration for kamal-proxy, see kamal docs proxy
|
# Configuration for kamal-proxy, see kamal docs proxy:
|
||||||
proxy:
|
proxy:
|
||||||
...
|
...
|
||||||
|
|
||||||
# SSHKit
|
# SSHKit
|
||||||
#
|
#
|
||||||
# See kamal docs sshkit
|
# See kamal docs sshkit:
|
||||||
sshkit:
|
sshkit:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Boot options
|
# Boot options
|
||||||
#
|
#
|
||||||
# See kamal docs boot
|
# See kamal docs boot:
|
||||||
boot:
|
boot:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
#
|
#
|
||||||
# Docker logging configuration, see kamal docs logging
|
# Docker logging configuration, see kamal docs logging:
|
||||||
logging:
|
logging:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Aliases
|
# Aliases
|
||||||
#
|
#
|
||||||
# Alias configuration, see kamal docs alias
|
# Alias configuration, see kamal docs alias:
|
||||||
aliases:
|
aliases:
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# Environment variables
|
# Environment variables
|
||||||
#
|
#
|
||||||
# Environment variables can be set directly in the Kamal configuration or
|
# Environment variables can be set directly in the Kamal configuration or
|
||||||
# read from .kamal/secrets.
|
# read from `.kamal/secrets`.
|
||||||
|
|
||||||
# Reading environment variables from the configuration
|
# Reading environment variables from the configuration
|
||||||
#
|
#
|
||||||
# Environment variables can be set directly in the configuration file.
|
# Environment variables can be set directly in the configuration file.
|
||||||
#
|
#
|
||||||
# These are passed to the docker run command when deploying.
|
# These are passed to the `docker run` command when deploying.
|
||||||
env:
|
env:
|
||||||
DATABASE_HOST: mysql-db1
|
DATABASE_HOST: mysql-db1
|
||||||
DATABASE_PORT: 3306
|
DATABASE_PORT: 3306
|
||||||
@@ -16,7 +16,7 @@ env:
|
|||||||
#
|
#
|
||||||
# Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file.
|
# Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file.
|
||||||
#
|
#
|
||||||
# If you are using destinations, secrets will instead be read from `.kamal/secrets-<DESTINATION>` if
|
# If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if
|
||||||
# it exists.
|
# it exists.
|
||||||
#
|
#
|
||||||
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
||||||
@@ -24,26 +24,27 @@ env:
|
|||||||
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
|
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
|
||||||
# You can use variable or command substitution in the secrets file.
|
# You can use variable or command substitution in the secrets file.
|
||||||
#
|
#
|
||||||
# ```
|
# ```shell
|
||||||
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||||
# RAILS_MASTER_KEY=$(cat config/master.key)
|
# RAILS_MASTER_KEY=$(cat config/master.key)
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# You can also use [secret helpers](../commands/secrets) for some common password managers.
|
# You can also use [secret helpers](../../commands/secrets) for some common password managers.
|
||||||
# ```
|
#
|
||||||
|
# ```shell
|
||||||
# SECRETS=$(kamal secrets fetch ...)
|
# SECRETS=$(kamal secrets fetch ...)
|
||||||
#
|
#
|
||||||
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
|
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
|
||||||
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
|
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# If you store secrets directly in .kamal/secrets, ensure that it is not checked into version control.
|
# If you store secrets directly in `.kamal/secrets`, ensure that it is not checked into version control.
|
||||||
#
|
#
|
||||||
# To pass the secrets you should list them under the `secret` key. When you do this the
|
# To pass the secrets, you should list them under the `secret` key. When you do this, the
|
||||||
# other variables need to be moved under the `clear` key.
|
# other variables need to be moved under the `clear` key.
|
||||||
#
|
#
|
||||||
# Unlike clear values, secrets are not passed directly to the container,
|
# Unlike clear values, secrets are not passed directly to the container
|
||||||
# but are stored in an env file on the host
|
# but are stored in an env file on the host:
|
||||||
env:
|
env:
|
||||||
clear:
|
clear:
|
||||||
DB_USER: app
|
DB_USER: app
|
||||||
@@ -55,7 +56,7 @@ env:
|
|||||||
# Tags are used to add extra env variables to specific hosts.
|
# Tags are used to add extra env variables to specific hosts.
|
||||||
# See kamal docs servers for how to tag hosts.
|
# See kamal docs servers for how to tag hosts.
|
||||||
#
|
#
|
||||||
# Tags are only allowed in the top level env configuration (i.e not under a role specific env).
|
# Tags are only allowed in the top-level env configuration (i.e., not under a role-specific env).
|
||||||
#
|
#
|
||||||
# The env variables can be specified with secret and clear values as explained above.
|
# The env variables can be specified with secret and clear values as explained above.
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -6,16 +6,16 @@
|
|||||||
#
|
#
|
||||||
# These go under the logging key in the configuration file.
|
# These go under the logging key in the configuration file.
|
||||||
#
|
#
|
||||||
# This can be specified in the root level or for a specific role.
|
# This can be specified at the root level or for a specific role.
|
||||||
logging:
|
logging:
|
||||||
|
|
||||||
# Driver
|
# Driver
|
||||||
#
|
#
|
||||||
# The logging driver to use, passed to Docker via `--log-driver`
|
# The logging driver to use, passed to Docker via `--log-driver`:
|
||||||
driver: json-file
|
driver: json-file
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
#
|
#
|
||||||
# Any logging options to pass to the driver, passed to Docker via `--log-opt`
|
# Any logging options to pass to the driver, passed to Docker via `--log-opt`:
|
||||||
options:
|
options:
|
||||||
max-size: 100m
|
max-size: 100m
|
||||||
|
|||||||
@@ -5,54 +5,72 @@
|
|||||||
# application container.
|
# application container.
|
||||||
#
|
#
|
||||||
# The proxy is configured in the root configuration under `proxy`. These are
|
# The proxy is configured in the root configuration under `proxy`. These are
|
||||||
# options that are set when deploying the application, not when booting the proxy
|
# options that are set when deploying the application, not when booting the proxy.
|
||||||
#
|
#
|
||||||
# They are application specific, so are not shared when multiple applications
|
# They are application-specific, so they are not shared when multiple applications
|
||||||
# run on the same proxy.
|
# run on the same proxy.
|
||||||
#
|
#
|
||||||
# The proxy is enabled by default on the primary role, but can be disabled by
|
# The proxy is enabled by default on the primary role but can be disabled by
|
||||||
# setting `proxy: false`.
|
# setting `proxy: false`.
|
||||||
#
|
#
|
||||||
# It is disabled by default on all other roles, but can be enabled by setting
|
# It is disabled by default on all other roles but can be enabled by setting
|
||||||
# `proxy: true`, or providing a proxy configuration.
|
# `proxy: true` or providing a proxy configuration.
|
||||||
proxy:
|
proxy:
|
||||||
|
|
||||||
# Host
|
# Hosts
|
||||||
#
|
#
|
||||||
# The hosts that will be used to serve the app. The proxy will only route requests
|
# The hosts that will be used to serve the app. The proxy will only route requests
|
||||||
# to this host to your app.
|
# to this host to your app.
|
||||||
#
|
#
|
||||||
# If no hosts are set, then all requests will be forwarded, except for matching
|
# If no hosts are set, then all requests will be forwarded, except for matching
|
||||||
# requests for other apps deployed on that server that do have a host set.
|
# requests for other apps deployed on that server that do have a host set.
|
||||||
|
#
|
||||||
|
# Specify one of `host` or `hosts`.
|
||||||
host: foo.example.com
|
host: foo.example.com
|
||||||
|
hosts:
|
||||||
|
- foo.example.com
|
||||||
|
- bar.example.com
|
||||||
|
|
||||||
# App port
|
# App port
|
||||||
#
|
#
|
||||||
# The port the application container is exposed on
|
# The port the application container is exposed on.
|
||||||
#
|
#
|
||||||
# Defaults to 80
|
# Defaults to 80:
|
||||||
app_port: 3000
|
app_port: 3000
|
||||||
|
|
||||||
# SSL
|
# SSL
|
||||||
#
|
#
|
||||||
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
|
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
|
||||||
#
|
#
|
||||||
# This requires that we are deploying to a one server and the host option is set.
|
# This requires that we are deploying to one server and the host option is set.
|
||||||
# The host value must point to the server we are deploying to and port 443 must be
|
# The host value must point to the server we are deploying to, and port 443 must be
|
||||||
# open for the Let's Encrypt challenge to succeed.
|
# open for the Let's Encrypt challenge to succeed.
|
||||||
#
|
#
|
||||||
# Defaults to false
|
# If you set `ssl` to `true`, `kamal-proxy` will stop forwarding headers to your app,
|
||||||
|
# unless you explicitly set `forward_headers: true`
|
||||||
|
#
|
||||||
|
# Defaults to `false`:
|
||||||
ssl: true
|
ssl: true
|
||||||
|
|
||||||
|
# Forward headers
|
||||||
|
#
|
||||||
|
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
|
||||||
|
#
|
||||||
|
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
|
||||||
|
#
|
||||||
|
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
|
||||||
|
# will forward them if it is set to `false`.
|
||||||
|
forward_headers: true
|
||||||
|
|
||||||
# Response timeout
|
# Response timeout
|
||||||
#
|
#
|
||||||
# How long to wait for requests to complete before timing out, defaults to 30 seconds
|
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
|
||||||
response_timeout: 10
|
response_timeout: 10
|
||||||
|
|
||||||
# Healthcheck
|
# Healthcheck
|
||||||
#
|
#
|
||||||
# When deploying, the proxy will by default hit /up once every second until we hit
|
# When deploying, the proxy will by default hit `/up` once every second until we hit
|
||||||
# the deploy timeout, with a 5 second timeout for each request.
|
# the deploy timeout, with a 5-second timeout for each request.
|
||||||
#
|
#
|
||||||
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
||||||
healthcheck:
|
healthcheck:
|
||||||
@@ -62,12 +80,12 @@ proxy:
|
|||||||
|
|
||||||
# Buffering
|
# Buffering
|
||||||
#
|
#
|
||||||
# Whether to buffer request and response bodies in the proxy
|
# Whether to buffer request and response bodies in the proxy.
|
||||||
#
|
#
|
||||||
# By default buffering is enabled with a max request body size of 1GB and no limit
|
# By default, buffering is enabled with a max request body size of 1GB and no limit
|
||||||
# for response size.
|
# for response size.
|
||||||
#
|
#
|
||||||
# You can also set the memory limit for buffering, which defaults to 1MB, anything
|
# You can also set the memory limit for buffering, which defaults to 1MB; anything
|
||||||
# larger than that is written to disk.
|
# larger than that is written to disk.
|
||||||
buffering:
|
buffering:
|
||||||
requests: true
|
requests: true
|
||||||
@@ -78,9 +96,9 @@ proxy:
|
|||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
#
|
#
|
||||||
# Configure request logging for the proxy
|
# Configure request logging for the proxy.
|
||||||
# You can specify request and response headers to log.
|
# You can specify request and response headers to log.
|
||||||
# By default, Cache-Control, Last-Modified and User-Agent request headers are logged
|
# By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged:
|
||||||
logging:
|
logging:
|
||||||
request_headers:
|
request_headers:
|
||||||
- Cache-Control
|
- Cache-Control
|
||||||
@@ -88,13 +106,3 @@ proxy:
|
|||||||
response_headers:
|
response_headers:
|
||||||
- X-Request-ID
|
- X-Request-ID
|
||||||
- X-Request-Start
|
- X-Request-Start
|
||||||
|
|
||||||
# Forward headers
|
|
||||||
#
|
|
||||||
# Whether to forward the X-Forwarded-For and X-Forwarded-Proto headers.
|
|
||||||
#
|
|
||||||
# If you are behind a trusted proxy, you can set this to true to forward the headers.
|
|
||||||
#
|
|
||||||
# By default kamal-proxy will not forward the headers the ssl option is set to true, and
|
|
||||||
# will forward them if it is set to false.
|
|
||||||
forward_headers: true
|
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
# Registry
|
# Registry
|
||||||
#
|
#
|
||||||
# The default registry is Docker Hub, but you can change it using registry/server:
|
# The default registry is Docker Hub, but you can change it using `registry/server`.
|
||||||
#
|
#
|
||||||
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
|
# By default, Docker Hub creates public repositories. To avoid making your images public,
|
||||||
# in the local environment.
|
# set up a private repository before deploying, or change the default repository privacy
|
||||||
|
# settings to private in your [Docker Hub settings](https://hub.docker.com/repository-settings/default-privacy).
|
||||||
|
#
|
||||||
|
# A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret
|
||||||
|
# in the local environment:
|
||||||
registry:
|
registry:
|
||||||
server: registry.digitalocean.com
|
server: registry.digitalocean.com
|
||||||
username:
|
username:
|
||||||
@@ -13,30 +16,31 @@ registry:
|
|||||||
- DOCKER_REGISTRY_TOKEN
|
- DOCKER_REGISTRY_TOKEN
|
||||||
|
|
||||||
# Using AWS ECR as the container registry
|
# Using AWS ECR as the container registry
|
||||||
# You will need to have the aws CLI installed locally for this to work.
|
#
|
||||||
# AWS ECR’s access token is only valid for 12hrs. In order to not have to manually regenerate the token every time, you can use ERB in the deploy.yml file to shell out to the aws cli command, and obtain the token:
|
# You will need to have the AWS CLI installed locally for this to work.
|
||||||
|
# AWS ECR’s access token is only valid for 12 hours. In order to avoid having to manually regenerate the token every time, you can use ERB in the `deploy.yml` file to shell out to the AWS CLI command and obtain the token:
|
||||||
registry:
|
registry:
|
||||||
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
||||||
username: AWS
|
username: AWS
|
||||||
password: <%= %x(aws ecr get-login-password) %>
|
password: <%= %x(aws ecr get-login-password) %>
|
||||||
|
|
||||||
# Using GCP Artifact Registry as the container registry
|
# Using GCP Artifact Registry as the container registry
|
||||||
# To sign into Artifact Registry, you would need to
|
#
|
||||||
|
# To sign into Artifact Registry, you need to
|
||||||
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
||||||
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
||||||
# Normally, assigning a roles/artifactregistry.writer role should be sufficient.
|
# Normally, assigning the `roles/artifactregistry.writer` role should be sufficient.
|
||||||
#
|
#
|
||||||
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
|
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# base64 -i /path/to/key.json | tr -d "\\n")
|
# base64 -i /path/to/key.json | tr -d "\\n"
|
||||||
# ```
|
# ```
|
||||||
# You'll then need to set the KAMAL_REGISTRY_PASSWORD secret to that value.
|
|
||||||
#
|
#
|
||||||
# Use the env variable as password along with _json_key_base64 as username.
|
# You'll then need to set the `KAMAL_REGISTRY_PASSWORD` secret to that value.
|
||||||
|
#
|
||||||
|
# Use the environment variable as the password along with `_json_key_base64` as the username.
|
||||||
# Here’s the final configuration:
|
# Here’s the final configuration:
|
||||||
|
|
||||||
registry:
|
registry:
|
||||||
server: <your registry region>-docker.pkg.dev
|
server: <your registry region>-docker.pkg.dev
|
||||||
username: _json_key_base64
|
username: _json_key_base64
|
||||||
@@ -46,6 +50,7 @@ registry:
|
|||||||
# Validating the configuration
|
# Validating the configuration
|
||||||
#
|
#
|
||||||
# You can validate the configuration by running:
|
# You can validate the configuration by running:
|
||||||
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# kamal registry login
|
# kamal registry login
|
||||||
# ```
|
# ```
|
||||||
|
|||||||
@@ -1,22 +1,21 @@
|
|||||||
# Roles
|
# Roles
|
||||||
#
|
#
|
||||||
# Roles are used to configure different types of servers in the deployment.
|
# Roles are used to configure different types of servers in the deployment.
|
||||||
# The most common use for this is to run a web servers and job servers.
|
# The most common use for this is to run web servers and job servers.
|
||||||
#
|
#
|
||||||
# Kamal expects there to be a `web` role, unless you set a different `primary_role`
|
# Kamal expects there to be a `web` role, unless you set a different `primary_role`
|
||||||
# in the root configuration.
|
# in the root configuration.
|
||||||
|
|
||||||
# Role configuration
|
# Role configuration
|
||||||
#
|
#
|
||||||
# Roles are specified under the servers key
|
# Roles are specified under the servers key:
|
||||||
servers:
|
servers:
|
||||||
|
|
||||||
# Simple role configuration
|
# Simple role configuration
|
||||||
#
|
#
|
||||||
|
# This can be a list of hosts if you don't need custom configuration for the role.
|
||||||
#
|
#
|
||||||
# This can be a list of hosts, if you don't need custom configuration for the role.
|
# You can set tags on the hosts for custom env variables (see kamal docs env):
|
||||||
#
|
|
||||||
# You can set tags on the hosts for custom env variables (see kamal docs env)
|
|
||||||
web:
|
web:
|
||||||
- 172.1.0.1
|
- 172.1.0.1
|
||||||
- 172.1.0.2: experiment1
|
- 172.1.0.2: experiment1
|
||||||
@@ -24,16 +23,16 @@ servers:
|
|||||||
|
|
||||||
# Custom role configuration
|
# Custom role configuration
|
||||||
#
|
#
|
||||||
# When there are other options to set, the list of hosts goes under the `hosts` key
|
# When there are other options to set, the list of hosts goes under the `hosts` key.
|
||||||
#
|
#
|
||||||
# By default only the primary role uses a proxy.
|
# By default, only the primary role uses a proxy.
|
||||||
#
|
#
|
||||||
# For other roles, you can set it to `proxy: true` enable it and inherit the root proxy
|
# For other roles, you can set it to `proxy: true` to enable it and inherit the root proxy
|
||||||
# configuration or provide a map of options to override the root configuration.
|
# configuration or provide a map of options to override the root configuration.
|
||||||
#
|
#
|
||||||
# For the primary role, you can set `proxy: false` to disable the proxy.
|
# For the primary role, you can set `proxy: false` to disable the proxy.
|
||||||
#
|
#
|
||||||
# You can also set a custom cmd to run in the container, and overwrite other settings
|
# You can also set a custom `cmd` to run in the container and overwrite other settings
|
||||||
# from the root configuration.
|
# from the root configuration.
|
||||||
workers:
|
workers:
|
||||||
hosts:
|
hosts:
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
#
|
#
|
||||||
# Servers are split into different roles, with each role having its own configuration.
|
# Servers are split into different roles, with each role having its own configuration.
|
||||||
#
|
#
|
||||||
# For simpler deployments though where all servers are identical, you can just specify a list of servers
|
# For simpler deployments, though, where all servers are identical, you can just specify a list of servers.
|
||||||
# They will be implicitly assigned to the `web` role.
|
# They will be implicitly assigned to the `web` role.
|
||||||
servers:
|
servers:
|
||||||
- 172.0.0.1
|
- 172.0.0.1
|
||||||
@@ -19,7 +19,7 @@ servers:
|
|||||||
|
|
||||||
# Roles
|
# Roles
|
||||||
#
|
#
|
||||||
# For more complex deployments (e.g. if you are running job hosts), you can specify roles, and configure each separately (see kamal docs role)
|
# For more complex deployments (e.g., if you are running job hosts), you can specify roles and configure each separately (see kamal docs role):
|
||||||
servers:
|
servers:
|
||||||
web:
|
web:
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# SSH configuration
|
# SSH configuration
|
||||||
#
|
#
|
||||||
# Kamal uses SSH to connect run commands on your hosts.
|
# Kamal uses SSH to connect and run commands on your hosts.
|
||||||
# By default it will attempt to connect to the root user on port 22
|
# By default, it will attempt to connect to the root user on port 22.
|
||||||
#
|
#
|
||||||
# If you are using non-root user, you may need to bootstrap your servers manually, before using them with Kamal. On Ubuntu, you’d do:
|
# If you are using a non-root user, you may need to bootstrap your servers manually before using them with Kamal. On Ubuntu, you’d do:
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# sudo apt update
|
# sudo apt update
|
||||||
@@ -12,7 +12,6 @@
|
|||||||
# sudo usermod -a -G docker app
|
# sudo usermod -a -G docker app
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
|
|
||||||
# SSH options
|
# SSH options
|
||||||
#
|
#
|
||||||
# The options are specified under the ssh key in the configuration file.
|
# The options are specified under the ssh key in the configuration file.
|
||||||
@@ -20,47 +19,52 @@ ssh:
|
|||||||
|
|
||||||
# The SSH user
|
# The SSH user
|
||||||
#
|
#
|
||||||
# Defaults to `root`
|
# Defaults to `root`:
|
||||||
#
|
|
||||||
user: app
|
user: app
|
||||||
|
|
||||||
# The SSH port
|
# The SSH port
|
||||||
#
|
#
|
||||||
# Defaults to 22
|
# Defaults to 22:
|
||||||
port: "2222"
|
port: "2222"
|
||||||
|
|
||||||
# Proxy host
|
# Proxy host
|
||||||
#
|
#
|
||||||
# Specified in the form <host> or <user>@<host>
|
# Specified in the form <host> or <user>@<host>:
|
||||||
proxy: root@proxy-host
|
proxy: root@proxy-host
|
||||||
|
|
||||||
# Proxy command
|
# Proxy command
|
||||||
#
|
#
|
||||||
# A custom proxy command, required for older versions of SSH
|
# A custom proxy command, required for older versions of SSH:
|
||||||
proxy_command: "ssh -W %h:%p user@proxy"
|
proxy_command: "ssh -W %h:%p user@proxy"
|
||||||
|
|
||||||
# Log level
|
# Log level
|
||||||
#
|
#
|
||||||
# Defaults to `fatal`. Set this to debug if you are having
|
# Defaults to `fatal`. Set this to `debug` if you are having SSH connection issues.
|
||||||
# SSH connection issues.
|
|
||||||
log_level: debug
|
log_level: debug
|
||||||
|
|
||||||
# Keys Only
|
# Keys only
|
||||||
#
|
#
|
||||||
# Set to true to use only private keys from keys and key_data parameters,
|
# Set to `true` to use only private keys from the `keys` and `key_data` parameters,
|
||||||
# even if ssh-agent offers more identities. This option is intended for
|
# even if ssh-agent offers more identities. This option is intended for
|
||||||
# situations where ssh-agent offers many different identites or you have
|
# situations where ssh-agent offers many different identities or you
|
||||||
# a need to overwrite all identites and force a single one.
|
# need to overwrite all identities and force a single one.
|
||||||
keys_only: false
|
keys_only: false
|
||||||
|
|
||||||
# Keys
|
# Keys
|
||||||
#
|
#
|
||||||
# An array of file names of private keys to use for public key
|
# An array of file names of private keys to use for public key
|
||||||
# and hostbased authentication
|
# and host-based authentication:
|
||||||
keys: [ "~/.ssh/id.pem" ]
|
keys: [ "~/.ssh/id.pem" ]
|
||||||
|
|
||||||
# Key Data
|
# Key data
|
||||||
#
|
#
|
||||||
# An array of strings, with each element of the array being
|
# An array of strings, with each element of the array being
|
||||||
# a raw private key in PEM format.
|
# a raw private key in PEM format.
|
||||||
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
|
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
|
||||||
|
|
||||||
|
# Config
|
||||||
|
#
|
||||||
|
# Set to true to load the default OpenSSH config files (~/.ssh/config,
|
||||||
|
# /etc/ssh_config), to false ignore config files, or to a file path
|
||||||
|
# (or array of paths) to load specific configuration. Defaults to true.
|
||||||
|
config: true
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
#
|
#
|
||||||
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
||||||
#
|
#
|
||||||
# The default settings should be sufficient for most use cases, but
|
# The default, settings should be sufficient for most use cases, but
|
||||||
# when connecting to a large number of hosts you may need to adjust
|
# when connecting to a large number of hosts, you may need to adjust.
|
||||||
|
|
||||||
# SSHKit options
|
# SSHKit options
|
||||||
#
|
#
|
||||||
@@ -13,11 +13,11 @@ sshkit:
|
|||||||
# Max concurrent starts
|
# Max concurrent starts
|
||||||
#
|
#
|
||||||
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
||||||
# By default Kamal will limit concurrent connection starts to 30 at a time.
|
# By default, Kamal will limit concurrent connection starts to 30 at a time.
|
||||||
max_concurrent_starts: 10
|
max_concurrent_starts: 10
|
||||||
|
|
||||||
# Pool idle timeout
|
# Pool idle timeout
|
||||||
#
|
#
|
||||||
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
||||||
# re-connection storms after an idle period, like building an image or waiting for CI.
|
# re-connection storms after an idle period, such as building an image or waiting for CI.
|
||||||
pool_idle_timeout: 300
|
pool_idle_timeout: 300
|
||||||
|
|||||||
@@ -22,14 +22,14 @@ class Kamal::Configuration::Proxy
|
|||||||
proxy_config.fetch("ssl", false)
|
proxy_config.fetch("ssl", false)
|
||||||
end
|
end
|
||||||
|
|
||||||
def host
|
def hosts
|
||||||
proxy_config["host"]
|
proxy_config["hosts"] || proxy_config["host"]&.split(",") || []
|
||||||
end
|
end
|
||||||
|
|
||||||
def deploy_options
|
def deploy_options
|
||||||
{
|
{
|
||||||
host: proxy_config["host"],
|
host: hosts,
|
||||||
tls: proxy_config["ssl"],
|
tls: proxy_config["ssl"].presence,
|
||||||
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
||||||
"drain-timeout": seconds_duration(config.drain_timeout),
|
"drain-timeout": seconds_duration(config.drain_timeout),
|
||||||
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
||||||
@@ -48,11 +48,7 @@ class Kamal::Configuration::Proxy
|
|||||||
end
|
end
|
||||||
|
|
||||||
def deploy_command_args(target:)
|
def deploy_command_args(target:)
|
||||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options)
|
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "="
|
||||||
end
|
|
||||||
|
|
||||||
def remove_command_args(target:)
|
|
||||||
optionize({ target: "#{target}:#{app_port}" })
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def merge(other)
|
def merge(other)
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
class Kamal::Configuration::Registry
|
class Kamal::Configuration::Registry
|
||||||
include Kamal::Configuration::Validation
|
include Kamal::Configuration::Validation
|
||||||
|
|
||||||
attr_reader :registry_config, :secrets
|
def initialize(config:, secrets:, context: "registry")
|
||||||
|
@registry_config = config["registry"] || {}
|
||||||
def initialize(config:)
|
@secrets = secrets
|
||||||
@registry_config = config.raw_config.registry || {}
|
validate! registry_config, context: context, with: Kamal::Configuration::Validator::Registry
|
||||||
@secrets = config.secrets
|
|
||||||
validate! registry_config, with: Kamal::Configuration::Validator::Registry
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def server
|
def server
|
||||||
@@ -22,6 +20,8 @@ class Kamal::Configuration::Registry
|
|||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
attr_reader :registry_config, :secrets
|
||||||
|
|
||||||
def lookup(key)
|
def lookup(key)
|
||||||
if registry_config[key].is_a?(Array)
|
if registry_config[key].is_a?(Array)
|
||||||
secrets[registry_config[key].first]
|
secrets[registry_config[key].first]
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ class Kamal::Configuration::Role
|
|||||||
def initialize(name, config:)
|
def initialize(name, config:)
|
||||||
@name, @config = name.inquiry, config
|
@name, @config = name.inquiry, config
|
||||||
validate! \
|
validate! \
|
||||||
specializations,
|
role_config,
|
||||||
example: validation_yml["servers"]["workers"],
|
example: validation_yml["servers"]["workers"],
|
||||||
context: "servers/#{name}",
|
context: "servers/#{name}",
|
||||||
with: Kamal::Configuration::Validator::Role
|
with: Kamal::Configuration::Validator::Role
|
||||||
@@ -204,11 +204,11 @@ class Kamal::Configuration::Role
|
|||||||
end
|
end
|
||||||
|
|
||||||
def specializations
|
def specializations
|
||||||
if config.raw_config.servers.is_a?(Array) || config.raw_config.servers[name].is_a?(Array)
|
@specializations ||= role_config.is_a?(Array) ? {} : role_config
|
||||||
{}
|
|
||||||
else
|
|
||||||
config.raw_config.servers[name]
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def role_config
|
||||||
|
@role_config ||= config.raw_config.servers.is_a?(Array) ? {} : config.raw_config.servers[name]
|
||||||
end
|
end
|
||||||
|
|
||||||
def custom_labels
|
def custom_labels
|
||||||
|
|||||||
@@ -3,9 +3,13 @@ class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
|
|||||||
unless config.nil?
|
unless config.nil?
|
||||||
super
|
super
|
||||||
|
|
||||||
if config["host"].blank? && config["ssl"]
|
if config["host"].blank? && config["hosts"].blank? && config["ssl"]
|
||||||
error "Must set a host to enable automatic SSL"
|
error "Must set a host to enable automatic SSL"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if (config.keys & [ "host", "hosts" ]).size > 1
|
||||||
|
error "Specify one of 'host' or 'hosts', not both"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ class Kamal::Configuration::Validator::Role < Kamal::Configuration::Validator
|
|||||||
validate_type! config, Array, Hash
|
validate_type! config, Array, Hash
|
||||||
|
|
||||||
if config.is_a?(Array)
|
if config.is_a?(Array)
|
||||||
validate_servers! "servers", config
|
validate_servers!(config)
|
||||||
else
|
else
|
||||||
super
|
super
|
||||||
end
|
end
|
||||||
|
|||||||
30
lib/kamal/docker.rb
Normal file
30
lib/kamal/docker.rb
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
require "tempfile"
|
||||||
|
require "open3"
|
||||||
|
|
||||||
|
module Kamal::Docker
|
||||||
|
extend self
|
||||||
|
BUILD_CHECK_TAG = "kamal-local-build-check"
|
||||||
|
|
||||||
|
def included_files
|
||||||
|
Tempfile.create do |dockerfile|
|
||||||
|
dockerfile.write(<<~DOCKERFILE)
|
||||||
|
FROM busybox
|
||||||
|
COPY . app
|
||||||
|
WORKDIR app
|
||||||
|
CMD find . -type f | sed "s|^\./||"
|
||||||
|
DOCKERFILE
|
||||||
|
dockerfile.close
|
||||||
|
|
||||||
|
cmd = "docker buildx build -t=#{BUILD_CHECK_TAG} -f=#{dockerfile.path} ."
|
||||||
|
system(cmd) || raise("failed to build check image")
|
||||||
|
end
|
||||||
|
|
||||||
|
cmd = "docker run --rm #{BUILD_CHECK_TAG}"
|
||||||
|
out, err, status = Open3.capture3(cmd)
|
||||||
|
unless status
|
||||||
|
raise "failed to run check image:\n#{err}"
|
||||||
|
end
|
||||||
|
|
||||||
|
out.lines.map(&:strip)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -37,6 +37,8 @@ class Kamal::EnvFile
|
|||||||
def escape_docker_env_file_ascii_value(value)
|
def escape_docker_env_file_ascii_value(value)
|
||||||
# Doublequotes are treated literally in docker env files
|
# Doublequotes are treated literally in docker env files
|
||||||
# so remove leading and trailing ones and unescape any others
|
# so remove leading and trailing ones and unescape any others
|
||||||
value.to_s.dump[1..-2].gsub(/\\"/, "\"")
|
value.to_s.dump[1..-2]
|
||||||
|
.gsub(/\\"/, "\"")
|
||||||
|
.gsub(/\\#/, "#")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -24,4 +24,14 @@ module Kamal::Git
|
|||||||
def root
|
def root
|
||||||
`git rev-parse --show-toplevel`.strip
|
`git rev-parse --show-toplevel`.strip
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# returns an array of relative path names of files with uncommitted changes
|
||||||
|
def uncommitted_files
|
||||||
|
`git ls-files --modified`.lines.map(&:strip)
|
||||||
|
end
|
||||||
|
|
||||||
|
# returns an array of relative path names of untracked files, including gitignored files
|
||||||
|
def untracked_files
|
||||||
|
`git ls-files --others`.lines.map(&:strip)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,13 +1,10 @@
|
|||||||
require "dotenv"
|
require "dotenv"
|
||||||
|
|
||||||
class Kamal::Secrets
|
class Kamal::Secrets
|
||||||
attr_reader :secrets_files
|
|
||||||
|
|
||||||
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
||||||
|
|
||||||
def initialize(destination: nil)
|
def initialize(destination: nil)
|
||||||
@secrets_files = \
|
@destination = destination
|
||||||
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{destination}" if destination)}" ].select { |f| File.exist?(f) }
|
|
||||||
@mutex = Mutex.new
|
@mutex = Mutex.new
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -17,10 +14,10 @@ class Kamal::Secrets
|
|||||||
secrets.fetch(key)
|
secrets.fetch(key)
|
||||||
end
|
end
|
||||||
rescue KeyError
|
rescue KeyError
|
||||||
if secrets_files
|
if secrets_files.present?
|
||||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
||||||
else
|
else
|
||||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files provided"
|
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files (#{secrets_filenames.join(", ")}) provided"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -28,10 +25,18 @@ class Kamal::Secrets
|
|||||||
secrets
|
secrets
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def secrets_files
|
||||||
|
@secrets_files ||= secrets_filenames.select { |f| File.exist?(f) }
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def secrets
|
def secrets
|
||||||
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
||||||
secrets.merge!(::Dotenv.parse(secrets_file))
|
secrets.merge!(::Dotenv.parse(secrets_file, overwrite: true))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def secrets_filenames
|
||||||
|
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{@destination}" if @destination)}" ]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ module Kamal::Secrets::Adapters
|
|||||||
def self.lookup(name)
|
def self.lookup(name)
|
||||||
name = "one_password" if name.downcase == "1password"
|
name = "one_password" if name.downcase == "1password"
|
||||||
name = "last_pass" if name.downcase == "lastpass"
|
name = "last_pass" if name.downcase == "lastpass"
|
||||||
|
name = "gcp_secret_manager" if name.downcase == "gcp"
|
||||||
|
name = "bitwarden_secrets_manager" if name.downcase == "bitwarden-sm"
|
||||||
adapter_class(name)
|
adapter_class(name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
50
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
50
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
class Kamal::Secrets::Adapters::AwsSecretsManager < Kamal::Secrets::Adapters::Base
|
||||||
|
def requires_account?
|
||||||
|
false
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def login(_account)
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secrets(secrets, from:, account: nil, session:)
|
||||||
|
{}.tap do |results|
|
||||||
|
get_from_secrets_manager(prefixed_secrets(secrets, from: from), account: account).each do |secret|
|
||||||
|
secret_name = secret["Name"]
|
||||||
|
secret_string = JSON.parse(secret["SecretString"])
|
||||||
|
|
||||||
|
secret_string.each do |key, value|
|
||||||
|
results["#{secret_name}/#{key}"] = value
|
||||||
|
end
|
||||||
|
rescue JSON::ParserError
|
||||||
|
results["#{secret_name}"] = secret["SecretString"]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def get_from_secrets_manager(secrets, account: nil)
|
||||||
|
args = [ "aws", "secretsmanager", "batch-get-secret-value", "--secret-id-list" ] + secrets.map(&:shellescape)
|
||||||
|
args += [ "--profile", account.shellescape ] if account
|
||||||
|
cmd = args.join(" ")
|
||||||
|
|
||||||
|
`#{cmd}`.tap do |secrets|
|
||||||
|
raise RuntimeError, "Could not read #{secrets} from AWS Secrets Manager" unless $?.success?
|
||||||
|
|
||||||
|
secrets = JSON.parse(secrets)
|
||||||
|
|
||||||
|
return secrets["SecretValues"] unless secrets["Errors"].present?
|
||||||
|
|
||||||
|
raise RuntimeError, secrets["Errors"].map { |error| "#{error['SecretId']}: #{error['Message']}" }.join(" ")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "AWS CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`aws --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,10 +1,17 @@
|
|||||||
class Kamal::Secrets::Adapters::Base
|
class Kamal::Secrets::Adapters::Base
|
||||||
delegate :optionize, to: Kamal::Utils
|
delegate :optionize, to: Kamal::Utils
|
||||||
|
|
||||||
def fetch(secrets, account:, from: nil)
|
def fetch(secrets, account: nil, from: nil)
|
||||||
|
raise RuntimeError, "Missing required option '--account'" if requires_account? && account.blank?
|
||||||
|
|
||||||
|
check_dependencies!
|
||||||
|
|
||||||
session = login(account)
|
session = login(account)
|
||||||
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
fetch_secrets(secrets, from: from, account: account, session: session)
|
||||||
fetch_secrets(full_secrets, account: account, session: session)
|
end
|
||||||
|
|
||||||
|
def requires_account?
|
||||||
|
true
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
@@ -15,4 +22,12 @@ class Kamal::Secrets::Adapters::Base
|
|||||||
def fetch_secrets(...)
|
def fetch_secrets(...)
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise NotImplementedError
|
||||||
|
end
|
||||||
|
|
||||||
|
def prefixed_secrets(secrets, from:)
|
||||||
|
secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -21,24 +21,32 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
|||||||
session
|
session
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_secrets(secrets, account:, session:)
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
{}.tap do |results|
|
{}.tap do |results|
|
||||||
items_fields(secrets).each do |item, fields|
|
items_fields(prefixed_secrets(secrets, from: from)).each do |item, fields|
|
||||||
item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
|
item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
|
||||||
raise RuntimeError, "Could not read #{secret} from Bitwarden" unless $?.success?
|
raise RuntimeError, "Could not read #{item} from Bitwarden" unless $?.success?
|
||||||
item_json = JSON.parse(item_json)
|
item_json = JSON.parse(item_json)
|
||||||
|
|
||||||
if fields.any?
|
if fields.any?
|
||||||
fields.each do |field|
|
results.merge! fetch_secrets_from_fields(fields, item, item_json)
|
||||||
|
elsif item_json.dig("login", "password")
|
||||||
|
results[item] = item_json.dig("login", "password")
|
||||||
|
elsif item_json["fields"]&.any?
|
||||||
|
fields = item_json["fields"].pluck("name")
|
||||||
|
results.merge! fetch_secrets_from_fields(fields, item, item_json)
|
||||||
|
else
|
||||||
|
raise RuntimeError, "Item #{item} is not a login type item and no fields were specified"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secrets_from_fields(fields, item, item_json)
|
||||||
|
fields.to_h do |field|
|
||||||
item_field = item_json["fields"].find { |f| f["name"] == field }
|
item_field = item_json["fields"].find { |f| f["name"] == field }
|
||||||
raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field
|
raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field
|
||||||
value = item_field["value"]
|
value = item_field["value"]
|
||||||
results["#{item}/#{field}"] = value
|
[ "#{item}/#{field}", value ]
|
||||||
end
|
|
||||||
else
|
|
||||||
results[item] = item_json["login"]["password"]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -61,4 +69,13 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
|||||||
result = `#{full_command}`.strip
|
result = `#{full_command}`.strip
|
||||||
raw ? result : JSON.parse(result)
|
raw ? result : JSON.parse(result)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "Bitwarden CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`bw --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
72
lib/kamal/secrets/adapters/bitwarden_secrets_manager.rb
Normal file
72
lib/kamal/secrets/adapters/bitwarden_secrets_manager.rb
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
class Kamal::Secrets::Adapters::BitwardenSecretsManager < Kamal::Secrets::Adapters::Base
|
||||||
|
def requires_account?
|
||||||
|
false
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
LIST_ALL_SELECTOR = "all"
|
||||||
|
LIST_ALL_FROM_PROJECT_SUFFIX = "/all"
|
||||||
|
LIST_COMMAND = "secret list -o env"
|
||||||
|
GET_COMMAND = "secret get -o env"
|
||||||
|
|
||||||
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
|
raise RuntimeError, "You must specify what to retrieve from Bitwarden Secrets Manager" if secrets.length == 0
|
||||||
|
|
||||||
|
secrets = prefixed_secrets(secrets, from: from)
|
||||||
|
command, project = extract_command_and_project(secrets)
|
||||||
|
|
||||||
|
{}.tap do |results|
|
||||||
|
if command.nil?
|
||||||
|
secrets.each do |secret_uuid|
|
||||||
|
secret = run_command("#{GET_COMMAND} #{secret_uuid.shellescape}")
|
||||||
|
raise RuntimeError, "Could not read #{secret_uuid} from Bitwarden Secrets Manager" unless $?.success?
|
||||||
|
key, value = parse_secret(secret)
|
||||||
|
results[key] = value
|
||||||
|
end
|
||||||
|
else
|
||||||
|
secrets = run_command(command)
|
||||||
|
raise RuntimeError, "Could not read secrets from Bitwarden Secrets Manager" unless $?.success?
|
||||||
|
secrets.split("\n").each do |secret|
|
||||||
|
key, value = parse_secret(secret)
|
||||||
|
results[key] = value
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def extract_command_and_project(secrets)
|
||||||
|
if secrets.length == 1
|
||||||
|
if secrets[0] == LIST_ALL_SELECTOR
|
||||||
|
[ LIST_COMMAND, nil ]
|
||||||
|
elsif secrets[0].end_with?(LIST_ALL_FROM_PROJECT_SUFFIX)
|
||||||
|
project = secrets[0].split(LIST_ALL_FROM_PROJECT_SUFFIX).first
|
||||||
|
[ "#{LIST_COMMAND} #{project.shellescape}", project ]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_secret(secret)
|
||||||
|
key, value = secret.split("=", 2)
|
||||||
|
value = value.gsub(/^"|"$/, "")
|
||||||
|
[ key, value ]
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_command(command, session: nil)
|
||||||
|
full_command = [ "bws", command ].join(" ")
|
||||||
|
`#{full_command}`
|
||||||
|
end
|
||||||
|
|
||||||
|
def login(account)
|
||||||
|
run_command("run 'echo OK'")
|
||||||
|
raise RuntimeError, "Could not authenticate to Bitwarden Secrets Manager. Did you set a valid access token?" unless $?.success?
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "Bitwarden Secrets Manager CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`bws --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
end
|
||||||
57
lib/kamal/secrets/adapters/doppler.rb
Normal file
57
lib/kamal/secrets/adapters/doppler.rb
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
class Kamal::Secrets::Adapters::Doppler < Kamal::Secrets::Adapters::Base
|
||||||
|
def requires_account?
|
||||||
|
false
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def login(*)
|
||||||
|
unless loggedin?
|
||||||
|
`doppler login -y`
|
||||||
|
raise RuntimeError, "Failed to login to Doppler" unless $?.success?
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def loggedin?
|
||||||
|
`doppler me --json 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secrets(secrets, from:, **)
|
||||||
|
secrets = prefixed_secrets(secrets, from: from)
|
||||||
|
flags = secrets_get_flags(secrets)
|
||||||
|
|
||||||
|
secret_names = secrets.collect { |s| s.split("/").last }
|
||||||
|
|
||||||
|
items = `doppler secrets get #{secret_names.map(&:shellescape).join(" ")} --json #{flags}`
|
||||||
|
raise RuntimeError, "Could not read #{secrets} from Doppler" unless $?.success?
|
||||||
|
|
||||||
|
items = JSON.parse(items)
|
||||||
|
|
||||||
|
items.transform_values { |value| value["computed"] }
|
||||||
|
end
|
||||||
|
|
||||||
|
def secrets_get_flags(secrets)
|
||||||
|
unless service_token_set?
|
||||||
|
project, config, _ = secrets.first.split("/")
|
||||||
|
|
||||||
|
unless project && config
|
||||||
|
raise RuntimeError, "Missing project or config from '--from=project/config' option"
|
||||||
|
end
|
||||||
|
|
||||||
|
project_and_config_flags = "-p #{project.shellescape} -c #{config.shellescape}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def service_token_set?
|
||||||
|
ENV["DOPPLER_TOKEN"] && ENV["DOPPLER_TOKEN"][0, 5] == "dp.st"
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "Doppler CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`doppler --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
end
|
||||||
71
lib/kamal/secrets/adapters/enpass.rb
Normal file
71
lib/kamal/secrets/adapters/enpass.rb
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
##
|
||||||
|
# Enpass is different from most password managers, in a way that it's offline and doesn't need an account.
|
||||||
|
#
|
||||||
|
# Usage
|
||||||
|
#
|
||||||
|
# Fetch all password from FooBar item
|
||||||
|
# `kamal secrets fetch --adapter enpass --from /Users/YOUR_USERNAME/Library/Containers/in.sinew.Enpass-Desktop/Data/Documents/Vaults/primary FooBar`
|
||||||
|
#
|
||||||
|
# Fetch only DB_PASSWORD from FooBar item
|
||||||
|
# `kamal secrets fetch --adapter enpass --from /Users/YOUR_USERNAME/Library/Containers/in.sinew.Enpass-Desktop/Data/Documents/Vaults/primary FooBar/DB_PASSWORD`
|
||||||
|
class Kamal::Secrets::Adapters::Enpass < Kamal::Secrets::Adapters::Base
|
||||||
|
def requires_account?
|
||||||
|
false
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
|
secrets_titles = fetch_secret_titles(secrets)
|
||||||
|
|
||||||
|
result = `enpass-cli -json -vault #{from.shellescape} show #{secrets_titles.map(&:shellescape).join(" ")}`.strip
|
||||||
|
|
||||||
|
parse_result_and_take_secrets(result, secrets)
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "Enpass CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`enpass-cli version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
|
||||||
|
def login(account)
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secret_titles(secrets)
|
||||||
|
secrets.reduce(Set.new) do |secret_titles, secret|
|
||||||
|
# Sometimes secrets contain a '/', when the intent is to fetch a single password for an item. Example: FooBar/DB_PASSWORD
|
||||||
|
# Another case is, when the intent is to fetch all passwords for an item. Example: FooBar (and FooBar may have multiple different passwords)
|
||||||
|
key, separator, value = secret.rpartition("/")
|
||||||
|
if key.empty?
|
||||||
|
secret_titles << value
|
||||||
|
else
|
||||||
|
secret_titles << key
|
||||||
|
end
|
||||||
|
end.to_a
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_result_and_take_secrets(unparsed_result, secrets)
|
||||||
|
result = JSON.parse(unparsed_result)
|
||||||
|
|
||||||
|
result.reduce({}) do |secrets_with_passwords, item|
|
||||||
|
title = item["title"]
|
||||||
|
label = item["label"]
|
||||||
|
password = item["password"]
|
||||||
|
|
||||||
|
if title && password.present?
|
||||||
|
key = [ title, label ].compact.reject(&:empty?).join("/")
|
||||||
|
|
||||||
|
if secrets.include?(title) || secrets.include?(key)
|
||||||
|
raise RuntimeError, "#{key} is present more than once" if secrets_with_passwords[key]
|
||||||
|
secrets_with_passwords[key] = password
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
secrets_with_passwords
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
112
lib/kamal/secrets/adapters/gcp_secret_manager.rb
Normal file
112
lib/kamal/secrets/adapters/gcp_secret_manager.rb
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
class Kamal::Secrets::Adapters::GcpSecretManager < Kamal::Secrets::Adapters::Base
|
||||||
|
private
|
||||||
|
def login(account)
|
||||||
|
# Since only the account option is passed from the cli, we'll use it for both account and service account
|
||||||
|
# impersonation.
|
||||||
|
#
|
||||||
|
# Syntax:
|
||||||
|
# ACCOUNT: USER | USER "|" DELEGATION_CHAIN
|
||||||
|
# USER: DEFAULT_USER | EMAIL
|
||||||
|
# DELEGATION_CHAIN: EMAIL | EMAIL "," DELEGATION_CHAIN
|
||||||
|
# EMAIL: <The email address of the user or service account, like "my-user@example.com" >
|
||||||
|
# DEFAULT_USER: "default"
|
||||||
|
#
|
||||||
|
# Some valid examples:
|
||||||
|
# - "my-user@example.com" sets the user
|
||||||
|
# - "my-user@example.com|my-service-user@example.com" will use my-user and enable service account impersonation as my-service-user
|
||||||
|
# - "default" will use the default user and no impersonation
|
||||||
|
# - "default|my-service-user@example.com" will use the default user, and enable service account impersonation as my-service-user
|
||||||
|
# - "default|my-service-user@example.com,another-service-user@example.com" same as above, but with an impersonation delegation chain
|
||||||
|
|
||||||
|
unless logged_in?
|
||||||
|
`gcloud auth login`
|
||||||
|
raise RuntimeError, "could not login to gcloud" unless logged_in?
|
||||||
|
end
|
||||||
|
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
|
user, service_account = parse_account(account)
|
||||||
|
|
||||||
|
{}.tap do |results|
|
||||||
|
secrets_with_metadata(prefixed_secrets(secrets, from: from)).each do |secret, (project, secret_name, secret_version)|
|
||||||
|
item_name = "#{project}/#{secret_name}"
|
||||||
|
results[item_name] = fetch_secret(project, secret_name, secret_version, user, service_account)
|
||||||
|
raise RuntimeError, "Could not read #{item_name} from Google Secret Manager" unless $?.success?
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secret(project, secret_name, secret_version, user, service_account)
|
||||||
|
secret = run_command(
|
||||||
|
"secrets versions access #{secret_version.shellescape} --secret=#{secret_name.shellescape}",
|
||||||
|
project: project,
|
||||||
|
user: user,
|
||||||
|
service_account: service_account
|
||||||
|
)
|
||||||
|
Base64.decode64(secret.dig("payload", "data"))
|
||||||
|
end
|
||||||
|
|
||||||
|
# The secret needs to at least contain a secret name, but project name, and secret version can also be specified.
|
||||||
|
#
|
||||||
|
# The string "default" can be used to refer to the default project configured for gcloud.
|
||||||
|
#
|
||||||
|
# The version can be either the string "latest", or a version number.
|
||||||
|
#
|
||||||
|
# The following formats are valid:
|
||||||
|
#
|
||||||
|
# - The following are all equivalent, and sets project: default, secret name: my-secret, version: latest
|
||||||
|
# - "my-secret"
|
||||||
|
# - "default/my-secret"
|
||||||
|
# - "default/my-secret/latest"
|
||||||
|
# - "my-secret/latest" in combination with --from=default
|
||||||
|
# - "my-secret/123" (only in combination with --from=some-project) -> project: some-project, secret name: my-secret, version: 123
|
||||||
|
# - "some-project/my-secret/123" -> project: some-project, secret name: my-secret, version: 123
|
||||||
|
def secrets_with_metadata(secrets)
|
||||||
|
{}.tap do |items|
|
||||||
|
secrets.each do |secret|
|
||||||
|
parts = secret.split("/")
|
||||||
|
parts.unshift("default") if parts.length == 1
|
||||||
|
project = parts.shift
|
||||||
|
secret_name = parts.shift
|
||||||
|
secret_version = parts.shift || "latest"
|
||||||
|
|
||||||
|
items[secret] = [ project, secret_name, secret_version ]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def run_command(command, project: "default", user: "default", service_account: nil)
|
||||||
|
full_command = [ "gcloud", command ]
|
||||||
|
full_command << "--project=#{project.shellescape}" unless project == "default"
|
||||||
|
full_command << "--account=#{user.shellescape}" unless user == "default"
|
||||||
|
full_command << "--impersonate-service-account=#{service_account.shellescape}" if service_account
|
||||||
|
full_command << "--format=json"
|
||||||
|
full_command = full_command.join(" ")
|
||||||
|
|
||||||
|
result = `#{full_command}`.strip
|
||||||
|
JSON.parse(result)
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "gcloud CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`gcloud --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
|
|
||||||
|
def logged_in?
|
||||||
|
JSON.parse(`gcloud auth list --format=json`).any?
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_account(account)
|
||||||
|
account.split("|", 2)
|
||||||
|
end
|
||||||
|
|
||||||
|
def is_user?(candidate)
|
||||||
|
candidate.include?("@")
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -3,7 +3,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
|||||||
def login(account)
|
def login(account)
|
||||||
unless loggedin?(account)
|
unless loggedin?(account)
|
||||||
`lpass login #{account.shellescape}`
|
`lpass login #{account.shellescape}`
|
||||||
raise RuntimeError, "Failed to login to 1Password" unless $?.success?
|
raise RuntimeError, "Failed to login to LastPass" unless $?.success?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -11,9 +11,10 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
|||||||
`lpass status --color never`.strip == "Logged in as #{account}."
|
`lpass status --color never`.strip == "Logged in as #{account}."
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_secrets(secrets, account:, session:)
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
|
secrets = prefixed_secrets(secrets, from: from)
|
||||||
items = `lpass show #{secrets.map(&:shellescape).join(" ")} --json`
|
items = `lpass show #{secrets.map(&:shellescape).join(" ")} --json`
|
||||||
raise RuntimeError, "Could not read #{secrets} from 1Password" unless $?.success?
|
raise RuntimeError, "Could not read #{secrets} from LastPass" unless $?.success?
|
||||||
|
|
||||||
items = JSON.parse(items)
|
items = JSON.parse(items)
|
||||||
|
|
||||||
@@ -23,8 +24,17 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
if (missing_items = secrets - results.keys).any?
|
if (missing_items = secrets - results.keys).any?
|
||||||
raise RuntimeError, "Could not find #{missing_items.join(", ")} in LassPass"
|
raise RuntimeError, "Could not find #{missing_items.join(", ")} in LastPass"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "LastPass CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`lpass --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ class Kamal::Secrets::Adapters::OnePassword < Kamal::Secrets::Adapters::Base
|
|||||||
$?.success?
|
$?.success?
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_secrets(secrets, account:, session:)
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
{}.tap do |results|
|
{}.tap do |results|
|
||||||
vaults_items_fields(secrets).map do |vault, items|
|
vaults_items_fields(prefixed_secrets(secrets, from: from)).map do |vault, items|
|
||||||
items.each do |item, fields|
|
items.each do |item, fields|
|
||||||
fields_json = JSON.parse(op_item_get(vault, item, fields, account: account, session: session))
|
fields_json = JSON.parse(op_item_get(vault, item, fields, account: account, session: session))
|
||||||
fields_json = [ fields_json ] if fields.one?
|
fields_json = [ fields_json ] if fields.one?
|
||||||
@@ -58,4 +58,13 @@ class Kamal::Secrets::Adapters::OnePassword < Kamal::Secrets::Adapters::Base
|
|||||||
raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success?
|
raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "1Password CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`op --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,7 +4,11 @@ class Kamal::Secrets::Adapters::Test < Kamal::Secrets::Adapters::Base
|
|||||||
true
|
true
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_secrets(secrets, account:, session:)
|
def fetch_secrets(secrets, from:, account:, session:)
|
||||||
secrets.to_h { |secret| [ secret, secret.reverse ] }
|
prefixed_secrets(secrets, from: from).to_h { |secret| [ secret, secret.reverse ] }
|
||||||
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
# no op
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -12,6 +12,8 @@ module Kamal::Utils
|
|||||||
attr = "#{key}=#{escape_shell_value(value)}"
|
attr = "#{key}=#{escape_shell_value(value)}"
|
||||||
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
||||||
[ argument, attr ]
|
[ argument, attr ]
|
||||||
|
elsif value == false
|
||||||
|
[ argument, "#{key}=false" ]
|
||||||
else
|
else
|
||||||
[ argument, key ]
|
[ argument, key ]
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
module Kamal
|
module Kamal
|
||||||
VERSION = "2.0.0.rc2"
|
VERSION = "2.5.0"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ class CliAccessoryTest < CliTestCase
|
|||||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
||||||
|
|
||||||
run_command("boot", "mysql").tap do |output|
|
run_command("boot", "mysql").tap do |output|
|
||||||
assert_match /docker login.*on 1.1.1.3/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --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", output
|
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -24,24 +24,28 @@ class CliAccessoryTest < CliTestCase
|
|||||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:directories).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:directories).with("redis")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:directories).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("busybox")
|
||||||
|
|
||||||
run_command("boot", "all").tap do |output|
|
run_command("boot", "all").tap do |output|
|
||||||
assert_match /docker login.*on 1.1.1.3/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||||
assert_match /docker login.*on 1.1.1.1/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||||
assert_match /docker login.*on 1.1.1.2/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.2", output
|
||||||
|
assert_match "docker login other.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||||
assert_match /docker network create kamal.*on 1.1.1.1/, output
|
assert_match /docker network create kamal.*on 1.1.1.1/, output
|
||||||
assert_match /docker network create kamal.*on 1.1.1.2/, output
|
assert_match /docker network create kamal.*on 1.1.1.2/, output
|
||||||
assert_match /docker network create kamal.*on 1.1.1.3/, output
|
assert_match /docker network create kamal.*on 1.1.1.3/, output
|
||||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --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", output
|
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
||||||
|
assert_match "docker run --name custom-box --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-box\" other.registry/busybox:latest on 1.1.1.3", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "upload" do
|
test "upload" do
|
||||||
run_command("upload", "mysql").tap do |output|
|
run_command("upload", "mysql").tap do |output|
|
||||||
assert_match "mkdir -p app-mysql/etc/mysql", output
|
assert_match "mkdir -p app-mysql/etc/mysql", output
|
||||||
assert_match "test/fixtures/files/my.cnf app-mysql/etc/mysql/my.cnf", output
|
assert_match "test/fixtures/files/my.cnf to app-mysql/etc/mysql/my.cnf", output
|
||||||
assert_match "chmod 755 app-mysql/etc/mysql/my.cnf", output
|
assert_match "chmod 755 app-mysql/etc/mysql/my.cnf", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -60,13 +64,16 @@ class CliAccessoryTest < CliTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "reboot all" do
|
test "reboot all" do
|
||||||
Kamal::Commands::Registry.any_instance.expects(:login).times(3)
|
Kamal::Commands::Registry.any_instance.expects(:login).times(4)
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("mysql")
|
Kamal::Cli::Accessory.any_instance.expects(:stop).with("mysql")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("mysql")
|
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("mysql")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:boot).with("mysql", prepare: false)
|
Kamal::Cli::Accessory.any_instance.expects(:boot).with("mysql", prepare: false)
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:stop).with("redis")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:boot).with("redis", prepare: false)
|
Kamal::Cli::Accessory.any_instance.expects(:boot).with("redis", prepare: false)
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:stop).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:boot).with("busybox", prepare: false)
|
||||||
|
|
||||||
run_command("reboot", "all")
|
run_command("reboot", "all")
|
||||||
end
|
end
|
||||||
@@ -94,7 +101,7 @@ class CliAccessoryTest < CliTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "details with non-existent accessory" do
|
test "details with non-existent accessory" do
|
||||||
assert_equal "No accessory by the name of 'hello' (options: mysql and redis)", stderred { run_command("details", "hello") }
|
assert_equal "No accessory by the name of 'hello' (options: mysql, redis, and busybox)", stderred { run_command("details", "hello") }
|
||||||
end
|
end
|
||||||
|
|
||||||
test "details with all" do
|
test "details with all" do
|
||||||
@@ -180,6 +187,10 @@ class CliAccessoryTest < CliTestCase
|
|||||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:remove_image).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:remove_image).with("redis")
|
||||||
Kamal::Cli::Accessory.any_instance.expects(:remove_service_directory).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:remove_service_directory).with("redis")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:stop).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:remove_image).with("busybox")
|
||||||
|
Kamal::Cli::Accessory.any_instance.expects(:remove_service_directory).with("busybox")
|
||||||
|
|
||||||
run_command("remove", "all", "-y")
|
run_command("remove", "all", "-y")
|
||||||
end
|
end
|
||||||
@@ -189,7 +200,7 @@ class CliAccessoryTest < CliTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "remove_image" do
|
test "remove_image" do
|
||||||
assert_match "docker image rm --force mysql", run_command("remove_image", "mysql")
|
assert_match "docker image rm --force private.registry/mysql:5.7", run_command("remove_image", "mysql")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove_service_directory" do
|
test "remove_service_directory" do
|
||||||
@@ -201,8 +212,8 @@ class CliAccessoryTest < CliTestCase
|
|||||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||||
|
|
||||||
run_command("boot", "redis", "--hosts", "1.1.1.1").tap do |output|
|
run_command("boot", "redis", "--hosts", "1.1.1.1").tap do |output|
|
||||||
assert_match /docker login.*on 1.1.1.1/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||||
assert_no_match /docker login.*on 1.1.1.2/, output
|
assert_no_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.2", output
|
||||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||||
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
||||||
end
|
end
|
||||||
@@ -213,8 +224,8 @@ class CliAccessoryTest < CliTestCase
|
|||||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||||
|
|
||||||
run_command("boot", "redis", "--hosts", "1.1.1.1,1.1.1.3").tap do |output|
|
run_command("boot", "redis", "--hosts", "1.1.1.1,1.1.1.3").tap do |output|
|
||||||
assert_match /docker login.*on 1.1.1.1/, output
|
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||||
assert_no_match /docker login.*on 1.1.1.3/, output
|
assert_no_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||||
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.3", output
|
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.3", output
|
||||||
end
|
end
|
||||||
@@ -225,7 +236,7 @@ class CliAccessoryTest < CliTestCase
|
|||||||
assert_match "Upgrading all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
assert_match "Upgrading all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
||||||
assert_match "docker network create kamal on 1.1.1.3", output
|
assert_match "docker network create kamal on 1.1.1.3", output
|
||||||
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
||||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --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", output
|
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||||
assert_match "Upgraded all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
assert_match "Upgraded all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -235,14 +246,13 @@ class CliAccessoryTest < CliTestCase
|
|||||||
assert_match "Upgrading all accessories on 1.1.1.3...", output
|
assert_match "Upgrading all accessories on 1.1.1.3...", output
|
||||||
assert_match "docker network create kamal on 1.1.1.3", output
|
assert_match "docker network create kamal on 1.1.1.3", output
|
||||||
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
||||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --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", output
|
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||||
assert_match "Upgraded all accessories on 1.1.1.3", output
|
assert_match "Upgraded all accessories on 1.1.1.3", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted { Kamal::Cli::Accessory.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
stdouted { Kamal::Cli::Accessory.start([ *command, "-c", "test/fixtures/deploy_with_accessories_with_different_registries.yml" ]) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123") # old version
|
.returns("123") # old version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
@@ -37,13 +37,20 @@ class CliAppTest < CliTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "boot uses group strategy when specified" do
|
test "boot uses group strategy when specified" do
|
||||||
Kamal::Cli::App.any_instance.stubs(:on).with("1.1.1.1").times(2) # ensure locks dir, acquire & release lock
|
Kamal::Cli::App.any_instance.stubs(:on).with("1.1.1.1").twice
|
||||||
Kamal::Cli::App.any_instance.stubs(:on).with([ "1.1.1.1" ]) # tag container
|
Kamal::Cli::App.any_instance.stubs(:on).with([ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ]).times(3)
|
||||||
|
|
||||||
# Strategy is used when booting the containers
|
# Strategy is used when booting the containers
|
||||||
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.1" ], in: :groups, limit: 3, wait: 2).with_block_given
|
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.1", "1.1.1.2", "1.1.1.3" ]).with_block_given
|
||||||
|
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.4" ]).with_block_given
|
||||||
|
Object.any_instance.expects(:sleep).with(2).twice
|
||||||
|
|
||||||
run_command("boot", config: :with_boot_strategy)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
|
|
||||||
|
run_command("boot", config: :with_boot_strategy, host: nil).tap do |output|
|
||||||
|
assert_hook_ran "pre-app-boot", output, count: 2
|
||||||
|
assert_hook_ran "post-app-boot", output, count: 2
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "boot errors don't leave lock in place" do
|
test "boot errors don't leave lock in place" do
|
||||||
@@ -63,7 +70,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123").twice # old version
|
.returns("123").twice # old version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
@@ -73,7 +80,7 @@ class CliAppTest < CliTestCase
|
|||||||
run_command("boot", config: :with_assets).tap do |output|
|
run_command("boot", config: :with_assets).tap do |output|
|
||||||
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-123 || true ; cp -rnT .kamal/apps/app/assets/extracted/web-123 .kamal/apps/app/assets/volumes/web-latest || true", output
|
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-123 || true ; cp -rnT .kamal/apps/app/assets/extracted/web-123 .kamal/apps/app/assets/volumes/web-latest || true", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/extracted/web-latest && docker stop -t 1 app-web-assets 2> /dev/null || true && docker run --name app-web-assets --detach --rm --entrypoint sleep dhh/app:latest 1000000 && docker cp -L app-web-assets:/public/assets/. .kamal/apps/app/assets/extracted/web-latest && docker stop -t 1 app-web-assets", output
|
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/extracted/web-latest && docker container rm app-web-assets 2> /dev/null || true && docker container create --name app-web-assets dhh/app:latest && docker container cp -L app-web-assets:/public/assets/. .kamal/apps/app/assets/extracted/web-latest && docker container rm app-web-assets", output
|
||||||
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} /, output
|
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} /, output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
||||||
assert_match "/usr/bin/env find .kamal/apps/app/assets/extracted -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" + ; find .kamal/apps/app/assets/volumes -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" +", output
|
assert_match "/usr/bin/env find .kamal/apps/app/assets/extracted -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" + ; find .kamal/apps/app/assets/volumes -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" +", output
|
||||||
@@ -92,7 +99,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123") # old version
|
.returns("123") # old version
|
||||||
|
|
||||||
run_command("boot", config: :with_env_tags).tap do |output|
|
run_command("boot", config: :with_env_tags).tap do |output|
|
||||||
@@ -130,7 +137,7 @@ class CliAppTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false)
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false)
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||||
.with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target", "\"123:80\"", "--deploy-timeout", "\"1s\"", "--drain-timeout", "\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header", "\"Cache-Control\"", "--log-request-header", "\"Last-Modified\"", "--log-request-header", "\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy"))
|
.with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target=\"123:80\"", "--deploy-timeout=\"1s\"", "--drain-timeout=\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header=\"Cache-Control\"", "--log-request-header=\"Last-Modified\"", "--log-request-header=\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy"))
|
||||||
|
|
||||||
stderred do
|
stderred do
|
||||||
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
|
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
|
||||||
@@ -190,23 +197,23 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
run_command("start").tap do |output|
|
run_command("start").tap do |output|
|
||||||
assert_match "docker start app-web-999", output
|
assert_match "docker start app-web-999", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"999:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"999:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\"", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stop" do
|
test "stop" do
|
||||||
run_command("stop").tap do |output|
|
run_command("stop").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop", output
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stale_containers" do
|
test "stale_containers" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=destination=", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n87654321\n")
|
.returns("12345678\n87654321\n")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n")
|
.returns("12345678\n")
|
||||||
|
|
||||||
run_command("stale_containers").tap do |output|
|
run_command("stale_containers").tap do |output|
|
||||||
@@ -216,11 +223,11 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "stop stale_containers" do
|
test "stop stale_containers" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=destination=", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n87654321\n")
|
.returns("12345678\n87654321\n")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n")
|
.returns("12345678\n")
|
||||||
|
|
||||||
run_command("stale_containers", "--stop").tap do |output|
|
run_command("stale_containers", "--stop").tap do |output|
|
||||||
@@ -231,13 +238,13 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "details" do
|
test "details" do
|
||||||
run_command("details").tap do |output|
|
run_command("details").tap do |output|
|
||||||
assert_match "docker ps --filter label=service=app --filter label=role=web", output
|
assert_match "docker ps --filter label=service=app --filter label=destination= --filter label=role=web", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove" do
|
test "remove" do
|
||||||
run_command("remove").tap do |output|
|
run_command("remove").tap do |output|
|
||||||
assert_match /#{Regexp.escape("sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop")}/, output
|
assert_match /#{Regexp.escape("sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop")}/, output
|
||||||
assert_match /#{Regexp.escape("docker container prune --force --filter label=service=app")}/, output
|
assert_match /#{Regexp.escape("docker container prune --force --filter label=service=app")}/, output
|
||||||
assert_match /#{Regexp.escape("docker image prune --all --force --filter label=service=app")}/, output
|
assert_match /#{Regexp.escape("docker image prune --all --force --filter label=service=app")}/, output
|
||||||
end
|
end
|
||||||
@@ -263,26 +270,50 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "exec" do
|
test "exec" do
|
||||||
run_command("exec", "ruby -v").tap do |output|
|
run_command("exec", "ruby -v").tap do |output|
|
||||||
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env dhh/app:latest ruby -v", output
|
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "exec separate arguments" do
|
test "exec separate arguments" do
|
||||||
run_command("exec", "ruby", " -v").tap do |output|
|
run_command("exec", "ruby", " -v").tap do |output|
|
||||||
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env dhh/app:latest ruby -v", output
|
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec detach" do
|
||||||
|
run_command("exec", "--detach", "ruby -v").tap do |output|
|
||||||
|
assert_match "docker run --detach --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec detach with reuse" do
|
||||||
|
assert_raises(ArgumentError, "Detach is not compatible with reuse") do
|
||||||
|
run_command("exec", "--detach", "--reuse", "ruby -v")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec detach with interactive" do
|
||||||
|
assert_raises(ArgumentError, "Detach is not compatible with interactive") do
|
||||||
|
run_command("exec", "--interactive", "--detach", "ruby -v")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "exec detach with interactive and reuse" do
|
||||||
|
assert_raises(ArgumentError, "Detach is not compatible with interactive or reuse") do
|
||||||
|
run_command("exec", "--interactive", "--detach", "--reuse", "ruby -v")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "exec with reuse" do
|
test "exec with reuse" do
|
||||||
run_command("exec", "--reuse", "ruby -v").tap do |output|
|
run_command("exec", "--reuse", "ruby -v").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output # Get current version
|
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output # Get current version
|
||||||
assert_match "docker exec app-web-999 ruby -v", output
|
assert_match "docker exec app-web-999 ruby -v", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "exec interactive" do
|
test "exec interactive" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:exec)
|
SSHKit::Backend::Abstract.any_instance.expects(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env dhh/app:latest ruby -v'")
|
.with("ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v'")
|
||||||
run_command("exec", "-i", "ruby -v").tap do |output|
|
run_command("exec", "-i", "ruby -v").tap do |output|
|
||||||
assert_match "Get most recent version available as an image...", output
|
assert_match "Get most recent version available as an image...", output
|
||||||
assert_match "Launching interactive command with version latest via SSH from new container on 1.1.1.1...", output
|
assert_match "Launching interactive command with version latest via SSH from new container on 1.1.1.1...", output
|
||||||
@@ -294,7 +325,7 @@ class CliAppTest < CliTestCase
|
|||||||
.with("ssh -t root@1.1.1.1 -p 22 'docker exec -it app-web-999 ruby -v'")
|
.with("ssh -t root@1.1.1.1 -p 22 'docker exec -it app-web-999 ruby -v'")
|
||||||
run_command("exec", "-i", "--reuse", "ruby -v").tap do |output|
|
run_command("exec", "-i", "--reuse", "ruby -v").tap do |output|
|
||||||
assert_match "Get current version of running container...", output
|
assert_match "Get current version of running container...", output
|
||||||
assert_match "Running /usr/bin/env sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done on 1.1.1.1", output
|
assert_match "Running /usr/bin/env sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done on 1.1.1.1", output
|
||||||
assert_match "Launching interactive command with version 999 via SSH from existing container on 1.1.1.1...", output
|
assert_match "Launching interactive command with version 999 via SSH from existing container on 1.1.1.1...", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -313,46 +344,55 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 'sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1| xargs docker logs --timestamps --tail 10 2>&1'")
|
.with("ssh -t root@1.1.1.1 'sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1| xargs docker logs --timestamps --tail 10 2>&1'")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1", run_command("logs")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1", run_command("logs")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey'", run_command("logs", "--grep", "hey")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey'", run_command("logs", "--grep", "hey")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey' -C 2", run_command("logs", "--grep", "hey", "--grep-options", "-C 2")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey' -C 2", run_command("logs", "--grep", "hey", "--grep-options", "-C 2")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow" do
|
test "logs with follow" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1", run_command("logs", "--follow")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1", run_command("logs", "--follow")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "logs with follow and container_id" do
|
||||||
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
|
.with("ssh -t root@1.1.1.1 -p 22 'echo ID123 | xargs docker logs --timestamps --tail 10 --follow 2>&1'")
|
||||||
|
|
||||||
|
assert_match "echo ID123 | xargs docker logs --timestamps --tail 10 --follow 2>&1", run_command("logs", "--follow", "--container-id", "ID123")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow and grep" do
|
test "logs with follow and grep" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"", run_command("logs", "--follow", "--grep", "hey")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"", run_command("logs", "--follow", "--grep", "hey")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow, grep and grep options" do
|
test "logs with follow, grep and grep options" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2", run_command("logs", "--follow", "--grep", "hey", "--grep-options", "-C 2")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2", run_command("logs", "--follow", "--grep", "hey", "--grep-options", "-C 2")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "version" do
|
test "version" do
|
||||||
run_command("version").tap do |output|
|
run_command("version").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "version through main" do
|
test "version through main" do
|
||||||
stdouted { Kamal::Cli::Main.start([ "app", "version", "-c", "test/fixtures/deploy_with_accessories.yml", "--hosts", "1.1.1.1" ]) }.tap do |output|
|
with_argv([ "app", "version", "-c", "test/fixtures/deploy_with_accessories.yml", "--hosts", "1.1.1.1" ]) do
|
||||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||||
|
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -383,7 +423,7 @@ class CliAppTest < CliTestCase
|
|||||||
assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename
|
assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename
|
||||||
assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output
|
assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output
|
||||||
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output
|
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output
|
||||||
assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target "123:80"/, output
|
assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target="123:80"/, output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -392,8 +432,8 @@ class CliAppTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
|
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
|
||||||
|
|
||||||
run_command("boot", config: :with_proxy_roles, host: nil).tap do |output|
|
run_command("boot", config: :with_proxy_roles, host: nil).tap do |output|
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"10s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"10s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"15s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"15s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ class CliBuildTest < CliTestCase
|
|||||||
test "push" do
|
test "push" do
|
||||||
with_build_directory do |build_directory|
|
with_build_directory do |build_directory|
|
||||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "build", subcommand: "push" }
|
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||||
@@ -22,11 +21,33 @@ class CliBuildTest < CliTestCase
|
|||||||
.returns("")
|
.returns("")
|
||||||
|
|
||||||
run_command("push", "--verbose").tap do |output|
|
run_command("push", "--verbose").tap do |output|
|
||||||
assert_hook_ran "pre-build", output, **hook_variables
|
assert_hook_ran "pre-build", output
|
||||||
assert_match /Cloning repo into build directory/, output
|
assert_match /Cloning repo into build directory/, output
|
||||||
assert_match /git -C #{Dir.tmpdir}\/kamal-clones\/app-#{pwd_sha} clone #{Dir.pwd}/, output
|
assert_match /git -C #{Dir.tmpdir}\/kamal-clones\/app-#{pwd_sha} clone #{Dir.pwd}/, output
|
||||||
assert_match /docker --version && docker buildx version/, output
|
assert_match /docker --version && docker buildx version/, output
|
||||||
assert_match /docker buildx build --push --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. as .*@localhost/, output
|
assert_match /docker buildx build --output=type=registry --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. as .*@localhost/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "push --output=docker" do
|
||||||
|
with_build_directory do |build_directory|
|
||||||
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
|
|
||||||
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
|
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||||
|
.returns(Kamal::Git.revision)
|
||||||
|
|
||||||
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
|
.with(:git, "-C", anything, :status, "--porcelain")
|
||||||
|
.returns("")
|
||||||
|
|
||||||
|
run_command("push", "--output=docker", "--verbose").tap do |output|
|
||||||
|
assert_hook_ran "pre-build", output
|
||||||
|
assert_match /Cloning repo into build directory/, output
|
||||||
|
assert_match /git -C #{Dir.tmpdir}\/kamal-clones\/app-#{pwd_sha} clone #{Dir.pwd}/, output
|
||||||
|
assert_match /docker --version && docker buildx version/, output
|
||||||
|
assert_match /docker buildx build --output=type=docker --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. as .*@localhost/, output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -49,7 +70,7 @@ class CliBuildTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.expects(:execute).with(:git, "-C", build_directory, :submodule, :update, "--init")
|
SSHKit::Backend::Abstract.any_instance.expects(:execute).with(:git, "-C", build_directory, :submodule, :update, "--init")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||||
.with(:docker, :buildx, :build, "--push", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
.with(:docker, :buildx, :build, "--output=type=registry", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||||
@@ -68,13 +89,12 @@ class CliBuildTest < CliTestCase
|
|||||||
|
|
||||||
test "push without clone" do
|
test "push without clone" do
|
||||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "build", subcommand: "push" }
|
|
||||||
|
|
||||||
run_command("push", "--verbose", fixture: :without_clone).tap do |output|
|
run_command("push", "--verbose", fixture: :without_clone).tap do |output|
|
||||||
assert_no_match /Cloning repo into build directory/, output
|
assert_no_match /Cloning repo into build directory/, output
|
||||||
assert_hook_ran "pre-build", output, **hook_variables
|
assert_hook_ran "pre-build", output
|
||||||
assert_match /docker --version && docker buildx version/, output
|
assert_match /docker --version && docker buildx version/, output
|
||||||
assert_match /docker buildx build --push --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile . as .*@localhost/, output
|
assert_match /docker buildx build --output=type=registry --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile . as .*@localhost/, output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -140,7 +160,7 @@ class CliBuildTest < CliTestCase
|
|||||||
.returns("")
|
.returns("")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||||
.with(:docker, :buildx, :build, "--push", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
.with(:docker, :buildx, :build, "--output=type=registry", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
||||||
|
|
||||||
run_command("push").tap do |output|
|
run_command("push").tap do |output|
|
||||||
assert_match /WARN Missing compatible builder, so creating a new one first/, output
|
assert_match /WARN Missing compatible builder, so creating a new one first/, output
|
||||||
@@ -155,7 +175,7 @@ class CliBuildTest < CliTestCase
|
|||||||
.raises(SSHKit::Command::Failed.new("no buildx"))
|
.raises(SSHKit::Command::Failed.new("no buildx"))
|
||||||
|
|
||||||
Kamal::Commands::Builder.any_instance.stubs(:native_and_local?).returns(false)
|
Kamal::Commands::Builder.any_instance.stubs(:native_and_local?).returns(false)
|
||||||
assert_raises(Kamal::Cli::Build::BuildError) { run_command("push") }
|
assert_raises(Kamal::Cli::DependencyError) { run_command("push") }
|
||||||
end
|
end
|
||||||
|
|
||||||
test "push pre-build hook failure" do
|
test "push pre-build hook failure" do
|
||||||
@@ -235,6 +255,12 @@ class CliBuildTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "create cloud" do
|
||||||
|
run_command("create", fixture: :with_cloud_builder).tap do |output|
|
||||||
|
assert_match /docker buildx create --driver cloud example_org\/cloud_builder/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
test "create with error" do
|
test "create with error" do
|
||||||
stub_setup
|
stub_setup
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||||
@@ -252,6 +278,12 @@ class CliBuildTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "remove cloud" do
|
||||||
|
run_command("remove", fixture: :with_cloud_builder).tap do |output|
|
||||||
|
assert_match /docker buildx rm cloud-example_org-cloud_builder/, output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
test "details" do
|
test "details" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture)
|
SSHKit::Backend::Abstract.any_instance.stubs(:capture)
|
||||||
.with(:docker, :context, :ls, "&&", :docker, :buildx, :ls)
|
.with(:docker, :context, :ls, "&&", :docker, :buildx, :ls)
|
||||||
@@ -263,6 +295,30 @@ class CliBuildTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "dev" do
|
||||||
|
with_build_directory do |build_directory|
|
||||||
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
|
|
||||||
|
run_command("dev", "--verbose").tap do |output|
|
||||||
|
assert_no_match(/Cloning repo into build directory/, output)
|
||||||
|
assert_match(/docker --version && docker buildx version/, output)
|
||||||
|
assert_match(/docker buildx build --output=type=docker --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999-dirty -t dhh\/app:latest-dirty --label service="app" --file Dockerfile \. as .*@localhost/, output)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "dev --output=local" do
|
||||||
|
with_build_directory do |build_directory|
|
||||||
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
|
|
||||||
|
run_command("dev", "--output=local", "--verbose").tap do |output|
|
||||||
|
assert_no_match(/Cloning repo into build directory/, output)
|
||||||
|
assert_match(/docker --version && docker buildx version/, output)
|
||||||
|
assert_match(/docker buildx build --output=type=local --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999-dirty -t dhh\/app:latest-dirty --label service="app" --file Dockerfile \. as .*@localhost/, output)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command, fixture: :with_accessories)
|
def run_command(*command, fixture: :with_accessories)
|
||||||
stdouted { Kamal::Cli::Build.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
stdouted { Kamal::Cli::Build.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
||||||
@@ -274,17 +330,4 @@ class CliBuildTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||||
.with { |*args| args[0..1] == [ :docker, :buildx ] }
|
.with { |*args| args[0..1] == [ :docker, :buildx ] }
|
||||||
end
|
end
|
||||||
|
|
||||||
def with_build_directory
|
|
||||||
build_directory = File.join Dir.tmpdir, "kamal-clones", "app-#{pwd_sha}", "kamal"
|
|
||||||
FileUtils.mkdir_p build_directory
|
|
||||||
FileUtils.touch File.join build_directory, "Dockerfile"
|
|
||||||
yield build_directory + "/"
|
|
||||||
ensure
|
|
||||||
FileUtils.rm_rf build_directory
|
|
||||||
end
|
|
||||||
|
|
||||||
def pwd_sha
|
|
||||||
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -40,8 +40,9 @@ class CliTestCase < ActiveSupport::TestCase
|
|||||||
.with(:docker, :buildx, :inspect, "kamal-local-docker-container")
|
.with(:docker, :buildx, :inspect, "kamal-local-docker-container")
|
||||||
end
|
end
|
||||||
|
|
||||||
def assert_hook_ran(hook, output, version:, service_version:, hosts:, command:, subcommand: nil, runtime: false, secrets: false)
|
def assert_hook_ran(hook, output, count: 1)
|
||||||
assert_match %r{usr/bin/env\s\.kamal/hooks/#{hook}}, output
|
regexp = ([ "/usr/bin/env .kamal/hooks/#{hook}" ] * count).join(".*")
|
||||||
|
assert_match /#{regexp}/m, output
|
||||||
end
|
end
|
||||||
|
|
||||||
def with_argv(*argv)
|
def with_argv(*argv)
|
||||||
@@ -51,4 +52,17 @@ class CliTestCase < ActiveSupport::TestCase
|
|||||||
ensure
|
ensure
|
||||||
ARGV.replace(old_argv)
|
ARGV.replace(old_argv)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def with_build_directory
|
||||||
|
build_directory = File.join Dir.tmpdir, "kamal-clones", "app-#{pwd_sha}", "kamal"
|
||||||
|
FileUtils.mkdir_p build_directory
|
||||||
|
FileUtils.touch File.join build_directory, "Dockerfile"
|
||||||
|
yield build_directory + "/"
|
||||||
|
ensure
|
||||||
|
FileUtils.rm_rf build_directory
|
||||||
|
end
|
||||||
|
|
||||||
|
def pwd_sha
|
||||||
|
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -8,8 +8,7 @@ class CliMainTest < CliTestCase
|
|||||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
||||||
|
|
||||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:server:bootstrap", [], invoke_options)
|
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:server:bootstrap", [], invoke_options)
|
||||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:accessory:boot", [ "all" ], invoke_options)
|
Kamal::Cli::Main.any_instance.expects(:deploy).with(boot_accessories: true)
|
||||||
Kamal::Cli::Main.any_instance.expects(:deploy)
|
|
||||||
|
|
||||||
run_command("setup").tap do |output|
|
run_command("setup").tap do |output|
|
||||||
assert_match /Ensure Docker is installed.../, output
|
assert_match /Ensure Docker is installed.../, output
|
||||||
@@ -54,17 +53,16 @@ class CliMainTest < CliTestCase
|
|||||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:prune:all", [], invoke_options)
|
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:prune:all", [], invoke_options)
|
||||||
|
|
||||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2", command: "deploy" }
|
|
||||||
|
|
||||||
run_command("deploy", "--verbose").tap do |output|
|
run_command("deploy", "--verbose").tap do |output|
|
||||||
assert_hook_ran "pre-connect", output, **hook_variables
|
assert_hook_ran "pre-connect", output
|
||||||
assert_match /Log into image registry/, output
|
assert_match /Log into image registry/, output
|
||||||
assert_match /Build and push app image/, output
|
assert_match /Build and push app image/, output
|
||||||
assert_hook_ran "pre-deploy", output, **hook_variables, secrets: true
|
assert_hook_ran "pre-deploy", output
|
||||||
assert_match /Ensure kamal-proxy is running/, output
|
assert_match /Ensure kamal-proxy is running/, output
|
||||||
assert_match /Detect stale containers/, output
|
assert_match /Detect stale containers/, output
|
||||||
assert_match /Prune old containers and images/, output
|
assert_match /Prune old containers and images/, output
|
||||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true, secrets: true
|
assert_hook_ran "post-deploy", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -206,14 +204,12 @@ class CliMainTest < CliTestCase
|
|||||||
|
|
||||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
|
|
||||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2", command: "redeploy" }
|
|
||||||
|
|
||||||
run_command("redeploy", "--verbose").tap do |output|
|
run_command("redeploy", "--verbose").tap do |output|
|
||||||
assert_hook_ran "pre-connect", output, **hook_variables
|
assert_hook_ran "pre-connect", output
|
||||||
assert_match /Build and push app image/, output
|
assert_match /Build and push app image/, output
|
||||||
assert_hook_ran "pre-deploy", output, **hook_variables
|
assert_hook_ran "pre-deploy", output
|
||||||
assert_match /Running the pre-deploy hook.../, output
|
assert_match /Running the pre-deploy hook.../, output
|
||||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true
|
assert_hook_ran "post-deploy", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -250,7 +246,7 @@ class CliMainTest < CliTestCase
|
|||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-#{role}-123$", "--quiet")
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-#{role}-123$", "--quiet")
|
||||||
.returns("version-to-rollback\n").at_least_once
|
.returns("version-to-rollback\n").at_least_once
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=#{role} --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=#{role} --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-#{role}-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=#{role} --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=#{role} --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-#{role}-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("version-to-rollback\n").at_least_once
|
.returns("version-to-rollback\n").at_least_once
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -259,14 +255,13 @@ class CliMainTest < CliTestCase
|
|||||||
.returns("running").at_least_once # health check
|
.returns("running").at_least_once # health check
|
||||||
|
|
||||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||||
hook_variables = { version: 123, service_version: "app@123", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "rollback" }
|
|
||||||
|
|
||||||
run_command("rollback", "--verbose", "123", config_file: "deploy_with_accessories").tap do |output|
|
run_command("rollback", "--verbose", "123", config_file: "deploy_with_accessories").tap do |output|
|
||||||
assert_hook_ran "pre-deploy", output, **hook_variables
|
assert_hook_ran "pre-deploy", output
|
||||||
assert_match "docker tag dhh/app:123 dhh/app:latest", output
|
assert_match "docker tag dhh/app:123 dhh/app:latest", output
|
||||||
assert_match "docker run --detach --restart unless-stopped --name app-web-123", output
|
assert_match "docker run --detach --restart unless-stopped --name app-web-123", output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-version-to-rollback$ --quiet | xargs docker stop", output, "Should stop the container that was previously running"
|
assert_match "docker container ls --all --filter name=^app-web-version-to-rollback$ --quiet | xargs docker stop", output, "Should stop the container that was previously running"
|
||||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true
|
assert_hook_ran "post-deploy", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -280,7 +275,7 @@ class CliMainTest < CliTestCase
|
|||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
||||||
.returns("123").at_least_once
|
.returns("123").at_least_once
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("").at_least_once
|
.returns("").at_least_once
|
||||||
|
|
||||||
run_command("rollback", "123").tap do |output|
|
run_command("rollback", "123").tap do |output|
|
||||||
@@ -460,6 +455,7 @@ class CliMainTest < CliTestCase
|
|||||||
|
|
||||||
test "run an alias for a console" do
|
test "run an alias for a console" do
|
||||||
run_command("console", config_file: "deploy_with_aliases").tap do |output|
|
run_command("console", config_file: "deploy_with_aliases").tap do |output|
|
||||||
|
assert_no_match "App Host: 1.1.1.4", output
|
||||||
assert_match "docker exec app-console-999 bin/console on 1.1.1.5", output
|
assert_match "docker exec app-console-999 bin/console on 1.1.1.5", output
|
||||||
assert_match "App Host: 1.1.1.5", output
|
assert_match "App Host: 1.1.1.5", output
|
||||||
end
|
end
|
||||||
@@ -486,6 +482,33 @@ class CliMainTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "switch config file with an alias" do
|
||||||
|
with_config_files do
|
||||||
|
with_argv([ "other_config" ]) do
|
||||||
|
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||||
|
assert_match ":service_with_version: app2-999", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "switch destination with an alias" do
|
||||||
|
with_config_files do
|
||||||
|
with_argv([ "other_destination_config" ]) do
|
||||||
|
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||||
|
assert_match ":service_with_version: app3-999", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run on primary via alias" do
|
||||||
|
run_command("primary_details", config_file: "deploy_with_aliases").tap do |output|
|
||||||
|
assert_match "App Host: 1.1.1.1", output
|
||||||
|
assert_no_match "App Host: 1.1.1.2", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
test "upgrade" do
|
test "upgrade" do
|
||||||
invoke_options = { "config_file" => "test/fixtures/deploy_with_accessories.yml", "skip_hooks" => false, "confirmed" => true, "rolling" => false }
|
invoke_options = { "config_file" => "test/fixtures/deploy_with_accessories.yml", "skip_hooks" => false, "confirmed" => true, "rolling" => false }
|
||||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:upgrade", [], invoke_options)
|
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:upgrade", [], invoke_options)
|
||||||
@@ -530,6 +553,20 @@ class CliMainTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def with_config_files
|
||||||
|
Dir.mktmpdir do |tmpdir|
|
||||||
|
config_dir = File.join(tmpdir, "config")
|
||||||
|
FileUtils.mkdir_p(config_dir)
|
||||||
|
FileUtils.cp "test/fixtures/deploy.yml", config_dir
|
||||||
|
FileUtils.cp "test/fixtures/deploy2.yml", config_dir
|
||||||
|
FileUtils.cp "test/fixtures/deploy.elsewhere.yml", config_dir
|
||||||
|
|
||||||
|
Dir.chdir(tmpdir) do
|
||||||
|
yield
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def assert_file(file, content)
|
def assert_file(file, content)
|
||||||
assert_match content, File.read(file)
|
assert_match content, File.read(file)
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ class CliProxyTest < CliTestCase
|
|||||||
test "boot" do
|
test "boot" do
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -18,11 +18,11 @@ class CliProxyTest < CliTestCase
|
|||||||
exception = assert_raises do
|
exception = assert_raises do
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
assert_includes exception.message, "kamal-proxy version v0.0.1 is too old, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
assert_includes exception.message, "kamal-proxy version v0.0.1 is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||||
ensure
|
ensure
|
||||||
Thread.report_on_exception = false
|
Thread.report_on_exception = false
|
||||||
end
|
end
|
||||||
@@ -36,7 +36,7 @@ class CliProxyTest < CliTestCase
|
|||||||
|
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
|
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
ensure
|
ensure
|
||||||
Thread.report_on_exception = false
|
Thread.report_on_exception = false
|
||||||
@@ -55,16 +55,14 @@ class CliProxyTest < CliTestCase
|
|||||||
|
|
||||||
run_command("reboot", "-y").tap do |output|
|
run_command("reboot", "-y").tap do |output|
|
||||||
assert_match "docker container stop kamal-proxy on 1.1.1.1", output
|
assert_match "docker container stop kamal-proxy on 1.1.1.1", output
|
||||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
|
|
||||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image} on 1.1.1.1", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.1", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.1", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.1", output
|
||||||
|
|
||||||
assert_match "docker container stop kamal-proxy on 1.1.1.2", output
|
assert_match "docker container stop kamal-proxy on 1.1.1.2", output
|
||||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
|
|
||||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
|
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image} on 1.1.1.2", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.2", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.2", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.2", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -198,13 +196,13 @@ class CliProxyTest < CliTestCase
|
|||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
assert_match "docker network create kamal", output
|
assert_match "docker network create kamal", output
|
||||||
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
||||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output
|
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
|
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
|
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
|
||||||
assert_match %r{/usr/bin/env .* .kamal/apps/app/env/roles/web.env}, output
|
assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output
|
||||||
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
|
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"12345678:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"12345678:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
|
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
|
||||||
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
@@ -236,6 +234,106 @@ class CliProxyTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "boot_config set" do
|
||||||
|
run_command("boot_config", "set").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set no publish" do
|
||||||
|
run_command("boot_config", "set", "--publish", "false").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set custom max_size" do
|
||||||
|
run_command("boot_config", "set", "--log-max-size", "100m").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=100m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set no log max size" do
|
||||||
|
run_command("boot_config", "set", "--log-max-size=").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 80:80 --publish 443:443\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set custom ports" do
|
||||||
|
run_command("boot_config", "set", "--http-port", "8080", "--https-port", "8443").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 8080:80 --publish 8443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set bind IP" do
|
||||||
|
run_command("boot_config", "set", "--publish-host-ip", "127.0.0.1").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 127.0.0.1:80:80 --publish 127.0.0.1:443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set multiple bind IPs" do
|
||||||
|
run_command("boot_config", "set", "--publish-host-ip", "127.0.0.1", "--publish-host-ip", "::1").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 127.0.0.1:80:80 --publish 127.0.0.1:443:443 --publish [::1]:80:80 --publish [::1]:443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set invalid bind IPs" do
|
||||||
|
exception = assert_raises do
|
||||||
|
run_command("boot_config", "set", "--publish-host-ip", "1.2.3.invalidIP", "--publish-host-ip", "::1")
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_includes exception.message, "Invalid publish IP address: 1.2.3.invalidIP"
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config set docker options" do
|
||||||
|
run_command("boot_config", "set", "--docker_options", "label=foo=bar", "add_host=thishost:thathost").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
|
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m --label=foo=bar --add_host=thishost:thathost\" to .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config get" do
|
||||||
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
|
.with(:cat, ".kamal/proxy/options", "||", :echo, "\"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"")
|
||||||
|
.returns("--publish 80:80 --publish 8443:443 --label=foo=bar")
|
||||||
|
.twice
|
||||||
|
|
||||||
|
run_command("boot_config", "get").tap do |output|
|
||||||
|
assert_match "Host 1.1.1.1: --publish 80:80 --publish 8443:443 --label=foo=bar", output
|
||||||
|
assert_match "Host 1.1.1.2: --publish 80:80 --publish 8443:443 --label=foo=bar", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
test "boot_config reset" do
|
||||||
|
run_command("boot_config", "reset").tap do |output|
|
||||||
|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||||
|
assert_match "rm .kamal/proxy/options on #{host}", output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command, fixture: :with_proxy)
|
def run_command(*command, fixture: :with_proxy)
|
||||||
stdouted { Kamal::Cli::Proxy.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
stdouted { Kamal::Cli::Proxy.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
||||||
|
|||||||
@@ -43,6 +43,16 @@ class CliRegistryTest < CliTestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "login with no docker" do
|
||||||
|
stub_setup
|
||||||
|
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||||
|
.with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||||
|
.raises(SSHKit::Command::Failed.new("command not found"))
|
||||||
|
|
||||||
|
assert_raises(Kamal::Cli::DependencyError) { run_command("login") }
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted { Kamal::Cli::Registry.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
stdouted { Kamal::Cli::Registry.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||||
|
|||||||
@@ -7,6 +7,12 @@ class CliSecretsTest < CliTestCase
|
|||||||
run_command("fetch", "foo", "bar", "baz", "--account", "myaccount", "--adapter", "test")
|
run_command("fetch", "foo", "bar", "baz", "--account", "myaccount", "--adapter", "test")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch missing --acount" do
|
||||||
|
assert_equal \
|
||||||
|
"No value provided for required options '--account'",
|
||||||
|
run_command("fetch", "foo", "bar", "baz", "--adapter", "test")
|
||||||
|
end
|
||||||
|
|
||||||
test "extract" do
|
test "extract" do
|
||||||
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||||
end
|
end
|
||||||
@@ -15,6 +21,12 @@ class CliSecretsTest < CliTestCase
|
|||||||
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "print" do
|
||||||
|
with_test_secrets("secrets" => "SECRET1=ABC\nSECRET2=${SECRET1}DEF\n") do
|
||||||
|
assert_equal "SECRET1=ABC\nSECRET2=ABCDEF", run_command("print")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||||
|
|||||||
@@ -104,28 +104,6 @@ class CommanderTest < ActiveSupport::TestCase
|
|||||||
assert_equal [ "web", "workers" ], @kamal.roles_on("1.1.1.1").map(&:name)
|
assert_equal [ "web", "workers" ], @kamal.roles_on("1.1.1.1").map(&:name)
|
||||||
end
|
end
|
||||||
|
|
||||||
test "default group strategy" do
|
|
||||||
assert_empty @kamal.boot_strategy
|
|
||||||
end
|
|
||||||
|
|
||||||
test "specific limit group strategy" do
|
|
||||||
configure_with(:deploy_with_boot_strategy)
|
|
||||||
|
|
||||||
assert_equal({ in: :groups, limit: 3, wait: 2 }, @kamal.boot_strategy)
|
|
||||||
end
|
|
||||||
|
|
||||||
test "percentage-based group strategy" do
|
|
||||||
configure_with(:deploy_with_percentage_boot_strategy)
|
|
||||||
|
|
||||||
assert_equal({ in: :groups, limit: 1, wait: 2 }, @kamal.boot_strategy)
|
|
||||||
end
|
|
||||||
|
|
||||||
test "percentage-based group strategy limit is at least 1" do
|
|
||||||
configure_with(:deploy_with_low_percentage_boot_strategy)
|
|
||||||
|
|
||||||
assert_equal({ in: :groups, limit: 1, wait: 2 }, @kamal.boot_strategy)
|
|
||||||
end
|
|
||||||
|
|
||||||
test "try to match the primary role from a list of specific roles" do
|
test "try to match the primary role from a list of specific roles" do
|
||||||
configure_with(:deploy_primary_web_role_override)
|
configure_with(:deploy_primary_web_role_override)
|
||||||
|
|
||||||
@@ -150,6 +128,27 @@ class CommanderTest < ActiveSupport::TestCase
|
|||||||
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
|
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "accessory hosts without filtering" do
|
||||||
|
configure_with(:deploy_with_single_accessory)
|
||||||
|
assert_equal [ "1.1.1.5" ], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
configure_with(:deploy_with_accessories_on_independent_server)
|
||||||
|
assert_equal [ "1.1.1.5", "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
test "accessory hosts with role filtering" do
|
||||||
|
configure_with(:deploy_with_single_accessory)
|
||||||
|
@kamal.specific_roles = [ "web" ]
|
||||||
|
assert_equal [], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
configure_with(:deploy_with_accessories_on_independent_server)
|
||||||
|
@kamal.specific_roles = [ "web" ]
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
@kamal.specific_roles = [ "workers" ]
|
||||||
|
assert_equal [], @kamal.accessory_hosts
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def configure_with(variant)
|
def configure_with(variant)
|
||||||
@kamal = Kamal::Commander.new.tap do |kamal|
|
@kamal = Kamal::Commander.new.tap do |kamal|
|
||||||
|
|||||||
@@ -5,7 +5,9 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
setup_test_secrets("secrets" => "MYSQL_ROOT_PASSWORD=secret123")
|
setup_test_secrets("secrets" => "MYSQL_ROOT_PASSWORD=secret123")
|
||||||
|
|
||||||
@config = {
|
@config = {
|
||||||
service: "app", image: "dhh/app", registry: { "server" => "private.registry", "username" => "dhh", "password" => "secret" },
|
service: "app",
|
||||||
|
image: "dhh/app",
|
||||||
|
registry: { "server" => "private.registry", "username" => "dhh", "password" => "secret" },
|
||||||
servers: [ "1.1.1.1" ],
|
servers: [ "1.1.1.1" ],
|
||||||
builder: { "arch" => "amd64" },
|
builder: { "arch" => "amd64" },
|
||||||
accessories: {
|
accessories: {
|
||||||
@@ -39,7 +41,11 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
"busybox" => {
|
"busybox" => {
|
||||||
"service" => "custom-busybox",
|
"service" => "custom-busybox",
|
||||||
"image" => "busybox:latest",
|
"image" => "busybox:latest",
|
||||||
"host" => "1.1.1.7"
|
"registry" => { "server" => "other.registry", "username" => "user", "password" => "pw" },
|
||||||
|
"host" => "1.1.1.7",
|
||||||
|
"proxy" => {
|
||||||
|
"host" => "busybox.example.com"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -59,7 +65,7 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
new_command(:redis).run.join(" ")
|
new_command(:redis).run.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" busybox:latest",
|
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" other.registry/busybox:latest",
|
||||||
new_command(:busybox).run.join(" ")
|
new_command(:busybox).run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -67,10 +73,18 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
|
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" busybox:latest",
|
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" other.registry/busybox:latest",
|
||||||
new_command(:busybox).run.join(" ")
|
new_command(:busybox).run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "run in custom network" do
|
||||||
|
@config[:accessories]["mysql"]["network"] = "custom"
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run --name app-mysql --detach --restart unless-stopped --network custom --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --label service=\"app-mysql\" private.registry/mysql:8.0",
|
||||||
|
new_command(:mysql).run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
test "start" do
|
test "start" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container start app-mysql",
|
"docker container start app-mysql",
|
||||||
@@ -89,7 +103,6 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
new_command(:mysql).info.join(" ")
|
new_command(:mysql).info.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "execute in new container" do
|
test "execute in new container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --rm --network kamal --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env private.registry/mysql:8.0 mysql -u root",
|
"docker run --rm --network kamal --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env private.registry/mysql:8.0 mysql -u root",
|
||||||
@@ -116,8 +129,6 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker logs app-mysql --timestamps 2>&1",
|
"docker logs app-mysql --timestamps 2>&1",
|
||||||
@@ -158,6 +169,18 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
new_command(:mysql).remove_image.join(" ")
|
new_command(:mysql).remove_image.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "deploy" do
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy custom-busybox --target=\"172.1.0.2:80\" --host=\"busybox.example.com\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command(:busybox).deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "remove" do
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy remove custom-busybox",
|
||||||
|
new_command(:busybox).remove.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def new_command(accessory)
|
def new_command(accessory)
|
||||||
Kamal::Commands::Accessory.new(Kamal::Configuration.new(@config), name: accessory)
|
Kamal::Commands::Accessory.new(Kamal::Configuration.new(@config), name: accessory)
|
||||||
|
|||||||
@@ -79,18 +79,18 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "stop" do
|
test "stop" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
||||||
new_command.stop.join(" ")
|
new_command.stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stop with custom drain timeout" do
|
test "stop with custom drain timeout" do
|
||||||
@config[:drain_timeout] = 20
|
@config[:drain_timeout] = 20
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
||||||
new_command.stop.join(" ")
|
new_command.stop.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=workers --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=workers --filter status=running --filter status=restarting' | head -1 | xargs docker stop -t 20",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=workers --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=workers --filter status=running --filter status=restarting' | head -1 | xargs docker stop -t 20",
|
||||||
new_command(role: "workers").stop.join(" ")
|
new_command(role: "workers").stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "info" do
|
test "info" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.info.join(" ")
|
new_command.info.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -115,114 +115,162 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "deploy" do
|
test "deploy" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker exec kamal-proxy kamal-proxy deploy app-web --target \"172.1.0.2:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"",
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL" do
|
||||||
|
@config[:proxy] = { "ssl" => true, "host" => "example.com" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL targeting multiple hosts" do
|
||||||
|
@config[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --host=\"anotherexample.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL false" do
|
||||||
|
@config[:proxy] = { "ssl" => false }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
new_command.deploy(target: "172.1.0.2").join(" ")
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove" do
|
test "remove" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"",
|
"docker exec kamal-proxy kamal-proxy remove app-web",
|
||||||
new_command.remove(target: "172.1.0.2").join(" ")
|
new_command.remove.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1",
|
||||||
new_command.logs.join(" ")
|
new_command.logs.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "logs with container_id" do
|
||||||
|
assert_equal \
|
||||||
|
"echo C137 | xargs docker logs --timestamps 2>&1",
|
||||||
|
new_command.logs(container_id: "C137").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
test "logs with since" do
|
test "logs with since" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1",
|
||||||
new_command.logs(since: "5m").join(" ")
|
new_command.logs(since: "5m").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with lines" do
|
test "logs with lines" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1",
|
||||||
new_command.logs(lines: "100").join(" ")
|
new_command.logs(lines: "100").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since and lines" do
|
test "logs with since and lines" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m --tail 100 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m --tail 100 2>&1",
|
||||||
new_command.logs(since: "5m", lines: "100").join(" ")
|
new_command.logs(since: "5m", lines: "100").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with grep" do
|
test "logs with grep" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id'",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id'",
|
||||||
new_command.logs(grep: "my-id").join(" ")
|
new_command.logs(grep: "my-id").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with grep and grep options" do
|
test "logs with grep and grep options" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id' -C 2",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id' -C 2",
|
||||||
new_command.logs(grep: "my-id", grep_options: "-C 2").join(" ")
|
new_command.logs(grep: "my-id", grep_options: "-C 2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since, grep and grep options" do
|
test "logs with since, grep and grep options" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id' -C 2",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id' -C 2",
|
||||||
new_command.logs(since: "5m", grep: "my-id", grep_options: "-C 2").join(" ")
|
new_command.logs(since: "5m", grep: "my-id", grep_options: "-C 2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since and grep" do
|
test "logs with since and grep" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id'",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id'",
|
||||||
new_command.logs(since: "5m", grep: "my-id").join(" ")
|
new_command.logs(since: "5m", grep: "my-id").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "follow logs" do
|
test "follow logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1'",
|
||||||
new_command.follow_logs(host: "app-1")
|
new_command.follow_logs(host: "app-1")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", grep: "Completed")
|
new_command.follow_logs(host: "app-1", grep: "Completed")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1'",
|
"ssh -t root@app-1 -p 22 'echo ID321 | xargs docker logs --timestamps --follow 2>&1'",
|
||||||
|
new_command.follow_logs(host: "app-1", container_id: "ID321")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1'",
|
||||||
new_command.follow_logs(host: "app-1", lines: 123)
|
new_command.follow_logs(host: "app-1", lines: 123)
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", lines: 123, grep: "Completed")
|
new_command.follow_logs(host: "app-1", lines: 123, grep: "Completed")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", timestamps: false, lines: 123, grep: "Completed")
|
new_command.follow_logs(host: "app-1", timestamps: false, lines: 123, grep: "Completed")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "execute in new container" do
|
test "execute in new container" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env dhh/app:999 bin/rails db:setup",
|
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:999 bin/rails db:setup",
|
||||||
|
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "execute in new container with logging" do
|
||||||
|
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" dhh/app:999 bin/rails db:setup",
|
||||||
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container with env" do
|
test "execute in new container with env" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --env foo=\"bar\" dhh/app:999 bin/rails db:setup",
|
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --env foo=\"bar\" --log-opt max-size=\"10m\" dhh/app:999 bin/rails db:setup",
|
||||||
new_command.execute_in_new_container("bin/rails", "db:setup", env: { "foo" => "bar" }).join(" ")
|
new_command.execute_in_new_container("bin/rails", "db:setup", env: { "foo" => "bar" }).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "execute in new detached container" do
|
||||||
|
assert_equal \
|
||||||
|
"docker run --detach --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:999 bin/rails db:setup",
|
||||||
|
new_command.execute_in_new_container("bin/rails", "db:setup", detach: true, env: {}).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
test "execute in new container with tags" do
|
test "execute in new container with tags" do
|
||||||
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
||||||
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --rm --network kamal --env ENV1=\"value1\" --env-file .kamal/apps/app/env/roles/web.env dhh/app:999 bin/rails db:setup",
|
"docker run --rm --network kamal --env ENV1=\"value1\" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:999 bin/rails db:setup",
|
||||||
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container with custom options" do
|
test "execute in new container with custom options" do
|
||||||
@config[:servers] = { "web" => { "hosts" => [ "1.1.1.1" ], "options" => { "mount" => "somewhere", "cap-add" => true } } }
|
@config[:servers] = { "web" => { "hosts" => [ "1.1.1.1" ], "options" => { "mount" => "somewhere", "cap-add" => true } } }
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --mount \"somewhere\" --cap-add dhh/app:999 bin/rails db:setup",
|
"docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" --mount \"somewhere\" --cap-add dhh/app:999 bin/rails db:setup",
|
||||||
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
new_command.execute_in_new_container("bin/rails", "db:setup", env: {}).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -239,7 +287,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container over ssh" do
|
test "execute in new container over ssh" do
|
||||||
assert_match %r{docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env dhh/app:999 bin/rails c},
|
assert_match %r{docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" dhh/app:999 bin/rails c},
|
||||||
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -247,13 +295,13 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
||||||
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
||||||
|
|
||||||
assert_equal "ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --network kamal --env ENV1=\"value1\" --env-file .kamal/apps/app/env/roles/web.env dhh/app:999 bin/rails c'",
|
assert_equal "ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --network kamal --env ENV1=\"value1\" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:999 bin/rails c'",
|
||||||
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
||||||
end
|
end
|
||||||
|
|
||||||
test "execute in new container with custom options over ssh" do
|
test "execute in new container with custom options over ssh" do
|
||||||
@config[:servers] = { "web" => { "hosts" => [ "1.1.1.1" ], "options" => { "mount" => "somewhere", "cap-add" => true } } }
|
@config[:servers] = { "web" => { "hosts" => [ "1.1.1.1" ], "options" => { "mount" => "somewhere", "cap-add" => true } } }
|
||||||
assert_match %r{docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --mount \"somewhere\" --cap-add dhh/app:999 bin/rails c},
|
assert_match %r{docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" --mount \"somewhere\" --cap-add dhh/app:999 bin/rails c},
|
||||||
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
new_command.execute_in_new_container_over_ssh("bin/rails", "c", env: {})
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -291,6 +339,16 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
assert_equal "ssh -J root@2.2.2.2 -t app@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
assert_equal "ssh -J root@2.2.2.2 -t app@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "run over ssh with keys config" do
|
||||||
|
@config[:ssh] = { "keys" => [ "path_to_key.pem" ] }
|
||||||
|
assert_equal "ssh -i path_to_key.pem -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "run over ssh with keys config with keys_only" do
|
||||||
|
@config[:ssh] = { "keys" => [ "path_to_key.pem" ], "keys_only" => true }
|
||||||
|
assert_equal "ssh -i path_to_key.pem -o IdentitiesOnly=yes -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
|
end
|
||||||
|
|
||||||
test "run over ssh with proxy_command" do
|
test "run over ssh with proxy_command" do
|
||||||
@config[:ssh] = { "proxy_command" => "ssh -W %h:%p user@proxy-server" }
|
@config[:ssh] = { "proxy_command" => "ssh -W %h:%p user@proxy-server" }
|
||||||
assert_equal "ssh -o ProxyCommand='ssh -W %h:%p user@proxy-server' -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
assert_equal "ssh -o ProxyCommand='ssh -W %h:%p user@proxy-server' -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
|
||||||
@@ -298,7 +356,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "current_running_container_id" do
|
test "current_running_container_id" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1",
|
||||||
new_command.current_running_container_id.join(" ")
|
new_command.current_running_container_id.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -317,23 +375,23 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "current_running_version" do
|
test "current_running_version" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done",
|
"sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.current_running_version.join(" ")
|
new_command.current_running_version.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "list_versions" do
|
test "list_versions" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.list_versions.join(" ")
|
new_command.list_versions.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --latest --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --latest --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.list_versions("--latest", statuses: [ :running, :restarting ]).join(" ")
|
new_command.list_versions("--latest", statuses: [ :running, :restarting ]).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "list_containers" do
|
test "list_containers" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container ls --all --filter label=service=app --filter label=role=web",
|
"docker container ls --all --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.list_containers.join(" ")
|
new_command.list_containers.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -346,7 +404,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "list_container_names" do
|
test "list_container_names" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container ls --all --filter label=service=app --filter label=role=web --format '{{ .Names }}'",
|
"docker container ls --all --filter label=service=app --filter label=destination= --filter label=role=web --format '{{ .Names }}'",
|
||||||
new_command.list_container_names.join(" ")
|
new_command.list_container_names.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -365,7 +423,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "remove_containers" do
|
test "remove_containers" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container prune --force --filter label=service=app --filter label=role=web",
|
"docker container prune --force --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.remove_containers.join(" ")
|
new_command.remove_containers.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -384,14 +442,14 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "remove_images" do
|
test "remove_images" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker image prune --all --force --filter label=service=app --filter label=role=web",
|
"docker image prune --all --force --filter label=service=app",
|
||||||
new_command.remove_images.join(" ")
|
new_command.remove_images.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove_images with destination" do
|
test "remove_images with destination" do
|
||||||
@destination = "staging"
|
@destination = "staging"
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker image prune --all --force --filter label=service=app --filter label=destination=staging --filter label=role=web",
|
"docker image prune --all --force --filter label=service=app",
|
||||||
new_command.remove_images.join(" ")
|
new_command.remove_images.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -411,10 +469,10 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
test "extract assets" do
|
test "extract assets" do
|
||||||
assert_equal [
|
assert_equal [
|
||||||
:mkdir, "-p", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
:mkdir, "-p", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
||||||
:docker, :stop, "-t 1", "app-web-assets", "2> /dev/null", "|| true", "&&",
|
:docker, :container, :rm, "app-web-assets", "2> /dev/null", "|| true", "&&",
|
||||||
:docker, :run, "--name", "app-web-assets", "--detach", "--rm", "--entrypoint", "sleep", "dhh/app:999", "1000000", "&&",
|
:docker, :container, :create, "--name", "app-web-assets", "dhh/app:999", "&&",
|
||||||
:docker, :cp, "-L", "app-web-assets:/public/assets/.", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
:docker, :container, :cp, "-L", "app-web-assets:/public/assets/.", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
||||||
:docker, :stop, "-t 1", "app-web-assets"
|
:docker, :container, :rm, "app-web-assets"
|
||||||
], new_command(asset_path: "/public/assets").extract_assets
|
], new_command(asset_path: "/public/assets").extract_assets
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
||||||
assert_equal "local", builder.name
|
assert_equal "local", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "arch" => [ "amd64" ] })
|
builder = new_builder_command(builder: { "arch" => [ "amd64" ] })
|
||||||
assert_equal "local", builder.name
|
assert_equal "local", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -25,7 +25,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
||||||
assert_equal "local", builder.name
|
assert_equal "local", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -33,7 +33,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" } })
|
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" } })
|
||||||
assert_equal "hybrid", builder.name
|
assert_equal "hybrid", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder kamal-hybrid-docker-container-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64,linux/arm64 --builder kamal-hybrid-docker-container-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" }, "local" => false })
|
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" }, "local" => false })
|
||||||
assert_equal "remote", builder.name
|
assert_equal "remote", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder kamal-remote-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64,linux/arm64 --builder kamal-remote-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "arch" => [ "#{remote_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
builder = new_builder_command(builder: { "arch" => [ "#{remote_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
||||||
assert_equal "remote", builder.name
|
assert_equal "remote", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/#{remote_arch} --builder kamal-remote-ssh---app-host -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/#{remote_arch} --builder kamal-remote-ssh---app-host -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -57,14 +57,22 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "arch" => [ "#{local_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
builder = new_builder_command(builder: { "arch" => [ "#{local_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
||||||
assert_equal "local", builder.name
|
assert_equal "local", builder.name
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/#{local_arch} --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/#{local_arch} --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "cloud builder" do
|
||||||
|
builder = new_builder_command(builder: { "arch" => [ "#{local_arch}" ], "driver" => "cloud docker-org-name/builder-name" })
|
||||||
|
assert_equal "cloud", builder.name
|
||||||
|
assert_equal \
|
||||||
|
"docker buildx build --output=type=registry --platform linux/#{local_arch} --builder cloud-docker-org-name-builder-name -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "build args" do
|
test "build args" do
|
||||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile",
|
"--label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile",
|
||||||
builder.target.build_options.join(" ")
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -73,7 +81,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
FileUtils.touch("Dockerfile")
|
FileUtils.touch("Dockerfile")
|
||||||
builder = new_builder_command(builder: { "secrets" => [ "token_a", "token_b" ] })
|
builder = new_builder_command(builder: { "secrets" => [ "token_a", "token_b" ] })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"token_a\" --secret id=\"token_b\" --file Dockerfile",
|
"--label service=\"app\" --secret id=\"token_a\" --secret id=\"token_b\" --file Dockerfile",
|
||||||
builder.target.build_options.join(" ")
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -82,7 +90,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
Pathname.any_instance.expects(:exist?).returns(true).once
|
Pathname.any_instance.expects(:exist?).returns(true).once
|
||||||
builder = new_builder_command(builder: { "dockerfile" => "Dockerfile.xyz" })
|
builder = new_builder_command(builder: { "dockerfile" => "Dockerfile.xyz" })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile.xyz",
|
"--label service=\"app\" --file Dockerfile.xyz",
|
||||||
builder.target.build_options.join(" ")
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -97,21 +105,21 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
test "build target" do
|
test "build target" do
|
||||||
builder = new_builder_command(builder: { "target" => "prod" })
|
builder = new_builder_command(builder: { "target" => "prod" })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --target prod",
|
"--label service=\"app\" --file Dockerfile --target prod",
|
||||||
builder.target.build_options.join(" ")
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "build context" do
|
test "build context" do
|
||||||
builder = new_builder_command(builder: { "context" => ".." })
|
builder = new_builder_command(builder: { "context" => ".." })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ..",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ..",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "push with build args" do
|
test "push with build args" do
|
||||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -120,7 +128,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
FileUtils.touch("Dockerfile")
|
FileUtils.touch("Dockerfile")
|
||||||
builder = new_builder_command(builder: { "secrets" => [ "a", "b" ] })
|
builder = new_builder_command(builder: { "secrets" => [ "a", "b" ] })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"a\" --secret id=\"b\" --file Dockerfile .",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"a\" --secret id=\"b\" --file Dockerfile .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -129,7 +137,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder = new_builder_command(builder: { "ssh" => "default=$SSH_AUTH_SOCK" })
|
builder = new_builder_command(builder: { "ssh" => "default=$SSH_AUTH_SOCK" })
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --ssh default=$SSH_AUTH_SOCK",
|
"--label service=\"app\" --file Dockerfile --ssh default=$SSH_AUTH_SOCK",
|
||||||
builder.target.build_options.join(" ")
|
builder.target.build_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -140,7 +148,35 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
test "context build" do
|
test "context build" do
|
||||||
builder = new_builder_command(builder: { "context" => "./foo" })
|
builder = new_builder_command(builder: { "context" => "./foo" })
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ./foo",
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ./foo",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "push with provenance" do
|
||||||
|
builder = new_builder_command(builder: { "provenance" => "mode=max" })
|
||||||
|
assert_equal \
|
||||||
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance mode=max .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "push with provenance false" do
|
||||||
|
builder = new_builder_command(builder: { "provenance" => false })
|
||||||
|
assert_equal \
|
||||||
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance false .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "push with sbom" do
|
||||||
|
builder = new_builder_command(builder: { "sbom" => true })
|
||||||
|
assert_equal \
|
||||||
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --sbom true .",
|
||||||
|
builder.push.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "push with sbom false" do
|
||||||
|
builder = new_builder_command(builder: { "sbom" => false })
|
||||||
|
assert_equal \
|
||||||
|
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --sbom false .",
|
||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -149,15 +185,26 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
|
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "clone path with spaces" do
|
||||||
|
command = new_builder_command
|
||||||
|
Kamal::Git.stubs(:root).returns("/absolute/path with spaces")
|
||||||
|
clone_command = command.clone.join(" ")
|
||||||
|
clone_reset_commands = command.clone_reset_steps.map { |a| a.join(" ") }
|
||||||
|
|
||||||
|
assert_match(%r{path\\ with\\ space}, clone_command)
|
||||||
|
assert_no_match(%r{path with spaces}, clone_command)
|
||||||
|
|
||||||
|
clone_reset_commands.each do |command|
|
||||||
|
assert_match(%r{path\\ with\\ space}, command)
|
||||||
|
assert_no_match(%r{path with spaces}, command)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def new_builder_command(additional_config = {})
|
def new_builder_command(additional_config = {})
|
||||||
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
|
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_directory
|
|
||||||
"#{Dir.tmpdir}/kamal-clones/app/kamal/"
|
|
||||||
end
|
|
||||||
|
|
||||||
def local_arch
|
def local_arch
|
||||||
Kamal::Utils.docker_arch
|
Kamal::Utils.docker_arch
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -15,13 +15,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "run" do
|
test "run" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||||
new_command.run.join(" ")
|
|
||||||
end
|
|
||||||
|
|
||||||
test "run with ports configured" do
|
|
||||||
assert_equal \
|
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
|
||||||
new_command.run.join(" ")
|
new_command.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -29,15 +23,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
@config.delete(:proxy)
|
@config.delete(:proxy)
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||||
new_command.run.join(" ")
|
|
||||||
end
|
|
||||||
|
|
||||||
test "run with logging config" do
|
|
||||||
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
|
|
||||||
|
|
||||||
assert_equal \
|
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
|
||||||
new_command.run.join(" ")
|
new_command.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -119,6 +105,24 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
new_command.version.join(" ")
|
new_command.version.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ensure_proxy_directory" do
|
||||||
|
assert_equal \
|
||||||
|
"mkdir -p .kamal/proxy",
|
||||||
|
new_command.ensure_proxy_directory.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "get_boot_options" do
|
||||||
|
assert_equal \
|
||||||
|
"cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"",
|
||||||
|
new_command.get_boot_options.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "reset_boot_options" do
|
||||||
|
assert_equal \
|
||||||
|
"rm .kamal/proxy/options",
|
||||||
|
new_command.reset_boot_options.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def new_command
|
def new_command
|
||||||
Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123"))
|
Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123"))
|
||||||
|
|||||||
@@ -2,14 +2,27 @@ require "test_helper"
|
|||||||
|
|
||||||
class CommandsRegistryTest < ActiveSupport::TestCase
|
class CommandsRegistryTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@config = { service: "app",
|
@config = {
|
||||||
|
service: "app",
|
||||||
image: "dhh/app",
|
image: "dhh/app",
|
||||||
registry: { "username" => "dhh",
|
registry: {
|
||||||
|
"username" => "dhh",
|
||||||
"password" => "secret",
|
"password" => "secret",
|
||||||
"server" => "hub.docker.com"
|
"server" => "hub.docker.com"
|
||||||
},
|
},
|
||||||
builder: { "arch" => "amd64" },
|
builder: { "arch" => "amd64" },
|
||||||
servers: [ "1.1.1.1" ]
|
servers: [ "1.1.1.1" ],
|
||||||
|
accessories: {
|
||||||
|
"db" => {
|
||||||
|
"image" => "mysql:8.0",
|
||||||
|
"hosts" => [ "1.1.1.1" ],
|
||||||
|
"registry" => {
|
||||||
|
"username" => "user",
|
||||||
|
"password" => "pw",
|
||||||
|
"server" => "other.hub.docker.com"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -19,13 +32,24 @@ class CommandsRegistryTest < ActiveSupport::TestCase
|
|||||||
registry.login.join(" ")
|
registry.login.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "given registry login" do
|
||||||
|
assert_equal \
|
||||||
|
"docker login other.hub.docker.com -u \"user\" -p \"pw\"",
|
||||||
|
registry.login(registry_config: accessory_registry_config).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
test "registry login with ENV password" do
|
test "registry login with ENV password" do
|
||||||
with_test_secrets("secrets" => "KAMAL_REGISTRY_PASSWORD=more-secret") do
|
with_test_secrets("secrets" => "KAMAL_REGISTRY_PASSWORD=more-secret\nKAMAL_MYSQL_REGISTRY_PASSWORD=secret-pw") do
|
||||||
@config[:registry]["password"] = [ "KAMAL_REGISTRY_PASSWORD" ]
|
@config[:registry]["password"] = [ "KAMAL_REGISTRY_PASSWORD" ]
|
||||||
|
@config[:accessories]["db"]["registry"]["password"] = [ "KAMAL_MYSQL_REGISTRY_PASSWORD" ]
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker login hub.docker.com -u \"dhh\" -p \"more-secret\"",
|
"docker login hub.docker.com -u \"dhh\" -p \"more-secret\"",
|
||||||
registry.login.join(" ")
|
registry.login.join(" ")
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker login other.hub.docker.com -u \"user\" -p \"secret-pw\"",
|
||||||
|
registry.login(registry_config: accessory_registry_config).join(" ")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -55,8 +79,22 @@ class CommandsRegistryTest < ActiveSupport::TestCase
|
|||||||
registry.logout.join(" ")
|
registry.logout.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "given registry logout" do
|
||||||
|
assert_equal \
|
||||||
|
"docker logout other.hub.docker.com",
|
||||||
|
registry.logout(registry_config: accessory_registry_config).join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def registry
|
def registry
|
||||||
Kamal::Commands::Registry.new Kamal::Configuration.new(@config)
|
Kamal::Commands::Registry.new main_config
|
||||||
|
end
|
||||||
|
|
||||||
|
def main_config
|
||||||
|
Kamal::Configuration.new(@config)
|
||||||
|
end
|
||||||
|
|
||||||
|
def accessory_registry_config
|
||||||
|
main_config.accessory("db").registry
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,7 +3,9 @@ require "test_helper"
|
|||||||
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@deploy = {
|
@deploy = {
|
||||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
service: "app",
|
||||||
|
image: "dhh/app",
|
||||||
|
registry: { "username" => "dhh", "password" => "secret" },
|
||||||
servers: {
|
servers: {
|
||||||
"web" => [ "1.1.1.1", "1.1.1.2" ],
|
"web" => [ "1.1.1.1", "1.1.1.2" ],
|
||||||
"workers" => [ "1.1.1.3", "1.1.1.4" ]
|
"workers" => [ "1.1.1.3", "1.1.1.4" ]
|
||||||
@@ -12,7 +14,7 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
env: { "REDIS_URL" => "redis://x/y" },
|
env: { "REDIS_URL" => "redis://x/y" },
|
||||||
accessories: {
|
accessories: {
|
||||||
"mysql" => {
|
"mysql" => {
|
||||||
"image" => "mysql:8.0",
|
"image" => "public.registry/mysql:8.0",
|
||||||
"host" => "1.1.1.5",
|
"host" => "1.1.1.5",
|
||||||
"port" => "3306",
|
"port" => "3306",
|
||||||
"env" => {
|
"env" => {
|
||||||
@@ -52,6 +54,7 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
"monitoring" => {
|
"monitoring" => {
|
||||||
"service" => "custom-monitoring",
|
"service" => "custom-monitoring",
|
||||||
"image" => "monitoring:latest",
|
"image" => "monitoring:latest",
|
||||||
|
"registry" => { "server" => "other.registry", "username" => "user", "password" => "pw" },
|
||||||
"roles" => [ "web" ],
|
"roles" => [ "web" ],
|
||||||
"port" => "4321:4321",
|
"port" => "4321:4321",
|
||||||
"labels" => {
|
"labels" => {
|
||||||
@@ -63,6 +66,9 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
"options" => {
|
"options" => {
|
||||||
"cpus" => "4",
|
"cpus" => "4",
|
||||||
"memory" => "2GB"
|
"memory" => "2GB"
|
||||||
|
},
|
||||||
|
"proxy" => {
|
||||||
|
"host" => "monitoring.example.com"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -77,6 +83,21 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
assert_equal "custom-monitoring", @config.accessory(:monitoring).service_name
|
assert_equal "custom-monitoring", @config.accessory(:monitoring).service_name
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "image" do
|
||||||
|
assert_equal "public.registry/mysql:8.0", @config.accessory(:mysql).image
|
||||||
|
assert_equal "redis:latest", @config.accessory(:redis).image
|
||||||
|
assert_equal "other.registry/monitoring:latest", @config.accessory(:monitoring).image
|
||||||
|
end
|
||||||
|
|
||||||
|
test "registry" do
|
||||||
|
assert_nil @config.accessory(:mysql).registry
|
||||||
|
assert_nil @config.accessory(:redis).registry
|
||||||
|
monitoring_registry = @config.accessory(:monitoring).registry
|
||||||
|
assert_equal "other.registry", monitoring_registry.server
|
||||||
|
assert_equal "user", monitoring_registry.username
|
||||||
|
assert_equal "pw", monitoring_registry.password
|
||||||
|
end
|
||||||
|
|
||||||
test "port" do
|
test "port" do
|
||||||
assert_equal "3306:3306", @config.accessory(:mysql).port
|
assert_equal "3306:3306", @config.accessory(:mysql).port
|
||||||
assert_equal "6379:6379", @config.accessory(:redis).port
|
assert_equal "6379:6379", @config.accessory(:redis).port
|
||||||
@@ -152,4 +173,18 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
test "options" do
|
test "options" do
|
||||||
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
|
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "network_args default" do
|
||||||
|
assert_equal [ "--network", "kamal" ], @config.accessory(:mysql).network_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "network_args with configured options" do
|
||||||
|
@deploy[:accessories]["mysql"]["network"] = "database"
|
||||||
|
assert_equal [ "--network", "database" ], @config.accessory(:mysql).network_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "proxy" do
|
||||||
|
assert @config.accessory(:monitoring).running_proxy?
|
||||||
|
assert_equal [ "monitoring.example.com" ], @config.accessory(:monitoring).proxy.hosts
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
54
test/configuration/boot_test.rb
Normal file
54
test/configuration/boot_test.rb
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class ConfigurationBootTest < ActiveSupport::TestCase
|
||||||
|
test "no group strategy" do
|
||||||
|
deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||||
|
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] }
|
||||||
|
}
|
||||||
|
|
||||||
|
config = Kamal::Configuration.new(deploy)
|
||||||
|
|
||||||
|
assert_nil config.boot.limit
|
||||||
|
assert_nil config.boot.wait
|
||||||
|
end
|
||||||
|
|
||||||
|
test "specific limit group strategy" do
|
||||||
|
deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||||
|
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||||
|
boot: { "limit" => 3, "wait" => 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
config = Kamal::Configuration.new(deploy)
|
||||||
|
|
||||||
|
assert_equal 3, config.boot.limit
|
||||||
|
assert_equal 2, config.boot.wait
|
||||||
|
end
|
||||||
|
|
||||||
|
test "percentage-based group strategy" do
|
||||||
|
deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||||
|
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||||
|
boot: { "limit" => "50%", "wait" => 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
config = Kamal::Configuration.new(deploy)
|
||||||
|
|
||||||
|
assert_equal 2, config.boot.limit
|
||||||
|
assert_equal 2, config.boot.wait
|
||||||
|
end
|
||||||
|
|
||||||
|
test "percentage-based group strategy limit is at least 1" do
|
||||||
|
deploy = {
|
||||||
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||||
|
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||||
|
boot: { "limit" => "1%", "wait" => 2 }
|
||||||
|
}
|
||||||
|
|
||||||
|
config = Kamal::Configuration.new(deploy)
|
||||||
|
|
||||||
|
assert_equal 1, config.boot.limit
|
||||||
|
assert_equal 2, config.boot.wait
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -64,7 +64,7 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from
|
assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=dhh/app-build-cache", config.builder.cache_to
|
assert_equal "type=registry,ref=dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "setting registry cache when using a custom registry" do
|
test "setting registry cache when using a custom registry" do
|
||||||
@@ -72,14 +72,14 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from
|
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_to
|
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "setting registry cache with image" do
|
test "setting registry cache with image" do
|
||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=kamal", config.builder.cache_from
|
assert_equal "type=registry,ref=kamal", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,ref=kamal", config.builder.cache_to
|
assert_equal "type=registry,ref=kamal,mode=max", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "args" do
|
test "args" do
|
||||||
@@ -134,6 +134,26 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
|
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "provenance" do
|
||||||
|
assert_nil config.builder.provenance
|
||||||
|
end
|
||||||
|
|
||||||
|
test "setting provenance" do
|
||||||
|
@deploy[:builder]["provenance"] = "mode=max"
|
||||||
|
|
||||||
|
assert_equal "mode=max", config.builder.provenance
|
||||||
|
end
|
||||||
|
|
||||||
|
test "sbom" do
|
||||||
|
assert_nil config.builder.sbom
|
||||||
|
end
|
||||||
|
|
||||||
|
test "setting sbom" do
|
||||||
|
@deploy[:builder]["sbom"] = true
|
||||||
|
|
||||||
|
assert_equal true, config.builder.sbom
|
||||||
|
end
|
||||||
|
|
||||||
test "local disabled but no remote set" do
|
test "local disabled but no remote set" do
|
||||||
@deploy[:builder]["local"] = false
|
@deploy[:builder]["local"] = false
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
require "test_helper"
|
require "test_helper"
|
||||||
|
|
||||||
class ConfigurationEnvTest < ActiveSupport::TestCase
|
class ConfigurationProxyTest < ActiveSupport::TestCase
|
||||||
setup do
|
setup do
|
||||||
@deploy = {
|
@deploy = {
|
||||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||||
@@ -13,11 +13,31 @@ class ConfigurationEnvTest < ActiveSupport::TestCase
|
|||||||
assert_equal true, config.proxy.ssl?
|
assert_equal true, config.proxy.ssl?
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ssl with multiple hosts passed via host" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, "host" => "example.com,anotherexample.com" }
|
||||||
|
assert_equal true, config.proxy.ssl?
|
||||||
|
end
|
||||||
|
|
||||||
|
test "ssl with multiple hosts passed via hosts" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
|
||||||
|
assert_equal true, config.proxy.ssl?
|
||||||
|
end
|
||||||
|
|
||||||
test "ssl with no host" do
|
test "ssl with no host" do
|
||||||
@deploy[:proxy] = { "ssl" => true }
|
@deploy[:proxy] = { "ssl" => true }
|
||||||
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ssl with both host and hosts" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, host: "example.com", hosts: [ "anotherexample.com" ] }
|
||||||
|
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
||||||
|
end
|
||||||
|
|
||||||
|
test "ssl false" do
|
||||||
|
@deploy[:proxy] = { "ssl" => false }
|
||||||
|
assert_not config.proxy.ssl?
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def config
|
def config
|
||||||
Kamal::Configuration.new(@deploy)
|
Kamal::Configuration.new(@deploy)
|
||||||
|
|||||||
@@ -222,6 +222,13 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
assert_equal "my-user", config.registry.username
|
assert_equal "my-user", config.registry.username
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "destination is loaded into env" do
|
||||||
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
|
config = Kamal::Configuration.create_from config_file: dest_config_file, destination: "world"
|
||||||
|
assert_equal ENV["KAMAL_DESTINATION"], "world"
|
||||||
|
end
|
||||||
|
|
||||||
test "destination yml config merge" do
|
test "destination yml config merge" do
|
||||||
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
@@ -377,4 +384,15 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "two proxy ssl roles with same host in a hosts array" do
|
||||||
|
@deploy_with_roles[:servers]["web"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "foo.example.com", "bar.example.com" ] } }
|
||||||
|
@deploy_with_roles[:servers]["workers"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "www.example.com", "foo.example.com" ] } }
|
||||||
|
|
||||||
|
exception = assert_raises(Kamal::ConfigurationError) do
|
||||||
|
Kamal::Configuration.new(@deploy_with_roles)
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -11,6 +11,16 @@ class EnvFileTest < ActiveSupport::TestCase
|
|||||||
Kamal::EnvFile.new(env).to_s
|
Kamal::EnvFile.new(env).to_s
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "to_s won't escape '#'" do
|
||||||
|
env = {
|
||||||
|
"foo" => '#$foo',
|
||||||
|
"bar" => '#{bar}'
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal "foo=\#$foo\nbar=\#{bar}\n", \
|
||||||
|
Kamal::EnvFile.new(env).to_s
|
||||||
|
end
|
||||||
|
|
||||||
test "to_str won't escape chinese characters" do
|
test "to_str won't escape chinese characters" do
|
||||||
env = {
|
env = {
|
||||||
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'
|
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'
|
||||||
|
|||||||
12
test/fixtures/deploy.elsewhere.yml
vendored
Normal file
12
test/fixtures/deploy.elsewhere.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
service: app3
|
||||||
|
image: dhh/app3
|
||||||
|
servers:
|
||||||
|
- "1.1.1.3"
|
||||||
|
- "1.1.1.4"
|
||||||
|
registry:
|
||||||
|
username: user
|
||||||
|
password: pw
|
||||||
|
builder:
|
||||||
|
arch: amd64
|
||||||
|
aliases:
|
||||||
|
other_config: config -c config/deploy2.yml
|
||||||
13
test/fixtures/deploy.yml
vendored
Normal file
13
test/fixtures/deploy.yml
vendored
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
service: app
|
||||||
|
image: dhh/app
|
||||||
|
servers:
|
||||||
|
- "1.1.1.1"
|
||||||
|
- "1.1.1.2"
|
||||||
|
registry:
|
||||||
|
username: user
|
||||||
|
password: pw
|
||||||
|
builder:
|
||||||
|
arch: amd64
|
||||||
|
aliases:
|
||||||
|
other_config: config -c config/deploy2.yml
|
||||||
|
other_destination_config: config -d elsewhere
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user