Compare commits

...

50 Commits

Author SHA1 Message Date
Jeremy Daer
46e3085052 SSH proxy: allow using a bare hostname without root@
Otherwise we can't connect to the proxy as the local user and we can't
use ~/.ssh/config to set User directives.

Defaulting to root@ is hard to deprecate without introducing new config.
A clean break is probably clearest.
2024-10-03 12:03:34 -07:00
David Heinemeier Hansson
81f3508507 Bump version for 2.1.1 2024-10-03 11:39:56 -07:00
David Heinemeier Hansson
9a16873f21 Merge pull request #1035 from basecamp/fix-kamal-setup-on-accessory-hosts
Restore kamal setup to accessory hosts
2024-10-03 19:25:33 +02:00
David Heinemeier Hansson
e5ca53db6e Use new deploy config so as not to update all other tests 2024-10-02 17:34:13 -07:00
David Heinemeier Hansson
82a436fa02 Rubocop 2024-10-02 17:07:51 -07:00
David Heinemeier Hansson
7be2e7e0ba Test accessory_hosts with roles and without filtering 2024-10-02 17:03:30 -07:00
David Heinemeier Hansson
4f7ebd73a3 Specifics#accessory_hosts was being filtered out by role host check 2024-10-02 16:30:32 -07:00
Donal McBreen
279bda2770 Bump version for 2.1.0 2024-10-02 11:35:45 +01:00
Donal McBreen
aa15fa532a Merge pull request #1024 from jeromedalbert/follow-primary-role
Follow logs on primary role by default
2024-10-02 09:29:16 +01:00
Donal McBreen
276b469c2b Merge pull request #1019 from nickhammond/ENV/destination
Set KAMAL_DESTINATION when loading config
2024-10-02 09:28:01 +01:00
Donal McBreen
c10b3fb07a Merge pull request #908 from basecamp/ignorable-ssh-config
SSH: allow setting `config: false` to ignore local user `~/.ssh/config`
2024-10-02 08:28:57 +01:00
Jerome Dalbert
f47fd13e5b Follow logs on primary role by default
Do not default `kamal app logs -f` to use the hardcoded “web” role;
instead use the primary role, which can be different from “web”.
2024-10-01 13:51:09 -07:00
Nick Hammond
1d8c40f5d2 Run RC 2024-10-01 08:20:21 -07:00
Nick Hammond
73c78079bc Set KAMAL_DESTINATION when loading config 2024-10-01 08:16:52 -07:00
Donal McBreen
cd12f95a97 Merge pull request #1018 from basecamp/kamal-proxy-deploy-equals-in-args
Use `=` in kamal-proxy deploy command args
2024-10-01 15:51:43 +01:00
Donal McBreen
641e9056b3 Use = in kamal-proxy deploy command args
`=` is required for boolean values and works for all values.
2024-10-01 15:42:12 +01:00
Donal McBreen
b4bcf35f78 Merge pull request #1000 from kpumuk/hosts
Allow specifying multiple hosts for kamal-proxy via an array
2024-09-30 10:26:15 -04:00
Donal McBreen
7f6095c9eb Merge pull request #1009 from basecamp/secrets-print
Add `kamal secrets print` for secret debugging
2024-09-30 09:55:53 -04:00
Donal McBreen
ef1271df47 Merge pull request #1010 from basecamp/kamal-proxy-0-7-0
Added support for ACME `http-01` challenges
2024-09-30 09:55:34 -04:00
Donal McBreen
df1232d90f Added support for ACME http-01 challenges
Update to kamal-proxy 0.7.0 for ACME `http-01` challenge support.
2024-09-30 14:44:28 +01:00
Dmytro Shteflyuk
e75365c8c6 Simplified deploy options for kamal-proxy as it supports multiple --host arguments 2024-09-30 08:09:05 -04:00
Donal McBreen
e441399255 Add kamal secrets print for secret debugging
Dotenv's variable substitution doesn't work the same way as commands run
in the shell. It needs values to be escaped.

