Compare commits

..

1 Commits

Author SHA1 Message Date
David Heinemeier Hansson
bf6fa46268 Bump version for 2.0.0.rc3 2024-09-23 16:47:06 -07:00
80 changed files with 335 additions and 1064 deletions

View File

@@ -27,13 +27,9 @@ jobs:
- "3.1" - "3.1"
- "3.2" - "3.2"
- "3.3" - "3.3"
- "3.4.0-preview2"
gemfile: gemfile:
- Gemfile - Gemfile
- gemfiles/rails_edge.gemfile - gemfiles/rails_edge.gemfile
exclude:
- ruby-version: "3.1"
gemfile: gemfiles/rails_edge.gemfile
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }} name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
continue-on-error: true continue-on-error: true
@@ -42,9 +38,6 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Remove gemfile.lock
run: rm Gemfile.lock
- name: Install Ruby - name: Install Ruby
uses: ruby/setup-ruby@v1 uses: ruby/setup-ruby@v1
with: with:
@@ -53,5 +46,3 @@ jobs:
- name: Run tests - name: Run tests
run: bin/test run: bin/test
env:
RUBYOPT: ${{ startsWith(matrix.ruby-version, '3.4.') && '--enable=frozen-string-literal' || '' }}

View File

@@ -1,4 +1,5 @@
FROM ruby:3.3-alpine # Use the official Ruby 3.2.0 Alpine image as the base image
FROM ruby:3.2.0-alpine
# Install docker/buildx-bin # Install docker/buildx-bin
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
@@ -32,7 +33,7 @@ WORKDIR /workdir
# Tell git it's safe to access /workdir/.git even if # Tell git it's safe to access /workdir/.git even if
# the directory is owned by a different user # the directory is owned by a different user
RUN git config --global --add safe.directory '*' RUN git config --global --add safe.directory /workdir
# Set the entrypoint to run the installed binary in /workdir # Set the entrypoint to run the installed binary in /workdir
# Example: docker run -it -v "$PWD:/workdir" kamal init # Example: docker run -it -v "$PWD:/workdir" kamal init

View File

@@ -1,24 +1,24 @@
PATH PATH
remote: . remote: .
specs: specs:
kamal (2.3.0) kamal (2.0.0.rc3)
activesupport (>= 7.0) activesupport (>= 7.0)
base64 (~> 0.2) base64 (~> 0.2)
bcrypt_pbkdf (~> 1.0) bcrypt_pbkdf (~> 1.0)
concurrent-ruby (~> 1.2) concurrent-ruby (~> 1.2)
dotenv (~> 3.1) dotenv (~> 3.1)
ed25519 (~> 1.2) ed25519 (~> 1.2)
net-ssh (~> 7.3) net-ssh (~> 7.0)
sshkit (>= 1.23.0, < 2.0) sshkit (>= 1.23.0, < 2.0)
thor (~> 1.3) thor (~> 1.3)
zeitwerk (>= 2.6.18, < 3.0) zeitwerk (~> 2.5)
GEM GEM
remote: https://rubygems.org/ remote: https://rubygems.org/
specs: specs:
actionpack (7.1.4.1) actionpack (7.1.3.4)
actionview (= 7.1.4.1) actionview (= 7.1.3.4)
activesupport (= 7.1.4.1) activesupport (= 7.1.3.4)
nokogiri (>= 1.8.5) nokogiri (>= 1.8.5)
racc racc
rack (>= 2.2.4) rack (>= 2.2.4)
@@ -26,13 +26,13 @@ GEM
rack-test (>= 0.6.3) rack-test (>= 0.6.3)
rails-dom-testing (~> 2.2) rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6) rails-html-sanitizer (~> 1.6)
actionview (7.1.4.1) actionview (7.1.3.4)
activesupport (= 7.1.4.1) activesupport (= 7.1.3.4)
builder (~> 3.1) builder (~> 3.1)
erubi (~> 1.11) erubi (~> 1.11)
rails-dom-testing (~> 2.2) rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6) rails-html-sanitizer (~> 1.6)
activesupport (7.1.4.1) activesupport (7.1.3.4)
base64 base64
bigdecimal bigdecimal
concurrent-ruby (~> 1.0, >= 1.0.2) concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -49,7 +49,7 @@ GEM
bcrypt_pbkdf (1.1.1-x86_64-darwin) bcrypt_pbkdf (1.1.1-x86_64-darwin)
bigdecimal (3.1.8) bigdecimal (3.1.8)
builder (3.3.0) builder (3.3.0)
concurrent-ruby (1.3.4) concurrent-ruby (1.3.3)
connection_pool (2.4.1) connection_pool (2.4.1)
crass (1.0.6) crass (1.0.6)
debug (1.9.2) debug (1.9.2)
@@ -59,7 +59,7 @@ GEM
drb (2.2.1) drb (2.2.1)
ed25519 (1.3.0) ed25519 (1.3.0)
erubi (1.13.0) erubi (1.13.0)
i18n (1.14.6) i18n (1.14.5)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
io-console (0.7.2) io-console (0.7.2)
irb (1.14.0) irb (1.14.0)
@@ -70,7 +70,7 @@ GEM
loofah (2.22.0) loofah (2.22.0)
crass (~> 1.0.2) crass (~> 1.0.2)
nokogiri (>= 1.12.0) nokogiri (>= 1.12.0)
minitest (5.25.1) minitest (5.24.1)
mocha (2.4.5) mocha (2.4.5)
ruby2_keywords (>= 0.0.5) ruby2_keywords (>= 0.0.5)
mutex_m (0.2.0) mutex_m (0.2.0)
@@ -78,7 +78,7 @@ GEM
net-ssh (>= 2.6.5, < 8.0.0) net-ssh (>= 2.6.5, < 8.0.0)
net-sftp (4.0.0) net-sftp (4.0.0)
net-ssh (>= 5.0.0, < 8.0.0) net-ssh (>= 5.0.0, < 8.0.0)
net-ssh (7.3.0) net-ssh (7.2.3)
nokogiri (1.16.7-arm64-darwin) nokogiri (1.16.7-arm64-darwin)
racc (~> 1.4) racc (~> 1.4)
nokogiri (1.16.7-x86_64-darwin) nokogiri (1.16.7-x86_64-darwin)
@@ -92,7 +92,7 @@ GEM
psych (5.1.2) psych (5.1.2)
stringio stringio
racc (1.8.1) racc (1.8.1)
rack (3.1.8) rack (3.1.7)
rack-session (2.0.0) rack-session (2.0.0)
rack (>= 3.0.0) rack (>= 3.0.0)
rack-test (2.1.0) rack-test (2.1.0)
@@ -107,9 +107,9 @@ GEM
rails-html-sanitizer (1.6.0) rails-html-sanitizer (1.6.0)
loofah (~> 2.21) loofah (~> 2.21)
nokogiri (~> 1.14) nokogiri (~> 1.14)
railties (7.1.4.1) railties (7.1.3.4)
actionpack (= 7.1.4.1) actionpack (= 7.1.3.4)
activesupport (= 7.1.4.1) activesupport (= 7.1.3.4)
irb irb
rackup (>= 1.0.0) rackup (>= 1.0.0)
rake (>= 12.2) rake (>= 12.2)
@@ -122,7 +122,8 @@ GEM
regexp_parser (2.9.2) regexp_parser (2.9.2)
reline (0.5.9) reline (0.5.9)
io-console (~> 0.5) io-console (~> 0.5)
rexml (3.3.9) rexml (3.3.4)
strscan
rubocop (1.65.1) rubocop (1.65.1)
json (~> 2.3) json (~> 2.3)
language_server-protocol (>= 3.17.0) language_server-protocol (>= 3.17.0)
@@ -160,12 +161,13 @@ GEM
net-sftp (>= 2.1.2) net-sftp (>= 2.1.2)
net-ssh (>= 2.8.0) net-ssh (>= 2.8.0)
stringio (3.1.1) stringio (3.1.1)
strscan (3.1.0)
thor (1.3.1) thor (1.3.1)
tzinfo (2.0.6) tzinfo (2.0.6)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
unicode-display_width (2.5.0) unicode-display_width (2.5.0)
webrick (1.8.2) webrick (1.8.1)
zeitwerk (2.7.1) zeitwerk (2.6.17)
PLATFORMS PLATFORMS
arm64-darwin arm64-darwin

View File

@@ -30,7 +30,6 @@ DOCS = {
"ssh" => "SSH", "ssh" => "SSH",
"sshkit" => "SSHKit" "sshkit" => "SSHKit"
} }
DOCS_PATH = "lib/kamal/configuration/docs"
class DocWriter class DocWriter
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
@@ -71,7 +70,6 @@ class DocWriter
generate_line(line, heading: place == :new_section) generate_line(line, heading: place == :new_section)
place = :in_section place = :in_section
else else
output.puts
output.puts "```yaml" output.puts "```yaml"
output.puts line output.puts line
place = :in_yaml place = :in_yaml
@@ -79,7 +77,6 @@ class DocWriter
when :in_yaml, :in_empty_line_yaml when :in_yaml, :in_empty_line_yaml
if line =~ /^ *#/ if line =~ /^ *#/
output.puts "```" output.puts "```"
output.puts
generate_line(line, heading: place == :in_empty_line_yaml) generate_line(line, heading: place == :in_empty_line_yaml)
place = :in_section place = :in_section
elsif line.empty? elsif line.empty?
@@ -95,12 +92,11 @@ class DocWriter
def generate_header def generate_header
output.puts "---" output.puts "---"
output.puts "# This file has been generated from the Kamal source, do not edit directly."
output.puts "# Find the source of this file at #{DOCS_PATH}/#{key}.yml in the Kamal repository."
output.puts "title: #{heading[2..-1]}" output.puts "title: #{heading[2..-1]}"
output.puts "---" output.puts "---"
output.puts output.puts
output.puts heading output.puts heading
output.puts
end end
def generate_line(line, heading: false) def generate_line(line, heading: false)
@@ -122,20 +118,18 @@ class DocWriter
end end
def linkify(text) def linkify(text)
if text == "Configuration overview"
"overview"
else
text.downcase.gsub(" ", "-") text.downcase.gsub(" ", "-")
end end
end
def titlify(text) def titlify(text)
text.capitalize.gsub("-", " ") text.capitalize.gsub("-", " ")
end end
end end
from_dir = File.join(File.dirname(__FILE__), "../#{DOCS_PATH}") from_dir = File.join(File.dirname(__FILE__), "../lib/kamal/configuration/docs")
to_dir = File.join(kamal_site_repo, "docs/configuration") to_dir = File.join(kamal_site_repo, "docs/configuration")
Dir.glob("#{from_dir}/*") do |from_file| Dir.glob("#{from_dir}/*") do |from_file|
key = File.basename(from_file, ".yml")
DocWriter.new(from_file, to_dir).write DocWriter.new(from_file, to_dir).write
end end

View File

@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
spec.add_dependency "activesupport", ">= 7.0" spec.add_dependency "activesupport", ">= 7.0"
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0" spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
spec.add_dependency "net-ssh", "~> 7.3" spec.add_dependency "net-ssh", "~> 7.0"
spec.add_dependency "thor", "~> 1.3" spec.add_dependency "thor", "~> 1.3"
spec.add_dependency "dotenv", "~> 3.1" spec.add_dependency "dotenv", "~> 3.1"
spec.add_dependency "zeitwerk", ">= 2.6.18", "< 3.0" spec.add_dependency "zeitwerk", "~> 2.5"
spec.add_dependency "ed25519", "~> 1.2" spec.add_dependency "ed25519", "~> 1.2"
spec.add_dependency "bcrypt_pbkdf", "~> 1.0" spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
spec.add_dependency "concurrent-ruby", "~> 1.2" spec.add_dependency "concurrent-ruby", "~> 1.2"

View File

@@ -1,5 +1,3 @@
require "active_support/core_ext/array/conversions"
class Kamal::Cli::Accessory < Kamal::Cli::Base class Kamal::Cli::Accessory < Kamal::Cli::Base
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)" desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
def boot(name, prepare: true) def boot(name, prepare: true)

View File

@@ -68,7 +68,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
endpoint = capture_with_info(*app.container_id_for_version(version)).strip endpoint = capture_with_info(*app.container_id_for_version(version)).strip
if endpoint.present? if endpoint.present?
execute *app.remove, raise_on_non_zero_exit: false execute *app.remove(target: endpoint), raise_on_non_zero_exit: false
end end
end end
@@ -203,7 +203,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
run_locally do run_locally do
info "Following logs on #{KAMAL.primary_host}..." info "Following logs on #{KAMAL.primary_host}..."
KAMAL.specific_roles ||= [ KAMAL.primary_role.name ] KAMAL.specific_roles ||= [ "web" ]
role = KAMAL.roles_on(KAMAL.primary_host).first role = KAMAL.roles_on(KAMAL.primary_host).first
app = KAMAL.app(role: role, host: host) app = KAMAL.app(role: role, host: host)

View File

@@ -135,7 +135,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
puts "No documentation found for #{section}" puts "No documentation found for #{section}"
end end
desc "init", "Create config stub in config/deploy.yml and secrets stub in .kamal" desc "init", "Create config stub in config/deploy.yml and env stub in .env"
option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub" option :bundle, type: :boolean, default: false, desc: "Add Kamal to the Gemfile and create a bin/kamal binstub"
def init def init
require "fileutils" require "fileutils"

View File

