Compare commits
209 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
22e7243b10 | ||
|
|
259a018d5a | ||
|
|
a82e88d5c9 | ||
|
|
d6459e869a | ||
|
|
ad21c7e984 | ||
|
|
87965281a3 | ||
|
|
dca96eafaa | ||
|
|
7b1439c3c6 | ||
|
|
b9e5ce7ca7 | ||
|
|
f62c1a50c4 | ||
|
|
2c1d6ed891 | ||
|
|
031f55ecf7 | ||
|
|
d98d6a3475 | ||
|
|
78c9d610cf | ||
|
|
4187ee2397 | ||
|
|
7bfb2ed9f2 | ||
|
|
299c741c1b | ||
|
|
fb82d04aaf | ||
|
|
9d5a534ef8 | ||
|
|
5ad000a08e | ||
|
|
1ca2b4d394 | ||
|
|
9aac51bbd0 | ||
|
|
83a5636e27 | ||
|
|
2d43f788c4 | ||
|
|
c351c2d2de | ||
|
|
0d36fc4bd0 | ||
|
|
317f00281a | ||
|
|
226e7091db | ||
|
|
e32ea2e276 | ||
|
|
1ea5d0bd86 | ||
|
|
f5f1bab8bf | ||
|
|
419a1171fa | ||
|
|
2f7feaf59d | ||
|
|
52c6191803 | ||
|
|
b1c5c5092f | ||
|
|
128294672d | ||
|
|
eb915f830e | ||
|
|
d26b3f1768 | ||
|
|
8789a1b10c | ||
|
|
54b2c79f08 | ||
|
|
d464707c32 | ||
|
|
f5ff612846 | ||
|
|
04568dea2f | ||
|
|
63f65d60c6 | ||
|
|
5145289625 | ||
|
|
aa57462c1b | ||
|
|
d0c9af20d8 | ||
|
|
f898fb8cb7 | ||
|
|
400fbcea1f | ||
|
|
93d1bd1369 | ||
|
|
f768fab481 | ||
|
|
02c3b947c3 | ||
|
|
7a63cacb09 | ||
|
|
cd9d01b016 | ||
|
|
48f5eeff09 | ||
|
|
bf64d9a0f5 | ||
|
|
8d5ed62d30 | ||
|
|
58d5c7fb15 | ||
|
|
e4e39c31e3 | ||
|
|
5c71f2ba5a | ||
|
|
05f04f4c10 | ||
|
|
03cac7ae3d | ||
|
|
399f1526af | ||
|
|
84fa30e376 | ||
|
|
098c937bab | ||
|
|
95e3edc32b | ||
|
|
ac719dc271 | ||
|
|
91f01ece1b | ||
|
|
521425c386 | ||
|
|
55ec6ca0a6 | ||
|
|
2a8d561094 | ||
|
|
354530f3b8 | ||
|
|
26b6c072f3 | ||
|
|
3c1fbb41cb | ||
|
|
8ceeda6ac9 | ||
|
|
dd9048e09c | ||
|
|
bd81632439 | ||
|
|
85320dbc51 | ||
|
|
c9a755bde6 | ||
|
|
c3a9a3c1eb | ||
|
|
215fd2faed | ||
|
|
ec28caa83f | ||
|
|
a71ea08fb6 | ||
|
|
0b28a54518 | ||
|
|
d7dbef1c9e | ||
|
|
8fe2f92164 | ||
|
|
fb95b38e73 | ||
|
|
3aef9303c3 | ||
|
|
c1d8ce7f70 | ||
|
|
eeb5c01fc5 | ||
|
|
58e23f9167 | ||
|
|
7fa27faaca | ||
|
|
a02826284d | ||
|
|
4d78afaf1b | ||
|
|
d4ab010b01 | ||
|
|
3c9a3f2264 | ||
|
|
8098ed1fd1 | ||
|
|
0d034ec5dc | ||
|
|
598bd65b78 | ||
|
|
36f4e90a76 | ||
|
|
973fa1a7ff | ||
|
|
5e87b6d58e | ||
|
|
f87bcf5bc6 | ||
|
|
62dfa45ee6 | ||
|
|
c13ee578df | ||
|
|
f01238112e | ||
|
|
32ab72089a | ||
|
|
5377871278 | ||
|
|
91259720b2 | ||
|
|
6f29d4e78b | ||
|
|
9d2dda0d77 | ||
|
|
b130bc0321 | ||
|
|
28be0300b9 | ||
|
|
3c2163ab78 | ||
|
|
fdf7e6927a | ||
|
|
45197e46f6 | ||
|
|
6b40a64b9a | ||
|
|
9af2425fbd | ||
|
|
854dd925ba | ||
|
|
8775d202bd | ||
|
|
bae7c56e74 | ||
|
|
07d05ad58a | ||
|
|
e69611efb6 | ||
|
|
ba6dd6ff14 | ||
|
|
04a96aa5be | ||
|
|
dba3a115bd | ||
|
|
cd73cea850 | ||
|
|
09d020e9bb | ||
|
|
ff3538f81d | ||
|
|
c7d1711e30 | ||
|
|
d710b5a22b | ||
|
|
214d4fd321 | ||
|
|
5ddaa3810d | ||
|
|
3c01dc75fd | ||
|
|
2127f1708a | ||
|
|
24e4347c45 | ||
|
|
5f04e4266b | ||
|
|
35a29cc538 | ||
|
|
f187080db5 | ||
|
|
080fa49fdf | ||
|
|
34050f1036 | ||
|
|
459c7366ec | ||
|
|
f8db5de5eb | ||
|
|
4d67a1671a | ||
|
|
2c9bba3f88 | ||
|
|
a388937de8 | ||
|
|
9ef6c2f893 | ||
|
|
eee9d67691 | ||
|
|
5bd9bc8576 | ||
|
|
a5b9c69838 | ||
|
|
dc9a95db2c | ||
|
|
0174b872bf | ||
|
|
1db44c402c | ||
|
|
b420b2613d | ||
|
|
4ffa772201 | ||
|
|
e081414849 | ||
|
|
85c1c47c2f | ||
|
|
9f1688da7a | ||
|
|
2bd716ece4 | ||
|
|
f9a78f4fcb | ||
|
|
10dafc058a | ||
|
|
5e2678dece | ||
|
|
a1708f687f | ||
|
|
db7556ed99 | ||
|
|
93133cd7a9 | ||
|
|
a7b2ef56c7 | ||
|
|
06f2cb223e | ||
|
|
ea7e72d75f | ||
|
|
9035bd0d88 | ||
|
|
dd8cadf743 | ||
|
|
f1a9a09929 | ||
|
|
620b132138 | ||
|
|
2e7d0ddc44 | ||
|
|
ab8396fbb2 | ||
|
|
2cdca4596c | ||
|
|
78fcc3d88f | ||
|
|
7627f74e45 | ||
|
|
2b9d5c2b19 | ||
|
|
d59c274208 | ||
|
|
bd8689c185 | ||
|
|
b5aee11a40 | ||
|
|
2943c4a301 | ||
|
|
32e1b6504d | ||
|
|
39e2c4f848 | ||
|
|
89db5025a0 | ||
|
|
c56edba4a9 | ||
|
|
8103d68688 | ||
|
|
eb82b4a753 | ||
|
|
19b4359b17 | ||
|
|
dc64aaa0de | ||
|
|
ea170fbe5e | ||
|
|
18f2aae936 | ||
|
|
e314f38bdc | ||
|
|
1c8a56b8cf | ||
|
|
e597ae6155 | ||
|
|
aa9fe4c525 | ||
|
|
0bafa02e7d | ||
|
|
ffe1ac3483 | ||
|
|
11e4f37409 | ||
|
|
b87bcae6a3 | ||
|
|
0c9a367efc | ||
|
|
a07ef64fad | ||
|
|
3793bdc2c3 | ||
|
|
79bc7584ca | ||
|
|
c9dec8c79a | ||
|
|
8d7a6403b5 | ||
|
|
b356b08069 | ||
|
|
4d09f3c242 | ||
|
|
d6c4411e97 |
4
.github/workflows/ci.yml
vendored
4
.github/workflows/ci.yml
vendored
@@ -23,12 +23,13 @@ jobs:
|
||||
run: bundle exec rubocop --parallel
|
||||
tests:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
ruby-version:
|
||||
- "3.1"
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
- "3.4.0-preview2"
|
||||
- "3.4"
|
||||
gemfile:
|
||||
- Gemfile
|
||||
- gemfiles/rails_edge.gemfile
|
||||
@@ -37,7 +38,6 @@ jobs:
|
||||
gemfile: gemfiles/rails_edge.gemfile
|
||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
env:
|
||||
BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
|
||||
steps:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
FROM ruby:3.3-alpine
|
||||
FROM ruby:3.4-alpine
|
||||
|
||||
# Install docker/buildx-bin
|
||||
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
||||
@@ -13,9 +13,9 @@ COPY Gemfile Gemfile.lock kamal.gemspec ./
|
||||
COPY lib/kamal/version.rb /kamal/lib/kamal/version.rb
|
||||
|
||||
# Install system dependencies
|
||||
RUN apk add --no-cache build-base git docker openrc openssh-client-default \
|
||||
RUN apk add --no-cache build-base git docker openrc openssh-client-default yaml-dev \
|
||||
&& rc-update add docker boot \
|
||||
&& gem install bundler --version=2.4.3 \
|
||||
&& gem install bundler --version=2.6.5 \
|
||||
&& bundle install
|
||||
|
||||
# Copy the rest of our application code into the container.
|
||||
|
||||
26
Gemfile.lock
26
Gemfile.lock
@@ -1,13 +1,13 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
kamal (2.4.0)
|
||||
kamal (2.6.1)
|
||||
activesupport (>= 7.0)
|
||||
base64 (~> 0.2)
|
||||
bcrypt_pbkdf (~> 1.0)
|
||||
concurrent-ruby (~> 1.2)
|
||||
dotenv (~> 3.1)
|
||||
ed25519 (~> 1.2)
|
||||
ed25519 (~> 1.4)
|
||||
net-ssh (~> 7.3)
|
||||
sshkit (>= 1.23.0, < 2.0)
|
||||
thor (~> 1.3)
|
||||
@@ -48,8 +48,6 @@ GEM
|
||||
ast (2.4.2)
|
||||
base64 (0.2.0)
|
||||
bcrypt_pbkdf (1.1.1)
|
||||
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||
benchmark (0.4.0)
|
||||
bigdecimal (3.1.8)
|
||||
builder (3.3.0)
|
||||
@@ -62,7 +60,7 @@ GEM
|
||||
reline (>= 0.3.8)
|
||||
dotenv (3.1.5)
|
||||
drb (2.2.1)
|
||||
ed25519 (1.3.0)
|
||||
ed25519 (1.4.0)
|
||||
erubi (1.13.0)
|
||||
i18n (1.14.6)
|
||||
concurrent-ruby (~> 1.0)
|
||||
@@ -84,11 +82,15 @@ GEM
|
||||
net-sftp (4.0.0)
|
||||
net-ssh (>= 5.0.0, < 8.0.0)
|
||||
net-ssh (7.3.0)
|
||||
nokogiri (1.17.2-arm64-darwin)
|
||||
nokogiri (1.18.8-aarch64-linux-musl)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.17.2-x86_64-darwin)
|
||||
nokogiri (1.18.8-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.17.2-x86_64-linux)
|
||||
nokogiri (1.18.8-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.18.8-x86_64-linux-gnu)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.18.8-x86_64-linux-musl)
|
||||
racc (~> 1.4)
|
||||
ostruct (0.6.1)
|
||||
parallel (1.26.3)
|
||||
@@ -99,7 +101,7 @@ GEM
|
||||
date
|
||||
stringio
|
||||
racc (1.8.1)
|
||||
rack (3.1.8)
|
||||
rack (3.1.12)
|
||||
rack-session (2.0.0)
|
||||
rack (>= 3.0.0)
|
||||
rack-test (2.1.0)
|
||||
@@ -172,14 +174,16 @@ GEM
|
||||
unicode-display_width (3.1.2)
|
||||
unicode-emoji (~> 4.0, >= 4.0.4)
|
||||
unicode-emoji (4.0.4)
|
||||
uri (1.0.2)
|
||||
uri (1.0.3)
|
||||
useragent (0.16.11)
|
||||
zeitwerk (2.7.1)
|
||||
|
||||
PLATFORMS
|
||||
aarch64-linux-musl
|
||||
arm64-darwin
|
||||
x86_64-darwin
|
||||
x86_64-linux
|
||||
x86_64-linux-musl
|
||||
|
||||
DEPENDENCIES
|
||||
debug
|
||||
@@ -189,4 +193,4 @@ DEPENDENCIES
|
||||
rubocop-rails-omakase
|
||||
|
||||
BUNDLED WITH
|
||||
2.4.3
|
||||
2.6.5
|
||||
|
||||
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
|
||||
spec.add_dependency "thor", "~> 1.3"
|
||||
spec.add_dependency "dotenv", "~> 3.1"
|
||||
spec.add_dependency "zeitwerk", ">= 2.6.18", "< 3.0"
|
||||
spec.add_dependency "ed25519", "~> 1.2"
|
||||
spec.add_dependency "ed25519", "~> 1.4"
|
||||
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
||||
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
||||
spec.add_dependency "base64", "~> 0.2"
|
||||
|
||||
@@ -2,6 +2,7 @@ module Kamal::Cli
|
||||
class BootError < StandardError; end
|
||||
class HookError < StandardError; end
|
||||
class LockError < StandardError; end
|
||||
class DependencyError < StandardError; end
|
||||
end
|
||||
|
||||
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
require "active_support/core_ext/array/conversions"
|
||||
require "concurrent/array"
|
||||
|
||||
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
||||
@@ -10,6 +11,16 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
prepare(name) if prepare
|
||||
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
booted_hosts = Concurrent::Array.new
|
||||
on(hosts) do |host|
|
||||
booted_hosts << host.to_s if capture_with_info(*accessory.info(all: true, quiet: true)).strip.presence
|
||||
end
|
||||
|
||||
if booted_hosts.any?
|
||||
say "Skipping booting `#{name}` on #{booted_hosts.sort.join(", ")}, a container already exists", :yellow
|
||||
hosts -= booted_hosts
|
||||
end
|
||||
|
||||
directories(name)
|
||||
upload(name)
|
||||
|
||||
@@ -130,6 +141,8 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||
def exec(name, *cmd)
|
||||
pre_connect_if_required
|
||||
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
case
|
||||
@@ -139,6 +152,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
|
||||
when options[:interactive]
|
||||
say "Launching interactive command via SSH from new container...", :magenta
|
||||
on(accessory.hosts.first) { execute *KAMAL.registry.login }
|
||||
run_locally { exec accessory.execute_in_new_container_over_ssh(cmd) }
|
||||
|
||||
when options[:reuse]
|
||||
@@ -151,6 +165,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
else
|
||||
say "Launching command from new container...", :magenta
|
||||
on(hosts) do |host|
|
||||
execute *KAMAL.registry.login
|
||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||
puts_by_host host, capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||
end
|
||||
@@ -275,11 +290,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
def accessory_hosts(accessory)
|
||||
if KAMAL.specific_hosts&.any?
|
||||
KAMAL.specific_hosts & accessory.hosts
|
||||
else
|
||||
accessory.hosts
|
||||
end
|
||||
KAMAL.accessory_hosts & accessory.hosts
|
||||
end
|
||||
|
||||
def remove_accessory(name)
|
||||
@@ -292,7 +303,7 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
def prepare(name)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
on(hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
execute *KAMAL.registry.login(registry_config: accessory.registry)
|
||||
execute *KAMAL.docker.create_network
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise unless e.message.include?("already exists")
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
class Kamal::Cli::Alias::Command < Thor::DynamicCommand
|
||||
def run(instance, args = [])
|
||||
if (_alias = KAMAL.config.aliases[name])
|
||||
KAMAL.reset
|
||||
Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
|
||||
else
|
||||
super
|
||||
|
||||
@@ -7,23 +7,33 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
say "Start container with version #{version} (or reboot if already running)...", :magenta
|
||||
|
||||
# Assets are prepared in a separate step to ensure they are on all hosts before booting
|
||||
on(KAMAL.hosts) do
|
||||
on(KAMAL.app_hosts) do
|
||||
Kamal::Cli::App::ErrorPages.new(host, self).run
|
||||
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
Kamal::Cli::App::PrepareAssets.new(host, role, self).run
|
||||
Kamal::Cli::App::Assets.new(host, role, self).run
|
||||
end
|
||||
end
|
||||
|
||||
# Primary hosts and roles are returned first, so they can open the barrier
|
||||
barrier = Kamal::Cli::Healthcheck::Barrier.new
|
||||
|
||||
on(KAMAL.hosts, **KAMAL.boot_strategy) do |host|
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
||||
host_boot_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
run_hook "pre-app-boot", hosts: host_list
|
||||
|
||||
on(hosts) do |host|
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-app-boot", hosts: host_list
|
||||
sleep KAMAL.config.boot.wait if KAMAL.config.boot.wait
|
||||
end
|
||||
|
||||
# Tag once the app booted on all hosts
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Tagging #{KAMAL.config.absolute_image} as the latest image"), verbosity: :debug
|
||||
execute *KAMAL.app.tag_latest_image
|
||||
end
|
||||
@@ -34,7 +44,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
desc "start", "Start existing app container on servers"
|
||||
def start
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -57,7 +67,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
desc "stop", "Stop app container on servers"
|
||||
def stop
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -81,7 +91,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
# FIXME: Drop in favor of just containers?
|
||||
desc "details", "Show details about app containers"
|
||||
def details
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -96,10 +106,16 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
option :env, aliases: "-e", type: :hash, desc: "Set environment variables for the command"
|
||||
option :detach, type: :boolean, default: false, desc: "Execute command in a detached container"
|
||||
def exec(*cmd)
|
||||
pre_connect_if_required
|
||||
|
||||
if (incompatible_options = [ :interactive, :reuse ].select { |key| options[:detach] && options[key] }.presence)
|
||||
raise ArgumentError, "Detach is not compatible with #{incompatible_options.join(" or ")}"
|
||||
end
|
||||
|
||||
if cmd.empty?
|
||||
raise ArgumentError, "No command provided. You must specify a command to execute."
|
||||
end
|
||||
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
env = options[:env]
|
||||
detach = options[:detach]
|
||||
@@ -115,6 +131,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||
using_version(version_or_latest) do |version|
|
||||
say "Launching interactive command with version #{version} via SSH from new container on #{KAMAL.primary_host}...", :magenta
|
||||
on(KAMAL.primary_host) { execute *KAMAL.registry.login }
|
||||
run_locally do
|
||||
exec KAMAL.app(role: KAMAL.primary_role, host: KAMAL.primary_host).execute_in_new_container_over_ssh(cmd, env: env)
|
||||
end
|
||||
@@ -125,7 +142,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
using_version(options[:version] || current_running_version) do |version|
|
||||
say "Launching command with version #{version} from existing container...", :magenta
|
||||
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -139,7 +156,9 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||
using_version(version_or_latest) do |version|
|
||||
say "Launching command with version #{version} from new container...", :magenta
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -153,7 +172,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
desc "containers", "Show app containers on servers"
|
||||
def containers
|
||||
on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_containers) }
|
||||
on(KAMAL.app_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_containers) }
|
||||
end
|
||||
|
||||
desc "stale_containers", "Detect app stale containers"
|
||||
@@ -162,7 +181,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
stop = options[:stop]
|
||||
|
||||
with_lock_if_stopping do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -185,7 +204,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
desc "images", "Show app images on servers"
|
||||
def images
|
||||
on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_images) }
|
||||
on(KAMAL.app_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_images) }
|
||||
end
|
||||
|
||||
desc "logs", "Show log lines from app on servers (use --help to show options)"
|
||||
@@ -221,7 +240,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
else
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -241,14 +260,44 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
stop
|
||||
remove_containers
|
||||
remove_images
|
||||
remove_app_directory
|
||||
remove_app_directories
|
||||
end
|
||||
end
|
||||
|
||||
desc "live", "Set the app to live mode"
|
||||
def live
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
execute *KAMAL.app(role: role, host: host).live if role.running_proxy?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "maintenance", "Set the app to maintenance mode"
|
||||
option :drain_timeout, type: :numeric, desc: "How long to allow in-flight requests to complete (defaults to drain_timeout from config)"
|
||||
option :message, type: :string, desc: "Message to display to clients while stopped"
|
||||
def maintenance
|
||||
maintenance_options = { drain_timeout: options[:drain_timeout] || KAMAL.config.drain_timeout, message: options[:message] }
|
||||
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
execute *KAMAL.app(role: role, host: host).maintenance(**maintenance_options) if role.running_proxy?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_container [VERSION]", "Remove app container with given version from servers", hide: true
|
||||
def remove_container(version)
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -262,7 +311,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
desc "remove_containers", "Remove all app containers from servers", hide: true
|
||||
def remove_containers
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
@@ -276,30 +325,33 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
desc "remove_images", "Remove all app images from servers", hide: true
|
||||
def remove_images
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do
|
||||
on(KAMAL.app_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed all app images"), verbosity: :debug
|
||||
execute *KAMAL.app.remove_images
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_app_directory", "Remove the service directory from servers", hide: true
|
||||
def remove_app_directory
|
||||
desc "remove_app_directories", "Remove the app directories from servers", hide: true
|
||||
def remove_app_directories
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
execute *KAMAL.auditor.record("Removed #{KAMAL.config.app_directory} on all servers", role: role), verbosity: :debug
|
||||
execute *KAMAL.auditor.record("Removed #{KAMAL.config.app_directory}", role: role), verbosity: :debug
|
||||
execute *KAMAL.server.remove_app_directory, raise_on_non_zero_exit: false
|
||||
end
|
||||
|
||||
execute *KAMAL.auditor.record("Removed #{KAMAL.config.app_directory}"), verbosity: :debug
|
||||
execute *KAMAL.app.remove_proxy_app_directory, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "version", "Show app version currently running on servers"
|
||||
def version
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
role = KAMAL.roles_on(host).first
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).current_running_version).strip
|
||||
end
|
||||
@@ -340,4 +392,8 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
yield
|
||||
end
|
||||
end
|
||||
|
||||
def host_boot_groups
|
||||
KAMAL.config.boot.limit ? KAMAL.app_hosts.each_slice(KAMAL.config.boot.limit).to_a : [ KAMAL.app_hosts ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
class Kamal::Cli::App::PrepareAssets
|
||||
class Kamal::Cli::App::Assets
|
||||
attr_reader :host, :role, :sshkit
|
||||
delegate :execute, :capture_with_info, :info, to: :sshkit
|
||||
delegate :assets?, to: :role
|
||||
@@ -70,6 +70,7 @@ class Kamal::Cli::App::Boot
|
||||
def stop_old_version(version)
|
||||
execute *app.stop(version: version), raise_on_non_zero_exit: false
|
||||
execute *app.clean_up_assets if assets?
|
||||
execute *app.clean_up_error_pages if KAMAL.config.error_pages_path
|
||||
end
|
||||
|
||||
def release_barrier
|
||||
|
||||
33
lib/kamal/cli/app/error_pages.rb
Normal file
33
lib/kamal/cli/app/error_pages.rb
Normal file
@@ -0,0 +1,33 @@
|
||||
class Kamal::Cli::App::ErrorPages
|
||||
ERROR_PAGES_GLOB = "{4??.html,5??.html}"
|
||||
|
||||
attr_reader :host, :sshkit
|
||||
delegate :upload!, :execute, to: :sshkit
|
||||
|
||||
def initialize(host, sshkit)
|
||||
@host = host
|
||||
@sshkit = sshkit
|
||||
end
|
||||
|
||||
def run
|
||||
if KAMAL.config.error_pages_path
|
||||
with_error_pages_tmpdir do |local_error_pages_dir|
|
||||
execute *KAMAL.app.create_error_pages_directory
|
||||
upload! local_error_pages_dir, KAMAL.config.proxy_boot.error_pages_directory, mode: "0700", recursive: true
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def with_error_pages_tmpdir
|
||||
Dir.mktmpdir("kamal-error-pages") do |tmpdir|
|
||||
error_pages_dir = File.join(tmpdir, KAMAL.config.version)
|
||||
FileUtils.mkdir(error_pages_dir)
|
||||
|
||||
if (files = Dir[File.join(KAMAL.config.error_pages_path, ERROR_PAGES_GLOB)]).any?
|
||||
FileUtils.cp(files, error_pages_dir)
|
||||
yield error_pages_dir
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -5,7 +5,7 @@ module Kamal::Cli
|
||||
class Base < Thor
|
||||
include SSHKit::DSL
|
||||
|
||||
def self.exit_on_failure?() false end
|
||||
def self.exit_on_failure?() true end
|
||||
def self.dynamic_command_class() Kamal::Cli::Alias::Command end
|
||||
|
||||
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
||||
@@ -30,6 +30,7 @@ module Kamal::Cli
|
||||
else
|
||||
super
|
||||
end
|
||||
|
||||
initialize_commander unless KAMAL.configured?
|
||||
end
|
||||
|
||||
@@ -132,7 +133,13 @@ module Kamal::Cli
|
||||
|
||||
def run_hook(hook, **extra_details)
|
||||
if !options[:skip_hooks] && KAMAL.hook.hook_exists?(hook)
|
||||
details = { hosts: KAMAL.hosts.join(","), command: command, subcommand: subcommand }
|
||||
details = {
|
||||
hosts: KAMAL.hosts.join(","),
|
||||
roles: KAMAL.specific_roles&.join(","),
|
||||
lock: KAMAL.holding_lock?.to_s,
|
||||
command: command,
|
||||
subcommand: subcommand
|
||||
}.compact
|
||||
|
||||
say "Running the #{hook} hook...", :magenta
|
||||
with_env KAMAL.hook.env(**details, **extra_details) do
|
||||
@@ -146,12 +153,16 @@ module Kamal::Cli
|
||||
end
|
||||
|
||||
def on(*args, &block)
|
||||
pre_connect_if_required
|
||||
|
||||
super
|
||||
end
|
||||
|
||||
def pre_connect_if_required
|
||||
if !KAMAL.connected?
|
||||
run_hook "pre-connect"
|
||||
KAMAL.connected = true
|
||||
end
|
||||
|
||||
super
|
||||
end
|
||||
|
||||
def command
|
||||
@@ -194,5 +205,19 @@ module Kamal::Cli
|
||||
ENV.clear
|
||||
ENV.update(current_env)
|
||||
end
|
||||
|
||||
def ensure_docker_installed
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.ensure_docker_installed
|
||||
rescue SSHKit::Command::Failed => e
|
||||
error = e.message =~ /command not found/ ?
|
||||
"Docker is not installed locally" :
|
||||
"Docker buildx plugin is not installed locally"
|
||||
|
||||
raise DependencyError, error
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -5,15 +5,22 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
|
||||
desc "deliver", "Build app and push app image to registry then pull image on servers"
|
||||
def deliver
|
||||
push
|
||||
pull
|
||||
invoke :push
|
||||
invoke :pull
|
||||
end
|
||||
|
||||
desc "push", "Build and push app image to registry"
|
||||
option :output, type: :string, default: "registry", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||
def push
|
||||
cli = self
|
||||
|
||||
verify_local_dependencies
|
||||
# Ensure pre-connect hooks run before the build, they may needed for a remote builder
|
||||
# or the pre-build hooks.
|
||||
pre_connect_if_required
|
||||
|
||||
ensure_docker_installed
|
||||
login_to_registry_locally
|
||||
|
||||
run_hook "pre-build"
|
||||
|
||||
uncommitted_changes = Kamal::Git.uncommitted_changes
|
||||
@@ -49,7 +56,7 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||
push = KAMAL.builder.push
|
||||
push = KAMAL.builder.push(cli.options[:output])
|
||||
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
@@ -60,14 +67,16 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
|
||||
desc "pull", "Pull app image from registry onto servers"
|
||||
def pull
|
||||
login_to_registry_remotely
|
||||
|
||||
if (first_hosts = mirror_hosts).any?
|
||||
# Pull on a single host per mirror first to seed them
|
||||
say "Pulling image on #{first_hosts.join(", ")} to seed the #{"mirror".pluralize(first_hosts.count)}...", :magenta
|
||||
pull_on_hosts(first_hosts)
|
||||
say "Pulling image on remaining hosts...", :magenta
|
||||
pull_on_hosts(KAMAL.hosts - first_hosts)
|
||||
pull_on_hosts(KAMAL.app_hosts - first_hosts)
|
||||
else
|
||||
pull_on_hosts(KAMAL.hosts)
|
||||
pull_on_hosts(KAMAL.app_hosts)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -108,21 +117,42 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def verify_local_dependencies
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.ensure_local_dependencies_installed
|
||||
rescue SSHKit::Command::Failed => e
|
||||
build_error = e.message =~ /command not found/ ?
|
||||
"Docker is not installed locally" :
|
||||
"Docker buildx plugin is not installed locally"
|
||||
desc "dev", "Build using the working directory, tag it as dirty, and push to local image store."
|
||||
option :output, type: :string, default: "docker", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||
def dev
|
||||
cli = self
|
||||
|
||||
raise BuildError, build_error
|
||||
ensure_docker_installed
|
||||
|
||||
docker_included_files = Set.new(Kamal::Docker.included_files)
|
||||
git_uncommitted_files = Set.new(Kamal::Git.uncommitted_files)
|
||||
git_untracked_files = Set.new(Kamal::Git.untracked_files)
|
||||
|
||||
docker_uncommitted_files = docker_included_files & git_uncommitted_files
|
||||
if docker_uncommitted_files.any?
|
||||
say "WARNING: Files with uncommitted changes will be present in the dev container:", :yellow
|
||||
docker_uncommitted_files.sort.each { |f| say " #{f}", :yellow }
|
||||
say
|
||||
end
|
||||
|
||||
docker_untracked_files = docker_included_files & git_untracked_files
|
||||
if docker_untracked_files.any?
|
||||
say "WARNING: Untracked files will be present in the dev container:", :yellow
|
||||
docker_untracked_files.sort.each { |f| say " #{f}", :yellow }
|
||||
say
|
||||
end
|
||||
|
||||
with_env(KAMAL.config.builder.secrets) do
|
||||
run_locally do
|
||||
build = KAMAL.builder.push(cli.options[:output], tag_as_dirty: true)
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
execute(*build)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def connect_to_remote_host(remote_host)
|
||||
remote_uri = URI.parse(remote_host)
|
||||
if remote_uri.scheme == "ssh"
|
||||
@@ -137,9 +167,9 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
def mirror_hosts
|
||||
if KAMAL.hosts.many?
|
||||
if KAMAL.app_hosts.many?
|
||||
mirror_hosts = Concurrent::Hash.new
|
||||
on(KAMAL.hosts) do |host|
|
||||
on(KAMAL.app_hosts) do |host|
|
||||
first_mirror = capture_with_info(*KAMAL.builder.first_mirror).strip.presence
|
||||
mirror_hosts[first_mirror] ||= host.to_s if first_mirror
|
||||
rescue SSHKit::Command::Failed => e
|
||||
@@ -159,4 +189,16 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
execute *KAMAL.builder.validate_image
|
||||
end
|
||||
end
|
||||
|
||||
def login_to_registry_locally
|
||||
run_locally do
|
||||
execute *KAMAL.registry.login
|
||||
end
|
||||
end
|
||||
|
||||
def login_to_registry_remotely
|
||||
on(KAMAL.app_hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -9,21 +9,17 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
say "Ensure Docker is installed...", :magenta
|
||||
invoke "kamal:cli:server:bootstrap", [], invoke_options
|
||||
|
||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options
|
||||
deploy
|
||||
deploy(boot_accessories: true)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "deploy", "Deploy app to servers"
|
||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
||||
def deploy
|
||||
def deploy(boot_accessories: false)
|
||||
runtime = print_runtime do
|
||||
invoke_options = deploy_options
|
||||
|
||||
say "Log into image registry...", :magenta
|
||||
invoke "kamal:cli:registry:login", [], invoke_options.merge(skip_local: options[:skip_push])
|
||||
|
||||
if options[:skip_push]
|
||||
say "Pull app image...", :magenta
|
||||
invoke "kamal:cli:build:pull", [], invoke_options
|
||||
@@ -38,6 +34,8 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
say "Ensure kamal-proxy is running...", :magenta
|
||||
invoke "kamal:cli:proxy:boot", [], invoke_options
|
||||
|
||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options if boot_accessories
|
||||
|
||||
say "Detect stale containers...", :magenta
|
||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||
|
||||
@@ -51,7 +49,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s
|
||||
end
|
||||
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting kamal-proxy, pruning, and registry login"
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting kamal-proxy and pruning"
|
||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
||||
def redeploy
|
||||
runtime = print_runtime do
|
||||
@@ -196,10 +194,10 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
confirming "This will replace Traefik with kamal-proxy and restart all accessories" do
|
||||
with_lock do
|
||||
if options[:rolling]
|
||||
(KAMAL.hosts | KAMAL.accessory_hosts).each do |host|
|
||||
KAMAL.hosts.each do |host|
|
||||
KAMAL.with_specific_hosts(host) do
|
||||
say "Upgrading #{host}...", :magenta
|
||||
if KAMAL.hosts.include?(host)
|
||||
if KAMAL.app_hosts.include?(host)
|
||||
invoke "kamal:cli:proxy:upgrade", [], options.merge(confirmed: true, rolling: false)
|
||||
reset_invocation(Kamal::Cli::Proxy)
|
||||
end
|
||||
@@ -255,7 +253,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
private
|
||||
def container_available?(version)
|
||||
begin
|
||||
on(KAMAL.hosts) do
|
||||
on(KAMAL.app_hosts) do
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
container_id = capture_with_info(*KAMAL.app(role: role, host: host).container_id_for_version(version))
|
||||
raise "Container not found" unless container_id.present?
|
||||
|
||||
@@ -13,9 +13,10 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
|
||||
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
||||
|
||||
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION)
|
||||
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}"
|
||||
end
|
||||
execute *KAMAL.proxy.ensure_apps_config_directory
|
||||
execute *KAMAL.proxy.start_or_run
|
||||
end
|
||||
end
|
||||
@@ -23,30 +24,76 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
|
||||
desc "boot_config <set|get|reset>", "Manage kamal-proxy boot configuration"
|
||||
option :publish, type: :boolean, default: true, desc: "Publish the proxy ports on the host"
|
||||
option :http_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTP_PORT, desc: "HTTP port to publish on the host"
|
||||
option :https_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTPS_PORT, desc: "HTTPS port to publish on the host"
|
||||
option :log_max_size, type: :string, default: Kamal::Configuration::PROXY_LOG_MAX_SIZE, desc: "Max size of proxy logs"
|
||||
option :publish_host_ip, type: :string, repeatable: true, default: nil, desc: "Host IP address to bind HTTP/HTTPS traffic to. Defaults to all interfaces"
|
||||
option :http_port, type: :numeric, default: Kamal::Configuration::Proxy::Boot::DEFAULT_HTTP_PORT, desc: "HTTP port to publish on the host"
|
||||
option :https_port, type: :numeric, default: Kamal::Configuration::Proxy::Boot::DEFAULT_HTTPS_PORT, desc: "HTTPS port to publish on the host"
|
||||
option :log_max_size, type: :string, default: Kamal::Configuration::Proxy::Boot::DEFAULT_LOG_MAX_SIZE, desc: "Max size of proxy logs"
|
||||
option :registry, type: :string, default: nil, desc: "Registry to use for the proxy image"
|
||||
option :repository, type: :string, default: nil, desc: "Repository for the proxy image"
|
||||
option :image_version, type: :string, default: nil, desc: "Version of the proxy to run"
|
||||
option :metrics_port, type: :numeric, default: nil, desc: "Port to report prometheus metrics on"
|
||||
option :debug, type: :boolean, default: false, desc: "Whether to run the proxy in debug mode"
|
||||
option :docker_options, type: :array, default: [], desc: "Docker options to pass to the proxy container", banner: "option=value option2=value2"
|
||||
def boot_config(subcommand)
|
||||
proxy_boot_config = KAMAL.config.proxy_boot
|
||||
|
||||
case subcommand
|
||||
when "set"
|
||||
boot_options = [
|
||||
*(KAMAL.config.proxy_publish_args(options[:http_port], options[:https_port]) if options[:publish]),
|
||||
*(KAMAL.config.proxy_logging_args(options[:log_max_size])),
|
||||
*(proxy_boot_config.publish_args(options[:http_port], options[:https_port], options[:publish_host_ip]) if options[:publish]),
|
||||
*(proxy_boot_config.logging_args(options[:log_max_size])),
|
||||
*("--expose=#{options[:metrics_port]}" if options[:metrics_port]),
|
||||
*options[:docker_options].map { |option| "--#{option}" }
|
||||
]
|
||||
|
||||
image = [
|
||||
options[:registry].presence,
|
||||
options[:repository].presence || proxy_boot_config.repository_name,
|
||||
proxy_boot_config.image_name
|
||||
].compact.join("/")
|
||||
|
||||
image_version = options[:image_version]
|
||||
|
||||
run_command_options = { debug: options[:debug] || nil, "metrics-port": options[:metrics_port] }.compact
|
||||
run_command = "kamal-proxy run #{Kamal::Utils.optionize(run_command_options).join(" ")}" if run_command_options.any?
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute(*KAMAL.proxy.ensure_proxy_directory)
|
||||
upload! StringIO.new(boot_options.join(" ")), KAMAL.config.proxy_options_file
|
||||
if boot_options != proxy_boot_config.default_boot_options
|
||||
upload! StringIO.new(boot_options.join(" ")), proxy_boot_config.options_file
|
||||
else
|
||||
execute *KAMAL.proxy.reset_boot_options, raise_on_non_zero_exit: false
|
||||
end
|
||||
|
||||
if image != proxy_boot_config.image_default
|
||||
upload! StringIO.new(image), proxy_boot_config.image_file
|
||||
else
|
||||
execute *KAMAL.proxy.reset_image, raise_on_non_zero_exit: false
|
||||
end
|
||||
|
||||
if image_version
|
||||
upload! StringIO.new(image_version), proxy_boot_config.image_version_file
|
||||
else
|
||||
execute *KAMAL.proxy.reset_image_version, raise_on_non_zero_exit: false
|
||||
end
|
||||
|
||||
if run_command
|
||||
upload! StringIO.new(run_command), proxy_boot_config.run_command_file
|
||||
else
|
||||
execute *KAMAL.proxy.reset_run_command, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
when "get"
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
puts "Host #{host}: #{capture_with_info(*KAMAL.proxy.get_boot_options)}"
|
||||
puts "Host #{host}: #{capture_with_info(*KAMAL.proxy.boot_config)}"
|
||||
end
|
||||
when "reset"
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute *KAMAL.proxy.reset_boot_options
|
||||
execute *KAMAL.proxy.reset_boot_options, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.reset_image, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.reset_image_version, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.reset_run_command, raise_on_non_zero_exit: false
|
||||
end
|
||||
else
|
||||
raise ArgumentError, "Unknown boot_config subcommand #{subcommand}"
|
||||
@@ -67,26 +114,12 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
"Stopping and removing Traefik on #{host}, if running..."
|
||||
execute *KAMAL.proxy.cleanup_traefik
|
||||
|
||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.remove_container
|
||||
execute *KAMAL.proxy.ensure_apps_config_directory
|
||||
|
||||
execute *KAMAL.proxy.run
|
||||
|
||||
KAMAL.roles_on(host).select(&:running_proxy?).each do |role|
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
|
||||
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||
|
||||
if endpoint.present?
|
||||
info "Deploying #{endpoint} for role `#{role}` on #{host}..."
|
||||
execute *app.deploy(target: endpoint)
|
||||
end
|
||||
end
|
||||
end
|
||||
run_hook "post-proxy-reboot", hosts: host_list
|
||||
end
|
||||
|
||||
@@ -3,6 +3,8 @@ class Kamal::Cli::Registry < Kamal::Cli::Base
|
||||
option :skip_local, aliases: "-L", type: :boolean, default: false, desc: "Skip local login"
|
||||
option :skip_remote, aliases: "-R", type: :boolean, default: false, desc: "Skip remote login"
|
||||
def login
|
||||
ensure_docker_installed unless options[:skip_local]
|
||||
|
||||
run_locally { execute *KAMAL.registry.login } unless options[:skip_local]
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.login } unless options[:skip_remote]
|
||||
end
|
||||
|
||||
@@ -2,8 +2,10 @@ class Kamal::Cli::Server < Kamal::Cli::Base
|
||||
desc "exec", "Run a custom command on the server (use --help to show options)"
|
||||
option :interactive, type: :boolean, aliases: "-i", default: false, desc: "Run the command interactively (use for console/bash)"
|
||||
def exec(*cmd)
|
||||
pre_connect_if_required
|
||||
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
hosts = KAMAL.hosts | KAMAL.accessory_hosts
|
||||
hosts = KAMAL.hosts
|
||||
|
||||
case
|
||||
when options[:interactive]
|
||||
@@ -27,7 +29,7 @@ class Kamal::Cli::Server < Kamal::Cli::Base
|
||||
with_lock do
|
||||
missing = []
|
||||
|
||||
on(KAMAL.hosts | KAMAL.accessory_hosts) do |host|
|
||||
on(KAMAL.hosts) do |host|
|
||||
unless execute(*KAMAL.docker.installed?, raise_on_non_zero_exit: false)
|
||||
if execute(*KAMAL.docker.superuser?, raise_on_non_zero_exit: false)
|
||||
info "Missing Docker on #{host}. Installing…"
|
||||
|
||||
@@ -38,7 +38,7 @@ builder:
|
||||
arch: amd64
|
||||
# Pass in additional build args needed for your Dockerfile.
|
||||
# args:
|
||||
# RUBY_VERSION: <%= File.read('.ruby-version').strip %>
|
||||
# RUBY_VERSION: <%= ENV["RBENV_VERSION"] || ENV["rvm_ruby_string"] || "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}" %>
|
||||
|
||||
# Inject ENV variables into containers (secrets come from .kamal/secrets).
|
||||
#
|
||||
@@ -49,7 +49,7 @@ builder:
|
||||
# - RAILS_MASTER_KEY
|
||||
|
||||
# Aliases are triggered with "bin/kamal <alias>". You can overwrite arguments on invocation:
|
||||
# "bin/kamal logs -r job" will tail logs from the first server in the job section.
|
||||
# "bin/kamal app logs -r job" will tail logs from the first server in the job section.
|
||||
#
|
||||
# aliases:
|
||||
# shell: app exec --interactive --reuse "bash"
|
||||
|
||||
3
lib/kamal/cli/templates/sample_hooks/post-app-boot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/post-app-boot.sample
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||
@@ -7,7 +7,7 @@
|
||||
# KAMAL_PERFORMER
|
||||
# KAMAL_VERSION
|
||||
# KAMAL_HOSTS
|
||||
# KAMAL_ROLE (if set)
|
||||
# KAMAL_ROLES (if set)
|
||||
# KAMAL_DESTINATION (if set)
|
||||
# KAMAL_RUNTIME
|
||||
|
||||
|
||||
3
lib/kamal/cli/templates/sample_hooks/pre-app-boot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/pre-app-boot.sample
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||
@@ -13,7 +13,7 @@
|
||||
# KAMAL_PERFORMER
|
||||
# KAMAL_VERSION
|
||||
# KAMAL_HOSTS
|
||||
# KAMAL_ROLE (if set)
|
||||
# KAMAL_ROLES (if set)
|
||||
# KAMAL_DESTINATION (if set)
|
||||
|
||||
if [ -n "$(git status --porcelain)" ]; then
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
# KAMAL_PERFORMER
|
||||
# KAMAL_VERSION
|
||||
# KAMAL_HOSTS
|
||||
# KAMAL_ROLE (if set)
|
||||
# KAMAL_ROLES (if set)
|
||||
# KAMAL_DESTINATION (if set)
|
||||
# KAMAL_RUNTIME
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
# KAMAL_HOSTS
|
||||
# KAMAL_COMMAND
|
||||
# KAMAL_SUBCOMMAND
|
||||
# KAMAL_ROLE (if set)
|
||||
# KAMAL_ROLES (if set)
|
||||
# KAMAL_DESTINATION (if set)
|
||||
|
||||
# Only check the build status for production deployments
|
||||
@@ -82,11 +82,12 @@ end
|
||||
|
||||
$stdout.sync = true
|
||||
|
||||
puts "Checking build status..."
|
||||
attempts = 0
|
||||
checks = GithubStatusChecks.new
|
||||
|
||||
begin
|
||||
puts "Checking build status..."
|
||||
|
||||
attempts = 0
|
||||
checks = GithubStatusChecks.new
|
||||
|
||||
loop do
|
||||
case checks.state
|
||||
when "success"
|
||||
|
||||
@@ -4,13 +4,20 @@ require "active_support/core_ext/object/blank"
|
||||
|
||||
class Kamal::Commander
|
||||
attr_accessor :verbosity, :holding_lock, :connected
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :proxy_hosts, :accessory_hosts, to: :specifics
|
||||
attr_reader :specific_roles, :specific_hosts
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :app_hosts, :proxy_hosts, :accessory_hosts, to: :specifics
|
||||
|
||||
def initialize
|
||||
reset
|
||||
end
|
||||
|
||||
def reset
|
||||
self.verbosity = :info
|
||||
self.holding_lock = false
|
||||
self.holding_lock = ENV["KAMAL_LOCK"] == "true"
|
||||
self.connected = false
|
||||
@specifics = nil
|
||||
@specifics = @specific_roles = @specific_hosts = nil
|
||||
@config = @config_kwargs = nil
|
||||
@commands = {}
|
||||
end
|
||||
|
||||
def config
|
||||
@@ -28,8 +35,6 @@ class Kamal::Commander
|
||||
@config || @config_kwargs
|
||||
end
|
||||
|
||||
attr_reader :specific_roles, :specific_hosts
|
||||
|
||||
def specific_primary!
|
||||
@specifics = nil
|
||||
if specific_roles.present?
|
||||
@@ -76,11 +81,6 @@ class Kamal::Commander
|
||||
config.accessories&.collect(&:name) || []
|
||||
end
|
||||
|
||||
def accessories_on(host)
|
||||
config.accessories.select { |accessory| accessory.hosts.include?(host.to_s) }.map(&:name)
|
||||
end
|
||||
|
||||
|
||||
def app(role: nil, host: nil)
|
||||
Kamal::Commands::App.new(config, role: role, host: host)
|
||||
end
|
||||
@@ -94,42 +94,41 @@ class Kamal::Commander
|
||||
end
|
||||
|
||||
def builder
|
||||
@builder ||= Kamal::Commands::Builder.new(config)
|
||||
@commands[:builder] ||= Kamal::Commands::Builder.new(config)
|
||||
end
|
||||
|
||||
def docker
|
||||
@docker ||= Kamal::Commands::Docker.new(config)
|
||||
@commands[:docker] ||= Kamal::Commands::Docker.new(config)
|
||||
end
|
||||
|
||||
def hook
|
||||
@hook ||= Kamal::Commands::Hook.new(config)
|
||||
@commands[:hook] ||= Kamal::Commands::Hook.new(config)
|
||||
end
|
||||
|
||||
def lock
|
||||
@lock ||= Kamal::Commands::Lock.new(config)
|
||||
@commands[:lock] ||= Kamal::Commands::Lock.new(config)
|
||||
end
|
||||
|
||||
def proxy
|
||||
@proxy ||= Kamal::Commands::Proxy.new(config)
|
||||
@commands[:proxy] ||= Kamal::Commands::Proxy.new(config)
|
||||
end
|
||||
|
||||
def prune
|
||||
@prune ||= Kamal::Commands::Prune.new(config)
|
||||
@commands[:prune] ||= Kamal::Commands::Prune.new(config)
|
||||
end
|
||||
|
||||
def registry
|
||||
@registry ||= Kamal::Commands::Registry.new(config)
|
||||
@commands[:registry] ||= Kamal::Commands::Registry.new(config)
|
||||
end
|
||||
|
||||
def server
|
||||
@server ||= Kamal::Commands::Server.new(config)
|
||||
@commands[:server] ||= Kamal::Commands::Server.new(config)
|
||||
end
|
||||
|
||||
def alias(name)
|
||||
config.aliases[name]
|
||||
end
|
||||
|
||||
|
||||
def with_verbosity(level)
|
||||
old_level = self.verbosity
|
||||
|
||||
@@ -142,14 +141,6 @@ class Kamal::Commander
|
||||
SSHKit.config.output_verbosity = old_level
|
||||
end
|
||||
|
||||
def boot_strategy
|
||||
if config.boot.limit.present?
|
||||
{ in: :groups, limit: config.boot.limit, wait: config.boot.wait }
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
def holding_lock?
|
||||
self.holding_lock
|
||||
end
|
||||
|
||||
@@ -11,13 +11,17 @@ class Kamal::Commander::Specifics
|
||||
@primary_role = primary_or_first_role(roles_on(primary_host))
|
||||
|
||||
stable_sort!(roles) { |role| role == primary_role ? 0 : 1 }
|
||||
stable_sort!(hosts) { |host| roles_on(host).any? { |role| role == primary_role } ? 0 : 1 }
|
||||
sort_primary_role_hosts_first!(hosts)
|
||||
end
|
||||
|
||||
def roles_on(host)
|
||||
roles.select { |role| role.hosts.include?(host.to_s) }
|
||||
end
|
||||
|
||||
def app_hosts
|
||||
@app_hosts ||= sort_primary_role_hosts_first!(config.app_hosts & specified_hosts)
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
config.proxy_hosts & specified_hosts
|
||||
end
|
||||
@@ -51,4 +55,8 @@ class Kamal::Commander::Specifics
|
||||
specified_hosts
|
||||
end
|
||||
end
|
||||
|
||||
def sort_primary_role_hosts_first!(hosts)
|
||||
stable_sort!(hosts) { |host| roles_on(host).any? { |role| role == primary_role } ? 0 : 1 }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,10 +4,8 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
attr_reader :accessory_config
|
||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||
:secrets_io, :secrets_path, :env_directory, :proxy, :running_proxy?,
|
||||
:secrets_io, :secrets_path, :env_directory, :proxy, :running_proxy?, :registry,
|
||||
to: :accessory_config
|
||||
delegate :proxy_container_name, to: :config
|
||||
|
||||
|
||||
def initialize(config, name:)
|
||||
super(config)
|
||||
@@ -38,11 +36,10 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :container, :stop, service_name
|
||||
end
|
||||
|
||||
def info
|
||||
docker :ps, *service_filter
|
||||
def info(all: false, quiet: false)
|
||||
docker :ps, *("-a" if all), *("-q" if quiet), *service_filter
|
||||
end
|
||||
|
||||
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||
@@ -56,7 +53,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
end
|
||||
|
||||
|
||||
def execute_in_existing_container(*command, interactive: false)
|
||||
docker :exec,
|
||||
("-it" if interactive),
|
||||
@@ -87,7 +83,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
super command, host: hosts.first
|
||||
end
|
||||
|
||||
|
||||
def ensure_local_file_present(local_file)
|
||||
if !local_file.is_a?(StringIO) && !Pathname.new(local_file).exist?
|
||||
raise "Missing file: #{local_file}"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
module Kamal::Commands::Accessory::Proxy
|
||||
delegate :proxy_container_name, to: :config
|
||||
delegate :container_name, to: :"config.proxy_boot", prefix: :proxy
|
||||
|
||||
def deploy(target:)
|
||||
proxy_exec :deploy, service_name, *proxy.deploy_command_args(target: target)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
class Kamal::Commands::App < Kamal::Commands::Base
|
||||
include Assets, Containers, Execution, Images, Logging, Proxy
|
||||
include Assets, Containers, ErrorPages, Execution, Images, Logging, Proxy
|
||||
|
||||
ACTIVE_DOCKER_STATUSES = [ :running, :restarting ]
|
||||
|
||||
|
||||
@@ -4,10 +4,10 @@ module Kamal::Commands::App::Assets
|
||||
|
||||
combine \
|
||||
make_directory(role.asset_extracted_directory),
|
||||
[ *docker(:stop, "-t 1", asset_container, "2> /dev/null"), "|| true" ],
|
||||
docker(:run, "--name", asset_container, "--detach", "--rm", "--entrypoint", "sleep", config.absolute_image, "1000000"),
|
||||
docker(:cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_directory),
|
||||
docker(:stop, "-t 1", asset_container),
|
||||
[ *docker(:container, :rm, asset_container, "2> /dev/null"), "|| true" ],
|
||||
docker(:container, :create, "--name", asset_container, config.absolute_image),
|
||||
docker(:container, :cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_directory),
|
||||
docker(:container, :rm, asset_container),
|
||||
by: "&&"
|
||||
end
|
||||
|
||||
|
||||
9
lib/kamal/commands/app/error_pages.rb
Normal file
9
lib/kamal/commands/app/error_pages.rb
Normal file
@@ -0,0 +1,9 @@
|
||||
module Kamal::Commands::App::ErrorPages
|
||||
def create_error_pages_directory
|
||||
make_directory(config.proxy_boot.error_pages_directory)
|
||||
end
|
||||
|
||||
def clean_up_error_pages
|
||||
[ :find, config.proxy_boot.error_pages_directory, "-mindepth", "1", "-maxdepth", "1", "!", "-name", KAMAL.config.version, "-exec", "rm", "-rf", "{} +" ]
|
||||
end
|
||||
end
|
||||
@@ -1,5 +1,5 @@
|
||||
module Kamal::Commands::App::Proxy
|
||||
delegate :proxy_container_name, to: :config
|
||||
delegate :container_name, to: :"config.proxy_boot", prefix: :proxy
|
||||
|
||||
def deploy(target:)
|
||||
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
||||
@@ -9,6 +9,18 @@ module Kamal::Commands::App::Proxy
|
||||
proxy_exec :remove, role.container_prefix
|
||||
end
|
||||
|
||||
def live
|
||||
proxy_exec :resume, role.container_prefix
|
||||
end
|
||||
|
||||
def maintenance(**options)
|
||||
proxy_exec :stop, role.container_prefix, *role.proxy.stop_command_args(**options)
|
||||
end
|
||||
|
||||
def remove_proxy_app_directory
|
||||
remove_directory config.proxy_boot.app_directory
|
||||
end
|
||||
|
||||
private
|
||||
def proxy_exec(*command)
|
||||
docker :exec, proxy_container_name, "kamal-proxy", *command
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
class Kamal::Commands::Auditor < Kamal::Commands::Base
|
||||
attr_reader :details
|
||||
delegate :escape_shell_value, to: Kamal::Utils
|
||||
|
||||
def initialize(config, **details)
|
||||
super(config)
|
||||
@@ -9,11 +10,8 @@ class Kamal::Commands::Auditor < Kamal::Commands::Base
|
||||
# Runs remotely
|
||||
def record(line, **details)
|
||||
combine \
|
||||
[ :mkdir, "-p", config.run_directory ],
|
||||
append(
|
||||
[ :echo, audit_tags(**details).except(:version, :service_version, :service).to_s, line ],
|
||||
audit_log_file
|
||||
)
|
||||
make_run_directory,
|
||||
append([ :echo, escape_shell_value(audit_line(line, **details)) ], audit_log_file)
|
||||
end
|
||||
|
||||
def reveal
|
||||
@@ -30,4 +28,12 @@ class Kamal::Commands::Auditor < Kamal::Commands::Base
|
||||
def audit_tags(**details)
|
||||
tags(**self.details, **details)
|
||||
end
|
||||
|
||||
def make_run_directory
|
||||
[ :mkdir, "-p", config.run_directory ]
|
||||
end
|
||||
|
||||
def audit_line(line, **details)
|
||||
"#{audit_tags(**details).except(:version, :service_version, :service)} #{line}"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -34,6 +34,12 @@ module Kamal::Commands
|
||||
[ :rm, path ]
|
||||
end
|
||||
|
||||
def ensure_docker_installed
|
||||
combine \
|
||||
ensure_local_docker_installed,
|
||||
ensure_local_buildx_installed
|
||||
end
|
||||
|
||||
private
|
||||
def combine(*commands, by: "&&")
|
||||
commands
|
||||
@@ -62,6 +68,10 @@ module Kamal::Commands
|
||||
combine *commands, by: "||"
|
||||
end
|
||||
|
||||
def substitute(*commands)
|
||||
"\$\(#{commands.join(" ")}\)"
|
||||
end
|
||||
|
||||
def xargs(command)
|
||||
[ :xargs, command ].flatten
|
||||
end
|
||||
@@ -104,5 +114,13 @@ module Kamal::Commands
|
||||
" -i #{key}"
|
||||
end
|
||||
end
|
||||
|
||||
def ensure_local_docker_installed
|
||||
docker "--version"
|
||||
end
|
||||
|
||||
def ensure_local_buildx_installed
|
||||
docker :buildx, "version"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
require "active_support/core_ext/string/filters"
|
||||
|
||||
class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
delegate :create, :remove, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
||||
delegate :local?, :remote?, to: "config.builder"
|
||||
delegate :create, :remove, :dev, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
||||
delegate :local?, :remote?, :cloud?, to: "config.builder"
|
||||
|
||||
include Clone
|
||||
|
||||
@@ -17,6 +17,8 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
else
|
||||
remote
|
||||
end
|
||||
elsif cloud?
|
||||
cloud
|
||||
else
|
||||
local
|
||||
end
|
||||
@@ -34,23 +36,7 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
@hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
|
||||
end
|
||||
|
||||
|
||||
def ensure_local_dependencies_installed
|
||||
if name.native?
|
||||
ensure_local_docker_installed
|
||||
else
|
||||
combine \
|
||||
ensure_local_docker_installed,
|
||||
ensure_local_buildx_installed
|
||||
end
|
||||
def cloud
|
||||
@cloud ||= Kamal::Commands::Builder::Cloud.new(config)
|
||||
end
|
||||
|
||||
private
|
||||
def ensure_local_docker_installed
|
||||
docker "--version"
|
||||
end
|
||||
|
||||
def ensure_local_buildx_installed
|
||||
docker :buildx, "version"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -13,13 +13,15 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
docker :image, :rm, "--force", config.absolute_image
|
||||
end
|
||||
|
||||
def push
|
||||
def push(export_action = "registry", tag_as_dirty: false)
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
"--output=type=#{export_action}",
|
||||
*platform_options(arches),
|
||||
*([ "--builder", builder_name ] unless docker_driver?),
|
||||
*build_tag_options(tag_as_dirty: tag_as_dirty),
|
||||
*build_options,
|
||||
build_context
|
||||
build_context,
|
||||
"2>&1"
|
||||
end
|
||||
|
||||
def pull
|
||||
@@ -37,7 +39,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def build_options
|
||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||
[ *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||
end
|
||||
|
||||
def build_context
|
||||
@@ -58,8 +60,14 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
private
|
||||
def build_tags
|
||||
[ "-t", config.absolute_image, "-t", config.latest_image ]
|
||||
def build_tag_names(tag_as_dirty: false)
|
||||
tag_names = [ config.absolute_image, config.latest_image ]
|
||||
tag_names.map! { |t| "#{t}-dirty" } if tag_as_dirty
|
||||
tag_names
|
||||
end
|
||||
|
||||
def build_tag_options(tag_as_dirty: false)
|
||||
build_tag_names(tag_as_dirty: tag_as_dirty).flat_map { |name| [ "-t", name ] }
|
||||
end
|
||||
|
||||
def build_cache
|
||||
|
||||
22
lib/kamal/commands/builder/cloud.rb
Normal file
22
lib/kamal/commands/builder/cloud.rb
Normal file
@@ -0,0 +1,22 @@
|
||||
class Kamal::Commands::Builder::Cloud < Kamal::Commands::Builder::Base
|
||||
# Expects `driver` to be of format "cloud docker-org-name/builder-name"
|
||||
|
||||
def create
|
||||
docker :buildx, :create, "--driver", driver
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
driver.gsub(/[ \/]/, "-")
|
||||
end
|
||||
|
||||
def inspect_buildx
|
||||
pipe \
|
||||
docker(:buildx, :inspect, builder_name),
|
||||
grep("-q", "Endpoint:.*cloud://.*")
|
||||
end
|
||||
end
|
||||
@@ -2,14 +2,7 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
def run
|
||||
docker :run,
|
||||
"--name", container_name,
|
||||
"--network", "kamal",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
||||
"\$\(#{get_boot_options.join(" ")}\)",
|
||||
config.proxy_image
|
||||
pipe boot_config, xargs(docker_run)
|
||||
end
|
||||
|
||||
def start
|
||||
@@ -31,7 +24,7 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
def version
|
||||
pipe \
|
||||
docker(:inspect, container_name, "--format '{{.Config.Image}}'"),
|
||||
[ :cut, "-d:", "-f2" ]
|
||||
[ :awk, "-F:", "'{print \$NF}'" ]
|
||||
end
|
||||
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
@@ -65,23 +58,70 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def ensure_proxy_directory
|
||||
make_directory config.proxy_directory
|
||||
make_directory config.proxy_boot.host_directory
|
||||
end
|
||||
|
||||
def remove_proxy_directory
|
||||
remove_directory config.proxy_directory
|
||||
remove_directory config.proxy_boot.host_directory
|
||||
end
|
||||
|
||||
def get_boot_options
|
||||
combine [ :cat, config.proxy_options_file ], [ :echo, "\"#{config.proxy_options_default.join(" ")}\"" ], by: "||"
|
||||
def ensure_apps_config_directory
|
||||
make_directory config.proxy_boot.apps_directory
|
||||
end
|
||||
|
||||
def boot_config
|
||||
[ :echo, "#{substitute(read_boot_options)} #{substitute(read_image)}:#{substitute(read_image_version)} #{substitute(read_run_command)}" ]
|
||||
end
|
||||
|
||||
def read_boot_options
|
||||
read_file(config.proxy_boot.options_file, default: config.proxy_boot.default_boot_options.join(" "))
|
||||
end
|
||||
|
||||
def read_image
|
||||
read_file(config.proxy_boot.image_file, default: config.proxy_boot.image_default)
|
||||
end
|
||||
|
||||
def read_image_version
|
||||
read_file(config.proxy_boot.image_version_file, default: Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION)
|
||||
end
|
||||
|
||||
def read_run_command
|
||||
read_file(config.proxy_boot.run_command_file)
|
||||
end
|
||||
|
||||
def reset_boot_options
|
||||
remove_file config.proxy_options_file
|
||||
remove_file config.proxy_boot.options_file
|
||||
end
|
||||
|
||||
def reset_image
|
||||
remove_file config.proxy_boot.image_file
|
||||
end
|
||||
|
||||
def reset_image_version
|
||||
remove_file config.proxy_boot.image_version_file
|
||||
end
|
||||
|
||||
def reset_run_command
|
||||
remove_file config.proxy_boot.run_command_file
|
||||
end
|
||||
|
||||
private
|
||||
def container_name
|
||||
config.proxy_container_name
|
||||
config.proxy_boot.container_name
|
||||
end
|
||||
|
||||
def read_file(file, default: nil)
|
||||
combine [ :cat, file, "2>", "/dev/null" ], [ :echo, "\"#{default}\"" ], by: "||"
|
||||
end
|
||||
|
||||
def docker_run
|
||||
docker \
|
||||
:run,
|
||||
"--name", container_name,
|
||||
"--network", "kamal",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
||||
*config.proxy_boot.apps_volume.docker_args
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,14 +1,16 @@
|
||||
class Kamal::Commands::Registry < Kamal::Commands::Base
|
||||
delegate :registry, to: :config
|
||||
def login(registry_config: nil)
|
||||
registry_config ||= config.registry
|
||||
|
||||
def login
|
||||
docker :login,
|
||||
registry.server,
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry.username)),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry.password))
|
||||
registry_config.server,
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry_config.username)),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry_config.password))
|
||||
end
|
||||
|
||||
def logout
|
||||
docker :logout, registry.server
|
||||
def logout(registry_config: nil)
|
||||
registry_config ||= config.registry
|
||||
|
||||
docker :logout, registry_config.server
|
||||
end
|
||||
end
|
||||
|
||||
@@ -10,15 +10,10 @@ class Kamal::Configuration
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :destination, :raw_config, :secrets
|
||||
attr_reader :accessories, :aliases, :boot, :builder, :env, :logging, :proxy, :servers, :ssh, :sshkit, :registry
|
||||
attr_reader :accessories, :aliases, :boot, :builder, :env, :logging, :proxy, :proxy_boot, :servers, :ssh, :sshkit, :registry
|
||||
|
||||
include Validation
|
||||
|
||||
PROXY_MINIMUM_VERSION = "v0.8.4"
|
||||
PROXY_HTTP_PORT = 80
|
||||
PROXY_HTTPS_PORT = 443
|
||||
PROXY_LOG_MAX_SIZE = "10m"
|
||||
|
||||
class << self
|
||||
def create_from(config_file:, destination: nil, version: nil)
|
||||
ENV["KAMAL_DESTINATION"] = destination
|
||||
@@ -59,7 +54,7 @@ class Kamal::Configuration
|
||||
|
||||
# Eager load config to validate it, these are first as they have dependencies later on
|
||||
@servers = Servers.new(config: self)
|
||||
@registry = Registry.new(config: self)
|
||||
@registry = Registry.new(config: @raw_config, secrets: secrets)
|
||||
|
||||
@accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
|
||||
@aliases = @raw_config.aliases&.keys&.to_h { |name| [ name, Alias.new(name, config: self) ] } || {}
|
||||
@@ -68,7 +63,8 @@ class Kamal::Configuration
|
||||
@env = Env.new(config: @raw_config.env || {}, secrets: secrets)
|
||||
|
||||
@logging = Logging.new(logging_config: @raw_config.logging)
|
||||
@proxy = Proxy.new(config: self, proxy_config: @raw_config.proxy || {})
|
||||
@proxy = Proxy.new(config: self, proxy_config: @raw_config.proxy)
|
||||
@proxy_boot = Proxy::Boot.new(config: self)
|
||||
@ssh = Ssh.new(config: self)
|
||||
@sshkit = Sshkit.new(config: self)
|
||||
|
||||
@@ -82,7 +78,6 @@ class Kamal::Configuration
|
||||
ensure_unique_hosts_for_ssl_roles
|
||||
end
|
||||
|
||||
|
||||
def version=(version)
|
||||
@declared_version = version
|
||||
end
|
||||
@@ -106,6 +101,9 @@ class Kamal::Configuration
|
||||
raw_config.minimum_version
|
||||
end
|
||||
|
||||
def service_and_destination
|
||||
[ service, destination ].compact.join("-")
|
||||
end
|
||||
|
||||
def roles
|
||||
servers.roles
|
||||
@@ -119,11 +117,14 @@ class Kamal::Configuration
|
||||
accessories.detect { |a| a.name == name.to_s }
|
||||
end
|
||||
|
||||
|
||||
def all_hosts
|
||||
(roles + accessories).flat_map(&:hosts).uniq
|
||||
end
|
||||
|
||||
def app_hosts
|
||||
roles.flat_map(&:hosts).uniq
|
||||
end
|
||||
|
||||
def primary_host
|
||||
primary_role&.primary_host
|
||||
end
|
||||
@@ -148,8 +149,12 @@ class Kamal::Configuration
|
||||
proxy_roles.flat_map(&:name)
|
||||
end
|
||||
|
||||
def proxy_accessories
|
||||
accessories.select(&:running_proxy?)
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
proxy_roles.flat_map(&:hosts).uniq
|
||||
(proxy_roles.flat_map(&:hosts) + proxy_accessories.flat_map(&:hosts)).uniq
|
||||
end
|
||||
|
||||
def repository
|
||||
@@ -180,7 +185,6 @@ class Kamal::Configuration
|
||||
raw_config.retain_containers || 5
|
||||
end
|
||||
|
||||
|
||||
def volume_args
|
||||
if raw_config.volumes.present?
|
||||
argumentize "--volume", raw_config.volumes
|
||||
@@ -193,7 +197,6 @@ class Kamal::Configuration
|
||||
logging.args
|
||||
end
|
||||
|
||||
|
||||
def readiness_delay
|
||||
raw_config.readiness_delay || 7
|
||||
end
|
||||
@@ -206,7 +209,6 @@ class Kamal::Configuration
|
||||
raw_config.drain_timeout || 30
|
||||
end
|
||||
|
||||
|
||||
def run_directory
|
||||
".kamal"
|
||||
end
|
||||
@@ -216,7 +218,7 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
def app_directory
|
||||
File.join apps_directory, [ service, destination ].compact.join("-")
|
||||
File.join apps_directory, service_and_destination
|
||||
end
|
||||
|
||||
def env_directory
|
||||
@@ -227,7 +229,6 @@ class Kamal::Configuration
|
||||
File.join app_directory, "assets"
|
||||
end
|
||||
|
||||
|
||||
def hooks_path
|
||||
raw_config.hooks_path || ".kamal/hooks"
|
||||
end
|
||||
@@ -236,6 +237,9 @@ class Kamal::Configuration
|
||||
raw_config.asset_path
|
||||
end
|
||||
|
||||
def error_pages_path
|
||||
raw_config.error_pages_path
|
||||
end
|
||||
|
||||
def env_tags
|
||||
@env_tags ||= if (tags = raw_config.env["tags"])
|
||||
@@ -249,35 +253,6 @@ class Kamal::Configuration
|
||||
env_tags.detect { |t| t.name == name.to_s }
|
||||
end
|
||||
|
||||
def proxy_publish_args(http_port, https_port)
|
||||
argumentize "--publish", [ "#{http_port}:#{PROXY_HTTP_PORT}", "#{https_port}:#{PROXY_HTTPS_PORT}" ]
|
||||
end
|
||||
|
||||
def proxy_logging_args(max_size)
|
||||
argumentize "--log-opt", "max-size=#{max_size}" if max_size.present?
|
||||
end
|
||||
|
||||
def proxy_options_default
|
||||
[ *proxy_publish_args(PROXY_HTTP_PORT, PROXY_HTTPS_PORT), *proxy_logging_args(PROXY_LOG_MAX_SIZE) ]
|
||||
end
|
||||
|
||||
def proxy_image
|
||||
"basecamp/kamal-proxy:#{PROXY_MINIMUM_VERSION}"
|
||||
end
|
||||
|
||||
def proxy_container_name
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def proxy_directory
|
||||
File.join run_directory, "proxy"
|
||||
end
|
||||
|
||||
def proxy_options_file
|
||||
File.join proxy_directory, "options"
|
||||
end
|
||||
|
||||
|
||||
def to_h
|
||||
{
|
||||
roles: role_names,
|
||||
@@ -307,22 +282,26 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
def ensure_required_keys_present
|
||||
%i[ service image registry servers ].each do |key|
|
||||
%i[ service image registry ].each do |key|
|
||||
raise Kamal::ConfigurationError, "Missing required configuration for #{key}" unless raw_config[key].present?
|
||||
end
|
||||
|
||||
unless role(primary_role_name).present?
|
||||
raise Kamal::ConfigurationError, "The primary_role #{primary_role_name} isn't defined"
|
||||
end
|
||||
if raw_config.servers.nil?
|
||||
raise Kamal::ConfigurationError, "No servers or accessories specified" unless raw_config.accessories.present?
|
||||
else
|
||||
unless role(primary_role_name).present?
|
||||
raise Kamal::ConfigurationError, "The primary_role #{primary_role_name} isn't defined"
|
||||
end
|
||||
|
||||
if primary_role.hosts.empty?
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{primary_role.name} primary_role"
|
||||
end
|
||||
if primary_role.hosts.empty?
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{primary_role.name} primary_role"
|
||||
end
|
||||
|
||||
unless allow_empty_roles?
|
||||
roles.each do |role|
|
||||
if role.hosts.empty?
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
|
||||
unless allow_empty_roles?
|
||||
roles.each do |role|
|
||||
if role.hosts.empty?
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -5,7 +5,7 @@ class Kamal::Configuration::Accessory
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :name, :accessory_config, :env, :proxy
|
||||
attr_reader :name, :env, :proxy, :registry
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
||||
@@ -16,12 +16,11 @@ class Kamal::Configuration::Accessory
|
||||
context: "accessories/#{name}",
|
||||
with: Kamal::Configuration::Validator::Accessory
|
||||
|
||||
@env = Kamal::Configuration::Env.new \
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/env"
|
||||
ensure_valid_roles
|
||||
|
||||
initialize_proxy if running_proxy?
|
||||
@env = initialize_env
|
||||
@proxy = initialize_proxy if running_proxy?
|
||||
@registry = initialize_registry if accessory_config["registry"].present?
|
||||
end
|
||||
|
||||
def service_name
|
||||
@@ -29,11 +28,11 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def image
|
||||
accessory_config["image"]
|
||||
[ registry&.server, accessory_config["image"] ].compact.join("/")
|
||||
end
|
||||
|
||||
def hosts
|
||||
hosts_from_host || hosts_from_hosts || hosts_from_roles
|
||||
hosts_from_host || hosts_from_hosts || hosts_from_roles || hosts_from_tags
|
||||
end
|
||||
|
||||
def port
|
||||
@@ -109,18 +108,32 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def running_proxy?
|
||||
@accessory_config["proxy"].present?
|
||||
end
|
||||
|
||||
def initialize_proxy
|
||||
@proxy = Kamal::Configuration::Proxy.new \
|
||||
config: config,
|
||||
proxy_config: accessory_config["proxy"],
|
||||
context: "accessories/#{name}/proxy"
|
||||
accessory_config["proxy"].present?
|
||||
end
|
||||
|
||||
private
|
||||
attr_accessor :config
|
||||
attr_reader :config, :accessory_config
|
||||
|
||||
def initialize_env
|
||||
Kamal::Configuration::Env.new \
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/env"
|
||||
end
|
||||
|
||||
def initialize_proxy
|
||||
Kamal::Configuration::Proxy.new \
|
||||
config: config,
|
||||
proxy_config: accessory_config["proxy"],
|
||||
context: "accessories/#{name}/proxy"
|
||||
end
|
||||
|
||||
def initialize_registry
|
||||
Kamal::Configuration::Registry.new \
|
||||
config: accessory_config,
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/registry"
|
||||
end
|
||||
|
||||
def default_labels
|
||||
{ "service" => service_name }
|
||||
@@ -188,9 +201,27 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def hosts_from_roles
|
||||
if accessory_config.key?("roles")
|
||||
accessory_config["roles"].flat_map do |role|
|
||||
config.role(role)&.hosts || raise(Kamal::ConfigurationError, "Unknown role in accessories config: '#{role}'")
|
||||
if accessory_config.key?("role")
|
||||
config.role(accessory_config["role"])&.hosts
|
||||
elsif accessory_config.key?("roles")
|
||||
accessory_config["roles"].flat_map { |role| config.role(role)&.hosts }
|
||||
end
|
||||
end
|
||||
|
||||
def hosts_from_tags
|
||||
if accessory_config.key?("tag")
|
||||
extract_hosts_from_config_with_tag(accessory_config["tag"])
|
||||
elsif accessory_config.key?("tags")
|
||||
accessory_config["tags"].flat_map { |tag| extract_hosts_from_config_with_tag(tag) }
|
||||
end
|
||||
end
|
||||
|
||||
def extract_hosts_from_config_with_tag(tag)
|
||||
if (servers_with_roles = config.raw_config.servers).is_a?(Hash)
|
||||
servers_with_roles.flat_map do |role, servers_in_role|
|
||||
servers_in_role.filter_map do |host|
|
||||
host.keys.first if host.is_a?(Hash) && host.values.first.include?(tag)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -198,4 +229,12 @@ class Kamal::Configuration::Accessory
|
||||
def network
|
||||
accessory_config["network"] || DEFAULT_NETWORK
|
||||
end
|
||||
|
||||
def ensure_valid_roles
|
||||
if accessory_config["roles"] && (missing_roles = accessory_config["roles"] - config.roles.map(&:name)).any?
|
||||
raise Kamal::ConfigurationError, "accessories/#{name}: unknown roles #{missing_roles.join(", ")}"
|
||||
elsif accessory_config["role"] && !config.role(accessory_config["role"])
|
||||
raise Kamal::ConfigurationError, "accessories/#{name}: unknown role #{accessory_config["role"]}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -53,6 +53,10 @@ class Kamal::Configuration::Builder
|
||||
!local_disabled? && (arches.empty? || local_arches.any?)
|
||||
end
|
||||
|
||||
def cloud?
|
||||
driver.start_with? "cloud"
|
||||
end
|
||||
|
||||
def cached?
|
||||
!!builder_config["cache"]
|
||||
end
|
||||
|
||||
@@ -23,18 +23,41 @@ accessories:
|
||||
|
||||
# Image
|
||||
#
|
||||
# The Docker image to use, prefix it with a registry if not using Docker Hub:
|
||||
# The Docker image to use.
|
||||
# Prefix it with its server when using root level registry different from Docker Hub.
|
||||
# Define registry directly or via anchors when it differs from root level registry.
|
||||
image: mysql:8.0
|
||||
|
||||
# Registry
|
||||
#
|
||||
# By default accessories use Docker Hub registry.
|
||||
# You can specify different registry per accessory with this option.
|
||||
# Don't prefix image with this registry server.
|
||||
# Use anchors if you need to set the same specific registry for several accessories.
|
||||
#
|
||||
# ```yml
|
||||
# registry:
|
||||
# <<: *specific-registry
|
||||
# ```
|
||||
#
|
||||
# See kamal docs registry for more information:
|
||||
registry:
|
||||
...
|
||||
|
||||
# Accessory hosts
|
||||
#
|
||||
# Specify one of `host`, `hosts`, or `roles`:
|
||||
# Specify one of `host`, `hosts`, `role`, `roles`, `tag` or `tags`:
|
||||
host: mysql-db1
|
||||
hosts:
|
||||
- mysql-db1
|
||||
- mysql-db2
|
||||
role: mysql
|
||||
roles:
|
||||
- mysql
|
||||
tag: writer
|
||||
tags:
|
||||
- writer
|
||||
- reader
|
||||
|
||||
# Custom command
|
||||
#
|
||||
@@ -100,5 +123,6 @@ accessories:
|
||||
|
||||
# Proxy
|
||||
#
|
||||
# You can run your accessory behind the Kamal proxy. See kamal docs proxy for more information
|
||||
proxy:
|
||||
...
|
||||
|
||||
@@ -102,6 +102,9 @@ builder:
|
||||
#
|
||||
# The build driver to use, defaults to `docker-container`:
|
||||
driver: docker
|
||||
#
|
||||
# If you want to use Docker Build Cloud (https://www.docker.com/products/build-cloud/), you can set the driver to:
|
||||
driver: cloud org-name/builder-name
|
||||
|
||||
# Provenance
|
||||
#
|
||||
|
||||
@@ -82,6 +82,12 @@ asset_path: /path/to/assets
|
||||
# See https://kamal-deploy.org/docs/hooks for more information:
|
||||
hooks_path: /user_home/kamal/hooks
|
||||
|
||||
# Error pages
|
||||
#
|
||||
# A directory relative to the app root to find error pages for the proxy to serve.
|
||||
# Any files in the format 4xx.html or 5xx.html will be copied to the hosts.
|
||||
error_pages_path: public
|
||||
|
||||
# Require destinations
|
||||
#
|
||||
# Whether deployments require a destination to be specified, defaults to `false`:
|
||||
|
||||
@@ -51,6 +51,37 @@ env:
|
||||
secret:
|
||||
- DB_PASSWORD
|
||||
|
||||
# Aliased secrets
|
||||
#
|
||||
# You can also alias secrets to other secrets using a `:` separator.
|
||||
#
|
||||
# This is useful when the ENV name is different from the secret name. For example, if you have two
|
||||
# places where you need to define the ENV variable `DB_PASSWORD`, but the value is different depending
|
||||
# on the context.
|
||||
#
|
||||
# ```shell
|
||||
# SECRETS=$(kamal secrets fetch ...)
|
||||
#
|
||||
# MAIN_DB_PASSWORD=$(kamal secrets extract MAIN_DB_PASSWORD $SECRETS)
|
||||
# SECONDARY_DB_PASSWORD=$(kamal secrets extract SECONDARY_DB_PASSWORD $SECRETS)
|
||||
# ```
|
||||
env:
|
||||
secret:
|
||||
- DB_PASSWORD:MAIN_DB_PASSWORD
|
||||
tags:
|
||||
secondary_db:
|
||||
secret:
|
||||
- DB_PASSWORD:SECONDARY_DB_PASSWORD
|
||||
accessories:
|
||||
main_db_accessory:
|
||||
env:
|
||||
secret:
|
||||
- DB_PASSWORD:MAIN_DB_PASSWORD
|
||||
secondary_db_accessory:
|
||||
env:
|
||||
secret:
|
||||
- DB_PASSWORD:SECONDARY_DB_PASSWORD
|
||||
|
||||
# Tags
|
||||
#
|
||||
# Tags are used to add extra env variables to specific hosts.
|
||||
|
||||
@@ -10,11 +10,6 @@
|
||||
# They are application-specific, so they are not shared when multiple applications
|
||||
# run on the same proxy.
|
||||
#
|
||||
# The proxy is enabled by default on the primary role but can be disabled by
|
||||
# setting `proxy: false`.
|
||||
#
|
||||
# It is disabled by default on all other roles but can be enabled by setting
|
||||
# `proxy: true` or providing a proxy configuration.
|
||||
proxy:
|
||||
|
||||
# Hosts
|
||||
@@ -52,6 +47,13 @@ proxy:
|
||||
# Defaults to `false`:
|
||||
ssl: true
|
||||
|
||||
# SSL redirect
|
||||
#
|
||||
# By default, kamal-proxy will redirect all HTTP requests to HTTPS when SSL is enabled.
|
||||
# If you prefer that HTTP traffic is passed through to your application (along with
|
||||
# HTTPS traffic), you can disable this redirect by setting `ssl_redirect: false`:
|
||||
ssl_redirect: false
|
||||
|
||||
# Forward headers
|
||||
#
|
||||
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
|
||||
@@ -106,3 +108,30 @@ proxy:
|
||||
response_headers:
|
||||
- X-Request-ID
|
||||
- X-Request-Start
|
||||
|
||||
# Enabling/disabling the proxy on roles
|
||||
#
|
||||
# The proxy is enabled by default on the primary role but can be disabled by
|
||||
# setting `proxy: false` in the primary role's configuration.
|
||||
#
|
||||
# ```yaml
|
||||
# servers:
|
||||
# web:
|
||||
# hosts:
|
||||
# - ...
|
||||
# proxy: false
|
||||
# ```
|
||||
#
|
||||
# It is disabled by default on all other roles but can be enabled by setting
|
||||
# `proxy: true` or providing a proxy configuration for that role.
|
||||
#
|
||||
# ```yaml
|
||||
# servers:
|
||||
# web:
|
||||
# hosts:
|
||||
# - ...
|
||||
# web2:
|
||||
# hosts:
|
||||
# - ...
|
||||
# proxy: true
|
||||
# ```
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
class Kamal::Configuration::Env
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :context, :secrets
|
||||
attr_reader :clear, :secret_keys
|
||||
attr_reader :context, :clear, :secret_keys
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
|
||||
def initialize(config:, secrets:, context: "env")
|
||||
@@ -18,12 +17,22 @@ class Kamal::Configuration::Env
|
||||
end
|
||||
|
||||
def secrets_io
|
||||
Kamal::EnvFile.new(secret_keys.to_h { |key| [ key, secrets[key] ] }).to_io
|
||||
Kamal::EnvFile.new(aliased_secrets).to_io
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new \
|
||||
config: { "clear" => clear.merge(other.clear), "secret" => secret_keys | other.secret_keys },
|
||||
secrets: secrets
|
||||
secrets: @secrets
|
||||
end
|
||||
|
||||
private
|
||||
def aliased_secrets
|
||||
secret_keys.to_h { |key| extract_alias(key) }.transform_values { |secret_key| @secrets[secret_key] }
|
||||
end
|
||||
|
||||
def extract_alias(key)
|
||||
key_name, key_aliased_to = key.split(":", 2)
|
||||
[ key_name, key_aliased_to || key_name ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -11,6 +11,7 @@ class Kamal::Configuration::Proxy
|
||||
def initialize(config:, proxy_config:, context: "proxy")
|
||||
@config = config
|
||||
@proxy_config = proxy_config
|
||||
@proxy_config = {} if @proxy_config.nil?
|
||||
validate! @proxy_config, with: Kamal::Configuration::Validator::Proxy, context: context
|
||||
end
|
||||
|
||||
@@ -42,8 +43,10 @@ class Kamal::Configuration::Proxy
|
||||
"max-request-body": proxy_config.dig("buffering", "max_request_body"),
|
||||
"max-response-body": proxy_config.dig("buffering", "max_response_body"),
|
||||
"forward-headers": proxy_config.dig("forward_headers"),
|
||||
"tls-redirect": proxy_config.dig("ssl_redirect"),
|
||||
"log-request-header": proxy_config.dig("logging", "request_headers") || DEFAULT_LOG_REQUEST_HEADERS,
|
||||
"log-response-header": proxy_config.dig("logging", "response_headers")
|
||||
"log-response-header": proxy_config.dig("logging", "response_headers"),
|
||||
"error-pages": error_pages
|
||||
}.compact
|
||||
end
|
||||
|
||||
@@ -51,6 +54,17 @@ class Kamal::Configuration::Proxy
|
||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "="
|
||||
end
|
||||
|
||||
def stop_options(drain_timeout: nil, message: nil)
|
||||
{
|
||||
"drain-timeout": seconds_duration(drain_timeout),
|
||||
message: message
|
||||
}.compact
|
||||
end
|
||||
|
||||
def stop_command_args(**options)
|
||||
optionize stop_options(**options), with: "="
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new config: config, proxy_config: proxy_config.deep_merge(other.proxy_config)
|
||||
end
|
||||
@@ -59,4 +73,8 @@ class Kamal::Configuration::Proxy
|
||||
def seconds_duration(value)
|
||||
value ? "#{value}s" : nil
|
||||
end
|
||||
|
||||
def error_pages
|
||||
File.join config.proxy_boot.error_pages_container_directory, config.version if config.error_pages_path
|
||||
end
|
||||
end
|
||||
|
||||
121
lib/kamal/configuration/proxy/boot.rb
Normal file
121
lib/kamal/configuration/proxy/boot.rb
Normal file
@@ -0,0 +1,121 @@
|
||||
class Kamal::Configuration::Proxy::Boot
|
||||
MINIMUM_VERSION = "v0.9.0"
|
||||
DEFAULT_HTTP_PORT = 80
|
||||
DEFAULT_HTTPS_PORT = 443
|
||||
DEFAULT_LOG_MAX_SIZE = "10m"
|
||||
|
||||
attr_reader :config
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
def initialize(config:)
|
||||
@config = config
|
||||
end
|
||||
|
||||
def publish_args(http_port, https_port, bind_ips = nil)
|
||||
ensure_valid_bind_ips(bind_ips)
|
||||
|
||||
(bind_ips || [ nil ]).map do |bind_ip|
|
||||
bind_ip = format_bind_ip(bind_ip)
|
||||
publish_http = [ bind_ip, http_port, DEFAULT_HTTP_PORT ].compact.join(":")
|
||||
publish_https = [ bind_ip, https_port, DEFAULT_HTTPS_PORT ].compact.join(":")
|
||||
|
||||
argumentize "--publish", [ publish_http, publish_https ]
|
||||
end.join(" ")
|
||||
end
|
||||
|
||||
def logging_args(max_size)
|
||||
argumentize "--log-opt", "max-size=#{max_size}" if max_size.present?
|
||||
end
|
||||
|
||||
def default_boot_options
|
||||
[
|
||||
*(publish_args(DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT, nil)),
|
||||
*(logging_args(DEFAULT_LOG_MAX_SIZE))
|
||||
]
|
||||
end
|
||||
|
||||
def repository_name
|
||||
"basecamp"
|
||||
end
|
||||
|
||||
def image_name
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def image_default
|
||||
"#{repository_name}/#{image_name}"
|
||||
end
|
||||
|
||||
def container_name
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def host_directory
|
||||
File.join config.run_directory, "proxy"
|
||||
end
|
||||
|
||||
def options_file
|
||||
File.join host_directory, "options"
|
||||
end
|
||||
|
||||
def image_file
|
||||
File.join host_directory, "image"
|
||||
end
|
||||
|
||||
def image_version_file
|
||||
File.join host_directory, "image_version"
|
||||
end
|
||||
|
||||
def run_command_file
|
||||
File.join host_directory, "run_command"
|
||||
end
|
||||
|
||||
def apps_directory
|
||||
File.join host_directory, "apps-config"
|
||||
end
|
||||
|
||||
def apps_container_directory
|
||||
"/home/kamal-proxy/.apps-config"
|
||||
end
|
||||
|
||||
def apps_volume
|
||||
Kamal::Configuration::Volume.new \
|
||||
host_path: apps_directory,
|
||||
container_path: apps_container_directory
|
||||
end
|
||||
|
||||
def app_directory
|
||||
File.join apps_directory, config.service_and_destination
|
||||
end
|
||||
|
||||
def app_container_directory
|
||||
File.join apps_container_directory, config.service_and_destination
|
||||
end
|
||||
|
||||
def error_pages_directory
|
||||
File.join app_directory, "error_pages"
|
||||
end
|
||||
|
||||
def error_pages_container_directory
|
||||
File.join app_container_directory, "error_pages"
|
||||
end
|
||||
|
||||
private
|
||||
def ensure_valid_bind_ips(bind_ips)
|
||||
bind_ips.present? && bind_ips.each do |ip|
|
||||
next if ip =~ Resolv::IPv4::Regex || ip =~ Resolv::IPv6::Regex
|
||||
raise ArgumentError, "Invalid publish IP address: #{ip}"
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def format_bind_ip(ip)
|
||||
# Ensure IPv6 address inside square brackets - e.g. [::1]
|
||||
if ip =~ Resolv::IPv6::Regex && ip !~ /\A\[.*\]\z/
|
||||
"[#{ip}]"
|
||||
else
|
||||
ip
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,12 +1,10 @@
|
||||
class Kamal::Configuration::Registry
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :registry_config, :secrets
|
||||
|
||||
def initialize(config:)
|
||||
@registry_config = config.raw_config.registry || {}
|
||||
@secrets = config.secrets
|
||||
validate! registry_config, with: Kamal::Configuration::Validator::Registry
|
||||
def initialize(config:, secrets:, context: "registry")
|
||||
@registry_config = config["registry"] || {}
|
||||
@secrets = secrets
|
||||
validate! registry_config, context: context, with: Kamal::Configuration::Validator::Registry
|
||||
end
|
||||
|
||||
def server
|
||||
@@ -22,6 +20,8 @@ class Kamal::Configuration::Registry
|
||||
end
|
||||
|
||||
private
|
||||
attr_reader :registry_config, :secrets
|
||||
|
||||
def lookup(key)
|
||||
if registry_config[key].is_a?(Array)
|
||||
secrets[registry_config[key].first]
|
||||
|
||||
@@ -10,7 +10,7 @@ class Kamal::Configuration::Role
|
||||
def initialize(name, config:)
|
||||
@name, @config = name.inquiry, config
|
||||
validate! \
|
||||
specializations,
|
||||
role_config,
|
||||
example: validation_yml["servers"]["workers"],
|
||||
context: "servers/#{name}",
|
||||
with: Kamal::Configuration::Validator::Role
|
||||
@@ -204,11 +204,11 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def specializations
|
||||
if config.raw_config.servers.is_a?(Array) || config.raw_config.servers[name].is_a?(Array)
|
||||
{}
|
||||
else
|
||||
config.raw_config.servers[name]
|
||||
end
|
||||
@specializations ||= role_config.is_a?(Array) ? {} : role_config
|
||||
end
|
||||
|
||||
def role_config
|
||||
@role_config ||= config.raw_config.servers.is_a?(Array) ? {} : config.raw_config.servers[name]
|
||||
end
|
||||
|
||||
def custom_labels
|
||||
|
||||
@@ -13,6 +13,13 @@ class Kamal::Configuration::Servers
|
||||
|
||||
private
|
||||
def role_names
|
||||
servers_config.is_a?(Array) ? [ "web" ] : servers_config.keys.sort
|
||||
case servers_config
|
||||
when Array
|
||||
[ "web" ]
|
||||
when NilClass
|
||||
[]
|
||||
else
|
||||
servers_config.keys.sort
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -168,4 +168,10 @@ class Kamal::Configuration::Validator
|
||||
unknown_keys.reject! { |key| extension?(key) } if allow_extensions?
|
||||
unknown_keys_error unknown_keys if unknown_keys.present?
|
||||
end
|
||||
|
||||
def validate_docker_options!(options)
|
||||
if options
|
||||
error "Cannot set restart policy in docker options, unless-stopped is required" if options["restart"]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -2,8 +2,10 @@ class Kamal::Configuration::Validator::Accessory < Kamal::Configuration::Validat
|
||||
def validate!
|
||||
super
|
||||
|
||||
if (config.keys & [ "host", "hosts", "roles" ]).size != 1
|
||||
error "specify one of `host`, `hosts` or `roles`"
|
||||
if (config.keys & [ "host", "hosts", "role", "roles", "tag", "tags" ]).size != 1
|
||||
error "specify one of `host`, `hosts`, `role`, `roles`, `tag` or `tags`"
|
||||
end
|
||||
|
||||
validate_docker_options!(config["options"])
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,9 +3,10 @@ class Kamal::Configuration::Validator::Role < Kamal::Configuration::Validator
|
||||
validate_type! config, Array, Hash
|
||||
|
||||
if config.is_a?(Array)
|
||||
validate_servers! "servers", config
|
||||
validate_servers!(config)
|
||||
else
|
||||
super
|
||||
validate_docker_options!(config["options"])
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
class Kamal::Configuration::Validator::Servers < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
validate_type! config, Array, Hash
|
||||
validate_type! config, Array, Hash, NilClass
|
||||
|
||||
validate_servers! config if config.is_a?(Array)
|
||||
end
|
||||
|
||||
30
lib/kamal/docker.rb
Normal file
30
lib/kamal/docker.rb
Normal file
@@ -0,0 +1,30 @@
|
||||
require "tempfile"
|
||||
require "open3"
|
||||
|
||||
module Kamal::Docker
|
||||
extend self
|
||||
BUILD_CHECK_TAG = "kamal-local-build-check"
|
||||
|
||||
def included_files
|
||||
Tempfile.create do |dockerfile|
|
||||
dockerfile.write(<<~DOCKERFILE)
|
||||
FROM busybox
|
||||
COPY . app
|
||||
WORKDIR app
|
||||
CMD find . -type f | sed "s|^\./||"
|
||||
DOCKERFILE
|
||||
dockerfile.close
|
||||
|
||||
cmd = "docker buildx build -t=#{BUILD_CHECK_TAG} -f=#{dockerfile.path} ."
|
||||
system(cmd) || raise("failed to build check image")
|
||||
end
|
||||
|
||||
cmd = "docker run --rm #{BUILD_CHECK_TAG}"
|
||||
out, err, status = Open3.capture3(cmd)
|
||||
unless status
|
||||
raise "failed to run check image:\n#{err}"
|
||||
end
|
||||
|
||||
out.lines.map(&:strip)
|
||||
end
|
||||
end
|
||||
@@ -24,4 +24,14 @@ module Kamal::Git
|
||||
def root
|
||||
`git rev-parse --show-toplevel`.strip
|
||||
end
|
||||
|
||||
# returns an array of relative path names of files with uncommitted changes
|
||||
def uncommitted_files
|
||||
`git ls-files --modified`.lines.map(&:strip)
|
||||
end
|
||||
|
||||
# returns an array of relative path names of untracked files, including gitignored files
|
||||
def untracked_files
|
||||
`git ls-files --others`.lines.map(&:strip)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,6 +3,8 @@ module Kamal::Secrets::Adapters
|
||||
def self.lookup(name)
|
||||
name = "one_password" if name.downcase == "1password"
|
||||
name = "last_pass" if name.downcase == "lastpass"
|
||||
name = "gcp_secret_manager" if name.downcase == "gcp"
|
||||
name = "bitwarden_secrets_manager" if name.downcase == "bitwarden-sm"
|
||||
adapter_class(name)
|
||||
end
|
||||
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
class Kamal::Secrets::Adapters::AwsSecretsManager < Kamal::Secrets::Adapters::Base
|
||||
def requires_account?
|
||||
false
|
||||
end
|
||||
|
||||
private
|
||||
def login(_account)
|
||||
nil
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
def fetch_secrets(secrets, from:, account: nil, session:)
|
||||
{}.tap do |results|
|
||||
get_from_secrets_manager(secrets, account: account).each do |secret|
|
||||
get_from_secrets_manager(prefixed_secrets(secrets, from: from), account: account).each do |secret|
|
||||
secret_name = secret["Name"]
|
||||
secret_string = JSON.parse(secret["SecretString"])
|
||||
|
||||
@@ -19,8 +23,13 @@ class Kamal::Secrets::Adapters::AwsSecretsManager < Kamal::Secrets::Adapters::Ba
|
||||
end
|
||||
end
|
||||
|
||||
def get_from_secrets_manager(secrets, account:)
|
||||
`aws secretsmanager batch-get-secret-value --secret-id-list #{secrets.map(&:shellescape).join(" ")} --profile #{account.shellescape}`.tap do |secrets|
|
||||
def get_from_secrets_manager(secrets, account: nil)
|
||||
args = [ "aws", "secretsmanager", "batch-get-secret-value", "--secret-id-list" ] + secrets.map(&:shellescape)
|
||||
args += [ "--profile", account.shellescape ] if account
|
||||
args += [ "--output", "json" ]
|
||||
cmd = args.join(" ")
|
||||
|
||||
`#{cmd}`.tap do |secrets|
|
||||
raise RuntimeError, "Could not read #{secrets} from AWS Secrets Manager" unless $?.success?
|
||||
|
||||
secrets = JSON.parse(secrets)
|
||||
|
||||
@@ -7,8 +7,7 @@ class Kamal::Secrets::Adapters::Base
|
||||
check_dependencies!
|
||||
|
||||
session = login(account)
|
||||
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||
fetch_secrets(full_secrets, account: account, session: session)
|
||||
fetch_secrets(secrets, from: from, account: account, session: session)
|
||||
end
|
||||
|
||||
def requires_account?
|
||||
@@ -27,4 +26,8 @@ class Kamal::Secrets::Adapters::Base
|
||||
def check_dependencies!
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
def prefixed_secrets(secrets, from:)
|
||||
secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -21,9 +21,9 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
|
||||
session
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
{}.tap do |results|
|
||||
items_fields(secrets).each do |item, fields|
|
||||
items_fields(prefixed_secrets(secrets, from: from)).each do |item, fields|
|
||||
item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
|
||||
raise RuntimeError, "Could not read #{item} from Bitwarden" unless $?.success?
|
||||
item_json = JSON.parse(item_json)
|
||||
|
||||
72
lib/kamal/secrets/adapters/bitwarden_secrets_manager.rb
Normal file
72
lib/kamal/secrets/adapters/bitwarden_secrets_manager.rb
Normal file
@@ -0,0 +1,72 @@
|
||||
class Kamal::Secrets::Adapters::BitwardenSecretsManager < Kamal::Secrets::Adapters::Base
|
||||
def requires_account?
|
||||
false
|
||||
end
|
||||
|
||||
private
|
||||
LIST_ALL_SELECTOR = "all"
|
||||
LIST_ALL_FROM_PROJECT_SUFFIX = "/all"
|
||||
LIST_COMMAND = "secret list -o env"
|
||||
GET_COMMAND = "secret get -o env"
|
||||
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
raise RuntimeError, "You must specify what to retrieve from Bitwarden Secrets Manager" if secrets.length == 0
|
||||
|
||||
secrets = prefixed_secrets(secrets, from: from)
|
||||
command, project = extract_command_and_project(secrets)
|
||||
|
||||
{}.tap do |results|
|
||||
if command.nil?
|
||||
secrets.each do |secret_uuid|
|
||||
secret = run_command("#{GET_COMMAND} #{secret_uuid.shellescape}")
|
||||
raise RuntimeError, "Could not read #{secret_uuid} from Bitwarden Secrets Manager" unless $?.success?
|
||||
key, value = parse_secret(secret)
|
||||
results[key] = value
|
||||
end
|
||||
else
|
||||
secrets = run_command(command)
|
||||
raise RuntimeError, "Could not read secrets from Bitwarden Secrets Manager" unless $?.success?
|
||||
secrets.split("\n").each do |secret|
|
||||
key, value = parse_secret(secret)
|
||||
results[key] = value
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def extract_command_and_project(secrets)
|
||||
if secrets.length == 1
|
||||
if secrets[0] == LIST_ALL_SELECTOR
|
||||
[ LIST_COMMAND, nil ]
|
||||
elsif secrets[0].end_with?(LIST_ALL_FROM_PROJECT_SUFFIX)
|
||||
project = secrets[0].split(LIST_ALL_FROM_PROJECT_SUFFIX).first
|
||||
[ "#{LIST_COMMAND} #{project.shellescape}", project ]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def parse_secret(secret)
|
||||
key, value = secret.split("=", 2)
|
||||
value = value.gsub(/^"|"$/, "")
|
||||
[ key, value ]
|
||||
end
|
||||
|
||||
def run_command(command, session: nil)
|
||||
full_command = [ "bws", command ].join(" ")
|
||||
`#{full_command}`
|
||||
end
|
||||
|
||||
def login(account)
|
||||
run_command("run 'echo OK'")
|
||||
raise RuntimeError, "Could not authenticate to Bitwarden Secrets Manager. Did you set a valid access token?" unless $?.success?
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
raise RuntimeError, "Bitwarden Secrets Manager CLI is not installed" unless cli_installed?
|
||||
end
|
||||
|
||||
def cli_installed?
|
||||
`bws --version 2> /dev/null`
|
||||
$?.success?
|
||||
end
|
||||
end
|
||||
@@ -16,8 +16,21 @@ class Kamal::Secrets::Adapters::Doppler < Kamal::Secrets::Adapters::Base
|
||||
$?.success?
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, **)
|
||||
project_and_config_flags = ""
|
||||
def fetch_secrets(secrets, from:, **)
|
||||
secrets = prefixed_secrets(secrets, from: from)
|
||||
flags = secrets_get_flags(secrets)
|
||||
|
||||
secret_names = secrets.collect { |s| s.split("/").last }
|
||||
|
||||
items = `doppler secrets get #{secret_names.map(&:shellescape).join(" ")} --json #{flags}`
|
||||
raise RuntimeError, "Could not read #{secrets} from Doppler" unless $?.success?
|
||||
|
||||
items = JSON.parse(items)
|
||||
|
||||
items.transform_values { |value| value["computed"] }
|
||||
end
|
||||
|
||||
def secrets_get_flags(secrets)
|
||||
unless service_token_set?
|
||||
project, config, _ = secrets.first.split("/")
|
||||
|
||||
@@ -27,15 +40,6 @@ class Kamal::Secrets::Adapters::Doppler < Kamal::Secrets::Adapters::Base
|
||||
|
||||
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?
|
||||
|
||||
71
lib/kamal/secrets/adapters/enpass.rb
Normal file
71
lib/kamal/secrets/adapters/enpass.rb
Normal file
@@ -0,0 +1,71 @@
|
||||
##
|
||||
# Enpass is different from most password managers, in a way that it's offline and doesn't need an account.
|
||||
#
|
||||
# Usage
|
||||
#
|
||||
# Fetch all password from FooBar item
|
||||
# `kamal secrets fetch --adapter enpass --from /Users/YOUR_USERNAME/Library/Containers/in.sinew.Enpass-Desktop/Data/Documents/Vaults/primary FooBar`
|
||||
#
|
||||
# Fetch only DB_PASSWORD from FooBar item
|
||||
# `kamal secrets fetch --adapter enpass --from /Users/YOUR_USERNAME/Library/Containers/in.sinew.Enpass-Desktop/Data/Documents/Vaults/primary FooBar/DB_PASSWORD`
|
||||
class Kamal::Secrets::Adapters::Enpass < Kamal::Secrets::Adapters::Base
|
||||
def requires_account?
|
||||
false
|
||||
end
|
||||
|
||||
private
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
secrets_titles = fetch_secret_titles(secrets)
|
||||
|
||||
result = `enpass-cli -json -vault #{from.shellescape} show #{secrets_titles.map(&:shellescape).join(" ")}`.strip
|
||||
|
||||
parse_result_and_take_secrets(result, secrets)
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
raise RuntimeError, "Enpass CLI is not installed" unless cli_installed?
|
||||
end
|
||||
|
||||
def cli_installed?
|
||||
`enpass-cli version 2> /dev/null`
|
||||
$?.success?
|
||||
end
|
||||
|
||||
def login(account)
|
||||
nil
|
||||
end
|
||||
|
||||
def fetch_secret_titles(secrets)
|
||||
secrets.reduce(Set.new) do |secret_titles, secret|
|
||||
# Sometimes secrets contain a '/', when the intent is to fetch a single password for an item. Example: FooBar/DB_PASSWORD
|
||||
# Another case is, when the intent is to fetch all passwords for an item. Example: FooBar (and FooBar may have multiple different passwords)
|
||||
key, separator, value = secret.rpartition("/")
|
||||
if key.empty?
|
||||
secret_titles << value
|
||||
else
|
||||
secret_titles << key
|
||||
end
|
||||
end.to_a
|
||||
end
|
||||
|
||||
def parse_result_and_take_secrets(unparsed_result, secrets)
|
||||
result = JSON.parse(unparsed_result)
|
||||
|
||||
result.reduce({}) do |secrets_with_passwords, item|
|
||||
title = item["title"]
|
||||
label = item["label"]
|
||||
password = item["password"]
|
||||
|
||||
if title && password.present?
|
||||
key = [ title, label ].compact.reject(&:empty?).join("/")
|
||||
|
||||
if secrets.include?(title) || secrets.include?(key)
|
||||
raise RuntimeError, "#{key} is present more than once" if secrets_with_passwords[key]
|
||||
secrets_with_passwords[key] = password
|
||||
end
|
||||
end
|
||||
|
||||
secrets_with_passwords
|
||||
end
|
||||
end
|
||||
end
|
||||
112
lib/kamal/secrets/adapters/gcp_secret_manager.rb
Normal file
112
lib/kamal/secrets/adapters/gcp_secret_manager.rb
Normal file
@@ -0,0 +1,112 @@
|
||||
class Kamal::Secrets::Adapters::GcpSecretManager < Kamal::Secrets::Adapters::Base
|
||||
private
|
||||
def login(account)
|
||||
# Since only the account option is passed from the cli, we'll use it for both account and service account
|
||||
# impersonation.
|
||||
#
|
||||
# Syntax:
|
||||
# ACCOUNT: USER | USER "|" DELEGATION_CHAIN
|
||||
# USER: DEFAULT_USER | EMAIL
|
||||
# DELEGATION_CHAIN: EMAIL | EMAIL "," DELEGATION_CHAIN
|
||||
# EMAIL: <The email address of the user or service account, like "my-user@example.com" >
|
||||
# DEFAULT_USER: "default"
|
||||
#
|
||||
# Some valid examples:
|
||||
# - "my-user@example.com" sets the user
|
||||
# - "my-user@example.com|my-service-user@example.com" will use my-user and enable service account impersonation as my-service-user
|
||||
# - "default" will use the default user and no impersonation
|
||||
# - "default|my-service-user@example.com" will use the default user, and enable service account impersonation as my-service-user
|
||||
# - "default|my-service-user@example.com,another-service-user@example.com" same as above, but with an impersonation delegation chain
|
||||
|
||||
unless logged_in?
|
||||
`gcloud auth login`
|
||||
raise RuntimeError, "could not login to gcloud" unless logged_in?
|
||||
end
|
||||
|
||||
nil
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
user, service_account = parse_account(account)
|
||||
|
||||
{}.tap do |results|
|
||||
secrets_with_metadata(prefixed_secrets(secrets, from: from)).each do |secret, (project, secret_name, secret_version)|
|
||||
item_name = "#{project}/#{secret_name}"
|
||||
results[item_name] = fetch_secret(project, secret_name, secret_version, user, service_account)
|
||||
raise RuntimeError, "Could not read #{item_name} from Google Secret Manager" unless $?.success?
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def fetch_secret(project, secret_name, secret_version, user, service_account)
|
||||
secret = run_command(
|
||||
"secrets versions access #{secret_version.shellescape} --secret=#{secret_name.shellescape}",
|
||||
project: project,
|
||||
user: user,
|
||||
service_account: service_account
|
||||
)
|
||||
Base64.decode64(secret.dig("payload", "data"))
|
||||
end
|
||||
|
||||
# The secret needs to at least contain a secret name, but project name, and secret version can also be specified.
|
||||
#
|
||||
# The string "default" can be used to refer to the default project configured for gcloud.
|
||||
#
|
||||
# The version can be either the string "latest", or a version number.
|
||||
#
|
||||
# The following formats are valid:
|
||||
#
|
||||
# - The following are all equivalent, and sets project: default, secret name: my-secret, version: latest
|
||||
# - "my-secret"
|
||||
# - "default/my-secret"
|
||||
# - "default/my-secret/latest"
|
||||
# - "my-secret/latest" in combination with --from=default
|
||||
# - "my-secret/123" (only in combination with --from=some-project) -> project: some-project, secret name: my-secret, version: 123
|
||||
# - "some-project/my-secret/123" -> project: some-project, secret name: my-secret, version: 123
|
||||
def secrets_with_metadata(secrets)
|
||||
{}.tap do |items|
|
||||
secrets.each do |secret|
|
||||
parts = secret.split("/")
|
||||
parts.unshift("default") if parts.length == 1
|
||||
project = parts.shift
|
||||
secret_name = parts.shift
|
||||
secret_version = parts.shift || "latest"
|
||||
|
||||
items[secret] = [ project, secret_name, secret_version ]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def run_command(command, project: "default", user: "default", service_account: nil)
|
||||
full_command = [ "gcloud", command ]
|
||||
full_command << "--project=#{project.shellescape}" unless project == "default"
|
||||
full_command << "--account=#{user.shellescape}" unless user == "default"
|
||||
full_command << "--impersonate-service-account=#{service_account.shellescape}" if service_account
|
||||
full_command << "--format=json"
|
||||
full_command = full_command.join(" ")
|
||||
|
||||
result = `#{full_command}`.strip
|
||||
JSON.parse(result)
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
raise RuntimeError, "gcloud CLI is not installed" unless cli_installed?
|
||||
end
|
||||
|
||||
def cli_installed?
|
||||
`gcloud --version 2> /dev/null`
|
||||
$?.success?
|
||||
end
|
||||
|
||||
def logged_in?
|
||||
JSON.parse(`gcloud auth list --format=json`).any?
|
||||
end
|
||||
|
||||
def parse_account(account)
|
||||
account.split("|", 2)
|
||||
end
|
||||
|
||||
def is_user?(candidate)
|
||||
candidate.include?("@")
|
||||
end
|
||||
end
|
||||
@@ -11,7 +11,8 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
||||
`lpass status --color never`.strip == "Logged in as #{account}."
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
secrets = prefixed_secrets(secrets, from: from)
|
||||
items = `lpass show #{secrets.map(&:shellescape).join(" ")} --json`
|
||||
raise RuntimeError, "Could not read #{secrets} from LastPass" unless $?.success?
|
||||
|
||||
@@ -23,7 +24,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
|
||||
end
|
||||
|
||||
if (missing_items = secrets - results.keys).any?
|
||||
raise RuntimeError, "Could not find #{missing_items.join(", ")} in LassPass"
|
||||
raise RuntimeError, "Could not find #{missing_items.join(", ")} in LastPass"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -15,9 +15,9 @@ class Kamal::Secrets::Adapters::OnePassword < Kamal::Secrets::Adapters::Base
|
||||
$?.success?
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
{}.tap do |results|
|
||||
vaults_items_fields(secrets).map do |vault, items|
|
||||
vaults_items_fields(prefixed_secrets(secrets, from: from)).map do |vault, items|
|
||||
items.each do |item, fields|
|
||||
fields_json = JSON.parse(op_item_get(vault, item, fields, account: account, session: session))
|
||||
fields_json = [ fields_json ] if fields.one?
|
||||
|
||||
@@ -4,8 +4,8 @@ class Kamal::Secrets::Adapters::Test < Kamal::Secrets::Adapters::Base
|
||||
true
|
||||
end
|
||||
|
||||
def fetch_secrets(secrets, account:, session:)
|
||||
secrets.to_h { |secret| [ secret, secret.reverse ] }
|
||||
def fetch_secrets(secrets, from:, account:, session:)
|
||||
prefixed_secrets(secrets, from: from).to_h { |secret| [ secret, secret.reverse ] }
|
||||
end
|
||||
|
||||
def check_dependencies!
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
class Kamal::Secrets::Adapters::TestOptionalAccount < Kamal::Secrets::Adapters::Test
|
||||
def requires_account?
|
||||
false
|
||||
end
|
||||
end
|
||||
@@ -4,7 +4,7 @@ class Kamal::Secrets::Dotenv::InlineCommandSubstitution
|
||||
::Dotenv::Parser.substitutions.map! { |sub| sub == ::Dotenv::Substitutions::Command ? self : sub }
|
||||
end
|
||||
|
||||
def call(value, _env, overwrite: false)
|
||||
def call(value, env, overwrite: false)
|
||||
# Process interpolated shell commands
|
||||
value.gsub(Dotenv::Substitutions::Command.singleton_class::INTERPOLATED_SHELL_COMMAND) do |*|
|
||||
# Eliminate opening and closing parentheses
|
||||
@@ -14,6 +14,7 @@ class Kamal::Secrets::Dotenv::InlineCommandSubstitution
|
||||
# Command is escaped, don't replace it.
|
||||
$LAST_MATCH_INFO[0][1..]
|
||||
else
|
||||
command = ::Dotenv::Substitutions::Variable.call(command, env)
|
||||
if command =~ /\A\s*kamal\s*secrets\s+/
|
||||
# Inline the command
|
||||
inline_secrets_command(command)
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
module Kamal
|
||||
VERSION = "2.4.0"
|
||||
VERSION = "2.6.1"
|
||||
end
|
||||
|
||||
@@ -14,8 +14,8 @@ class CliAccessoryTest < CliTestCase
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
||||
|
||||
run_command("boot", "mysql").tap do |output|
|
||||
assert_match /docker login.*on 1.1.1.3/, output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -24,17 +24,21 @@ class CliAccessoryTest < CliTestCase
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("mysql")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:directories).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:directories).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("busybox")
|
||||
|
||||
run_command("boot", "all").tap do |output|
|
||||
assert_match /docker login.*on 1.1.1.3/, output
|
||||
assert_match /docker login.*on 1.1.1.1/, output
|
||||
assert_match /docker login.*on 1.1.1.2/, output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.2", output
|
||||
assert_match "docker login other.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||
assert_match /docker network create kamal.*on 1.1.1.1/, output
|
||||
assert_match /docker network create kamal.*on 1.1.1.2/, output
|
||||
assert_match /docker network create kamal.*on 1.1.1.3/, output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
||||
assert_match "docker run --name custom-box --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-box\" other.registry/busybox:latest on 1.1.1.3", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -60,13 +64,16 @@ class CliAccessoryTest < CliTestCase
|
||||
end
|
||||
|
||||
test "reboot all" do
|
||||
Kamal::Commands::Registry.any_instance.expects(:login).times(3)
|
||||
Kamal::Commands::Registry.any_instance.expects(:login).times(4)
|
||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("mysql")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("mysql")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:boot).with("mysql", prepare: false)
|
||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:boot).with("redis", prepare: false)
|
||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:boot).with("busybox", prepare: false)
|
||||
|
||||
run_command("reboot", "all")
|
||||
end
|
||||
@@ -94,7 +101,7 @@ class CliAccessoryTest < CliTestCase
|
||||
end
|
||||
|
||||
test "details with non-existent accessory" do
|
||||
assert_equal "No accessory by the name of 'hello' (options: mysql and redis)", stderred { run_command("details", "hello") }
|
||||
assert_equal "No accessory by the name of 'hello' (options: mysql, redis, and busybox)", stderred { run_command("details", "hello") }
|
||||
end
|
||||
|
||||
test "details with all" do
|
||||
@@ -108,6 +115,7 @@ class CliAccessoryTest < CliTestCase
|
||||
|
||||
test "exec" do
|
||||
run_command("exec", "mysql", "mysql -v").tap do |output|
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED]", output
|
||||
assert_match "Launching command from new container", output
|
||||
assert_match "mysql -v", output
|
||||
end
|
||||
@@ -180,6 +188,10 @@ class CliAccessoryTest < CliTestCase
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_image).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_service_directory).with("redis")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:stop).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_container).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_image).with("busybox")
|
||||
Kamal::Cli::Accessory.any_instance.expects(:remove_service_directory).with("busybox")
|
||||
|
||||
run_command("remove", "all", "-y")
|
||||
end
|
||||
@@ -189,7 +201,7 @@ class CliAccessoryTest < CliTestCase
|
||||
end
|
||||
|
||||
test "remove_image" do
|
||||
assert_match "docker image rm --force mysql", run_command("remove_image", "mysql")
|
||||
assert_match "docker image rm --force private.registry/mysql:5.7", run_command("remove_image", "mysql")
|
||||
end
|
||||
|
||||
test "remove_service_directory" do
|
||||
@@ -201,8 +213,8 @@ class CliAccessoryTest < CliTestCase
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||
|
||||
run_command("boot", "redis", "--hosts", "1.1.1.1").tap do |output|
|
||||
assert_match /docker login.*on 1.1.1.1/, output
|
||||
assert_no_match /docker login.*on 1.1.1.2/, output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||
assert_no_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.2", output
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
||||
end
|
||||
@@ -213,8 +225,8 @@ class CliAccessoryTest < CliTestCase
|
||||
Kamal::Cli::Accessory.any_instance.expects(:upload).with("redis")
|
||||
|
||||
run_command("boot", "redis", "--hosts", "1.1.1.1,1.1.1.3").tap do |output|
|
||||
assert_match /docker login.*on 1.1.1.1/, output
|
||||
assert_no_match /docker login.*on 1.1.1.3/, output
|
||||
assert_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.1", output
|
||||
assert_no_match "docker login private.registry -u [REDACTED] -p [REDACTED] on 1.1.1.3", output
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||
assert_no_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.3", output
|
||||
end
|
||||
@@ -225,7 +237,7 @@ class CliAccessoryTest < CliTestCase
|
||||
assert_match "Upgrading all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
||||
assert_match "docker network create kamal on 1.1.1.3", output
|
||||
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "Upgraded all accessories on 1.1.1.3,1.1.1.1,1.1.1.2...", output
|
||||
end
|
||||
end
|
||||
@@ -235,14 +247,26 @@ class CliAccessoryTest < CliTestCase
|
||||
assert_match "Upgrading all accessories on 1.1.1.3...", output
|
||||
assert_match "docker network create kamal on 1.1.1.3", output
|
||||
assert_match "docker container stop app-mysql on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "docker run --name app-mysql --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST="%" --env-file .kamal/apps/app/env/accessories/mysql.env --volume $PWD/app-mysql/etc/mysql/my.cnf:/etc/mysql/my.cnf --volume $PWD/app-mysql/data:/var/lib/mysql --label service=\"app-mysql\" private.registry/mysql:5.7 on 1.1.1.3", output
|
||||
assert_match "Upgraded all accessories on 1.1.1.3", output
|
||||
end
|
||||
end
|
||||
|
||||
test "boot with web role filter" do
|
||||
run_command("boot", "redis", "-r", "web").tap do |output|
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.1", output
|
||||
assert_match "docker run --name app-redis --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --publish 6379:6379 --env-file .kamal/apps/app/env/accessories/redis.env --volume $PWD/app-redis/data:/data --label service=\"app-redis\" redis:latest on 1.1.1.2", output
|
||||
end
|
||||
end
|
||||
|
||||
test "boot with workers role filter" do
|
||||
run_command("boot", "redis", "-r", "workers").tap do |output|
|
||||
assert_no_match "docker run", output
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def run_command(*command)
|
||||
stdouted { Kamal::Cli::Accessory.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||
stdouted { Kamal::Cli::Accessory.start([ *command, "-c", "test/fixtures/deploy_with_accessories_with_different_registries.yml" ]) }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -37,13 +37,20 @@ class CliAppTest < CliTestCase
|
||||
end
|
||||
|
||||
test "boot uses group strategy when specified" do
|
||||
Kamal::Cli::App.any_instance.stubs(:on).with("1.1.1.1").times(2) # ensure locks dir, acquire & release lock
|
||||
Kamal::Cli::App.any_instance.stubs(:on).with([ "1.1.1.1" ]) # tag container
|
||||
Kamal::Cli::App.any_instance.stubs(:on).with("1.1.1.1").twice
|
||||
Kamal::Cli::App.any_instance.stubs(:on).with([ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ]).times(3)
|
||||
|
||||
# Strategy is used when booting the containers
|
||||
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.1" ], in: :groups, limit: 3, wait: 2).with_block_given
|
||||
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.1", "1.1.1.2", "1.1.1.3" ]).with_block_given
|
||||
Kamal::Cli::App.any_instance.expects(:on).with([ "1.1.1.4" ]).with_block_given
|
||||
Object.any_instance.expects(:sleep).with(2).twice
|
||||
|
||||
run_command("boot", config: :with_boot_strategy)
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
run_command("boot", config: :with_boot_strategy, host: nil).tap do |output|
|
||||
assert_hook_ran "pre-app-boot", output, count: 2
|
||||
assert_hook_ran "post-app-boot", output, count: 2
|
||||
end
|
||||
end
|
||||
|
||||
test "boot errors don't leave lock in place" do
|
||||
@@ -73,7 +80,7 @@ class CliAppTest < CliTestCase
|
||||
run_command("boot", config: :with_assets).tap do |output|
|
||||
assert_match "docker tag dhh/app:latest dhh/app:latest", output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-latest ; cp -rnT .kamal/apps/app/assets/extracted/web-latest .kamal/apps/app/assets/volumes/web-123 || true ; cp -rnT .kamal/apps/app/assets/extracted/web-123 .kamal/apps/app/assets/volumes/web-latest || true", output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/extracted/web-latest && docker stop -t 1 app-web-assets 2> /dev/null || true && docker run --name app-web-assets --detach --rm --entrypoint sleep dhh/app:latest 1000000 && docker cp -L app-web-assets:/public/assets/. .kamal/apps/app/assets/extracted/web-latest && docker stop -t 1 app-web-assets", output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/assets/extracted/web-latest && docker container rm app-web-assets 2> /dev/null || true && docker container create --name app-web-assets dhh/app:latest && docker container cp -L app-web-assets:/public/assets/. .kamal/apps/app/assets/extracted/web-latest && docker container rm app-web-assets", output
|
||||
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} /, output
|
||||
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
||||
assert_match "/usr/bin/env find .kamal/apps/app/assets/extracted -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" + ; find .kamal/apps/app/assets/volumes -maxdepth 1 -name 'web-*' ! -name web-latest -exec rm -rf \"{}\" +", output
|
||||
@@ -185,6 +192,34 @@ class CliAppTest < CliTestCase
|
||||
Thread.report_on_exception = true
|
||||
end
|
||||
|
||||
test "boot with only workers" do
|
||||
Object.any_instance.stubs(:sleep)
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-workers-latest$", "--quiet", "|", :xargs, :docker, :inspect, "--format", "'{{if .State.Health}}{{.State.Health.Status}}{{else}}{{.State.Status}}{{end}}'")
|
||||
.returns("running").at_least_once # workers health check
|
||||
|
||||
run_command("boot", config: :with_only_workers, host: nil).tap do |output|
|
||||
assert_match /First workers container is healthy on 1.1.1.\d, booting any other roles/, output
|
||||
assert_no_match "kamal-proxy", output
|
||||
end
|
||||
end
|
||||
|
||||
test "boot with error pages" do
|
||||
with_error_pages(directory: "public") do
|
||||
stub_running
|
||||
run_command("boot", config: :with_error_pages).tap do |output|
|
||||
assert_match /Uploading .*kamal-error-pages.*\/latest to \.kamal\/proxy\/apps-config\/app\/error_pages/, output
|
||||
assert_match "docker tag dhh/app:latest 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} /, output
|
||||
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
|
||||
assert_match "Running /usr/bin/env find .kamal/proxy/apps-config/app/error_pages -mindepth 1 -maxdepth 1 ! -name latest -exec rm -rf {} + on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "start" do
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("999") # old version
|
||||
|
||||
@@ -237,9 +272,11 @@ class CliAppTest < CliTestCase
|
||||
|
||||
test "remove" do
|
||||
run_command("remove").tap do |output|
|
||||
assert_match /#{Regexp.escape("sh -c 'docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --quiet --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | xargs docker stop")}/, output
|
||||
assert_match /#{Regexp.escape("docker container prune --force --filter label=service=app")}/, output
|
||||
assert_match /#{Regexp.escape("docker image prune --all --force --filter label=service=app")}/, output
|
||||
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
|
||||
assert_match "docker container prune --force --filter label=service=app", output
|
||||
assert_match "docker image prune --all --force --filter label=service=app", output
|
||||
assert_match "rm -r .kamal/apps/app on 1.1.1.1", output
|
||||
assert_match "rm -r .kamal/proxy/apps-config/app on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -261,12 +298,27 @@ class CliAppTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "remove_app_directories" do
|
||||
run_command("remove_app_directories").tap do |output|
|
||||
assert_match "rm -r .kamal/apps/app on 1.1.1.1", output
|
||||
assert_match "rm -r .kamal/proxy/apps-config/app on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
|
||||
test "exec" do
|
||||
run_command("exec", "ruby -v").tap do |output|
|
||||
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
||||
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v", output
|
||||
end
|
||||
end
|
||||
|
||||
test "exec without command fails" do
|
||||
error = assert_raises(ArgumentError, "Exec requires a command to be specified") do
|
||||
run_command("exec")
|
||||
end
|
||||
assert_equal "No command provided. You must specify a command to execute.", error.message
|
||||
end
|
||||
|
||||
test "exec separate arguments" do
|
||||
run_command("exec", "ruby", " -v").tap do |output|
|
||||
assert_match "docker run --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v", output
|
||||
@@ -305,18 +357,25 @@ class CliAppTest < CliTestCase
|
||||
end
|
||||
|
||||
test "exec interactive" do
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:exec)
|
||||
.with("ssh -t root@1.1.1.1 -p 22 'docker run -it --rm --network kamal --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size=\"10m\" dhh/app:latest ruby -v'")
|
||||
|
||||
run_command("exec", "-i", "ruby -v").tap do |output|
|
||||
assert_hook_ran "pre-connect", output
|
||||
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
||||
assert_match "Get most recent version available as an image...", output
|
||||
assert_match "Launching interactive command with version latest via SSH from new container on 1.1.1.1...", output
|
||||
end
|
||||
end
|
||||
|
||||
test "exec interactive with reuse" do
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:exec)
|
||||
.with("ssh -t root@1.1.1.1 -p 22 'docker exec -it app-web-999 ruby -v'")
|
||||
|
||||
run_command("exec", "-i", "--reuse", "ruby -v").tap do |output|
|
||||
assert_hook_ran "pre-connect", 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=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
|
||||
@@ -382,8 +441,10 @@ class CliAppTest < CliTestCase
|
||||
|
||||
|
||||
test "version through main" do
|
||||
stdouted { Kamal::Cli::Main.start([ "app", "version", "-c", "test/fixtures/deploy_with_accessories.yml", "--hosts", "1.1.1.1" ]) }.tap do |output|
|
||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=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
|
||||
with_argv([ "app", "version", "-c", "test/fixtures/deploy_with_accessories.yml", "--hosts", "1.1.1.1" ]) do
|
||||
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||
assert_match "sh -c 'docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting --filter ancestor=$(docker image ls --filter reference=dhh/app:latest --format '\\''{{.ID}}'\\'') ; docker ps --latest --format '\\''{{.Names}}'\\'' --filter label=service=app --filter label=destination= --filter label=role=web --filter status=running --filter status=restarting' | head -1 | while read line; do echo ${line#app-web-}; done", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -428,6 +489,24 @@ class CliAppTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "live" do
|
||||
run_command("live").tap do |output|
|
||||
assert_match "docker exec kamal-proxy kamal-proxy resume app-web on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
|
||||
test "maintenance" do
|
||||
run_command("maintenance").tap do |output|
|
||||
assert_match "docker exec kamal-proxy kamal-proxy stop app-web --drain-timeout=\"30s\" on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
|
||||
test "maintenance with options" do
|
||||
run_command("maintenance", "--message", "Hello", "--drain_timeout", "10").tap do |output|
|
||||
assert_match "docker exec kamal-proxy kamal-proxy stop app-web --drain-timeout=\"10s\" --message=\"Hello\" on 1.1.1.1", output
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def run_command(*command, config: :with_accessories, host: "1.1.1.1", allow_execute_error: false)
|
||||
stdouted do
|
||||
|
||||
@@ -11,7 +11,6 @@ class CliBuildTest < CliTestCase
|
||||
test "push" do
|
||||
with_build_directory do |build_directory|
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "build", subcommand: "push" }
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||
@@ -22,11 +21,34 @@ class CliBuildTest < CliTestCase
|
||||
.returns("")
|
||||
|
||||
run_command("push", "--verbose").tap do |output|
|
||||
assert_hook_ran "pre-build", output, **hook_variables
|
||||
assert_hook_ran "pre-connect", output
|
||||
assert_hook_ran "pre-build", output
|
||||
assert_match /Cloning repo into build directory/, output
|
||||
assert_match /git -C #{Dir.tmpdir}\/kamal-clones\/app-#{pwd_sha} clone #{Dir.pwd}/, output
|
||||
assert_match /docker --version && docker buildx version/, output
|
||||
assert_match /docker buildx build --push --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. as .*@localhost/, output
|
||||
assert_match /docker buildx build --output=type=registry --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. 2>&1 as .*@localhost/, output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "push --output=docker" do
|
||||
with_build_directory do |build_directory|
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||
.returns(Kamal::Git.revision)
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:git, "-C", anything, :status, "--porcelain")
|
||||
.returns("")
|
||||
|
||||
run_command("push", "--output=docker", "--verbose").tap do |output|
|
||||
assert_hook_ran "pre-build", output
|
||||
assert_match /Cloning repo into build directory/, output
|
||||
assert_match /git -C #{Dir.tmpdir}\/kamal-clones\/app-#{pwd_sha} clone #{Dir.pwd}/, output
|
||||
assert_match /docker --version && docker buildx version/, output
|
||||
assert_match /docker buildx build --output=type=docker --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile \. 2>&1 as .*@localhost/, output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -36,6 +58,7 @@ class CliBuildTest < CliTestCase
|
||||
stub_setup
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute).with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute).with { |*args| args[0..1] == [ :docker, :login ] }
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:git, "-C", "#{Dir.tmpdir}/kamal-clones/app-#{pwd_sha}", :clone, Dir.pwd, "--recurse-submodules")
|
||||
@@ -49,7 +72,7 @@ class CliBuildTest < CliTestCase
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute).with(:git, "-C", build_directory, :submodule, :update, "--init")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:docker, :buildx, :build, "--push", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
||||
.with(:docker, :buildx, :build, "--output=type=registry", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".", "2>&1")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:git, "-C", anything, :"rev-parse", :HEAD)
|
||||
@@ -68,13 +91,12 @@ class CliBuildTest < CliTestCase
|
||||
|
||||
test "push without clone" do
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "build", subcommand: "push" }
|
||||
|
||||
run_command("push", "--verbose", fixture: :without_clone).tap do |output|
|
||||
assert_no_match /Cloning repo into build directory/, output
|
||||
assert_hook_ran "pre-build", output, **hook_variables
|
||||
assert_hook_ran "pre-build", output
|
||||
assert_match /docker --version && docker buildx version/, output
|
||||
assert_match /docker buildx build --push --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile . as .*@localhost/, output
|
||||
assert_match /docker buildx build --output=type=registry --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999 -t dhh\/app:latest --label service="app" --file Dockerfile . 2>&1 as .*@localhost/, output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -83,6 +105,7 @@ class CliBuildTest < CliTestCase
|
||||
stub_setup
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute).with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute).with { |*args| args[0..1] == [ :docker, :login ] }
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:git, "-C", "#{Dir.tmpdir}/kamal-clones/app-#{pwd_sha}", :clone, Dir.pwd, "--recurse-submodules")
|
||||
@@ -119,6 +142,9 @@ class CliBuildTest < CliTestCase
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
.with { |*args| args[0..1] == [ :docker, :login ] }
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:docker, :buildx, :rm, "kamal-local-docker-container")
|
||||
|
||||
@@ -140,7 +166,7 @@ class CliBuildTest < CliTestCase
|
||||
.returns("")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:execute)
|
||||
.with(:docker, :buildx, :build, "--push", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".")
|
||||
.with(:docker, :buildx, :build, "--output=type=registry", "--platform", "linux/amd64", "--builder", "kamal-local-docker-container", "-t", "dhh/app:999", "-t", "dhh/app:latest", "--label", "service=\"app\"", "--file", "Dockerfile", ".", "2>&1")
|
||||
|
||||
run_command("push").tap do |output|
|
||||
assert_match /WARN Missing compatible builder, so creating a new one first/, output
|
||||
@@ -155,7 +181,7 @@ class CliBuildTest < CliTestCase
|
||||
.raises(SSHKit::Command::Failed.new("no buildx"))
|
||||
|
||||
Kamal::Commands::Builder.any_instance.stubs(:native_and_local?).returns(false)
|
||||
assert_raises(Kamal::Cli::Build::BuildError) { run_command("push") }
|
||||
assert_raises(Kamal::Cli::DependencyError) { run_command("push") }
|
||||
end
|
||||
|
||||
test "push pre-build hook failure" do
|
||||
@@ -235,6 +261,12 @@ class CliBuildTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "create cloud" do
|
||||
run_command("create", fixture: :with_cloud_builder).tap do |output|
|
||||
assert_match /docker buildx create --driver cloud example_org\/cloud_builder/, output
|
||||
end
|
||||
end
|
||||
|
||||
test "create with error" do
|
||||
stub_setup
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
@@ -252,6 +284,12 @@ class CliBuildTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "remove cloud" do
|
||||
run_command("remove", fixture: :with_cloud_builder).tap do |output|
|
||||
assert_match /docker buildx rm cloud-example_org-cloud_builder/, output
|
||||
end
|
||||
end
|
||||
|
||||
test "details" do
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture)
|
||||
.with(:docker, :context, :ls, "&&", :docker, :buildx, :ls)
|
||||
@@ -263,9 +301,33 @@ class CliBuildTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "dev" do
|
||||
with_build_directory do |build_directory|
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
run_command("dev", "--verbose").tap do |output|
|
||||
assert_no_match(/Cloning repo into build directory/, output)
|
||||
assert_match(/docker --version && docker buildx version/, output)
|
||||
assert_match(/docker buildx build --output=type=docker --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999-dirty -t dhh\/app:latest-dirty --label service="app" --file Dockerfile \. 2>&1 as .*@localhost/, output)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "dev --output=local" do
|
||||
with_build_directory do |build_directory|
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
run_command("dev", "--output=local", "--verbose").tap do |output|
|
||||
assert_no_match(/Cloning repo into build directory/, output)
|
||||
assert_match(/docker --version && docker buildx version/, output)
|
||||
assert_match(/docker buildx build --output=type=local --platform linux\/amd64 --builder kamal-local-docker-container -t dhh\/app:999-dirty -t dhh\/app:latest-dirty --label service="app" --file Dockerfile \. 2>&1 as .*@localhost/, output)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def run_command(*command, fixture: :with_accessories)
|
||||
stdouted { Kamal::Cli::Build.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }
|
||||
stdouted { stderred { Kamal::Cli::Build.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) } }
|
||||
end
|
||||
|
||||
def stub_dependency_checks
|
||||
@@ -274,17 +336,4 @@ class CliBuildTest < CliTestCase
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
.with { |*args| args[0..1] == [ :docker, :buildx ] }
|
||||
end
|
||||
|
||||
def with_build_directory
|
||||
build_directory = File.join Dir.tmpdir, "kamal-clones", "app-#{pwd_sha}", "kamal"
|
||||
FileUtils.mkdir_p build_directory
|
||||
FileUtils.touch File.join build_directory, "Dockerfile"
|
||||
yield build_directory + "/"
|
||||
ensure
|
||||
FileUtils.rm_rf build_directory
|
||||
end
|
||||
|
||||
def pwd_sha
|
||||
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -40,8 +40,9 @@ class CliTestCase < ActiveSupport::TestCase
|
||||
.with(:docker, :buildx, :inspect, "kamal-local-docker-container")
|
||||
end
|
||||
|
||||
def assert_hook_ran(hook, output, version:, service_version:, hosts:, command:, subcommand: nil, runtime: false, secrets: false)
|
||||
assert_match %r{usr/bin/env\s\.kamal/hooks/#{hook}}, output
|
||||
def assert_hook_ran(hook, output, count: 1)
|
||||
regexp = ([ "/usr/bin/env .kamal/hooks/#{hook}" ] * count).join(".*")
|
||||
assert_match /#{regexp}/m, output
|
||||
end
|
||||
|
||||
def with_argv(*argv)
|
||||
@@ -51,4 +52,17 @@ class CliTestCase < ActiveSupport::TestCase
|
||||
ensure
|
||||
ARGV.replace(old_argv)
|
||||
end
|
||||
|
||||
def with_build_directory
|
||||
build_directory = File.join Dir.tmpdir, "kamal-clones", "app-#{pwd_sha}", "kamal"
|
||||
FileUtils.mkdir_p build_directory
|
||||
FileUtils.touch File.join build_directory, "Dockerfile"
|
||||
yield build_directory + "/"
|
||||
ensure
|
||||
FileUtils.rm_rf build_directory
|
||||
end
|
||||
|
||||
def pwd_sha
|
||||
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -8,8 +8,7 @@ class CliMainTest < CliTestCase
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:server:bootstrap", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:accessory:boot", [ "all" ], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:deploy)
|
||||
Kamal::Cli::Main.any_instance.expects(:deploy).with(boot_accessories: true)
|
||||
|
||||
run_command("setup").tap do |output|
|
||||
assert_match /Ensure Docker is installed.../, output
|
||||
@@ -22,7 +21,6 @@ class CliMainTest < CliTestCase
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:server:bootstrap", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:accessory:boot", [ "all" ], invoke_options)
|
||||
# deploy
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: true))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:pull", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
@@ -33,7 +31,6 @@ class CliMainTest < CliTestCase
|
||||
assert_match /Ensure Docker is installed.../, output
|
||||
# deploy
|
||||
assert_match /Acquiring the deploy lock/, output
|
||||
assert_match /Log into image registry/, output
|
||||
assert_match /Pull app image/, output
|
||||
assert_match /Ensure kamal-proxy is running/, output
|
||||
assert_match /Detect stale containers/, output
|
||||
@@ -46,7 +43,6 @@ class CliMainTest < CliTestCase
|
||||
with_test_secrets("secrets" => "DB_PASSWORD=secret") do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false, "verbose" => true }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: false))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:deliver", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
@@ -54,17 +50,15 @@ class CliMainTest < CliTestCase
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:prune:all", [], invoke_options)
|
||||
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2", command: "deploy" }
|
||||
|
||||
run_command("deploy", "--verbose").tap do |output|
|
||||
assert_hook_ran "pre-connect", output, **hook_variables
|
||||
assert_match /Log into image registry/, output
|
||||
assert_hook_ran "pre-connect", output
|
||||
assert_match /Build and push app image/, output
|
||||
assert_hook_ran "pre-deploy", output, **hook_variables, secrets: true
|
||||
assert_hook_ran "pre-deploy", output
|
||||
assert_match /Ensure kamal-proxy is running/, output
|
||||
assert_match /Detect stale containers/, output
|
||||
assert_match /Prune old containers and images/, output
|
||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true, secrets: true
|
||||
assert_hook_ran "post-deploy", output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -72,7 +66,6 @@ class CliMainTest < CliTestCase
|
||||
test "deploy with skip_push" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: true))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:pull", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
@@ -81,7 +74,6 @@ class CliMainTest < CliTestCase
|
||||
|
||||
run_command("deploy", "--skip_push").tap do |output|
|
||||
assert_match /Acquiring the deploy lock/, output
|
||||
assert_match /Log into image registry/, output
|
||||
assert_match /Pull app image/, output
|
||||
assert_match /Ensure kamal-proxy is running/, output
|
||||
assert_match /Detect stale containers/, output
|
||||
@@ -124,6 +116,32 @@ class CliMainTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "deploy when inheriting lock" do
|
||||
Thread.report_on_exception = false
|
||||
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:deliver", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:prune:all", [], invoke_options)
|
||||
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
with_kamal_lock_env do
|
||||
KAMAL.reset
|
||||
run_command("deploy").tap do |output|
|
||||
assert_no_match /Acquiring the deploy lock/, output
|
||||
assert_match /Build and push app image/, output
|
||||
assert_match /Ensure kamal-proxy is running/, output
|
||||
assert_match /Detect stale containers/, output
|
||||
assert_match /Prune old containers and images/, output
|
||||
assert_no_match /Releasing the deploy lock/, output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "deploy error when locking" do
|
||||
Thread.report_on_exception = false
|
||||
|
||||
@@ -155,11 +173,11 @@ class CliMainTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "deploy errors during outside section leave remove lock" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false, :skip_local => false }
|
||||
test "deploy errors during outside section leave remote lock" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => false }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke)
|
||||
.with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: false))
|
||||
.with("kamal:cli:build:deliver", [], invoke_options)
|
||||
.raises(RuntimeError)
|
||||
|
||||
assert_not KAMAL.holding_lock?
|
||||
@@ -172,7 +190,6 @@ class CliMainTest < CliTestCase
|
||||
test "deploy with skipped hooks" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_simple.yml", "version" => "999", "skip_hooks" => true }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: false))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:deliver", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
@@ -187,7 +204,6 @@ class CliMainTest < CliTestCase
|
||||
test "deploy with missing secrets" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_with_secrets.yml", "version" => "999", "skip_hooks" => false }
|
||||
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:registry:login", [], invoke_options.merge(skip_local: false))
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:build:deliver", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:boot", [], invoke_options)
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true))
|
||||
@@ -206,14 +222,12 @@ class CliMainTest < CliTestCase
|
||||
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
|
||||
hook_variables = { version: 999, service_version: "app@999", hosts: "1.1.1.1,1.1.1.2", command: "redeploy" }
|
||||
|
||||
run_command("redeploy", "--verbose").tap do |output|
|
||||
assert_hook_ran "pre-connect", output, **hook_variables
|
||||
assert_hook_ran "pre-connect", output
|
||||
assert_match /Build and push app image/, output
|
||||
assert_hook_ran "pre-deploy", output, **hook_variables
|
||||
assert_hook_ran "pre-deploy", output
|
||||
assert_match /Running the pre-deploy hook.../, output
|
||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true
|
||||
assert_hook_ran "post-deploy", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -259,14 +273,13 @@ class CliMainTest < CliTestCase
|
||||
.returns("running").at_least_once # health check
|
||||
|
||||
Kamal::Commands::Hook.any_instance.stubs(:hook_exists?).returns(true)
|
||||
hook_variables = { version: 123, service_version: "app@123", hosts: "1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4", command: "rollback" }
|
||||
|
||||
run_command("rollback", "--verbose", "123", config_file: "deploy_with_accessories").tap do |output|
|
||||
assert_hook_ran "pre-deploy", output, **hook_variables
|
||||
assert_hook_ran "pre-deploy", output
|
||||
assert_match "docker tag dhh/app:123 dhh/app:latest", output
|
||||
assert_match "docker run --detach --restart unless-stopped --name app-web-123", output
|
||||
assert_match "docker container ls --all --filter name=^app-web-version-to-rollback$ --quiet | xargs docker stop", output, "Should stop the container that was previously running"
|
||||
assert_hook_ran "post-deploy", output, **hook_variables, runtime: true
|
||||
assert_hook_ran "post-deploy", output
|
||||
end
|
||||
end
|
||||
|
||||
@@ -460,6 +473,7 @@ class CliMainTest < CliTestCase
|
||||
|
||||
test "run an alias for a console" do
|
||||
run_command("console", config_file: "deploy_with_aliases").tap do |output|
|
||||
assert_no_match "App Host: 1.1.1.4", output
|
||||
assert_match "docker exec app-console-999 bin/console on 1.1.1.5", output
|
||||
assert_match "App Host: 1.1.1.5", output
|
||||
end
|
||||
@@ -486,6 +500,33 @@ class CliMainTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "switch config file with an alias" do
|
||||
with_config_files do
|
||||
with_argv([ "other_config" ]) do
|
||||
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||
assert_match ":service_with_version: app2-999", output
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "switch destination with an alias" do
|
||||
with_config_files do
|
||||
with_argv([ "other_destination_config" ]) do
|
||||
stdouted { Kamal::Cli::Main.start }.tap do |output|
|
||||
assert_match ":service_with_version: app3-999", output
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "run on primary via alias" do
|
||||
run_command("primary_details", config_file: "deploy_with_aliases").tap do |output|
|
||||
assert_match "App Host: 1.1.1.1", output
|
||||
assert_no_match "App Host: 1.1.1.2", output
|
||||
end
|
||||
end
|
||||
|
||||
test "upgrade" do
|
||||
invoke_options = { "config_file" => "test/fixtures/deploy_with_accessories.yml", "skip_hooks" => false, "confirmed" => true, "rolling" => false }
|
||||
Kamal::Cli::Main.any_instance.expects(:invoke).with("kamal:cli:proxy:upgrade", [], invoke_options)
|
||||
@@ -530,7 +571,28 @@ class CliMainTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
def with_config_files
|
||||
Dir.mktmpdir do |tmpdir|
|
||||
config_dir = File.join(tmpdir, "config")
|
||||
FileUtils.mkdir_p(config_dir)
|
||||
FileUtils.cp "test/fixtures/deploy.yml", config_dir
|
||||
FileUtils.cp "test/fixtures/deploy2.yml", config_dir
|
||||
FileUtils.cp "test/fixtures/deploy.elsewhere.yml", config_dir
|
||||
|
||||
Dir.chdir(tmpdir) do
|
||||
yield
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def assert_file(file, content)
|
||||
assert_match content, File.read(file)
|
||||
end
|
||||
|
||||
def with_kamal_lock_env
|
||||
ENV["KAMAL_LOCK"] = "true"
|
||||
yield
|
||||
ensure
|
||||
ENV.delete("KAMAL_LOCK")
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,25 +4,26 @@ class CliProxyTest < CliTestCase
|
||||
test "boot" do
|
||||
run_command("boot").tap do |output|
|
||||
assert_match "docker login", output
|
||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --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
|
||||
assert_match "mkdir -p .kamal/proxy/apps-config", output
|
||||
assert_match "echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy", output
|
||||
end
|
||||
end
|
||||
|
||||
test "boot old version" do
|
||||
Thread.report_on_exception = false
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :cut, "-d:", "-f2")
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :awk, "-F:", "'{print $NF}'")
|
||||
.returns("v0.0.1")
|
||||
.at_least_once
|
||||
|
||||
exception = assert_raises do
|
||||
run_command("boot").tap do |output|
|
||||
assert_match "docker login", output
|
||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --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
|
||||
assert_match "echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy", output
|
||||
end
|
||||
end
|
||||
|
||||
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}"
|
||||
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::Boot::MINIMUM_VERSION}"
|
||||
ensure
|
||||
Thread.report_on_exception = false
|
||||
end
|
||||
@@ -30,55 +31,33 @@ class CliProxyTest < CliTestCase
|
||||
test "boot correct version" do
|
||||
Thread.report_on_exception = false
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :cut, "-d:", "-f2")
|
||||
.returns(Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :awk, "-F:", "'{print $NF}'")
|
||||
.returns(Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION)
|
||||
.at_least_once
|
||||
|
||||
run_command("boot").tap do |output|
|
||||
assert_match "docker login", output
|
||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --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
|
||||
assert_match "docker container start kamal-proxy || echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy", output
|
||||
end
|
||||
ensure
|
||||
Thread.report_on_exception = false
|
||||
end
|
||||
|
||||
test "reboot" do
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
||||
.returns("abcdefabcdef")
|
||||
.at_least_once
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with { |*args| args[0..1] == [ :sh, "-c" ] }
|
||||
.returns("123")
|
||||
.at_least_once
|
||||
|
||||
run_command("reboot", "-y").tap do |output|
|
||||
assert_match "docker container stop kamal-proxy on 1.1.1.1", output
|
||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
|
||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
||||
assert_match "docker 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 "mkdir -p .kamal/proxy/apps-config on 1.1.1.1", output
|
||||
assert_match "echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --volume $(pwd)/.kamal/proxy/apps-config:/home/kamal-proxy/.apps-config on 1.1.1.1", output
|
||||
|
||||
assert_match "docker container stop kamal-proxy on 1.1.1.2", output
|
||||
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
|
||||
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
|
||||
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --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 "mkdir -p .kamal/proxy/apps-config on 1.1.1.1", output
|
||||
assert_match "echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --volume $(pwd)/.kamal/proxy/apps-config:/home/kamal-proxy/.apps-config on 1.1.1.2", output
|
||||
end
|
||||
end
|
||||
|
||||
test "reboot --rolling" do
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-123$", "--quiet")
|
||||
.returns("abcdefabcdef")
|
||||
.at_least_once
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with { |*args| args[0..1] == [ :sh, "-c" ] }
|
||||
.returns("123")
|
||||
.at_least_once
|
||||
|
||||
run_command("reboot", "--rolling", "-y").tap do |output|
|
||||
assert_match "Running docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
|
||||
end
|
||||
@@ -181,8 +160,8 @@ class CliProxyTest < CliTestCase
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("12345678")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :cut, "-d:", "-f2")
|
||||
.returns(Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :awk, "-F:", "'{print $NF}'")
|
||||
.returns(Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION)
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-workers-latest$", "--quiet", "|", :xargs, :docker, :inspect, "--format", "'{{if .State.Health}}{{.State.Health.Status}}{{else}}{{.State.Status}}{{end}}'")
|
||||
@@ -198,7 +177,7 @@ class CliProxyTest < CliTestCase
|
||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||
assert_match "docker network create kamal", output
|
||||
assert_match "docker login -u [REDACTED] -p [REDACTED]", output
|
||||
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --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 "docker container start kamal-proxy || echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy", output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal", output
|
||||
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
|
||||
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
|
||||
@@ -220,8 +199,8 @@ class CliProxyTest < CliTestCase
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("12345678")
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :cut, "-d:", "-f2")
|
||||
.returns(Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||
.with(:docker, :inspect, "kamal-proxy", "--format '{{.Config.Image}}'", "|", :awk, "-F:", "'{print $NF}'")
|
||||
.returns(Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION)
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-workers-latest$", "--quiet", "|", :xargs, :docker, :inspect, "--format", "'{{if .State.Health}}{{.State.Health.Status}}{{else}}{{.State.Status}}{{end}}'")
|
||||
@@ -240,7 +219,10 @@ class CliProxyTest < CliTestCase
|
||||
run_command("boot_config", "set").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -250,6 +232,9 @@ class CliProxyTest < CliTestCase
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -259,6 +244,9 @@ class CliProxyTest < CliTestCase
|
||||
%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
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -268,6 +256,9 @@ class CliProxyTest < CliTestCase
|
||||
%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
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -281,24 +272,112 @@ class CliProxyTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set bind IP" do
|
||||
run_command("boot_config", "set", "--publish-host-ip", "127.0.0.1").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--publish 127.0.0.1:80:80 --publish 127.0.0.1:443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set multiple bind IPs" do
|
||||
run_command("boot_config", "set", "--publish-host-ip", "127.0.0.1", "--publish-host-ip", "::1").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--publish 127.0.0.1:80:80 --publish 127.0.0.1:443:443 --publish [::1]:80:80 --publish [::1]:443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set invalid bind IPs" do
|
||||
exception = assert_raises do
|
||||
run_command("boot_config", "set", "--publish-host-ip", "1.2.3.invalidIP", "--publish-host-ip", "::1")
|
||||
end
|
||||
|
||||
assert_includes exception.message, "Invalid publish IP address: 1.2.3.invalidIP"
|
||||
end
|
||||
|
||||
test "boot_config set docker options" do
|
||||
run_command("boot_config", "set", "--docker_options", "label=foo=bar", "add_host=thishost:thathost").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m --label=foo=bar --add_host=thishost:thathost\" to .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set registry" do
|
||||
run_command("boot_config", "set", "--registry", "myreg").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 "Running /usr/bin/env rm .kamal/proxy/options on #{host}", output
|
||||
assert_match "Uploading \"myreg/basecamp/kamal-proxy\" to .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set repository" do
|
||||
run_command("boot_config", "set", "--repository", "myrepo").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 "Running /usr/bin/env rm .kamal/proxy/options on #{host}", output
|
||||
assert_match "Uploading \"myrepo/kamal-proxy\" to .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set image_version" do
|
||||
run_command("boot_config", "set", "--image_version", "0.9.9").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 "Running /usr/bin/env rm .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Uploading \"0.9.9\" to .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set run_command" do
|
||||
run_command("boot_config", "set", "--metrics_port", "9000", "--debug", "true").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
|
||||
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m --expose=9000\" to .kamal/proxy/options on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image on #{host}", output
|
||||
assert_match "Running /usr/bin/env rm .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Uploading \"kamal-proxy run --debug --metrics-port \\\"9000\\\"\" to .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config set all" do
|
||||
run_command("boot_config", "set", "--docker_options", "label=foo=bar", "--registry", "myreg", "--repository", "myrepo", "--image_version", "0.9.9", "--metrics_port", "9000", "--debug", "true").tap do |output|
|
||||
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
|
||||
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m --expose=9000 --label=foo=bar\" to .kamal/proxy/options on #{host}", output
|
||||
assert_match "Uploading \"myreg/myrepo/kamal-proxy\" to .kamal/proxy/image on #{host}", output
|
||||
assert_match "Uploading \"0.9.9\" to .kamal/proxy/image_version on #{host}", output
|
||||
assert_match "Uploading \"kamal-proxy run --debug --metrics-port \\\"9000\\\"\" to .kamal/proxy/run_command on #{host}", output
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "boot_config get" do
|
||||
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
|
||||
.with(:cat, ".kamal/proxy/options", "||", :echo, "\"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"")
|
||||
.returns("--publish 80:80 --publish 8443:443 --label=foo=bar")
|
||||
.with(:echo, "$(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\")")
|
||||
.returns("--publish 80:80 --publish 8443:443 --label=foo=bar basecamp/kamal-proxy:v1.0.0")
|
||||
.twice
|
||||
|
||||
run_command("boot_config", "get").tap do |output|
|
||||
assert_match "Host 1.1.1.1: --publish 80:80 --publish 8443:443 --label=foo=bar", output
|
||||
assert_match "Host 1.1.1.2: --publish 80:80 --publish 8443:443 --label=foo=bar", output
|
||||
assert_match "Host 1.1.1.1: --publish 80:80 --publish 8443:443 --label=foo=bar basecamp/kamal-proxy:v1.0.0", output
|
||||
assert_match "Host 1.1.1.2: --publish 80:80 --publish 8443:443 --label=foo=bar basecamp/kamal-proxy:v1.0.0", output
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -43,6 +43,28 @@ class CliRegistryTest < CliTestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "login with no docker" do
|
||||
stub_setup
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
.with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||
.raises(SSHKit::Command::Failed.new("command not found"))
|
||||
|
||||
assert_raises(Kamal::Cli::DependencyError) { run_command("login") }
|
||||
end
|
||||
|
||||
test "allow remote login with no docker" do
|
||||
stub_setup
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
.with(:docker, "--version", "&&", :docker, :buildx, "version")
|
||||
.raises(SSHKit::Command::Failed.new("command not found"))
|
||||
|
||||
SSHKit::Backend::Abstract.any_instance.stubs(:execute)
|
||||
.with { |*args| args[0..1] == [ :docker, :login ] }
|
||||
|
||||
assert_nothing_raised { run_command("login", "--skip-local") }
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
def run_command(*command)
|
||||
stdouted { Kamal::Cli::Registry.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }
|
||||
|
||||
@@ -13,12 +13,6 @@ class CliSecretsTest < CliTestCase
|
||||
run_command("fetch", "foo", "bar", "baz", "--adapter", "test")
|
||||
end
|
||||
|
||||
test "fetch without required --account" do
|
||||
assert_equal \
|
||||
"\\{\\\"foo\\\":\\\"oof\\\",\\\"bar\\\":\\\"rab\\\",\\\"baz\\\":\\\"zab\\\"\\}",
|
||||
run_command("fetch", "foo", "bar", "baz", "--adapter", "test_optional_account")
|
||||
end
|
||||
|
||||
test "extract" do
|
||||
assert_equal "oof", run_command("extract", "foo", "{\"foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
|
||||
end
|
||||
|
||||
@@ -104,28 +104,6 @@ class CommanderTest < ActiveSupport::TestCase
|
||||
assert_equal [ "web", "workers" ], @kamal.roles_on("1.1.1.1").map(&:name)
|
||||
end
|
||||
|
||||
test "default group strategy" do
|
||||
assert_empty @kamal.boot_strategy
|
||||
end
|
||||
|
||||
test "specific limit group strategy" do
|
||||
configure_with(:deploy_with_boot_strategy)
|
||||
|
||||
assert_equal({ in: :groups, limit: 3, wait: 2 }, @kamal.boot_strategy)
|
||||
end
|
||||
|
||||
test "percentage-based group strategy" do
|
||||
configure_with(:deploy_with_percentage_boot_strategy)
|
||||
|
||||
assert_equal({ in: :groups, limit: 1, wait: 2 }, @kamal.boot_strategy)
|
||||
end
|
||||
|
||||
test "percentage-based group strategy limit is at least 1" do
|
||||
configure_with(:deploy_with_low_percentage_boot_strategy)
|
||||
|
||||
assert_equal({ in: :groups, limit: 1, wait: 2 }, @kamal.boot_strategy)
|
||||
end
|
||||
|
||||
test "try to match the primary role from a list of specific roles" do
|
||||
configure_with(:deploy_primary_web_role_override)
|
||||
|
||||
@@ -171,6 +149,12 @@ class CommanderTest < ActiveSupport::TestCase
|
||||
assert_equal [], @kamal.accessory_hosts
|
||||
end
|
||||
|
||||
test "primary role hosts are first" do
|
||||
configure_with(:deploy_with_roles_workers_primary)
|
||||
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @kamal.hosts
|
||||
assert_equal [ "1.1.1.1", "1.1.1.2", "1.1.1.3", "1.1.1.4" ], @kamal.app_hosts
|
||||
end
|
||||
|
||||
private
|
||||
def configure_with(variant)
|
||||
@kamal = Kamal::Commander.new.tap do |kamal|
|
||||
|
||||
@@ -5,7 +5,9 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
setup_test_secrets("secrets" => "MYSQL_ROOT_PASSWORD=secret123")
|
||||
|
||||
@config = {
|
||||
service: "app", image: "dhh/app", registry: { "server" => "private.registry", "username" => "dhh", "password" => "secret" },
|
||||
service: "app",
|
||||
image: "dhh/app",
|
||||
registry: { "server" => "private.registry", "username" => "dhh", "password" => "secret" },
|
||||
servers: [ "1.1.1.1" ],
|
||||
builder: { "arch" => "amd64" },
|
||||
accessories: {
|
||||
@@ -39,6 +41,7 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
"busybox" => {
|
||||
"service" => "custom-busybox",
|
||||
"image" => "busybox:latest",
|
||||
"registry" => { "server" => "other.registry", "username" => "user", "password" => "pw" },
|
||||
"host" => "1.1.1.7",
|
||||
"proxy" => {
|
||||
"host" => "busybox.example.com"
|
||||
@@ -62,7 +65,7 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
new_command(:redis).run.join(" ")
|
||||
|
||||
assert_equal \
|
||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" busybox:latest",
|
||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-opt max-size=\"10m\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" other.registry/busybox:latest",
|
||||
new_command(:busybox).run.join(" ")
|
||||
end
|
||||
|
||||
@@ -70,7 +73,7 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
|
||||
|
||||
assert_equal \
|
||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" busybox:latest",
|
||||
"docker run --name custom-busybox --detach --restart unless-stopped --network kamal --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" --env-file .kamal/apps/app/env/accessories/busybox.env --label service=\"custom-busybox\" other.registry/busybox:latest",
|
||||
new_command(:busybox).run.join(" ")
|
||||
end
|
||||
|
||||
@@ -100,7 +103,6 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
new_command(:mysql).info.join(" ")
|
||||
end
|
||||
|
||||
|
||||
test "execute in new container" do
|
||||
assert_equal \
|
||||
"docker run --rm --network kamal --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env private.registry/mysql:8.0 mysql -u root",
|
||||
@@ -127,8 +129,6 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
|
||||
test "logs" do
|
||||
assert_equal \
|
||||
"docker logs app-mysql --timestamps 2>&1",
|
||||
|
||||
@@ -469,10 +469,10 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
test "extract assets" do
|
||||
assert_equal [
|
||||
:mkdir, "-p", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
||||
:docker, :stop, "-t 1", "app-web-assets", "2> /dev/null", "|| true", "&&",
|
||||
:docker, :run, "--name", "app-web-assets", "--detach", "--rm", "--entrypoint", "sleep", "dhh/app:999", "1000000", "&&",
|
||||
:docker, :cp, "-L", "app-web-assets:/public/assets/.", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
||||
:docker, :stop, "-t 1", "app-web-assets"
|
||||
:docker, :container, :rm, "app-web-assets", "2> /dev/null", "|| true", "&&",
|
||||
:docker, :container, :create, "--name", "app-web-assets", "dhh/app:999", "&&",
|
||||
:docker, :container, :cp, "-L", "app-web-assets:/public/assets/.", ".kamal/apps/app/assets/extracted/web-999", "&&",
|
||||
:docker, :container, :rm, "app-web-assets"
|
||||
], new_command(asset_path: "/public/assets").extract_assets
|
||||
end
|
||||
|
||||
@@ -497,6 +497,30 @@ class CommandsAppTest < ActiveSupport::TestCase
|
||||
], new_command(asset_path: "/public/assets").clean_up_assets
|
||||
end
|
||||
|
||||
test "live" do
|
||||
assert_equal \
|
||||
"docker exec kamal-proxy kamal-proxy resume app-web",
|
||||
new_command.live.join(" ")
|
||||
end
|
||||
|
||||
test "maintenance" do
|
||||
assert_equal \
|
||||
"docker exec kamal-proxy kamal-proxy stop app-web",
|
||||
new_command.maintenance.join(" ")
|
||||
end
|
||||
|
||||
test "maintenance with options" do
|
||||
assert_equal \
|
||||
"docker exec kamal-proxy kamal-proxy stop app-web --drain-timeout=\"10s\" --message=\"Hi\"",
|
||||
new_command.maintenance(drain_timeout: 10, message: "Hi").join(" ")
|
||||
end
|
||||
|
||||
test "remove_proxy_app_directory" do
|
||||
assert_equal \
|
||||
"rm -r .kamal/proxy/apps-config/app",
|
||||
new_command.remove_proxy_app_directory.join(" ")
|
||||
end
|
||||
|
||||
private
|
||||
def new_command(role: "web", host: "1.1.1.1", **additional_config)
|
||||
config = Kamal::Configuration.new(@config.merge(additional_config), destination: @destination, version: "999")
|
||||
|
||||
@@ -20,8 +20,7 @@ class CommandsAuditorTest < ActiveSupport::TestCase
|
||||
assert_equal [
|
||||
:mkdir, "-p", ".kamal", "&&",
|
||||
:echo,
|
||||
"[#{@recorded_at}] [#{@performer}]",
|
||||
"app removed container",
|
||||
"\"[#{@recorded_at}] [#{@performer}] app removed container\"",
|
||||
">>", ".kamal/app-audit.log"
|
||||
], @auditor.record("app removed container")
|
||||
end
|
||||
@@ -31,8 +30,7 @@ class CommandsAuditorTest < ActiveSupport::TestCase
|
||||
assert_equal [
|
||||
:mkdir, "-p", ".kamal", "&&",
|
||||
:echo,
|
||||
"[#{@recorded_at}] [#{@performer}] [staging]",
|
||||
"app removed container",
|
||||
"\"[#{@recorded_at}] [#{@performer}] [staging] app removed container\"",
|
||||
">>", ".kamal/app-staging-audit.log"
|
||||
], auditor.record("app removed container")
|
||||
end
|
||||
@@ -43,8 +41,7 @@ class CommandsAuditorTest < ActiveSupport::TestCase
|
||||
assert_equal [
|
||||
:mkdir, "-p", ".kamal", "&&",
|
||||
:echo,
|
||||
"[#{@recorded_at}] [#{@performer}] [web]",
|
||||
"app removed container",
|
||||
"\"[#{@recorded_at}] [#{@performer}] [web] app removed container\"",
|
||||
">>", ".kamal/app-audit.log"
|
||||
], auditor.record("app removed container")
|
||||
end
|
||||
@@ -54,8 +51,7 @@ class CommandsAuditorTest < ActiveSupport::TestCase
|
||||
assert_equal [
|
||||
:mkdir, "-p", ".kamal", "&&",
|
||||
:echo,
|
||||
"[#{@recorded_at}] [#{@performer}] [value]",
|
||||
"app removed container",
|
||||
"\"[#{@recorded_at}] [#{@performer}] [value] app removed container\"",
|
||||
">>", ".kamal/app-audit.log"
|
||||
], @auditor.record("app removed container", detail: "value")
|
||||
end
|
||||
|
||||
@@ -9,7 +9,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
||||
assert_equal "local", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -17,7 +17,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "arch" => [ "amd64" ] })
|
||||
assert_equal "local", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -25,7 +25,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "cache" => { "type" => "gha" } })
|
||||
assert_equal "local", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -33,7 +33,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" } })
|
||||
assert_equal "hybrid", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder kamal-hybrid-docker-container-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64,linux/arm64 --builder kamal-hybrid-docker-container-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -41,7 +41,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "arch" => [ "amd64", "arm64" ], "remote" => "ssh://app@127.0.0.1", "cache" => { "type" => "gha" }, "local" => false })
|
||||
assert_equal "remote", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64,linux/arm64 --builder kamal-remote-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64,linux/arm64 --builder kamal-remote-ssh---app-127-0-0-1 -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -49,7 +49,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "arch" => [ "#{remote_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
||||
assert_equal "remote", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/#{remote_arch} --builder kamal-remote-ssh---app-host -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/#{remote_arch} --builder kamal-remote-ssh---app-host -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -57,14 +57,22 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "arch" => [ "#{local_arch}" ], "remote" => "ssh://app@host", "cache" => { "type" => "gha" } })
|
||||
assert_equal "local", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/#{local_arch} --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/#{local_arch} --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --cache-to type=gha --cache-from type=gha --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
test "cloud builder" do
|
||||
builder = new_builder_command(builder: { "arch" => [ "#{local_arch}" ], "driver" => "cloud docker-org-name/builder-name" })
|
||||
assert_equal "cloud", builder.name
|
||||
assert_equal \
|
||||
"docker buildx build --output=type=registry --platform linux/#{local_arch} --builder cloud-docker-org-name-builder-name -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
test "build args" do
|
||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||
assert_equal \
|
||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile",
|
||||
"--label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile",
|
||||
builder.target.build_options.join(" ")
|
||||
end
|
||||
|
||||
@@ -73,7 +81,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
FileUtils.touch("Dockerfile")
|
||||
builder = new_builder_command(builder: { "secrets" => [ "token_a", "token_b" ] })
|
||||
assert_equal \
|
||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"token_a\" --secret id=\"token_b\" --file Dockerfile",
|
||||
"--label service=\"app\" --secret id=\"token_a\" --secret id=\"token_b\" --file Dockerfile",
|
||||
builder.target.build_options.join(" ")
|
||||
end
|
||||
end
|
||||
@@ -82,7 +90,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
Pathname.any_instance.expects(:exist?).returns(true).once
|
||||
builder = new_builder_command(builder: { "dockerfile" => "Dockerfile.xyz" })
|
||||
assert_equal \
|
||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile.xyz",
|
||||
"--label service=\"app\" --file Dockerfile.xyz",
|
||||
builder.target.build_options.join(" ")
|
||||
end
|
||||
|
||||
@@ -97,21 +105,21 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
test "build target" do
|
||||
builder = new_builder_command(builder: { "target" => "prod" })
|
||||
assert_equal \
|
||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --target prod",
|
||||
"--label service=\"app\" --file Dockerfile --target prod",
|
||||
builder.target.build_options.join(" ")
|
||||
end
|
||||
|
||||
test "build context" do
|
||||
builder = new_builder_command(builder: { "context" => ".." })
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ..",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile .. 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
test "push with build args" do
|
||||
builder = new_builder_command(builder: { "args" => { "a" => 1, "b" => 2 } })
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --build-arg a=\"1\" --build-arg b=\"2\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
@@ -120,7 +128,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
FileUtils.touch("Dockerfile")
|
||||
builder = new_builder_command(builder: { "secrets" => [ "a", "b" ] })
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"a\" --secret id=\"b\" --file Dockerfile .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --secret id=\"a\" --secret id=\"b\" --file Dockerfile . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
end
|
||||
@@ -129,7 +137,7 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
builder = new_builder_command(builder: { "ssh" => "default=$SSH_AUTH_SOCK" })
|
||||
|
||||
assert_equal \
|
||||
"-t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --ssh default=$SSH_AUTH_SOCK",
|
||||
"--label service=\"app\" --file Dockerfile --ssh default=$SSH_AUTH_SOCK",
|
||||
builder.target.build_options.join(" ")
|
||||
end
|
||||
|
||||
@@ -140,35 +148,35 @@ class CommandsBuilderTest < ActiveSupport::TestCase
|
||||
test "context build" do
|
||||
builder = new_builder_command(builder: { "context" => "./foo" })
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ./foo",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile ./foo 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
test "push with provenance" do
|
||||
builder = new_builder_command(builder: { "provenance" => "mode=max" })
|
||||
assert_equal \
|
||||
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance mode=max .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance mode=max . 2>&1",
|
||||
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 .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance false . 2>&1",
|
||||
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 .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --sbom true . 2>&1",
|
||||
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 .",
|
||||
"docker buildx build --output=type=registry --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --sbom false . 2>&1",
|
||||
builder.push.join(" ")
|
||||
end
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
|
||||
test "run" do
|
||||
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 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||
"echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --volume $(pwd)/.kamal/proxy/apps-config:/home/kamal-proxy/.apps-config",
|
||||
new_command.run.join(" ")
|
||||
end
|
||||
|
||||
@@ -23,7 +23,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
@config.delete(:proxy)
|
||||
|
||||
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 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
|
||||
"echo $(cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") $(cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"):$(cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\") $(cat .kamal/proxy/run_command 2> /dev/null || echo \"\") | xargs docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --volume $(pwd)/.kamal/proxy/apps-config:/home/kamal-proxy/.apps-config",
|
||||
new_command.run.join(" ")
|
||||
end
|
||||
|
||||
@@ -101,7 +101,7 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
|
||||
test "version" do
|
||||
assert_equal \
|
||||
"docker inspect kamal-proxy --format '{{.Config.Image}}' | cut -d: -f2",
|
||||
"docker inspect kamal-proxy --format '{{.Config.Image}}' | awk -F: '{print $NF}'",
|
||||
new_command.version.join(" ")
|
||||
end
|
||||
|
||||
@@ -111,10 +111,28 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
new_command.ensure_proxy_directory.join(" ")
|
||||
end
|
||||
|
||||
test "get_boot_options" do
|
||||
test "read_boot_options" do
|
||||
assert_equal \
|
||||
"cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"",
|
||||
new_command.get_boot_options.join(" ")
|
||||
"cat .kamal/proxy/options 2> /dev/null || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"",
|
||||
new_command.read_boot_options.join(" ")
|
||||
end
|
||||
|
||||
test "read_image" do
|
||||
assert_equal \
|
||||
"cat .kamal/proxy/image 2> /dev/null || echo \"basecamp/kamal-proxy\"",
|
||||
new_command.read_image.join(" ")
|
||||
end
|
||||
|
||||
test "read_image_version" do
|
||||
assert_equal \
|
||||
"cat .kamal/proxy/image_version 2> /dev/null || echo \"#{Kamal::Configuration::Proxy::Boot::MINIMUM_VERSION}\"",
|
||||
new_command.read_image_version.join(" ")
|
||||
end
|
||||
|
||||
test "read_run_command" do
|
||||
assert_equal \
|
||||
"cat .kamal/proxy/run_command 2> /dev/null || echo \"\"",
|
||||
new_command.read_run_command.join(" ")
|
||||
end
|
||||
|
||||
test "reset_boot_options" do
|
||||
@@ -123,6 +141,30 @@ class CommandsProxyTest < ActiveSupport::TestCase
|
||||
new_command.reset_boot_options.join(" ")
|
||||
end
|
||||
|
||||
test "reset_image" do
|
||||
assert_equal \
|
||||
"rm .kamal/proxy/image",
|
||||
new_command.reset_image.join(" ")
|
||||
end
|
||||
|
||||
test "reset_image_version" do
|
||||
assert_equal \
|
||||
"rm .kamal/proxy/image_version",
|
||||
new_command.reset_image_version.join(" ")
|
||||
end
|
||||
|
||||
test "ensure_apps_config_directory" do
|
||||
assert_equal \
|
||||
"mkdir -p .kamal/proxy/apps-config",
|
||||
new_command.ensure_apps_config_directory.join(" ")
|
||||
end
|
||||
|
||||
test "reset_run_command" do
|
||||
assert_equal \
|
||||
"rm .kamal/proxy/run_command",
|
||||
new_command.reset_run_command.join(" ")
|
||||
end
|
||||
|
||||
private
|
||||
def new_command
|
||||
Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123"))
|
||||
|
||||
@@ -2,14 +2,27 @@ require "test_helper"
|
||||
|
||||
class CommandsRegistryTest < ActiveSupport::TestCase
|
||||
setup do
|
||||
@config = { service: "app",
|
||||
@config = {
|
||||
service: "app",
|
||||
image: "dhh/app",
|
||||
registry: { "username" => "dhh",
|
||||
registry: {
|
||||
"username" => "dhh",
|
||||
"password" => "secret",
|
||||
"server" => "hub.docker.com"
|
||||
},
|
||||
builder: { "arch" => "amd64" },
|
||||
servers: [ "1.1.1.1" ]
|
||||
servers: [ "1.1.1.1" ],
|
||||
accessories: {
|
||||
"db" => {
|
||||
"image" => "mysql:8.0",
|
||||
"hosts" => [ "1.1.1.1" ],
|
||||
"registry" => {
|
||||
"username" => "user",
|
||||
"password" => "pw",
|
||||
"server" => "other.hub.docker.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
@@ -19,13 +32,24 @@ class CommandsRegistryTest < ActiveSupport::TestCase
|
||||
registry.login.join(" ")
|
||||
end
|
||||
|
||||
test "given registry login" do
|
||||
assert_equal \
|
||||
"docker login other.hub.docker.com -u \"user\" -p \"pw\"",
|
||||
registry.login(registry_config: accessory_registry_config).join(" ")
|
||||
end
|
||||
|
||||
test "registry login with ENV password" do
|
||||
with_test_secrets("secrets" => "KAMAL_REGISTRY_PASSWORD=more-secret") do
|
||||
with_test_secrets("secrets" => "KAMAL_REGISTRY_PASSWORD=more-secret\nKAMAL_MYSQL_REGISTRY_PASSWORD=secret-pw") do
|
||||
@config[:registry]["password"] = [ "KAMAL_REGISTRY_PASSWORD" ]
|
||||
@config[:accessories]["db"]["registry"]["password"] = [ "KAMAL_MYSQL_REGISTRY_PASSWORD" ]
|
||||
|
||||
assert_equal \
|
||||
"docker login hub.docker.com -u \"dhh\" -p \"more-secret\"",
|
||||
registry.login.join(" ")
|
||||
|
||||
assert_equal \
|
||||
"docker login other.hub.docker.com -u \"user\" -p \"secret-pw\"",
|
||||
registry.login(registry_config: accessory_registry_config).join(" ")
|
||||
end
|
||||
end
|
||||
|
||||
@@ -55,8 +79,22 @@ class CommandsRegistryTest < ActiveSupport::TestCase
|
||||
registry.logout.join(" ")
|
||||
end
|
||||
|
||||
test "given registry logout" do
|
||||
assert_equal \
|
||||
"docker logout other.hub.docker.com",
|
||||
registry.logout(registry_config: accessory_registry_config).join(" ")
|
||||
end
|
||||
|
||||
private
|
||||
def registry
|
||||
Kamal::Commands::Registry.new Kamal::Configuration.new(@config)
|
||||
Kamal::Commands::Registry.new main_config
|
||||
end
|
||||
|
||||
def main_config
|
||||
Kamal::Configuration.new(@config)
|
||||
end
|
||||
|
||||
def accessory_registry_config
|
||||
main_config.accessory("db").registry
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,16 +3,18 @@ require "test_helper"
|
||||
class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
setup do
|
||||
@deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||
service: "app",
|
||||
image: "dhh/app",
|
||||
registry: { "username" => "dhh", "password" => "secret" },
|
||||
servers: {
|
||||
"web" => [ "1.1.1.1", "1.1.1.2" ],
|
||||
"workers" => [ "1.1.1.3", "1.1.1.4" ]
|
||||
"web" => [ { "1.1.1.1" => "writer" }, { "1.1.1.2" => "reader" } ],
|
||||
"workers" => [ { "1.1.1.3" => "writer" }, "1.1.1.4" ]
|
||||
},
|
||||
builder: { "arch" => "amd64" },
|
||||
env: { "REDIS_URL" => "redis://x/y" },
|
||||
accessories: {
|
||||
"mysql" => {
|
||||
"image" => "mysql:8.0",
|
||||
"image" => "public.registry/mysql:8.0",
|
||||
"host" => "1.1.1.5",
|
||||
"port" => "3306",
|
||||
"env" => {
|
||||
@@ -52,7 +54,8 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
"monitoring" => {
|
||||
"service" => "custom-monitoring",
|
||||
"image" => "monitoring:latest",
|
||||
"roles" => [ "web" ],
|
||||
"registry" => { "server" => "other.registry", "username" => "user", "password" => "pw" },
|
||||
"role" => "web",
|
||||
"port" => "4321:4321",
|
||||
"labels" => {
|
||||
"cache" => "true"
|
||||
@@ -67,6 +70,14 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
"proxy" => {
|
||||
"host" => "monitoring.example.com"
|
||||
}
|
||||
},
|
||||
"proxy" => {
|
||||
"image" => "proxy:latest",
|
||||
"tags" => [ "writer", "reader" ]
|
||||
},
|
||||
"logger" => {
|
||||
"image" => "logger:latest",
|
||||
"tag" => "writer"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -80,6 +91,21 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
assert_equal "custom-monitoring", @config.accessory(:monitoring).service_name
|
||||
end
|
||||
|
||||
test "image" do
|
||||
assert_equal "public.registry/mysql:8.0", @config.accessory(:mysql).image
|
||||
assert_equal "redis:latest", @config.accessory(:redis).image
|
||||
assert_equal "other.registry/monitoring:latest", @config.accessory(:monitoring).image
|
||||
end
|
||||
|
||||
test "registry" do
|
||||
assert_nil @config.accessory(:mysql).registry
|
||||
assert_nil @config.accessory(:redis).registry
|
||||
monitoring_registry = @config.accessory(:monitoring).registry
|
||||
assert_equal "other.registry", monitoring_registry.server
|
||||
assert_equal "user", monitoring_registry.username
|
||||
assert_equal "pw", monitoring_registry.password
|
||||
end
|
||||
|
||||
test "port" do
|
||||
assert_equal "3306:3306", @config.accessory(:mysql).port
|
||||
assert_equal "6379:6379", @config.accessory(:redis).port
|
||||
@@ -89,6 +115,8 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
assert_equal [ "1.1.1.5" ], @config.accessory(:mysql).hosts
|
||||
assert_equal [ "1.1.1.6", "1.1.1.7" ], @config.accessory(:redis).hosts
|
||||
assert_equal [ "1.1.1.1", "1.1.1.2" ], @config.accessory(:monitoring).hosts
|
||||
assert_equal [ "1.1.1.1", "1.1.1.3", "1.1.1.2" ], @config.accessory(:proxy).hosts
|
||||
assert_equal [ "1.1.1.1", "1.1.1.3" ], @config.accessory(:logger).hosts
|
||||
end
|
||||
|
||||
test "missing host" do
|
||||
@@ -99,14 +127,14 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "setting host, hosts and roles" do
|
||||
test "setting host, hosts, roles and tags" do
|
||||
@deploy[:accessories]["mysql"]["hosts"] = [ "mysql-db1" ]
|
||||
@deploy[:accessories]["mysql"]["roles"] = [ "db" ]
|
||||
|
||||
exception = assert_raises(Kamal::ConfigurationError) do
|
||||
Kamal::Configuration.new(@deploy)
|
||||
end
|
||||
assert_equal "accessories/mysql: specify one of `host`, `hosts` or `roles`", exception.message
|
||||
assert_equal "accessories/mysql: specify one of `host`, `hosts`, `role`, `roles`, `tag` or `tags`", exception.message
|
||||
end
|
||||
|
||||
test "all hosts" do
|
||||
@@ -169,4 +197,12 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
|
||||
assert @config.accessory(:monitoring).running_proxy?
|
||||
assert_equal [ "monitoring.example.com" ], @config.accessory(:monitoring).proxy.hosts
|
||||
end
|
||||
|
||||
test "can't set restart in options" do
|
||||
@deploy[:accessories]["mysql"]["options"] = { "restart" => "always" }
|
||||
|
||||
assert_raises Kamal::ConfigurationError, "servers/workers: Cannot set restart policy in docker options, unless-stopped is required" do
|
||||
Kamal::Configuration.new(@deploy)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
54
test/configuration/boot_test.rb
Normal file
54
test/configuration/boot_test.rb
Normal file
@@ -0,0 +1,54 @@
|
||||
require "test_helper"
|
||||
|
||||
class ConfigurationBootTest < ActiveSupport::TestCase
|
||||
test "no group strategy" do
|
||||
deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] }
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
|
||||
assert_nil config.boot.limit
|
||||
assert_nil config.boot.wait
|
||||
end
|
||||
|
||||
test "specific limit group strategy" do
|
||||
deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||
boot: { "limit" => 3, "wait" => 2 }
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
|
||||
assert_equal 3, config.boot.limit
|
||||
assert_equal 2, config.boot.wait
|
||||
end
|
||||
|
||||
test "percentage-based group strategy" do
|
||||
deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||
boot: { "limit" => "50%", "wait" => 2 }
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
|
||||
assert_equal 2, config.boot.limit
|
||||
assert_equal 2, config.boot.wait
|
||||
end
|
||||
|
||||
test "percentage-based group strategy limit is at least 1" do
|
||||
deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, builder: { "arch" => "amd64" },
|
||||
servers: { "web" => [ "1.1.1.1", "1.1.1.2" ], "workers" => [ "1.1.1.3", "1.1.1.4" ] },
|
||||
boot: { "limit" => "1%", "wait" => 2 }
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
|
||||
assert_equal 1, config.boot.limit
|
||||
assert_equal 2, config.boot.wait
|
||||
end
|
||||
end
|
||||
20
test/configuration/env/tags_test.rb
vendored
20
test/configuration/env/tags_test.rb
vendored
@@ -92,7 +92,25 @@ class ConfigurationEnvTagsTest < ActiveSupport::TestCase
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
assert_equal "hello", config.role("web").env("1.1.1.1").secrets["PASSWORD"]
|
||||
assert_equal "PASSWORD=hello\n", config.role("web").env("1.1.1.1").secrets_io.string
|
||||
end
|
||||
end
|
||||
|
||||
test "aliased tag secret env" do
|
||||
with_test_secrets("secrets" => "PASSWORD=hello\nALIASED_PASSWORD=aliased_hello") do
|
||||
deploy = {
|
||||
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
|
||||
servers: [ { "1.1.1.1" => "secrets" } ],
|
||||
builder: { "arch" => "amd64" },
|
||||
env: {
|
||||
"tags" => {
|
||||
"secrets" => { "secret" => [ "PASSWORD:ALIASED_PASSWORD" ] }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
config = Kamal::Configuration.new(deploy)
|
||||
assert_equal "PASSWORD=aliased_hello\n", config.role("web").env("1.1.1.1").secrets_io.string
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -48,6 +48,20 @@ class ConfigurationEnvTest < ActiveSupport::TestCase
|
||||
end
|
||||
end
|
||||
|
||||
test "aliased secrets" do
|
||||
with_test_secrets("secrets" => "ALIASED_PASSWORD=hello") do
|
||||
config = {
|
||||
"secret" => [ "PASSWORD:ALIASED_PASSWORD" ],
|
||||
"clear" => {}
|
||||
}
|
||||
|
||||
assert_config \
|
||||
config: config,
|
||||
clear: {},
|
||||
secrets: { "PASSWORD" => "hello" }
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def assert_config(config:, clear: {}, secrets: {})
|
||||
env = Kamal::Configuration::Env.new config: config, secrets: Kamal::Secrets.new
|
||||
|
||||
29
test/configuration/proxy/boot_test.rb
Normal file
29
test/configuration/proxy/boot_test.rb
Normal file
@@ -0,0 +1,29 @@
|
||||
require "test_helper"
|
||||
|
||||
class ConfigurationProxyBootTest < ActiveSupport::TestCase
|
||||
setup do
|
||||
ENV["RAILS_MASTER_KEY"] = "456"
|
||||
ENV["VERSION"] = "missing"
|
||||
|
||||
@deploy = {
|
||||
service: "app", image: "dhh/app",
|
||||
registry: { "username" => "dhh", "password" => "secret" },
|
||||
builder: { "arch" => "amd64" },
|
||||
env: { "REDIS_URL" => "redis://x/y" },
|
||||
servers: [ "1.1.1.1", "1.1.1.2" ],
|
||||
volumes: [ "/local/path:/container/path" ]
|
||||
}
|
||||
|
||||
@config = Kamal::Configuration.new(@deploy)
|
||||
@proxy_boot_config = @config.proxy_boot
|
||||
end
|
||||
|
||||
test "proxy directories" do
|
||||
assert_equal ".kamal/proxy/apps-config", @proxy_boot_config.apps_directory
|
||||
assert_equal "/home/kamal-proxy/.apps-config", @proxy_boot_config.apps_container_directory
|
||||
assert_equal ".kamal/proxy/apps-config/app", @proxy_boot_config.app_directory
|
||||
assert_equal "/home/kamal-proxy/.apps-config/app", @proxy_boot_config.app_container_directory
|
||||
assert_equal ".kamal/proxy/apps-config/app/error_pages", @proxy_boot_config.error_pages_directory
|
||||
assert_equal "/home/kamal-proxy/.apps-config/app/error_pages", @proxy_boot_config.error_pages_container_directory
|
||||
end
|
||||
end
|
||||
@@ -38,6 +38,13 @@ class ConfigurationProxyTest < ActiveSupport::TestCase
|
||||
assert_not config.proxy.ssl?
|
||||
end
|
||||
|
||||
test "false not allowed" do
|
||||
@deploy[:proxy] = false
|
||||
assert_raises(Kamal::ConfigurationError, "proxy: should be a hash") do
|
||||
config.proxy
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def config
|
||||
Kamal::Configuration.new(@deploy)
|
||||
|
||||
@@ -258,6 +258,14 @@ class ConfigurationRoleTest < ActiveSupport::TestCase
|
||||
assert_equal "18s", config_with_roles.role(:workers).proxy.deploy_options[:"target-timeout"]
|
||||
end
|
||||
|
||||
test "can't set restart in options" do
|
||||
@deploy_with_roles[:servers]["workers"]["options"] = { "restart" => "always" }
|
||||
|
||||
assert_raises Kamal::ConfigurationError, "servers/workers: Cannot set restart policy in docker options, unless-stopped is required" do
|
||||
Kamal::Configuration.new(@deploy_with_roles)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def config
|
||||
Kamal::Configuration.new(@deploy)
|
||||
|
||||
@@ -30,7 +30,7 @@ class ConfigurationTest < ActiveSupport::TestCase
|
||||
%i[ service image registry ].each do |key|
|
||||
test "#{key} config required" do
|
||||
assert_raise(Kamal::ConfigurationError) do
|
||||
Kamal::Configuration.new @deploy.tap { _1.delete key }
|
||||
Kamal::Configuration.new @deploy.tap { |config| config.delete key }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -38,21 +38,36 @@ class ConfigurationTest < ActiveSupport::TestCase
|
||||
%w[ username password ].each do |key|
|
||||
test "registry #{key} required" do
|
||||
assert_raise(Kamal::ConfigurationError) do
|
||||
Kamal::Configuration.new @deploy.tap { _1[:registry].delete key }
|
||||
Kamal::Configuration.new @deploy.tap { |config| config[:registry].delete key }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
test "service name valid" do
|
||||
assert_nothing_raised do
|
||||
Kamal::Configuration.new(@deploy.tap { _1[:service] = "hey-app1_primary" })
|
||||
Kamal::Configuration.new(@deploy.tap { _1[:service] = "MyApp" })
|
||||
Kamal::Configuration.new(@deploy.tap { |config| config[:service] = "hey-app1_primary" })
|
||||
Kamal::Configuration.new(@deploy.tap { |config| config[:service] = "MyApp" })
|
||||
end
|
||||
end
|
||||
|
||||
test "service name invalid" do
|
||||
assert_raise(Kamal::ConfigurationError) do
|
||||
Kamal::Configuration.new @deploy.tap { _1[:service] = "app.com" }
|
||||
Kamal::Configuration.new @deploy.tap { |config| config[:service] = "app.com" }
|
||||
end
|
||||
end
|
||||
|
||||
test "servers required" do
|
||||
assert_raise(Kamal::ConfigurationError) do
|
||||
Kamal::Configuration.new @deploy.tap { |config| config.delete(:servers) }
|
||||
end
|
||||
end
|
||||
|
||||
test "servers not required with accessories" do
|
||||
assert_nothing_raised do
|
||||
@deploy.delete(:servers)
|
||||
@deploy[:accessories] = { "foo" => { "image" => "foo/bar", "host" => "1.1.1.1" } }
|
||||
|
||||
Kamal::Configuration.new(@deploy)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -250,7 +265,7 @@ class ConfigurationTest < ActiveSupport::TestCase
|
||||
test "destination required" do
|
||||
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_required_dest.yml", __dir__))
|
||||
|
||||
assert_raises(Kamal::ConfigurationError) do
|
||||
assert_raises(ArgumentError, "You must specify a destination") do
|
||||
config = Kamal::Configuration.create_from config_file: dest_config_file
|
||||
end
|
||||
|
||||
|
||||
12
test/fixtures/deploy.elsewhere.yml
vendored
Normal file
12
test/fixtures/deploy.elsewhere.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
service: app3
|
||||
image: dhh/app3
|
||||
servers:
|
||||
- "1.1.1.3"
|
||||
- "1.1.1.4"
|
||||
registry:
|
||||
username: user
|
||||
password: pw
|
||||
builder:
|
||||
arch: amd64
|
||||
aliases:
|
||||
other_config: config -c config/deploy2.yml
|
||||
13
test/fixtures/deploy.yml
vendored
Normal file
13
test/fixtures/deploy.yml
vendored
Normal file
@@ -0,0 +1,13 @@
|
||||
service: app
|
||||
image: dhh/app
|
||||
servers:
|
||||
- "1.1.1.1"
|
||||
- "1.1.1.2"
|
||||
registry:
|
||||
username: user
|
||||
password: pw
|
||||
builder:
|
||||
arch: amd64
|
||||
aliases:
|
||||
other_config: config -c config/deploy2.yml
|
||||
other_destination_config: config -d elsewhere
|
||||
12
test/fixtures/deploy2.yml
vendored
Normal file
12
test/fixtures/deploy2.yml
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
service: app2
|
||||
image: dhh/app2
|
||||
servers:
|
||||
- "1.1.1.1"
|
||||
- "1.1.1.2"
|
||||
registry:
|
||||
username: user2
|
||||
password: pw2
|
||||
builder:
|
||||
arch: amd64
|
||||
aliases:
|
||||
other_config: config -c config/deploy2.yml
|
||||
47
test/fixtures/deploy_with_accessories_with_different_registries.yml
vendored
Normal file
47
test/fixtures/deploy_with_accessories_with_different_registries.yml
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
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:
|
||||
server: private.registry
|
||||
username: user
|
||||
password: pw
|
||||
builder:
|
||||
arch: amd64
|
||||
|
||||
accessories:
|
||||
mysql:
|
||||
image: private.registry/mysql:5.7
|
||||
host: 1.1.1.3
|
||||
port: 3306
|
||||
env:
|
||||
clear:
|
||||
MYSQL_ROOT_HOST: '%'
|
||||
secret:
|
||||
- MYSQL_ROOT_PASSWORD
|
||||
files:
|
||||
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
|
||||
directories:
|
||||
- data:/var/lib/mysql
|
||||
redis:
|
||||
image: redis:latest
|
||||
roles:
|
||||
- web
|
||||
port: 6379
|
||||
directories:
|
||||
- data:/data
|
||||
busybox:
|
||||
service: custom-box
|
||||
image: busybox:latest
|
||||
host: 1.1.1.3
|
||||
registry:
|
||||
server: other.registry
|
||||
username: other_user
|
||||
password: other_pw
|
||||
|
||||
readiness_delay: 0
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user