Compare commits
240 Commits
v2.0.0.bet
...
v2.4.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1547089da0 | ||
|
|
ae7a4f3411 | ||
|
|
77c202ebaf | ||
|
|
063dfd9edd | ||
|
|
3e4a190173 | ||
|
|
d9c25533e4 | ||
|
|
d5ec0e6ad2 | ||
|
|
725da6aa68 | ||
|
|
84a874e63b | ||
|
|
ba567e0474 | ||
|
|
e464177349 | ||
|
|
68e6f82b30 | ||
|
|
55983c6431 | ||
|
|
b2cf3f33a7 | ||
|
|
16fb3adacb | ||
|
|
407c8b834e | ||
|
|
3468b45014 | ||
|
|
495b3cd95f | ||
|
|
b04e8cd8d7 | ||
|
|
f5391d7fe4 | ||
|
|
2386c903ca | ||
|
|
fbc4515888 | ||
|
|
99829092b3 | ||
|
|
084d1d4a1d | ||
|
|
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 | ||
|
|
72f30774ba | ||
|
|
3fa9cd5a41 | ||
|
|
c970ceebe3 | ||
|
|
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 | ||
|
|
e71bfcbadd | ||
|
|
567309596a | ||
|
|
b89ec2bf63 | ||
|
|
3172adca30 | ||
|
|
04d21f45bb | ||
|
|
eabd57350c | ||
|
|
487f6f5f53 | ||
|
|
d98500982d | ||
|
|
8693e968c1 | ||
|
|
6ab5fc9459 | ||
|
|
6fc2915884 | ||
|
|
afa6898a82 | ||
|
|
384b36d158 | ||
|
|
6df169a4fb | ||
|
|
ab109afc52 | ||
|
|
a6a48c456c | ||
|
|
a4e5dbe5d4 | ||
|
|
56e90906b1 | ||
|
|
6e65968bdc | ||
|
|
85f1e14b97 | ||
|
|
2c829a4824 | ||
|
|
45a58f7e15 | ||
|
|
834b343ded | ||
|
|
9fe1821cae | ||
|
|
1d7c9fec1d | ||
|
|
190f4fba28 |
10
.github/workflows/ci.yml
vendored
10
.github/workflows/ci.yml
vendored
@@ -4,6 +4,7 @@ on:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
rubocop:
|
||||
name: RuboCop
|
||||
@@ -27,9 +28,13 @@ jobs:
|
||||
- "3.1"
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
- "3.4.0-preview2"
|
||||
gemfile:
|
||||
- Gemfile
|
||||
- gemfiles/rails_edge.gemfile
|
||||
exclude:
|
||||
- ruby-version: "3.1"
|
||||
gemfile: gemfiles/rails_edge.gemfile
|
||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
@@ -38,6 +43,9 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Remove gemfile.lock
|
||||
run: rm Gemfile.lock
|
||||
|
||||
- name: Install Ruby
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
@@ -46,3 +54,5 @@ jobs:
|
||||
|
||||
- name: Run tests
|
||||
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.2.0-alpine
|
||||
FROM ruby:3.3-alpine
|
||||
|
||||
# Install docker/buildx-bin
|
||||
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
|
||||
# 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
|
||||
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
||||
|
||||
129
Gemfile.lock
129
Gemfile.lock
@@ -1,152 +1,155 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
kamal (2.0.0.beta1)
|
||||
kamal (2.4.0)
|
||||
activesupport (>= 7.0)
|
||||
base64 (~> 0.2)
|
||||
bcrypt_pbkdf (~> 1.0)
|
||||
concurrent-ruby (~> 1.2)
|
||||
dotenv (~> 3.1)
|
||||
ed25519 (~> 1.2)
|
||||
net-ssh (~> 7.0)
|
||||
net-ssh (~> 7.3)
|
||||
sshkit (>= 1.23.0, < 2.0)
|
||||
thor (~> 1.3)
|
||||
zeitwerk (~> 2.5)
|
||||
zeitwerk (>= 2.6.18, < 3.0)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
actionpack (7.1.3.4)
|
||||
actionview (= 7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
actionpack (8.0.0.1)
|
||||
actionview (= 8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
nokogiri (>= 1.8.5)
|
||||
racc
|
||||
rack (>= 2.2.4)
|
||||
rack-session (>= 1.0.1)
|
||||
rack-test (>= 0.6.3)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
actionview (7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
useragent (~> 0.16)
|
||||
actionview (8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
builder (~> 3.1)
|
||||
erubi (~> 1.11)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
activesupport (7.1.3.4)
|
||||
activesupport (8.0.0.1)
|
||||
base64
|
||||
benchmark (>= 0.3)
|
||||
bigdecimal
|
||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
||||
concurrent-ruby (~> 1.0, >= 1.3.1)
|
||||
connection_pool (>= 2.2.5)
|
||||
drb
|
||||
i18n (>= 1.6, < 2)
|
||||
logger (>= 1.4.2)
|
||||
minitest (>= 5.1)
|
||||
mutex_m
|
||||
tzinfo (~> 2.0)
|
||||
securerandom (>= 0.3)
|
||||
tzinfo (~> 2.0, >= 2.0.5)
|
||||
uri (>= 0.13.1)
|
||||
ast (2.4.2)
|
||||
base64 (0.2.0)
|
||||
bcrypt_pbkdf (1.1.1)
|
||||
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||
benchmark (0.4.0)
|
||||
bigdecimal (3.1.8)
|
||||
builder (3.3.0)
|
||||
concurrent-ruby (1.3.3)
|
||||
concurrent-ruby (1.3.4)
|
||||
connection_pool (2.4.1)
|
||||
crass (1.0.6)
|
||||
date (3.4.1)
|
||||
debug (1.9.2)
|
||||
irb (~> 1.10)
|
||||
reline (>= 0.3.8)
|
||||
dotenv (3.1.2)
|
||||
dotenv (3.1.5)
|
||||
drb (2.2.1)
|
||||
ed25519 (1.3.0)
|
||||
erubi (1.13.0)
|
||||
i18n (1.14.5)
|
||||
i18n (1.14.6)
|
||||
concurrent-ruby (~> 1.0)
|
||||
io-console (0.7.2)
|
||||
irb (1.14.0)
|
||||
io-console (0.8.0)
|
||||
irb (1.14.2)
|
||||
rdoc (>= 4.0.0)
|
||||
reline (>= 0.4.2)
|
||||
json (2.7.2)
|
||||
json (2.9.0)
|
||||
language_server-protocol (3.17.0.3)
|
||||
loofah (2.22.0)
|
||||
logger (1.6.3)
|
||||
loofah (2.23.1)
|
||||
crass (~> 1.0.2)
|
||||
nokogiri (>= 1.12.0)
|
||||
minitest (5.24.1)
|
||||
mocha (2.4.5)
|
||||
minitest (5.25.4)
|
||||
mocha (2.7.1)
|
||||
ruby2_keywords (>= 0.0.5)
|
||||
mutex_m (0.2.0)
|
||||
net-scp (4.0.0)
|
||||
net-ssh (>= 2.6.5, < 8.0.0)
|
||||
net-sftp (4.0.0)
|
||||
net-ssh (>= 5.0.0, < 8.0.0)
|
||||
net-ssh (7.2.3)
|
||||
nokogiri (1.16.7-arm64-darwin)
|
||||
net-ssh (7.3.0)
|
||||
nokogiri (1.17.2-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.16.7-x86_64-darwin)
|
||||
nokogiri (1.17.2-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.16.7-x86_64-linux)
|
||||
nokogiri (1.17.2-x86_64-linux)
|
||||
racc (~> 1.4)
|
||||
parallel (1.25.1)
|
||||
parser (3.3.4.0)
|
||||
ostruct (0.6.1)
|
||||
parallel (1.26.3)
|
||||
parser (3.3.6.0)
|
||||
ast (~> 2.4.1)
|
||||
racc
|
||||
psych (5.1.2)
|
||||
psych (5.2.1)
|
||||
date
|
||||
stringio
|
||||
racc (1.8.1)
|
||||
rack (3.1.7)
|
||||
rack (3.1.8)
|
||||
rack-session (2.0.0)
|
||||
rack (>= 3.0.0)
|
||||
rack-test (2.1.0)
|
||||
rack (>= 1.3)
|
||||
rackup (2.1.0)
|
||||
rackup (2.2.1)
|
||||
rack (>= 3)
|
||||
webrick (~> 1.8)
|
||||
rails-dom-testing (2.2.0)
|
||||
activesupport (>= 5.0.0)
|
||||
minitest
|
||||
nokogiri (>= 1.6)
|
||||
rails-html-sanitizer (1.6.0)
|
||||
rails-html-sanitizer (1.6.2)
|
||||
loofah (~> 2.21)
|
||||
nokogiri (~> 1.14)
|
||||
railties (7.1.3.4)
|
||||
actionpack (= 7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
irb
|
||||
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 (8.0.0.1)
|
||||
actionpack (= 8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
irb (~> 1.13)
|
||||
rackup (>= 1.0.0)
|
||||
rake (>= 12.2)
|
||||
thor (~> 1.0, >= 1.2.2)
|
||||
zeitwerk (~> 2.6)
|
||||
rainbow (3.1.1)
|
||||
rake (13.2.1)
|
||||
rdoc (6.7.0)
|
||||
rdoc (6.8.1)
|
||||
psych (>= 4.0.0)
|
||||
regexp_parser (2.9.2)
|
||||
reline (0.5.9)
|
||||
regexp_parser (2.9.3)
|
||||
reline (0.5.12)
|
||||
io-console (~> 0.5)
|
||||
rexml (3.3.4)
|
||||
strscan
|
||||
rubocop (1.65.1)
|
||||
rubocop (1.69.2)
|
||||
json (~> 2.3)
|
||||
language_server-protocol (>= 3.17.0)
|
||||
parallel (~> 1.10)
|
||||
parser (>= 3.3.0.2)
|
||||
rainbow (>= 2.2.2, < 4.0)
|
||||
regexp_parser (>= 2.4, < 3.0)
|
||||
rexml (>= 3.2.5, < 4.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
regexp_parser (>= 2.9.3, < 3.0)
|
||||
rubocop-ast (>= 1.36.2, < 2.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (>= 2.4.0, < 3.0)
|
||||
rubocop-ast (1.32.0)
|
||||
unicode-display_width (>= 2.4.0, < 4.0)
|
||||
rubocop-ast (1.36.2)
|
||||
parser (>= 3.3.1.0)
|
||||
rubocop-minitest (0.35.1)
|
||||
rubocop-minitest (0.36.0)
|
||||
rubocop (>= 1.61, < 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-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-rails (2.25.1)
|
||||
rubocop-rails (2.27.0)
|
||||
activesupport (>= 4.2.0)
|
||||
rack (>= 1.1)
|
||||
rubocop (>= 1.33.0, < 2.0)
|
||||
rubocop (>= 1.52.0, < 2.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-rails-omakase (1.0.0)
|
||||
rubocop
|
||||
@@ -155,19 +158,23 @@ GEM
|
||||
rubocop-rails
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
sshkit (1.23.0)
|
||||
securerandom (0.4.0)
|
||||
sshkit (1.23.2)
|
||||
base64
|
||||
net-scp (>= 1.1.2)
|
||||
net-sftp (>= 2.1.2)
|
||||
net-ssh (>= 2.8.0)
|
||||
stringio (3.1.1)
|
||||
strscan (3.1.0)
|
||||
thor (1.3.1)
|
||||
ostruct
|
||||
stringio (3.1.2)
|
||||
thor (1.3.2)
|
||||
tzinfo (2.0.6)
|
||||
concurrent-ruby (~> 1.0)
|
||||
unicode-display_width (2.5.0)
|
||||
webrick (1.8.1)
|
||||
zeitwerk (2.6.17)
|
||||
unicode-display_width (3.1.2)
|
||||
unicode-emoji (~> 4.0, >= 4.0.4)
|
||||
unicode-emoji (4.0.4)
|
||||
uri (1.0.2)
|
||||
useragent (0.16.11)
|
||||
zeitwerk (2.7.1)
|
||||
|
||||
PLATFORMS
|
||||
arm64-darwin
|
||||
|
||||
16
bin/docs
16
bin/docs
@@ -30,6 +30,7 @@ DOCS = {
|
||||
"ssh" => "SSH",
|
||||
"sshkit" => "SSHKit"
|
||||
}
|
||||
DOCS_PATH = "lib/kamal/configuration/docs"
|
||||
|
||||
class DocWriter
|
||||
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)
|
||||
place = :in_section
|
||||
else
|
||||
output.puts
|
||||
output.puts "```yaml"
|
||||
output.puts line
|
||||
place = :in_yaml
|
||||
@@ -77,6 +79,7 @@ class DocWriter
|
||||
when :in_yaml, :in_empty_line_yaml
|
||||
if line =~ /^ *#/
|
||||
output.puts "```"
|
||||
output.puts
|
||||
generate_line(line, heading: place == :in_empty_line_yaml)
|
||||
place = :in_section
|
||||
elsif line.empty?
|
||||
@@ -92,11 +95,12 @@ class DocWriter
|
||||
|
||||
def generate_header
|
||||
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 "---"
|
||||
output.puts
|
||||
output.puts heading
|
||||
output.puts
|
||||
end
|
||||
|
||||
def generate_line(line, heading: false)
|
||||
@@ -118,7 +122,11 @@ class DocWriter
|
||||
end
|
||||
|
||||
def linkify(text)
|
||||
text.downcase.gsub(" ", "-")
|
||||
if text == "Configuration overview"
|
||||
"overview"
|
||||
else
|
||||
text.downcase.gsub(" ", "-")
|
||||
end
|
||||
end
|
||||
|
||||
def titlify(text)
|
||||
@@ -126,10 +134,8 @@ class DocWriter
|
||||
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")
|
||||
Dir.glob("#{from_dir}/*") do |from_file|
|
||||
key = File.basename(from_file, ".yml")
|
||||
|
||||
DocWriter.new(from_file, to_dir).write
|
||||
end
|
||||
|
||||
@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
|
||||
|
||||
spec.add_dependency "activesupport", ">= 7.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 "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 "bcrypt_pbkdf", "~> 1.0"
|
||||
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
require "active_support/core_ext/array/conversions"
|
||||
|
||||
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
||||
def boot(name, prepare: true)
|
||||
@@ -16,6 +18,11 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
execute *accessory.ensure_env_directory
|
||||
upload! accessory.secrets_io, accessory.secrets_path, mode: "0600"
|
||||
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
|
||||
@@ -73,6 +80,10 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Started #{name} accessory"), verbosity: :debug
|
||||
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
|
||||
@@ -85,6 +96,11 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
||||
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
|
||||
@@ -110,14 +126,15 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
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 :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|
|
||||
case
|
||||
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) }
|
||||
|
||||
when options[:interactive]
|
||||
@@ -126,16 +143,16 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
|
||||
when options[:reuse]
|
||||
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
|
||||
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||
puts_by_host host, capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||
end
|
||||
|
||||
else
|
||||
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
|
||||
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
|
||||
@@ -145,25 +162,27 @@ 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 :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_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 :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||
def logs(name)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{hosts}..."
|
||||
info accessory.follow_logs(grep: grep, grep_options: grep_options)
|
||||
exec accessory.follow_logs(grep: grep, grep_options: grep_options)
|
||||
info accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
|
||||
exec accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
|
||||
end
|
||||
else
|
||||
since = options[:since]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(hosts) do
|
||||
puts capture_with_info(*accessory.logs(since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
puts capture_with_info(*accessory.logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -68,7 +68,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
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
|
||||
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
|
||||
|
||||
@@ -94,9 +94,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 :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 :detach, type: :boolean, default: false, desc: "Execute command in a detached container"
|
||||
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)
|
||||
env = options[:env]
|
||||
detach = options[:detach]
|
||||
case
|
||||
when options[:interactive] && options[:reuse]
|
||||
say "Get current version of running container...", :magenta unless options[:version]
|
||||
@@ -138,7 +144,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
roles.each do |role|
|
||||
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
|
||||
@@ -186,14 +192,18 @@ 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 :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_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 :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
|
||||
# FIXME: Catch when app containers aren't running
|
||||
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
since = options[:since]
|
||||
container_id = options[:container_id]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 10) # Default to 10 lines if since or grep isn't set
|
||||
@@ -201,12 +211,12 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
run_locally do
|
||||
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
|
||||
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
info app.follow_logs(host: KAMAL.primary_host, lines: lines, grep: grep, grep_options: grep_options)
|
||||
exec app.follow_logs(host: KAMAL.primary_host, 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, container_id: container_id, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
||||
end
|
||||
else
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
@@ -216,7 +226,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
roles.each do |role|
|
||||
begin
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(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
|
||||
puts_by_host host, "Nothing found"
|
||||
end
|
||||
|
||||
@@ -45,7 +45,7 @@ class Kamal::Cli::App::Boot
|
||||
|
||||
def start_new_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
|
||||
upload! role.secrets_io(host), role.secrets_path, mode: "0600"
|
||||
@@ -91,7 +91,7 @@ class Kamal::Cli::App::Boot
|
||||
if barrier.close
|
||||
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting any other roles"
|
||||
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))
|
||||
rescue SSHKit::Command::Failed
|
||||
error "Could not fetch logs for #{version}"
|
||||
|
||||
@@ -135,8 +135,10 @@ module Kamal::Cli
|
||||
details = { hosts: KAMAL.hosts.join(","), command: command, subcommand: subcommand }
|
||||
|
||||
say "Running the #{hook} hook...", :magenta
|
||||
run_locally do
|
||||
execute *KAMAL.hook.run(hook, **details, **extra_details)
|
||||
with_env KAMAL.hook.env(**details, **extra_details) do
|
||||
run_locally do
|
||||
execute *KAMAL.hook.run(hook)
|
||||
end
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise HookError.new("Hook `#{hook}` failed:\n#{e.message}")
|
||||
end
|
||||
@@ -183,5 +185,14 @@ module Kamal::Cli
|
||||
execute(*KAMAL.server.ensure_run_directory)
|
||||
end
|
||||
end
|
||||
|
||||
def with_env(env)
|
||||
current_env = ENV.to_h.dup
|
||||
ENV.update(env)
|
||||
yield
|
||||
ensure
|
||||
ENV.clear
|
||||
ENV.update(current_env)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -30,28 +30,30 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
say "Building with uncommitted changes:\n #{uncommitted_changes}", :yellow
|
||||
end
|
||||
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.inspect_builder
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /(context not found|no builder|no compatible builder|does not exist)/
|
||||
warn "Missing compatible builder, so creating a new one first"
|
||||
begin
|
||||
cli.remove
|
||||
rescue SSHKit::Command::Failed
|
||||
raise unless e.message =~ /(context not found|no builder|does not exist)/
|
||||
with_env(KAMAL.config.builder.secrets) do
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.inspect_builder
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /(context not found|no builder|no compatible builder|does not exist)/
|
||||
warn "Missing compatible builder, so creating a new one first"
|
||||
begin
|
||||
cli.remove
|
||||
rescue SSHKit::Command::Failed
|
||||
raise unless e.message =~ /(context not found|no builder|does not exist)/
|
||||
end
|
||||
cli.create
|
||||
else
|
||||
raise
|
||||
end
|
||||
cli.create
|
||||
else
|
||||
raise
|
||||
end
|
||||
end
|
||||
|
||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||
push = KAMAL.builder.push
|
||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||
push = KAMAL.builder.push
|
||||
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push, env: KAMAL.config.builder.secrets }
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -48,7 +48,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s
|
||||
end
|
||||
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting kamal-proxy, pruning, and registry login"
|
||||
@@ -75,7 +75,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s
|
||||
end
|
||||
|
||||
desc "rollback [VERSION]", "Rollback app to VERSION"
|
||||
@@ -99,7 +99,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round if rolled_back
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s if rolled_back
|
||||
end
|
||||
|
||||
desc "details", "Show details about all containers"
|
||||
@@ -135,7 +135,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
puts "No documentation found for #{section}"
|
||||
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"
|
||||
def init
|
||||
require "fileutils"
|
||||
|
||||
@@ -14,13 +14,45 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
||||
|
||||
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
|
||||
execute *KAMAL.proxy.start_or_run
|
||||
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 :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]) 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)"
|
||||
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"
|
||||
@@ -140,21 +172,23 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||
def logs
|
||||
grep = options[:grep]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{KAMAL.primary_host}..."
|
||||
info KAMAL.proxy.follow_logs(host: KAMAL.primary_host, grep: grep)
|
||||
exec KAMAL.proxy.follow_logs(host: KAMAL.primary_host, grep: grep)
|
||||
info KAMAL.proxy.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, grep: grep)
|
||||
exec KAMAL.proxy.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, grep: grep)
|
||||
end
|
||||
else
|
||||
since = options[:since]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
puts_by_host host, capture(*KAMAL.proxy.logs(since: since, lines: lines, grep: grep)), type: "Proxy"
|
||||
puts_by_host host, capture(*KAMAL.proxy.logs(timestamps: timestamps, since: since, lines: lines, grep: grep)), type: "Proxy"
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -167,7 +201,7 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
stop
|
||||
remove_container
|
||||
remove_image
|
||||
remove_host_directory
|
||||
remove_proxy_directory
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -192,12 +226,11 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_host_directory", "Remove proxy directory from servers", hide: true
|
||||
def remove_host_directory
|
||||
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.auditor.record("Removed #{KAMAL.config.proxy_directory}"), verbosity: :debug
|
||||
execute *KAMAL.proxy.remove_host_directory, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.remove_proxy_directory, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,11 +1,17 @@
|
||||
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
||||
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
||||
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 :inline, type: :boolean, required: false, hidden: true
|
||||
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]
|
||||
end
|
||||
@@ -21,8 +27,15 @@ class Kamal::Cli::Secrets < Kamal::Cli::Base
|
||||
return_or_puts value, inline: options[:inline]
|
||||
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
|
||||
def adapter(adapter)
|
||||
def initialize_adapter(adapter)
|
||||
Kamal::Secrets::Adapters.lookup(adapter)
|
||||
end
|
||||
|
||||
|
||||
@@ -2,11 +2,26 @@
|
||||
service: my-app
|
||||
|
||||
# Name of the container image.
|
||||
image: user/my-app
|
||||
image: my-user/my-app
|
||||
|
||||
# Deploy to these servers.
|
||||
servers:
|
||||
- 192.168.0.1
|
||||
web:
|
||||
- 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.
|
||||
registry:
|
||||
@@ -14,27 +29,55 @@ registry:
|
||||
# server: registry.digitalocean.com / ghcr.io / ...
|
||||
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:
|
||||
- KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
# Configure builder setup.
|
||||
builder:
|
||||
arch: amd64
|
||||
# Pass in additional build args needed for your Dockerfile.
|
||||
# args:
|
||||
# RUBY_VERSION: <%= File.read('.ruby-version').strip %>
|
||||
|
||||
# Inject ENV variables into containers (secrets come from .env).
|
||||
# Remember to run `kamal env push` after making changes!
|
||||
# Inject ENV variables into containers (secrets come from .kamal/secrets).
|
||||
#
|
||||
# env:
|
||||
# clear:
|
||||
# DB_HOST: 192.168.0.2
|
||||
# secret:
|
||||
# - RAILS_MASTER_KEY
|
||||
|
||||
# Aliases are triggered with "bin/kamal <alias>". You can overwrite arguments on invocation:
|
||||
# "bin/kamal 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
|
||||
#
|
||||
# ssh:
|
||||
# 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:
|
||||
# db:
|
||||
# image: mysql:8.0
|
||||
@@ -51,34 +94,8 @@ builder:
|
||||
# directories:
|
||||
# - data:/var/lib/mysql
|
||||
# redis:
|
||||
# image: redis:7.0
|
||||
# image: valkey/valkey:8
|
||||
# host: 192.168.0.2
|
||||
# port: 6379
|
||||
# directories:
|
||||
# - 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
|
||||
#
|
||||
# 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
|
||||
echo "Docker set up on $KAMAL_HOSTS..."
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
#!/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
|
||||
# If you must, then add `.kamal/secrets*` to your .gitignore file
|
||||
# Secrets defined here are available for reference under registry/password, env/secret, builder/secrets,
|
||||
# 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
|
||||
KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
@@ -43,7 +43,12 @@ class Kamal::Commander::Specifics
|
||||
end
|
||||
|
||||
def specified_hosts
|
||||
(specific_hosts || config.all_hosts) \
|
||||
.select { |host| (specific_roles || config.roles).flat_map(&:hosts).include?(host) }
|
||||
specified_hosts = specific_hosts || config.all_hosts
|
||||
|
||||
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
|
||||
|
||||
@@ -1,9 +1,13 @@
|
||||
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
include Proxy
|
||||
|
||||
attr_reader :accessory_config
|
||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||
:publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||
:secrets_io, :secrets_path, :env_directory,
|
||||
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||
:secrets_io, :secrets_path, :env_directory, :proxy, :running_proxy?,
|
||||
to: :accessory_config
|
||||
delegate :proxy_container_name, to: :config
|
||||
|
||||
|
||||
def initialize(config, name:)
|
||||
super(config)
|
||||
@@ -15,7 +19,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
"--name", service_name,
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
"--network", "kamal",
|
||||
*network_args,
|
||||
*config.logging_args,
|
||||
*publish_args,
|
||||
*env_args,
|
||||
@@ -39,16 +43,16 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
|
||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(grep: nil, grep_options: nil)
|
||||
def follow_logs(timestamps: true, grep: nil, grep_options: nil)
|
||||
run_over_ssh \
|
||||
pipe \
|
||||
docker(:logs, service_name, "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
docker(:logs, service_name, ("--timestamps" if timestamps), "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
end
|
||||
|
||||
@@ -64,7 +68,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :run,
|
||||
("-it" if interactive),
|
||||
"--rm",
|
||||
"--network", "kamal",
|
||||
*network_args,
|
||||
*env_args,
|
||||
*volume_args,
|
||||
image,
|
||||
|
||||
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
|
||||
|
||||
def info
|
||||
docker :ps, *filter_args
|
||||
docker :ps, *container_filter_args
|
||||
end
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
|
||||
def list_versions(*docker_args, statuses: nil)
|
||||
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
|
||||
end
|
||||
|
||||
@@ -91,11 +91,15 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def filter_args(statuses: nil)
|
||||
argumentize "--filter", filters(statuses: statuses)
|
||||
def container_filter_args(statuses: nil)
|
||||
argumentize "--filter", container_filters(statuses: statuses)
|
||||
end
|
||||
|
||||
def image_filter_args
|
||||
argumentize "--filter", image_filters
|
||||
end
|
||||
|
||||
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)
|
||||
end
|
||||
|
||||
def filters(statuses: nil)
|
||||
def container_filters(statuses: nil)
|
||||
[ "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
|
||||
statuses&.each do |status|
|
||||
filters << "status=#{status}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def image_filters
|
||||
[ "label=service=#{config.service}" ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -2,7 +2,7 @@ module Kamal::Commands::App::Containers
|
||||
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
||||
|
||||
def list_containers
|
||||
docker :container, :ls, "--all", *filter_args
|
||||
docker :container, :ls, "--all", *container_filter_args
|
||||
end
|
||||
|
||||
def list_container_names
|
||||
@@ -20,7 +20,7 @@ module Kamal::Commands::App::Containers
|
||||
end
|
||||
|
||||
def remove_containers
|
||||
docker :container, :prune, "--force", *filter_args
|
||||
docker :container, :prune, "--force", *container_filter_args
|
||||
end
|
||||
|
||||
def container_health_log(version:)
|
||||
|
||||
@@ -7,12 +7,15 @@ module Kamal::Commands::App::Execution
|
||||
*command
|
||||
end
|
||||
|
||||
def execute_in_new_container(*command, interactive: false, env:)
|
||||
def execute_in_new_container(*command, interactive: false, detach: false, env:)
|
||||
docker :run,
|
||||
("-it" if interactive),
|
||||
"--rm",
|
||||
("--detach" if detach),
|
||||
("--rm" unless detach),
|
||||
"--network", "kamal",
|
||||
*role&.env_args(host),
|
||||
*argumentize("--env", env),
|
||||
*role.logging_args,
|
||||
*config.volume_args,
|
||||
*role&.option_args,
|
||||
config.absolute_image,
|
||||
|
||||
@@ -4,7 +4,7 @@ module Kamal::Commands::App::Images
|
||||
end
|
||||
|
||||
def remove_images
|
||||
docker :image, :prune, "--all", "--force", *filter_args
|
||||
docker :image, :prune, "--all", "--force", *image_filter_args
|
||||
end
|
||||
|
||||
def tag_latest_image
|
||||
|
||||
@@ -1,18 +1,28 @@
|
||||
module Kamal::Commands::App::Logging
|
||||
def logs(version: nil, 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 \
|
||||
version ? container_id_for_version(version) : current_running_container_id,
|
||||
"xargs docker logs#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
|
||||
container_id_command(container_id),
|
||||
"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)
|
||||
end
|
||||
|
||||
def follow_logs(host:, 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 \
|
||||
pipe(
|
||||
current_running_container_id,
|
||||
"xargs docker logs --timestamps#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||
container_id_command(container_id),
|
||||
"xargs docker logs#{" --timestamps" if timestamps}#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
),
|
||||
host: host
|
||||
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
|
||||
|
||||
@@ -5,8 +5,8 @@ module Kamal::Commands::App::Proxy
|
||||
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
||||
end
|
||||
|
||||
def remove(target:)
|
||||
proxy_exec :remove, role.container_prefix, *role.proxy.remove_command_args(target: target)
|
||||
def remove
|
||||
proxy_exec :remove, role.container_prefix
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -11,14 +11,7 @@ module Kamal::Commands
|
||||
end
|
||||
|
||||
def run_over_ssh(*command, host:)
|
||||
"ssh".tap do |cmd|
|
||||
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
|
||||
"ssh#{ssh_proxy_args}#{ssh_keys_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
|
||||
end
|
||||
|
||||
def container_id_for(container_name:, only_running: false)
|
||||
@@ -92,5 +85,24 @@ module Kamal::Commands
|
||||
def tags(**details)
|
||||
Kamal::Tags.from_config(config, **details)
|
||||
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
|
||||
end
|
||||
end
|
||||
|
||||
@@ -6,7 +6,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
delegate \
|
||||
: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
|
||||
|
||||
def clean
|
||||
@@ -37,7 +37,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def build_options
|
||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
|
||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||
end
|
||||
|
||||
def build_context
|
||||
@@ -97,6 +97,14 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
argumentize "--ssh", ssh if ssh.present?
|
||||
end
|
||||
|
||||
def builder_provenance
|
||||
argumentize "--provenance", provenance unless provenance.nil?
|
||||
end
|
||||
|
||||
def builder_sbom
|
||||
argumentize "--sbom", sbom unless sbom.nil?
|
||||
end
|
||||
|
||||
def builder_config
|
||||
config.builder
|
||||
end
|
||||
|
||||
@@ -1,29 +1,31 @@
|
||||
module Kamal::Commands::Builder::Clone
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
included do
|
||||
delegate :clone_directory, :build_directory, to: :"config.builder"
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def clone_reset_steps
|
||||
[
|
||||
git(:remote, "set-url", :origin, Kamal::Git.root, path: build_directory),
|
||||
git(:fetch, :origin, path: build_directory),
|
||||
git(:reset, "--hard", Kamal::Git.revision, path: build_directory),
|
||||
git(:clean, "-fdx", path: build_directory),
|
||||
git(:submodule, :update, "--init", path: build_directory)
|
||||
git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory),
|
||||
git(:fetch, :origin, path: escaped_build_directory),
|
||||
git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory),
|
||||
git(:clean, "-fdx", path: escaped_build_directory),
|
||||
git(:submodule, :update, "--init", path: escaped_build_directory)
|
||||
]
|
||||
end
|
||||
|
||||
def clone_status
|
||||
git :status, "--porcelain", path: build_directory
|
||||
git :status, "--porcelain", path: escaped_build_directory
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
class Kamal::Commands::Hook < Kamal::Commands::Base
|
||||
def run(hook, secrets: false, **details)
|
||||
env = tags(**details).env
|
||||
env.merge!(config.secrets.to_h) if secrets
|
||||
def run(hook)
|
||||
[ hook_file(hook) ]
|
||||
end
|
||||
|
||||
[ hook_file(hook), env: env ]
|
||||
def env(secrets: false, **details)
|
||||
tags(**details).env.tap do |env|
|
||||
env.merge!(config.secrets.to_h) if secrets
|
||||
end
|
||||
end
|
||||
|
||||
def hook_exists?(hook)
|
||||
|
||||
@@ -7,10 +7,8 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
"--network", "kamal",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
*config.proxy_publish_args,
|
||||
"--volume", "/var/run/docker.sock:/var/run/docker.sock",
|
||||
*config.proxy_config_volume.docker_args,
|
||||
*config.logging_args,
|
||||
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
||||
"\$\(#{get_boot_options.join(" ")}\)",
|
||||
config.proxy_image
|
||||
end
|
||||
|
||||
@@ -36,15 +34,15 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
[ :cut, "-d:", "-f2" ]
|
||||
end
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, container_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
|
||||
docker(:logs, container_name, ("--since #{since}" if since), ("--tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, grep: nil, grep_options: nil)
|
||||
def follow_logs(host:, timestamps: true, grep: nil, grep_options: nil)
|
||||
run_over_ssh pipe(
|
||||
docker(:logs, container_name, "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
docker(:logs, container_name, ("--timestamps" if timestamps), "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
).join(" "), host: host
|
||||
end
|
||||
@@ -57,10 +55,6 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy"
|
||||
end
|
||||
|
||||
def remove_host_directory
|
||||
remove_directory config.proxy_directory
|
||||
end
|
||||
|
||||
def cleanup_traefik
|
||||
chain \
|
||||
docker(:container, :stop, "traefik"),
|
||||
@@ -70,6 +64,22 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
)
|
||||
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
|
||||
def container_name
|
||||
config.proxy_container_name
|
||||
|
||||
@@ -14,12 +14,15 @@ class Kamal::Configuration
|
||||
|
||||
include Validation
|
||||
|
||||
PROXY_MINIMUM_VERSION = "v0.3.0"
|
||||
PROXY_MINIMUM_VERSION = "v0.8.4"
|
||||
PROXY_HTTP_PORT = 80
|
||||
PROXY_HTTPS_PORT = 443
|
||||
PROXY_LOG_MAX_SIZE = "10m"
|
||||
|
||||
class << self
|
||||
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))
|
||||
|
||||
new raw_config, destination: destination, version: version
|
||||
@@ -34,7 +37,7 @@ class Kamal::Configuration
|
||||
if file.exist?
|
||||
# Newer Psych doesn't load aliases by default
|
||||
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
|
||||
raise "Configuration file not found in #{file}"
|
||||
end
|
||||
@@ -216,10 +219,6 @@ class Kamal::Configuration
|
||||
File.join apps_directory, [ service, destination ].compact.join("-")
|
||||
end
|
||||
|
||||
def proxy_directory
|
||||
File.join run_directory, "proxy"
|
||||
end
|
||||
|
||||
def env_directory
|
||||
File.join app_directory, "env"
|
||||
end
|
||||
@@ -250,8 +249,16 @@ class Kamal::Configuration
|
||||
env_tags.detect { |t| t.name == name.to_s }
|
||||
end
|
||||
|
||||
def proxy_publish_args
|
||||
argumentize "--publish", [ "#{PROXY_HTTP_PORT}:#{PROXY_HTTP_PORT}", "#{PROXY_HTTPS_PORT}:#{PROXY_HTTPS_PORT}" ]
|
||||
def proxy_publish_args(http_port, https_port)
|
||||
argumentize "--publish", [ "#{http_port}:#{PROXY_HTTP_PORT}", "#{https_port}:#{PROXY_HTTPS_PORT}" ]
|
||||
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
|
||||
|
||||
def proxy_image
|
||||
@@ -262,10 +269,12 @@ class Kamal::Configuration
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def proxy_config_volume
|
||||
Kamal::Configuration::Volume.new \
|
||||
host_path: File.join(proxy_directory, "config"),
|
||||
container_path: "/home/kamal-proxy/.config/kamal-proxy"
|
||||
def proxy_directory
|
||||
File.join run_directory, "proxy"
|
||||
end
|
||||
|
||||
def proxy_options_file
|
||||
File.join proxy_directory, "options"
|
||||
end
|
||||
|
||||
|
||||
@@ -358,7 +367,7 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
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 }
|
||||
|
||||
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
class Kamal::Configuration::Accessory
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
DEFAULT_NETWORK = "kamal"
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :name, :accessory_config, :env
|
||||
attr_reader :name, :accessory_config, :env, :proxy
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
||||
@@ -18,6 +20,8 @@ class Kamal::Configuration::Accessory
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/env"
|
||||
|
||||
initialize_proxy if running_proxy?
|
||||
end
|
||||
|
||||
def service_name
|
||||
@@ -38,6 +42,10 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
end
|
||||
|
||||
def network_args
|
||||
argumentize "--network", network
|
||||
end
|
||||
|
||||
def publish_args
|
||||
argumentize "--publish", port if port
|
||||
end
|
||||
@@ -100,6 +108,17 @@ class Kamal::Configuration::Accessory
|
||||
accessory_config["cmd"]
|
||||
end
|
||||
|
||||
def running_proxy?
|
||||
@accessory_config["proxy"].present?
|
||||
end
|
||||
|
||||
def initialize_proxy
|
||||
@proxy = Kamal::Configuration::Proxy.new \
|
||||
config: config,
|
||||
proxy_config: accessory_config["proxy"],
|
||||
context: "accessories/#{name}/proxy"
|
||||
end
|
||||
|
||||
private
|
||||
attr_accessor :config
|
||||
|
||||
@@ -123,7 +142,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def expand_remote_file(remote_file)
|
||||
@@ -170,7 +189,13 @@ class Kamal::Configuration::Accessory
|
||||
|
||||
def hosts_from_roles
|
||||
if accessory_config.key?("roles")
|
||||
accessory_config["roles"].flat_map { |role| config.role(role).hosts }
|
||||
accessory_config["roles"].flat_map do |role|
|
||||
config.role(role)&.hosts || raise(Kamal::ConfigurationError, "Unknown role in accessories config: '#{role}'")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def network
|
||||
accessory_config["network"] || DEFAULT_NETWORK
|
||||
end
|
||||
end
|
||||
|
||||
@@ -111,6 +111,14 @@ class Kamal::Configuration::Builder
|
||||
builder_config["ssh"]
|
||||
end
|
||||
|
||||
def provenance
|
||||
builder_config["provenance"]
|
||||
end
|
||||
|
||||
def sbom
|
||||
builder_config["sbom"]
|
||||
end
|
||||
|
||||
def git_clone?
|
||||
Kamal::Git.used? && builder_config["context"].nil?
|
||||
end
|
||||
@@ -166,7 +174,7 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def repo_basename
|
||||
|
||||
@@ -3,32 +3,32 @@
|
||||
# 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.
|
||||
#
|
||||
# Accessories are managed separately from the main service - they are not updated
|
||||
# when you deploy and they do not have zero-downtime deployments.
|
||||
# Accessories are managed separately from the main service — they are not updated
|
||||
# when you deploy, and they do not have zero-downtime deployments.
|
||||
#
|
||||
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
||||
# See `kamal accessory --help` for more information.
|
||||
|
||||
# Configuring accessories
|
||||
#
|
||||
# First define the accessory in the `accessories`
|
||||
# First, define the accessory in the `accessories`:
|
||||
accessories:
|
||||
mysql:
|
||||
|
||||
# Service name
|
||||
#
|
||||
# This is used in the service label and defaults to `<service>-<accessory>`
|
||||
# where `<service>` is the main service name from the root configuration
|
||||
# This is used in the service label and defaults to `<service>-<accessory>`,
|
||||
# where `<service>` is the main service name from the root configuration:
|
||||
service: mysql
|
||||
|
||||
# Image
|
||||
#
|
||||
# The Docker image to use, prefix with a registry if not using Docker hub
|
||||
# The Docker image to use, prefix it with a registry if not using Docker Hub:
|
||||
image: mysql:8.0
|
||||
|
||||
# Accessory hosts
|
||||
#
|
||||
# Specify one of `host`, `hosts` or `roles`
|
||||
# Specify one of `host`, `hosts`, or `roles`:
|
||||
host: mysql-db1
|
||||
hosts:
|
||||
- mysql-db1
|
||||
@@ -38,13 +38,13 @@ accessories:
|
||||
|
||||
# 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"
|
||||
|
||||
# Port mappings
|
||||
#
|
||||
# See https://docs.docker.com/network/, especially note the warning about the security
|
||||
# implications of exposing ports publicly.
|
||||
# See [https://docs.docker.com/network/](https://docs.docker.com/network/), and
|
||||
# especially note the warning about the security implications of exposing ports publicly.
|
||||
port: "127.0.0.1:3306:3306"
|
||||
|
||||
# Labels
|
||||
@@ -52,20 +52,22 @@ accessories:
|
||||
app: myapp
|
||||
|
||||
# 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:
|
||||
restart: always
|
||||
cpus: 2
|
||||
|
||||
# Environment variables
|
||||
# See kamal docs env for more information
|
||||
#
|
||||
# See kamal docs env for more information:
|
||||
env:
|
||||
...
|
||||
|
||||
# Copying files
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# They will be uploaded from the local repo to the host and then mounted.
|
||||
@@ -78,13 +80,25 @@ accessories:
|
||||
# Directories
|
||||
#
|
||||
# You can specify directories to mount into the container. They will be created on the host
|
||||
# before being mounted
|
||||
# before being mounted:
|
||||
directories:
|
||||
- mysql-logs:/var/log/mysql
|
||||
|
||||
# Volumes
|
||||
#
|
||||
# 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:
|
||||
- /path/to/mysql-logs:/var/log/mysql
|
||||
|
||||
# Network
|
||||
#
|
||||
# The network the accessory will be attached to.
|
||||
#
|
||||
# Defaults to kamal:
|
||||
network: custom
|
||||
|
||||
# Proxy
|
||||
#
|
||||
proxy:
|
||||
...
|
||||
|
||||
@@ -5,22 +5,22 @@
|
||||
# For example, for a Rails app, you might open a console with:
|
||||
#
|
||||
# ```shell
|
||||
# kamal app exec -i -r console "rails console"
|
||||
# kamal app exec -i --reuse "bin/rails console"
|
||||
# ```
|
||||
#
|
||||
# By defining an alias, like this:
|
||||
aliases:
|
||||
console: app exec -r console -i "rails console"
|
||||
console: app exec -i --reuse "bin/rails console"
|
||||
# You can now open the console with:
|
||||
#
|
||||
# ```shell
|
||||
# kamal console
|
||||
# ```
|
||||
|
||||
# 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:
|
||||
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.
|
||||
#
|
||||
# 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
|
||||
#
|
||||
# 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:
|
||||
limit: 2
|
||||
wait: 10
|
||||
|
||||
# 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:
|
||||
limit: 25%
|
||||
wait: 2
|
||||
|
||||
@@ -1,12 +1,8 @@
|
||||
# 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`.
|
||||
#
|
||||
# If no configuration is specified, Kamal will:
|
||||
# 1. Create a buildx context called `kamal-local-docker-container`, using the docker-container driver
|
||||
# 2. Use `docker build` to build a multiarch image for linux/amd64,linux/arm64 with that context
|
||||
#
|
||||
# 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
|
||||
#
|
||||
@@ -15,15 +11,15 @@ builder:
|
||||
|
||||
# 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:
|
||||
- amd64
|
||||
|
||||
# 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.
|
||||
remote: ssh://docker@docker-builder
|
||||
|
||||
@@ -32,14 +28,14 @@ builder:
|
||||
# If set to false, Kamal will always use the remote builder even when building
|
||||
# the local architecture.
|
||||
#
|
||||
# Defaults to true
|
||||
# Defaults to true:
|
||||
local: true
|
||||
|
||||
# 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:
|
||||
type: registry
|
||||
options: mode=max
|
||||
@@ -47,25 +43,25 @@ builder:
|
||||
|
||||
# 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.
|
||||
#
|
||||
# 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: .
|
||||
|
||||
# Dockerfile
|
||||
#
|
||||
# The Dockerfile to use for building, defaults to `Dockerfile`
|
||||
# The Dockerfile to use for building, defaults to `Dockerfile`:
|
||||
dockerfile: Dockerfile.production
|
||||
|
||||
# Build target
|
||||
#
|
||||
# If not set, then the default target is used
|
||||
# If not set, then the default target is used:
|
||||
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:
|
||||
ENVIRONMENT: production
|
||||
|
||||
@@ -78,33 +74,43 @@ builder:
|
||||
|
||||
# Build secrets
|
||||
#
|
||||
# Values are read from the .kamal/secrets.
|
||||
#
|
||||
# Values are read from `.kamal/secrets`:
|
||||
secrets:
|
||||
- SECRET1
|
||||
- SECRET2
|
||||
|
||||
# Referencing Build Secrets
|
||||
# Referencing build secrets
|
||||
#
|
||||
# ```shell
|
||||
# # Copy Gemfiles
|
||||
# COPY Gemfile Gemfile.lock ./
|
||||
#
|
||||
# # 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 \
|
||||
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||
# bundle install && \
|
||||
# rm -rf /usr/local/bundle/cache
|
||||
# ```
|
||||
|
||||
|
||||
# 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
|
||||
|
||||
# Driver
|
||||
#
|
||||
# The build driver to use, defaults to `docker-container`
|
||||
# The build driver to use, defaults to `docker-container`:
|
||||
driver: docker
|
||||
|
||||
# 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
|
||||
#
|
||||
# Configuration is read from the `config/deploy.yml`
|
||||
#
|
||||
# Configuration is read from the `config/deploy.yml`.
|
||||
|
||||
# Destinations
|
||||
#
|
||||
# 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.
|
||||
|
||||
# Extensions
|
||||
@@ -18,10 +17,11 @@
|
||||
# However, you might want to declare a configuration block using YAML anchors
|
||||
# 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.
|
||||
|
||||
# The service name
|
||||
#
|
||||
# This is a required value. It is used as the container name prefix.
|
||||
service: myapp
|
||||
|
||||
@@ -32,143 +32,147 @@ image: my-image
|
||||
|
||||
# Labels
|
||||
#
|
||||
# Additional labels to add to the container
|
||||
# Additional labels to add to the container:
|
||||
labels:
|
||||
my-label: my-value
|
||||
|
||||
# Additional volumes to mount into the container
|
||||
# Volumes
|
||||
#
|
||||
# Additional volumes to mount into the container:
|
||||
volumes:
|
||||
- /path/on/host:/path/in/container:ro
|
||||
|
||||
# Registry
|
||||
#
|
||||
# The Docker registry configuration, see kamal docs registry
|
||||
# The Docker registry configuration, see kamal docs registry:
|
||||
registry:
|
||||
...
|
||||
|
||||
# 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:
|
||||
...
|
||||
|
||||
# Environment variables
|
||||
#
|
||||
# See kamal docs env
|
||||
# See kamal docs env:
|
||||
env:
|
||||
...
|
||||
|
||||
# Asset Bridging
|
||||
# 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
|
||||
# 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
|
||||
# volume containing both sets of files.
|
||||
# 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:
|
||||
asset_path: /path/to/assets
|
||||
|
||||
# Path to hooks, defaults to `.kamal/hooks`
|
||||
# See https://kamal-deploy.org/docs/hooks for more information
|
||||
# Hooks path
|
||||
#
|
||||
# Path to hooks, defaults to `.kamal/hooks`.
|
||||
# See https://kamal-deploy.org/docs/hooks for more information:
|
||||
hooks_path: /user_home/kamal/hooks
|
||||
|
||||
# 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
|
||||
|
||||
# The 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# 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
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# See kamal docs ssh
|
||||
# See kamal docs ssh:
|
||||
ssh:
|
||||
...
|
||||
|
||||
# Builder options
|
||||
#
|
||||
# See kamal docs builder
|
||||
# See kamal docs builder:
|
||||
builder:
|
||||
...
|
||||
|
||||
# Accessories
|
||||
#
|
||||
# Additionals services to run in Docker, see kamal docs accessory
|
||||
# Additional services to run in Docker, see kamal docs accessory:
|
||||
accessories:
|
||||
...
|
||||
|
||||
# Proxy
|
||||
#
|
||||
# Configuration for kamal-proxy, see kamal docs proxy
|
||||
# Configuration for kamal-proxy, see kamal docs proxy:
|
||||
proxy:
|
||||
...
|
||||
|
||||
# SSHKit
|
||||
#
|
||||
# See kamal docs sshkit
|
||||
# See kamal docs sshkit:
|
||||
sshkit:
|
||||
...
|
||||
|
||||
# Boot options
|
||||
#
|
||||
# See kamal docs boot
|
||||
# See kamal docs boot:
|
||||
boot:
|
||||
...
|
||||
|
||||
# Logging
|
||||
#
|
||||
# Docker logging configuration, see kamal docs logging
|
||||
# Docker logging configuration, see kamal docs logging:
|
||||
logging:
|
||||
...
|
||||
|
||||
# Aliases
|
||||
#
|
||||
# Alias configuration, see kamal docs alias
|
||||
# Alias configuration, see kamal docs alias:
|
||||
aliases:
|
||||
...
|
||||
|
||||
@@ -1,36 +1,50 @@
|
||||
# Environment variables
|
||||
#
|
||||
# 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
|
||||
#
|
||||
# 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:
|
||||
DATABASE_HOST: mysql-db1
|
||||
DATABASE_PORT: 3306
|
||||
|
||||
# Using .kamal/secrets file to load required environment variables
|
||||
# Secrets
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# This file can be used to set variables like KAMAL_REGISTRY_PASSWORD or database passwords.
|
||||
# If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if
|
||||
# it exists.
|
||||
#
|
||||
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# ```
|
||||
# ```shell
|
||||
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||
# RAILS_MASTER_KEY=$(cat config/master.key)
|
||||
# ```
|
||||
#
|
||||
# If you store secrets directly in .kamal/secrets, ensure that it is not checked into version control.
|
||||
# You can also use [secret helpers](../../commands/secrets) for some common password managers.
|
||||
#
|
||||
# To pass the secrets you should list them under the `secret` key. When you do this the
|
||||
# ```shell
|
||||
# SECRETS=$(kamal secrets fetch ...)
|
||||
#
|
||||
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_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.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# Unlike clear values, secrets are not passed directly to the container,
|
||||
# but are stored in an env file on the host
|
||||
# Unlike clear values, secrets are not passed directly to the container
|
||||
# but are stored in an env file on the host:
|
||||
env:
|
||||
clear:
|
||||
DB_USER: app
|
||||
@@ -42,7 +56,7 @@ env:
|
||||
# Tags are used to add extra env variables to specific 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.
|
||||
env:
|
||||
|
||||
@@ -6,16 +6,16 @@
|
||||
#
|
||||
# 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:
|
||||
|
||||
# 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
|
||||
|
||||
# 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:
|
||||
max-size: 100m
|
||||
|
||||
@@ -5,54 +5,72 @@
|
||||
# application container.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# 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`.
|
||||
#
|
||||
# It is disabled by default on all other roles, but can be enabled by setting
|
||||
# `proxy: true`, or providing a proxy configuration.
|
||||
# It is disabled by default on all other roles but can be enabled by setting
|
||||
# `proxy: true` or providing a proxy configuration.
|
||||
proxy:
|
||||
|
||||
# Host
|
||||
# Hosts
|
||||
#
|
||||
# The hosts that will be used to serve the app. The proxy will only route requests
|
||||
# to this host to your app.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# Specify one of `host` or `hosts`.
|
||||
host: foo.example.com
|
||||
hosts:
|
||||
- foo.example.com
|
||||
- bar.example.com
|
||||
|
||||
# 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
|
||||
|
||||
# SSL
|
||||
#
|
||||
# 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.
|
||||
# The host value must point to the server we are deploying to and port 443 must be
|
||||
# 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
|
||||
# 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
|
||||
|
||||
# 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
|
||||
#
|
||||
# How long to wait for requests to complete before timing out, defaults to 30 seconds
|
||||
response_timeout: 10s
|
||||
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
|
||||
response_timeout: 10
|
||||
|
||||
# Healthcheck
|
||||
#
|
||||
# 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.
|
||||
# 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.
|
||||
#
|
||||
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
||||
healthcheck:
|
||||
@@ -62,12 +80,12 @@ proxy:
|
||||
|
||||
# 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.
|
||||
#
|
||||
# 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.
|
||||
buffering:
|
||||
requests: true
|
||||
@@ -78,9 +96,9 @@ proxy:
|
||||
|
||||
# Logging
|
||||
#
|
||||
# Configure request logging for the proxy
|
||||
# Configure request logging for the proxy.
|
||||
# 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:
|
||||
request_headers:
|
||||
- Cache-Control
|
||||
@@ -88,13 +106,3 @@ proxy:
|
||||
response_headers:
|
||||
- X-Request-ID
|
||||
- X-Request-Start
|
||||
|
||||
# Forward headers
|
||||
#
|
||||
# Whether to forward the X-Forwarded-For and X-Forwarded-Proto headers (defaults to false)
|
||||
#
|
||||
# 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
|
||||
#
|
||||
# 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
|
||||
# in the local environment.
|
||||
|
||||
# By default, Docker Hub creates public repositories. To avoid making your images public,
|
||||
# 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:
|
||||
server: registry.digitalocean.com
|
||||
username:
|
||||
@@ -13,30 +16,31 @@ registry:
|
||||
- DOCKER_REGISTRY_TOKEN
|
||||
|
||||
# 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:
|
||||
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
||||
username: AWS
|
||||
password: <%= %x(aws ecr get-login-password) %>
|
||||
|
||||
# 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)
|
||||
# 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:
|
||||
#
|
||||
# ```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:
|
||||
|
||||
registry:
|
||||
server: <your registry region>-docker.pkg.dev
|
||||
username: _json_key_base64
|
||||
@@ -46,6 +50,7 @@ registry:
|
||||
# Validating the configuration
|
||||
#
|
||||
# You can validate the configuration by running:
|
||||
#
|
||||
# ```shell
|
||||
# kamal registry login
|
||||
# ```
|
||||
|
||||
@@ -1,22 +1,21 @@
|
||||
# Roles
|
||||
#
|
||||
# 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`
|
||||
# in the root configuration.
|
||||
|
||||
# Role configuration
|
||||
#
|
||||
# Roles are specified under the servers key
|
||||
# Roles are specified under the servers key:
|
||||
servers:
|
||||
|
||||
# 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:
|
||||
- 172.1.0.1
|
||||
- 172.1.0.2: experiment1
|
||||
@@ -24,12 +23,16 @@ servers:
|
||||
|
||||
# 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, but you can set `proxy` to change
|
||||
# it.
|
||||
# By default, only the primary role uses a proxy.
|
||||
#
|
||||
# You can also set a custom cmd to run in the container, and overwrite other settings
|
||||
# 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.
|
||||
#
|
||||
# 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
|
||||
# from the root configuration.
|
||||
workers:
|
||||
hosts:
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
#
|
||||
# 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.
|
||||
servers:
|
||||
- 172.0.0.1
|
||||
@@ -19,7 +19,7 @@ servers:
|
||||
|
||||
# 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:
|
||||
web:
|
||||
...
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# SSH configuration
|
||||
#
|
||||
# Kamal uses SSH to connect run commands on your hosts.
|
||||
# By default it will attempt to connect to the root user on port 22
|
||||
# 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.
|
||||
#
|
||||
# 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
|
||||
# sudo apt update
|
||||
@@ -12,7 +12,6 @@
|
||||
# sudo usermod -a -G docker app
|
||||
# ```
|
||||
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# The options are specified under the ssh key in the configuration file.
|
||||
@@ -20,47 +19,52 @@ ssh:
|
||||
|
||||
# The SSH user
|
||||
#
|
||||
# Defaults to `root`
|
||||
#
|
||||
# Defaults to `root`:
|
||||
user: app
|
||||
|
||||
# The SSH port
|
||||
#
|
||||
# Defaults to 22
|
||||
# Defaults to 22:
|
||||
port: "2222"
|
||||
|
||||
# Proxy host
|
||||
#
|
||||
# Specified in the form <host> or <user>@<host>
|
||||
# Specified in the form <host> or <user>@<host>:
|
||||
proxy: root@proxy-host
|
||||
|
||||
# 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"
|
||||
|
||||
# Log level
|
||||
#
|
||||
# Defaults to `fatal`. Set this to debug if you are having
|
||||
# SSH connection issues.
|
||||
# Defaults to `fatal`. Set this to `debug` if you are having SSH connection issues.
|
||||
log_level: debug
|
||||
|
||||
# Keys Only
|
||||
# Keys only
|
||||
#
|
||||
# Set to true to use only private keys from keys and key_data parameters,
|
||||
# even if ssh-agent offers more identities. This option is intended for
|
||||
# situations where ssh-agent offers many different identites or you have
|
||||
# a need to overwrite all identites and force a single one.
|
||||
# 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
|
||||
# situations where ssh-agent offers many different identities or you
|
||||
# need to overwrite all identities and force a single one.
|
||||
keys_only: false
|
||||
|
||||
# Keys
|
||||
#
|
||||
# An array of file names of private keys to use for publickey
|
||||
# and hostbased authentication
|
||||
# An array of file names of private keys to use for public key
|
||||
# and host-based authentication:
|
||||
keys: [ "~/.ssh/id.pem" ]
|
||||
|
||||
# Key Data
|
||||
# Key data
|
||||
#
|
||||
# An array of strings, with each element of the array being
|
||||
# a raw private key in PEM format.
|
||||
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.
|
||||
#
|
||||
# The default settings should be sufficient for most use cases, but
|
||||
# when connecting to a large number of hosts you may need to adjust
|
||||
# The default, settings should be sufficient for most use cases, but
|
||||
# when connecting to a large number of hosts, you may need to adjust.
|
||||
|
||||
# SSHKit options
|
||||
#
|
||||
@@ -13,11 +13,11 @@ sshkit:
|
||||
# Max concurrent starts
|
||||
#
|
||||
# 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
|
||||
|
||||
# Pool idle timeout
|
||||
#
|
||||
# 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
|
||||
|
||||
@@ -22,14 +22,14 @@ class Kamal::Configuration::Proxy
|
||||
proxy_config.fetch("ssl", false)
|
||||
end
|
||||
|
||||
def host
|
||||
proxy_config["host"]
|
||||
def hosts
|
||||
proxy_config["hosts"] || proxy_config["host"]&.split(",") || []
|
||||
end
|
||||
|
||||
def deploy_options
|
||||
{
|
||||
host: proxy_config["host"],
|
||||
tls: proxy_config["ssl"],
|
||||
host: hosts,
|
||||
tls: proxy_config["ssl"].presence,
|
||||
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
||||
"drain-timeout": seconds_duration(config.drain_timeout),
|
||||
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
||||
@@ -48,11 +48,7 @@ class Kamal::Configuration::Proxy
|
||||
end
|
||||
|
||||
def deploy_command_args(target:)
|
||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options)
|
||||
end
|
||||
|
||||
def remove_command_args(target:)
|
||||
optionize({ target: "#{target}:#{app_port}" })
|
||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "="
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
|
||||
@@ -3,9 +3,13 @@ class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
|
||||
unless config.nil?
|
||||
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"
|
||||
end
|
||||
|
||||
if (config.keys & [ "host", "hosts" ]).size > 1
|
||||
error "Specify one of 'host' or 'hosts', not both"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -37,6 +37,8 @@ class Kamal::EnvFile
|
||||
def escape_docker_env_file_ascii_value(value)
|
||||
# Doublequotes are treated literally in docker env files
|
||||
# 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
|
||||
|
||||
@@ -1,13 +1,10 @@
|
||||
require "dotenv"
|
||||
|
||||
class Kamal::Secrets
|
||||
attr_reader :secrets_files
|
||||
|
||||
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
||||
|
||||
def initialize(destination: nil)
|
||||
@secrets_files = \
|
||||
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{destination}" if destination)}" ].select { |f| File.exist?(f) }
|
||||
@destination = destination
|
||||
@mutex = Mutex.new
|
||||
end
|
||||
|
||||
@@ -17,10 +14,10 @@ class Kamal::Secrets
|
||||
secrets.fetch(key)
|
||||
end
|
||||
rescue KeyError
|
||||
if secrets_files
|
||||
if secrets_files.present?
|
||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
||||
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
|
||||
|
||||
@@ -28,10 +25,18 @@ class Kamal::Secrets
|
||||
secrets
|
||||
end
|
||||
|
||||
def secrets_files
|
||||
@secrets_files ||= secrets_filenames.select { |f| File.exist?(f) }
|
||||
end
|
||||
|
||||
private
|
||||
def secrets
|
||||
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
||||
secrets.merge!(::Dotenv.parse(secrets_file))
|
||||
secrets.merge!(::Dotenv.parse(secrets_file, overwrite: true))
|
||||
end
|
||||
end
|
||||
|
||||
def secrets_filenames
|
||||
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{@destination}" if @destination)}" ]
|
||||
end
|
||||
end
|
||||
|
||||
42
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
42
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
@@ -0,0 +1,42 @@
|
||||
class Kamal::Secrets::Adapters::AwsSecretsManager < Kamal::Secrets::Adapters::Base
|
||||
private
|
||||
def login(_account)
|
||||
nil
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
{}.tap do |results|
|
||||
get_from_secrets_manager(secrets, 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:)
|
||||
`aws secretsmanager batch-get-secret-value --secret-id-list #{secrets.map(&:shellescape).join(" ")} --profile #{account.shellescape}`.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,12 +1,20 @@
|
||||
class Kamal::Secrets::Adapters::Base
|
||||
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)
|
||||
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||
fetch_secrets(full_secrets, account: account, session: session)
|
||||
end
|
||||
|
||||
def requires_account?
|
||||
true
|
||||
end
|
||||
|
||||
private
|
||||
def login(...)
|
||||
raise NotImplementedError
|
||||
@@ -15,4 +23,8 @@ class Kamal::Secrets::Adapters::Base
|
||||
def fetch_secrets(...)
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
raise NotImplementedError
|
||||
end
|
||||
end
|
||||
|
||||
@@ -25,23 +25,31 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
||||
{}.tap do |results|
|
||||
items_fields(secrets).each do |item, fields|
|
||||
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)
|
||||
|
||||
if fields.any?
|
||||
fields.each do |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
|
||||
value = item_field["value"]
|
||||
results["#{item}/#{field}"] = value
|
||||
end
|
||||
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
|
||||
results[item] = item_json["login"]["password"]
|
||||
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 }
|
||||
raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field
|
||||
value = item_field["value"]
|
||||
[ "#{item}/#{field}", value ]
|
||||
end
|
||||
end
|
||||
|
||||
def items_fields(secrets)
|
||||
{}.tap do |items|
|
||||
secrets.each do |secret|
|
||||
@@ -61,4 +69,13 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
||||
result = `#{full_command}`.strip
|
||||
raw ? result : JSON.parse(result)
|
||||
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
|
||||
|
||||
53
lib/kamal/secrets/adapters/doppler.rb
Normal file
53
lib/kamal/secrets/adapters/doppler.rb
Normal file
@@ -0,0 +1,53 @@
|
||||
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, **)
|
||||
project_and_config_flags = ""
|
||||
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
|
||||
|
||||
secret_names = secrets.collect { |s| s.split("/").last }
|
||||
|
||||
items = `doppler secrets get #{secret_names.map(&:shellescape).join(" ")} --json #{project_and_config_flags}`
|
||||
raise RuntimeError, "Could not read #{secrets} from Doppler" unless $?.success?
|
||||
|
||||
items = JSON.parse(items)
|
||||
|
||||
items.transform_values { |value| value["computed"] }
|
||||
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
|
||||
@@ -3,7 +3,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
||||
def login(account)
|
||||
unless loggedin?(account)
|
||||
`lpass login #{account.shellescape}`
|
||||
raise RuntimeError, "Failed to login to 1Password" unless $?.success?
|
||||
raise RuntimeError, "Failed to login to LastPass" unless $?.success?
|
||||
end
|
||||
end
|
||||
|
||||
@@ -13,7 +13,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
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)
|
||||
|
||||
@@ -27,4 +27,13 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
||||
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
|
||||
|
||||
@@ -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?
|
||||
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
|
||||
|
||||
@@ -7,4 +7,8 @@ class Kamal::Secrets::Adapters::Test < Kamal::Secrets::Adapters::Base
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
secrets.to_h { |secret| [ secret, secret.reverse ] }
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
# no op
|
||||
end
|
||||
end
|
||||
|
||||
5
lib/kamal/secrets/adapters/test_optional_account.rb
Normal file
5
lib/kamal/secrets/adapters/test_optional_account.rb
Normal file
@@ -0,0 +1,5 @@
|
||||
class Kamal::Secrets::Adapters::TestOptionalAccount < Kamal::Secrets::Adapters::Test
|
||||
def requires_account?
|
||||
false
|
||||
end
|
||||
end
|
||||
@@ -12,6 +12,8 @@ module Kamal::Utils
|
||||
attr = "#{key}=#{escape_shell_value(value)}"
|
||||
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
||||
[ argument, attr ]
|
||||
elsif value == false
|
||||
[ argument, "#{key}=false" ]
|
||||
else
|
||||
[ argument, key ]
|
||||
end
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
module Kamal
|
||||
VERSION = "2.0.0.beta1"
|
||||
VERSION = "2.4.0"
|
||||
end
|
||||
|
||||
@@ -41,7 +41,7 @@ class CliAccessoryTest < CliTestCase
|
||||
test "upload" do
|
||||
run_command("upload", "mysql").tap do |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
|
||||
end
|
||||
end
|
||||
|
||||
@@ -19,7 +19,7 @@ class CliAppTest < CliTestCase
|
||||
.returns("12345678") # running version
|
||||
|
||||
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
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
@@ -63,7 +63,7 @@ class CliAppTest < CliTestCase
|
||||
.returns("12345678") # running version
|
||||
|
||||
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
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
@@ -92,7 +92,7 @@ class CliAppTest < CliTestCase
|
||||
.returns("12345678") # running version
|
||||
|
||||
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
|
||||
|
||||
run_command("boot", config: :with_env_tags).tap do |output|
|
||||
@@ -130,7 +130,7 @@ class CliAppTest < CliTestCase
|
||||
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)
|
||||
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
|
||||
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
|
||||
@@ -190,23 +190,23 @@ class CliAppTest < CliTestCase
|
||||
|
||||
run_command("start").tap do |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
|
||||
|
||||
test "stop" do
|
||||
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
|
||||
|
||||
test "stale_containers" do
|
||||
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")
|
||||
|
||||
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")
|
||||
|
||||
run_command("stale_containers").tap do |output|
|
||||
@@ -216,11 +216,11 @@ class CliAppTest < CliTestCase
|
||||
|
||||
test "stop stale_containers" do
|
||||
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")
|
||||
|
||||
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")
|
||||
|
||||
run_command("stale_containers", "--stop").tap do |output|
|
||||
@@ -231,13 +231,13 @@ class CliAppTest < CliTestCase
|
||||
|
||||
test "details" do
|
||||
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
|
||||
|
||||
test "remove" do
|
||||
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 image prune --all --force --filter label=service=app")}/, output
|
||||
end
|
||||
@@ -263,26 +263,50 @@ class CliAppTest < CliTestCase
|
||||
|
||||
test "exec" do
|
||||
run_command("exec", "ruby -v").tap do |output|
|
||||
assert_match "docker run --rm --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 separate arguments" do
|
||||
run_command("exec", "ruby", " -v").tap do |output|
|
||||
assert_match "docker run --rm --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
|
||||
|
||||
test "exec with reuse" do
|
||||
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
|
||||
end
|
||||
end
|
||||
|
||||
test "exec interactive" do
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:exec)
|
||||
.with("ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --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|
|
||||
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
|
||||
@@ -294,7 +318,7 @@ class CliAppTest < CliTestCase
|
||||
.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|
|
||||
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
|
||||
end
|
||||
end
|
||||
@@ -313,46 +337,53 @@ class CliAppTest < CliTestCase
|
||||
|
||||
test "logs" do
|
||||
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 --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 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 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
|
||||
|
||||
test "logs with follow" do
|
||||
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
|
||||
|
||||
test "logs with follow and grep" do
|
||||
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
|
||||
|
||||
test "logs with follow, grep and grep options" do
|
||||
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
|
||||
|
||||
test "version" do
|
||||
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
|
||||
|
||||
|
||||
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|
|
||||
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
|
||||
|
||||
@@ -383,7 +414,7 @@ class CliAppTest < CliTestCase
|
||||
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 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
|
||||
end
|
||||
end
|
||||
@@ -392,8 +423,8 @@ class CliAppTest < CliTestCase
|
||||
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|
|
||||
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-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
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -49,7 +49,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(: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", ".", env: {})
|
||||
.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", ".")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||
@@ -140,7 +140,7 @@ class CliBuildTest < CliTestCase
|
||||
.returns("")
|
||||
|
||||
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", ".", env: {})
|
||||
.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", ".")
|
||||
|
||||
run_command("push").tap do |output|
|
||||
assert_match /WARN Missing compatible builder, so creating a new one first/, output
|
||||
|
||||
@@ -41,27 +41,7 @@ class CliTestCase < ActiveSupport::TestCase
|
||||
end
|
||||
|
||||
def assert_hook_ran(hook, output, version:, service_version:, hosts:, command:, subcommand: nil, runtime: false, secrets: false)
|
||||
whoami = `whoami`.chomp
|
||||
performer = Kamal::Git.email.presence || whoami
|
||||
service = service_version.split("@").first
|
||||
|
||||
assert_match "Running the #{hook} hook...\n", output
|
||||
|
||||
expected = %r{Running\s/usr/bin/env\s\.kamal/hooks/#{hook}\sas\s#{whoami}@localhost\n\s
|
||||
DEBUG\s\[[0-9a-f]*\]\sCommand:\s\(\sexport\s
|
||||
KAMAL_RECORDED_AT=\"\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\dZ\"\s
|
||||
KAMAL_PERFORMER=\"#{performer}\"\s
|
||||
KAMAL_VERSION=\"#{version}\"\s
|
||||
KAMAL_SERVICE_VERSION=\"#{service_version}\"\s
|
||||
KAMAL_SERVICE=\"#{service}\"\s
|
||||
KAMAL_HOSTS=\"#{hosts}\"\s
|
||||
KAMAL_COMMAND=\"#{command}\"\s
|
||||
#{"KAMAL_SUBCOMMAND=\\\"#{subcommand}\\\"\\s" if subcommand}
|
||||
#{"KAMAL_RUNTIME=\\\"\\d+\\\"\\s" if runtime}
|
||||
#{"DB_PASSWORD=\"secret\"\\s" if secrets}
|
||||
;\s/usr/bin/env\s\.kamal/hooks/#{hook} }x
|
||||
|
||||
assert_match expected, output
|
||||
assert_match %r{usr/bin/env\s\.kamal/hooks/#{hook}}, output
|
||||
end
|
||||
|
||||
def with_argv(*argv)
|
||||
|
||||
@@ -250,7 +250,7 @@ class CliMainTest < CliTestCase
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-#{role}-123$", "--quiet")
|
||||
.returns("version-to-rollback\n").at_least_once
|
||||
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
|
||||
end
|
||||
|
||||
@@ -280,7 +280,7 @@ class CliMainTest < CliTestCase
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
||||
.returns("123").at_least_once
|
||||
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
|
||||
|
||||
run_command("rollback", "123").tap do |output|
|
||||
|
||||
@@ -4,7 +4,7 @@ class CliProxyTest < CliTestCase
|
||||
test "boot" do
|
||||
run_command("boot").tap do |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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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
|
||||
|
||||
@@ -18,11 +18,11 @@ class CliProxyTest < CliTestCase
|
||||
exception = assert_raises do
|
||||
run_command("boot").tap do |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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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
|
||||
|
||||
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
|
||||
Thread.report_on_exception = false
|
||||
end
|
||||
@@ -36,7 +36,7 @@ class CliProxyTest < CliTestCase
|
||||
|
||||
run_command("boot").tap do |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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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
|
||||
ensure
|
||||
Thread.report_on_exception = false
|
||||
@@ -57,14 +57,14 @@ class CliProxyTest < CliTestCase
|
||||
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 run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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 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 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 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 run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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 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 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
|
||||
end
|
||||
end
|
||||
|
||||
@@ -111,11 +111,11 @@ class CliProxyTest < CliTestCase
|
||||
|
||||
test "logs" do
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture)
|
||||
.with(:docker, :logs, "kamal-proxy", " --tail 100", "--timestamps", "2>&1")
|
||||
.with(:docker, :logs, "kamal-proxy", "--tail 100", "--timestamps", "2>&1")
|
||||
.returns("Log entry")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture)
|
||||
.with(:docker, :logs, "proxy", " --tail 100", "--timestamps", "2>&1")
|
||||
.with(:docker, :logs, "proxy", "--tail 100", "--timestamps", "2>&1")
|
||||
.returns("Log entry")
|
||||
|
||||
run_command("logs").tap do |output|
|
||||
@@ -136,7 +136,6 @@ class CliProxyTest < CliTestCase
|
||||
assert_match "/usr/bin/env ls .kamal/apps | wc -l", output
|
||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy", output
|
||||
assert_match "docker image prune --all --force --filter label=org.opencontainers.image.title=kamal-proxy", output
|
||||
assert_match "/usr/bin/env rm -r .kamal/proxy", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -176,12 +175,6 @@ class CliProxyTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "remove_host_directory" do
|
||||
run_command("remove_host_directory").tap do |output|
|
||||
assert_match "/usr/bin/env rm -r .kamal/proxy", output
|
||||
end
|
||||
end
|
||||
|
||||
test "upgrade" do
|
||||
Object.any_instance.stubs(:sleep)
|
||||
|
||||
@@ -205,13 +198,13 @@ class CliProxyTest < CliTestCase
|
||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||
assert_match "docker network create kamal", 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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.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 %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 %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 "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 tag dhh/app:latest dhh/app:latest", output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||
@@ -243,6 +236,80 @@ class CliProxyTest < CliTestCase
|
||||
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 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
|
||||
def run_command(*command, fixture: :with_proxy)
|
||||
stdouted { Kamal::Cli::Proxy.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
||||
|
||||
@@ -7,6 +7,18 @@ class CliSecretsTest < CliTestCase
|
||||
run_command("fetch", "foo", "bar", "baz", "--account", "myaccount", "--adapter", "test")
|
||||
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 "fetch without required --account" do
|
||||
assert_equal \
|
||||
"\\{\\\"foo\\\":\\\"oof\\\",\\\"bar\\\":\\\"rab\\\",\\\"baz\\\":\\\"zab\\\"\\}",
|
||||
run_command("fetch", "foo", "bar", "baz", "--adapter", "test_optional_account")
|
||||
end
|
||||
|
||||
test "extract" do
|
||||
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||
end
|
||||
@@ -15,6 +27,12 @@ class CliSecretsTest < CliTestCase
|
||||
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||
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
|
||||
def run_command(*command)
|
||||
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||
|
||||
@@ -150,6 +150,27 @@ class CommanderTest < ActiveSupport::TestCase
|
||||
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
|
||||
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
|
||||
def configure_with(variant)
|
||||
@kamal = Kamal::Commander.new.tap do |kamal|
|
||||
|
||||
@@ -39,7 +39,10 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
"busybox" => {
|
||||
"service" => "custom-busybox",
|
||||
"image" => "busybox:latest",
|
||||
"host" => "1.1.1.7"
|
||||
"host" => "1.1.1.7",
|
||||
"proxy" => {
|
||||
"host" => "busybox.example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -71,6 +74,14 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
new_command(:busybox).run.join(" ")
|
||||
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
|
||||
assert_equal \
|
||||
"docker container start app-mysql",
|
||||
@@ -130,12 +141,20 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
assert_equal \
|
||||
"docker logs app-mysql --since 5m --tail 100 --timestamps 2>&1 | grep 'thing' -C 2",
|
||||
new_command(:mysql).logs(since: "5m", lines: 100, grep: "thing", grep_options: "-C 2").join(" ")
|
||||
|
||||
assert_equal \
|
||||
"docker logs app-mysql --since 5m --tail 100 2>&1 | grep 'thing' -C 2",
|
||||
new_command(:mysql).logs(timestamps: false, since: "5m", lines: 100, grep: "thing", grep_options: "-C 2").join(" ")
|
||||
end
|
||||
|
||||
test "follow logs" do
|
||||
assert_equal \
|
||||
"ssh -t root@1.1.1.5 -p 22 'docker logs app-mysql --timestamps --tail 10 --follow 2>&1'",
|
||||
new_command(:mysql).follow_logs
|
||||
|
||||
assert_equal \
|
||||
"ssh -t root@1.1.1.5 -p 22 'docker logs app-mysql --tail 10 --follow 2>&1'",
|
||||
new_command(:mysql).follow_logs(timestamps: false)
|
||||
end
|
||||
|
||||
test "remove container" do
|
||||
@@ -150,6 +169,18 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
new_command(:mysql).remove_image.join(" ")
|
||||
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
|
||||
def new_command(accessory)
|
||||
Kamal::Commands::Accessory.new(Kamal::Configuration.new(@config), name: accessory)
|
||||
|
||||
@@ -79,18 +79,18 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "stop" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
test "stop with custom drain timeout" do
|
||||
@config[:drain_timeout] = 20
|
||||
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(" ")
|
||||
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -102,7 +102,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "info" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -115,110 +115,162 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "deploy" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
test "remove" do
|
||||
assert_equal \
|
||||
"docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"",
|
||||
new_command.remove(target: "172.1.0.2").join(" ")
|
||||
"docker exec kamal-proxy kamal-proxy remove app-web",
|
||||
new_command.remove.join(" ")
|
||||
end
|
||||
|
||||
|
||||
|
||||
test "logs" do
|
||||
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 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(" ")
|
||||
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
|
||||
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 --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(" ")
|
||||
end
|
||||
|
||||
test "logs with lines" do
|
||||
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 --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(" ")
|
||||
end
|
||||
|
||||
test "logs with since and lines" do
|
||||
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 --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(" ")
|
||||
end
|
||||
|
||||
test "logs with grep" do
|
||||
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 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(" ")
|
||||
end
|
||||
|
||||
test "logs with grep and grep options" do
|
||||
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 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(" ")
|
||||
end
|
||||
|
||||
test "logs with since, grep and grep options" do
|
||||
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 --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(" ")
|
||||
end
|
||||
|
||||
test "logs with since and grep" do
|
||||
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 --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(" ")
|
||||
end
|
||||
|
||||
test "follow logs" do
|
||||
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")
|
||||
|
||||
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")
|
||||
|
||||
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)
|
||||
|
||||
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")
|
||||
|
||||
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 --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
||||
new_command.follow_logs(host: "app-1", timestamps: false, lines: 123, grep: "Completed")
|
||||
end
|
||||
|
||||
|
||||
test "execute in new container" do
|
||||
assert_equal \
|
||||
"docker run --rm --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(" ")
|
||||
end
|
||||
|
||||
test "execute in new container with env" do
|
||||
assert_equal \
|
||||
"docker run --rm --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(" ")
|
||||
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
|
||||
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
||||
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
||||
|
||||
assert_equal \
|
||||
"docker run --rm --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(" ")
|
||||
end
|
||||
|
||||
test "execute in new container with custom options" do
|
||||
@config[:servers] = { "web" => { "hosts" => [ "1.1.1.1" ], "options" => { "mount" => "somewhere", "cap-add" => true } } }
|
||||
assert_equal \
|
||||
"docker run --rm --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(" ")
|
||||
end
|
||||
|
||||
@@ -235,7 +287,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
end
|
||||
|
||||
test "execute in new container over ssh" do
|
||||
assert_match %r{docker run -it --rm --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: {})
|
||||
end
|
||||
|
||||
@@ -243,13 +295,13 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
@config[:servers] = [ { "1.1.1.1" => "tag1" } ]
|
||||
@config[:env]["tags"] = { "tag1" => { "ENV1" => "value1" } }
|
||||
|
||||
assert_equal "ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --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: {})
|
||||
end
|
||||
|
||||
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 } } }
|
||||
assert_match %r{docker run -it --rm --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: {})
|
||||
end
|
||||
|
||||
@@ -287,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")
|
||||
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
|
||||
@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")
|
||||
@@ -294,7 +356,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "current_running_container_id" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -313,23 +375,23 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "current_running_version" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
test "list_versions" do
|
||||
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(" ")
|
||||
|
||||
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(" ")
|
||||
end
|
||||
|
||||
test "list_containers" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -342,7 +404,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "list_container_names" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -361,7 +423,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "remove_containers" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
@@ -380,14 +442,14 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
|
||||
test "remove_images" do
|
||||
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(" ")
|
||||
end
|
||||
|
||||
test "remove_images with destination" do
|
||||
@destination = "staging"
|
||||
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(" ")
|
||||
end
|
||||
|
||||
|
||||
@@ -144,20 +144,59 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
test "push with provenance" do
|
||||
builder = new_builder_command(builder: { "provenance" => "mode=max" })
|
||||
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 --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 --push --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 --push --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 --push --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(" ")
|
||||
end
|
||||
|
||||
test "mirror count" do
|
||||
command = new_builder_command
|
||||
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
|
||||
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
|
||||
def new_builder_command(additional_config = {})
|
||||
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
|
||||
end
|
||||
|
||||
def build_directory
|
||||
"#{Dir.tmpdir}/kamal-clones/app/kamal/"
|
||||
end
|
||||
|
||||
def local_arch
|
||||
Kamal::Utils.docker_arch
|
||||
end
|
||||
|
||||
@@ -16,41 +16,34 @@ class CommandsHookTest < ActiveSupport::TestCase
|
||||
end
|
||||
|
||||
test "run" do
|
||||
assert_equal [
|
||||
".kamal/hooks/foo",
|
||||
{ env: {
|
||||
"KAMAL_RECORDED_AT" => @recorded_at,
|
||||
"KAMAL_PERFORMER" => @performer,
|
||||
"KAMAL_VERSION" => "123",
|
||||
"KAMAL_SERVICE_VERSION" => "app@123",
|
||||
"KAMAL_SERVICE" => "app" } }
|
||||
], new_command.run("foo")
|
||||
assert_equal [ ".kamal/hooks/foo" ], new_command.run("foo")
|
||||
end
|
||||
|
||||
test "env" do
|
||||
assert_equal ({
|
||||
"KAMAL_RECORDED_AT" => @recorded_at,
|
||||
"KAMAL_PERFORMER" => @performer,
|
||||
"KAMAL_VERSION" => "123",
|
||||
"KAMAL_SERVICE_VERSION" => "app@123",
|
||||
"KAMAL_SERVICE" => "app"
|
||||
}), new_command.env
|
||||
end
|
||||
|
||||
test "run with custom hooks_path" do
|
||||
assert_equal [
|
||||
"custom/hooks/path/foo",
|
||||
{ env: {
|
||||
"KAMAL_RECORDED_AT" => @recorded_at,
|
||||
"KAMAL_PERFORMER" => @performer,
|
||||
"KAMAL_VERSION" => "123",
|
||||
"KAMAL_SERVICE_VERSION" => "app@123",
|
||||
"KAMAL_SERVICE" => "app" } }
|
||||
], new_command(hooks_path: "custom/hooks/path").run("foo")
|
||||
assert_equal [ "custom/hooks/path/foo" ], new_command(hooks_path: "custom/hooks/path").run("foo")
|
||||
end
|
||||
|
||||
test "hook with secrets" do
|
||||
test "env with secrets" do
|
||||
with_test_secrets("secrets" => "DB_PASSWORD=secret") do
|
||||
assert_equal [
|
||||
".kamal/hooks/foo",
|
||||
{ env: {
|
||||
assert_equal (
|
||||
{
|
||||
"KAMAL_RECORDED_AT" => @recorded_at,
|
||||
"KAMAL_PERFORMER" => @performer,
|
||||
"KAMAL_VERSION" => "123",
|
||||
"KAMAL_SERVICE_VERSION" => "app@123",
|
||||
"KAMAL_SERVICE" => "app",
|
||||
"DB_PASSWORD" => "secret" } }
|
||||
], new_command(env: { "secret" => [ "DB_PASSWORD" ] }).run("foo", secrets: true)
|
||||
"DB_PASSWORD" => "secret" }
|
||||
), new_command.env(secrets: true)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -15,13 +15,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
|
||||
test "run" do
|
||||
assert_equal \
|
||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.kamal/proxy/config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}",
|
||||
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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.kamal/proxy/config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}",
|
||||
"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
|
||||
|
||||
@@ -29,15 +23,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
@config.delete(:proxy)
|
||||
|
||||
assert_equal \
|
||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.kamal/proxy/config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}",
|
||||
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 /var/run/docker.sock:/var/run/docker.sock --volume $(pwd)/.kamal/proxy/config:/home/kamal-proxy/.config/kamal-proxy --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" #{KAMAL.config.proxy_image}",
|
||||
"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
|
||||
|
||||
@@ -67,16 +53,22 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
|
||||
test "proxy logs since 2h" do
|
||||
assert_equal \
|
||||
"docker logs kamal-proxy --since 2h --timestamps 2>&1",
|
||||
"docker logs kamal-proxy --since 2h --timestamps 2>&1",
|
||||
new_command.logs(since: "2h").join(" ")
|
||||
end
|
||||
|
||||
test "proxy logs last 10 lines" do
|
||||
assert_equal \
|
||||
"docker logs kamal-proxy --tail 10 --timestamps 2>&1",
|
||||
"docker logs kamal-proxy --tail 10 --timestamps 2>&1",
|
||||
new_command.logs(lines: 10).join(" ")
|
||||
end
|
||||
|
||||
test "proxy logs without timestamps" do
|
||||
assert_equal \
|
||||
"docker logs kamal-proxy 2>&1",
|
||||
new_command.logs(timestamps: false).join(" ")
|
||||
end
|
||||
|
||||
test "proxy logs with grep hello!" do
|
||||
assert_equal \
|
||||
"docker logs kamal-proxy --timestamps 2>&1 | grep 'hello!'",
|
||||
@@ -113,6 +105,24 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
new_command.version.join(" ")
|
||||
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
|
||||
def new_command
|
||||
Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123"))
|
||||
|
||||
@@ -63,6 +63,9 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
"options" => {
|
||||
"cpus" => "4",
|
||||
"memory" => "2GB"
|
||||
},
|
||||
"proxy" => {
|
||||
"host" => "monitoring.example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -152,4 +155,18 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
test "options" do
|
||||
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
|
||||
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
|
||||
|
||||
@@ -64,7 +64,7 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
||||
@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,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
|
||||
|
||||
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" } }
|
||||
|
||||
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
|
||||
|
||||
test "setting registry cache with image" do
|
||||
@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,mode=max,ref=kamal", config.builder.cache_to
|
||||
assert_equal "type=registry,ref=kamal,mode=max", config.builder.cache_to
|
||||
end
|
||||
|
||||
test "args" do
|
||||
@@ -134,6 +134,26 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
||||
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
|
||||
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
|
||||
@deploy[:builder]["local"] = false
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
require "test_helper"
|
||||
|
||||
class ConfigurationEnvTest < ActiveSupport::TestCase
|
||||
class ConfigurationProxyTest < ActiveSupport::TestCase
|
||||
setup do
|
||||
@deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||
@@ -13,11 +13,31 @@ class ConfigurationEnvTest < ActiveSupport::TestCase
|
||||
assert_equal true, config.proxy.ssl?
|
||||
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
|
||||
@deploy[:proxy] = { "ssl" => true }
|
||||
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
||||
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
|
||||
def config
|
||||
Kamal::Configuration.new(@deploy)
|
||||
|
||||
@@ -222,6 +222,13 @@ class ConfigurationTest < ActiveSupport::TestCase
|
||||
assert_equal "my-user", config.registry.username
|
||||
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
|
||||
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
|
||||
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
|
||||
|
||||
@@ -11,6 +11,16 @@ class EnvFileTest < ActiveSupport::TestCase
|
||||
Kamal::EnvFile.new(env).to_s
|
||||
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
|
||||
env = {
|
||||
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'
|
||||
|
||||
38
test/fixtures/deploy_with_accessories_on_independent_server.yml
vendored
Normal file
38
test/fixtures/deploy_with_accessories_on_independent_server.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
service: app
|
||||
image: dhh/app
|
||||
servers:
|
||||
web:
|
||||
- "1.1.1.1"
|
||||
- "1.1.1.2"
|
||||
workers:
|
||||
- "1.1.1.3"
|
||||
- "1.1.1.4"
|
||||
registry:
|
||||
username: user
|
||||
password: pw
|
||||
builder:
|
||||
arch: amd64
|
||||
|
||||
accessories:
|
||||
mysql:
|
||||
image: mysql:5.7
|
||||
host: 1.1.1.5
|
||||
port: 3306
|
||||
env:
|
||||
clear:
|
||||
MYSQL_ROOT_HOST: '%'
|
||||
secret:
|
||||
- MYSQL_ROOT_PASSWORD
|
||||
files:
|
||||
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
|
||||
directories:
|
||||
- data:/var/lib/mysql
|
||||
redis:
|
||||
image: redis:latest
|
||||
roles:
|
||||
- web
|
||||
port: 6379
|
||||
directories:
|
||||
- data:/data
|
||||
|
||||
readiness_delay: 0
|
||||
29
test/fixtures/deploy_with_single_accessory.yml
vendored
Normal file
29
test/fixtures/deploy_with_single_accessory.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
service: app
|
||||
image: dhh/app
|
||||
servers:
|
||||
web:
|
||||
- "1.1.1.1"
|
||||
- "1.1.1.2"
|
||||
workers:
|
||||
- "1.1.1.3"
|
||||
- "1.1.1.4"
|
||||
registry:
|
||||
username: user
|
||||
password: pw
|
||||
builder:
|
||||
arch: amd64
|
||||
|
||||
accessories:
|
||||
mysql:
|
||||
image: mysql:5.7
|
||||
host: 1.1.1.5
|
||||
port: 3306
|
||||
env:
|
||||
clear:
|
||||
MYSQL_ROOT_HOST: '%'
|
||||
secret:
|
||||
- MYSQL_ROOT_PASSWORD
|
||||
files:
|
||||
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
|
||||
directories:
|
||||
- data:/var/lib/mysql
|
||||
@@ -8,7 +8,7 @@ class AppTest < IntegrationTest
|
||||
|
||||
kamal :app, :stop
|
||||
|
||||
assert_app_is_down
|
||||
assert_app_not_found
|
||||
|
||||
kamal :app, :start
|
||||
|
||||
@@ -48,7 +48,7 @@ class AppTest < IntegrationTest
|
||||
|
||||
kamal :app, :remove
|
||||
|
||||
assert_app_is_down
|
||||
assert_app_not_found
|
||||
assert_app_directory_removed
|
||||
end
|
||||
end
|
||||
|
||||
@@ -9,7 +9,7 @@ class BrokenDeployTest < IntegrationTest
|
||||
kamal :deploy
|
||||
|
||||
assert_app_is_up version: first_version
|
||||
assert_container_running host: :vm3, name: "app-workers-#{first_version}"
|
||||
assert_container_running host: :vm3, name: "app_with_roles-workers-#{first_version}"
|
||||
|
||||
second_version = break_app
|
||||
|
||||
@@ -17,8 +17,8 @@ class BrokenDeployTest < IntegrationTest
|
||||
|
||||
assert_failed_deploy output
|
||||
assert_app_is_up version: first_version
|
||||
assert_container_running host: :vm3, name: "app-workers-#{first_version}"
|
||||
assert_container_not_running host: :vm3, name: "app-workers-#{second_version}"
|
||||
assert_container_running host: :vm3, name: "app_with_roles-workers-#{first_version}"
|
||||
assert_container_not_running host: :vm3, name: "app_with_roles-workers-#{second_version}"
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -19,6 +19,8 @@ RUN apt-get update --fix-missing && apt-get install -y docker-ce docker-ce-cli c
|
||||
COPY *.sh .
|
||||
COPY app/ app/
|
||||
COPY app_with_roles/ app_with_roles/
|
||||
COPY app_with_traefik/ app_with_traefik/
|
||||
COPY app_with_proxied_accessory/ app_with_proxied_accessory/
|
||||
|
||||
RUN rm -rf /root/.ssh
|
||||
RUN ln -s /shared/ssh /root/.ssh
|
||||
@@ -28,6 +30,8 @@ RUN git config --global user.email "deployer@example.com"
|
||||
RUN git config --global user.name "Deployer"
|
||||
RUN cd app && git init && git add . && git commit -am "Initial version"
|
||||
RUN cd app_with_roles && git init && git add . && git commit -am "Initial version"
|
||||
RUN cd app_with_traefik && git init && git add . && git commit -am "Initial version"
|
||||
RUN cd app_with_proxied_accessory && git init && git add . && git commit -am "Initial version"
|
||||
|
||||
HEALTHCHECK --interval=1s CMD pgrep sleep
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
#!/bin/sh
|
||||
echo "Rebooting Traefik on ${KAMAL_HOSTS}..."
|
||||
echo "Rebooting kamal-proxy on ${KAMAL_HOSTS}..."
|
||||
mkdir -p /tmp/${TEST_ID} && touch /tmp/${TEST_ID}/pre-proxy-reboot
|
||||
|
||||
@@ -23,7 +23,8 @@ asset_path: /usr/share/nginx/html/versions
|
||||
deploy_timeout: 2
|
||||
drain_timeout: 2
|
||||
readiness_delay: 0
|
||||
|
||||
proxy:
|
||||
host: 127.0.0.1
|
||||
registry:
|
||||
server: registry:4443
|
||||
username: root
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
FROM registry:4443/nginx:1-alpine-slim
|
||||
|
||||
COPY default.conf /etc/nginx/conf.d/default.conf
|
||||
|
||||
ARG COMMIT_SHA
|
||||
RUN echo $COMMIT_SHA > /usr/share/nginx/html/version
|
||||
RUN mkdir -p /usr/share/nginx/html/versions && echo "version" > /usr/share/nginx/html/versions/$COMMIT_SHA
|
||||
RUN mkdir -p /usr/share/nginx/html/versions && echo "hidden" > /usr/share/nginx/html/versions/.hidden
|
||||
RUN echo "Up!" > /usr/share/nginx/html/up
|
||||
@@ -0,0 +1,44 @@
|
||||
service: app_with_proxied_accessory
|
||||
image: app_with_proxied_accessory
|
||||
servers:
|
||||
- vm1
|
||||
env:
|
||||
clear:
|
||||
CLEAR_TOKEN: 4321
|
||||
CLEAR_TAG: ""
|
||||
HOST_TOKEN: "${HOST_TOKEN}"
|
||||
asset_path: /usr/share/nginx/html/versions
|
||||
proxy:
|
||||
host: 127.0.0.1
|
||||
registry:
|
||||
server: registry:4443
|
||||
username: root
|
||||
password: root
|
||||
builder:
|
||||
driver: docker
|
||||
arch: <%= Kamal::Utils.docker_arch %>
|
||||
args:
|
||||
COMMIT_SHA: <%= `git rev-parse HEAD` %>
|
||||
accessories:
|
||||
busybox:
|
||||
service: custom-busybox
|
||||
image: registry:4443/busybox:1.36.0
|
||||
cmd: sh -c 'echo "Starting busybox..."; trap exit term; while true; do sleep 1; done'
|
||||
roles:
|
||||
- web
|
||||
netcat:
|
||||
service: netcat
|
||||
image: registry:4443/busybox:1.36.0
|
||||
cmd: >
|
||||
sh -c 'echo "Starting netcat..."; while true; do echo -e "HTTP/1.1 200 OK\r\nContent-Length: 11\r\n\r\nHello Ruby" | nc -l -p 80; done'
|
||||
roles:
|
||||
- web
|
||||
port: 12345:80
|
||||
proxy:
|
||||
host: netcat
|
||||
ssl: false
|
||||
healthcheck:
|
||||
interval: 1
|
||||
timeout: 1
|
||||
path: "/"
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
server_name localhost;
|
||||
|
||||
location / {
|
||||
root /usr/share/nginx/html;
|
||||
index index.html index.htm;
|
||||
}
|
||||
|
||||
# redirect server error pages to the static page /50x.html
|
||||
#
|
||||
error_page 500 502 503 504 /50x.html;
|
||||
location = /50x.html {
|
||||
root /usr/share/nginx/html;
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
service: app
|
||||
image: app
|
||||
service: app_with_roles
|
||||
image: app_with_roles
|
||||
servers:
|
||||
web:
|
||||
hosts:
|
||||
@@ -14,14 +14,16 @@ drain_timeout: 2
|
||||
readiness_delay: 0
|
||||
|
||||
proxy:
|
||||
host: localhost
|
||||
ssl: false
|
||||
healthcheck:
|
||||
interval: 1
|
||||
timeout: 1
|
||||
path: "/up"
|
||||
response_timeout: 2
|
||||
buffering:
|
||||
requests: true
|
||||
responses: true
|
||||
requests: false
|
||||
responses: false
|
||||
memory: 400_000
|
||||
max_request_body: 40_000_000
|
||||
max_response_body: 40_000_000
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
kamal proxy boot_config set --publish false \
|
||||
--docker_options label=traefik.http.services.kamal_proxy.loadbalancer.server.scheme=http \
|
||||
label=traefik.http.routers.kamal_proxy.rule=PathPrefix\(\`/\`\)
|
||||
@@ -0,0 +1 @@
|
||||
SECRET_TOKEN='1234 with "中文"'
|
||||
@@ -0,0 +1,9 @@
|
||||
FROM registry:4443/nginx:1-alpine-slim
|
||||
|
||||
COPY default.conf /etc/nginx/conf.d/default.conf
|
||||
|
||||
ARG COMMIT_SHA
|
||||
RUN echo $COMMIT_SHA > /usr/share/nginx/html/version
|
||||
RUN mkdir -p /usr/share/nginx/html/versions && echo "version" > /usr/share/nginx/html/versions/$COMMIT_SHA
|
||||
RUN mkdir -p /usr/share/nginx/html/versions && echo "hidden" > /usr/share/nginx/html/versions/.hidden
|
||||
RUN echo "Up!" > /usr/share/nginx/html/up
|
||||
@@ -0,0 +1,29 @@
|
||||
service: app_with_traefik
|
||||
image: app_with_traefik
|
||||
servers:
|
||||
- vm1
|
||||
- vm2
|
||||
deploy_timeout: 2
|
||||
drain_timeout: 2
|
||||
readiness_delay: 0
|
||||
|
||||
registry:
|
||||
server: registry:4443
|
||||
username: root
|
||||
password: root
|
||||
builder:
|
||||
driver: docker
|
||||
arch: <%= Kamal::Utils.docker_arch %>
|
||||
args:
|
||||
COMMIT_SHA: <%= `git rev-parse HEAD` %>
|
||||
accessories:
|
||||
traefik:
|
||||
service: traefik
|
||||
image: traefik:v2.10
|
||||
port: 80
|
||||
cmd: "--providers.docker"
|
||||
options:
|
||||
volume:
|
||||
- "/var/run/docker.sock:/var/run/docker.sock"
|
||||
roles:
|
||||
- web
|
||||
@@ -0,0 +1,17 @@
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
server_name localhost;
|
||||
|
||||
location / {
|
||||
root /usr/share/nginx/html;
|
||||
index index.html index.htm;
|
||||
}
|
||||
|
||||
# redirect server error pages to the static page /50x.html
|
||||
#
|
||||
error_page 500 502 503 504 /50x.html;
|
||||
location = /50x.html {
|
||||
root /usr/share/nginx/html;
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,8 @@ server {
|
||||
|
||||
location / {
|
||||
proxy_pass http://loadbalancer;
|
||||
proxy_set_header Host $host;
|
||||
|
||||
proxy_connect_timeout 10;
|
||||
proxy_send_timeout 10;
|
||||
proxy_read_timeout 10;
|
||||
|
||||
@@ -50,8 +50,14 @@ class IntegrationTest < ActiveSupport::TestCase
|
||||
assert_equal "502", response.code
|
||||
end
|
||||
|
||||
def assert_app_is_up(version: nil)
|
||||
def assert_app_not_found
|
||||
response = app_response
|
||||
debug_response_code(response, "404")
|
||||
assert_equal "404", response.code
|
||||
end
|
||||
|
||||
def assert_app_is_up(version: nil, app: @app)
|
||||
response = app_response(app: app)
|
||||
debug_response_code(response, "200")
|
||||
assert_equal "200", response.code
|
||||
assert_app_version(version, response) if version
|
||||
@@ -69,8 +75,8 @@ class IntegrationTest < ActiveSupport::TestCase
|
||||
assert_equal up_times, up_count
|
||||
end
|
||||
|
||||
def app_response
|
||||
Net::HTTP.get_response(URI.parse("http://localhost:12345/version"))
|
||||
def app_response(app: @app)
|
||||
Net::HTTP.get_response(URI.parse("http://#{app_host(app)}:12345/version"))
|
||||
end
|
||||
|
||||
def update_app_rev
|
||||
@@ -153,11 +159,24 @@ class IntegrationTest < ActiveSupport::TestCase
|
||||
assert_directory_removed("./kamal/apps/#{@app}")
|
||||
end
|
||||
|
||||
def assert_proxy_directory_removed
|
||||
assert_directory_removed("./kamal/proxy")
|
||||
end
|
||||
|
||||
def assert_directory_removed(directory)
|
||||
assert docker_compose("exec vm1 ls #{directory} | wc -l", capture: true).strip == "0"
|
||||
end
|
||||
|
||||
def assert_proxy_running
|
||||
assert_container_running(host: "vm1", name: "kamal-proxy")
|
||||
end
|
||||
|
||||
def assert_proxy_not_running
|
||||
assert_container_not_running(host: "vm1", name: "kamal-proxy")
|
||||
end
|
||||
|
||||
def app_host(app = @app)
|
||||
case app
|
||||
when "app"
|
||||
"127.0.0.1"
|
||||
else
|
||||
"localhost"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -46,13 +46,13 @@ class MainTest < IntegrationTest
|
||||
|
||||
assert_app_is_up version: version
|
||||
assert_hooks_ran "pre-connect", "pre-build", "pre-deploy", "post-deploy"
|
||||
assert_container_running host: :vm3, name: "app-workers-#{version}"
|
||||
assert_container_running host: :vm3, name: "app_with_roles-workers-#{version}"
|
||||
|
||||
second_version = update_app_rev
|
||||
|
||||
kamal :redeploy
|
||||
assert_app_is_up version: second_version
|
||||
assert_container_running host: :vm3, name: "app-workers-#{second_version}"
|
||||
assert_container_running host: :vm3, name: "app_with_roles-workers-#{second_version}"
|
||||
end
|
||||
|
||||
test "config" do
|
||||
@@ -88,6 +88,14 @@ class MainTest < IntegrationTest
|
||||
end
|
||||
|
||||
test "setup and remove" do
|
||||
@app = "app_with_roles"
|
||||
|
||||
kamal :proxy, :set_config,
|
||||
"--publish=false",
|
||||
"--options=label=traefik.http.services.kamal_proxy.loadbalancer.server.scheme=http",
|
||||
"label=traefik.http.routers.kamal_proxy.rule=PathPrefix\\\(\\\`/\\\`\\\)",
|
||||
"label=traefik.http.routers.kamal_proxy.priority=2"
|
||||
|
||||
# Check remove completes when nothing has been setup yet
|
||||
kamal :remove, "-y"
|
||||
assert_no_images_or_containers
|
||||
@@ -98,7 +106,38 @@ class MainTest < IntegrationTest
|
||||
kamal :remove, "-y"
|
||||
assert_no_images_or_containers
|
||||
assert_app_directory_removed
|
||||
assert_proxy_directory_removed
|
||||
end
|
||||
|
||||
test "two apps" do
|
||||
@app = "app"
|
||||
kamal :deploy
|
||||
app1_version = latest_app_version
|
||||
|
||||
@app = "app_with_roles"
|
||||
kamal :deploy
|
||||
app2_version = latest_app_version
|
||||
|
||||
assert_app_is_up version: app1_version, app: "app"
|
||||
assert_app_is_up version: app2_version, app: "app_with_roles"
|
||||
|
||||
@app = "app"
|
||||
kamal :remove, "-y"
|
||||
assert_app_directory_removed
|
||||
assert_proxy_running
|
||||
|
||||
@app = "app_with_roles"
|
||||
kamal :remove, "-y"
|
||||
assert_app_directory_removed
|
||||
assert_proxy_not_running
|
||||
end
|
||||
|
||||
test "deploy with traefik" do
|
||||
@app = "app_with_traefik"
|
||||
|
||||
first_version = latest_app_version
|
||||
|
||||
kamal :setup
|
||||
assert_app_is_up version: first_version
|
||||
end
|
||||
|
||||
private
|
||||
@@ -116,21 +155,21 @@ class MainTest < IntegrationTest
|
||||
end
|
||||
|
||||
def assert_env(key, value, vm:, version:)
|
||||
assert_equal "#{key}=#{value}", docker_compose("exec #{vm} docker exec app-web-#{version} env | grep #{key}", capture: true)
|
||||
assert_equal "#{key}=#{value}", docker_compose("exec #{vm} docker exec #{@app}-web-#{version} env | grep #{key}", capture: true)
|
||||
end
|
||||
|
||||
def assert_no_env(key, vm:, version:)
|
||||
assert_raises(RuntimeError, /exit 1/) do
|
||||
docker_compose("exec #{vm} docker exec app-web-#{version} env | grep #{key}", capture: true)
|
||||
docker_compose("exec #{vm} docker exec #{@app}-web-#{version} env | grep #{key}", capture: true)
|
||||
end
|
||||
end
|
||||
|
||||
def assert_accumulated_assets(*versions)
|
||||
versions.each do |version|
|
||||
assert_equal "200", Net::HTTP.get_response(URI.parse("http://localhost:12345/versions/#{version}")).code
|
||||
assert_equal "200", Net::HTTP.get_response(URI.parse("http://#{app_host}:12345/versions/#{version}")).code
|
||||
end
|
||||
|
||||
assert_equal "200", Net::HTTP.get_response(URI.parse("http://localhost:12345/versions/.hidden")).code
|
||||
assert_equal "200", Net::HTTP.get_response(URI.parse("http://#{app_host}:12345/versions/.hidden")).code
|
||||
end
|
||||
|
||||
def vm1_image_ids
|
||||
|
||||
63
test/integration/proxied_accessory_test.rb
Normal file
63
test/integration/proxied_accessory_test.rb
Normal file
@@ -0,0 +1,63 @@
|
||||
require_relative "integration_test"
|
||||
|
||||
class ProxiedAccessoryTest < IntegrationTest
|
||||
test "boot, stop, start, restart, logs, remove" do
|
||||
@app = "app_with_proxied_accessory"
|
||||
|
||||
kamal :deploy
|
||||
|
||||
kamal :accessory, :boot, :netcat
|
||||
assert_accessory_running :netcat
|
||||
assert_netcat_is_up
|
||||
|
||||
kamal :accessory, :stop, :netcat
|
||||
assert_accessory_not_running :netcat
|
||||
assert_netcat_not_found
|
||||
|
||||
kamal :accessory, :start, :netcat
|
||||
assert_accessory_running :netcat
|
||||
assert_netcat_is_up
|
||||
|
||||
kamal :accessory, :restart, :netcat
|
||||
assert_accessory_running :netcat
|
||||
assert_netcat_is_up
|
||||
|
||||
kamal :accessory, :remove, :netcat, "-y"
|
||||
assert_accessory_not_running :netcat
|
||||
assert_netcat_not_found
|
||||
end
|
||||
|
||||
private
|
||||
def assert_accessory_running(name)
|
||||
assert_match /registry:4443\/busybox:1.36.0 "sh -c 'echo \\"Start/, accessory_details(name)
|
||||
end
|
||||
|
||||
def assert_accessory_not_running(name)
|
||||
assert_no_match /registry:4443\/busybox:1.36.0 "sh -c 'echo \\"Start/, accessory_details(name)
|
||||
end
|
||||
|
||||
def accessory_details(name)
|
||||
kamal :accessory, :details, name, capture: true
|
||||
end
|
||||
|
||||
def assert_netcat_is_up
|
||||
response = netcat_response
|
||||
debug_response_code(response, "200")
|
||||
assert_equal "200", response.code
|
||||
end
|
||||
|
||||
def assert_netcat_not_found
|
||||
response = netcat_response
|
||||
debug_response_code(response, "404")
|
||||
assert_equal "404", response.code
|
||||
end
|
||||
|
||||
def netcat_response
|
||||
uri = URI.parse("http://127.0.0.1:12345/up")
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
request = Net::HTTP::Get.new(uri)
|
||||
request["Host"] = "netcat"
|
||||
|
||||
http.request(request)
|
||||
end
|
||||
end
|
||||
@@ -48,19 +48,5 @@ class ProxyTest < IntegrationTest
|
||||
|
||||
kamal :proxy, :remove
|
||||
assert_proxy_not_running
|
||||
assert_proxy_directory_removed
|
||||
end
|
||||
|
||||
private
|
||||
def assert_proxy_running
|
||||
assert_match /basecamp\/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION} \"kamal-proxy run\"/, proxy_details
|
||||
end
|
||||
|
||||
def assert_proxy_not_running
|
||||
assert_no_match /basecamp\/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION} \"kamal-proxy run\"/, proxy_details
|
||||
end
|
||||
|
||||
def proxy_details
|
||||
kamal :proxy, :details, capture: true
|
||||
end
|
||||
end
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user