@@ -14,45 +14,13 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
version = capture_with_info(*KAMAL.proxy.version).strip.presence version = capture_with_info(*KAMAL.proxy.version).strip.presence
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION) if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}" raise "kamal-proxy version #{version} is too old, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
end end
execute *KAMAL.proxy.start_or_run execute *KAMAL.proxy.start_or_run
end end
end end
end end
desc "boot_config <set|get|reset>", "Manage kamal-proxy boot configuration"
option :publish, type: :boolean, default: true, desc: "Publish the proxy ports on the host"
option :http_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTP_PORT, desc: "HTTP port to publish on the host"
option :https_port, type: :numeric, default: Kamal::Configuration::PROXY_HTTPS_PORT, desc: "HTTPS port to publish on the host"
option :log_max_size, type: :string, default: Kamal::Configuration::PROXY_LOG_MAX_SIZE, desc: "Max size of proxy logs"
option :docker_options, type: :array, default: [], desc: "Docker options to pass to the proxy container", banner: "option=value option2=value2"
def boot_config(subcommand)
case subcommand
when "set"
boot_options = [
*(KAMAL.config.proxy_publish_args(options[:http_port], options[:https_port]) if options[:publish]),
*(KAMAL.config.proxy_logging_args(options[:log_max_size])),
*options[:docker_options].map { |option| "--#{option}" }
]
on(KAMAL.proxy_hosts) do |host|
execute(*KAMAL.proxy.ensure_proxy_directory)
upload! StringIO.new(boot_options.join(" ")), KAMAL.config.proxy_options_file
end
when "get"
on(KAMAL.proxy_hosts) do |host|
puts "Host #{host}: #{capture_with_info(*KAMAL.proxy.get_boot_options)}"
end
when "reset"
on(KAMAL.proxy_hosts) do |host|
execute *KAMAL.proxy.reset_boot_options
end
else
raise ArgumentError, "Unknown boot_config subcommand #{subcommand}"
end
end
desc "reboot", "Reboot proxy on servers (stop container, remove container, start new container)" desc "reboot", "Reboot proxy on servers (stop container, remove container, start new container)"
option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel" option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel"
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question" option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
@@ -201,7 +169,6 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
stop stop
remove_container remove_container
remove_image remove_image
remove_proxy_directory
end end
end end
end end
@@ -226,15 +193,6 @@ class Kamal::Cli::Proxy < Kamal::Cli::Base
end end
end end
desc "remove_proxy_directory", "Remove the proxy directory from servers", hide: true
def remove_proxy_directory
with_lock do
on(KAMAL.proxy_hosts) do
execute *KAMAL.proxy.remove_proxy_directory, raise_on_non_zero_exit: false
end
end
end
private private
def removal_allowed?(force) def removal_allowed?(force)
on(KAMAL.proxy_hosts) do |host| on(KAMAL.proxy_hosts) do |host|

View File

@@ -21,13 +21,6 @@ class Kamal::Cli::Secrets < Kamal::Cli::Base
return_or_puts value, inline: options[:inline] return_or_puts value, inline: options[:inline]
end end
desc "print", "Print the secrets (for debugging)"
def print
KAMAL.config.secrets.to_h.each do |key, value|
puts "#{key}=#{value}"
end
end
private private
def adapter(adapter) def adapter(adapter)
Kamal::Secrets::Adapters.lookup(adapter) Kamal::Secrets::Adapters.lookup(adapter)

View File

@@ -13,15 +13,11 @@ servers:
# - 192.168.0.1 # - 192.168.0.1
# cmd: bin/jobs # cmd: bin/jobs
# Enable SSL auto certification via Let's Encrypt and allow for multiple apps on a single web server. # Enable SSL auto certification via Let's Encrypt (and allow for multiple apps on one server).
# Remove this section when using multiple web servers and ensure you terminate SSL at your load balancer. # Set ssl: false if using something like Cloudflare to terminate SSL (but keep host!).
#
# Note: If using Cloudflare, set encryption mode in SSL/TLS setting to "Full" to enable CF-to-app encryption.
proxy: proxy:
ssl: true ssl: true
host: app.example.com host: app.example.com
# Proxy connects to your container on port 80 by default.
# app_port: 3000
# Credentials for your image host. # Credentials for your image host.
registry: registry:
@@ -91,7 +87,7 @@ builder:
# directories: # directories:
# - data:/var/lib/mysql # - data:/var/lib/mysql
# redis: # redis:
# image: valkey/valkey:8 # image: redis:7.0
# host: 192.168.0.2 # host: 192.168.0.2
# port: 6379 # port: 6379
# directories: # directories:

View File

@@ -1,3 +1,13 @@
#!/bin/sh #!/usr/bin/env ruby
echo "Docker set up on $KAMAL_HOSTS..." # A sample docker-setup hook
#
# Sets up a Docker network on defined hosts which can then be used by the applications containers
hosts = ENV["KAMAL_HOSTS"].split(",")
hosts.each do |ip|
destination = "root@#{ip}"
puts "Creating a Docker network \"kamal\" on #{destination}"
`ssh #{destination} docker network create kamal`
end

View File

@@ -1,3 +1,3 @@
#!/bin/sh #!/bin/sh
echo "Rebooting kamal-proxy on $KAMAL_HOSTS..." echo "Rebooting Traefik on $KAMAL_HOSTS..."

View File

@@ -43,12 +43,7 @@ class Kamal::Commander::Specifics
end end
def specified_hosts def specified_hosts
specified_hosts = specific_hosts || config.all_hosts (specific_hosts || config.all_hosts) \
.select { |host| (specific_roles || config.roles).flat_map(&:hosts).include?(host) }
if (specific_role_hosts = specific_roles&.flat_map(&:hosts)).present?
specified_hosts.select { |host| specific_role_hosts.include?(host) }
else
specified_hosts
end
end end
end end

View File

@@ -1,7 +1,7 @@
class Kamal::Commands::Accessory < Kamal::Commands::Base class Kamal::Commands::Accessory < Kamal::Commands::Base
attr_reader :accessory_config attr_reader :accessory_config
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd, delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
:secrets_io, :secrets_path, :env_directory, :secrets_io, :secrets_path, :env_directory,
to: :accessory_config to: :accessory_config
@@ -15,7 +15,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
"--name", service_name, "--name", service_name,
"--detach", "--detach",
"--restart", "unless-stopped", "--restart", "unless-stopped",
*network_args, "--network", "kamal",
*config.logging_args, *config.logging_args,
*publish_args, *publish_args,
*env_args, *env_args,
@@ -64,7 +64,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
docker :run, docker :run,
("-it" if interactive), ("-it" if interactive),
"--rm", "--rm",
*network_args, "--network", "kamal",
*env_args, *env_args,
*volume_args, *volume_args,
image, image,

View File

@@ -5,8 +5,8 @@ module Kamal::Commands::App::Proxy
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target) proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
end end
def remove def remove(target:)
proxy_exec :remove, role.container_prefix proxy_exec :remove, role.container_prefix, *role.proxy.remove_command_args(target: target)
end end
private private

View File

@@ -11,7 +11,14 @@ module Kamal::Commands
end end
def run_over_ssh(*command, host:) def run_over_ssh(*command, host:)
"ssh#{ssh_proxy_args} -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'" "ssh".tap do |cmd|
if config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Jump)
cmd << " -J #{config.ssh.proxy.jump_proxies}"
elsif config.ssh.proxy && config.ssh.proxy.is_a?(Net::SSH::Proxy::Command)
cmd << " -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
end
cmd << " -t #{config.ssh.user}@#{host} -p #{config.ssh.port} '#{command.join(" ").gsub("'", "'\\\\''")}'"
end
end end
def container_id_for(container_name:, only_running: false) def container_id_for(container_name:, only_running: false)
@@ -85,14 +92,5 @@ module Kamal::Commands
def tags(**details) def tags(**details)
Kamal::Tags.from_config(config, **details) Kamal::Tags.from_config(config, **details)
end end
def ssh_proxy_args
case config.ssh.proxy
when Net::SSH::Proxy::Jump
" -J #{config.ssh.proxy.jump_proxies}"
when Net::SSH::Proxy::Command
" -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
end
end
end end
end end

View File

@@ -6,7 +6,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
delegate :argumentize, to: Kamal::Utils delegate :argumentize, to: Kamal::Utils
delegate \ delegate \
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote, :args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
:cache_from, :cache_to, :ssh, :provenance, :driver, :docker_driver?, :cache_from, :cache_to, :ssh, :driver, :docker_driver?,
to: :builder_config to: :builder_config
def clean def clean
@@ -37,7 +37,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
end end
def build_options def build_options
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance ] [ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
end end
def build_context def build_context
@@ -97,10 +97,6 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
argumentize "--ssh", ssh if ssh.present? argumentize "--ssh", ssh if ssh.present?
end end
def builder_provenance
argumentize "--provenance", provenance unless provenance.nil?
end
def builder_config def builder_config
config.builder config.builder
end end

View File

@@ -1,31 +1,29 @@
module Kamal::Commands::Builder::Clone module Kamal::Commands::Builder::Clone
extend ActiveSupport::Concern
included do
delegate :clone_directory, :build_directory, to: :"config.builder"
end
def clone def clone
git :clone, escaped_root, "--recurse-submodules", path: config.builder.clone_directory.shellescape git :clone, Kamal::Git.root, "--recurse-submodules", path: clone_directory
end end
def clone_reset_steps def clone_reset_steps
[ [
git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory), git(:remote, "set-url", :origin, Kamal::Git.root, path: build_directory),
git(:fetch, :origin, path: escaped_build_directory), git(:fetch, :origin, path: build_directory),
git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory), git(:reset, "--hard", Kamal::Git.revision, path: build_directory),
git(:clean, "-fdx", path: escaped_build_directory), git(:clean, "-fdx", path: build_directory),
git(:submodule, :update, "--init", path: escaped_build_directory) git(:submodule, :update, "--init", path: build_directory)
] ]
end end
def clone_status def clone_status
git :status, "--porcelain", path: escaped_build_directory git :status, "--porcelain", path: build_directory
end end
def clone_revision def clone_revision
git :"rev-parse", :HEAD, path: escaped_build_directory git :"rev-parse", :HEAD, path: build_directory
end
def escaped_root
Kamal::Git.root.shellescape
end
def escaped_build_directory
config.builder.build_directory.shellescape
end end
end end

View File

@@ -7,8 +7,9 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
"--network", "kamal", "--network", "kamal",
"--detach", "--detach",
"--restart", "unless-stopped", "--restart", "unless-stopped",
*config.proxy_publish_args,
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy", "--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
"\$\(#{get_boot_options.join(" ")}\)", *config.logging_args,
config.proxy_image config.proxy_image
end end
@@ -64,22 +65,6 @@ class Kamal::Commands::Proxy < Kamal::Commands::Base
) )
end end
def ensure_proxy_directory
make_directory config.proxy_directory
end
def remove_proxy_directory
remove_directory config.proxy_directory
end
def get_boot_options
combine [ :cat, config.proxy_options_file ], [ :echo, "\"#{config.proxy_options_default.join(" ")}\"" ], by: "||"
end
def reset_boot_options
remove_file config.proxy_options_file
end
private private
def container_name def container_name
config.proxy_container_name config.proxy_container_name

View File