```sh
$ cat /tmp/env
SECRETS=$(cat /tmp/json)
SECRETS2=$(echo $SECRETS | jq)
$ cat /tmp/json
\{\ \"foo\"\ :\ \"bar\" \}
$ SECRETS=$(cat /tmp/json)
$ SECRETS2=$(echo $SECRETS | jq)
jq: parse error: Invalid numeric literal at line 1, column 2
$ ruby -e 'require "dotenv"; puts Dotenv.parse("/tmp/env")["SECRETS2"]'
{
  "foo": "bar"
}
```

Since you then can't use the shell to debug, `kamal secrets print` will
allow you to see what the secrets will be set to.
2024-09-30 12:28:29 +01:00
Donal McBreen
af992ce755 Merge pull request #996 from iximiuz/patch-1
Fix git --add safe.directory command in Dockerfile
2024-09-30 04:36:00 -04:00
Donal McBreen
32caf4b148 Merge pull request #995 from honzasterba/bw_nicer_error_message_on_non_field_fetch
[bitwarden] default fetch raises NoMethodError
2024-09-30 04:35:48 -04:00
Donal McBreen
28a02262df Merge pull request #988 from igor-alexandrov/kamal-proxy-remove-no-target
Fixed kamal-proxy remove command
2024-09-30 04:18:12 -04:00
Donal McBreen
b11fb93a6c Merge pull request #971 from igor-alexandrov/add-app-port-example
Added app_port example to the proxy section
2024-09-30 04:16:34 -04:00
Dmytro Shteflyuk
67ad7662ab Simplified proxy hosts validation and documentation, similar to accessory config 2024-09-29 20:56:23 -04:00
Dmytro Shteflyuk
c63ec39f07 Added a test for colliding hosts passed via hosts array 2024-09-29 20:56:23 -04:00
Dmytro Shteflyuk
8df7d7d92d Do not allow both host and hosts for proxy configuration 2024-09-29 20:43:44 -04:00
Dmytro Shteflyuk
1d48a0fb0a Allow specifying multiple hosts for kamal proxy via an array 2024-09-29 20:43:44 -04:00
David Heinemeier Hansson
f331605efa Merge pull request #1004 from kpumuk/grammar
Backporting changes to the documentation committed directly to kamal-site
2024-09-30 02:22:39 +02:00
Dmytro Shteflyuk
7ea995db91 Added a comment to the front matter of the configuration docs about the generator 2024-09-29 15:33:06 -04:00
Dmytro Shteflyuk
994a8faf6b Re-applied corrections to configuration YAML files that were merged directly into kamal-site 2024-09-29 15:33:06 -04:00
Dmytro Shteflyuk
6c75fe40df Removed second newline characters after the section title 2024-09-29 15:33:06 -04:00
Dmytro Shteflyuk
7567cae964 Added empty lines around YAML code fences 2024-09-29 15:33:06 -04:00
Dmytro Shteflyuk
ecd842ab9b 'Configuration overview' section was moved to overview.md file 2024-09-29 15:33:06 -04:00
Dmytro Shteflyuk
91ae1dd7b9 Removed unused variable from bin/doc 2024-09-29 15:33:06 -04:00
Ivan Velichko
0f815e17e4 Relax the safe.directory requirement
Co-authored-by: Jeremy Daer <jeremydaer@gmail.com>
2024-09-28 18:00:10 +02:00
Ivan Velichko
a310aa8fef Fix git --add safe.directory command in Dockerfile
Upgrading kamal from `v1.8.3` to `v1.9.0` broke my [kamal playground](https://labs.iximiuz.com/playgrounds/kamal):

```
laborant@dev-machine:~/svc-a$ kamal setup
  INFO [34d0def6] Running /usr/bin/env mkdir -p .kamal on 172.16.0.3
  INFO [c34cf833] Running /usr/bin/env mkdir -p .kamal on 172.16.0.4
  INFO [34d0def6] Finished in 0.147 seconds with exit status 0 (successful).
  INFO [c34cf833] Finished in 0.204 seconds with exit status 0 (successful).
Acquiring the deploy lock...
Ensure Docker is installed...
  INFO [413ee426] Running docker -v on 172.16.0.4
  INFO [f1acacba] Running docker -v on 172.16.0.3
  INFO [413ee426] Finished in 0.036 seconds with exit status 0 (successful).
  INFO [f1acacba] Finished in 0.076 seconds with exit status 0 (successful).
Log into image registry...
  INFO [94cff492] Running docker login registry.iximiuz.com -u [REDACTED] -p [REDACTED] on localhost
  INFO [94cff492] Finished in 0.077 seconds with exit status 0 (successful).
  INFO [605c535f] Running docker login registry.iximiuz.com -u [REDACTED] -p [REDACTED] on 172.16.0.4
  INFO [6002b598] Running docker login registry.iximiuz.com -u [REDACTED] -p [REDACTED] on 172.16.0.3
  INFO [605c535f] Finished in 0.083 seconds with exit status 0 (successful).
  INFO [6002b598] Finished in 0.083 seconds with exit status 0 (successful).
Build and push app image...
  INFO [9d172b1e] Running docker --version && docker buildx version on localhost
  INFO [9d172b1e] Finished in 0.059 seconds with exit status 0 (successful).
  INFO Cloning repo into build directory `/tmp/kamal-clones/svc-a-2f65914456263/workdir/`...
  INFO [26fb1bd3] Running /usr/bin/env git -C /tmp/kamal-clones/svc-a-2f65914456263 clone /workdir --recurse-submodules on localhost
 ERROR Error preparing clone: Failed to clone repo: git exit status: 32768
git stdout: Nothing written
git stderr: Cloning into 'workdir'...
fatal: detected dubious ownership in repository at '/workdir/.git'
To add an exception for this directory, call:

        git config --global --add safe.directory /workdir/.git
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
, deleting and retrying...
  INFO Cloning repo into build directory `/tmp/kamal-clones/svc-a-2f65914456263/workdir/`...
  INFO [fd4aac0c] Running /usr/bin/env git -C /tmp/kamal-clones/svc-a-2f65914456263 clone /workdir --recurse-submodules on localhost
  Finished all in 0.3 seconds
Releasing the deploy lock...
  Finished all in 0.6 seconds
  ERROR (SSHKit::Command::Failed): git exit status: 32768
git stdout: Nothing written
git stderr: Cloning into 'workdir'...
fatal: detected dubious ownership in repository at '/workdir/.git'
To add an exception for this directory, call:

        git config --global --add safe.directory /workdir/.git
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

laborant@dev-machine:~/svc-a$ kamal version
2.0.0
```

I checked the [v1.8.3...v1.9.0](https://github.com/basecamp/kamal/compare/v1.8.3...v1.9.0) diff, and couldn't find anything even remotely related to the above error.

Then I checked the `git` versions in kamal `v1.8.3` and `v1.9.0` images:

```
docker run -it --rm --entrypoint sh ghcr.io/basecamp/kamal:v1.8.3 
/workdir # git --version
git version 2.38.5
```

vs.

```
docker run -it --rm --entrypoint sh ghcr.io/basecamp/kamal:v2.0.0 
/workdir # git --version
git version 2.39.5
```

Apparently, something changed in between `2.38.5` and `2.39.5` git releases (likely yet another CVE fix), and the `git config --global --add safe.directory /workdir` stopped working.

Here is the mitigation I currently use, but it's a bit awkward to do it:

```
docker build -t ghcr.io/basecamp/kamal:v2.0.0 - <<EOF
FROM ghcr.io/basecamp/kamal:v2.0.0

RUN git config --global --add safe.directory /workdir/.git
EOF
```

Hence, this PR.

To repro, you can start a [kamal playground](https://labs.iximiuz.com/playgrounds/kamal), then `docker pull ghcr.io/basecamp/kamal:v2.0.0` to override my patched image, and `cd svc-a && kamal setup`.
2024-09-28 14:23:30 +02:00
Jan Sterba
29b02f5c30 [bitwarden] default fetch raises NoMethodError
When fetched item is not a login, Bitwarden adapter raises NoMethodError
because the returned JSON does not have the login.password value.

Add a nicer error message for that case.
2024-09-28 13:24:14 +02:00
Igor Alexandrov
6d63c4e9c6 Fixed example with the proxy status after the application has been removed 2024-09-27 21:11:51 +04:00
Igor Alexandrov
472d163cc7 Assert 404 after app is stopped 2024-09-27 19:15:42 +04:00
Igor Alexandrov
dadac999d7 Fixed kamal-proxy remove call 2024-09-27 17:45:35 +04:00
Donal McBreen
5036f8843f Merge pull request #986 from basecamp/rails-8-requires-ruby-3.2
Rails 8 doesn't support Ruby 3.1
2024-09-27 08:23:32 -04:00
Donal McBreen
14d0396581 Rails 8 doesn't support Ruby 3.1
Remove it from the build matrix as its no longer a supported combination.
2024-09-27 08:13:24 -04:00
Donal McBreen
8c32e6af07 Bump version for 2.0.0 2024-09-26 15:34:24 -04:00
Igor Aleksandrov
2b0810d063 Update lib/kamal/cli/templates/deploy.yml
Co-authored-by: Nick Hammond <nick@nickhammond.com>
2024-09-25 17:19:20 +04:00
Igor Alexandrov
098f1855e2 Added back accidentially removed new line 2024-09-25 12:11:45 +04:00
Igor Alexandrov
88351312bf Added app_port example to the proxy section 2024-09-25 11:25:42 +04:00
Jeremy Daer
190f4fba28 SSH: allow setting config: false to ignore local user ~/.ssh/config 2024-08-13 12:46:50 -07:00
42 changed files with 430 additions and 209 deletions

View File

@@ -30,6 +30,9 @@ jobs:
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

View File

@@ -33,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 /workdir RUN git config --global --add safe.directory '*'
# Set the entrypoint to run the installed binary in /workdir # Set the entrypoint to run the installed binary in /workdir
# Example: docker run -it -v "$PWD:/workdir" kamal init # Example: docker run -it -v "$PWD:/workdir" kamal init

View File

@@ -1,7 +1,7 @@
PATH PATH
remote: . remote: .
specs: specs:
kamal (2.0.0.rc4) kamal (2.1.1)
activesupport (>= 7.0) activesupport (>= 7.0)
base64 (~> 0.2) base64 (~> 0.2)
bcrypt_pbkdf (~> 1.0) bcrypt_pbkdf (~> 1.0)

View File

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

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(target: endpoint), raise_on_non_zero_exit: false execute *app.remove, raise_on_non_zero_exit: false
end end
end end
@@ -203,7 +203,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
run_locally do run_locally do
info "Following logs on #{KAMAL.primary_host}..." info "Following logs on #{KAMAL.primary_host}..."
KAMAL.specific_roles ||= [ "web" ] KAMAL.specific_roles ||= [ KAMAL.primary_role.name ]
role = KAMAL.roles_on(KAMAL.primary_host).first role = KAMAL.roles_on(KAMAL.primary_host).first
app = KAMAL.app(role: role, host: host) app = KAMAL.app(role: role, host: host)

View File

@@ -21,6 +21,13 @@ 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

@@ -18,6 +18,8 @@ servers:
proxy: proxy:
ssl: true ssl: true
host: app.example.com host: app.example.com
# kamal-proxy connects to your container over port 80, use `app_port` to specify a different port.
# app_port: 3000
# Credentials for your image host. # Credentials for your image host.
registry: registry:

View File

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

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(target:) def remove
proxy_exec :remove, role.container_prefix, *role.proxy.remove_command_args(target: target) proxy_exec :remove, role.container_prefix
end end
private private

View File

@@ -14,12 +14,14 @@ class Kamal::Configuration
include Validation include Validation
PROXY_MINIMUM_VERSION = "v0.6.0" PROXY_MINIMUM_VERSION = "v0.7.0"
PROXY_HTTP_PORT = 80 PROXY_HTTP_PORT = 80
PROXY_HTTPS_PORT = 443 PROXY_HTTPS_PORT = 443
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
@@ -360,7 +362,7 @@ class Kamal::Configuration
end end
def ensure_unique_hosts_for_ssl_roles def ensure_unique_hosts_for_ssl_roles
hosts = roles.select(&:ssl?).map { |role| role.proxy.host } hosts = roles.select(&:ssl?).flat_map { |role| role.proxy.hosts }
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 } duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any? raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?

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 with a registry if not using Docker hub # The Docker image to use, prefix it with a registry if not using Docker Hub:
image: mysql:8.0 image: mysql:8.0
# Accessory hosts # Accessory hosts
# #
# Specify one of `host`, `hosts` or `roles` # Specify one of `host`, `hosts`, or `roles`:
host: mysql-db1 host: mysql-db1
hosts: hosts:
- mysql-db1 - mysql-db1
@@ -38,12 +38,12 @@ accessories:
# Custom command # Custom command
# #
# You can set a custom command to run in the container, if you do not want to use the default # You can set a custom command to run in the container if you do not want to use the default:
cmd: "bin/mysqld" cmd: "bin/mysqld"
# Port mappings # Port mappings
# #
# See https://docs.docker.com/network/, especially note the warning about the security # See https://docs.docker.com/network/, and especially note the warning about the security
# implications of exposing ports publicly. # implications of exposing ports publicly.
port: "127.0.0.1:3306:3306" port: "127.0.0.1:3306:3306"
@@ -52,20 +52,22 @@ accessories:
app: myapp app: myapp
# Options # Options
# These are passed to the Docker run command in the form `--<name> <value>` #
# These are passed to the Docker run command in the form `--<name> <value>`:
options: options:
restart: always restart: always
cpus: 2 cpus: 2
# Environment variables # Environment variables
# See kamal docs env for more information #
# See kamal docs env for more information:
env: env:
... ...
# Copying files # Copying files
# #
# You can specify files to mount into the container. # You can specify files to mount into the container.
# The format is `local:remote` where `local` is the path to the file on the local machine # The format is `local:remote`, where `local` is the path to the file on the local machine
# and `remote` is the path to the file in the container. # and `remote` is the path to the file in the container.
# #
# They will be uploaded from the local repo to the host and then mounted. # They will be uploaded from the local repo to the host and then mounted.
@@ -78,13 +80,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

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. But you can control this with the boot configuration. # Kamals default is to boot new containers on all hosts in parallel. However, you can control this with the boot configuration.
# Fixed group sizes # Fixed group sizes
# #
# Here we boot 2 hosts at a time with a 10 second gap between each group. # Here, we boot 2 hosts at a time with a 10-second gap between each group:
boot: boot:
limit: 2 limit: 2
wait: 10 wait: 10
# Percentage of hosts # Percentage of hosts
# #
# Here we boot 25% of the hosts at a time with a 2 second gap between each group. # Here, we boot 25% of the hosts at a time with a 2-second gap between each group:
boot: boot:
limit: 25% limit: 25%
wait: 2 wait: 2

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. Not compatible with the docker driver # The image is only used for registry cache and is not compatible with the Docker driver:
cache: cache:
type: registry type: registry
options: mode=max options: mode=max
@@ -43,25 +43,25 @@ builder:
# Build context # Build context
# #
# If this is not set, then a local git clone of the repo is used. # If this is not set, then a local Git clone of the repo is used.
# This ensures a clean build with no uncommitted changes. # This ensures a clean build with no uncommitted changes.
# #
# To use the local checkout instead you can set the context to `.`, or a path to another directory. # To use the local checkout instead, you can set the context to `.`, or a path to another directory.
context: . context: .
# Dockerfile # Dockerfile
# #
# The Dockerfile to use for building, defaults to `Dockerfile` # The Dockerfile to use for building, defaults to `Dockerfile`:
dockerfile: Dockerfile.production dockerfile: Dockerfile.production
# Build target # Build target
# #
# If not set, then the default target is used # If not set, then the default target is used:
target: production target: production
# Build Arguments # Build arguments
# #
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>` # Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`:
args: args:
ENVIRONMENT: production ENVIRONMENT: production
@@ -74,33 +74,31 @@ 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

View File

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

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,26 +24,27 @@ env:
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords. # This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
# You can use variable or command substitution in the secrets file. # You can use variable or command substitution in the secrets file.
# #
# ``` # ```shell
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD # KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
# RAILS_MASTER_KEY=$(cat config/master.key) # RAILS_MASTER_KEY=$(cat config/master.key)
# ``` # ```
# #
# You can also use [secret helpers](../commands/secrets) for some common password managers. # You can also use [secret helpers](../../commands/secrets) for some common password managers.
# ``` #
# ```shell
# SECRETS=$(kamal secrets fetch ...) # SECRETS=$(kamal secrets fetch ...)
# #
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS) # REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS) # DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
# ``` # ```
# #
# If you store secrets directly in .kamal/secrets, ensure that it is not checked into version control. # If you store secrets directly in `.kamal/secrets`, ensure that it is not checked into version control.
# #
# To pass the secrets you should list them under the `secret` key. When you do this the # To pass the secrets, you should list them under the `secret` key. When you do this, the
# other variables need to be moved under the `clear` key. # other variables need to be moved under the `clear` key.
# #
# Unlike clear values, secrets are not passed directly to the container, # Unlike clear values, secrets are not passed directly to the container
# but are stored in an env file on the host # but are stored in an env file on the host:
env: env:
clear: clear:
DB_USER: app DB_USER: app
@@ -55,7 +56,7 @@ env:
# Tags are used to add extra env variables to specific hosts. # Tags are used to add extra env variables to specific hosts.
# See kamal docs servers for how to tag hosts. # See kamal docs servers for how to tag hosts.
# #
# Tags are only allowed in the top level env configuration (i.e not under a role specific env). # Tags are only allowed in the top-level env configuration (i.e., not under a role-specific env).
# #
# The env variables can be specified with secret and clear values as explained above. # The env variables can be specified with secret and clear values as explained above.
env: env:

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 in the root level or for a specific role. # This can be specified at the root level or for a specific role.
logging: logging:
# Driver # Driver
# #
# The logging driver to use, passed to Docker via `--log-driver` # The logging driver to use, passed to Docker via `--log-driver`:
driver: json-file driver: json-file
# Options # Options
# #
# Any logging options to pass to the driver, passed to Docker via `--log-opt` # Any logging options to pass to the driver, passed to Docker via `--log-opt`:
options: options:
max-size: 100m max-size: 100m

View File

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

View File

@@ -1,10 +1,9 @@
# Registry # Registry
# #
# The default registry is Docker Hub, but you can change it using registry/server: # The default registry is Docker Hub, but you can change it using `registry/server`.
# #
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret # A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret
# in the local environment. # in the local environment:
registry: registry:
server: registry.digitalocean.com server: registry.digitalocean.com
username: username:
@@ -13,30 +12,31 @@ registry:
- DOCKER_REGISTRY_TOKEN - DOCKER_REGISTRY_TOKEN
# Using AWS ECR as the container registry # Using AWS ECR as the container registry
# You will need to have the aws CLI installed locally for this to work. #
# AWS 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: # You will need to have the AWS CLI installed locally for this to work.
# 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 a roles/artifactregistry.writer role should be sufficient. # Normally, assigning the `roles/artifactregistry.writer` role should be sufficient.
# #
# Once the service account is ready, you need to generate and download a JSON key and base64 encode it: # Once the service account is ready, you need to generate and download a JSON key and base64 encode it:
# #
# ```shell # ```shell
# base64 -i /path/to/key.json | tr -d "\\n") # base64 -i /path/to/key.json | tr -d "\\n"
# ``` # ```
# You'll then need to set the KAMAL_REGISTRY_PASSWORD secret to that value.
# #
# Use the env variable as password along with _json_key_base64 as username. # You'll then need to set the `KAMAL_REGISTRY_PASSWORD` secret to that value.
#
# Use the environment variable as the password along with `_json_key_base64` as the username.
# 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,6 +46,7 @@ registry:
# Validating the configuration # Validating the configuration
# #
# You can validate the configuration by running: # You can validate the configuration by running:
#
# ```shell # ```shell
# kamal registry login # kamal registry login
# ``` # ```

View File

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

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

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, like building an image or waiting for CI. # re-connection storms after an idle period, such as building an image or waiting for CI.
pool_idle_timeout: 300 pool_idle_timeout: 300

View File

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

View File

@@ -19,9 +19,9 @@ class Kamal::Configuration::Ssh
end end
def proxy def proxy
if (proxy = ssh_config["proxy"]) if proxy = ssh_config["proxy"]
Net::SSH::Proxy::Jump.new(proxy.include?("@") ? proxy : "root@#{proxy}") Net::SSH::Proxy::Jump.new(proxy)
elsif (proxy_command = ssh_config["proxy_command"]) elsif proxy_command = ssh_config["proxy_command"]
Net::SSH::Proxy::Command.new(proxy_command) Net::SSH::Proxy::Command.new(proxy_command)
end end
end end

View File

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

View File

@@ -35,8 +35,10 @@ class Kamal::Secrets::Adapters::Bitwarden < Kamal::Secrets::Adapters::Base
value = item_field["value"] value = item_field["value"]
results["#{item}/#{field}"] = value results["#{item}/#{field}"] = value
end end
elsif item_json.dig("login", "password")
results[item] = item_json.dig("login", "password")
else else
results[item] = item_json["login"]["password"] raise RuntimeError, "Item #{item} is not a login type item and no fields were specified"
end end
end end
end end

View File

@@ -1,3 +1,3 @@
module Kamal module Kamal
VERSION = "2.0.0.rc4" VERSION = "2.1.1"
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

@@ -58,13 +58,13 @@ class CliProxyTest < CliTestCase
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.1", output
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.1", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image} on 1.1.1.1", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image} on 1.1.1.1", output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"abcdefabcdef:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\" on 1.1.1.1", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"abcdefabcdef:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\" on 1.1.1.1", output
assert_match "docker container stop kamal-proxy on 1.1.1.2", output assert_match "docker container stop kamal-proxy on 1.1.1.2", output
assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output assert_match "Running docker container stop traefik ; docker container prune --force --filter label=org.opencontainers.image.title=Traefik && docker image prune --all --force --filter label=org.opencontainers.image.title=Traefik on 1.1.1.2", output
assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output assert_match "docker container prune --force --filter label=org.opencontainers.image.title=kamal-proxy on 1.1.1.2", output
assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{KAMAL.config.proxy_image} on 1.1.1.2", output assert_match "docker run --name kamal-proxy --network kamal --detach --restart unless-stopped --volume kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy $(cat .kamal/proxy/options || echo \"--publish 80:80 --publish 443:443\") #{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
@@ -204,7 +204,7 @@ class CliProxyTest < CliTestCase
assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output assert_match "/usr/bin/env mkdir -p .kamal/apps/app/env/roles", output
assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output assert_match "Uploading \"\\n\" to .kamal/apps/app/env/roles/web.env", output
assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output assert_match %r{docker run --detach --restart unless-stopped --name app-web-latest --network kamal --hostname 1.1.1.1-.* -e KAMAL_CONTAINER_NAME="app-web-latest" -e KAMAL_VERSION="latest" --env-file .kamal/apps/app/env/roles/web.env --log-opt max-size="10m" --label service="app" --label role="web" --label destination dhh/app:latest}, output
assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target \"12345678:80\" --deploy-timeout \"6s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", output assert_match "docker exec kamal-proxy kamal-proxy deploy app-web --target=\"12345678:80\" --deploy-timeout=\"6s\" --drain-timeout=\"30s\" --buffer-requests --buffer-responses --log-request-header=\"Cache-Control\" --log-request-header=\"Last-Modified\" --log-request-header=\"User-Agent\"", output
assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output assert_match "docker container ls --all --filter name=^app-web-12345678$ --quiet | xargs docker stop", output
assert_match "docker tag dhh/app:latest dhh/app:latest", output assert_match "docker tag dhh/app:latest dhh/app:latest", output
assert_match "/usr/bin/env mkdir -p .kamal", output assert_match "/usr/bin/env mkdir -p .kamal", output

View File

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

View File

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

View File

@@ -115,14 +115,30 @@ 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(" ") new_command.deploy(target: "172.1.0.2").join(" ")
end end
test "remove" do test "remove" do
assert_equal \ assert_equal \
"docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"", "docker exec kamal-proxy kamal-proxy remove app-web",
new_command.remove(target: "172.1.0.2").join(" ") new_command.remove.join(" ")
end end
@@ -278,7 +294,7 @@ class CommandsAppTest < ActiveSupport::TestCase
test "run over ssh with proxy" do test "run over ssh with proxy" do
@config[:ssh] = { "proxy" => "2.2.2.2" } @config[:ssh] = { "proxy" => "2.2.2.2" }
assert_equal "ssh -J root@2.2.2.2 -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1") assert_equal "ssh -J 2.2.2.2 -t root@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
end end
test "run over ssh with proxy user" do test "run over ssh with proxy user" do
@@ -288,7 +304,7 @@ class CommandsAppTest < ActiveSupport::TestCase
test "run over ssh with custom user with proxy" do test "run over ssh with custom user with proxy" do
@config[:ssh] = { "user" => "app", "proxy" => "2.2.2.2" } @config[:ssh] = { "user" => "app", "proxy" => "2.2.2.2" }
assert_equal "ssh -J root@2.2.2.2 -t app@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1") assert_equal "ssh -J 2.2.2.2 -t app@1.1.1.1 -p 22 'ls'", new_command.run_over_ssh("ls", host: "1.1.1.1")
end end
test "run over ssh with proxy_command" do test "run over ssh with proxy_command" do

