Compare commits
152 Commits
v2.0.0
...
output-rol
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bffe137e2b | ||
|
|
b9804a07aa | ||
|
|
f4d98bb67a | ||
|
|
42c3425411 | ||
|
|
57e48a33bb | ||
|
|
4acb78fff6 | ||
|
|
1a86b3ae6e | ||
|
|
a4ab34d8d9 | ||
|
|
24d03fd60e | ||
|
|
83fd2a051d | ||
|
|
72f30774ba | ||
|
|
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 | ||
|
|
92d82dd1a7 | ||
|
|
c17bdba61c | ||
|
|
13328687d1 | ||
|
|
2b0810d063 | ||
|
|
098f1855e2 | ||
|
|
88351312bf | ||
|
|
190f4fba28 |
9
.github/workflows/ci.yml
vendored
9
.github/workflows/ci.yml
vendored
@@ -27,9 +27,13 @@ jobs:
|
|||||||
- "3.1"
|
- "3.1"
|
||||||
- "3.2"
|
- "3.2"
|
||||||
- "3.3"
|
- "3.3"
|
||||||
|
- "3.4.0-preview2"
|
||||||
gemfile:
|
gemfile:
|
||||||
- Gemfile
|
- Gemfile
|
||||||
- gemfiles/rails_edge.gemfile
|
- gemfiles/rails_edge.gemfile
|
||||||
|
exclude:
|
||||||
|
- ruby-version: "3.1"
|
||||||
|
gemfile: gemfiles/rails_edge.gemfile
|
||||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
@@ -38,6 +42,9 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Remove gemfile.lock
|
||||||
|
run: rm Gemfile.lock
|
||||||
|
|
||||||
- name: Install Ruby
|
- name: Install Ruby
|
||||||
uses: ruby/setup-ruby@v1
|
uses: ruby/setup-ruby@v1
|
||||||
with:
|
with:
|
||||||
@@ -46,3 +53,5 @@ jobs:
|
|||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: bin/test
|
run: bin/test
|
||||||
|
env:
|
||||||
|
RUBYOPT: ${{ startsWith(matrix.ruby-version, '3.4.') && '--enable=frozen-string-literal' || '' }}
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
# Use the official Ruby 3.2.0 Alpine image as the base image
|
FROM ruby:3.3-alpine
|
||||||
FROM ruby:3.2.0-alpine
|
|
||||||
|
|
||||||
# Install docker/buildx-bin
|
# Install docker/buildx-bin
|
||||||
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
||||||
@@ -33,7 +32,7 @@ WORKDIR /workdir
|
|||||||
|
|
||||||
# Tell git it's safe to access /workdir/.git even if
|
# Tell git it's safe to access /workdir/.git even if
|
||||||
# the directory is owned by a different user
|
# the directory is owned by a different user
|
||||||
RUN git config --global --add safe.directory /workdir
|
RUN git config --global --add safe.directory '*'
|
||||||
|
|
||||||
# Set the entrypoint to run the installed binary in /workdir
|
# Set the entrypoint to run the installed binary in /workdir
|
||||||
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
||||||
|
|||||||
42
Gemfile.lock
42
Gemfile.lock
@@ -1,24 +1,24 @@
|
|||||||
PATH
|
PATH
|
||||||
remote: .
|
remote: .
|
||||||
specs:
|
specs:
|
||||||
kamal (2.0.0)
|
kamal (2.3.0)
|
||||||
activesupport (>= 7.0)
|
activesupport (>= 7.0)
|
||||||
base64 (~> 0.2)
|
base64 (~> 0.2)
|
||||||
bcrypt_pbkdf (~> 1.0)
|
bcrypt_pbkdf (~> 1.0)
|
||||||
concurrent-ruby (~> 1.2)
|
concurrent-ruby (~> 1.2)
|
||||||
dotenv (~> 3.1)
|
dotenv (~> 3.1)
|
||||||
ed25519 (~> 1.2)
|
ed25519 (~> 1.2)
|
||||||
net-ssh (~> 7.0)
|
net-ssh (~> 7.3)
|
||||||
sshkit (>= 1.23.0, < 2.0)
|
sshkit (>= 1.23.0, < 2.0)
|
||||||
thor (~> 1.3)
|
thor (~> 1.3)
|
||||||
zeitwerk (~> 2.5)
|
zeitwerk (>= 2.6.18, < 3.0)
|
||||||
|
|
||||||
GEM
|
GEM
|
||||||
remote: https://rubygems.org/
|
remote: https://rubygems.org/
|
||||||
specs:
|
specs:
|
||||||
actionpack (7.1.3.4)
|
actionpack (7.1.4.1)
|
||||||
actionview (= 7.1.3.4)
|
actionview (= 7.1.4.1)
|
||||||
activesupport (= 7.1.3.4)
|
activesupport (= 7.1.4.1)
|
||||||
nokogiri (>= 1.8.5)
|
nokogiri (>= 1.8.5)
|
||||||
racc
|
racc
|
||||||
rack (>= 2.2.4)
|
rack (>= 2.2.4)
|
||||||
@@ -26,13 +26,13 @@ GEM
|
|||||||
rack-test (>= 0.6.3)
|
rack-test (>= 0.6.3)
|
||||||
rails-dom-testing (~> 2.2)
|
rails-dom-testing (~> 2.2)
|
||||||
rails-html-sanitizer (~> 1.6)
|
rails-html-sanitizer (~> 1.6)
|
||||||
actionview (7.1.3.4)
|
actionview (7.1.4.1)
|
||||||
activesupport (= 7.1.3.4)
|
activesupport (= 7.1.4.1)
|
||||||
builder (~> 3.1)
|
builder (~> 3.1)
|
||||||
erubi (~> 1.11)
|
erubi (~> 1.11)
|
||||||
rails-dom-testing (~> 2.2)
|
rails-dom-testing (~> 2.2)
|
||||||
rails-html-sanitizer (~> 1.6)
|
rails-html-sanitizer (~> 1.6)
|
||||||
activesupport (7.1.3.4)
|
activesupport (7.1.4.1)
|
||||||
base64
|
base64
|
||||||
bigdecimal
|
bigdecimal
|
||||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
||||||
@@ -49,7 +49,7 @@ GEM
|
|||||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||||
bigdecimal (3.1.8)
|
bigdecimal (3.1.8)
|
||||||
builder (3.3.0)
|
builder (3.3.0)
|
||||||
concurrent-ruby (1.3.3)
|
concurrent-ruby (1.3.4)
|
||||||
connection_pool (2.4.1)
|
connection_pool (2.4.1)
|
||||||
crass (1.0.6)
|
crass (1.0.6)
|
||||||
debug (1.9.2)
|
debug (1.9.2)
|
||||||
@@ -59,7 +59,7 @@ GEM
|
|||||||
drb (2.2.1)
|
drb (2.2.1)
|
||||||
ed25519 (1.3.0)
|
ed25519 (1.3.0)
|
||||||
erubi (1.13.0)
|
erubi (1.13.0)
|
||||||
i18n (1.14.5)
|
i18n (1.14.6)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
io-console (0.7.2)
|
io-console (0.7.2)
|
||||||
irb (1.14.0)
|
irb (1.14.0)
|
||||||
@@ -70,7 +70,7 @@ GEM
|
|||||||
loofah (2.22.0)
|
loofah (2.22.0)
|
||||||
crass (~> 1.0.2)
|
crass (~> 1.0.2)
|
||||||
nokogiri (>= 1.12.0)
|
nokogiri (>= 1.12.0)
|
||||||
minitest (5.24.1)
|
minitest (5.25.1)
|
||||||
mocha (2.4.5)
|
mocha (2.4.5)
|
||||||
ruby2_keywords (>= 0.0.5)
|
ruby2_keywords (>= 0.0.5)
|
||||||
mutex_m (0.2.0)
|
mutex_m (0.2.0)
|
||||||
@@ -78,7 +78,7 @@ GEM
|
|||||||
net-ssh (>= 2.6.5, < 8.0.0)
|
net-ssh (>= 2.6.5, < 8.0.0)
|
||||||
net-sftp (4.0.0)
|
net-sftp (4.0.0)
|
||||||
net-ssh (>= 5.0.0, < 8.0.0)
|
net-ssh (>= 5.0.0, < 8.0.0)
|
||||||
net-ssh (7.2.3)
|
net-ssh (7.3.0)
|
||||||
nokogiri (1.16.7-arm64-darwin)
|
nokogiri (1.16.7-arm64-darwin)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
nokogiri (1.16.7-x86_64-darwin)
|
nokogiri (1.16.7-x86_64-darwin)
|
||||||
@@ -92,7 +92,7 @@ GEM
|
|||||||
psych (5.1.2)
|
psych (5.1.2)
|
||||||
stringio
|
stringio
|
||||||
racc (1.8.1)
|
racc (1.8.1)
|
||||||
rack (3.1.7)
|
rack (3.1.8)
|
||||||
rack-session (2.0.0)
|
rack-session (2.0.0)
|
||||||
rack (>= 3.0.0)
|
rack (>= 3.0.0)
|
||||||
rack-test (2.1.0)
|
rack-test (2.1.0)
|
||||||
@@ -107,9 +107,9 @@ GEM
|
|||||||
rails-html-sanitizer (1.6.0)
|
rails-html-sanitizer (1.6.0)
|
||||||
loofah (~> 2.21)
|
loofah (~> 2.21)
|
||||||
nokogiri (~> 1.14)
|
nokogiri (~> 1.14)
|
||||||
railties (7.1.3.4)
|
railties (7.1.4.1)
|
||||||
actionpack (= 7.1.3.4)
|
actionpack (= 7.1.4.1)
|
||||||
activesupport (= 7.1.3.4)
|
activesupport (= 7.1.4.1)
|
||||||
irb
|
irb
|
||||||
rackup (>= 1.0.0)
|
rackup (>= 1.0.0)
|
||||||
rake (>= 12.2)
|
rake (>= 12.2)
|
||||||
@@ -122,8 +122,7 @@ GEM
|
|||||||
regexp_parser (2.9.2)
|
regexp_parser (2.9.2)
|
||||||
reline (0.5.9)
|
reline (0.5.9)
|
||||||
io-console (~> 0.5)
|
io-console (~> 0.5)
|
||||||
rexml (3.3.4)
|
rexml (3.3.9)
|
||||||
strscan
|
|
||||||
rubocop (1.65.1)
|
rubocop (1.65.1)
|
||||||
json (~> 2.3)
|
json (~> 2.3)
|
||||||
language_server-protocol (>= 3.17.0)
|
language_server-protocol (>= 3.17.0)
|
||||||
@@ -161,13 +160,12 @@ GEM
|
|||||||
net-sftp (>= 2.1.2)
|
net-sftp (>= 2.1.2)
|
||||||
net-ssh (>= 2.8.0)
|
net-ssh (>= 2.8.0)
|
||||||
stringio (3.1.1)
|
stringio (3.1.1)
|
||||||
strscan (3.1.0)
|
|
||||||
thor (1.3.1)
|
thor (1.3.1)
|
||||||
tzinfo (2.0.6)
|
tzinfo (2.0.6)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
unicode-display_width (2.5.0)
|
unicode-display_width (2.5.0)
|
||||||
webrick (1.8.1)
|
webrick (1.8.2)
|
||||||
zeitwerk (2.6.17)
|
zeitwerk (2.7.1)
|
||||||
|
|
||||||
PLATFORMS
|
PLATFORMS
|
||||||
arm64-darwin
|
arm64-darwin
|
||||||
|
|||||||
16
bin/docs
16
bin/docs
@@ -30,6 +30,7 @@ DOCS = {
|
|||||||
"ssh" => "SSH",
|
"ssh" => "SSH",
|
||||||
"sshkit" => "SSHKit"
|
"sshkit" => "SSHKit"
|
||||||
}
|
}
|
||||||
|
DOCS_PATH = "lib/kamal/configuration/docs"
|
||||||
|
|
||||||
class DocWriter
|
class DocWriter
|
||||||
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
||||||
@@ -70,6 +71,7 @@ class DocWriter
|
|||||||
generate_line(line, heading: place == :new_section)
|
generate_line(line, heading: place == :new_section)
|
||||||
place = :in_section
|
place = :in_section
|
||||||
else
|
else
|
||||||
|
output.puts
|
||||||
output.puts "```yaml"
|
output.puts "```yaml"
|
||||||
output.puts line
|
output.puts line
|
||||||
place = :in_yaml
|
place = :in_yaml
|
||||||
@@ -77,6 +79,7 @@ class DocWriter
|
|||||||
when :in_yaml, :in_empty_line_yaml
|
when :in_yaml, :in_empty_line_yaml
|
||||||
if line =~ /^ *#/
|
if line =~ /^ *#/
|
||||||
output.puts "```"
|
output.puts "```"
|
||||||
|
output.puts
|
||||||
generate_line(line, heading: place == :in_empty_line_yaml)
|
generate_line(line, heading: place == :in_empty_line_yaml)
|
||||||
place = :in_section
|
place = :in_section
|
||||||
elsif line.empty?
|
elsif line.empty?
|
||||||
@@ -92,11 +95,12 @@ class DocWriter
|
|||||||
|
|
||||||
def generate_header
|
def generate_header
|
||||||
output.puts "---"
|
output.puts "---"
|
||||||
|
output.puts "# This file has been generated from the Kamal source, do not edit directly."
|
||||||
|
output.puts "# Find the source of this file at #{DOCS_PATH}/#{key}.yml in the Kamal repository."
|
||||||
output.puts "title: #{heading[2..-1]}"
|
output.puts "title: #{heading[2..-1]}"
|
||||||
output.puts "---"
|
output.puts "---"
|
||||||
output.puts
|
output.puts
|
||||||
output.puts heading
|
output.puts heading
|
||||||
output.puts
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def generate_line(line, heading: false)
|
def generate_line(line, heading: false)
|
||||||
@@ -118,7 +122,11 @@ class DocWriter
|
|||||||
end
|
end
|
||||||
|
|
||||||
def linkify(text)
|
def linkify(text)
|
||||||
text.downcase.gsub(" ", "-")
|
if text == "Configuration overview"
|
||||||
|
"overview"
|
||||||
|
else
|
||||||
|
text.downcase.gsub(" ", "-")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def titlify(text)
|
def titlify(text)
|
||||||
@@ -126,10 +134,8 @@ class DocWriter
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
from_dir = File.join(File.dirname(__FILE__), "../lib/kamal/configuration/docs")
|
from_dir = File.join(File.dirname(__FILE__), "../#{DOCS_PATH}")
|
||||||
to_dir = File.join(kamal_site_repo, "docs/configuration")
|
to_dir = File.join(kamal_site_repo, "docs/configuration")
|
||||||
Dir.glob("#{from_dir}/*") do |from_file|
|
Dir.glob("#{from_dir}/*") do |from_file|
|
||||||
key = File.basename(from_file, ".yml")
|
|
||||||
|
|
||||||
DocWriter.new(from_file, to_dir).write
|
DocWriter.new(from_file, to_dir).write
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
|
|||||||
|
|
||||||
spec.add_dependency "activesupport", ">= 7.0"
|
spec.add_dependency "activesupport", ">= 7.0"
|
||||||
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
||||||
spec.add_dependency "net-ssh", "~> 7.0"
|
spec.add_dependency "net-ssh", "~> 7.3"
|
||||||
spec.add_dependency "thor", "~> 1.3"
|
spec.add_dependency "thor", "~> 1.3"
|
||||||
spec.add_dependency "dotenv", "~> 3.1"
|
spec.add_dependency "dotenv", "~> 3.1"
|
||||||
spec.add_dependency "zeitwerk", "~> 2.5"
|
spec.add_dependency "zeitwerk", ">= 2.6.18", "< 3.0"
|
||||||
spec.add_dependency "ed25519", "~> 1.2"
|
spec.add_dependency "ed25519", "~> 1.2"
|
||||||
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
||||||
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
require "active_support/core_ext/array/conversions"
|
||||||
|
|
||||||
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||||
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
||||||
def boot(name, prepare: true)
|
def boot(name, prepare: true)
|
||||||
@@ -110,14 +112,15 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "exec [NAME] [CMD]", "Execute a custom command on servers (use --help to show options)"
|
desc "exec [NAME] [CMD...]", "Execute a custom command on servers within the accessory container (use --help to show options)"
|
||||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||||
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||||
def exec(name, cmd)
|
def exec(name, *cmd)
|
||||||
|
cmd = Kamal::Utils.join_commands(cmd)
|
||||||
with_accessory(name) do |accessory, hosts|
|
with_accessory(name) do |accessory, hosts|
|
||||||
case
|
case
|
||||||
when options[:interactive] && options[:reuse]
|
when options[:interactive] && options[:reuse]
|
||||||
say "Launching interactive command with via SSH from existing container...", :magenta
|
say "Launching interactive command via SSH from existing container...", :magenta
|
||||||
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
||||||
|
|
||||||
when options[:interactive]
|
when options[:interactive]
|
||||||
@@ -126,16 +129,16 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
|||||||
|
|
||||||
when options[:reuse]
|
when options[:reuse]
|
||||||
say "Launching command from existing container...", :magenta
|
say "Launching command from existing container...", :magenta
|
||||||
on(hosts) do
|
on(hosts) do |host|
|
||||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
puts_by_host host, capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||||
end
|
end
|
||||||
|
|
||||||
else
|
else
|
||||||
say "Launching command from new container...", :magenta
|
say "Launching command from new container...", :magenta
|
||||||
on(hosts) do
|
on(hosts) do |host|
|
||||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||||
capture_with_info(*accessory.execute_in_new_container(cmd))
|
puts_by_host host, capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -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
|
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
||||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||||
if endpoint.present?
|
if endpoint.present?
|
||||||
execute *app.remove(target: endpoint), raise_on_non_zero_exit: false
|
execute *app.remove, raise_on_non_zero_exit: false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -203,7 +203,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
run_locally do
|
run_locally do
|
||||||
info "Following logs on #{KAMAL.primary_host}..."
|
info "Following logs on #{KAMAL.primary_host}..."
|
||||||
|
|
||||||
KAMAL.specific_roles ||= [ "web" ]
|
KAMAL.specific_roles ||= [ KAMAL.primary_role.name ]
|
||||||
role = KAMAL.roles_on(KAMAL.primary_host).first
|
role = KAMAL.roles_on(KAMAL.primary_host).first
|
||||||
|
|
||||||
app = KAMAL.app(role: role, host: host)
|
app = KAMAL.app(role: role, host: host)
|
||||||
@@ -218,7 +218,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
|||||||
|
|
||||||
roles.each do |role|
|
roles.each do |role|
|
||||||
begin
|
begin
|
||||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options)), type: role
|
||||||
rescue SSHKit::Command::Failed
|
rescue SSHKit::Command::Failed
|
||||||
puts_by_host host, "Nothing found"
|
puts_by_host host, "Nothing found"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -135,7 +135,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
|||||||
puts "No documentation found for #{section}"
|
puts "No documentation found for #{section}"
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "init", "Create config stub in config/deploy.yml and env stub in .env"
|
desc "init", "Create config stub in config/deploy.yml and secrets stub in .kamal"
|
||||||
option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub"
|
option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub"
|
||||||
def init
|
def init
|
||||||
require "fileutils"
|
require "fileutils"
|
||||||
|
|||||||
@@ -14,23 +14,25 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
|||||||
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
||||||
|
|
||||||
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||||
raise "kamal-proxy version #{version} is too old, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||||
end
|
end
|
||||||
execute *KAMAL.proxy.start_or_run
|
execute *KAMAL.proxy.start_or_run
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
desc "boot_config <set|get|clear>", "Mange kamal-proxy boot configuration"
|
desc "boot_config <set|get|reset>", "Manage kamal-proxy boot configuration"
|
||||||
option :publish, type: :boolean, default: true, desc: "Publish the proxy ports on the host"
|
option :publish, 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 :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 :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"
|
option :docker_options, type: :array, default: [], desc: "Docker options to pass to the proxy container", banner: "option=value option2=value2"
|
||||||
def boot_config(subcommand)
|
def boot_config(subcommand)
|
||||||
case subcommand
|
case subcommand
|
||||||
when "set"
|
when "set"
|
||||||
boot_options = [
|
boot_options = [
|
||||||
*(KAMAL.config.proxy_publish_args(options[:http_port], options[:https_port]) if options[:publish]),
|
*(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}" }
|
*options[:docker_options].map { |option| "--#{option}" }
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,17 @@
|
|||||||
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
||||||
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
||||||
option :adapter, type: :string, aliases: "-a", required: true, desc: "Which vault adapter to use"
|
option :adapter, type: :string, aliases: "-a", required: true, desc: "Which vault adapter to use"
|
||||||
option :account, type: :string, required: true, desc: "The account identifier or username"
|
option :account, type: :string, required: false, desc: "The account identifier or username"
|
||||||
option :from, type: :string, required: false, desc: "A vault or folder to fetch the secrets from"
|
option :from, type: :string, required: false, desc: "A vault or folder to fetch the secrets from"
|
||||||
option :inline, type: :boolean, required: false, hidden: true
|
option :inline, type: :boolean, required: false, hidden: true
|
||||||
def fetch(*secrets)
|
def fetch(*secrets)
|
||||||
results = adapter(options[:adapter]).fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
adapter = initialize_adapter(options[:adapter])
|
||||||
|
|
||||||
|
if adapter.requires_account? && options[:account].blank?
|
||||||
|
return puts "No value provided for required options '--account'"
|
||||||
|
end
|
||||||
|
|
||||||
|
results = adapter.fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
||||||
|
|
||||||
return_or_puts JSON.dump(results).shellescape, inline: options[:inline]
|
return_or_puts JSON.dump(results).shellescape, inline: options[:inline]
|
||||||
end
|
end
|
||||||
@@ -21,8 +27,15 @@ class Kamal::Cli::Secrets < Kamal::Cli::Base
|
|||||||
return_or_puts value, inline: options[:inline]
|
return_or_puts value, inline: options[:inline]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
desc "print", "Print the secrets (for debugging)"
|
||||||
|
def print
|
||||||
|
KAMAL.config.secrets.to_h.each do |key, value|
|
||||||
|
puts "#{key}=#{value}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def adapter(adapter)
|
def initialize_adapter(adapter)
|
||||||
Kamal::Secrets::Adapters.lookup(adapter)
|
Kamal::Secrets::Adapters.lookup(adapter)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -13,11 +13,15 @@ servers:
|
|||||||
# - 192.168.0.1
|
# - 192.168.0.1
|
||||||
# cmd: bin/jobs
|
# cmd: bin/jobs
|
||||||
|
|
||||||
# Enable SSL auto certification via Let's Encrypt (and allow for multiple apps on one server).
|
# Enable SSL auto certification via Let's Encrypt and allow for multiple apps on a single web server.
|
||||||
# Set ssl: false if using something like Cloudflare to terminate SSL (but keep host!).
|
# 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:
|
proxy:
|
||||||
ssl: true
|
ssl: true
|
||||||
host: app.example.com
|
host: app.example.com
|
||||||
|
# Proxy connects to your container on port 80 by default.
|
||||||
|
# app_port: 3000
|
||||||
|
|
||||||
# Credentials for your image host.
|
# Credentials for your image host.
|
||||||
registry:
|
registry:
|
||||||
@@ -32,6 +36,9 @@ registry:
|
|||||||
# Configure builder setup.
|
# Configure builder setup.
|
||||||
builder:
|
builder:
|
||||||
arch: amd64
|
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 .kamal/secrets).
|
# Inject ENV variables into containers (secrets come from .kamal/secrets).
|
||||||
#
|
#
|
||||||
@@ -87,7 +94,7 @@ builder:
|
|||||||
# directories:
|
# directories:
|
||||||
# - data:/var/lib/mysql
|
# - data:/var/lib/mysql
|
||||||
# redis:
|
# redis:
|
||||||
# image: redis:7.0
|
# image: valkey/valkey:8
|
||||||
# host: 192.168.0.2
|
# host: 192.168.0.2
|
||||||
# port: 6379
|
# port: 6379
|
||||||
# directories:
|
# directories:
|
||||||
|
|||||||
@@ -1,13 +1,3 @@
|
|||||||
#!/usr/bin/env ruby
|
#!/bin/sh
|
||||||
|
|
||||||
# A sample docker-setup hook
|
echo "Docker set up on $KAMAL_HOSTS..."
|
||||||
#
|
|
||||||
# Sets up a Docker network on defined hosts which can then be used by the application’s containers
|
|
||||||
|
|
||||||
hosts = ENV["KAMAL_HOSTS"].split(",")
|
|
||||||
|
|
||||||
hosts.each do |ip|
|
|
||||||
destination = "root@#{ip}"
|
|
||||||
puts "Creating a Docker network \"kamal\" on #{destination}"
|
|
||||||
`ssh #{destination} docker network create kamal`
|
|
||||||
end
|
|
||||||
|
|||||||
@@ -43,7 +43,12 @@ class Kamal::Commander::Specifics
|
|||||||
end
|
end
|
||||||
|
|
||||||
def specified_hosts
|
def specified_hosts
|
||||||
(specific_hosts || config.all_hosts) \
|
specified_hosts = specific_hosts || config.all_hosts
|
||||||
.select { |host| (specific_roles || config.roles).flat_map(&:hosts).include?(host) }
|
|
||||||
|
if (specific_role_hosts = specific_roles&.flat_map(&:hosts)).present?
|
||||||
|
specified_hosts.select { |host| specific_role_hosts.include?(host) }
|
||||||
|
else
|
||||||
|
specified_hosts
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||||
attr_reader :accessory_config
|
attr_reader :accessory_config
|
||||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||||
:publish_args, :env_args, :volume_args, :label_args, :option_args,
|
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||||
:secrets_io, :secrets_path, :env_directory,
|
:secrets_io, :secrets_path, :env_directory,
|
||||||
to: :accessory_config
|
to: :accessory_config
|
||||||
|
|
||||||
@@ -15,7 +15,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
"--name", service_name,
|
"--name", service_name,
|
||||||
"--detach",
|
"--detach",
|
||||||
"--restart", "unless-stopped",
|
"--restart", "unless-stopped",
|
||||||
"--network", "kamal",
|
*network_args,
|
||||||
*config.logging_args,
|
*config.logging_args,
|
||||||
*publish_args,
|
*publish_args,
|
||||||
*env_args,
|
*env_args,
|
||||||
@@ -64,7 +64,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
|||||||
docker :run,
|
docker :run,
|
||||||
("-it" if interactive),
|
("-it" if interactive),
|
||||||
"--rm",
|
"--rm",
|
||||||
"--network", "kamal",
|
*network_args,
|
||||||
*env_args,
|
*env_args,
|
||||||
*volume_args,
|
*volume_args,
|
||||||
image,
|
image,
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def info
|
def info
|
||||||
docker :ps, *filter_args
|
docker :ps, *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
|
|
||||||
def list_versions(*docker_args, statuses: nil)
|
def list_versions(*docker_args, statuses: nil)
|
||||||
pipe \
|
pipe \
|
||||||
docker(:ps, *filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
docker(:ps, *container_filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
||||||
extract_version_from_name
|
extract_version_from_name
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -91,11 +91,15 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def latest_container(format:, filters: nil)
|
def latest_container(format:, filters: nil)
|
||||||
docker :ps, "--latest", *format, *filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
docker :ps, "--latest", *format, *container_filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
||||||
end
|
end
|
||||||
|
|
||||||
def filter_args(statuses: nil)
|
def container_filter_args(statuses: nil)
|
||||||
argumentize "--filter", filters(statuses: statuses)
|
argumentize "--filter", container_filters(statuses: statuses)
|
||||||
|
end
|
||||||
|
|
||||||
|
def image_filter_args
|
||||||
|
argumentize "--filter", image_filters
|
||||||
end
|
end
|
||||||
|
|
||||||
def extract_version_from_name
|
def extract_version_from_name
|
||||||
@@ -103,13 +107,17 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
|||||||
%(while read line; do echo ${line##{role.container_prefix}-}; done)
|
%(while read line; do echo ${line##{role.container_prefix}-}; done)
|
||||||
end
|
end
|
||||||
|
|
||||||
def filters(statuses: nil)
|
def container_filters(statuses: nil)
|
||||||
[ "label=service=#{config.service}" ].tap do |filters|
|
[ "label=service=#{config.service}" ].tap do |filters|
|
||||||
filters << "label=destination=#{config.destination}" if config.destination
|
filters << "label=destination=#{config.destination}"
|
||||||
filters << "label=role=#{role}" if role
|
filters << "label=role=#{role}" if role
|
||||||
statuses&.each do |status|
|
statuses&.each do |status|
|
||||||
filters << "status=#{status}"
|
filters << "status=#{status}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def image_filters
|
||||||
|
[ "label=service=#{config.service}" ]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ module Kamal::Commands::App::Containers
|
|||||||
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
||||||
|
|
||||||
def list_containers
|
def list_containers
|
||||||
docker :container, :ls, "--all", *filter_args
|
docker :container, :ls, "--all", *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def list_container_names
|
def list_container_names
|
||||||
@@ -20,7 +20,7 @@ module Kamal::Commands::App::Containers
|
|||||||
end
|
end
|
||||||
|
|
||||||
def remove_containers
|
def remove_containers
|
||||||
docker :container, :prune, "--force", *filter_args
|
docker :container, :prune, "--force", *container_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def container_health_log(version:)
|
def container_health_log(version:)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ module Kamal::Commands::App::Images
|
|||||||
end
|
end
|
||||||
|
|
||||||
def remove_images
|
def remove_images
|
||||||
docker :image, :prune, "--all", "--force", *filter_args
|
docker :image, :prune, "--all", "--force", *image_filter_args
|
||||||
end
|
end
|
||||||
|
|
||||||
def tag_latest_image
|
def tag_latest_image
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ module Kamal::Commands::App::Proxy
|
|||||||
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
||||||
end
|
end
|
||||||
|
|
||||||
def remove(target:)
|
def remove
|
||||||
proxy_exec :remove, role.container_prefix, *role.proxy.remove_command_args(target: target)
|
proxy_exec :remove, role.container_prefix
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
@@ -11,14 +11,7 @@ module Kamal::Commands
|
|||||||
end
|
end
|
||||||
|
|
||||||
def run_over_ssh(*command, host:)
|
def run_over_ssh(*command, host:)
|
||||||
"ssh".tap do |cmd|
|
"ssh#{ssh_proxy_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
|
||||||
if config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Jump)
|
|
||||||
cmd << " -J #{config.ssh.proxy.jump_proxies}"
|
|
||||||
elsif config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Command)
|
|
||||||
cmd << " -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
|
|
||||||
end
|
|
||||||
cmd << " -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def container_id_for(container_name:, only_running: false)
|
def container_id_for(container_name:, only_running: false)
|
||||||
@@ -92,5 +85,14 @@ module Kamal::Commands
|
|||||||
def tags(**details)
|
def tags(**details)
|
||||||
Kamal::Tags.from_config(config, **details)
|
Kamal::Tags.from_config(config, **details)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def ssh_proxy_args
|
||||||
|
case config.ssh.proxy
|
||||||
|
when Net::SSH::Proxy::Jump
|
||||||
|
" -J #{config.ssh.proxy.jump_proxies}"
|
||||||
|
when Net::SSH::Proxy::Command
|
||||||
|
" -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
delegate :argumentize, to: Kamal::Utils
|
delegate :argumentize, to: Kamal::Utils
|
||||||
delegate \
|
delegate \
|
||||||
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
||||||
:cache_from, :cache_to, :ssh, :driver, :docker_driver?,
|
:cache_from, :cache_to, :ssh, :provenance, :sbom, :driver, :docker_driver?,
|
||||||
to: :builder_config
|
to: :builder_config
|
||||||
|
|
||||||
def clean
|
def clean
|
||||||
@@ -37,7 +37,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
end
|
end
|
||||||
|
|
||||||
def build_options
|
def build_options
|
||||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
|
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_context
|
def build_context
|
||||||
@@ -97,6 +97,14 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
|||||||
argumentize "--ssh", ssh if ssh.present?
|
argumentize "--ssh", ssh if ssh.present?
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def builder_provenance
|
||||||
|
argumentize "--provenance", provenance unless provenance.nil?
|
||||||
|
end
|
||||||
|
|
||||||
|
def builder_sbom
|
||||||
|
argumentize "--sbom", sbom unless sbom.nil?
|
||||||
|
end
|
||||||
|
|
||||||
def builder_config
|
def builder_config
|
||||||
config.builder
|
config.builder
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,29 +1,31 @@
|
|||||||
module Kamal::Commands::Builder::Clone
|
module Kamal::Commands::Builder::Clone
|
||||||
extend ActiveSupport::Concern
|
|
||||||
|
|
||||||
included do
|
|
||||||
delegate :clone_directory, :build_directory, to: :"config.builder"
|
|
||||||
end
|
|
||||||
|
|
||||||
def clone
|
def clone
|
||||||
git :clone, Kamal::Git.root, "--recurse-submodules", path: clone_directory
|
git :clone, escaped_root, "--recurse-submodules", path: config.builder.clone_directory.shellescape
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_reset_steps
|
def clone_reset_steps
|
||||||
[
|
[
|
||||||
git(:remote, "set-url", :origin, Kamal::Git.root, path: build_directory),
|
git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory),
|
||||||
git(:fetch, :origin, path: build_directory),
|
git(:fetch, :origin, path: escaped_build_directory),
|
||||||
git(:reset, "--hard", Kamal::Git.revision, path: build_directory),
|
git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory),
|
||||||
git(:clean, "-fdx", path: build_directory),
|
git(:clean, "-fdx", path: escaped_build_directory),
|
||||||
git(:submodule, :update, "--init", path: build_directory)
|
git(:submodule, :update, "--init", path: escaped_build_directory)
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_status
|
def clone_status
|
||||||
git :status, "--porcelain", path: build_directory
|
git :status, "--porcelain", path: escaped_build_directory
|
||||||
end
|
end
|
||||||
|
|
||||||
def clone_revision
|
def clone_revision
|
||||||
git :"rev-parse", :HEAD, path: build_directory
|
git :"rev-parse", :HEAD, path: escaped_build_directory
|
||||||
|
end
|
||||||
|
|
||||||
|
def escaped_root
|
||||||
|
Kamal::Git.root.shellescape
|
||||||
|
end
|
||||||
|
|
||||||
|
def escaped_build_directory
|
||||||
|
config.builder.build_directory.shellescape
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -14,12 +14,15 @@ class Kamal::Configuration
|
|||||||
|
|
||||||
include Validation
|
include Validation
|
||||||
|
|
||||||
PROXY_MINIMUM_VERSION = "v0.6.0"
|
PROXY_MINIMUM_VERSION = "v0.8.2"
|
||||||
PROXY_HTTP_PORT = 80
|
PROXY_HTTP_PORT = 80
|
||||||
PROXY_HTTPS_PORT = 443
|
PROXY_HTTPS_PORT = 443
|
||||||
|
PROXY_LOG_MAX_SIZE = "10m"
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
def create_from(config_file:, destination: nil, version: nil)
|
def create_from(config_file:, destination: nil, version: nil)
|
||||||
|
ENV["KAMAL_DESTINATION"] = destination
|
||||||
|
|
||||||
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
|
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
|
||||||
|
|
||||||
new raw_config, destination: destination, version: version
|
new raw_config, destination: destination, version: version
|
||||||
@@ -250,8 +253,12 @@ class Kamal::Configuration
|
|||||||
argumentize "--publish", [ "#{http_port}:#{PROXY_HTTP_PORT}", "#{https_port}:#{PROXY_HTTPS_PORT}" ]
|
argumentize "--publish", [ "#{http_port}:#{PROXY_HTTP_PORT}", "#{https_port}:#{PROXY_HTTPS_PORT}" ]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def proxy_logging_args(max_size)
|
||||||
|
argumentize "--log-opt", "max-size=#{max_size}" if max_size.present?
|
||||||
|
end
|
||||||
|
|
||||||
def proxy_options_default
|
def proxy_options_default
|
||||||
proxy_publish_args PROXY_HTTP_PORT, PROXY_HTTPS_PORT
|
[ *proxy_publish_args(PROXY_HTTP_PORT, PROXY_HTTPS_PORT), *proxy_logging_args(PROXY_LOG_MAX_SIZE) ]
|
||||||
end
|
end
|
||||||
|
|
||||||
def proxy_image
|
def proxy_image
|
||||||
@@ -360,7 +367,7 @@ class Kamal::Configuration
|
|||||||
end
|
end
|
||||||
|
|
||||||
def ensure_unique_hosts_for_ssl_roles
|
def ensure_unique_hosts_for_ssl_roles
|
||||||
hosts = roles.select(&:ssl?).map { |role| role.proxy.host }
|
hosts = roles.select(&:ssl?).flat_map { |role| role.proxy.hosts }
|
||||||
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
|
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
|
||||||
|
|
||||||
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
class Kamal::Configuration::Accessory
|
class Kamal::Configuration::Accessory
|
||||||
include Kamal::Configuration::Validation
|
include Kamal::Configuration::Validation
|
||||||
|
|
||||||
|
DEFAULT_NETWORK = "kamal"
|
||||||
|
|
||||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||||
|
|
||||||
attr_reader :name, :accessory_config, :env
|
attr_reader :name, :accessory_config, :env
|
||||||
@@ -38,6 +40,10 @@ class Kamal::Configuration::Accessory
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def network_args
|
||||||
|
argumentize "--network", network
|
||||||
|
end
|
||||||
|
|
||||||
def publish_args
|
def publish_args
|
||||||
argumentize "--publish", port if port
|
argumentize "--publish", port if port
|
||||||
end
|
end
|
||||||
@@ -170,7 +176,13 @@ class Kamal::Configuration::Accessory
|
|||||||
|
|
||||||
def hosts_from_roles
|
def hosts_from_roles
|
||||||
if accessory_config.key?("roles")
|
if accessory_config.key?("roles")
|
||||||
accessory_config["roles"].flat_map { |role| config.role(role).hosts }
|
accessory_config["roles"].flat_map do |role|
|
||||||
|
config.role(role)&.hosts || raise(Kamal::ConfigurationError, "Unknown role in accessories config: '#{role}'")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def network
|
||||||
|
accessory_config["network"] || DEFAULT_NETWORK
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -111,6 +111,14 @@ class Kamal::Configuration::Builder
|
|||||||
builder_config["ssh"]
|
builder_config["ssh"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def provenance
|
||||||
|
builder_config["provenance"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def sbom
|
||||||
|
builder_config["sbom"]
|
||||||
|
end
|
||||||
|
|
||||||
def git_clone?
|
def git_clone?
|
||||||
Kamal::Git.used? && builder_config["context"].nil?
|
Kamal::Git.used? && builder_config["context"].nil?
|
||||||
end
|
end
|
||||||
@@ -166,7 +174,7 @@ class Kamal::Configuration::Builder
|
|||||||
end
|
end
|
||||||
|
|
||||||
def cache_to_config_for_registry
|
def cache_to_config_for_registry
|
||||||
[ "type=registry", builder_config["cache"]&.fetch("options", nil), "ref=#{cache_image_ref}" ].compact.join(",")
|
[ "type=registry", "ref=#{cache_image_ref}", builder_config["cache"]&.fetch("options", nil) ].compact.join(",")
|
||||||
end
|
end
|
||||||
|
|
||||||
def repo_basename
|
def repo_basename
|
||||||
|
|||||||
@@ -3,32 +3,32 @@
|
|||||||
# Accessories can be booted on a single host, a list of hosts, or on specific roles.
|
# Accessories can be booted on a single host, a list of hosts, or on specific roles.
|
||||||
# The hosts do not need to be defined in the Kamal servers configuration.
|
# The hosts do not need to be defined in the Kamal servers configuration.
|
||||||
#
|
#
|
||||||
# Accessories are managed separately from the main service - they are not updated
|
# Accessories are managed separately from the main service — they are not updated
|
||||||
# when you deploy and they do not have zero-downtime deployments.
|
# when you deploy, and they do not have zero-downtime deployments.
|
||||||
#
|
#
|
||||||
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
||||||
# See `kamal accessory --help` for more information.
|
# See `kamal accessory --help` for more information.
|
||||||
|
|
||||||
# Configuring accessories
|
# Configuring accessories
|
||||||
#
|
#
|
||||||
# First define the accessory in the `accessories`
|
# First, define the accessory in the `accessories`:
|
||||||
accessories:
|
accessories:
|
||||||
mysql:
|
mysql:
|
||||||
|
|
||||||
# Service name
|
# Service name
|
||||||
#
|
#
|
||||||
# This is used in the service label and defaults to `<service>-<accessory>`
|
# This is used in the service label and defaults to `<service>-<accessory>`,
|
||||||
# where `<service>` is the main service name from the root configuration
|
# where `<service>` is the main service name from the root configuration:
|
||||||
service: mysql
|
service: mysql
|
||||||
|
|
||||||
# Image
|
# Image
|
||||||
#
|
#
|
||||||
# The Docker image to use, prefix with a registry if not using Docker hub
|
# The Docker image to use, prefix it with a registry if not using Docker Hub:
|
||||||
image: mysql:8.0
|
image: mysql:8.0
|
||||||
|
|
||||||
# Accessory hosts
|
# Accessory hosts
|
||||||
#
|
#
|
||||||
# Specify one of `host`, `hosts` or `roles`
|
# Specify one of `host`, `hosts`, or `roles`:
|
||||||
host: mysql-db1
|
host: mysql-db1
|
||||||
hosts:
|
hosts:
|
||||||
- mysql-db1
|
- mysql-db1
|
||||||
@@ -38,12 +38,12 @@ accessories:
|
|||||||
|
|
||||||
# Custom command
|
# Custom command
|
||||||
#
|
#
|
||||||
# You can set a custom command to run in the container, if you do not want to use the default
|
# You can set a custom command to run in the container if you do not want to use the default:
|
||||||
cmd: "bin/mysqld"
|
cmd: "bin/mysqld"
|
||||||
|
|
||||||
# Port mappings
|
# Port mappings
|
||||||
#
|
#
|
||||||
# See https://docs.docker.com/network/, especially note the warning about the security
|
# See https://docs.docker.com/network/, and especially note the warning about the security
|
||||||
# implications of exposing ports publicly.
|
# implications of exposing ports publicly.
|
||||||
port: "127.0.0.1:3306:3306"
|
port: "127.0.0.1:3306:3306"
|
||||||
|
|
||||||
@@ -52,20 +52,22 @@ accessories:
|
|||||||
app: myapp
|
app: myapp
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
# These are passed to the Docker run command in the form `--<name> <value>`
|
#
|
||||||
|
# These are passed to the Docker run command in the form `--<name> <value>`:
|
||||||
options:
|
options:
|
||||||
restart: always
|
restart: always
|
||||||
cpus: 2
|
cpus: 2
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
# See kamal docs env for more information
|
#
|
||||||
|
# See kamal docs env for more information:
|
||||||
env:
|
env:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Copying files
|
# Copying files
|
||||||
#
|
#
|
||||||
# You can specify files to mount into the container.
|
# You can specify files to mount into the container.
|
||||||
# The format is `local:remote` where `local` is the path to the file on the local machine
|
# The format is `local:remote`, where `local` is the path to the file on the local machine
|
||||||
# and `remote` is the path to the file in the container.
|
# and `remote` is the path to the file in the container.
|
||||||
#
|
#
|
||||||
# They will be uploaded from the local repo to the host and then mounted.
|
# They will be uploaded from the local repo to the host and then mounted.
|
||||||
@@ -78,13 +80,21 @@ accessories:
|
|||||||
# Directories
|
# Directories
|
||||||
#
|
#
|
||||||
# You can specify directories to mount into the container. They will be created on the host
|
# You can specify directories to mount into the container. They will be created on the host
|
||||||
# before being mounted
|
# before being mounted:
|
||||||
directories:
|
directories:
|
||||||
- mysql-logs:/var/log/mysql
|
- mysql-logs:/var/log/mysql
|
||||||
|
|
||||||
# Volumes
|
# Volumes
|
||||||
#
|
#
|
||||||
# Any other volumes to mount, in addition to the files and directories.
|
# Any other volumes to mount, in addition to the files and directories.
|
||||||
# They are not created or copied before mounting
|
# They are not created or copied before mounting:
|
||||||
volumes:
|
volumes:
|
||||||
- /path/to/mysql-logs:/var/log/mysql
|
- /path/to/mysql-logs:/var/log/mysql
|
||||||
|
|
||||||
|
# Network
|
||||||
|
#
|
||||||
|
# The network the accessory will be attached to.
|
||||||
|
#
|
||||||
|
# Defaults to kamal:
|
||||||
|
network: custom
|
||||||
|
|
||||||
|
|||||||
@@ -12,15 +12,15 @@
|
|||||||
aliases:
|
aliases:
|
||||||
console: app exec -r console -i "rails console"
|
console: app exec -r console -i "rails console"
|
||||||
# You can now open the console with:
|
# You can now open the console with:
|
||||||
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# kamal console
|
# kamal console
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
# Configuring aliases
|
# Configuring aliases
|
||||||
#
|
#
|
||||||
# Aliases are defined in the root config under the alias key
|
# Aliases are defined in the root config under the alias key.
|
||||||
#
|
#
|
||||||
# Each alias is named and can only contain lowercase letters, numbers, dashes and underscores.
|
# Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores:
|
||||||
|
|
||||||
aliases:
|
aliases:
|
||||||
uname: app exec -p -q -r web "uname -a"
|
uname: app exec -p -q -r web "uname -a"
|
||||||
|
|||||||
@@ -2,18 +2,18 @@
|
|||||||
#
|
#
|
||||||
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
||||||
#
|
#
|
||||||
# Kamal’s default is to boot new containers on all hosts in parallel. But you can control this with the boot configuration.
|
# Kamal’s default is to boot new containers on all hosts in parallel. However, you can control this with the boot configuration.
|
||||||
|
|
||||||
# Fixed group sizes
|
# Fixed group sizes
|
||||||
#
|
#
|
||||||
# Here we boot 2 hosts at a time with a 10 second gap between each group.
|
# Here, we boot 2 hosts at a time with a 10-second gap between each group:
|
||||||
boot:
|
boot:
|
||||||
limit: 2
|
limit: 2
|
||||||
wait: 10
|
wait: 10
|
||||||
|
|
||||||
# Percentage of hosts
|
# Percentage of hosts
|
||||||
#
|
#
|
||||||
# Here we boot 25% of the hosts at a time with a 2 second gap between each group.
|
# Here, we boot 25% of the hosts at a time with a 2-second gap between each group:
|
||||||
boot:
|
boot:
|
||||||
limit: 25%
|
limit: 25%
|
||||||
wait: 2
|
wait: 2
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
# Builder
|
# Builder
|
||||||
#
|
#
|
||||||
# The builder configuration controls how the application is built with `docker build`
|
# The builder configuration controls how the application is built with `docker build`.
|
||||||
#
|
#
|
||||||
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information
|
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information.
|
||||||
|
|
||||||
# Builder options
|
# Builder options
|
||||||
#
|
#
|
||||||
@@ -11,15 +11,15 @@ builder:
|
|||||||
|
|
||||||
# Arch
|
# Arch
|
||||||
#
|
#
|
||||||
# The architectures to build for - you can set an array or just a single value.
|
# The architectures to build for — you can set an array or just a single value.
|
||||||
#
|
#
|
||||||
# Allowed values are `amd64` and `arm64`
|
# Allowed values are `amd64` and `arm64`:
|
||||||
arch:
|
arch:
|
||||||
- amd64
|
- amd64
|
||||||
|
|
||||||
# Remote
|
# Remote
|
||||||
#
|
#
|
||||||
# The connection string for a remote builder. If supplied Kamal will use this
|
# The connection string for a remote builder. If supplied, Kamal will use this
|
||||||
# for builds that do not match the local architecture of the deployment host.
|
# for builds that do not match the local architecture of the deployment host.
|
||||||
remote: ssh://docker@docker-builder
|
remote: ssh://docker@docker-builder
|
||||||
|
|
||||||
@@ -28,14 +28,14 @@ builder:
|
|||||||
# If set to false, Kamal will always use the remote builder even when building
|
# If set to false, Kamal will always use the remote builder even when building
|
||||||
# the local architecture.
|
# the local architecture.
|
||||||
#
|
#
|
||||||
# Defaults to true
|
# Defaults to true:
|
||||||
local: true
|
local: true
|
||||||
|
|
||||||
# Builder cache
|
# Builder cache
|
||||||
#
|
#
|
||||||
# The type must be either 'gha' or 'registry'
|
# The type must be either 'gha' or 'registry'.
|
||||||
#
|
#
|
||||||
# The image is only used for registry cache. Not compatible with the docker driver
|
# The image is only used for registry cache and is not compatible with the Docker driver:
|
||||||
cache:
|
cache:
|
||||||
type: registry
|
type: registry
|
||||||
options: mode=max
|
options: mode=max
|
||||||
@@ -43,25 +43,25 @@ builder:
|
|||||||
|
|
||||||
# Build context
|
# Build context
|
||||||
#
|
#
|
||||||
# If this is not set, then a local git clone of the repo is used.
|
# If this is not set, then a local Git clone of the repo is used.
|
||||||
# This ensures a clean build with no uncommitted changes.
|
# This ensures a clean build with no uncommitted changes.
|
||||||
#
|
#
|
||||||
# To use the local checkout instead you can set the context to `.`, or a path to another directory.
|
# To use the local checkout instead, you can set the context to `.`, or a path to another directory.
|
||||||
context: .
|
context: .
|
||||||
|
|
||||||
# Dockerfile
|
# Dockerfile
|
||||||
#
|
#
|
||||||
# The Dockerfile to use for building, defaults to `Dockerfile`
|
# The Dockerfile to use for building, defaults to `Dockerfile`:
|
||||||
dockerfile: Dockerfile.production
|
dockerfile: Dockerfile.production
|
||||||
|
|
||||||
# Build target
|
# Build target
|
||||||
#
|
#
|
||||||
# If not set, then the default target is used
|
# If not set, then the default target is used:
|
||||||
target: production
|
target: production
|
||||||
|
|
||||||
# Build Arguments
|
# Build arguments
|
||||||
#
|
#
|
||||||
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`
|
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`:
|
||||||
args:
|
args:
|
||||||
ENVIRONMENT: production
|
ENVIRONMENT: production
|
||||||
|
|
||||||
@@ -74,33 +74,43 @@ builder:
|
|||||||
|
|
||||||
# Build secrets
|
# Build secrets
|
||||||
#
|
#
|
||||||
# Values are read from .kamal/secrets.
|
# Values are read from `.kamal/secrets`:
|
||||||
#
|
|
||||||
secrets:
|
secrets:
|
||||||
- SECRET1
|
- SECRET1
|
||||||
- SECRET2
|
- SECRET2
|
||||||
|
|
||||||
# Referencing Build Secrets
|
# Referencing build secrets
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# # Copy Gemfiles
|
# # Copy Gemfiles
|
||||||
# COPY Gemfile Gemfile.lock ./
|
# COPY Gemfile Gemfile.lock ./
|
||||||
#
|
#
|
||||||
# # Install dependencies, including private repositories via access token
|
# # Install dependencies, including private repositories via access token
|
||||||
# # Then remove bundle cache with exposed GITHUB_TOKEN)
|
# # Then remove bundle cache with exposed GITHUB_TOKEN
|
||||||
# RUN --mount=type=secret,id=GITHUB_TOKEN \
|
# RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||||
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||||
# bundle install && \
|
# bundle install && \
|
||||||
# rm -rf /usr/local/bundle/cache
|
# rm -rf /usr/local/bundle/cache
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
|
|
||||||
# SSH
|
# SSH
|
||||||
#
|
#
|
||||||
# SSH agent socket or keys to expose to the build
|
# SSH agent socket or keys to expose to the build:
|
||||||
ssh: default=$SSH_AUTH_SOCK
|
ssh: default=$SSH_AUTH_SOCK
|
||||||
|
|
||||||
# Driver
|
# Driver
|
||||||
#
|
#
|
||||||
# The build driver to use, defaults to `docker-container`
|
# The build driver to use, defaults to `docker-container`:
|
||||||
driver: docker
|
driver: docker
|
||||||
|
|
||||||
|
# Provenance
|
||||||
|
#
|
||||||
|
# It is used to configure provenance attestations for the build result.
|
||||||
|
# The value can also be a boolean to enable or disable provenance attestations.
|
||||||
|
provenance: mode=max
|
||||||
|
|
||||||
|
# SBOM (Software Bill of Materials)
|
||||||
|
#
|
||||||
|
# It is used to configure SBOM generation for the build result.
|
||||||
|
# The value can also be a boolean to enable or disable SBOM generation.
|
||||||
|
sbom: true
|
||||||
|
|||||||
@@ -1,14 +1,13 @@
|
|||||||
# Kamal Configuration
|
# Kamal Configuration
|
||||||
#
|
#
|
||||||
# Configuration is read from the `config/deploy.yml`
|
# Configuration is read from the `config/deploy.yml`.
|
||||||
#
|
|
||||||
|
|
||||||
# Destinations
|
# Destinations
|
||||||
#
|
#
|
||||||
# When running commands, you can specify a destination with the `-d` flag,
|
# When running commands, you can specify a destination with the `-d` flag,
|
||||||
# e.g. `kamal deploy -d staging`
|
# e.g., `kamal deploy -d staging`.
|
||||||
#
|
#
|
||||||
# In this case the configuration will also be read from `config/deploy.staging.yml`
|
# In this case, the configuration will also be read from `config/deploy.staging.yml`
|
||||||
# and merged with the base configuration.
|
# and merged with the base configuration.
|
||||||
|
|
||||||
# Extensions
|
# Extensions
|
||||||
@@ -18,10 +17,11 @@
|
|||||||
# However, you might want to declare a configuration block using YAML anchors
|
# However, you might want to declare a configuration block using YAML anchors
|
||||||
# and aliases to avoid repetition.
|
# and aliases to avoid repetition.
|
||||||
#
|
#
|
||||||
# You can use prefix a configuration section with `x-` to indicate that it is an
|
# You can prefix a configuration section with `x-` to indicate that it is an
|
||||||
# extension. Kamal will ignore the extension and not raise an error.
|
# extension. Kamal will ignore the extension and not raise an error.
|
||||||
|
|
||||||
# The service name
|
# The service name
|
||||||
|
#
|
||||||
# This is a required value. It is used as the container name prefix.
|
# This is a required value. It is used as the container name prefix.
|
||||||
service: myapp
|
service: myapp
|
||||||
|
|
||||||
@@ -32,147 +32,147 @@ image: my-image
|
|||||||
|
|
||||||
# Labels
|
# Labels
|
||||||
#
|
#
|
||||||
# Additional labels to add to the container
|
# Additional labels to add to the container:
|
||||||
labels:
|
labels:
|
||||||
my-label: my-value
|
my-label: my-value
|
||||||
|
|
||||||
# Volumes
|
# Volumes
|
||||||
#
|
#
|
||||||
# Additional volumes to mount into the container
|
# Additional volumes to mount into the container:
|
||||||
volumes:
|
volumes:
|
||||||
- /path/on/host:/path/in/container:ro
|
- /path/on/host:/path/in/container:ro
|
||||||
|
|
||||||
# Registry
|
# Registry
|
||||||
#
|
#
|
||||||
# The Docker registry configuration, see kamal docs registry
|
# The Docker registry configuration, see kamal docs registry:
|
||||||
registry:
|
registry:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Servers
|
# Servers
|
||||||
#
|
#
|
||||||
# The servers to deploy to, optionally with custom roles, see kamal docs servers
|
# The servers to deploy to, optionally with custom roles, see kamal docs servers:
|
||||||
servers:
|
servers:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
#
|
#
|
||||||
# See kamal docs env
|
# See kamal docs env:
|
||||||
env:
|
env:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Asset Path
|
# Asset path
|
||||||
#
|
#
|
||||||
# Used for asset bridging across deployments, default to `nil`
|
# Used for asset bridging across deployments, default to `nil`.
|
||||||
#
|
#
|
||||||
# If there are changes to CSS or JS files, we may get requests
|
# If there are changes to CSS or JS files, we may get requests
|
||||||
# for the old versions on the new container and vice-versa.
|
# for the old versions on the new container, and vice versa.
|
||||||
#
|
#
|
||||||
# To avoid 404s we can specify an asset path.
|
# To avoid 404s, we can specify an asset path.
|
||||||
# Kamal will replace that path in the container with a mapped
|
# Kamal will replace that path in the container with a mapped
|
||||||
# volume containing both sets of files.
|
# volume containing both sets of files.
|
||||||
# This requires that file names change when the contents change
|
# This requires that file names change when the contents change
|
||||||
# (e.g. by including a hash of the contents in the name).
|
# (e.g., by including a hash of the contents in the name).
|
||||||
#
|
#
|
||||||
# To configure this, set the path to the assets:
|
# To configure this, set the path to the assets:
|
||||||
asset_path: /path/to/assets
|
asset_path: /path/to/assets
|
||||||
|
|
||||||
# Hooks path
|
# Hooks path
|
||||||
#
|
#
|
||||||
# Path to hooks, defaults to `.kamal/hooks`
|
# Path to hooks, defaults to `.kamal/hooks`.
|
||||||
# See https://kamal-deploy.org/docs/hooks for more information
|
# See https://kamal-deploy.org/docs/hooks for more information:
|
||||||
hooks_path: /user_home/kamal/hooks
|
hooks_path: /user_home/kamal/hooks
|
||||||
|
|
||||||
# Require destinations
|
# Require destinations
|
||||||
#
|
#
|
||||||
# Whether deployments require a destination to be specified, defaults to `false`
|
# Whether deployments require a destination to be specified, defaults to `false`:
|
||||||
require_destination: true
|
require_destination: true
|
||||||
|
|
||||||
# Primary role
|
# Primary role
|
||||||
#
|
#
|
||||||
# This defaults to `web`, but if you have no web role, you can change this
|
# This defaults to `web`, but if you have no web role, you can change this:
|
||||||
primary_role: workers
|
primary_role: workers
|
||||||
|
|
||||||
# Allowing empty roles
|
# Allowing empty roles
|
||||||
#
|
#
|
||||||
# Whether roles with no servers are allowed. Defaults to `false`.
|
# Whether roles with no servers are allowed. Defaults to `false`:
|
||||||
allow_empty_roles: false
|
allow_empty_roles: false
|
||||||
|
|
||||||
# Retain containers
|
# Retain containers
|
||||||
#
|
#
|
||||||
# How many old containers and images we retain, defaults to 5
|
# How many old containers and images we retain, defaults to 5:
|
||||||
retain_containers: 3
|
retain_containers: 3
|
||||||
|
|
||||||
# Minimum version
|
# Minimum version
|
||||||
#
|
#
|
||||||
# The minimum version of Kamal required to deploy this configuration, defaults to nil
|
# The minimum version of Kamal required to deploy this configuration, defaults to `nil`:
|
||||||
minimum_version: 1.3.0
|
minimum_version: 1.3.0
|
||||||
|
|
||||||
# Readiness delay
|
# Readiness delay
|
||||||
#
|
#
|
||||||
# Seconds to wait for a container to boot after is running, default 7
|
# Seconds to wait for a container to boot after it is running, default 7.
|
||||||
#
|
#
|
||||||
# This only applies to containers that do not run a proxy or specify a healthcheck
|
# This only applies to containers that do not run a proxy or specify a healthcheck:
|
||||||
readiness_delay: 4
|
readiness_delay: 4
|
||||||
|
|
||||||
# Deploy timeout
|
# Deploy timeout
|
||||||
#
|
#
|
||||||
# How long to wait for a container to become ready, default 30
|
# How long to wait for a container to become ready, default 30:
|
||||||
deploy_timeout: 10
|
deploy_timeout: 10
|
||||||
|
|
||||||
# Drain timeout
|
# Drain timeout
|
||||||
#
|
#
|
||||||
# How long to wait for a containers to drain, default 30
|
# How long to wait for a container to drain, default 30:
|
||||||
drain_timeout: 10
|
drain_timeout: 10
|
||||||
|
|
||||||
# Run directory
|
# Run directory
|
||||||
#
|
#
|
||||||
# Directory to store kamal runtime files in on the host, default `.kamal`
|
# Directory to store kamal runtime files in on the host, default `.kamal`:
|
||||||
run_directory: /etc/kamal
|
run_directory: /etc/kamal
|
||||||
|
|
||||||
# SSH options
|
# SSH options
|
||||||
#
|
#
|
||||||
# See kamal docs ssh
|
# See kamal docs ssh:
|
||||||
ssh:
|
ssh:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Builder options
|
# Builder options
|
||||||
#
|
#
|
||||||
# See kamal docs builder
|
# See kamal docs builder:
|
||||||
builder:
|
builder:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Accessories
|
# Accessories
|
||||||
#
|
#
|
||||||
# Additionals services to run in Docker, see kamal docs accessory
|
# Additional services to run in Docker, see kamal docs accessory:
|
||||||
accessories:
|
accessories:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Proxy
|
# Proxy
|
||||||
#
|
#
|
||||||
# Configuration for kamal-proxy, see kamal docs proxy
|
# Configuration for kamal-proxy, see kamal docs proxy:
|
||||||
proxy:
|
proxy:
|
||||||
...
|
...
|
||||||
|
|
||||||
# SSHKit
|
# SSHKit
|
||||||
#
|
#
|
||||||
# See kamal docs sshkit
|
# See kamal docs sshkit:
|
||||||
sshkit:
|
sshkit:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Boot options
|
# Boot options
|
||||||
#
|
#
|
||||||
# See kamal docs boot
|
# See kamal docs boot:
|
||||||
boot:
|
boot:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
#
|
#
|
||||||
# Docker logging configuration, see kamal docs logging
|
# Docker logging configuration, see kamal docs logging:
|
||||||
logging:
|
logging:
|
||||||
...
|
...
|
||||||
|
|
||||||
# Aliases
|
# Aliases
|
||||||
#
|
#
|
||||||
# Alias configuration, see kamal docs alias
|
# Alias configuration, see kamal docs alias:
|
||||||
aliases:
|
aliases:
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# Environment variables
|
# Environment variables
|
||||||
#
|
#
|
||||||
# Environment variables can be set directly in the Kamal configuration or
|
# Environment variables can be set directly in the Kamal configuration or
|
||||||
# read from .kamal/secrets.
|
# read from `.kamal/secrets`.
|
||||||
|
|
||||||
# Reading environment variables from the configuration
|
# Reading environment variables from the configuration
|
||||||
#
|
#
|
||||||
# Environment variables can be set directly in the configuration file.
|
# Environment variables can be set directly in the configuration file.
|
||||||
#
|
#
|
||||||
# These are passed to the docker run command when deploying.
|
# These are passed to the `docker run` command when deploying.
|
||||||
env:
|
env:
|
||||||
DATABASE_HOST: mysql-db1
|
DATABASE_HOST: mysql-db1
|
||||||
DATABASE_PORT: 3306
|
DATABASE_PORT: 3306
|
||||||
@@ -16,7 +16,7 @@ env:
|
|||||||
#
|
#
|
||||||
# Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file.
|
# Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file.
|
||||||
#
|
#
|
||||||
# If you are using destinations, secrets will instead be read from `.kamal/secrets-<DESTINATION>` if
|
# If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if
|
||||||
# it exists.
|
# it exists.
|
||||||
#
|
#
|
||||||
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
||||||
@@ -24,26 +24,27 @@ env:
|
|||||||
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
|
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
|
||||||
# You can use variable or command substitution in the secrets file.
|
# You can use variable or command substitution in the secrets file.
|
||||||
#
|
#
|
||||||
# ```
|
# ```shell
|
||||||
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||||
# RAILS_MASTER_KEY=$(cat config/master.key)
|
# RAILS_MASTER_KEY=$(cat config/master.key)
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# You can also use [secret helpers](../commands/secrets) for some common password managers.
|
# You can also use [secret helpers](../../commands/secrets) for some common password managers.
|
||||||
# ```
|
#
|
||||||
|
# ```shell
|
||||||
# SECRETS=$(kamal secrets fetch ...)
|
# SECRETS=$(kamal secrets fetch ...)
|
||||||
#
|
#
|
||||||
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
|
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
|
||||||
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
|
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
|
||||||
# ```
|
# ```
|
||||||
#
|
#
|
||||||
# If you store secrets directly in .kamal/secrets, ensure that it is not checked into version control.
|
# If you store secrets directly in `.kamal/secrets`, ensure that it is not checked into version control.
|
||||||
#
|
#
|
||||||
# To pass the secrets you should list them under the `secret` key. When you do this the
|
# To pass the secrets, you should list them under the `secret` key. When you do this, the
|
||||||
# other variables need to be moved under the `clear` key.
|
# other variables need to be moved under the `clear` key.
|
||||||
#
|
#
|
||||||
# Unlike clear values, secrets are not passed directly to the container,
|
# Unlike clear values, secrets are not passed directly to the container
|
||||||
# but are stored in an env file on the host
|
# but are stored in an env file on the host:
|
||||||
env:
|
env:
|
||||||
clear:
|
clear:
|
||||||
DB_USER: app
|
DB_USER: app
|
||||||
@@ -55,7 +56,7 @@ env:
|
|||||||
# Tags are used to add extra env variables to specific hosts.
|
# Tags are used to add extra env variables to specific hosts.
|
||||||
# See kamal docs servers for how to tag hosts.
|
# See kamal docs servers for how to tag hosts.
|
||||||
#
|
#
|
||||||
# Tags are only allowed in the top level env configuration (i.e not under a role specific env).
|
# Tags are only allowed in the top-level env configuration (i.e., not under a role-specific env).
|
||||||
#
|
#
|
||||||
# The env variables can be specified with secret and clear values as explained above.
|
# The env variables can be specified with secret and clear values as explained above.
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -6,16 +6,16 @@
|
|||||||
#
|
#
|
||||||
# These go under the logging key in the configuration file.
|
# These go under the logging key in the configuration file.
|
||||||
#
|
#
|
||||||
# This can be specified in the root level or for a specific role.
|
# This can be specified at the root level or for a specific role.
|
||||||
logging:
|
logging:
|
||||||
|
|
||||||
# Driver
|
# Driver
|
||||||
#
|
#
|
||||||
# The logging driver to use, passed to Docker via `--log-driver`
|
# The logging driver to use, passed to Docker via `--log-driver`:
|
||||||
driver: json-file
|
driver: json-file
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
#
|
#
|
||||||
# Any logging options to pass to the driver, passed to Docker via `--log-opt`
|
# Any logging options to pass to the driver, passed to Docker via `--log-opt`:
|
||||||
options:
|
options:
|
||||||
max-size: 100m
|
max-size: 100m
|
||||||
|
|||||||
@@ -5,54 +5,59 @@
|
|||||||
# application container.
|
# application container.
|
||||||
#
|
#
|
||||||
# The proxy is configured in the root configuration under `proxy`. These are
|
# The proxy is configured in the root configuration under `proxy`. These are
|
||||||
# options that are set when deploying the application, not when booting the proxy
|
# options that are set when deploying the application, not when booting the proxy.
|
||||||
#
|
#
|
||||||
# They are application specific, so are not shared when multiple applications
|
# They are application-specific, so they are not shared when multiple applications
|
||||||
# run on the same proxy.
|
# run on the same proxy.
|
||||||
#
|
#
|
||||||
# The proxy is enabled by default on the primary role, but can be disabled by
|
# The proxy is enabled by default on the primary role but can be disabled by
|
||||||
# setting `proxy: false`.
|
# setting `proxy: false`.
|
||||||
#
|
#
|
||||||
# It is disabled by default on all other roles, but can be enabled by setting
|
# It is disabled by default on all other roles but can be enabled by setting
|
||||||
# `proxy: true`, or providing a proxy configuration.
|
# `proxy: true` or providing a proxy configuration.
|
||||||
proxy:
|
proxy:
|
||||||
|
|
||||||
# Host
|
# Hosts
|
||||||
#
|
#
|
||||||
# The hosts that will be used to serve the app. The proxy will only route requests
|
# The hosts that will be used to serve the app. The proxy will only route requests
|
||||||
# to this host to your app.
|
# to this host to your app.
|
||||||
#
|
#
|
||||||
# If no hosts are set, then all requests will be forwarded, except for matching
|
# If no hosts are set, then all requests will be forwarded, except for matching
|
||||||
# requests for other apps deployed on that server that do have a host set.
|
# requests for other apps deployed on that server that do have a host set.
|
||||||
|
#
|
||||||
|
# Specify one of `host` or `hosts`.
|
||||||
host: foo.example.com
|
host: foo.example.com
|
||||||
|
hosts:
|
||||||
|
- foo.example.com
|
||||||
|
- bar.example.com
|
||||||
|
|
||||||
# App port
|
# App port
|
||||||
#
|
#
|
||||||
# The port the application container is exposed on
|
# The port the application container is exposed on.
|
||||||
#
|
#
|
||||||
# Defaults to 80
|
# Defaults to 80:
|
||||||
app_port: 3000
|
app_port: 3000
|
||||||
|
|
||||||
# SSL
|
# SSL
|
||||||
#
|
#
|
||||||
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
|
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
|
||||||
#
|
#
|
||||||
# This requires that we are deploying to a one server and the host option is set.
|
# This requires that we are deploying to one server and the host option is set.
|
||||||
# The host value must point to the server we are deploying to and port 443 must be
|
# The host value must point to the server we are deploying to, and port 443 must be
|
||||||
# open for the Let's Encrypt challenge to succeed.
|
# open for the Let's Encrypt challenge to succeed.
|
||||||
#
|
#
|
||||||
# Defaults to false
|
# Defaults to `false`:
|
||||||
ssl: true
|
ssl: true
|
||||||
|
|
||||||
# Response timeout
|
# Response timeout
|
||||||
#
|
#
|
||||||
# How long to wait for requests to complete before timing out, defaults to 30 seconds
|
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
|
||||||
response_timeout: 10
|
response_timeout: 10
|
||||||
|
|
||||||
# Healthcheck
|
# Healthcheck
|
||||||
#
|
#
|
||||||
# When deploying, the proxy will by default hit /up once every second until we hit
|
# When deploying, the proxy will by default hit `/up` once every second until we hit
|
||||||
# the deploy timeout, with a 5 second timeout for each request.
|
# the deploy timeout, with a 5-second timeout for each request.
|
||||||
#
|
#
|
||||||
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
||||||
healthcheck:
|
healthcheck:
|
||||||
@@ -62,12 +67,12 @@ proxy:
|
|||||||
|
|
||||||
# Buffering
|
# Buffering
|
||||||
#
|
#
|
||||||
# Whether to buffer request and response bodies in the proxy
|
# Whether to buffer request and response bodies in the proxy.
|
||||||
#
|
#
|
||||||
# By default buffering is enabled with a max request body size of 1GB and no limit
|
# By default, buffering is enabled with a max request body size of 1GB and no limit
|
||||||
# for response size.
|
# for response size.
|
||||||
#
|
#
|
||||||
# You can also set the memory limit for buffering, which defaults to 1MB, anything
|
# You can also set the memory limit for buffering, which defaults to 1MB; anything
|
||||||
# larger than that is written to disk.
|
# larger than that is written to disk.
|
||||||
buffering:
|
buffering:
|
||||||
requests: true
|
requests: true
|
||||||
@@ -78,9 +83,9 @@ proxy:
|
|||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
#
|
#
|
||||||
# Configure request logging for the proxy
|
# Configure request logging for the proxy.
|
||||||
# You can specify request and response headers to log.
|
# You can specify request and response headers to log.
|
||||||
# By default, Cache-Control, Last-Modified and User-Agent request headers are logged
|
# By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged:
|
||||||
logging:
|
logging:
|
||||||
request_headers:
|
request_headers:
|
||||||
- Cache-Control
|
- Cache-Control
|
||||||
@@ -91,10 +96,10 @@ proxy:
|
|||||||
|
|
||||||
# Forward headers
|
# Forward headers
|
||||||
#
|
#
|
||||||
# Whether to forward the X-Forwarded-For and X-Forwarded-Proto 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.
|
# 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
|
# 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.
|
# will forward them if it is set to `false`.
|
||||||
forward_headers: true
|
forward_headers: true
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
# Registry
|
# Registry
|
||||||
#
|
#
|
||||||
# The default registry is Docker Hub, but you can change it using registry/server:
|
# The default registry is Docker Hub, but you can change it using `registry/server`.
|
||||||
#
|
#
|
||||||
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
|
# A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret
|
||||||
# in the local environment.
|
# in the local environment:
|
||||||
|
|
||||||
registry:
|
registry:
|
||||||
server: registry.digitalocean.com
|
server: registry.digitalocean.com
|
||||||
username:
|
username:
|
||||||
@@ -13,30 +12,31 @@ registry:
|
|||||||
- DOCKER_REGISTRY_TOKEN
|
- DOCKER_REGISTRY_TOKEN
|
||||||
|
|
||||||
# Using AWS ECR as the container registry
|
# Using AWS ECR as the container registry
|
||||||
# You will need to have the aws CLI installed locally for this to work.
|
#
|
||||||
# AWS ECR’s access token is only valid for 12hrs. In order to not have to manually regenerate the token every time, you can use ERB in the deploy.yml file to shell out to the aws cli command, and obtain the token:
|
# You will need to have the AWS CLI installed locally for this to work.
|
||||||
|
# AWS ECR’s access token is only valid for 12 hours. In order to avoid having to manually regenerate the token every time, you can use ERB in the `deploy.yml` file to shell out to the AWS CLI command and obtain the token:
|
||||||
registry:
|
registry:
|
||||||
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
||||||
username: AWS
|
username: AWS
|
||||||
password: <%= %x(aws ecr get-login-password) %>
|
password: <%= %x(aws ecr get-login-password) %>
|
||||||
|
|
||||||
# Using GCP Artifact Registry as the container registry
|
# Using GCP Artifact Registry as the container registry
|
||||||
# To sign into Artifact Registry, you would need to
|
#
|
||||||
|
# To sign into Artifact Registry, you need to
|
||||||
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
||||||
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
||||||
# Normally, assigning a roles/artifactregistry.writer role should be sufficient.
|
# Normally, assigning the `roles/artifactregistry.writer` role should be sufficient.
|
||||||
#
|
#
|
||||||
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
|
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# base64 -i /path/to/key.json | tr -d "\\n")
|
# base64 -i /path/to/key.json | tr -d "\\n"
|
||||||
# ```
|
# ```
|
||||||
# You'll then need to set the KAMAL_REGISTRY_PASSWORD secret to that value.
|
|
||||||
#
|
#
|
||||||
# Use the env variable as password along with _json_key_base64 as username.
|
# You'll then need to set the `KAMAL_REGISTRY_PASSWORD` secret to that value.
|
||||||
|
#
|
||||||
|
# Use the environment variable as the password along with `_json_key_base64` as the username.
|
||||||
# Here’s the final configuration:
|
# Here’s the final configuration:
|
||||||
|
|
||||||
registry:
|
registry:
|
||||||
server: <your registry region>-docker.pkg.dev
|
server: <your registry region>-docker.pkg.dev
|
||||||
username: _json_key_base64
|
username: _json_key_base64
|
||||||
@@ -46,6 +46,7 @@ registry:
|
|||||||
# Validating the configuration
|
# Validating the configuration
|
||||||
#
|
#
|
||||||
# You can validate the configuration by running:
|
# You can validate the configuration by running:
|
||||||
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# kamal registry login
|
# kamal registry login
|
||||||
# ```
|
# ```
|
||||||
|
|||||||
@@ -1,22 +1,21 @@
|
|||||||
# Roles
|
# Roles
|
||||||
#
|
#
|
||||||
# Roles are used to configure different types of servers in the deployment.
|
# Roles are used to configure different types of servers in the deployment.
|
||||||
# The most common use for this is to run a web servers and job servers.
|
# The most common use for this is to run web servers and job servers.
|
||||||
#
|
#
|
||||||
# Kamal expects there to be a `web` role, unless you set a different `primary_role`
|
# Kamal expects there to be a `web` role, unless you set a different `primary_role`
|
||||||
# in the root configuration.
|
# in the root configuration.
|
||||||
|
|
||||||
# Role configuration
|
# Role configuration
|
||||||
#
|
#
|
||||||
# Roles are specified under the servers key
|
# Roles are specified under the servers key:
|
||||||
servers:
|
servers:
|
||||||
|
|
||||||
# Simple role configuration
|
# Simple role configuration
|
||||||
#
|
#
|
||||||
|
# This can be a list of hosts if you don't need custom configuration for the role.
|
||||||
#
|
#
|
||||||
# This can be a list of hosts, if you don't need custom configuration for the role.
|
# You can set tags on the hosts for custom env variables (see kamal docs env):
|
||||||
#
|
|
||||||
# You can set tags on the hosts for custom env variables (see kamal docs env)
|
|
||||||
web:
|
web:
|
||||||
- 172.1.0.1
|
- 172.1.0.1
|
||||||
- 172.1.0.2: experiment1
|
- 172.1.0.2: experiment1
|
||||||
@@ -24,16 +23,16 @@ servers:
|
|||||||
|
|
||||||
# Custom role configuration
|
# Custom role configuration
|
||||||
#
|
#
|
||||||
# When there are other options to set, the list of hosts goes under the `hosts` key
|
# When there are other options to set, the list of hosts goes under the `hosts` key.
|
||||||
#
|
#
|
||||||
# By default only the primary role uses a proxy.
|
# By default, only the primary role uses a proxy.
|
||||||
#
|
#
|
||||||
# For other roles, you can set it to `proxy: true` enable it and inherit the root proxy
|
# For other roles, you can set it to `proxy: true` to enable it and inherit the root proxy
|
||||||
# configuration or provide a map of options to override the root configuration.
|
# configuration or provide a map of options to override the root configuration.
|
||||||
#
|
#
|
||||||
# For the primary role, you can set `proxy: false` to disable the proxy.
|
# For the primary role, you can set `proxy: false` to disable the proxy.
|
||||||
#
|
#
|
||||||
# You can also set a custom cmd to run in the container, and overwrite other settings
|
# You can also set a custom `cmd` to run in the container and overwrite other settings
|
||||||
# from the root configuration.
|
# from the root configuration.
|
||||||
workers:
|
workers:
|
||||||
hosts:
|
hosts:
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
#
|
#
|
||||||
# Servers are split into different roles, with each role having its own configuration.
|
# Servers are split into different roles, with each role having its own configuration.
|
||||||
#
|
#
|
||||||
# For simpler deployments though where all servers are identical, you can just specify a list of servers
|
# For simpler deployments, though, where all servers are identical, you can just specify a list of servers.
|
||||||
# They will be implicitly assigned to the `web` role.
|
# They will be implicitly assigned to the `web` role.
|
||||||
servers:
|
servers:
|
||||||
- 172.0.0.1
|
- 172.0.0.1
|
||||||
@@ -19,7 +19,7 @@ servers:
|
|||||||
|
|
||||||
# Roles
|
# Roles
|
||||||
#
|
#
|
||||||
# For more complex deployments (e.g. if you are running job hosts), you can specify roles, and configure each separately (see kamal docs role)
|
# For more complex deployments (e.g., if you are running job hosts), you can specify roles and configure each separately (see kamal docs role):
|
||||||
servers:
|
servers:
|
||||||
web:
|
web:
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# SSH configuration
|
# SSH configuration
|
||||||
#
|
#
|
||||||
# Kamal uses SSH to connect run commands on your hosts.
|
# Kamal uses SSH to connect and run commands on your hosts.
|
||||||
# By default it will attempt to connect to the root user on port 22
|
# By default, it will attempt to connect to the root user on port 22.
|
||||||
#
|
#
|
||||||
# If you are using non-root user, you may need to bootstrap your servers manually, before using them with Kamal. On Ubuntu, you’d do:
|
# If you are using a non-root user, you may need to bootstrap your servers manually before using them with Kamal. On Ubuntu, you’d do:
|
||||||
#
|
#
|
||||||
# ```shell
|
# ```shell
|
||||||
# sudo apt update
|
# sudo apt update
|
||||||
@@ -12,7 +12,6 @@
|
|||||||
# sudo usermod -a -G docker app
|
# sudo usermod -a -G docker app
|
||||||
# ```
|
# ```
|
||||||
|
|
||||||
|
|
||||||
# SSH options
|
# SSH options
|
||||||
#
|
#
|
||||||
# The options are specified under the ssh key in the configuration file.
|
# The options are specified under the ssh key in the configuration file.
|
||||||
@@ -20,47 +19,52 @@ ssh:
|
|||||||
|
|
||||||
# The SSH user
|
# The SSH user
|
||||||
#
|
#
|
||||||
# Defaults to `root`
|
# Defaults to `root`:
|
||||||
#
|
|
||||||
user: app
|
user: app
|
||||||
|
|
||||||
# The SSH port
|
# The SSH port
|
||||||
#
|
#
|
||||||
# Defaults to 22
|
# Defaults to 22:
|
||||||
port: "2222"
|
port: "2222"
|
||||||
|
|
||||||
# Proxy host
|
# Proxy host
|
||||||
#
|
#
|
||||||
# Specified in the form <host> or <user>@<host>
|
# Specified in the form <host> or <user>@<host>:
|
||||||
proxy: root@proxy-host
|
proxy: root@proxy-host
|
||||||
|
|
||||||
# Proxy command
|
# Proxy command
|
||||||
#
|
#
|
||||||
# A custom proxy command, required for older versions of SSH
|
# A custom proxy command, required for older versions of SSH:
|
||||||
proxy_command: "ssh -W %h:%p user@proxy"
|
proxy_command: "ssh -W %h:%p user@proxy"
|
||||||
|
|
||||||
# Log level
|
# Log level
|
||||||
#
|
#
|
||||||
# Defaults to `fatal`. Set this to debug if you are having
|
# Defaults to `fatal`. Set this to `debug` if you are having SSH connection issues.
|
||||||
# SSH connection issues.
|
|
||||||
log_level: debug
|
log_level: debug
|
||||||
|
|
||||||
# Keys Only
|
# Keys only
|
||||||
#
|
#
|
||||||
# Set to true to use only private keys from keys and key_data parameters,
|
# Set to `true` to use only private keys from the `keys` and `key_data` parameters,
|
||||||
# even if ssh-agent offers more identities. This option is intended for
|
# even if ssh-agent offers more identities. This option is intended for
|
||||||
# situations where ssh-agent offers many different identites or you have
|
# situations where ssh-agent offers many different identities or you
|
||||||
# a need to overwrite all identites and force a single one.
|
# need to overwrite all identities and force a single one.
|
||||||
keys_only: false
|
keys_only: false
|
||||||
|
|
||||||
# Keys
|
# Keys
|
||||||
#
|
#
|
||||||
# An array of file names of private keys to use for publickey
|
# An array of file names of private keys to use for public key
|
||||||
# and hostbased authentication
|
# and host-based authentication:
|
||||||
keys: [ "~/.ssh/id.pem" ]
|
keys: [ "~/.ssh/id.pem" ]
|
||||||
|
|
||||||
# Key Data
|
# Key data
|
||||||
#
|
#
|
||||||
# An array of strings, with each element of the array being
|
# An array of strings, with each element of the array being
|
||||||
# a raw private key in PEM format.
|
# a raw private key in PEM format.
|
||||||
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
|
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
|
||||||
|
|
||||||
|
# Config
|
||||||
|
#
|
||||||
|
# Set to true to load the default OpenSSH config files (~/.ssh/config,
|
||||||
|
# /etc/ssh_config), to false ignore config files, or to a file path
|
||||||
|
# (or array of paths) to load specific configuration. Defaults to true.
|
||||||
|
config: true
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
#
|
#
|
||||||
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
||||||
#
|
#
|
||||||
# The default settings should be sufficient for most use cases, but
|
# The default, settings should be sufficient for most use cases, but
|
||||||
# when connecting to a large number of hosts you may need to adjust
|
# when connecting to a large number of hosts, you may need to adjust.
|
||||||
|
|
||||||
# SSHKit options
|
# SSHKit options
|
||||||
#
|
#
|
||||||
@@ -13,11 +13,11 @@ sshkit:
|
|||||||
# Max concurrent starts
|
# Max concurrent starts
|
||||||
#
|
#
|
||||||
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
||||||
# By default Kamal will limit concurrent connection starts to 30 at a time.
|
# By default, Kamal will limit concurrent connection starts to 30 at a time.
|
||||||
max_concurrent_starts: 10
|
max_concurrent_starts: 10
|
||||||
|
|
||||||
# Pool idle timeout
|
# Pool idle timeout
|
||||||
#
|
#
|
||||||
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
||||||
# re-connection storms after an idle period, like building an image or waiting for CI.
|
# re-connection storms after an idle period, such as building an image or waiting for CI.
|
||||||
pool_idle_timeout: 300
|
pool_idle_timeout: 300
|
||||||
|
|||||||
@@ -22,14 +22,14 @@ class Kamal::Configuration::Proxy
|
|||||||
proxy_config.fetch("ssl", false)
|
proxy_config.fetch("ssl", false)
|
||||||
end
|
end
|
||||||
|
|
||||||
def host
|
def hosts
|
||||||
proxy_config["host"]
|
proxy_config["hosts"] || proxy_config["host"]&.split(",") || []
|
||||||
end
|
end
|
||||||
|
|
||||||
def deploy_options
|
def deploy_options
|
||||||
{
|
{
|
||||||
host: proxy_config["host"],
|
host: hosts,
|
||||||
tls: proxy_config["ssl"] ? true : nil,
|
tls: proxy_config["ssl"].presence,
|
||||||
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
||||||
"drain-timeout": seconds_duration(config.drain_timeout),
|
"drain-timeout": seconds_duration(config.drain_timeout),
|
||||||
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
||||||
@@ -48,11 +48,7 @@ class Kamal::Configuration::Proxy
|
|||||||
end
|
end
|
||||||
|
|
||||||
def deploy_command_args(target:)
|
def deploy_command_args(target:)
|
||||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options)
|
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "="
|
||||||
end
|
|
||||||
|
|
||||||
def remove_command_args(target:)
|
|
||||||
optionize({ target: "#{target}:#{app_port}" })
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def merge(other)
|
def merge(other)
|
||||||
|
|||||||
@@ -3,9 +3,13 @@ class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
|
|||||||
unless config.nil?
|
unless config.nil?
|
||||||
super
|
super
|
||||||
|
|
||||||
if config["host"].blank? && config["ssl"]
|
if config["host"].blank? && config["hosts"].blank? && config["ssl"]
|
||||||
error "Must set a host to enable automatic SSL"
|
error "Must set a host to enable automatic SSL"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if (config.keys & [ "host", "hosts" ]).size > 1
|
||||||
|
error "Specify one of 'host' or 'hosts', not both"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -37,6 +37,8 @@ class Kamal::EnvFile
|
|||||||
def escape_docker_env_file_ascii_value(value)
|
def escape_docker_env_file_ascii_value(value)
|
||||||
# Doublequotes are treated literally in docker env files
|
# Doublequotes are treated literally in docker env files
|
||||||
# so remove leading and trailing ones and unescape any others
|
# so remove leading and trailing ones and unescape any others
|
||||||
value.to_s.dump[1..-2].gsub(/\\"/, "\"")
|
value.to_s.dump[1..-2]
|
||||||
|
.gsub(/\\"/, "\"")
|
||||||
|
.gsub(/\\#/, "#")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,13 +1,10 @@
|
|||||||
require "dotenv"
|
require "dotenv"
|
||||||
|
|
||||||
class Kamal::Secrets
|
class Kamal::Secrets
|
||||||
attr_reader :secrets_files
|
|
||||||
|
|
||||||
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
||||||
|
|
||||||
def initialize(destination: nil)
|
def initialize(destination: nil)
|
||||||
@secrets_files = \
|
@destination = destination
|
||||||
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{destination}" if destination)}" ].select { |f| File.exist?(f) }
|
|
||||||
@mutex = Mutex.new
|
@mutex = Mutex.new
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -17,10 +14,10 @@ class Kamal::Secrets
|
|||||||
secrets.fetch(key)
|
secrets.fetch(key)
|
||||||
end
|
end
|
||||||
rescue KeyError
|
rescue KeyError
|
||||||
if secrets_files
|
if secrets_files.present?
|
||||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
||||||
else
|
else
|
||||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files provided"
|
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files (#{secrets_filenames.join(", ")}) provided"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -28,10 +25,18 @@ class Kamal::Secrets
|
|||||||
secrets
|
secrets
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def secrets_files
|
||||||
|
@secrets_files ||= secrets_filenames.select { |f| File.exist?(f) }
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def secrets
|
def secrets
|
||||||
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
||||||
secrets.merge!(::Dotenv.parse(secrets_file))
|
secrets.merge!(::Dotenv.parse(secrets_file))
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def secrets_filenames
|
||||||
|
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{@destination}" if @destination)}" ]
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
34
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
34
lib/kamal/secrets/adapters/aws_secrets_manager.rb
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
class Kamal::Secrets::Adapters::AwsSecretsManager < Kamal::Secrets::Adapters::Base
|
||||||
|
private
|
||||||
|
def login(_account)
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def fetch_secrets(secrets, account:, session:)
|
||||||
|
{}.tap do |results|
|
||||||
|
JSON.parse(get_from_secrets_manager(secrets, account: account))["SecretValues"].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
|
||||||
|
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
|
||||||
|
raise RuntimeError, "Could not read #{secret} from AWS Secrets Manager" unless $?.success?
|
||||||
|
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
|
class Kamal::Secrets::Adapters::Base
|
||||||
delegate :optionize, to: Kamal::Utils
|
delegate :optionize, to: Kamal::Utils
|
||||||
|
|
||||||
def fetch(secrets, account:, from: nil)
|
def fetch(secrets, account: nil, from: nil)
|
||||||
|
raise RuntimeError, "Missing required option '--account'" if requires_account? && account.blank?
|
||||||
|
|
||||||
|
check_dependencies!
|
||||||
|
|
||||||
session = login(account)
|
session = login(account)
|
||||||
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||||
fetch_secrets(full_secrets, account: account, session: session)
|
fetch_secrets(full_secrets, account: account, session: session)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def requires_account?
|
||||||
|
true
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def login(...)
|
def login(...)
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
@@ -15,4 +23,8 @@ class Kamal::Secrets::Adapters::Base
|
|||||||
def fetch_secrets(...)
|
def fetch_secrets(...)
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise NotImplementedError
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -25,23 +25,31 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
|||||||
{}.tap do |results|
|
{}.tap do |results|
|
||||||
items_fields(secrets).each do |item, fields|
|
items_fields(secrets).each do |item, fields|
|
||||||
item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
|
item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
|
||||||
raise RuntimeError, "Could not read #{secret} from Bitwarden" unless $?.success?
|
raise RuntimeError, "Could not read #{item} from Bitwarden" unless $?.success?
|
||||||
item_json = JSON.parse(item_json)
|
item_json = JSON.parse(item_json)
|
||||||
|
|
||||||
if fields.any?
|
if fields.any?
|
||||||
fields.each do |field|
|
results.merge! fetch_secrets_from_fields(fields, item, item_json)
|
||||||
item_field = item_json["fields"].find { |f| f["name"] == field }
|
elsif item_json.dig("login", "password")
|
||||||
raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field
|
results[item] = item_json.dig("login", "password")
|
||||||
value = item_field["value"]
|
elsif item_json["fields"]&.any?
|
||||||
results["#{item}/#{field}"] = value
|
fields = item_json["fields"].pluck("name")
|
||||||
end
|
results.merge! fetch_secrets_from_fields(fields, item, item_json)
|
||||||
else
|
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
|
||||||
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)
|
def items_fields(secrets)
|
||||||
{}.tap do |items|
|
{}.tap do |items|
|
||||||
secrets.each do |secret|
|
secrets.each do |secret|
|
||||||
@@ -61,4 +69,13 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
|||||||
result = `#{full_command}`.strip
|
result = `#{full_command}`.strip
|
||||||
raw ? result : JSON.parse(result)
|
raw ? result : JSON.parse(result)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "Bitwarden CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`bw --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
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
|
||||||
@@ -27,4 +27,13 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "LastPass CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`lpass --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -58,4 +58,13 @@ class Kamal::Secrets::Adapters::OnePassword < Kamal::Secrets::Adapters::Base
|
|||||||
raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success?
|
raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
raise RuntimeError, "1Password CLI is not installed" unless cli_installed?
|
||||||
|
end
|
||||||
|
|
||||||
|
def cli_installed?
|
||||||
|
`op --version 2> /dev/null`
|
||||||
|
$?.success?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -7,4 +7,8 @@ class Kamal::Secrets::Adapters::Test < Kamal::Secrets::Adapters::Base
|
|||||||
def fetch_secrets(secrets, account:, session:)
|
def fetch_secrets(secrets, account:, session:)
|
||||||
secrets.to_h { |secret| [ secret, secret.reverse ] }
|
secrets.to_h { |secret| [ secret, secret.reverse ] }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_dependencies!
|
||||||
|
# no op
|
||||||
|
end
|
||||||
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 = "#{key}=#{escape_shell_value(value)}"
|
||||||
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
|
||||||
[ argument, attr ]
|
[ argument, attr ]
|
||||||
|
elsif value == false
|
||||||
|
[ argument, "#{key}=false" ]
|
||||||
else
|
else
|
||||||
[ argument, key ]
|
[ argument, key ]
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
module Kamal
|
module Kamal
|
||||||
VERSION = "2.0.0"
|
VERSION = "2.3.0"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123") # old version
|
.returns("123") # old version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
@@ -63,7 +63,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123").twice # old version
|
.returns("123").twice # old version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
@@ -92,7 +92,7 @@ class CliAppTest < CliTestCase
|
|||||||
.returns("12345678") # running version
|
.returns("12345678") # running version
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("123") # old version
|
.returns("123") # old version
|
||||||
|
|
||||||
run_command("boot", config: :with_env_tags).tap do |output|
|
run_command("boot", config: :with_env_tags).tap do |output|
|
||||||
@@ -130,7 +130,7 @@ class CliAppTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false)
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false)
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||||
.with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target", "\"123:80\"", "--deploy-timeout", "\"1s\"", "--drain-timeout", "\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header", "\"Cache-Control\"", "--log-request-header", "\"Last-Modified\"", "--log-request-header", "\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy"))
|
.with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target=\"123:80\"", "--deploy-timeout=\"1s\"", "--drain-timeout=\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header=\"Cache-Control\"", "--log-request-header=\"Last-Modified\"", "--log-request-header=\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy"))
|
||||||
|
|
||||||
stderred do
|
stderred do
|
||||||
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
|
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
|
||||||
@@ -190,23 +190,23 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
run_command("start").tap do |output|
|
run_command("start").tap do |output|
|
||||||
assert_match "docker start app-web-999", output
|
assert_match "docker start app-web-999", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"999:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"999:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\"", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stop" do
|
test "stop" do
|
||||||
run_command("stop").tap do |output|
|
run_command("stop").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop", output
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stale_containers" do
|
test "stale_containers" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=destination=", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n87654321\n")
|
.returns("12345678\n87654321\n")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n")
|
.returns("12345678\n")
|
||||||
|
|
||||||
run_command("stale_containers").tap do |output|
|
run_command("stale_containers").tap do |output|
|
||||||
@@ -216,11 +216,11 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "stop stale_containers" do
|
test "stop stale_containers" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:docker, :ps, "--filter", "label=service=app", "--filter", "label=destination=", "--filter", "label=role=web", "--format", "\"{{.Names}}\"", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n87654321\n")
|
.returns("12345678\n87654321\n")
|
||||||
|
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("12345678\n")
|
.returns("12345678\n")
|
||||||
|
|
||||||
run_command("stale_containers", "--stop").tap do |output|
|
run_command("stale_containers", "--stop").tap do |output|
|
||||||
@@ -231,13 +231,13 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "details" do
|
test "details" do
|
||||||
run_command("details").tap do |output|
|
run_command("details").tap do |output|
|
||||||
assert_match "docker ps --filter label=service=app --filter label=role=web", output
|
assert_match "docker ps --filter label=service=app --filter label=destination= --filter label=role=web", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove" do
|
test "remove" do
|
||||||
run_command("remove").tap do |output|
|
run_command("remove").tap do |output|
|
||||||
assert_match /#{Regexp.escape("sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop")}/, output
|
assert_match /#{Regexp.escape("sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop")}/, output
|
||||||
assert_match /#{Regexp.escape("docker container prune --force --filter label=service=app")}/, output
|
assert_match /#{Regexp.escape("docker container prune --force --filter label=service=app")}/, output
|
||||||
assert_match /#{Regexp.escape("docker image prune --all --force --filter label=service=app")}/, output
|
assert_match /#{Regexp.escape("docker image prune --all --force --filter label=service=app")}/, output
|
||||||
end
|
end
|
||||||
@@ -275,7 +275,7 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "exec with reuse" do
|
test "exec with reuse" do
|
||||||
run_command("exec", "--reuse", "ruby -v").tap do |output|
|
run_command("exec", "--reuse", "ruby -v").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output # Get current version
|
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output # Get current version
|
||||||
assert_match "docker exec app-web-999 ruby -v", output
|
assert_match "docker exec app-web-999 ruby -v", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -294,7 +294,7 @@ class CliAppTest < CliTestCase
|
|||||||
.with("ssh -t root@1.1.1.1 -p 22 'docker exec -it app-web-999 ruby -v'")
|
.with("ssh -t root@1.1.1.1 -p 22 'docker exec -it app-web-999 ruby -v'")
|
||||||
run_command("exec", "-i", "--reuse", "ruby -v").tap do |output|
|
run_command("exec", "-i", "--reuse", "ruby -v").tap do |output|
|
||||||
assert_match "Get current version of running container...", output
|
assert_match "Get current version of running container...", output
|
||||||
assert_match "Running /usr/bin/env sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done on 1.1.1.1", output
|
assert_match "Running /usr/bin/env sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done on 1.1.1.1", output
|
||||||
assert_match "Launching interactive command with version 999 via SSH from existing container on 1.1.1.1...", output
|
assert_match "Launching interactive command with version 999 via SSH from existing container on 1.1.1.1...", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -313,46 +313,46 @@ class CliAppTest < CliTestCase
|
|||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 'sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1| xargs docker logs --timestamps --tail 10 2>&1'")
|
.with("ssh -t root@1.1.1.1 'sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1| xargs docker logs --timestamps --tail 10 2>&1'")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1", run_command("logs")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1", run_command("logs")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey'", run_command("logs", "--grep", "hey")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey'", run_command("logs", "--grep", "hey")
|
||||||
|
|
||||||
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey' -C 2", run_command("logs", "--grep", "hey", "--grep-options", "-C 2")
|
assert_match "sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'hey' -C 2", run_command("logs", "--grep", "hey", "--grep-options", "-C 2")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow" do
|
test "logs with follow" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1", run_command("logs", "--follow")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 10 --follow 2>&1", run_command("logs", "--follow")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow and grep" do
|
test "logs with follow and grep" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"", run_command("logs", "--follow", "--grep", "hey")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\"", run_command("logs", "--follow", "--grep", "hey")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with follow, grep and grep options" do
|
test "logs with follow, grep and grep options" do
|
||||||
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
SSHKit::Backend::Abstract.any_instance.stubs(:exec)
|
||||||
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2'")
|
.with("ssh -t root@1.1.1.1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2'")
|
||||||
|
|
||||||
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2", run_command("logs", "--follow", "--grep", "hey", "--grep-options", "-C 2")
|
assert_match "sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"hey\" -C 2", run_command("logs", "--follow", "--grep", "hey", "--grep-options", "-C 2")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "version" do
|
test "version" do
|
||||||
run_command("version").tap do |output|
|
run_command("version").tap do |output|
|
||||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
test "version through main" do
|
test "version through main" do
|
||||||
stdouted { Kamal::Cli::Main.start([ "app", "version", "-c", "test/fixtures/deploy_with_accessories.yml", "--hosts", "1.1.1.1" ]) }.tap do |output|
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -383,7 +383,7 @@ class CliAppTest < CliTestCase
|
|||||||
assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename
|
assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename
|
||||||
assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output
|
assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output
|
||||||
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output
|
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output
|
||||||
assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target "123:80"/, output
|
assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target="123:80"/, output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -392,8 +392,8 @@ class CliAppTest < CliTestCase
|
|||||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
|
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
|
||||||
|
|
||||||
run_command("boot", config: :with_proxy_roles, host: nil).tap do |output|
|
run_command("boot", config: :with_proxy_roles, host: nil).tap do |output|
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"10s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"10s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"15s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"15s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -250,7 +250,7 @@ class CliMainTest < CliTestCase
|
|||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-#{role}-123$", "--quiet")
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-#{role}-123$", "--quiet")
|
||||||
.returns("version-to-rollback\n").at_least_once
|
.returns("version-to-rollback\n").at_least_once
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=#{role} --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=#{role} --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-#{role}-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=#{role} --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=#{role} --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-#{role}-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("version-to-rollback\n").at_least_once
|
.returns("version-to-rollback\n").at_least_once
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -280,7 +280,7 @@ class CliMainTest < CliTestCase
|
|||||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
||||||
.returns("123").at_least_once
|
.returns("123").at_least_once
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
.with(:sh, "-c", "'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'", "|", :head, "-1", "|", "while read line; do echo ${line#app-web-}; done", raise_on_non_zero_exit: false)
|
||||||
.returns("").at_least_once
|
.returns("").at_least_once
|
||||||
|
|
||||||
run_command("rollback", "123").tap do |output|
|
run_command("rollback", "123").tap do |output|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ class CliProxyTest < CliTestCase
|
|||||||
test "boot" do
|
test "boot" do
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image}", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -18,11 +18,11 @@ class CliProxyTest < CliTestCase
|
|||||||
exception = assert_raises do
|
exception = assert_raises do
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image}", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
assert_includes exception.message, "kamal-proxy version v0.0.1 is too old, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
assert_includes exception.message, "kamal-proxy version v0.0.1 is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||||
ensure
|
ensure
|
||||||
Thread.report_on_exception = false
|
Thread.report_on_exception = false
|
||||||
end
|
end
|
||||||
@@ -36,7 +36,7 @@ class CliProxyTest < CliTestCase
|
|||||||
|
|
||||||
run_command("boot").tap do |output|
|
run_command("boot").tap do |output|
|
||||||
assert_match "docker login", output
|
assert_match "docker login", output
|
||||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image}", output
|
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output
|
||||||
end
|
end
|
||||||
ensure
|
ensure
|
||||||
Thread.report_on_exception = false
|
Thread.report_on_exception = false
|
||||||
@@ -57,14 +57,14 @@ class CliProxyTest < CliTestCase
|
|||||||
assert_match "docker container stop kamal-proxy on 1.1.1.1", output
|
assert_match "docker container stop kamal-proxy on 1.1.1.1", output
|
||||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
|
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
|
||||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image} on 1.1.1.1", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.1", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.1", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.1", output
|
||||||
|
|
||||||
assert_match "docker container stop kamal-proxy on 1.1.1.2", output
|
assert_match "docker container stop kamal-proxy on 1.1.1.2", output
|
||||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
|
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
|
||||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
|
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
|
||||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image} on 1.1.1.2", output
|
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.2", output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.2", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.2", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -198,13 +198,13 @@ class CliProxyTest < CliTestCase
|
|||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
assert_match "docker network create kamal", output
|
assert_match "docker network create kamal", output
|
||||||
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
||||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output
|
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
|
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
|
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
|
||||||
assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output
|
assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output
|
||||||
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
|
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
|
||||||
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"12345678:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"12345678:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
|
||||||
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
|
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
|
||||||
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
||||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||||
@@ -240,7 +240,7 @@ class CliProxyTest < CliTestCase
|
|||||||
run_command("boot_config", "set").tap do |output|
|
run_command("boot_config", "set").tap do |output|
|
||||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
%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 "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
|
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -249,7 +249,25 @@ class CliProxyTest < CliTestCase
|
|||||||
run_command("boot_config", "set", "--publish", "false").tap do |output|
|
run_command("boot_config", "set", "--publish", "false").tap do |output|
|
||||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
%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 "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
assert_match "Uploading \"\" to .kamal/proxy/options 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
|
end
|
||||||
end
|
end
|
||||||
@@ -258,7 +276,7 @@ class CliProxyTest < CliTestCase
|
|||||||
run_command("boot_config", "set", "--http-port", "8080", "--https-port", "8443").tap do |output|
|
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|
|
%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 "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
assert_match "Uploading \"--publish 8080:80 --publish 8443:443\" to .kamal/proxy/options 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
|
end
|
||||||
end
|
end
|
||||||
@@ -267,14 +285,14 @@ class CliProxyTest < CliTestCase
|
|||||||
run_command("boot_config", "set", "--docker_options", "label=foo=bar", "add_host=thishost:thathost").tap do |output|
|
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|
|
%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 "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||||
assert_match "Uploading \"--publish 80:80 --publish 443:443 --label=foo=bar --add_host=thishost:thathost\" to .kamal/proxy/options 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
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
test "boot_config get" do
|
test "boot_config get" do
|
||||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||||
.with(:cat, ".kamal/proxy/options", "||", :echo, "\"--publish 80:80 --publish 443:443\"")
|
.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")
|
.returns("--publish 80:80 --publish 8443:443 --label=foo=bar")
|
||||||
.twice
|
.twice
|
||||||
|
|
||||||
|
|||||||
@@ -7,6 +7,18 @@ class CliSecretsTest < CliTestCase
|
|||||||
run_command("fetch", "foo", "bar", "baz", "--account", "myaccount", "--adapter", "test")
|
run_command("fetch", "foo", "bar", "baz", "--account", "myaccount", "--adapter", "test")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch missing --acount" do
|
||||||
|
assert_equal \
|
||||||
|
"No value provided for required options '--account'",
|
||||||
|
run_command("fetch", "foo", "bar", "baz", "--adapter", "test")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "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
|
test "extract" do
|
||||||
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||||
end
|
end
|
||||||
@@ -15,6 +27,12 @@ class CliSecretsTest < CliTestCase
|
|||||||
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "print" do
|
||||||
|
with_test_secrets("secrets" => "SECRET1=ABC\nSECRET2=${SECRET1}DEF\n") do
|
||||||
|
assert_equal "SECRET1=ABC\nSECRET2=ABCDEF", run_command("print")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||||
|
|||||||
@@ -150,6 +150,27 @@ class CommanderTest < ActiveSupport::TestCase
|
|||||||
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
|
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "accessory hosts without filtering" do
|
||||||
|
configure_with(:deploy_with_single_accessory)
|
||||||
|
assert_equal [ "1.1.1.5" ], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
configure_with(:deploy_with_accessories_on_independent_server)
|
||||||
|
assert_equal [ "1.1.1.5", "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
|
||||||
|
end
|
||||||
|
|
||||||
|
test "accessory hosts with role filtering" do
|
||||||
|
configure_with(:deploy_with_single_accessory)
|
||||||
|
@kamal.specific_roles = [ "web" ]
|
||||||
|
assert_equal [], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
configure_with(:deploy_with_accessories_on_independent_server)
|
||||||
|
@kamal.specific_roles = [ "web" ]
|
||||||
|
assert_equal [ "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
|
||||||
|
|
||||||
|
@kamal.specific_roles = [ "workers" ]
|
||||||
|
assert_equal [], @kamal.accessory_hosts
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def configure_with(variant)
|
def configure_with(variant)
|
||||||
@kamal = Kamal::Commander.new.tap do |kamal|
|
@kamal = Kamal::Commander.new.tap do |kamal|
|
||||||
|
|||||||
@@ -71,6 +71,14 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
|||||||
new_command(:busybox).run.join(" ")
|
new_command(:busybox).run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "run in custom network" do
|
||||||
|
@config[:accessories]["mysql"]["network"] = "custom"
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker run --name app-mysql --detach --restart unless-stopped --network custom --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --label service=\"app-mysql\" private.registry/mysql:8.0",
|
||||||
|
new_command(:mysql).run.join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
test "start" do
|
test "start" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container start app-mysql",
|
"docker container start app-mysql",
|
||||||
|
|||||||
@@ -79,18 +79,18 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "stop" do
|
test "stop" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
||||||
new_command.stop.join(" ")
|
new_command.stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "stop with custom drain timeout" do
|
test "stop with custom drain timeout" do
|
||||||
@config[:drain_timeout] = 20
|
@config[:drain_timeout] = 20
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop",
|
||||||
new_command.stop.join(" ")
|
new_command.stop.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=workers --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=workers --filter status=running --filter status=restarting' | head -1 | xargs docker stop -t 20",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=workers --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=workers --filter status=running --filter status=restarting' | head -1 | xargs docker stop -t 20",
|
||||||
new_command(role: "workers").stop.join(" ")
|
new_command(role: "workers").stop.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "info" do
|
test "info" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.info.join(" ")
|
new_command.info.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -115,85 +115,109 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "deploy" do
|
test "deploy" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker exec kamal-proxy kamal-proxy deploy app-web --target \"172.1.0.2:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"",
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL" do
|
||||||
|
@config[:proxy] = { "ssl" => true, "host" => "example.com" }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL targeting multiple hosts" do
|
||||||
|
@config[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --host=\"anotherexample.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "deploy with SSL false" do
|
||||||
|
@config[:proxy] = { "ssl" => false }
|
||||||
|
|
||||||
|
assert_equal \
|
||||||
|
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
|
||||||
new_command.deploy(target: "172.1.0.2").join(" ")
|
new_command.deploy(target: "172.1.0.2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove" do
|
test "remove" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"",
|
"docker exec kamal-proxy kamal-proxy remove app-web",
|
||||||
new_command.remove(target: "172.1.0.2").join(" ")
|
new_command.remove.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
test "logs" do
|
test "logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1",
|
||||||
new_command.logs.join(" ")
|
new_command.logs.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since" do
|
test "logs with since" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1",
|
||||||
new_command.logs(since: "5m").join(" ")
|
new_command.logs(since: "5m").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with lines" do
|
test "logs with lines" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --tail 100 2>&1",
|
||||||
new_command.logs(lines: "100").join(" ")
|
new_command.logs(lines: "100").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since and lines" do
|
test "logs with since and lines" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m --tail 100 2>&1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m --tail 100 2>&1",
|
||||||
new_command.logs(since: "5m", lines: "100").join(" ")
|
new_command.logs(since: "5m", lines: "100").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with grep" do
|
test "logs with grep" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id'",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id'",
|
||||||
new_command.logs(grep: "my-id").join(" ")
|
new_command.logs(grep: "my-id").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with grep and grep options" do
|
test "logs with grep and grep options" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id' -C 2",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps 2>&1 | grep 'my-id' -C 2",
|
||||||
new_command.logs(grep: "my-id", grep_options: "-C 2").join(" ")
|
new_command.logs(grep: "my-id", grep_options: "-C 2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since, grep and grep options" do
|
test "logs with since, grep and grep options" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id' -C 2",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id' -C 2",
|
||||||
new_command.logs(since: "5m", grep: "my-id", grep_options: "-C 2").join(" ")
|
new_command.logs(since: "5m", grep: "my-id", grep_options: "-C 2").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "logs with since and grep" do
|
test "logs with since and grep" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id'",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker logs --timestamps --since 5m 2>&1 | grep 'my-id'",
|
||||||
new_command.logs(since: "5m", grep: "my-id").join(" ")
|
new_command.logs(since: "5m", grep: "my-id").join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "follow logs" do
|
test "follow logs" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1'",
|
||||||
new_command.follow_logs(host: "app-1")
|
new_command.follow_logs(host: "app-1")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", grep: "Completed")
|
new_command.follow_logs(host: "app-1", grep: "Completed")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1'",
|
||||||
new_command.follow_logs(host: "app-1", lines: 123)
|
new_command.follow_logs(host: "app-1", lines: 123)
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --timestamps --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", lines: 123, grep: "Completed")
|
new_command.follow_logs(host: "app-1", lines: 123, grep: "Completed")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
"ssh -t root@app-1 -p 22 'sh -c '\\''docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''\\'\\'''\\''{{.ID}}'\\''\\'\\'''\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting'\\'' | head -1 | xargs docker logs --tail 123 --follow 2>&1 | grep \"Completed\"'",
|
||||||
new_command.follow_logs(host: "app-1", timestamps: false, lines: 123, grep: "Completed")
|
new_command.follow_logs(host: "app-1", timestamps: false, lines: 123, grep: "Completed")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -298,7 +322,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "current_running_container_id" do
|
test "current_running_container_id" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1",
|
"sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1",
|
||||||
new_command.current_running_container_id.join(" ")
|
new_command.current_running_container_id.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -317,23 +341,23 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "current_running_version" do
|
test "current_running_version" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done",
|
"sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.current_running_version.join(" ")
|
new_command.current_running_version.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "list_versions" do
|
test "list_versions" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.list_versions.join(" ")
|
new_command.list_versions.join(" ")
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker ps --filter label=service=app --filter label=role=web --filter status=running --filter status=restarting --latest --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
"docker ps --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --latest --format \"{{.Names}}\" | while read line; do echo ${line#app-web-}; done",
|
||||||
new_command.list_versions("--latest", statuses: [ :running, :restarting ]).join(" ")
|
new_command.list_versions("--latest", statuses: [ :running, :restarting ]).join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "list_containers" do
|
test "list_containers" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container ls --all --filter label=service=app --filter label=role=web",
|
"docker container ls --all --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.list_containers.join(" ")
|
new_command.list_containers.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -346,7 +370,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "list_container_names" do
|
test "list_container_names" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container ls --all --filter label=service=app --filter label=role=web --format '{{ .Names }}'",
|
"docker container ls --all --filter label=service=app --filter label=destination= --filter label=role=web --format '{{ .Names }}'",
|
||||||
new_command.list_container_names.join(" ")
|
new_command.list_container_names.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -365,7 +389,7 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "remove_containers" do
|
test "remove_containers" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker container prune --force --filter label=service=app --filter label=role=web",
|
"docker container prune --force --filter label=service=app --filter label=destination= --filter label=role=web",
|
||||||
new_command.remove_containers.join(" ")
|
new_command.remove_containers.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -384,14 +408,14 @@ class CommandsAppTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "remove_images" do
|
test "remove_images" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker image prune --all --force --filter label=service=app --filter label=role=web",
|
"docker image prune --all --force --filter label=service=app",
|
||||||
new_command.remove_images.join(" ")
|
new_command.remove_images.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
test "remove_images with destination" do
|
test "remove_images with destination" do
|
||||||
@destination = "staging"
|
@destination = "staging"
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker image prune --all --force --filter label=service=app --filter label=destination=staging --filter label=role=web",
|
"docker image prune --all --force --filter label=service=app",
|
||||||
new_command.remove_images.join(" ")
|
new_command.remove_images.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -144,20 +144,59 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
|||||||
builder.push.join(" ")
|
builder.push.join(" ")
|
||||||
end
|
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
|
test "mirror count" do
|
||||||
command = new_builder_command
|
command = new_builder_command
|
||||||
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
|
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "clone path with spaces" do
|
||||||
|
command = new_builder_command
|
||||||
|
Kamal::Git.stubs(:root).returns("/absolute/path with spaces")
|
||||||
|
clone_command = command.clone.join(" ")
|
||||||
|
clone_reset_commands = command.clone_reset_steps.map { |a| a.join(" ") }
|
||||||
|
|
||||||
|
assert_match(%r{path\\ with\\ space}, clone_command)
|
||||||
|
assert_no_match(%r{path with spaces}, clone_command)
|
||||||
|
|
||||||
|
clone_reset_commands.each do |command|
|
||||||
|
assert_match(%r{path\\ with\\ space}, command)
|
||||||
|
assert_no_match(%r{path with spaces}, command)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def new_builder_command(additional_config = {})
|
def new_builder_command(additional_config = {})
|
||||||
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
|
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
|
||||||
end
|
end
|
||||||
|
|
||||||
def build_directory
|
|
||||||
"#{Dir.tmpdir}/kamal-clones/app/kamal/"
|
|
||||||
end
|
|
||||||
|
|
||||||
def local_arch
|
def local_arch
|
||||||
Kamal::Utils.docker_arch
|
Kamal::Utils.docker_arch
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "run" do
|
test "run" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||||
new_command.run.join(" ")
|
new_command.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
@config.delete(:proxy)
|
@config.delete(:proxy)
|
||||||
|
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||||
new_command.run.join(" ")
|
new_command.run.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
test "get_boot_options" do
|
test "get_boot_options" do
|
||||||
assert_equal \
|
assert_equal \
|
||||||
"cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\"",
|
"cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"",
|
||||||
new_command.get_boot_options.join(" ")
|
new_command.get_boot_options.join(" ")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -152,4 +152,13 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
|||||||
test "options" do
|
test "options" do
|
||||||
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
|
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "network_args default" do
|
||||||
|
assert_equal [ "--network", "kamal" ], @config.accessory(:mysql).network_args
|
||||||
|
end
|
||||||
|
|
||||||
|
test "network_args with configured options" do
|
||||||
|
@deploy[:accessories]["mysql"]["network"] = "database"
|
||||||
|
assert_equal [ "--network", "database" ], @config.accessory(:mysql).network_args
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from
|
assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=dhh/app-build-cache", config.builder.cache_to
|
assert_equal "type=registry,ref=dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "setting registry cache when using a custom registry" do
|
test "setting registry cache when using a custom registry" do
|
||||||
@@ -72,14 +72,14 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from
|
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_to
|
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "setting registry cache with image" do
|
test "setting registry cache with image" do
|
||||||
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } }
|
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } }
|
||||||
|
|
||||||
assert_equal "type=registry,ref=kamal", config.builder.cache_from
|
assert_equal "type=registry,ref=kamal", config.builder.cache_from
|
||||||
assert_equal "type=registry,mode=max,ref=kamal", config.builder.cache_to
|
assert_equal "type=registry,ref=kamal,mode=max", config.builder.cache_to
|
||||||
end
|
end
|
||||||
|
|
||||||
test "args" do
|
test "args" do
|
||||||
@@ -134,6 +134,26 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
|
|||||||
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
|
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "provenance" do
|
||||||
|
assert_nil config.builder.provenance
|
||||||
|
end
|
||||||
|
|
||||||
|
test "setting provenance" do
|
||||||
|
@deploy[:builder]["provenance"] = "mode=max"
|
||||||
|
|
||||||
|
assert_equal "mode=max", config.builder.provenance
|
||||||
|
end
|
||||||
|
|
||||||
|
test "sbom" do
|
||||||
|
assert_nil config.builder.sbom
|
||||||
|
end
|
||||||
|
|
||||||
|
test "setting sbom" do
|
||||||
|
@deploy[:builder]["sbom"] = true
|
||||||
|
|
||||||
|
assert_equal true, config.builder.sbom
|
||||||
|
end
|
||||||
|
|
||||||
test "local disabled but no remote set" do
|
test "local disabled but no remote set" do
|
||||||
@deploy[:builder]["local"] = false
|
@deploy[:builder]["local"] = false
|
||||||
|
|
||||||
|
|||||||
@@ -13,15 +13,29 @@ class ConfigurationProxyTest < ActiveSupport::TestCase
|
|||||||
assert_equal true, config.proxy.ssl?
|
assert_equal true, config.proxy.ssl?
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ssl with multiple hosts passed via host" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, "host" => "example.com,anotherexample.com" }
|
||||||
|
assert_equal true, config.proxy.ssl?
|
||||||
|
end
|
||||||
|
|
||||||
|
test "ssl with multiple hosts passed via hosts" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
|
||||||
|
assert_equal true, config.proxy.ssl?
|
||||||
|
end
|
||||||
|
|
||||||
test "ssl with no host" do
|
test "ssl with no host" do
|
||||||
@deploy[:proxy] = { "ssl" => true }
|
@deploy[:proxy] = { "ssl" => true }
|
||||||
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "ssl with both host and hosts" do
|
||||||
|
@deploy[:proxy] = { "ssl" => true, host: "example.com", hosts: [ "anotherexample.com" ] }
|
||||||
|
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
|
||||||
|
end
|
||||||
|
|
||||||
test "ssl false" do
|
test "ssl false" do
|
||||||
@deploy[:proxy] = { "ssl" => false }
|
@deploy[:proxy] = { "ssl" => false }
|
||||||
assert_not config.proxy.ssl?
|
assert_not config.proxy.ssl?
|
||||||
assert_not config.proxy.deploy_options.has_key?(:tls)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
@@ -222,6 +222,13 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
assert_equal "my-user", config.registry.username
|
assert_equal "my-user", config.registry.username
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "destination is loaded into env" do
|
||||||
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
|
config = Kamal::Configuration.create_from config_file: dest_config_file, destination: "world"
|
||||||
|
assert_equal ENV["KAMAL_DESTINATION"], "world"
|
||||||
|
end
|
||||||
|
|
||||||
test "destination yml config merge" do
|
test "destination yml config merge" do
|
||||||
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
|
||||||
|
|
||||||
@@ -377,4 +384,15 @@ class ConfigurationTest < ActiveSupport::TestCase
|
|||||||
|
|
||||||
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "two proxy ssl roles with same host in a hosts array" do
|
||||||
|
@deploy_with_roles[:servers]["web"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "foo.example.com", "bar.example.com" ] } }
|
||||||
|
@deploy_with_roles[:servers]["workers"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "www.example.com", "foo.example.com" ] } }
|
||||||
|
|
||||||
|
exception = assert_raises(Kamal::ConfigurationError) do
|
||||||
|
Kamal::Configuration.new(@deploy_with_roles)
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -11,6 +11,16 @@ class EnvFileTest < ActiveSupport::TestCase
|
|||||||
Kamal::EnvFile.new(env).to_s
|
Kamal::EnvFile.new(env).to_s
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "to_s won't escape '#'" do
|
||||||
|
env = {
|
||||||
|
"foo" => '#$foo',
|
||||||
|
"bar" => '#{bar}'
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal "foo=\#$foo\nbar=\#{bar}\n", \
|
||||||
|
Kamal::EnvFile.new(env).to_s
|
||||||
|
end
|
||||||
|
|
||||||
test "to_str won't escape chinese characters" do
|
test "to_str won't escape chinese characters" do
|
||||||
env = {
|
env = {
|
||||||
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'
|
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'
|
||||||
|
|||||||
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
|
kamal :app, :stop
|
||||||
|
|
||||||
assert_app_is_down
|
assert_app_not_found
|
||||||
|
|
||||||
kamal :app, :start
|
kamal :app, :start
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ class AppTest < IntegrationTest
|
|||||||
|
|
||||||
kamal :app, :remove
|
kamal :app, :remove
|
||||||
|
|
||||||
assert_app_is_down
|
assert_app_not_found
|
||||||
assert_app_directory_removed
|
assert_app_directory_removed
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -15,14 +15,15 @@ readiness_delay: 0
|
|||||||
|
|
||||||
proxy:
|
proxy:
|
||||||
host: localhost
|
host: localhost
|
||||||
|
ssl: false
|
||||||
healthcheck:
|
healthcheck:
|
||||||
interval: 1
|
interval: 1
|
||||||
timeout: 1
|
timeout: 1
|
||||||
path: "/up"
|
path: "/up"
|
||||||
response_timeout: 2
|
response_timeout: 2
|
||||||
buffering:
|
buffering:
|
||||||
requests: true
|
requests: false
|
||||||
responses: true
|
responses: false
|
||||||
memory: 400_000
|
memory: 400_000
|
||||||
max_request_body: 40_000_000
|
max_request_body: 40_000_000
|
||||||
max_response_body: 40_000_000
|
max_response_body: 40_000_000
|
||||||
|
|||||||
@@ -50,6 +50,12 @@ class IntegrationTest < ActiveSupport::TestCase
|
|||||||
assert_equal "502", response.code
|
assert_equal "502", response.code
|
||||||
end
|
end
|
||||||
|
|
||||||
|
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)
|
def assert_app_is_up(version: nil, app: @app)
|
||||||
response = app_response(app: app)
|
response = app_response(app: app)
|
||||||
debug_response_code(response, "200")
|
debug_response_code(response, "200")
|
||||||
|
|||||||
98
test/secrets/aws_secrets_manager_adapter_test.rb
Normal file
98
test/secrets/aws_secrets_manager_adapter_test.rb
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class AwsSecretsManagerAdapterTest < SecretAdapterTestCase
|
||||||
|
test "fetch" do
|
||||||
|
stub_ticks.with("aws --version 2> /dev/null")
|
||||||
|
stub_ticks
|
||||||
|
.with("aws secretsmanager batch-get-secret-value --secret-id-list secret/KEY1 secret/KEY2 secret2/KEY3 --profile default")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"SecretValues": [
|
||||||
|
{
|
||||||
|
"ARN": "arn:aws:secretsmanager:us-east-1:aaaaaaaaaaaa:secret:secret",
|
||||||
|
"Name": "secret",
|
||||||
|
"VersionId": "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv",
|
||||||
|
"SecretString": "{\\"KEY1\\":\\"VALUE1\\", \\"KEY2\\":\\"VALUE2\\"}",
|
||||||
|
"VersionStages": [
|
||||||
|
"AWSCURRENT"
|
||||||
|
],
|
||||||
|
"CreatedDate": "2024-01-01T00:00:00.000000"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"ARN": "arn:aws:secretsmanager:us-east-1:aaaaaaaaaaaa:secret:secret2",
|
||||||
|
"Name": "secret2",
|
||||||
|
"VersionId": "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv",
|
||||||
|
"SecretString": "{\\"KEY3\\":\\"VALUE3\\"}",
|
||||||
|
"VersionStages": [
|
||||||
|
"AWSCURRENT"
|
||||||
|
],
|
||||||
|
"CreatedDate": "2024-01-01T00:00:00.000000"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"Errors": []
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
|
||||||
|
json = JSON.parse(shellunescape(run_command("fetch", "secret/KEY1", "secret/KEY2", "secret2/KEY3")))
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"secret/KEY1"=>"VALUE1",
|
||||||
|
"secret/KEY2"=>"VALUE2",
|
||||||
|
"secret2/KEY3"=>"VALUE3"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch with secret names" do
|
||||||
|
stub_ticks.with("aws --version 2> /dev/null")
|
||||||
|
stub_ticks
|
||||||
|
.with("aws secretsmanager batch-get-secret-value --secret-id-list secret/KEY1 secret/KEY2 --profile default")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"SecretValues": [
|
||||||
|
{
|
||||||
|
"ARN": "arn:aws:secretsmanager:us-east-1:aaaaaaaaaaaa:secret:secret",
|
||||||
|
"Name": "secret",
|
||||||
|
"VersionId": "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv",
|
||||||
|
"SecretString": "{\\"KEY1\\":\\"VALUE1\\", \\"KEY2\\":\\"VALUE2\\"}",
|
||||||
|
"VersionStages": [
|
||||||
|
"AWSCURRENT"
|
||||||
|
],
|
||||||
|
"CreatedDate": "2024-01-01T00:00:00.000000"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"Errors": []
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
|
||||||
|
json = JSON.parse(shellunescape(run_command("fetch", "--from", "secret", "KEY1", "KEY2")))
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"secret/KEY1"=>"VALUE1",
|
||||||
|
"secret/KEY2"=>"VALUE2"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch without CLI installed" do
|
||||||
|
stub_ticks_with("aws --version 2> /dev/null", succeed: false)
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "SECRET1")))
|
||||||
|
end
|
||||||
|
assert_equal "AWS CLI is not installed", error.message
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted do
|
||||||
|
Kamal::Cli::Secrets.start \
|
||||||
|
[ *command,
|
||||||
|
"-c", "test/fixtures/deploy_with_accessories.yml",
|
||||||
|
"--adapter", "aws_secrets_manager",
|
||||||
|
"--account", "default" ]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -2,6 +2,8 @@ require "test_helper"
|
|||||||
|
|
||||||
class BitwardenAdapterTest < SecretAdapterTestCase
|
class BitwardenAdapterTest < SecretAdapterTestCase
|
||||||
test "fetch" do
|
test "fetch" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_unlocked
|
stub_unlocked
|
||||||
stub_ticks.with("bw sync").returns("")
|
stub_ticks.with("bw sync").returns("")
|
||||||
stub_mypassword
|
stub_mypassword
|
||||||
@@ -13,7 +15,22 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
assert_equal expected_json, json
|
assert_equal expected_json, json
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch with no login" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
|
stub_unlocked
|
||||||
|
stub_ticks.with("bw sync").returns("")
|
||||||
|
stub_noteitem
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "mynote")))
|
||||||
|
end
|
||||||
|
assert_match(/not a login type item/, error.message)
|
||||||
|
end
|
||||||
|
|
||||||
test "fetch with from" do
|
test "fetch with from" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_unlocked
|
stub_unlocked
|
||||||
stub_ticks.with("bw sync").returns("")
|
stub_ticks.with("bw sync").returns("")
|
||||||
stub_myitem
|
stub_myitem
|
||||||
@@ -27,7 +44,26 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
assert_equal expected_json, json
|
assert_equal expected_json, json
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch all with from" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
|
stub_unlocked
|
||||||
|
stub_ticks.with("bw sync").returns("")
|
||||||
|
stub_noteitem_with_fields
|
||||||
|
|
||||||
|
json = JSON.parse(shellunescape(run_command("fetch", "mynotefields")))
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"mynotefields/field1"=>"secret1", "mynotefields/field2"=>"blam", "mynotefields/field3"=>"fewgrwjgk",
|
||||||
|
"mynotefields/field4"=>"auto"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
test "fetch with multiple items" do
|
test "fetch with multiple items" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_unlocked
|
stub_unlocked
|
||||||
|
|
||||||
stub_ticks.with("bw sync").returns("")
|
stub_ticks.with("bw sync").returns("")
|
||||||
@@ -69,6 +105,8 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch unauthenticated" do
|
test "fetch unauthenticated" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
.with("bw status")
|
.with("bw status")
|
||||||
.returns(
|
.returns(
|
||||||
@@ -90,6 +128,8 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch locked" do
|
test "fetch locked" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
.with("bw status")
|
.with("bw status")
|
||||||
.returns(
|
.returns(
|
||||||
@@ -115,6 +155,8 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch locked with session" do
|
test "fetch locked with session" do
|
||||||
|
stub_ticks.with("bw --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
.with("bw status")
|
.with("bw status")
|
||||||
.returns(
|
.returns(
|
||||||
@@ -139,6 +181,15 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
assert_equal expected_json, json
|
assert_equal expected_json, json
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch without CLI installed" do
|
||||||
|
stub_ticks_with("bw --version 2> /dev/null", succeed: false)
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "mynote")))
|
||||||
|
end
|
||||||
|
assert_equal "Bitwarden CLI is not installed", error.message
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted do
|
stdouted do
|
||||||
@@ -181,6 +232,60 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
JSON
|
JSON
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def stub_noteitem(session: nil)
|
||||||
|
stub_ticks
|
||||||
|
.with("#{"BW_SESSION=#{session} " if session}bw get item mynote")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"passwordHistory":null,
|
||||||
|
"revisionDate":"2024-09-28T09:07:27.461Z",
|
||||||
|
"creationDate":"2024-09-28T09:07:00.740Z",
|
||||||
|
"deletedDate":null,
|
||||||
|
"object":"item",
|
||||||
|
"id":"aaaaaaaa-cccc-eeee-0000-222222222222",
|
||||||
|
"organizationId":null,
|
||||||
|
"folderId":null,
|
||||||
|
"type":2,
|
||||||
|
"reprompt":0,
|
||||||
|
"name":"noteitem",
|
||||||
|
"notes":"NOTES",
|
||||||
|
"favorite":false,
|
||||||
|
"secureNote":{"type":0},
|
||||||
|
"collectionIds":[]
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
end
|
||||||
|
|
||||||
|
def stub_noteitem_with_fields(session: nil)
|
||||||
|
stub_ticks
|
||||||
|
.with("#{"BW_SESSION=#{session} " if session}bw get item mynotefields")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"passwordHistory":null,
|
||||||
|
"revisionDate":"2024-09-28T09:07:27.461Z",
|
||||||
|
"creationDate":"2024-09-28T09:07:00.740Z",
|
||||||
|
"deletedDate":null,
|
||||||
|
"object":"item",
|
||||||
|
"id":"aaaaaaaa-cccc-eeee-0000-222222222222",
|
||||||
|
"organizationId":null,
|
||||||
|
"folderId":null,
|
||||||
|
"type":2,
|
||||||
|
"reprompt":0,
|
||||||
|
"name":"noteitem",
|
||||||
|
"notes":"NOTES",
|
||||||
|
"favorite":false,
|
||||||
|
"fields":[
|
||||||
|
{"name":"field1","value":"secret1","type":1,"linkedId":null},
|
||||||
|
{"name":"field2","value":"blam","type":1,"linkedId":null},
|
||||||
|
{"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null},
|
||||||
|
{"name":"field4","value":"auto","type":1,"linkedId":null}
|
||||||
|
],
|
||||||
|
"secureNote":{"type":0},
|
||||||
|
"collectionIds":[]
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
end
|
||||||
|
|
||||||
def stub_myitem
|
def stub_myitem
|
||||||
stub_ticks
|
stub_ticks
|
||||||
.with("bw get item myitem")
|
.with("bw get item myitem")
|
||||||
@@ -202,7 +307,8 @@ class BitwardenAdapterTest < SecretAdapterTestCase
|
|||||||
"fields":[
|
"fields":[
|
||||||
{"name":"field1","value":"secret1","type":1,"linkedId":null},
|
{"name":"field1","value":"secret1","type":1,"linkedId":null},
|
||||||
{"name":"field2","value":"blam","type":1,"linkedId":null},
|
{"name":"field2","value":"blam","type":1,"linkedId":null},
|
||||||
{"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null}
|
{"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null},
|
||||||
|
{"name":"field4","value":"auto","type":1,"linkedId":null}
|
||||||
],
|
],
|
||||||
"login":{"fido2Credentials":[],"uris":[],"username":null,"password":null,"totp":null,"passwordRevisionDate":null},"collectionIds":[]
|
"login":{"fido2Credentials":[],"uris":[],"username":null,"password":null,"totp":null,"passwordRevisionDate":null},"collectionIds":[]
|
||||||
}
|
}
|
||||||
|
|||||||
186
test/secrets/doppler_adapter_test.rb
Normal file
186
test/secrets/doppler_adapter_test.rb
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
require "test_helper"
|
||||||
|
|
||||||
|
class DopplerAdapterTest < SecretAdapterTestCase
|
||||||
|
setup do
|
||||||
|
`true` # Ensure $? is 0
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch" do
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: true)
|
||||||
|
stub_ticks.with("doppler me --json 2> /dev/null")
|
||||||
|
|
||||||
|
stub_ticks
|
||||||
|
.with("doppler secrets get SECRET1 FSECRET1 FSECRET2 --json -p my-project -c prd")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"SECRET1": {
|
||||||
|
"computed":"secret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET1": {
|
||||||
|
"computed":"fsecret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET2": {
|
||||||
|
"computed":"fsecret2",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
|
||||||
|
json = JSON.parse(
|
||||||
|
shellunescape run_command("fetch", "--from", "my-project/prd", "SECRET1", "FSECRET1", "FSECRET2")
|
||||||
|
)
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"SECRET1"=>"secret1",
|
||||||
|
"FSECRET1"=>"fsecret1",
|
||||||
|
"FSECRET2"=>"fsecret2"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch having DOPPLER_TOKEN" do
|
||||||
|
ENV["DOPPLER_TOKEN"] = "dp.st.xxxxxxxxxxxxxxxxxxxxxx"
|
||||||
|
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: true)
|
||||||
|
stub_ticks.with("doppler me --json 2> /dev/null")
|
||||||
|
|
||||||
|
stub_ticks
|
||||||
|
.with("doppler secrets get SECRET1 FSECRET1 FSECRET2 --json ")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"SECRET1": {
|
||||||
|
"computed":"secret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET1": {
|
||||||
|
"computed":"fsecret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET2": {
|
||||||
|
"computed":"fsecret2",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
|
||||||
|
json = JSON.parse(
|
||||||
|
shellunescape run_command("fetch", "SECRET1", "FSECRET1", "FSECRET2")
|
||||||
|
)
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"SECRET1"=>"secret1",
|
||||||
|
"FSECRET1"=>"fsecret1",
|
||||||
|
"FSECRET2"=>"fsecret2"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
|
||||||
|
ENV.delete("DOPPLER_TOKEN")
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch with folder in secret" do
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: true)
|
||||||
|
stub_ticks.with("doppler me --json 2> /dev/null")
|
||||||
|
|
||||||
|
stub_ticks
|
||||||
|
.with("doppler secrets get SECRET1 FSECRET1 FSECRET2 --json -p my-project -c prd")
|
||||||
|
.returns(<<~JSON)
|
||||||
|
{
|
||||||
|
"SECRET1": {
|
||||||
|
"computed":"secret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET1": {
|
||||||
|
"computed":"fsecret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
},
|
||||||
|
"FSECRET2": {
|
||||||
|
"computed":"fsecret2",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
|
||||||
|
json = JSON.parse(
|
||||||
|
shellunescape run_command("fetch", "my-project/prd/SECRET1", "my-project/prd/FSECRET1", "my-project/prd/FSECRET2")
|
||||||
|
)
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"SECRET1"=>"secret1",
|
||||||
|
"FSECRET1"=>"fsecret1",
|
||||||
|
"FSECRET2"=>"fsecret2"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch without --from" do
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: true)
|
||||||
|
stub_ticks.with("doppler me --json 2> /dev/null")
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
run_command("fetch", "FSECRET1", "FSECRET2")
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_equal "Missing project or config from '--from=project/config' option", error.message
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch with signin" do
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: true)
|
||||||
|
stub_ticks_with("doppler me --json 2> /dev/null", succeed: false)
|
||||||
|
stub_ticks_with("doppler login -y", succeed: true).returns("")
|
||||||
|
stub_ticks.with("doppler secrets get SECRET1 --json -p my-project -c prd").returns(single_item_json)
|
||||||
|
|
||||||
|
json = JSON.parse(shellunescape(run_command("fetch", "--from", "my-project/prd", "SECRET1")))
|
||||||
|
|
||||||
|
expected_json = {
|
||||||
|
"SECRET1"=>"secret1"
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equal expected_json, json
|
||||||
|
end
|
||||||
|
|
||||||
|
test "fetch without CLI installed" do
|
||||||
|
stub_ticks_with("doppler --version 2> /dev/null", succeed: false)
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "HOST", "PORT")))
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_equal "Doppler CLI is not installed", error.message
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
def run_command(*command)
|
||||||
|
stdouted do
|
||||||
|
Kamal::Cli::Secrets.start \
|
||||||
|
[ *command,
|
||||||
|
"-c", "test/fixtures/deploy_with_accessories.yml",
|
||||||
|
"--adapter", "doppler" ]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def single_item_json
|
||||||
|
<<~JSON
|
||||||
|
{
|
||||||
|
"SECRET1": {
|
||||||
|
"computed":"secret1",
|
||||||
|
"computedVisibility":"unmasked",
|
||||||
|
"note":""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -6,6 +6,7 @@ class LastPassAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch" do
|
test "fetch" do
|
||||||
|
stub_ticks.with("lpass --version 2> /dev/null")
|
||||||
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
|
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
@@ -63,6 +64,7 @@ class LastPassAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch with from" do
|
test "fetch with from" do
|
||||||
|
stub_ticks.with("lpass --version 2> /dev/null")
|
||||||
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
|
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
@@ -107,6 +109,8 @@ class LastPassAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch with signin" do
|
test "fetch with signin" do
|
||||||
|
stub_ticks.with("lpass --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks_with("lpass status --color never", succeed: false).returns("Not logged in.")
|
stub_ticks_with("lpass status --color never", succeed: false).returns("Not logged in.")
|
||||||
stub_ticks_with("lpass login email@example.com", succeed: true).returns("")
|
stub_ticks_with("lpass login email@example.com", succeed: true).returns("")
|
||||||
stub_ticks.with("lpass show SECRET1 --json").returns(single_item_json)
|
stub_ticks.with("lpass show SECRET1 --json").returns(single_item_json)
|
||||||
@@ -120,6 +124,15 @@ class LastPassAdapterTest < SecretAdapterTestCase
|
|||||||
assert_equal expected_json, json
|
assert_equal expected_json, json
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch without CLI installed" do
|
||||||
|
stub_ticks_with("lpass --version 2> /dev/null", succeed: false)
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "SECRET1", "FOLDER1/FSECRET1", "FOLDER1/FSECRET2")))
|
||||||
|
end
|
||||||
|
assert_equal "LastPass CLI is not installed", error.message
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted do
|
stdouted do
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ require "test_helper"
|
|||||||
|
|
||||||
class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
||||||
test "fetch" do
|
test "fetch" do
|
||||||
|
stub_ticks.with("op --version 2> /dev/null")
|
||||||
stub_ticks.with("op account get --account myaccount 2> /dev/null")
|
stub_ticks.with("op account get --account myaccount 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
@@ -56,6 +57,7 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch with multiple items" do
|
test "fetch with multiple items" do
|
||||||
|
stub_ticks.with("op --version 2> /dev/null")
|
||||||
stub_ticks.with("op account get --account myaccount 2> /dev/null")
|
stub_ticks.with("op account get --account myaccount 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks
|
stub_ticks
|
||||||
@@ -115,6 +117,8 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch with signin, no session" do
|
test "fetch with signin, no session" do
|
||||||
|
stub_ticks.with("op --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
|
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
|
||||||
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("")
|
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("")
|
||||||
|
|
||||||
@@ -132,6 +136,8 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
|||||||
end
|
end
|
||||||
|
|
||||||
test "fetch with signin and session" do
|
test "fetch with signin and session" do
|
||||||
|
stub_ticks.with("op --version 2> /dev/null")
|
||||||
|
|
||||||
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
|
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
|
||||||
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("1234567890")
|
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("1234567890")
|
||||||
|
|
||||||
@@ -148,6 +154,15 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
|
|||||||
assert_equal expected_json, json
|
assert_equal expected_json, json
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "fetch without CLI installed" do
|
||||||
|
stub_ticks_with("op --version 2> /dev/null", succeed: false)
|
||||||
|
|
||||||
|
error = assert_raises RuntimeError do
|
||||||
|
JSON.parse(shellunescape(run_command("fetch", "--from", "op://myvault/myitem", "section/SECRET1", "section/SECRET2", "section2/SECRET3")))
|
||||||
|
end
|
||||||
|
assert_equal "1Password CLI is not installed", error.message
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
def run_command(*command)
|
def run_command(*command)
|
||||||
stdouted do
|
stdouted do
|
||||||
|
|||||||
@@ -31,4 +31,18 @@ class SecretsTest < ActiveSupport::TestCase
|
|||||||
assert_equal "JKL", Kamal::Secrets.new(destination: "nodest")["SECRET2"]
|
assert_equal "JKL", Kamal::Secrets.new(destination: "nodest")["SECRET2"]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "no secrets files" do
|
||||||
|
with_test_secrets do
|
||||||
|
error = assert_raises(Kamal::ConfigurationError) do
|
||||||
|
Kamal::Secrets.new["SECRET"]
|
||||||
|
end
|
||||||
|
assert_equal "Secret 'SECRET' not found, no secret files (.kamal/secrets-common, .kamal/secrets) provided", error.message
|
||||||
|
|
||||||
|
error = assert_raises(Kamal::ConfigurationError) do
|
||||||
|
Kamal::Secrets.new(destination: "dest")["SECRET"]
|
||||||
|
end
|
||||||
|
assert_equal "Secret 'SECRET' not found, no secret files (.kamal/secrets-common, .kamal/secrets.dest) provided", error.message
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ require "bundler/setup"
|
|||||||
require "active_support/test_case"
|
require "active_support/test_case"
|
||||||
require "active_support/testing/autorun"
|
require "active_support/testing/autorun"
|
||||||
require "active_support/testing/stream"
|
require "active_support/testing/stream"
|
||||||
|
require "rails/test_unit/line_filtering"
|
||||||
require "debug"
|
require "debug"
|
||||||
require "mocha/minitest" # using #stubs that can alter returns
|
require "mocha/minitest" # using #stubs that can alter returns
|
||||||
require "minitest/autorun" # using #stub that take args
|
require "minitest/autorun" # using #stub that take args
|
||||||
@@ -32,6 +33,7 @@ end
|
|||||||
|
|
||||||
class ActiveSupport::TestCase
|
class ActiveSupport::TestCase
|
||||||
include ActiveSupport::Testing::Stream
|
include ActiveSupport::Testing::Stream
|
||||||
|
extend Rails::LineFiltering
|
||||||
|
|
||||||
private
|
private
|
||||||
def stdouted
|
def stdouted
|
||||||
|
|||||||
@@ -2,8 +2,8 @@ require "test_helper"
|
|||||||
|
|
||||||
class UtilsTest < ActiveSupport::TestCase
|
class UtilsTest < ActiveSupport::TestCase
|
||||||
test "argumentize" do
|
test "argumentize" do
|
||||||
assert_equal [ "--label", "foo=\"\\`bar\\`\"", "--label", "baz=\"qux\"", "--label", :quux ], \
|
assert_equal [ "--label", "foo=\"\\`bar\\`\"", "--label", "baz=\"qux\"", "--label", :quux, "--label", "quuz=false" ], \
|
||||||
Kamal::Utils.argumentize("--label", { foo: "`bar`", baz: "qux", quux: nil })
|
Kamal::Utils.argumentize("--label", { foo: "`bar`", baz: "qux", quux: nil, quuz: false })
|
||||||
end
|
end
|
||||||
|
|
||||||
test "argumentize with redacted" do
|
test "argumentize with redacted" do
|
||||||
|
|||||||
Reference in New Issue
Block a user