@@ -14,15 +14,12 @@ class Kamal::Configuration
include Validation include Validation
PROXY_MINIMUM_VERSION = "v0.8.2" PROXY_MINIMUM_VERSION = "v0.4.0"
PROXY_HTTP_PORT = 80 PROXY_HTTP_PORT = 80
PROXY_HTTPS_PORT = 443 PROXY_HTTPS_PORT = 443
PROXY_LOG_MAX_SIZE = "10m"
class << self class << self
def create_from(config_file:, destination: nil, version: nil) def create_from(config_file:, destination: nil, version: nil)
ENV["KAMAL_DESTINATION"] = destination
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination)) raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
new raw_config, destination: destination, version: version new raw_config, destination: destination, version: version
@@ -249,16 +246,8 @@ class Kamal::Configuration
env_tags.detect { |t| t.name == name.to_s } env_tags.detect { |t| t.name == name.to_s }
end end
def proxy_publish_args(http_port, https_port) def proxy_publish_args
argumentize "--publish", [ "#{http_port}:#{PROXY_HTTP_PORT}", "#{https_port}:#{PROXY_HTTPS_PORT}" ] argumentize "--publish", [ "#{PROXY_HTTP_PORT}:#{PROXY_HTTP_PORT}", "#{PROXY_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 end
def proxy_image def proxy_image
@@ -269,14 +258,6 @@ class Kamal::Configuration
"kamal-proxy" "kamal-proxy"
end end
def proxy_directory
File.join run_directory, "proxy"
end
def proxy_options_file
File.join proxy_directory, "options"
end
def to_h def to_h
{ {
@@ -367,7 +348,7 @@ class Kamal::Configuration
end end
def ensure_unique_hosts_for_ssl_roles def ensure_unique_hosts_for_ssl_roles
hosts = roles.select(&:ssl?).flat_map { |role| role.proxy.hosts } hosts = roles.select(&:ssl?).map { |role| role.proxy.host }
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 } duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any? raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?

View File

@@ -1,8 +1,6 @@
class Kamal::Configuration::Accessory class Kamal::Configuration::Accessory
include Kamal::Configuration::Validation include Kamal::Configuration::Validation
DEFAULT_NETWORK = "kamal"
delegate :argumentize, :optionize, to: Kamal::Utils delegate :argumentize, :optionize, to: Kamal::Utils
attr_reader :name, :accessory_config, :env attr_reader :name, :accessory_config, :env
@@ -40,10 +38,6 @@ class Kamal::Configuration::Accessory
end end
end end
def network_args
argumentize "--network", network
end
def publish_args def publish_args
argumentize "--publish", port if port argumentize "--publish", port if port
end end
@@ -179,8 +173,4 @@ class Kamal::Configuration::Accessory
accessory_config["roles"].flat_map { |role| config.role(role).hosts } accessory_config["roles"].flat_map { |role| config.role(role).hosts }
end end
end end
def network
accessory_config["network"] || DEFAULT_NETWORK
end
end end

View File

@@ -111,10 +111,6 @@ class Kamal::Configuration::Builder
builder_config["ssh"] builder_config["ssh"]
end end
def provenance
builder_config["provenance"]
end
def git_clone? def git_clone?
Kamal::Git.used? && builder_config["context"].nil? Kamal::Git.used? && builder_config["context"].nil?
end end
@@ -170,7 +166,7 @@ class Kamal::Configuration::Builder
end end
def cache_to_config_for_registry def cache_to_config_for_registry
[ "type=registry", "ref=#{cache_image_ref}", builder_config["cache"]&.fetch("options", nil) ].compact.join(",") [ "type=registry", builder_config["cache"]&.fetch("options", nil), "ref=#{cache_image_ref}" ].compact.join(",")
end end
def repo_basename def repo_basename

View File

@@ -3,32 +3,32 @@
# Accessories can be booted on a single host, a list of hosts, or on specific roles. # Accessories can be booted on a single host, a list of hosts, or on specific roles.
# The hosts do not need to be defined in the Kamal servers configuration. # The hosts do not need to be defined in the Kamal servers configuration.
# #
# Accessories are managed separately from the main service they are not updated # Accessories are managed separately from the main service - they are not updated
# when you deploy, and they do not have zero-downtime deployments. # when you deploy and they do not have zero-downtime deployments.
# #
# Run `kamal accessory boot <accessory>` to boot an accessory. # Run `kamal accessory boot <accessory>` to boot an accessory.
# See `kamal accessory --help` for more information. # See `kamal accessory --help` for more information.
# Configuring accessories # Configuring accessories
# #
# First, define the accessory in the `accessories`: # First define the accessory in the `accessories`
accessories: accessories:
mysql: mysql:
# Service name # Service name
# #
# This is used in the service label and defaults to `<service>-<accessory>`, # This is used in the service label and defaults to `<service>-<accessory>`
# where `<service>` is the main service name from the root configuration: # where `<service>` is the main service name from the root configuration
service: mysql service: mysql
# Image # Image
# #
# The Docker image to use, prefix it with a registry if not using Docker Hub: # The Docker image to use, prefix with a registry if not using Docker hub
image: mysql:8.0 image: mysql:8.0
# Accessory hosts # Accessory hosts
# #
# Specify one of `host`, `hosts`, or `roles`: # Specify one of `host`, `hosts` or `roles`
host: mysql-db1 host: mysql-db1
hosts: hosts:
- mysql-db1 - mysql-db1
@@ -38,12 +38,12 @@ accessories:
# Custom command # Custom command
# #
# You can set a custom command to run in the container if you do not want to use the default: # You can set a custom command to run in the container, if you do not want to use the default
cmd: "bin/mysqld" cmd: "bin/mysqld"
# Port mappings # Port mappings
# #
# See https://docs.docker.com/network/, and especially note the warning about the security # See https://docs.docker.com/network/, especially note the warning about the security
# implications of exposing ports publicly. # implications of exposing ports publicly.
port: "127.0.0.1:3306:3306" port: "127.0.0.1:3306:3306"
@@ -52,22 +52,20 @@ accessories:
app: myapp app: myapp
# Options # Options
# # These are passed to the Docker run command in the form `--<name> <value>`
# These are passed to the Docker run command in the form `--<name> <value>`:
options: options:
restart: always restart: always
cpus: 2 cpus: 2
# Environment variables # Environment variables
# # See kamal docs env for more information
# See kamal docs env for more information:
env: env:
... ...
# Copying files # Copying files
# #
# You can specify files to mount into the container. # You can specify files to mount into the container.
# The format is `local:remote`, where `local` is the path to the file on the local machine # The format is `local:remote` where `local` is the path to the file on the local machine
# and `remote` is the path to the file in the container. # and `remote` is the path to the file in the container.
# #
# They will be uploaded from the local repo to the host and then mounted. # They will be uploaded from the local repo to the host and then mounted.
@@ -80,21 +78,13 @@ accessories:
# Directories # Directories
# #
# You can specify directories to mount into the container. They will be created on the host # You can specify directories to mount into the container. They will be created on the host
# before being mounted: # before being mounted
directories: directories:
- mysql-logs:/var/log/mysql - mysql-logs:/var/log/mysql
# Volumes # Volumes
# #
# Any other volumes to mount, in addition to the files and directories. # Any other volumes to mount, in addition to the files and directories.
# They are not created or copied before mounting: # They are not created or copied before mounting
volumes: volumes:
- /path/to/mysql-logs:/var/log/mysql - /path/to/mysql-logs:/var/log/mysql
# Network
#
# The network the accessory will be attached to.
#
# Defaults to kamal:
network: custom

View File

@@ -12,15 +12,15 @@
aliases: aliases:
console: app exec -r console -i "rails console" console: app exec -r console -i "rails console"
# You can now open the console with: # You can now open the console with:
#
# ```shell # ```shell
# kamal console # kamal console
# ``` # ```
# Configuring aliases # Configuring aliases
# #
# Aliases are defined in the root config under the alias key. # Aliases are defined in the root config under the alias key
# #
# Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores: # Each alias is named and can only contain lowercase letters, numbers, dashes and underscores.
aliases: aliases:
uname: app exec -p -q -r web "uname -a" uname: app exec -p -q -r web "uname -a"

View File

@@ -2,18 +2,18 @@
# #
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time. # When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
# #
# Kamals default is to boot new containers on all hosts in parallel. However, you can control this with the boot configuration. # Kamals default is to boot new containers on all hosts in parallel. But you can control this with the boot configuration.
# Fixed group sizes # Fixed group sizes
# #
# Here, we boot 2 hosts at a time with a 10-second gap between each group: # Here we boot 2 hosts at a time with a 10 second gap between each group.
boot: boot:
limit: 2 limit: 2
wait: 10 wait: 10
# Percentage of hosts # Percentage of hosts
# #
# Here, we boot 25% of the hosts at a time with a 2-second gap between each group: # Here we boot 25% of the hosts at a time with a 2 second gap between each group.
boot: boot:
limit: 25% limit: 25%
wait: 2 wait: 2

View File

@@ -1,8 +1,8 @@
# Builder # Builder
# #
# The builder configuration controls how the application is built with `docker build`. # The builder configuration controls how the application is built with `docker build`
# #
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information. # See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information
# Builder options # Builder options
# #
@@ -11,15 +11,15 @@ builder:
# Arch # Arch
# #
# The architectures to build for you can set an array or just a single value. # The architectures to build for - you can set an array or just a single value.
# #
# Allowed values are `amd64` and `arm64`: # Allowed values are `amd64` and `arm64`
arch: arch:
- amd64 - amd64
# Remote # Remote
# #
# The connection string for a remote builder. If supplied, Kamal will use this # The connection string for a remote builder. If supplied Kamal will use this
# for builds that do not match the local architecture of the deployment host. # for builds that do not match the local architecture of the deployment host.
remote: ssh://docker@docker-builder remote: ssh://docker@docker-builder
@@ -28,14 +28,14 @@ builder:
# If set to false, Kamal will always use the remote builder even when building # If set to false, Kamal will always use the remote builder even when building
# the local architecture. # the local architecture.
# #
# Defaults to true: # Defaults to true
local: true local: true
# Builder cache # Builder cache
# #
# The type must be either 'gha' or 'registry'. # The type must be either 'gha' or 'registry'
# #
# The image is only used for registry cache and is not compatible with the Docker driver: # The image is only used for registry cache. Not compatible with the docker driver
cache: cache:
type: registry type: registry
options: mode=max options: mode=max
@@ -43,25 +43,25 @@ builder:
# Build context # Build context
# #
# If this is not set, then a local Git clone of the repo is used. # If this is not set, then a local git clone of the repo is used.
# This ensures a clean build with no uncommitted changes. # This ensures a clean build with no uncommitted changes.
# #
# To use the local checkout instead, you can set the context to `.`, or a path to another directory. # To use the local checkout instead you can set the context to `.`, or a path to another directory.
context: . context: .
# Dockerfile # Dockerfile
# #
# The Dockerfile to use for building, defaults to `Dockerfile`: # The Dockerfile to use for building, defaults to `Dockerfile`
dockerfile: Dockerfile.production dockerfile: Dockerfile.production
# Build target # Build target
# #
# If not set, then the default target is used: # If not set, then the default target is used
target: production target: production
# Build arguments # Build Arguments
# #
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`: # Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`
args: args:
ENVIRONMENT: production ENVIRONMENT: production
@@ -74,37 +74,33 @@ builder:
# Build secrets # Build secrets
# #
# Values are read from `.kamal/secrets`: # Values are read from .kamal/secrets.
#
secrets: secrets:
- SECRET1 - SECRET1
- SECRET2 - SECRET2
# Referencing build secrets # Referencing Build Secrets
# #
# ```shell # ```shell
# # Copy Gemfiles # # Copy Gemfiles
# COPY Gemfile Gemfile.lock ./ # COPY Gemfile Gemfile.lock ./
# #
# # Install dependencies, including private repositories via access token # # Install dependencies, including private repositories via access token
# # Then remove bundle cache with exposed GITHUB_TOKEN # # Then remove bundle cache with exposed GITHUB_TOKEN)
# RUN --mount=type=secret,id=GITHUB_TOKEN \ # RUN --mount=type=secret,id=GITHUB_TOKEN \
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \ # BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
# bundle install && \ # bundle install && \
# rm -rf /usr/local/bundle/cache # rm -rf /usr/local/bundle/cache
# ``` # ```
# SSH # SSH
# #
# SSH agent socket or keys to expose to the build: # SSH agent socket or keys to expose to the build
ssh: default=$SSH_AUTH_SOCK ssh: default=$SSH_AUTH_SOCK
# Driver # Driver
# #
# The build driver to use, defaults to `docker-container`: # The build driver to use, defaults to `docker-container`
driver: docker driver: docker
# Provenance
#
# It is used to configure provenance attestations for the build result.
# The value can also be a boolean to enable or disable provenance attestations.
provenance: mode=max

View File

@@ -1,13 +1,14 @@
# Kamal Configuration # Kamal Configuration
# #
# Configuration is read from the `config/deploy.yml`. # Configuration is read from the `config/deploy.yml`
#
# Destinations # Destinations
# #
# When running commands, you can specify a destination with the `-d` flag, # When running commands, you can specify a destination with the `-d` flag,
# e.g., `kamal deploy -d staging`. # e.g. `kamal deploy -d staging`
# #
# In this case, the configuration will also be read from `config/deploy.staging.yml` # In this case the configuration will also be read from `config/deploy.staging.yml`
# and merged with the base configuration. # and merged with the base configuration.
# Extensions # Extensions
@@ -17,11 +18,10 @@
# However, you might want to declare a configuration block using YAML anchors # However, you might want to declare a configuration block using YAML anchors
# and aliases to avoid repetition. # and aliases to avoid repetition.
# #
# You can prefix a configuration section with `x-` to indicate that it is an # You can use prefix a configuration section with `x-` to indicate that it is an
# extension. Kamal will ignore the extension and not raise an error. # extension. Kamal will ignore the extension and not raise an error.
# The service name # The service name
#
# This is a required value. It is used as the container name prefix. # This is a required value. It is used as the container name prefix.
service: myapp service: myapp
@@ -32,147 +32,147 @@ image: my-image
# Labels # Labels
# #
# Additional labels to add to the container: # Additional labels to add to the container
labels: labels:
my-label: my-value my-label: my-value
# Volumes # Volumes
# #
# Additional volumes to mount into the container: # Additional volumes to mount into the container
volumes: volumes:
- /path/on/host:/path/in/container:ro - /path/on/host:/path/in/container:ro
# Registry # Registry
# #
# The Docker registry configuration, see kamal docs registry: # The Docker registry configuration, see kamal docs registry
registry: registry:
... ...
# Servers # Servers
# #
# The servers to deploy to, optionally with custom roles, see kamal docs servers: # The servers to deploy to, optionally with custom roles, see kamal docs servers
servers: servers:
... ...
# Environment variables # Environment variables
# #
# See kamal docs env: # See kamal docs env
env: env:
... ...
# Asset path # Asset Path
# #
# Used for asset bridging across deployments, default to `nil`. # Used for asset bridging across deployments, default to `nil`
# #
# If there are changes to CSS or JS files, we may get requests # If there are changes to CSS or JS files, we may get requests
# for the old versions on the new container, and vice versa. # for the old versions on the new container and vice-versa.
# #
# To avoid 404s, we can specify an asset path. # To avoid 404s we can specify an asset path.
# Kamal will replace that path in the container with a mapped # Kamal will replace that path in the container with a mapped
# volume containing both sets of files. # volume containing both sets of files.
# This requires that file names change when the contents change # This requires that file names change when the contents change
# (e.g., by including a hash of the contents in the name). # (e.g. by including a hash of the contents in the name).
# #
# To configure this, set the path to the assets: # To configure this, set the path to the assets:
asset_path: /path/to/assets asset_path: /path/to/assets
# Hooks path # Hooks path
# #
# Path to hooks, defaults to `.kamal/hooks`. # Path to hooks, defaults to `.kamal/hooks`
# See https://kamal-deploy.org/docs/hooks for more information: # See https://kamal-deploy.org/docs/hooks for more information
hooks_path: /user_home/kamal/hooks hooks_path: /user_home/kamal/hooks
# Require destinations # Require destinations
# #
# Whether deployments require a destination to be specified, defaults to `false`: # Whether deployments require a destination to be specified, defaults to `false`
require_destination: true require_destination: true
# Primary role # Primary role
# #
# This defaults to `web`, but if you have no web role, you can change this: # This defaults to `web`, but if you have no web role, you can change this
primary_role: workers primary_role: workers
# Allowing empty roles # Allowing empty roles
# #
# Whether roles with no servers are allowed. Defaults to `false`: # Whether roles with no servers are allowed. Defaults to `false`.
allow_empty_roles: false allow_empty_roles: false
# Retain containers # Retain containers
# #
# How many old containers and images we retain, defaults to 5: # How many old containers and images we retain, defaults to 5
retain_containers: 3 retain_containers: 3
# Minimum version # Minimum version
# #
# The minimum version of Kamal required to deploy this configuration, defaults to `nil`: # The minimum version of Kamal required to deploy this configuration, defaults to nil
minimum_version: 1.3.0 minimum_version: 1.3.0
# Readiness delay # Readiness delay
# #
# Seconds to wait for a container to boot after it is running, default 7. # Seconds to wait for a container to boot after is running, default 7
# #
# This only applies to containers that do not run a proxy or specify a healthcheck: # This only applies to containers that do not run a proxy or specify a healthcheck
readiness_delay: 4 readiness_delay: 4
# Deploy timeout # Deploy timeout
# #
# How long to wait for a container to become ready, default 30: # How long to wait for a container to become ready, default 30
deploy_timeout: 10 deploy_timeout: 10
# Drain timeout # Drain timeout
# #
# How long to wait for a container to drain, default 30: # How long to wait for a containers to drain, default 30
drain_timeout: 10 drain_timeout: 10
# Run directory # Run directory
# #
# Directory to store kamal runtime files in on the host, default `.kamal`: # Directory to store kamal runtime files in on the host, default `.kamal`
run_directory: /etc/kamal run_directory: /etc/kamal
# SSH options # SSH options
# #
# See kamal docs ssh: # See kamal docs ssh
ssh: ssh:
... ...
# Builder options # Builder options
# #
# See kamal docs builder: # See kamal docs builder
builder: builder:
... ...
# Accessories # Accessories
# #
# Additional services to run in Docker, see kamal docs accessory: # Additionals services to run in Docker, see kamal docs accessory
accessories: accessories:
... ...
# Proxy # Proxy
# #
# Configuration for kamal-proxy, see kamal docs proxy: # Configuration for kamal-proxy, see kamal docs proxy
proxy: proxy:
... ...
# SSHKit # SSHKit
# #
# See kamal docs sshkit: # See kamal docs sshkit
sshkit: sshkit:
... ...
# Boot options # Boot options
# #
# See kamal docs boot: # See kamal docs boot
boot: boot:
... ...
# Logging # Logging
# #
# Docker logging configuration, see kamal docs logging: # Docker logging configuration, see kamal docs logging
logging: logging:
... ...
# Aliases # Aliases
# #
# Alias configuration, see kamal docs alias: # Alias configuration, see kamal docs alias
aliases: aliases:
... ...

View File

@@ -1,13 +1,13 @@
# Environment variables # Environment variables
# #
# Environment variables can be set directly in the Kamal configuration or # Environment variables can be set directly in the Kamal configuration or
# read from `.kamal/secrets`. # read from .kamal/secrets.
# Reading environment variables from the configuration # Reading environment variables from the configuration
# #
# Environment variables can be set directly in the configuration file. # Environment variables can be set directly in the configuration file.
# #
# These are passed to the `docker run` command when deploying. # These are passed to the docker run command when deploying.
env: env:
DATABASE_HOST: mysql-db1 DATABASE_HOST: mysql-db1
DATABASE_PORT: 3306 DATABASE_PORT: 3306
@@ -16,7 +16,7 @@ env:
# #
# Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file. # Kamal uses dotenv to automatically load environment variables set in the `.kamal/secrets` file.
# #
# If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if # If you are using destinations, secrets will instead be read from `.kamal/secrets-<DESTINATION>` if
# it exists. # it exists.
# #
# Common secrets across all destinations can be set in `.kamal/secrets-common`. # Common secrets across all destinations can be set in `.kamal/secrets-common`.
@@ -24,27 +24,26 @@ env:
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords. # This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
# You can use variable or command substitution in the secrets file. # You can use variable or command substitution in the secrets file.
# #
# ```shell # ```
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD # KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
# RAILS_MASTER_KEY=$(cat config/master.key) # RAILS_MASTER_KEY=$(cat config/master.key)
# ``` # ```
# #
# You can also use [secret helpers](../../commands/secrets) for some common password managers. # You can also use [secret helpers](../commands/secrets) for some common password managers.
# # ```
# ```shell
# SECRETS=$(kamal secrets fetch ...) # SECRETS=$(kamal secrets fetch ...)
# #
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS) # REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS) # DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
# ``` # ```
# #
# If you store secrets directly in `.kamal/secrets`, ensure that it is not checked into version control. # If you store secrets directly in .kamal/secrets, ensure that it is not checked into version control.
# #
# To pass the secrets, you should list them under the `secret` key. When you do this, the # To pass the secrets you should list them under the `secret` key. When you do this the
# other variables need to be moved under the `clear` key. # other variables need to be moved under the `clear` key.
# #
# Unlike clear values, secrets are not passed directly to the container # Unlike clear values, secrets are not passed directly to the container,
# but are stored in an env file on the host: # but are stored in an env file on the host
env: env:
clear: clear:
DB_USER: app DB_USER: app
@@ -56,7 +55,7 @@ env:
# Tags are used to add extra env variables to specific hosts. # Tags are used to add extra env variables to specific hosts.
# See kamal docs servers for how to tag hosts. # See kamal docs servers for how to tag hosts.
# #
# Tags are only allowed in the top-level env configuration (i.e., not under a role-specific env). # Tags are only allowed in the top level env configuration (i.e not under a role specific env).
# #
# The env variables can be specified with secret and clear values as explained above. # The env variables can be specified with secret and clear values as explained above.
env: env:

View File

@@ -6,16 +6,16 @@
# #
# These go under the logging key in the configuration file. # These go under the logging key in the configuration file.
# #
# This can be specified at the root level or for a specific role. # This can be specified in the root level or for a specific role.
logging: logging:
# Driver # Driver
# #
# The logging driver to use, passed to Docker via `--log-driver`: # The logging driver to use, passed to Docker via `--log-driver`
driver: json-file driver: json-file
# Options # Options
# #
# Any logging options to pass to the driver, passed to Docker via `--log-opt`: # Any logging options to pass to the driver, passed to Docker via `--log-opt`
options: options:
max-size: 100m max-size: 100m

View File

@@ -5,59 +5,54 @@
# application container. # application container.
# #
# The proxy is configured in the root configuration under `proxy`. These are # The proxy is configured in the root configuration under `proxy`. These are
# options that are set when deploying the application, not when booting the proxy. # options that are set when deploying the application, not when booting the proxy
# #
# They are application-specific, so they are not shared when multiple applications # They are application specific, so are not shared when multiple applications
# run on the same proxy. # run on the same proxy.
# #
# The proxy is enabled by default on the primary role but can be disabled by # The proxy is enabled by default on the primary role, but can be disabled by
# setting `proxy: false`. # setting `proxy: false`.
# #
# It is disabled by default on all other roles but can be enabled by setting # It is disabled by default on all other roles, but can be enabled by setting
# `proxy: true` or providing a proxy configuration. # `proxy: true`, or providing a proxy configuration.
proxy: proxy:
# Hosts # Host
# #
# The hosts that will be used to serve the app. The proxy will only route requests # The hosts that will be used to serve the app. The proxy will only route requests
# to this host to your app. # to this host to your app.
# #
# If no hosts are set, then all requests will be forwarded, except for matching # If no hosts are set, then all requests will be forwarded, except for matching
# requests for other apps deployed on that server that do have a host set. # requests for other apps deployed on that server that do have a host set.
#
# Specify one of `host` or `hosts`.
host: foo.example.com host: foo.example.com
hosts:
- foo.example.com
- bar.example.com
# App port # App port
# #
# The port the application container is exposed on. # The port the application container is exposed on
# #
# Defaults to 80: # Defaults to 80
app_port: 3000 app_port: 3000
# SSL # SSL
# #
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt. # kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
# #
# This requires that we are deploying to one server and the host option is set. # This requires that we are deploying to a one server and the host option is set.
# The host value must point to the server we are deploying to, and port 443 must be # The host value must point to the server we are deploying to and port 443 must be
# open for the Let's Encrypt challenge to succeed. # open for the Let's Encrypt challenge to succeed.
# #
# Defaults to `false`: # Defaults to false
ssl: true ssl: true
# Response timeout # Response timeout
# #
# How long to wait for requests to complete before timing out, defaults to 30 seconds: # How long to wait for requests to complete before timing out, defaults to 30 seconds
response_timeout: 10 response_timeout: 10
# Healthcheck # Healthcheck
# #
# When deploying, the proxy will by default hit `/up` once every second until we hit # When deploying, the proxy will by default hit /up once every second until we hit
# the deploy timeout, with a 5-second timeout for each request. # the deploy timeout, with a 5 second timeout for each request.
# #
# Once the app is up, the proxy will stop hitting the healthcheck endpoint. # Once the app is up, the proxy will stop hitting the healthcheck endpoint.
healthcheck: healthcheck:
@@ -67,12 +62,12 @@ proxy:
# Buffering # Buffering
# #
# Whether to buffer request and response bodies in the proxy. # Whether to buffer request and response bodies in the proxy
# #
# By default, buffering is enabled with a max request body size of 1GB and no limit # By default buffering is enabled with a max request body size of 1GB and no limit
# for response size. # for response size.
# #
# You can also set the memory limit for buffering, which defaults to 1MB; anything # You can also set the memory limit for buffering, which defaults to 1MB, anything
# larger than that is written to disk. # larger than that is written to disk.
buffering: buffering:
requests: true requests: true
@@ -83,9 +78,9 @@ proxy:
# Logging # Logging
# #
# Configure request logging for the proxy. # Configure request logging for the proxy
# You can specify request and response headers to log. # You can specify request and response headers to log.
# By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged: # By default, Cache-Control, Last-Modified and User-Agent request headers are logged
logging: logging:
request_headers: request_headers:
- Cache-Control - Cache-Control
@@ -96,10 +91,10 @@ proxy:
# Forward headers # Forward headers
# #
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers. # Whether to forward the X-Forwarded-For and X-Forwarded-Proto headers.
# #
# If you are behind a trusted proxy, you can set this to `true` to forward the headers. # If you are behind a trusted proxy, you can set this to true to forward the headers.
# #
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and # By default kamal-proxy will not forward the headers the ssl option is set to true, and
# will forward them if it is set to `false`. # will forward them if it is set to false.
forward_headers: true forward_headers: true

View File

@@ -1,9 +1,10 @@
# Registry # Registry
# #
# The default registry is Docker Hub, but you can change it using `registry/server`. # The default registry is Docker Hub, but you can change it using registry/server:
# #
# A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret # A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
# in the local environment: # in the local environment.
registry: registry:
server: registry.digitalocean.com server: registry.digitalocean.com
username: username:
@@ -12,31 +13,30 @@ registry:
- DOCKER_REGISTRY_TOKEN - DOCKER_REGISTRY_TOKEN
# Using AWS ECR as the container registry # Using AWS ECR as the container registry
# # You will need to have the aws CLI installed locally for this to work.
# You will need to have the AWS CLI installed locally for this to work. # AWS ECRs access token is only valid for 12hrs. In order to not have to manually regenerate the token every time, you can use ERB in the deploy.yml file to shell out to the aws cli command, and obtain the token:
# AWS ECRs access token is only valid for 12 hours. In order to avoid having to manually regenerate the token every time, you can use ERB in the `deploy.yml` file to shell out to the AWS CLI command and obtain the token:
registry: registry:
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
username: AWS username: AWS
password: <%= %x(aws ecr get-login-password) %> password: <%= %x(aws ecr get-login-password) %>
# Using GCP Artifact Registry as the container registry # Using GCP Artifact Registry as the container registry
# # To sign into Artifact Registry, you would need to
# To sign into Artifact Registry, you need to
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating) # [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions). # and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
# Normally, assigning the `roles/artifactregistry.writer` role should be sufficient. # Normally, assigning a roles/artifactregistry.writer role should be sufficient.
# #
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it: # Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
# #
# ```shell # ```shell
# base64 -i /path/to/key.json | tr -d "\\n" # base64 -i /path/to/key.json | tr -d "\\n")
# ``` # ```
# You'll then need to set the KAMAL_REGISTRY_PASSWORD secret to that value.
# #
# You'll then need to set the `KAMAL_REGISTRY_PASSWORD` secret to that value. # Use the env variable as password along with _json_key_base64 as username.
#
# Use the environment variable as the password along with `_json_key_base64` as the username.
# Heres the final configuration: # Heres the final configuration:
registry: registry:
server: <your registry region>-docker.pkg.dev server: <your registry region>-docker.pkg.dev
username: _json_key_base64 username: _json_key_base64
@@ -46,7 +46,6 @@ registry:
# Validating the configuration # Validating the configuration
# #
# You can validate the configuration by running: # You can validate the configuration by running:
#
# ```shell # ```shell
# kamal registry login # kamal registry login
# ``` # ```