View File

@@ -13,15 +13,29 @@ class ConfigurationProxyTest < ActiveSupport::TestCase
assert_equal true, config.proxy.ssl? assert_equal true, config.proxy.ssl?
end end
test "ssl with multiple hosts passed via host" do
@deploy[:proxy] = { "ssl" => true, "host" => "example.com,anotherexample.com" }
assert_equal true, config.proxy.ssl?
end
test "ssl with multiple hosts passed via hosts" do
@deploy[:proxy] = { "ssl" => true, "hosts" => [ "example.com", "anotherexample.com" ] }
assert_equal true, config.proxy.ssl?
end
test "ssl with no host" do test "ssl with no host" do
@deploy[:proxy] = { "ssl" => true } @deploy[:proxy] = { "ssl" => true }
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? } assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
end end
test "ssl with both host and hosts" do
@deploy[:proxy] = { "ssl" => true, host: "example.com", hosts: [ "anotherexample.com" ] }
assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? }
end
test "ssl false" do test "ssl false" do
@deploy[:proxy] = { "ssl" => false } @deploy[:proxy] = { "ssl" => false }
assert_not config.proxy.ssl? assert_not config.proxy.ssl?
assert_not config.proxy.deploy_options.has_key?(:tls)
end end
private private

View File

@@ -30,7 +30,7 @@ class ConfigurationSshTest < ActiveSupport::TestCase
test "ssh options with proxy host" do test "ssh options with proxy host" do
config = Kamal::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "1.2.3.4" }) }) config = Kamal::Configuration.new(@deploy.tap { |c| c.merge!(ssh: { "proxy" => "1.2.3.4" }) })
assert_equal "root@1.2.3.4", config.ssh.options[:proxy].jump_proxies assert_equal "1.2.3.4", config.ssh.options[:proxy].jump_proxies
end end
test "ssh options with proxy host and user" do test "ssh options with proxy host and user" do

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -50,6 +50,12 @@ class IntegrationTest < ActiveSupport::TestCase
assert_equal "502", response.code assert_equal "502", response.code
end end
def assert_app_not_found
response = app_response
debug_response_code(response, "404")
assert_equal "404", response.code
end
def assert_app_is_up(version: nil, app: @app) def assert_app_is_up(version: nil, app: @app)
response = app_response(app: app) response = app_response(app: app)
debug_response_code(response, "200") debug_response_code(response, "200")

View File

@@ -13,6 +13,17 @@ class BitwardenAdapterTest < SecretAdapterTestCase
assert_equal expected_json, json assert_equal expected_json, json
end end
test "fetch with no login" do
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_unlocked stub_unlocked
stub_ticks.with("bw sync").returns("") stub_ticks.with("bw sync").returns("")
@@ -181,6 +192,30 @@ 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_myitem def stub_myitem
stub_ticks stub_ticks
.with("bw get item myitem") .with("bw get item myitem")