View File

@@ -1,21 +1,22 @@
# Roles # Roles
# #
# Roles are used to configure different types of servers in the deployment. # Roles are used to configure different types of servers in the deployment.
# The most common use for this is to run web servers and job servers. # The most common use for this is to run a web servers and job servers.
# #
# Kamal expects there to be a `web` role, unless you set a different `primary_role` # Kamal expects there to be a `web` role, unless you set a different `primary_role`
# in the root configuration. # in the root configuration.
# Role configuration # Role configuration
# #
# Roles are specified under the servers key: # Roles are specified under the servers key
servers: servers:
# Simple role configuration # Simple role configuration
# #
# This can be a list of hosts if you don't need custom configuration for the role.
# #
# You can set tags on the hosts for custom env variables (see kamal docs env): # This can be a list of hosts, if you don't need custom configuration for the role.
#
# You can set tags on the hosts for custom env variables (see kamal docs env)
web: web:
- 172.1.0.1 - 172.1.0.1
- 172.1.0.2: experiment1 - 172.1.0.2: experiment1
@@ -23,16 +24,16 @@ servers:
# Custom role configuration # Custom role configuration
# #
# When there are other options to set, the list of hosts goes under the `hosts` key. # When there are other options to set, the list of hosts goes under the `hosts` key
# #
# By default, only the primary role uses a proxy. # By default only the primary role uses a proxy.
# #
# For other roles, you can set it to `proxy: true` to enable it and inherit the root proxy # For other roles, you can set it to `proxy: true` enable it and inherit the root proxy
# configuration or provide a map of options to override the root configuration. # configuration or provide a map of options to override the root configuration.
# #
# For the primary role, you can set `proxy: false` to disable the proxy. # For the primary role, you can set `proxy: false` to disable the proxy.
# #
# You can also set a custom `cmd` to run in the container and overwrite other settings # You can also set a custom cmd to run in the container, and overwrite other settings
# from the root configuration. # from the root configuration.
workers: workers:
hosts: hosts:

View File

@@ -2,7 +2,7 @@
# #
# Servers are split into different roles, with each role having its own configuration. # Servers are split into different roles, with each role having its own configuration.
# #
# For simpler deployments, though, where all servers are identical, you can just specify a list of servers. # For simpler deployments though where all servers are identical, you can just specify a list of servers
# They will be implicitly assigned to the `web` role. # They will be implicitly assigned to the `web` role.
servers: servers:
- 172.0.0.1 - 172.0.0.1
@@ -19,7 +19,7 @@ servers:
# Roles # Roles
# #
# For more complex deployments (e.g., if you are running job hosts), you can specify roles and configure each separately (see kamal docs role): # For more complex deployments (e.g. if you are running job hosts), you can specify roles, and configure each separately (see kamal docs role)
servers: servers:
web: web:
... ...

View File

@@ -1,9 +1,9 @@
# SSH configuration # SSH configuration
# #
# Kamal uses SSH to connect and run commands on your hosts. # Kamal uses SSH to connect run commands on your hosts.
# By default, it will attempt to connect to the root user on port 22. # By default it will attempt to connect to the root user on port 22
# #
# If you are using a non-root user, you may need to bootstrap your servers manually before using them with Kamal. On Ubuntu, youd do: # If you are using non-root user, you may need to bootstrap your servers manually, before using them with Kamal. On Ubuntu, youd do:
# #
# ```shell # ```shell
# sudo apt update # sudo apt update
@@ -12,6 +12,7 @@
# sudo usermod -a -G docker app # sudo usermod -a -G docker app
# ``` # ```
# SSH options # SSH options
# #
# The options are specified under the ssh key in the configuration file. # The options are specified under the ssh key in the configuration file.
@@ -19,52 +20,47 @@ ssh:
# The SSH user # The SSH user
# #
# Defaults to `root`: # Defaults to `root`
#
user: app user: app
# The SSH port # The SSH port
# #
# Defaults to 22: # Defaults to 22
port: "2222" port: "2222"
# Proxy host # Proxy host
# #
# Specified in the form <host> or <user>@<host>: # Specified in the form <host> or <user>@<host>
proxy: root@proxy-host proxy: root@proxy-host
# Proxy command # Proxy command
# #
# A custom proxy command, required for older versions of SSH: # A custom proxy command, required for older versions of SSH
proxy_command: "ssh -W %h:%p user@proxy" proxy_command: "ssh -W %h:%p user@proxy"
# Log level # Log level
# #
# Defaults to `fatal`. Set this to `debug` if you are having SSH connection issues. # Defaults to `fatal`. Set this to debug if you are having
# SSH connection issues.
log_level: debug log_level: debug
# Keys only # Keys Only
# #
# Set to `true` to use only private keys from the `keys` and `key_data` parameters, # Set to true to use only private keys from keys and key_data parameters,
# even if ssh-agent offers more identities. This option is intended for # even if ssh-agent offers more identities. This option is intended for
# situations where ssh-agent offers many different identities or you # situations where ssh-agent offers many different identites or you have
# need to overwrite all identities and force a single one. # a need to overwrite all identites and force a single one.
keys_only: false keys_only: false
# Keys # Keys
# #
# An array of file names of private keys to use for public key # An array of file names of private keys to use for publickey
# and host-based authentication: # and hostbased authentication
keys: [ "~/.ssh/id.pem" ] keys: [ "~/.ssh/id.pem" ]
# Key data # Key Data
# #
# An array of strings, with each element of the array being # An array of strings, with each element of the array being
# a raw private key in PEM format. # a raw private key in PEM format.
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ] key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
# Config
#
# Set to true to load the default OpenSSH config files (~/.ssh/config,
# /etc/ssh_config), to false ignore config files, or to a file path
# (or array of paths) to load specific configuration. Defaults to true.
config: true

View File

@@ -2,8 +2,8 @@
# #
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal. # [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
# #
# The default, settings should be sufficient for most use cases, but # The default settings should be sufficient for most use cases, but
# when connecting to a large number of hosts, you may need to adjust. # when connecting to a large number of hosts you may need to adjust
# SSHKit options # SSHKit options
# #
@@ -13,11 +13,11 @@ sshkit:
# Max concurrent starts # Max concurrent starts
# #
# Creating SSH connections concurrently can be an issue when deploying to many servers. # Creating SSH connections concurrently can be an issue when deploying to many servers.
# By default, Kamal will limit concurrent connection starts to 30 at a time. # By default Kamal will limit concurrent connection starts to 30 at a time.
max_concurrent_starts: 10 max_concurrent_starts: 10
# Pool idle timeout # Pool idle timeout
# #
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid # Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
# re-connection storms after an idle period, such as building an image or waiting for CI. # re-connection storms after an idle period, like building an image or waiting for CI.
pool_idle_timeout: 300 pool_idle_timeout: 300

View File

@@ -22,14 +22,14 @@ class Kamal::Configuration::Proxy
proxy_config.fetch("ssl", false) proxy_config.fetch("ssl", false)
end end
def hosts def host
proxy_config["hosts"] || proxy_config["host"]&.split(",") || [] proxy_config["host"]
end end
def deploy_options def deploy_options
{ {
host: hosts, host: proxy_config["host"],
tls: proxy_config["ssl"].presence, tls: proxy_config["ssl"],
"deploy-timeout": seconds_duration(config.deploy_timeout), "deploy-timeout": seconds_duration(config.deploy_timeout),
"drain-timeout": seconds_duration(config.drain_timeout), "drain-timeout": seconds_duration(config.drain_timeout),
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")), "health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
@@ -48,7 +48,11 @@ class Kamal::Configuration::Proxy
end end
def deploy_command_args(target:) def deploy_command_args(target:)
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "=" optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options)
end
def remove_command_args(target:)
optionize({ target: "#{target}:#{app_port}" })
end end
def merge(other) def merge(other)

View File

@@ -3,13 +3,9 @@ class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
unless config.nil? unless config.nil?
super super
if config["host"].blank? && config["hosts"].blank? && config["ssl"] if config["host"].blank? && config["ssl"]
error "Must set a host to enable automatic SSL" error "Must set a host to enable automatic SSL"
end end
if (config.keys & [ "host", "hosts" ]).size > 1
error "Specify one of 'host' or 'hosts', not both"
end
end end
end end
end end

View File

@@ -37,8 +37,6 @@ class Kamal::EnvFile
def escape_docker_env_file_ascii_value(value) def escape_docker_env_file_ascii_value(value)
# Doublequotes are treated literally in docker env files # Doublequotes are treated literally in docker env files
# so remove leading and trailing ones and unescape any others # so remove leading and trailing ones and unescape any others
value.to_s.dump[1..-2] value.to_s.dump[1..-2].gsub(/\\"/, "\"")
.gsub(/\\"/, "\"")
.gsub(/\\#/, "#")
end end
end end

View File

@@ -1,10 +1,13 @@
require "dotenv" require "dotenv"
class Kamal::Secrets class Kamal::Secrets
attr_reader :secrets_files
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install! Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
def initialize(destination: nil) def initialize(destination: nil)
@destination = destination @secrets_files = \
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{destination}" if destination)}" ].select { |f| File.exist?(f) }
@mutex = Mutex.new @mutex = Mutex.new
end end
@@ -14,10 +17,10 @@ class Kamal::Secrets
secrets.fetch(key) secrets.fetch(key)
end end
rescue KeyError rescue KeyError
if secrets_files.present? if secrets_files
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}" raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
else else
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files (#{secrets_filenames.join(", ")}) provided" raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files provided"
end end
end end
@@ -25,18 +28,10 @@ class Kamal::Secrets
secrets secrets
end end
def secrets_files
@secrets_files ||= secrets_filenames.select { |f| File.exist?(f) }
end
private private
def secrets def secrets
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file| @secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
secrets.merge!(::Dotenv.parse(secrets_file)) secrets.merge!(::Dotenv.parse(secrets_file))
end end
end end
def secrets_filenames
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{@destination}" if @destination)}" ]
end
end end

View File

@@ -2,7 +2,6 @@ class Kamal::Secrets::Adapters::Base
delegate :optionize, to: Kamal::Utils delegate :optionize, to: Kamal::Utils
def fetch(secrets, account:, from: nil) def fetch(secrets, account:, from: nil)
check_dependencies!
session = login(account) session = login(account)
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") } full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
fetch_secrets(full_secrets, account: account, session: session) fetch_secrets(full_secrets, account: account, session: session)
@@ -16,8 +15,4 @@ class Kamal::Secrets::Adapters::Base
def fetch_secrets(...) def fetch_secrets(...)
raise NotImplementedError raise NotImplementedError
end end
def check_dependencies!
raise NotImplementedError
end
end end

View File

@@ -25,28 +25,20 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
{}.tap do |results| {}.tap do |results|
items_fields(secrets).each do |item, fields| items_fields(secrets).each do |item, fields|
item_json = run_command("get item #{item.shellescape}", session: session, raw: true) item_json = run_command("get item #{item.shellescape}", session: session, raw: true)
raise RuntimeError, "Could not read #{item} from Bitwarden" unless $?.success? raise RuntimeError, "Could not read #{secret} from Bitwarden" unless $?.success?
item_json = JSON.parse(item_json) item_json = JSON.parse(item_json)
if fields.any?
results.merge! fetch_secrets_from_fields(fields, item, item_json)
elsif item_json.dig("login", "password")
results[item] = item_json.dig("login", "password")
elsif item_json["fields"]&.any?
fields = item_json["fields"].pluck("name")
results.merge! fetch_secrets_from_fields(fields, item, item_json)
else
raise RuntimeError, "Item #{item} is not a login type item and no fields were specified"
end
end
end
end
def fetch_secrets_from_fields(fields, item, item_json) if fields.any?
fields.to_h do |field| fields.each do |field|
item_field = item_json["fields"].find { |f| f["name"] == field } item_field = item_json["fields"].find { |f| f["name"] == field }
raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field raise RuntimeError, "Could not find field #{field} in item #{item} in Bitwarden" unless item_field
value = item_field["value"] value = item_field["value"]
[ "#{item}/#{field}", value ] results["#{item}/#{field}"] = value
end
else
results[item] = item_json["login"]["password"]
end
end
end end
end end
@@ -69,13 +61,4 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
result = `#{full_command}`.strip result = `#{full_command}`.strip
raw ? result : JSON.parse(result) raw ? result : JSON.parse(result)
end end
def check_dependencies!
raise RuntimeError, "Bitwarden CLI is not installed" unless cli_installed?
end
def cli_installed?
`bw --version 2> /dev/null`
$?.success?
end
end end

View File

@@ -3,7 +3,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
def login(account) def login(account)
unless loggedin?(account) unless loggedin?(account)
`lpass login #{account.shellescape}` `lpass login #{account.shellescape}`
raise RuntimeError, "Failed to login to LastPass" unless $?.success? raise RuntimeError, "Failed to login to 1Password" unless $?.success?
end end
end end
@@ -13,7 +13,7 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
def fetch_secrets(secrets, account:, session:) def fetch_secrets(secrets, account:, session:)
items = `lpass show #{secrets.map(&:shellescape).join(" ")} --json` items = `lpass show #{secrets.map(&:shellescape).join(" ")} --json`
raise RuntimeError, "Could not read #{secrets} from LastPass" unless $?.success? raise RuntimeError, "Could not read #{secrets} from 1Password" unless $?.success?
items = JSON.parse(items) items = JSON.parse(items)
@@ -27,13 +27,4 @@ class Kamal::Secrets::Adapters::LastPass < Kamal::Secrets::Adapters::Base
end end
end end
end end
def check_dependencies!
raise RuntimeError, "LastPass CLI is not installed" unless cli_installed?
end
def cli_installed?
`lpass --version 2> /dev/null`
$?.success?
end
end end

View File

@@ -58,13 +58,4 @@ class Kamal::Secrets::Adapters::OnePassword < Kamal::Secrets::Adapters::Base
raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success? raise RuntimeError, "Could not read #{fields.join(", ")} from #{item} in the #{vault} 1Password vault" unless $?.success?
end end
end end
def check_dependencies!
raise RuntimeError, "1Password CLI is not installed" unless cli_installed?
end
def cli_installed?
`op --version 2> /dev/null`
$?.success?
end
end end

View File

@@ -7,8 +7,4 @@ class Kamal::Secrets::Adapters::Test < Kamal::Secrets::Adapters::Base
def fetch_secrets(secrets, account:, session:) def fetch_secrets(secrets, account:, session:)
secrets.to_h { |secret| [ secret, secret.reverse ] } secrets.to_h { |secret| [ secret, secret.reverse ] }
end end
def check_dependencies!
# no op
end
end end

View File

@@ -12,8 +12,6 @@ module Kamal::Utils
attr = "#{key}=#{escape_shell_value(value)}" attr = "#{key}=#{escape_shell_value(value)}"
attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive attr = self.sensitive(attr, redaction: "#{key}=[REDACTED]") if sensitive
[ argument, attr ] [ argument, attr ]
elsif value == false
[ argument, "#{key}=false" ]
else else
[ argument, key ] [ argument, key ]
end end

View File

@@ -1,3 +1,3 @@
module Kamal module Kamal
VERSION = "2.3.0" VERSION = "2.0.0.rc3"
end end

View File

@@ -41,7 +41,7 @@ class CliAccessoryTest < CliTestCase
test "upload" do test "upload" do
run_command("upload", "mysql").tap do |output| run_command("upload", "mysql").tap do |output|
assert_match "mkdir -p app-mysql/etc/mysql", output assert_match "mkdir -p app-mysql/etc/mysql", output
assert_match "test/fixtures/files/my.cnf to app-mysql/etc/mysql/my.cnf", output assert_match "test/fixtures/files/my.cnf app-mysql/etc/mysql/my.cnf", output
assert_match "chmod 755 app-mysql/etc/mysql/my.cnf", output assert_match "chmod 755 app-mysql/etc/mysql/my.cnf", output
end end
end end

View File

@@ -130,7 +130,7 @@ class CliAppTest < CliTestCase
SSHKit::Backend::Abstract.any_instance.stubs(:execute) SSHKit::Backend::Abstract.any_instance.stubs(:execute)
.with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false) .with(:docker, :container, :ls, "--all", "--filter", "name=^app-web-latest$", "--quiet", "|", :xargs, :docker, :stop, raise_on_non_zero_exit: false)
SSHKit::Backend::Abstract.any_instance.expects(:execute) SSHKit::Backend::Abstract.any_instance.expects(:execute)
.with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target=\"123:80\"", "--deploy-timeout=\"1s\"", "--drain-timeout=\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header=\"Cache-Control\"", "--log-request-header=\"Last-Modified\"", "--log-request-header=\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy")) .with(:docker, :exec, "kamal-proxy", "kamal-proxy", :deploy, "app-web", "--target", "\"123:80\"", "--deploy-timeout", "\"1s\"", "--drain-timeout", "\"30s\"", "--buffer-requests", "--buffer-responses", "--log-request-header", "\"Cache-Control\"", "--log-request-header", "\"Last-Modified\"", "--log-request-header", "\"User-Agent\"").raises(SSHKit::Command::Failed.new("Failed to deploy"))
stderred do stderred do
run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output| run_command("boot", config: :with_roles, host: nil, allow_execute_error: true).tap do |output|
@@ -190,7 +190,7 @@ class CliAppTest < CliTestCase
run_command("start").tap do |output| run_command("start").tap do |output|
assert_match "docker start app-web-999", output assert_match "docker start app-web-999", output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"999:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\"", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"999:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\"", output
end end
end end
@@ -383,7 +383,7 @@ class CliAppTest < CliTestCase
assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename assert_match /Renaming container .* to .* as already deployed on 1.1.1.1/, output # Rename
assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output assert_match /docker rename app-web-latest app-web-latest_replaced_[0-9a-f]{16}/, output
assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output assert_match /docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-[0-9a-f]{12} -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal\/apps\/app\/env\/roles\/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh\/app:latest/, output
assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target="123:80"/, output assert_match /docker exec kamal-proxy kamal-proxy deploy app-web --target "123:80"/, output
assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output assert_match "docker container ls --all --filter name=^app-web-123$ --quiet | xargs docker stop", output
end end
end end
@@ -392,8 +392,8 @@ class CliAppTest < CliTestCase
SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version SSHKit::Backend::Abstract.any_instance.stubs(:capture_with_info).returns("123") # old version
run_command("boot", config: :with_proxy_roles, host: nil).tap do |output| run_command("boot", config: :with_proxy_roles, host: nil).tap do |output|
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"10s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"10s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target=\"123:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --target-timeout=\"15s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web2 --target \"123:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --target-timeout \"15s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
end end
end end

View File

@@ -4,7 +4,7 @@ class CliProxyTest < CliTestCase
test "boot" do test "boot" do
run_command("boot").tap do |output| run_command("boot").tap do |output|
assert_match "docker login", output assert_match "docker login", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
end end
end end
@@ -18,11 +18,11 @@ class CliProxyTest < CliTestCase
exception = assert_raises do exception = assert_raises do
run_command("boot").tap do |output| run_command("boot").tap do |output|
assert_match "docker login", output assert_match "docker login", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
end end
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, please reboot to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
ensure ensure
Thread.report_on_exception = false Thread.report_on_exception = false
end end
@@ -36,7 +36,7 @@ class CliProxyTest < CliTestCase
run_command("boot").tap do |output| run_command("boot").tap do |output|
assert_match "docker login", output assert_match "docker login", output
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image}", output assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image}", output
end end
ensure ensure
Thread.report_on_exception = false Thread.report_on_exception = false
@@ -57,14 +57,14 @@ class CliProxyTest < CliTestCase
assert_match "docker container stop kamal-proxy on 1.1.1.1", output assert_match "docker container stop kamal-proxy on 1.1.1.1", output
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.1", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image} on 1.1.1.1", output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.1", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.1", output
assert_match "docker container stop kamal-proxy on 1.1.1.2", output assert_match "docker container stop kamal-proxy on 1.1.1.2", output
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") #{KAMAL.config.proxy_image} on 1.1.1.2", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" #{KAMAL.config.proxy_image} on 1.1.1.2", output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.2", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.2", output
end end
end end
@@ -198,13 +198,13 @@ class CliProxyTest < CliTestCase
assert_match "/usr/bin/env mkdir -p .kamal", output assert_match "/usr/bin/env mkdir -p .kamal", output
assert_match "docker network create kamal", output assert_match "docker network create kamal", output
assert_match "docker login -u [REDACTED] -p [REDACTED]", output assert_match "docker login -u [REDACTED] -p [REDACTED]", output
assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output assert_match "docker container start kamal-proxy || docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", output
assert_match "/usr/bin/env mkdir -p .kamal", output assert_match "/usr/bin/env mkdir -p .kamal", output
assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output assert_match %r{docker rename app-web-latest app-web-latest_replaced_.*}, output
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output assert_match %r{/usr/bin/env .* .kamal/apps/app/env/roles/web.env}, output
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"12345678:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"12345678:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
assert_match "docker tag dhh/app:latest dhh/app:latest", output assert_match "docker tag dhh/app:latest dhh/app:latest", output
assert_match "/usr/bin/env mkdir -p .kamal", output assert_match "/usr/bin/env mkdir -p .kamal", output
@@ -236,80 +236,6 @@ class CliProxyTest < CliTestCase
end end
end end
test "boot_config set" do
run_command("boot_config", "set").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config set no publish" do
run_command("boot_config", "set", "--publish", "false").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config set custom max_size" do
run_command("boot_config", "set", "--log-max-size", "100m").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=100m\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config set no log max size" do
run_command("boot_config", "set", "--log-max-size=").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--publish 80:80 --publish 443:443\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config set custom ports" do
run_command("boot_config", "set", "--http-port", "8080", "--https-port", "8443").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--publish 8080:80 --publish 8443:443 --log-opt max-size=10m\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config set docker options" do
run_command("boot_config", "set", "--docker_options", "label=foo=bar", "add_host=thishost:thathost").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "Running /usr/bin/env mkdir -p .kamal/proxy on #{host}", output
assert_match "Uploading \"--publish 80:80 --publish 443:443 --log-opt max-size=10m --label=foo=bar --add_host=thishost:thathost\" to .kamal/proxy/options on #{host}", output
end
end
end
test "boot_config get" do
SSHKit::Backend::Abstract.any_instance.expects(:capture_with_info)
.with(:cat, ".kamal/proxy/options", "||", :echo, "\"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"")
.returns("--publish 80:80 --publish 8443:443 --label=foo=bar")
.twice
run_command("boot_config", "get").tap do |output|
assert_match "Host 1.1.1.1: --publish 80:80 --publish 8443:443 --label=foo=bar", output
assert_match "Host 1.1.1.2: --publish 80:80 --publish 8443:443 --label=foo=bar", output
end
end
test "boot_config reset" do
run_command("boot_config", "reset").tap do |output|
%w[ 1.1.1.1 1.1.1.2 ].each do |host|
assert_match "rm .kamal/proxy/options on #{host}", output
end
end
end
private private
def run_command(*command, fixture: :with_proxy) def run_command(*command, fixture: :with_proxy)
stdouted { Kamal::Cli::Proxy.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) } stdouted { Kamal::Cli::Proxy.start([ *command, "-c", "test/fixtures/deploy_#{fixture}.yml" ]) }

View File

@@ -15,12 +15,6 @@ class CliSecretsTest < CliTestCase
assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}") assert_equal "oof", run_command("extract", "foo", "{\"abc/foo\":\"oof\", \"bar\":\"rab\", \"baz\":\"zab\"}")
end end
test "print" do
with_test_secrets("secrets" => "SECRET1=ABC\nSECRET2=${SECRET1}DEF\n") do
assert_equal "SECRET1=ABC\nSECRET2=ABCDEF", run_command("print")
end
end
private private
def run_command(*command) def run_command(*command)
stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) } stdouted { Kamal::Cli::Secrets.start([ *command, "-c", "test/fixtures/deploy_with_accessories.yml" ]) }

View File

@@ -150,27 +150,6 @@ class CommanderTest < ActiveSupport::TestCase
assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts assert_equal [ "1.1.1.2" ], @kamal.proxy_hosts
end end
test "accessory hosts without filtering" do
configure_with(:deploy_with_single_accessory)
assert_equal [ "1.1.1.5" ], @kamal.accessory_hosts
configure_with(:deploy_with_accessories_on_independent_server)
assert_equal [ "1.1.1.5", "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
end
test "accessory hosts with role filtering" do
configure_with(:deploy_with_single_accessory)
@kamal.specific_roles = [ "web" ]
assert_equal [], @kamal.accessory_hosts
configure_with(:deploy_with_accessories_on_independent_server)
@kamal.specific_roles = [ "web" ]
assert_equal [ "1.1.1.1", "1.1.1.2" ], @kamal.accessory_hosts
@kamal.specific_roles = [ "workers" ]
assert_equal [], @kamal.accessory_hosts
end
private private
def configure_with(variant) def configure_with(variant)
@kamal = Kamal::Commander.new.tap do |kamal| @kamal = Kamal::Commander.new.tap do |kamal|

View File

@@ -71,14 +71,6 @@ class CommandsAccessoryTest < ActiveSupport::TestCase
new_command(:busybox).run.join(" ") new_command(:busybox).run.join(" ")
end end
test "run in custom network" do
@config[:accessories]["mysql"]["network"] = "custom"
assert_equal \
"docker run --name app-mysql --detach --restart unless-stopped --network custom --log-opt max-size=\"10m\" --publish 3306:3306 --env MYSQL_ROOT_HOST=\"%\" --env-file .kamal/apps/app/env/accessories/mysql.env --label service=\"app-mysql\" private.registry/mysql:8.0",
new_command(:mysql).run.join(" ")
end
test "start" do test "start" do
assert_equal \ assert_equal \
"docker container start app-mysql", "docker container start app-mysql",

View File

@@ -115,38 +115,14 @@ class CommandsAppTest < ActiveSupport::TestCase
test "deploy" do test "deploy" do
assert_equal \ assert_equal \
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", "docker exec kamal-proxy kamal-proxy deploy app-web --target \"172.1.0.2:80\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"",
new_command.deploy(target: "172.1.0.2").join(" ")
end
test "deploy with SSL" do
@config[:proxy] = { "ssl" => true, "host" => "example.com" }
assert_equal \
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
new_command.deploy(target: "172.1.0.2").join(" ")
end
test "deploy with SSL targeting multiple hosts" do
@config[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
assert_equal \
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --host=\"example.com\" --host=\"anotherexample.com\" --tls --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
new_command.deploy(target: "172.1.0.2").join(" ")
end
test "deploy with SSL false" do
@config[:proxy] = { "ssl" => false }
assert_equal \
"docker exec kamal-proxy kamal-proxy deploy app-web --target=\"172.1.0.2:80\" --deploy-timeout=\"30s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"",
new_command.deploy(target: "172.1.0.2").join(" ") new_command.deploy(target: "172.1.0.2").join(" ")
end end
test "remove" do test "remove" do
assert_equal \ assert_equal \
"docker exec kamal-proxy kamal-proxy remove app-web", "docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"",
new_command.remove.join(" ") new_command.remove(target: "172.1.0.2").join(" ")
end end

View File

@@ -144,45 +144,20 @@ class CommandsBuilderTest < ActiveSupport::TestCase
builder.push.join(" ") builder.push.join(" ")
end end
test "push with provenance" do
builder = new_builder_command(builder: { "provenance" => "mode=max" })
assert_equal \
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance mode=max .",
builder.push.join(" ")
end
test "push with provenance false" do
builder = new_builder_command(builder: { "provenance" => false })
assert_equal \
"docker buildx build --push --platform linux/amd64 --builder kamal-local-docker-container -t dhh/app:123 -t dhh/app:latest --label service=\"app\" --file Dockerfile --provenance false .",
builder.push.join(" ")
end
test "mirror count" do test "mirror count" do
command = new_builder_command command = new_builder_command
assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ") assert_equal "docker info --format '{{index .RegistryConfig.Mirrors 0}}'", command.first_mirror.join(" ")
end end
test "clone path with spaces" do
command = new_builder_command
Kamal::Git.stubs(:root).returns("/absolute/path with spaces")
clone_command = command.clone.join(" ")
clone_reset_commands = command.clone_reset_steps.map { |a| a.join(" ") }
assert_match(%r{path\\ with\\ space}, clone_command)
assert_no_match(%r{path with spaces}, clone_command)
clone_reset_commands.each do |command|
assert_match(%r{path\\ with\\ space}, command)
assert_no_match(%r{path with spaces}, command)
end
end
private private
def new_builder_command(additional_config = {}) def new_builder_command(additional_config = {})
Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123")) Kamal::Commands::Builder.new(Kamal::Configuration.new(@config.deep_merge(additional_config), version: "123"))
end end
def build_directory
"#{Dir.tmpdir}/kamal-clones/app/kamal/"
end
def local_arch def local_arch
Kamal::Utils.docker_arch Kamal::Utils.docker_arch
end end

View File

@@ -15,7 +15,13 @@ class CommandsProxyTest < ActiveSupport::TestCase
test "run" do test "run" do
assert_equal \ assert_equal \
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
new_command.run.join(" ")
end
test "run with ports configured" do
assert_equal \
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
new_command.run.join(" ") new_command.run.join(" ")
end end
@@ -23,7 +29,15 @@ class CommandsProxyTest < ActiveSupport::TestCase
@config.delete(:proxy) @config.delete(:proxy)
assert_equal \ assert_equal \
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\") basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}", "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-opt max-size=\"10m\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
new_command.run.join(" ")
end
test "run with logging config" do
@config[:logging] = { "driver" => "local", "options" => { "max-size" => "100m", "max-file" => "3" } }
assert_equal \
"docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --publish 80:80 --publish 443:443 --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy --log-driver \"local\" --log-opt max-size=\"100m\" --log-opt max-file=\"3\" basecamp/kamal-proxy:#{Kamal::Configuration::PROXY_MINIMUM_VERSION}",
new_command.run.join(" ") new_command.run.join(" ")
end end
@@ -105,24 +119,6 @@ class CommandsProxyTest < ActiveSupport::TestCase
new_command.version.join(" ") new_command.version.join(" ")
end end
test "ensure_proxy_directory" do
assert_equal \
"mkdir -p .kamal/proxy",
new_command.ensure_proxy_directory.join(" ")
end
test "get_boot_options" do
assert_equal \
"cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443 --log-opt max-size=10m\"",
new_command.get_boot_options.join(" ")
end
test "reset_boot_options" do
assert_equal \
"rm .kamal/proxy/options",
new_command.reset_boot_options.join(" ")
end
private private
def new_command def new_command
Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123")) Kamal::Commands::Proxy.new(Kamal::Configuration.new(@config, version: "123"))

View File

@@ -152,13 +152,4 @@ class ConfigurationAccessoryTest < ActiveSupport::TestCase
test "options" do test "options" do
assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args assert_equal [ "--cpus", "\"4\"", "--memory", "\"2GB\"" ], @config.accessory(:redis).option_args
end end
test "network_args default" do
assert_equal [ "--network", "kamal" ], @config.accessory(:mysql).network_args
end
test "network_args with configured options" do
@deploy[:accessories]["mysql"]["network"] = "database"
assert_equal [ "--network", "database" ], @config.accessory(:mysql).network_args
end
end end

View File

@@ -64,7 +64,7 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } } @deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from assert_equal "type=registry,ref=dhh/app-build-cache", config.builder.cache_from
assert_equal "type=registry,ref=dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=dhh/app-build-cache", config.builder.cache_to
end end
test "setting registry cache when using a custom registry" do test "setting registry cache when using a custom registry" do
@@ -72,14 +72,14 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } } @deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "options" => "mode=max,image-manifest=true,oci-mediatypes=true" } }
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_from
assert_equal "type=registry,ref=registry.example.com/dhh/app-build-cache,mode=max,image-manifest=true,oci-mediatypes=true", config.builder.cache_to assert_equal "type=registry,mode=max,image-manifest=true,oci-mediatypes=true,ref=registry.example.com/dhh/app-build-cache", config.builder.cache_to
end end
test "setting registry cache with image" do test "setting registry cache with image" do
@deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } } @deploy[:builder] = { "arch" => "amd64", "cache" => { "type" => "registry", "image" => "kamal", "options" => "mode=max" } }
assert_equal "type=registry,ref=kamal", config.builder.cache_from assert_equal "type=registry,ref=kamal", config.builder.cache_from
assert_equal "type=registry,ref=kamal,mode=max", config.builder.cache_to assert_equal "type=registry,mode=max,ref=kamal", config.builder.cache_to
end end
test "args" do test "args" do
@@ -134,16 +134,6 @@ class ConfigurationBuilderTest < ActiveSupport::TestCase
assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh assert_equal "default=$SSH_AUTH_SOCK", config.builder.ssh
end end
test "provenance" do
assert_nil config.builder.provenance
end
test "setting provenance" do
@deploy[:builder]["provenance"] = "mode=max"
assert_equal "mode=max", config.builder.provenance
end
test "local disabled but no remote set" do test "local disabled but no remote set" do
@deploy[:builder]["local"] = false @deploy[:builder]["local"] = false

View File

@@ -1,6 +1,6 @@
require "test_helper" require "test_helper"
class ConfigurationProxyTest < ActiveSupport::TestCase class ConfigurationEnvTest < ActiveSupport::TestCase
setup do setup do
@deploy = { @deploy = {
service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" }, service: "app", image: "dhh/app", registry: { "username" => "dhh", "password" => "secret" },
@@ -13,31 +13,11 @@ class ConfigurationProxyTest < ActiveSupport::TestCase
assert_equal true, config.proxy.ssl? assert_equal true, config.proxy.ssl?
end end
test "ssl with multiple hosts passed via host" do
@deploy[:proxy] = { "ssl" => true, "host" => "example.com,anotherexample.com" }
assert_equal true, config.proxy.ssl?
end
test "ssl with multiple hosts passed via hosts" do
@deploy[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
assert_equal true, config.proxy.ssl?
end
test "ssl with no host" do test "ssl with no host" do
@deploy[:proxy] = { "ssl" => true } @deploy[:proxy] = { "ssl" => true }
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? } assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
end end
test "ssl with both host and hosts" do
@deploy[:proxy] = { "ssl" => true, host: "example.com", hosts: [ "anotherexample.com" ] }
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
end
test "ssl false" do
@deploy[:proxy] = { "ssl" => false }
assert_not config.proxy.ssl?
end
private private
def config def config
Kamal::Configuration.new(@deploy) Kamal::Configuration.new(@deploy)

View File

@@ -222,13 +222,6 @@ class ConfigurationTest < ActiveSupport::TestCase
assert_equal "my-user", config.registry.username assert_equal "my-user", config.registry.username
end end
test "destination is loaded into env" do
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
config = Kamal::Configuration.create_from config_file: dest_config_file, destination: "world"
assert_equal ENV["KAMAL_DESTINATION"], "world"
end
test "destination yml config merge" do test "destination yml config merge" do
dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__)) dest_config_file = Pathname.new(File.expand_path("fixtures/deploy_for_dest.yml", __dir__))
@@ -384,15 +377,4 @@ class ConfigurationTest < ActiveSupport::TestCase
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
end end
test "two proxy ssl roles with same host in a hosts array" do
@deploy_with_roles[:servers]["web"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "foo.example.com", "bar.example.com" ] } }
@deploy_with_roles[:servers]["workers"] = { "hosts" => [ "1.1.1.1" ], "proxy" => { "ssl" => true, "hosts" => [ "www.example.com", "foo.example.com" ] } }
exception = assert_raises(Kamal::ConfigurationError) do
Kamal::Configuration.new(@deploy_with_roles)
end
assert_equal "Different roles can't share the same host for SSL: foo.example.com", exception.message
end
end end

View File

@@ -11,16 +11,6 @@ class EnvFileTest < ActiveSupport::TestCase
Kamal::EnvFile.new(env).to_s Kamal::EnvFile.new(env).to_s
end end
test "to_s won't escape '#'" do
env = {
"foo" => '#$foo',
"bar" => '#{bar}'
}
assert_equal "foo=\#$foo\nbar=\#{bar}\n", \
Kamal::EnvFile.new(env).to_s
end
test "to_str won't escape chinese characters" do test "to_str won't escape chinese characters" do
env = { env = {
"foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}' "foo" => '你好 means hello, "欢迎" means welcome, that\'s simple! 😃 {smile}'

View File

@@ -1,38 +0,0 @@
service: app
image: dhh/app
servers:
web:
- "1.1.1.1"
- "1.1.1.2"
workers:
- "1.1.1.3"
- "1.1.1.4"
registry:
username: user
password: pw
builder:
arch: amd64
accessories:
mysql:
image: mysql:5.7
host: 1.1.1.5
port: 3306
env:
clear:
MYSQL_ROOT_HOST: '%'
secret:
- MYSQL_ROOT_PASSWORD
files:
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
directories:
- data:/var/lib/mysql
redis:
image: redis:latest
roles:
- web
port: 6379
directories:
- data:/data
readiness_delay: 0

View File

@@ -1,29 +0,0 @@
service: app
image: dhh/app
servers:
web:
- "1.1.1.1"
- "1.1.1.2"
workers:
- "1.1.1.3"
- "1.1.1.4"
registry:
username: user
password: pw
builder:
arch: amd64
accessories:
mysql:
image: mysql:5.7
host: 1.1.1.5
port: 3306
env:
clear:
MYSQL_ROOT_HOST: '%'
secret:
- MYSQL_ROOT_PASSWORD
files:
- test/fixtures/files/my.cnf:/etc/mysql/my.cnf
directories:
- data:/var/lib/mysql

View File

@@ -8,7 +8,7 @@ class AppTest < IntegrationTest
kamal :app, :stop kamal :app, :stop
assert_app_not_found assert_app_is_down
kamal :app, :start kamal :app, :start
@@ -48,7 +48,7 @@ class AppTest < IntegrationTest
kamal :app, :remove kamal :app, :remove
assert_app_not_found assert_app_is_down
assert_app_directory_removed assert_app_directory_removed
end end
end end

View File

@@ -19,7 +19,6 @@ RUN apt-get update --fix-missing && apt-get install -y docker-ce docker-ce-cli c
COPY *.sh . COPY *.sh .
COPY app/ app/ COPY app/ app/
COPY app_with_roles/ app_with_roles/ COPY app_with_roles/ app_with_roles/
COPY app_with_traefik/ app_with_traefik/
RUN rm -rf /root/.ssh RUN rm -rf /root/.ssh
RUN ln -s /shared/ssh /root/.ssh RUN ln -s /shared/ssh /root/.ssh
@@ -29,7 +28,6 @@ RUN git config --global user.email "deployer@example.com"
RUN git config --global user.name "Deployer" RUN git config --global user.name "Deployer"
RUN cd app && git init && git add . && git commit -am "Initial version" RUN cd app && git init && git add . && git commit -am "Initial version"
RUN cd app_with_roles && git init && git add . && git commit -am "Initial version" RUN cd app_with_roles && git init && git add . && git commit -am "Initial version"
RUN cd app_with_traefik && git init && git add . && git commit -am "Initial version"
HEALTHCHECK --interval=1s CMD pgrep sleep HEALTHCHECK --interval=1s CMD pgrep sleep

View File

@@ -1,3 +1,3 @@
#!/bin/sh #!/bin/sh
echo "Rebooting kamal-proxy on ${KAMAL_HOSTS}..." echo "Rebooting Traefik on ${KAMAL_HOSTS}..."
mkdir -p /tmp/${TEST_ID} && touch /tmp/${TEST_ID}/pre-proxy-reboot mkdir -p /tmp/${TEST_ID} && touch /tmp/${TEST_ID}/pre-proxy-reboot

View File

@@ -15,15 +15,14 @@ readiness_delay: 0
proxy: proxy:
host: localhost host: localhost
ssl: false
healthcheck: healthcheck:
interval: 1 interval: 1
timeout: 1 timeout: 1
path: "/up" path: "/up"
response_timeout: 2 response_timeout: 2
buffering: buffering:
requests: false requests: true
responses: false responses: true
memory: 400_000 memory: 400_000
max_request_body: 40_000_000 max_request_body: 40_000_000
max_response_body: 40_000_000 max_response_body: 40_000_000

View File

@@ -1,3 +0,0 @@
kamal proxy boot_config set --publish false \
--docker_options label=traefik.http.services.kamal_proxy.loadbalancer.server.scheme=http \
label=traefik.http.routers.kamal_proxy.rule=PathPrefix\(\`/\`\)

View File

@@ -1 +0,0 @@
SECRET_TOKEN='1234 with "中文"'

View File

@@ -1,9 +0,0 @@
FROM registry:4443/nginx:1-alpine-slim
COPY default.conf /etc/nginx/conf.d/default.conf
ARG COMMIT_SHA
RUN echo $COMMIT_SHA > /usr/share/nginx/html/version
RUN mkdir -p /usr/share/nginx/html/versions && echo "version" > /usr/share/nginx/html/versions/$COMMIT_SHA
RUN mkdir -p /usr/share/nginx/html/versions && echo "hidden" > /usr/share/nginx/html/versions/.hidden
RUN echo "Up!" > /usr/share/nginx/html/up

View File

@@ -1,29 +0,0 @@
service: app_with_traefik
image: app_with_traefik
servers:
- vm1
- vm2
deploy_timeout: 2
drain_timeout: 2
readiness_delay: 0
registry:
server: registry:4443
username: root
password: root
builder:
driver: docker
arch: <%= Kamal::Utils.docker_arch %>
args:
COMMIT_SHA: <%= `git rev-parse HEAD` %>
accessories:
traefik:
service: traefik
image: traefik:v2.10
port: 80
cmd: "--providers.docker"
options:
volume:
- "/var/run/docker.sock:/var/run/docker.sock"
roles:
- web

View File

@@ -1,17 +0,0 @@
server {
listen 80;
listen [::]:80;
server_name localhost;
location / {
root /usr/share/nginx/html;
index index.html index.htm;
}
# redirect server error pages to the static page /50x.html
#
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}

View File

@@ -50,12 +50,6 @@ class IntegrationTest < ActiveSupport::TestCase
assert_equal "502", response.code assert_equal "502", response.code
end end
def assert_app_not_found
response = app_response
debug_response_code(response, "404")
assert_equal "404", response.code
end
def assert_app_is_up(version: nil, app: @app) def assert_app_is_up(version: nil, app: @app)
response = app_response(app: app) response = app_response(app: app)
debug_response_code(response, "200") debug_response_code(response, "200")
@@ -175,8 +169,10 @@ class IntegrationTest < ActiveSupport::TestCase
case app case app
when "app" when "app"
"127.0.0.1" "127.0.0.1"
else when "app_with_roles"
"localhost" "localhost"
else
raise "Unknown app: #{app}"
end end
end end
end end

View File

@@ -88,14 +88,6 @@ class MainTest < IntegrationTest
end end
test "setup and remove" do test "setup and remove" do
@app = "app_with_roles"
kamal :proxy, :set_config,
"--publish=false",
"--options=label=traefik.http.services.kamal_proxy.loadbalancer.server.scheme=http",
"label=traefik.http.routers.kamal_proxy.rule=PathPrefix\\\(\\\`/\\\`\\\)",
"label=traefik.http.routers.kamal_proxy.priority=2"
# Check remove completes when nothing has been setup yet # Check remove completes when nothing has been setup yet
kamal :remove, "-y" kamal :remove, "-y"
assert_no_images_or_containers assert_no_images_or_containers
@@ -131,15 +123,6 @@ class MainTest < IntegrationTest
assert_proxy_not_running assert_proxy_not_running
end end
test "deploy with traefik" do
@app = "app_with_traefik"
first_version = latest_app_version
kamal :setup
assert_app_is_up version: first_version
end
private private
def assert_envs(version:) def assert_envs(version:)
assert_env :CLEAR_TOKEN, "4321", version: version, vm: :vm1 assert_env :CLEAR_TOKEN, "4321", version: version, vm: :vm1

View File

@@ -2,8 +2,6 @@ require "test_helper"
class BitwardenAdapterTest < SecretAdapterTestCase class BitwardenAdapterTest < SecretAdapterTestCase
test "fetch" do test "fetch" do
stub_ticks.with("bw --version 2> /dev/null")
stub_unlocked stub_unlocked
stub_ticks.with("bw sync").returns("") stub_ticks.with("bw sync").returns("")
stub_mypassword stub_mypassword
@@ -15,22 +13,7 @@ class BitwardenAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch with no login" do
stub_ticks.with("bw --version 2> /dev/null")
stub_unlocked
stub_ticks.with("bw sync").returns("")
stub_noteitem
error = assert_raises RuntimeError do
JSON.parse(shellunescape(run_command("fetch", "mynote")))
end
assert_match(/not a login type item/, error.message)
end
test "fetch with from" do test "fetch with from" do
stub_ticks.with("bw --version 2> /dev/null")
stub_unlocked stub_unlocked
stub_ticks.with("bw sync").returns("") stub_ticks.with("bw sync").returns("")
stub_myitem stub_myitem
@@ -44,26 +27,7 @@ class BitwardenAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch all with from" do
stub_ticks.with("bw --version 2> /dev/null")
stub_unlocked
stub_ticks.with("bw sync").returns("")
stub_noteitem_with_fields
json = JSON.parse(shellunescape(run_command("fetch", "mynotefields")))
expected_json = {
"mynotefields/field1"=>"secret1", "mynotefields/field2"=>"blam", "mynotefields/field3"=>"fewgrwjgk",
"mynotefields/field4"=>"auto"
}
assert_equal expected_json, json
end
test "fetch with multiple items" do test "fetch with multiple items" do
stub_ticks.with("bw --version 2> /dev/null")
stub_unlocked stub_unlocked
stub_ticks.with("bw sync").returns("") stub_ticks.with("bw sync").returns("")
@@ -105,8 +69,6 @@ class BitwardenAdapterTest < SecretAdapterTestCase
end end
test "fetch unauthenticated" do test "fetch unauthenticated" do
stub_ticks.with("bw --version 2> /dev/null")
stub_ticks stub_ticks
.with("bw status") .with("bw status")
.returns( .returns(
@@ -128,8 +90,6 @@ class BitwardenAdapterTest < SecretAdapterTestCase
end end
test "fetch locked" do test "fetch locked" do
stub_ticks.with("bw --version 2> /dev/null")
stub_ticks stub_ticks
.with("bw status") .with("bw status")
.returns( .returns(
@@ -155,8 +115,6 @@ class BitwardenAdapterTest < SecretAdapterTestCase
end end
test "fetch locked with session" do test "fetch locked with session" do
stub_ticks.with("bw --version 2> /dev/null")
stub_ticks stub_ticks
.with("bw status") .with("bw status")
.returns( .returns(
@@ -181,15 +139,6 @@ class BitwardenAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch without CLI installed" do
stub_ticks_with("bw --version 2> /dev/null", succeed: false)
error = assert_raises RuntimeError do
JSON.parse(shellunescape(run_command("fetch", "mynote")))
end
assert_equal "Bitwarden CLI is not installed", error.message
end
private private
def run_command(*command) def run_command(*command)
stdouted do stdouted do
@@ -232,60 +181,6 @@ class BitwardenAdapterTest < SecretAdapterTestCase
JSON JSON
end end
def stub_noteitem(session: nil)
stub_ticks
.with("#{"BW_SESSION=#{session} " if session}bw get item mynote")
.returns(<<~JSON)
{
"passwordHistory":null,
"revisionDate":"2024-09-28T09:07:27.461Z",
"creationDate":"2024-09-28T09:07:00.740Z",
"deletedDate":null,
"object":"item",
"id":"aaaaaaaa-cccc-eeee-0000-222222222222",
"organizationId":null,
"folderId":null,
"type":2,
"reprompt":0,
"name":"noteitem",
"notes":"NOTES",
"favorite":false,
"secureNote":{"type":0},
"collectionIds":[]
}
JSON
end
def stub_noteitem_with_fields(session: nil)
stub_ticks
.with("#{"BW_SESSION=#{session} " if session}bw get item mynotefields")
.returns(<<~JSON)
{
"passwordHistory":null,
"revisionDate":"2024-09-28T09:07:27.461Z",
"creationDate":"2024-09-28T09:07:00.740Z",
"deletedDate":null,
"object":"item",
"id":"aaaaaaaa-cccc-eeee-0000-222222222222",
"organizationId":null,
"folderId":null,
"type":2,
"reprompt":0,
"name":"noteitem",
"notes":"NOTES",
"favorite":false,
"fields":[
{"name":"field1","value":"secret1","type":1,"linkedId":null},
{"name":"field2","value":"blam","type":1,"linkedId":null},
{"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null},
{"name":"field4","value":"auto","type":1,"linkedId":null}
],
"secureNote":{"type":0},
"collectionIds":[]
}
JSON
end
def stub_myitem def stub_myitem
stub_ticks stub_ticks
.with("bw get item myitem") .with("bw get item myitem")
@@ -307,8 +202,7 @@ class BitwardenAdapterTest < SecretAdapterTestCase
"fields":[ "fields":[
{"name":"field1","value":"secret1","type":1,"linkedId":null}, {"name":"field1","value":"secret1","type":1,"linkedId":null},
{"name":"field2","value":"blam","type":1,"linkedId":null}, {"name":"field2","value":"blam","type":1,"linkedId":null},
{"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null}, {"name":"field3","value":"fewgrwjgk","type":1,"linkedId":null}
{"name":"field4","value":"auto","type":1,"linkedId":null}
], ],
"login":{"fido2Credentials":[],"uris":[],"username":null,"password":null,"totp":null,"passwordRevisionDate":null},"collectionIds":[] "login":{"fido2Credentials":[],"uris":[],"username":null,"password":null,"totp":null,"passwordRevisionDate":null},"collectionIds":[]
} }

View File

@@ -6,7 +6,6 @@ class LastPassAdapterTest < SecretAdapterTestCase
end end
test "fetch" do test "fetch" do
stub_ticks.with("lpass --version 2> /dev/null")
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.") stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
stub_ticks stub_ticks
@@ -64,7 +63,6 @@ class LastPassAdapterTest < SecretAdapterTestCase
end end
test "fetch with from" do test "fetch with from" do
stub_ticks.with("lpass --version 2> /dev/null")
stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.") stub_ticks.with("lpass status --color never").returns("Logged in as email@example.com.")
stub_ticks stub_ticks
@@ -109,8 +107,6 @@ class LastPassAdapterTest < SecretAdapterTestCase
end end
test "fetch with signin" do test "fetch with signin" do
stub_ticks.with("lpass --version 2> /dev/null")
stub_ticks_with("lpass status --color never", succeed: false).returns("Not logged in.") stub_ticks_with("lpass status --color never", succeed: false).returns("Not logged in.")
stub_ticks_with("lpass login email@example.com", succeed: true).returns("") stub_ticks_with("lpass login email@example.com", succeed: true).returns("")
stub_ticks.with("lpass show SECRET1 --json").returns(single_item_json) stub_ticks.with("lpass show SECRET1 --json").returns(single_item_json)
@@ -124,15 +120,6 @@ class LastPassAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch without CLI installed" do
stub_ticks_with("lpass --version 2> /dev/null", succeed: false)
error = assert_raises RuntimeError do
JSON.parse(shellunescape(run_command("fetch", "SECRET1", "FOLDER1/FSECRET1", "FOLDER1/FSECRET2")))
end
assert_equal "LastPass CLI is not installed", error.message
end
private private
def run_command(*command) def run_command(*command)
stdouted do stdouted do

View File

@@ -2,7 +2,6 @@ require "test_helper"
class SecretsOnePasswordAdapterTest < SecretAdapterTestCase class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
test "fetch" do test "fetch" do
stub_ticks.with("op --version 2> /dev/null")
stub_ticks.with("op account get --account myaccount 2> /dev/null") stub_ticks.with("op account get --account myaccount 2> /dev/null")
stub_ticks stub_ticks
@@ -57,7 +56,6 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
end end
test "fetch with multiple items" do test "fetch with multiple items" do
stub_ticks.with("op --version 2> /dev/null")
stub_ticks.with("op account get --account myaccount 2> /dev/null") stub_ticks.with("op account get --account myaccount 2> /dev/null")
stub_ticks stub_ticks
@@ -117,8 +115,6 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
end end
test "fetch with signin, no session" do test "fetch with signin, no session" do
stub_ticks.with("op --version 2> /dev/null")
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false) stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("") stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("")
@@ -136,8 +132,6 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
end end
test "fetch with signin and session" do test "fetch with signin and session" do
stub_ticks.with("op --version 2> /dev/null")
stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false) stub_ticks_with("op account get --account myaccount 2> /dev/null", succeed: false)
stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("1234567890") stub_ticks_with("op signin --account \"myaccount\" --force --raw", succeed: true).returns("1234567890")
@@ -154,15 +148,6 @@ class SecretsOnePasswordAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch without CLI installed" do
stub_ticks_with("op --version 2> /dev/null", succeed: false)
error = assert_raises RuntimeError do
JSON.parse(shellunescape(run_command("fetch", "--from", "op://myvault/myitem", "section/SECRET1", "section/SECRET2", "section2/SECRET3")))
end
assert_equal "1Password CLI is not installed", error.message
end
private private
def run_command(*command) def run_command(*command)
stdouted do stdouted do

View File

@@ -31,18 +31,4 @@ class SecretsTest < ActiveSupport::TestCase
assert_equal "JKL", Kamal::Secrets.new(destination: "nodest")["SECRET2"] assert_equal "JKL", Kamal::Secrets.new(destination: "nodest")["SECRET2"]
end end
end end
test "no secrets files" do
with_test_secrets do
error = assert_raises(Kamal::ConfigurationError) do
Kamal::Secrets.new["SECRET"]
end
assert_equal "Secret 'SECRET' not found, no secret files (.kamal/secrets-common, .kamal/secrets) provided", error.message
error = assert_raises(Kamal::ConfigurationError) do
Kamal::Secrets.new(destination: "dest")["SECRET"]
end
assert_equal "Secret 'SECRET' not found, no secret files (.kamal/secrets-common, .kamal/secrets.dest) provided", error.message
end
end
end end

View File

@@ -13,13 +13,6 @@ ActiveSupport::LogSubscriber.logger = ActiveSupport::Logger.new(STDOUT) if ENV["
# Applies to remote commands only. # Applies to remote commands only.
SSHKit.config.backend = SSHKit::Backend::Printer SSHKit.config.backend = SSHKit::Backend::Printer
class SSHKit::Backend::Printer
def upload!(local, location, **kwargs)
local = local.string.inspect if local.respond_to?(:string)
puts "Uploading #{local} to #{location} on #{host}"
end
end
# Ensure local commands use the printer backend too. # Ensure local commands use the printer backend too.
# See https://github.com/capistrano/sshkit/blob/master/lib/sshkit/dsl.rb#L9 # See https://github.com/capistrano/sshkit/blob/master/lib/sshkit/dsl.rb#L9
module SSHKit module SSHKit

View File

@@ -2,8 +2,8 @@ require "test_helper"
class UtilsTest < ActiveSupport::TestCase class UtilsTest < ActiveSupport::TestCase
test "argumentize" do test "argumentize" do
assert_equal [ "--label", "foo=\"\\`bar\\`\"", "--label", "baz=\"qux\"", "--label", :quux, "--label", "quuz=false" ], \ assert_equal [ "--label", "foo=\"\\`bar\\`\"", "--label", "baz=\"qux\"", "--label", :quux ], \
Kamal::Utils.argumentize("--label", { foo: "`bar`", baz: "qux", quux: nil, quuz: false }) Kamal::Utils.argumentize("--label", { foo: "`bar`", baz: "qux", quux: nil })
end end
test "argumentize with redacted" do test "argumentize with redacted" do