Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9db1403721 | ||
|
|
bf4add9e72 | ||
|
|
7c7785c1eb | ||
|
|
80bd46cde3 | ||
|
|
b449321a45 | ||
|
|
24a7e94c14 | ||
|
|
d269fc5d36 |
13
.github/workflows/ci.yml
vendored
13
.github/workflows/ci.yml
vendored
@@ -3,8 +3,8 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 1-8-stable
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
rubocop:
|
||||
name: RuboCop
|
||||
@@ -23,29 +23,22 @@ jobs:
|
||||
run: bundle exec rubocop --parallel
|
||||
tests:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
ruby-version:
|
||||
- "3.1"
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
- "3.4"
|
||||
gemfile:
|
||||
- Gemfile
|
||||
- gemfiles/rails_edge.gemfile
|
||||
exclude:
|
||||
- ruby-version: "3.1"
|
||||
gemfile: gemfiles/rails_edge.gemfile
|
||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
env:
|
||||
BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Remove gemfile.lock
|
||||
run: rm Gemfile.lock
|
||||
|
||||
- name: Install Ruby
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
@@ -54,5 +47,3 @@ jobs:
|
||||
|
||||
- name: Run tests
|
||||
run: bin/test
|
||||
env:
|
||||
RUBYOPT: ${{ startsWith(matrix.ruby-version, '3.4.') && '--enable=frozen-string-literal' || '' }}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
FROM ruby:3.4-alpine
|
||||
# Use the official Ruby 3.2.0 Alpine image as the base image
|
||||
FROM ruby:3.2.0-alpine
|
||||
|
||||
# Install docker/buildx-bin
|
||||
COPY --from=docker/buildx-bin /buildx /usr/libexec/docker/cli-plugins/docker-buildx
|
||||
@@ -13,7 +14,7 @@ COPY Gemfile Gemfile.lock kamal.gemspec ./
|
||||
COPY lib/kamal/version.rb /kamal/lib/kamal/version.rb
|
||||
|
||||
# Install system dependencies
|
||||
RUN apk add --no-cache build-base git docker openrc openssh-client-default yaml-dev \
|
||||
RUN apk add --no-cache build-base git docker openrc openssh-client-default \
|
||||
&& rc-update add docker boot \
|
||||
&& gem install bundler --version=2.4.3 \
|
||||
&& bundle install
|
||||
@@ -32,7 +33,7 @@ WORKDIR /workdir
|
||||
|
||||
# Tell git it's safe to access /workdir/.git even if
|
||||
# the directory is owned by a different user
|
||||
RUN git config --global --add safe.directory '*'
|
||||
RUN git config --global --add safe.directory /workdir
|
||||
|
||||
# Set the entrypoint to run the installed binary in /workdir
|
||||
# Example: docker run -it -v "$PWD:/workdir" kamal init
|
||||
|
||||
158
Gemfile.lock
158
Gemfile.lock
@@ -1,155 +1,150 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
kamal (2.5.2)
|
||||
kamal (1.9.0)
|
||||
activesupport (>= 7.0)
|
||||
base64 (~> 0.2)
|
||||
bcrypt_pbkdf (~> 1.0)
|
||||
concurrent-ruby (~> 1.2)
|
||||
dotenv (~> 3.1)
|
||||
dotenv (~> 2.8)
|
||||
ed25519 (~> 1.2)
|
||||
net-ssh (~> 7.3)
|
||||
net-ssh (~> 7.0)
|
||||
sshkit (>= 1.23.0, < 2.0)
|
||||
thor (~> 1.3)
|
||||
zeitwerk (>= 2.6.18, < 3.0)
|
||||
thor (~> 1.2)
|
||||
zeitwerk (~> 2.5)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
actionpack (8.0.0.1)
|
||||
actionview (= 8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
actionpack (7.1.2)
|
||||
actionview (= 7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
nokogiri (>= 1.8.5)
|
||||
racc
|
||||
rack (>= 2.2.4)
|
||||
rack-session (>= 1.0.1)
|
||||
rack-test (>= 0.6.3)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
useragent (~> 0.16)
|
||||
actionview (8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
actionview (7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
builder (~> 3.1)
|
||||
erubi (~> 1.11)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
activesupport (8.0.0.1)
|
||||
activesupport (7.1.2)
|
||||
base64
|
||||
benchmark (>= 0.3)
|
||||
bigdecimal
|
||||
concurrent-ruby (~> 1.0, >= 1.3.1)
|
||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
||||
connection_pool (>= 2.2.5)
|
||||
drb
|
||||
i18n (>= 1.6, < 2)
|
||||
logger (>= 1.4.2)
|
||||
minitest (>= 5.1)
|
||||
securerandom (>= 0.3)
|
||||
tzinfo (~> 2.0, >= 2.0.5)
|
||||
uri (>= 0.13.1)
|
||||
mutex_m
|
||||
tzinfo (~> 2.0)
|
||||
ast (2.4.2)
|
||||
base64 (0.2.0)
|
||||
bcrypt_pbkdf (1.1.1)
|
||||
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||
benchmark (0.4.0)
|
||||
bigdecimal (3.1.8)
|
||||
builder (3.3.0)
|
||||
concurrent-ruby (1.3.4)
|
||||
bcrypt_pbkdf (1.1.0)
|
||||
bigdecimal (3.1.5)
|
||||
builder (3.2.4)
|
||||
concurrent-ruby (1.2.2)
|
||||
connection_pool (2.4.1)
|
||||
crass (1.0.6)
|
||||
date (3.4.1)
|
||||
debug (1.9.2)
|
||||
debug (1.9.1)
|
||||
irb (~> 1.10)
|
||||
reline (>= 0.3.8)
|
||||
dotenv (3.1.5)
|
||||
drb (2.2.1)
|
||||
dotenv (2.8.1)
|
||||
drb (2.2.0)
|
||||
ruby2_keywords
|
||||
ed25519 (1.3.0)
|
||||
erubi (1.13.0)
|
||||
i18n (1.14.6)
|
||||
erubi (1.12.0)
|
||||
i18n (1.14.1)
|
||||
concurrent-ruby (~> 1.0)
|
||||
io-console (0.8.0)
|
||||
irb (1.14.2)
|
||||
rdoc (>= 4.0.0)
|
||||
reline (>= 0.4.2)
|
||||
json (2.9.0)
|
||||
io-console (0.7.1)
|
||||
irb (1.11.0)
|
||||
rdoc
|
||||
reline (>= 0.3.8)
|
||||
json (2.7.1)
|
||||
language_server-protocol (3.17.0.3)
|
||||
logger (1.6.3)
|
||||
loofah (2.23.1)
|
||||
loofah (2.22.0)
|
||||
crass (~> 1.0.2)
|
||||
nokogiri (>= 1.12.0)
|
||||
minitest (5.25.4)
|
||||
mocha (2.7.1)
|
||||
minitest (5.20.0)
|
||||
mocha (2.1.0)
|
||||
ruby2_keywords (>= 0.0.5)
|
||||
mutex_m (0.2.0)
|
||||
net-scp (4.0.0)
|
||||
net-ssh (>= 2.6.5, < 8.0.0)
|
||||
net-sftp (4.0.0)
|
||||
net-ssh (>= 5.0.0, < 8.0.0)
|
||||
net-ssh (7.3.0)
|
||||
nokogiri (1.17.2-arm64-darwin)
|
||||
net-ssh (7.2.1)
|
||||
nokogiri (1.16.0-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.17.2-x86_64-darwin)
|
||||
nokogiri (1.16.0-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.17.2-x86_64-linux)
|
||||
nokogiri (1.16.0-x86_64-linux)
|
||||
racc (~> 1.4)
|
||||
ostruct (0.6.1)
|
||||
parallel (1.26.3)
|
||||
parser (3.3.6.0)
|
||||
parallel (1.24.0)
|
||||
parser (3.3.0.5)
|
||||
ast (~> 2.4.1)
|
||||
racc
|
||||
psych (5.2.1)
|
||||
date
|
||||
psych (5.1.2)
|
||||
stringio
|
||||
racc (1.8.1)
|
||||
rack (3.1.8)
|
||||
racc (1.7.3)
|
||||
rack (3.0.8)
|
||||
rack-session (2.0.0)
|
||||
rack (>= 3.0.0)
|
||||
rack-test (2.1.0)
|
||||
rack (>= 1.3)
|
||||
rackup (2.2.1)
|
||||
rackup (2.1.0)
|
||||
rack (>= 3)
|
||||
webrick (~> 1.8)
|
||||
rails-dom-testing (2.2.0)
|
||||
activesupport (>= 5.0.0)
|
||||
minitest
|
||||
nokogiri (>= 1.6)
|
||||
rails-html-sanitizer (1.6.2)
|
||||
rails-html-sanitizer (1.6.0)
|
||||
loofah (~> 2.21)
|
||||
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
|
||||
railties (8.0.0.1)
|
||||
actionpack (= 8.0.0.1)
|
||||
activesupport (= 8.0.0.1)
|
||||
irb (~> 1.13)
|
||||
nokogiri (~> 1.14)
|
||||
railties (7.1.2)
|
||||
actionpack (= 7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
irb
|
||||
rackup (>= 1.0.0)
|
||||
rake (>= 12.2)
|
||||
thor (~> 1.0, >= 1.2.2)
|
||||
zeitwerk (~> 2.6)
|
||||
rainbow (3.1.1)
|
||||
rake (13.2.1)
|
||||
rdoc (6.8.1)
|
||||
rake (13.1.0)
|
||||
rdoc (6.6.2)
|
||||
psych (>= 4.0.0)
|
||||
regexp_parser (2.9.3)
|
||||
reline (0.5.12)
|
||||
regexp_parser (2.9.0)
|
||||
reline (0.4.2)
|
||||
io-console (~> 0.5)
|
||||
rubocop (1.69.2)
|
||||
rexml (3.2.6)
|
||||
rubocop (1.62.1)
|
||||
json (~> 2.3)
|
||||
language_server-protocol (>= 3.17.0)
|
||||
parallel (~> 1.10)
|
||||
parser (>= 3.3.0.2)
|
||||
rainbow (>= 2.2.2, < 4.0)
|
||||
regexp_parser (>= 2.9.3, < 3.0)
|
||||
rubocop-ast (>= 1.36.2, < 2.0)
|
||||
regexp_parser (>= 1.8, < 3.0)
|
||||
rexml (>= 3.2.5, < 4.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (>= 2.4.0, < 4.0)
|
||||
rubocop-ast (1.36.2)
|
||||
parser (>= 3.3.1.0)
|
||||
rubocop-minitest (0.36.0)
|
||||
unicode-display_width (>= 2.4.0, < 3.0)
|
||||
rubocop-ast (1.31.2)
|
||||
parser (>= 3.3.0.4)
|
||||
rubocop-minitest (0.35.0)
|
||||
rubocop (>= 1.61, < 2.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-performance (1.23.0)
|
||||
rubocop-performance (1.20.2)
|
||||
rubocop (>= 1.48.1, < 2.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-rails (2.27.0)
|
||||
rubocop-ast (>= 1.30.0, < 2.0)
|
||||
rubocop-rails (2.24.0)
|
||||
activesupport (>= 4.2.0)
|
||||
rack (>= 1.1)
|
||||
rubocop (>= 1.52.0, < 2.0)
|
||||
rubocop (>= 1.33.0, < 2.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-rails-omakase (1.0.0)
|
||||
rubocop
|
||||
@@ -158,23 +153,18 @@ GEM
|
||||
rubocop-rails
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
securerandom (0.4.0)
|
||||
sshkit (1.23.2)
|
||||
sshkit (1.23.0)
|
||||
base64
|
||||
net-scp (>= 1.1.2)
|
||||
net-sftp (>= 2.1.2)
|
||||
net-ssh (>= 2.8.0)
|
||||
ostruct
|
||||
stringio (3.1.2)
|
||||
thor (1.3.2)
|
||||
stringio (3.1.0)
|
||||
thor (1.3.0)
|
||||
tzinfo (2.0.6)
|
||||
concurrent-ruby (~> 1.0)
|
||||
unicode-display_width (3.1.2)
|
||||
unicode-emoji (~> 4.0, >= 4.0.4)
|
||||
unicode-emoji (4.0.4)
|
||||
uri (1.0.2)
|
||||
useragent (0.16.11)
|
||||
zeitwerk (2.7.1)
|
||||
unicode-display_width (2.5.0)
|
||||
webrick (1.8.1)
|
||||
zeitwerk (2.6.12)
|
||||
|
||||
PLATFORMS
|
||||
arm64-darwin
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Kamal: Deploy web apps anywhere
|
||||
|
||||
From bare metal to cloud VMs, deploy web apps anywhere with zero downtime. Kamal uses [kamal-proxy](https://github.com/basecamp/kamal-proxy) to seamlessly switch requests between containers. Works seamlessly across multiple servers, using SSHKit to execute commands. Originally built for Rails apps, Kamal will work with any type of web app that can be containerized with Docker.
|
||||
From bare metal to cloud VMs, deploy web apps anywhere with zero downtime. Kamal has the dynamic reverse-proxy Traefik hold requests while a new app container is started and the old one is stopped. Works seamlessly across multiple hosts, using SSHKit to execute commands. Originally built for Rails apps, Kamal will work with any type of web app that can be containerized with Docker.
|
||||
|
||||
➡️ See [kamal-deploy.org](https://kamal-deploy.org) for documentation on [installation](https://kamal-deploy.org/docs/installation), [configuration](https://kamal-deploy.org/docs/configuration), and [commands](https://kamal-deploy.org/docs/commands).
|
||||
|
||||
|
||||
41
bin/docs
41
bin/docs
@@ -17,20 +17,19 @@ end
|
||||
|
||||
DOCS = {
|
||||
"accessory" => "Accessories",
|
||||
"alias" => "Aliases",
|
||||
"boot" => "Booting",
|
||||
"builder" => "Builders",
|
||||
"configuration" => "Configuration overview",
|
||||
"env" => "Environment variables",
|
||||
"healthcheck" => "Healthchecks",
|
||||
"logging" => "Logging",
|
||||
"proxy" => "Proxy",
|
||||
"registry" => "Docker Registry",
|
||||
"role" => "Roles",
|
||||
"servers" => "Servers",
|
||||
"ssh" => "SSH",
|
||||
"sshkit" => "SSHKit"
|
||||
"sshkit" => "SSHKit",
|
||||
"traefik" => "Traefik"
|
||||
}
|
||||
DOCS_PATH = "lib/kamal/configuration/docs"
|
||||
|
||||
class DocWriter
|
||||
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
||||
@@ -68,42 +67,38 @@ class DocWriter
|
||||
output.puts
|
||||
place = :new_section
|
||||
elsif line =~ /^ *#/
|
||||
generate_line(line, heading: place == :new_section)
|
||||
generate_line(line, place: place)
|
||||
place = :in_section
|
||||
else
|
||||
output.puts
|
||||
output.puts "```yaml"
|
||||
output.puts line
|
||||
output.print line
|
||||
place = :in_yaml
|
||||
end
|
||||
when :in_yaml, :in_empty_line_yaml
|
||||
when :in_yaml
|
||||
if line =~ /^ *#/
|
||||
output.puts "```"
|
||||
output.puts
|
||||
generate_line(line, heading: place == :in_empty_line_yaml)
|
||||
generate_line(line, place: :new_section)
|
||||
place = :in_section
|
||||
elsif line.empty?
|
||||
place = :in_empty_line_yaml
|
||||
else
|
||||
output.puts line
|
||||
output.puts
|
||||
output.print line
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
output.puts "```" if place == :in_yaml
|
||||
output.puts "\n```" if place == :in_yaml
|
||||
end
|
||||
|
||||
def generate_header
|
||||
output.puts "---"
|
||||
output.puts "# This file has been generated from the Kamal source, do not edit directly."
|
||||
output.puts "# Find the source of this file at #{DOCS_PATH}/#{key}.yml in the Kamal repository."
|
||||
output.puts "title: #{heading[2..-1]}"
|
||||
output.puts "---"
|
||||
output.puts
|
||||
output.puts heading
|
||||
output.puts
|
||||
end
|
||||
|
||||
def generate_line(line, heading: false)
|
||||
def generate_line(line, place: :in_section)
|
||||
line = line.gsub(/^ *#\s?/, "")
|
||||
|
||||
if line =~ /(.*)kamal docs ([a-z]*)(.*)/
|
||||
@@ -114,7 +109,7 @@ class DocWriter
|
||||
line = "#{$1}[#{titlify($2.split("/").last)}](#{$2})#{$3}"
|
||||
end
|
||||
|
||||
if heading
|
||||
if place == :new_section
|
||||
output.puts "## [#{line}](##{linkify(line)})"
|
||||
else
|
||||
output.puts line
|
||||
@@ -122,11 +117,7 @@ class DocWriter
|
||||
end
|
||||
|
||||
def linkify(text)
|
||||
if text == "Configuration overview"
|
||||
"overview"
|
||||
else
|
||||
text.downcase.gsub(" ", "-")
|
||||
end
|
||||
text.downcase.gsub(" ", "-")
|
||||
end
|
||||
|
||||
def titlify(text)
|
||||
@@ -134,8 +125,10 @@ class DocWriter
|
||||
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")
|
||||
Dir.glob("#{from_dir}/*") do |from_file|
|
||||
key = File.basename(from_file, ".yml")
|
||||
|
||||
DocWriter.new(from_file, to_dir).write
|
||||
end
|
||||
|
||||
@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
|
||||
|
||||
spec.add_dependency "activesupport", ">= 7.0"
|
||||
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
||||
spec.add_dependency "net-ssh", "~> 7.3"
|
||||
spec.add_dependency "thor", "~> 1.3"
|
||||
spec.add_dependency "dotenv", "~> 3.1"
|
||||
spec.add_dependency "zeitwerk", ">= 2.6.18", "< 3.0"
|
||||
spec.add_dependency "net-ssh", "~> 7.0"
|
||||
spec.add_dependency "thor", "~> 1.2"
|
||||
spec.add_dependency "dotenv", "~> 2.8"
|
||||
spec.add_dependency "zeitwerk", "~> 2.5"
|
||||
spec.add_dependency "ed25519", "~> 1.2"
|
||||
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
||||
spec.add_dependency "concurrent-ruby", "~> 1.2"
|
||||
|
||||
@@ -5,10 +5,8 @@ end
|
||||
require "active_support"
|
||||
require "zeitwerk"
|
||||
require "yaml"
|
||||
require "tmpdir"
|
||||
require "pathname"
|
||||
|
||||
loader = Zeitwerk::Loader.for_gem
|
||||
loader.ignore(File.join(__dir__, "kamal", "sshkit_with_ext.rb"))
|
||||
loader.setup
|
||||
loader.eager_load_namespace(Kamal::Cli) # We need all commands loaded.
|
||||
loader.eager_load # We need all commands loaded.
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
module Kamal::Cli
|
||||
class BootError < StandardError; end
|
||||
class HookError < StandardError; end
|
||||
class LockError < StandardError; end
|
||||
class DependencyError < StandardError; end
|
||||
end
|
||||
|
||||
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||
|
||||
@@ -1,28 +1,18 @@
|
||||
require "active_support/core_ext/array/conversions"
|
||||
|
||||
class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
desc "boot [NAME]", "Boot new accessory service on host (use NAME=all to boot all accessories)"
|
||||
def boot(name, prepare: true)
|
||||
def boot(name, login: true)
|
||||
with_lock do
|
||||
if name == "all"
|
||||
KAMAL.accessory_names.each { |accessory_name| boot(accessory_name) }
|
||||
else
|
||||
prepare(name) if prepare
|
||||
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
directories(name)
|
||||
upload(name)
|
||||
|
||||
on(hosts) do
|
||||
execute *KAMAL.registry.login if login
|
||||
execute *KAMAL.auditor.record("Booted #{name} accessory"), verbosity: :debug
|
||||
execute *accessory.ensure_env_directory
|
||||
upload! accessory.secrets_io, accessory.secrets_path, mode: "0600"
|
||||
execute *accessory.run
|
||||
|
||||
if accessory.running_proxy?
|
||||
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||
execute *accessory.deploy(target: target)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -65,10 +55,15 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
if name == "all"
|
||||
KAMAL.accessory_names.each { |accessory_name| reboot(accessory_name) }
|
||||
else
|
||||
prepare(name)
|
||||
stop(name)
|
||||
remove_container(name)
|
||||
boot(name, prepare: false)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
on(hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
end
|
||||
|
||||
stop(name)
|
||||
remove_container(name)
|
||||
boot(name, login: false)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -80,10 +75,6 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Started #{name} accessory"), verbosity: :debug
|
||||
execute *accessory.start
|
||||
if accessory.running_proxy?
|
||||
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||
execute *accessory.deploy(target: target)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -96,11 +87,6 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
|
||||
execute *accessory.stop, raise_on_non_zero_exit: false
|
||||
|
||||
if accessory.running_proxy?
|
||||
target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
|
||||
execute *accessory.remove if target
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -109,8 +95,10 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
desc "restart [NAME]", "Restart existing accessory container on host"
|
||||
def restart(name)
|
||||
with_lock do
|
||||
stop(name)
|
||||
start(name)
|
||||
with_accessory(name) do
|
||||
stop(name)
|
||||
start(name)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -126,15 +114,14 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "exec [NAME] [CMD...]", "Execute a custom command on servers within the accessory container (use --help to show options)"
|
||||
desc "exec [NAME] [CMD]", "Execute a custom command on servers (use --help to show options)"
|
||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||
def exec(name, *cmd)
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
def exec(name, cmd)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
case
|
||||
when options[:interactive] && options[:reuse]
|
||||
say "Launching interactive command via SSH from existing container...", :magenta
|
||||
say "Launching interactive command with via SSH from existing container...", :magenta
|
||||
run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }
|
||||
|
||||
when options[:interactive]
|
||||
@@ -143,16 +130,16 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
|
||||
when options[:reuse]
|
||||
say "Launching command from existing container...", :magenta
|
||||
on(hosts) do |host|
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||
puts_by_host host, capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||
capture_with_info(*accessory.execute_in_existing_container(cmd))
|
||||
end
|
||||
|
||||
else
|
||||
say "Launching command from new container...", :magenta
|
||||
on(hosts) do |host|
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
|
||||
puts_by_host host, capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||
capture_with_info(*accessory.execute_in_new_container(cmd))
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -162,27 +149,25 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||
option :grep_options, desc: "Additional options supplied to grep"
|
||||
option :grep_options, aliases: "-o", desc: "Additional options supplied to grep"
|
||||
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||
def logs(name)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{hosts}..."
|
||||
info accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
|
||||
exec accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
|
||||
info accessory.follow_logs(grep: grep, grep_options: grep_options)
|
||||
exec accessory.follow_logs(grep: grep, grep_options: grep_options)
|
||||
end
|
||||
else
|
||||
since = options[:since]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(hosts) do
|
||||
puts capture_with_info(*accessory.logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
puts capture_with_info(*accessory.logs(since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -237,19 +222,19 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "upgrade", "Upgrade accessories from Kamal 1.x to 2.0 (restart them in 'kamal' network)"
|
||||
desc "downgrade", "Downgrade accessories from Kamal 2 to 1.9"
|
||||
option :rolling, type: :boolean, default: false, desc: "Upgrade one host at a time"
|
||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||
def upgrade(name)
|
||||
def downgrade(name)
|
||||
confirming "This will restart all accessories" do
|
||||
with_lock do
|
||||
host_groups = options[:rolling] ? KAMAL.accessory_hosts : [ KAMAL.accessory_hosts ]
|
||||
host_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
KAMAL.with_specific_hosts(hosts) do
|
||||
say "Upgrading #{name} accessories on #{host_list}...", :magenta
|
||||
say "Downgrading #{name} accessories on #{host_list}...", :magenta
|
||||
reboot name
|
||||
say "Upgraded #{name} accessories on #{host_list}...", :magenta
|
||||
say "Downgraded #{name} accessories on #{host_list}...", :magenta
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -283,20 +268,11 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
def remove_accessory(name)
|
||||
stop(name)
|
||||
remove_container(name)
|
||||
remove_image(name)
|
||||
remove_service_directory(name)
|
||||
end
|
||||
|
||||
def prepare(name)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
on(hosts) do
|
||||
execute *KAMAL.registry.login(registry_config: accessory.registry)
|
||||
execute *KAMAL.docker.create_network
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise unless e.message.include?("already exists")
|
||||
end
|
||||
with_accessory(name) do
|
||||
stop(name)
|
||||
remove_container(name)
|
||||
remove_image(name)
|
||||
remove_service_directory(name)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
class Kamal::Cli::Alias::Command < Thor::DynamicCommand
|
||||
def run(instance, args = [])
|
||||
if (_alias = KAMAL.config.aliases[name])
|
||||
KAMAL.reset
|
||||
Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
|
||||
else
|
||||
super
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -4,7 +4,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
with_lock do
|
||||
say "Get most recent version available as an image...", :magenta unless options[:version]
|
||||
using_version(version_or_latest) do |version|
|
||||
say "Start container with version #{version} (or reboot if already running)...", :magenta
|
||||
say "Start container with version #{version} using a #{KAMAL.config.readiness_delay}s readiness delay (or reboot if already running)...", :magenta
|
||||
|
||||
# Assets are prepared in a separate step to ensure they are on all hosts before booting
|
||||
on(KAMAL.hosts) do
|
||||
@@ -16,18 +16,10 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
# Primary hosts and roles are returned first, so they can open the barrier
|
||||
barrier = Kamal::Cli::Healthcheck::Barrier.new
|
||||
|
||||
host_boot_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
run_hook "pre-app-boot", hosts: host_list
|
||||
|
||||
on(hosts) do |host|
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
||||
end
|
||||
on(KAMAL.hosts, **KAMAL.boot_strategy) do |host|
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
|
||||
end
|
||||
|
||||
run_hook "post-app-boot", hosts: host_list
|
||||
sleep KAMAL.config.boot.wait if KAMAL.config.boot.wait
|
||||
end
|
||||
|
||||
# Tag once the app booted on all hosts
|
||||
@@ -46,17 +38,8 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
execute *KAMAL.auditor.record("Started app version #{KAMAL.config.version}"), verbosity: :debug
|
||||
execute *app.start, raise_on_non_zero_exit: false
|
||||
|
||||
if role.running_proxy?
|
||||
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
|
||||
raise Kamal::Cli::BootError, "Failed to get endpoint for #{role} on #{host}, did the container boot?" if endpoint.empty?
|
||||
|
||||
execute *app.deploy(target: endpoint)
|
||||
end
|
||||
execute *KAMAL.app(role: role, host: host).start, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -69,18 +52,8 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
execute *KAMAL.auditor.record("Stopped app", role: role), verbosity: :debug
|
||||
|
||||
if role.running_proxy?
|
||||
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||
if endpoint.present?
|
||||
execute *app.remove, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
|
||||
execute *app.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.app(role: role, host: host).stop, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -98,19 +71,12 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "exec [CMD...]", "Execute a custom command on servers within the app container (use --help to show options)"
|
||||
desc "exec [CMD]", "Execute a custom command on servers within the app container (use --help to show options)"
|
||||
option :interactive, aliases: "-i", type: :boolean, default: false, desc: "Execute command over ssh for an interactive shell (use for console/bash)"
|
||||
option :reuse, type: :boolean, default: false, desc: "Reuse currently running container instead of starting a new one"
|
||||
option :env, aliases: "-e", type: :hash, desc: "Set environment variables for the command"
|
||||
option :detach, type: :boolean, default: false, desc: "Execute command in a detached container"
|
||||
def exec(*cmd)
|
||||
if (incompatible_options = [ :interactive, :reuse ].select { |key| options[:detach] && options[key] }.presence)
|
||||
raise ArgumentError, "Detach is not compatible with #{incompatible_options.join(" or ")}"
|
||||
end
|
||||
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
def exec(cmd)
|
||||
env = options[:env]
|
||||
detach = options[:detach]
|
||||
case
|
||||
when options[:interactive] && options[:reuse]
|
||||
say "Get current version of running container...", :magenta unless options[:version]
|
||||
@@ -152,7 +118,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
roles.each do |role|
|
||||
execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_new_container(cmd, env: env, detach: detach))
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_new_container(cmd, env: env))
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -200,18 +166,14 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
option :since, aliases: "-s", desc: "Show lines since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of lines to show from each server"
|
||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||
option :grep_options, desc: "Additional options supplied to grep"
|
||||
option :grep_options, aliases: "-o", desc: "Additional options supplied to grep"
|
||||
option :follow, aliases: "-f", desc: "Follow log on primary server (or specific host set by --hosts)"
|
||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||
option :container_id, desc: "Docker container ID to fetch logs"
|
||||
def logs
|
||||
# FIXME: Catch when app containers aren't running
|
||||
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
since = options[:since]
|
||||
container_id = options[:container_id]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 10) # Default to 10 lines if since or grep isn't set
|
||||
@@ -219,12 +181,12 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
run_locally do
|
||||
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
|
||||
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
info app.follow_logs(host: KAMAL.primary_host, container_id: container_id, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
||||
exec app.follow_logs(host: KAMAL.primary_host, container_id: container_id, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
|
||||
info app.follow_logs(host: KAMAL.primary_host, lines: lines, grep: grep, grep_options: grep_options)
|
||||
exec app.follow_logs(host: KAMAL.primary_host, lines: lines, grep: grep, grep_options: grep_options)
|
||||
end
|
||||
else
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
@@ -234,7 +196,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
|
||||
roles.each do |role|
|
||||
begin
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(container_id: container_id, timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
rescue SSHKit::Command::Failed
|
||||
puts_by_host host, "Nothing found"
|
||||
end
|
||||
@@ -249,7 +211,6 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
stop
|
||||
remove_containers
|
||||
remove_images
|
||||
remove_app_directory
|
||||
end
|
||||
end
|
||||
|
||||
@@ -291,20 +252,6 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_app_directory", "Remove the service directory from servers", hide: true
|
||||
def remove_app_directory
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
roles = KAMAL.roles_on(host)
|
||||
|
||||
roles.each do |role|
|
||||
execute *KAMAL.auditor.record("Removed #{KAMAL.config.app_directory} on all servers", role: role), verbosity: :debug
|
||||
execute *KAMAL.server.remove_app_directory, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "version", "Show app version currently running on servers"
|
||||
def version
|
||||
on(KAMAL.hosts) do |host|
|
||||
@@ -348,8 +295,4 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
yield
|
||||
end
|
||||
end
|
||||
|
||||
def host_boot_groups
|
||||
KAMAL.config.boot.limit ? KAMAL.hosts.each_slice(KAMAL.config.boot.limit).to_a : [ KAMAL.hosts ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
class Kamal::Cli::App::Boot
|
||||
attr_reader :host, :role, :version, :barrier, :sshkit
|
||||
delegate :execute, :capture_with_info, :capture_with_pretty_json, :info, :error, :upload!, to: :sshkit
|
||||
delegate :assets?, :running_proxy?, to: :role
|
||||
delegate :execute, :capture_with_info, :capture_with_pretty_json, :info, :error, to: :sshkit
|
||||
delegate :uses_cord?, :assets?, :running_traefik?, to: :role
|
||||
|
||||
def initialize(host, role, sshkit, version, barrier)
|
||||
@host = host
|
||||
@@ -45,22 +45,11 @@ class Kamal::Cli::App::Boot
|
||||
|
||||
def start_new_version
|
||||
audit "Booted app version #{version}"
|
||||
hostname = "#{host.to_s[0...51].chomp(".")}-#{SecureRandom.hex(6)}"
|
||||
|
||||
execute *app.ensure_env_directory
|
||||
upload! role.secrets_io(host), role.secrets_path, mode: "0600"
|
||||
|
||||
execute *app.tie_cord(role.cord_host_file) if uses_cord?
|
||||
hostname = "#{host.to_s[0...51].gsub(/\.+$/, '')}-#{SecureRandom.hex(6)}"
|
||||
execute *app.run(hostname: hostname)
|
||||
if running_proxy?
|
||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||
raise Kamal::Cli::BootError, "Failed to get endpoint for #{role} on #{host}, did the container boot?" if endpoint.empty?
|
||||
execute *app.deploy(target: endpoint)
|
||||
else
|
||||
Kamal::Cli::Healthcheck::Poller.wait_for_healthy(pause_after_ready: true) { capture_with_info(*app.status(version: version)) }
|
||||
end
|
||||
rescue => e
|
||||
error "Failed to boot #{role} on #{host}"
|
||||
raise e
|
||||
Kamal::Cli::Healthcheck::Poller.wait_for_healthy(pause_after_ready: true) { capture_with_info(*app.status(version: version)) }
|
||||
end
|
||||
|
||||
def stop_new_version
|
||||
@@ -68,7 +57,16 @@ class Kamal::Cli::App::Boot
|
||||
end
|
||||
|
||||
def stop_old_version(version)
|
||||
if uses_cord?
|
||||
cord = capture_with_info(*app.cord(version: version), raise_on_non_zero_exit: false).strip
|
||||
if cord.present?
|
||||
execute *app.cut_cord(cord)
|
||||
Kamal::Cli::Healthcheck::Poller.wait_for_unhealthy(pause_after_ready: true) { capture_with_info(*app.status(version: version)) }
|
||||
end
|
||||
end
|
||||
|
||||
execute *app.stop(version: version), raise_on_non_zero_exit: false
|
||||
|
||||
execute *app.clean_up_assets if assets?
|
||||
end
|
||||
|
||||
@@ -90,12 +88,8 @@ class Kamal::Cli::App::Boot
|
||||
def close_barrier
|
||||
if barrier.close
|
||||
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting any other roles"
|
||||
begin
|
||||
error capture_with_info(*app.logs(container_id: app.container_id_for_version(version)))
|
||||
error capture_with_info(*app.container_health_log(version: version))
|
||||
rescue SSHKit::Command::Failed
|
||||
error "Could not fetch logs for #{version}"
|
||||
end
|
||||
error capture_with_info(*app.logs(version: version))
|
||||
error capture_with_info(*app.container_health_log(version: version))
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
require "thor"
|
||||
require "dotenv"
|
||||
require "kamal/sshkit_with_ext"
|
||||
|
||||
module Kamal::Cli
|
||||
@@ -6,7 +7,6 @@ module Kamal::Cli
|
||||
include SSHKit::DSL
|
||||
|
||||
def self.exit_on_failure?() true end
|
||||
def self.dynamic_command_class() Kamal::Cli::Alias::Command end
|
||||
|
||||
class_option :verbose, type: :boolean, aliases: "-v", desc: "Detailed logging"
|
||||
class_option :quiet, type: :boolean, aliases: "-q", desc: "Minimal logging"
|
||||
@@ -22,24 +22,55 @@ module Kamal::Cli
|
||||
|
||||
class_option :skip_hooks, aliases: "-H", type: :boolean, default: false, desc: "Don't run hooks"
|
||||
|
||||
def initialize(args = [], local_options = {}, config = {})
|
||||
if config[:current_command].is_a?(Kamal::Cli::Alias::Command)
|
||||
# When Thor generates a dynamic command, it doesn't attempt to parse the arguments.
|
||||
# For our purposes, it means the arguments are passed in args rather than local_options.
|
||||
super([], args, config)
|
||||
else
|
||||
super
|
||||
end
|
||||
|
||||
initialize_commander unless KAMAL.configured?
|
||||
def initialize(*)
|
||||
super
|
||||
@original_env = ENV.to_h.dup
|
||||
load_env
|
||||
initialize_commander(options_with_subcommand_class_options)
|
||||
end
|
||||
|
||||
private
|
||||
def reload_env
|
||||
reset_env
|
||||
load_env
|
||||
end
|
||||
|
||||
def load_env
|
||||
if destination = options[:destination]
|
||||
Dotenv.load(".env.#{destination}", ".env")
|
||||
else
|
||||
Dotenv.load(".env")
|
||||
end
|
||||
end
|
||||
|
||||
def reset_env
|
||||
replace_env @original_env
|
||||
end
|
||||
|
||||
def replace_env(env)
|
||||
ENV.clear
|
||||
ENV.update(env)
|
||||
end
|
||||
|
||||
def with_original_env
|
||||
keeping_current_env do
|
||||
reset_env
|
||||
yield
|
||||
end
|
||||
end
|
||||
|
||||
def keeping_current_env
|
||||
current_env = ENV.to_h.dup
|
||||
yield
|
||||
ensure
|
||||
replace_env(current_env)
|
||||
end
|
||||
|
||||
def options_with_subcommand_class_options
|
||||
options.merge(@_initializer.last[:class_options] || {})
|
||||
end
|
||||
|
||||
def initialize_commander
|
||||
def initialize_commander(options)
|
||||
KAMAL.tap do |commander|
|
||||
if options[:verbose]
|
||||
ENV["VERBOSE"] = "1" # For backtraces via cli/start
|
||||
@@ -74,6 +105,8 @@ module Kamal::Cli
|
||||
if KAMAL.holding_lock?
|
||||
yield
|
||||
else
|
||||
ensure_run_and_locks_directory
|
||||
|
||||
acquire_lock
|
||||
|
||||
begin
|
||||
@@ -102,8 +135,6 @@ module Kamal::Cli
|
||||
end
|
||||
|
||||
def acquire_lock
|
||||
ensure_run_directory
|
||||
|
||||
raise_if_locked do
|
||||
say "Acquiring the deploy lock...", :magenta
|
||||
on(KAMAL.primary_host) { execute *KAMAL.lock.acquire("Automatic deploy lock", KAMAL.config.version), verbosity: :debug }
|
||||
@@ -136,10 +167,8 @@ module Kamal::Cli
|
||||
details = { hosts: KAMAL.hosts.join(","), command: command, subcommand: subcommand }
|
||||
|
||||
say "Running the #{hook} hook...", :magenta
|
||||
with_env KAMAL.hook.env(**details, **extra_details) do
|
||||
run_locally do
|
||||
execute *KAMAL.hook.run(hook)
|
||||
end
|
||||
run_locally do
|
||||
execute *KAMAL.hook.run(hook, **details, **extra_details)
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise HookError.new("Hook `#{hook}` failed:\n#{e.message}")
|
||||
end
|
||||
@@ -181,32 +210,13 @@ module Kamal::Cli
|
||||
instance_variable_get("@_invocations")[cli_class].pop
|
||||
end
|
||||
|
||||
def ensure_run_directory
|
||||
def ensure_run_and_locks_directory
|
||||
on(KAMAL.hosts) do
|
||||
execute(*KAMAL.server.ensure_run_directory)
|
||||
end
|
||||
end
|
||||
|
||||
def with_env(env)
|
||||
current_env = ENV.to_h.dup
|
||||
ENV.update(env)
|
||||
yield
|
||||
ensure
|
||||
ENV.clear
|
||||
ENV.update(current_env)
|
||||
end
|
||||
|
||||
def ensure_docker_installed
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.ensure_docker_installed
|
||||
rescue SSHKit::Command::Failed => e
|
||||
error = e.message =~ /command not found/ ?
|
||||
"Docker is not installed locally" :
|
||||
"Docker buildx plugin is not installed locally"
|
||||
|
||||
raise DependencyError, error
|
||||
end
|
||||
on(KAMAL.primary_host) do
|
||||
execute(*KAMAL.lock.ensure_locks_directory)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -5,16 +5,15 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
|
||||
desc "deliver", "Build app and push app image to registry then pull image on servers"
|
||||
def deliver
|
||||
invoke :push
|
||||
invoke :pull
|
||||
push
|
||||
pull
|
||||
end
|
||||
|
||||
desc "push", "Build and push app image to registry"
|
||||
option :output, type: :string, default: "registry", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||
def push
|
||||
cli = self
|
||||
|
||||
ensure_docker_installed
|
||||
verify_local_dependencies
|
||||
run_hook "pre-build"
|
||||
|
||||
uncommitted_changes = Kamal::Git.uncommitted_changes
|
||||
@@ -31,30 +30,29 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
say "Building with uncommitted changes:\n #{uncommitted_changes}", :yellow
|
||||
end
|
||||
|
||||
with_env(KAMAL.config.builder.secrets) do
|
||||
run_locally do
|
||||
begin
|
||||
execute *KAMAL.builder.inspect_builder
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /(context not found|no builder|no compatible builder|does not exist)/
|
||||
warn "Missing compatible builder, so creating a new one first"
|
||||
begin
|
||||
cli.remove
|
||||
rescue SSHKit::Command::Failed
|
||||
raise unless e.message =~ /(context not found|no builder|does not exist)/
|
||||
end
|
||||
cli.create
|
||||
else
|
||||
raise
|
||||
end
|
||||
end
|
||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||
push = KAMAL.builder.push
|
||||
|
||||
# Get the command here to ensure the Dir.chdir doesn't interfere with it
|
||||
push = KAMAL.builder.push(cli.options[:output])
|
||||
run_locally do
|
||||
begin
|
||||
context_hosts = capture_with_info(*KAMAL.builder.context_hosts).split("\n")
|
||||
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
if context_hosts != KAMAL.builder.config_context_hosts
|
||||
warn "Context hosts have changed, so re-creating builder, was: #{context_hosts.join(", ")}], now: #{KAMAL.builder.config_context_hosts.join(", ")}"
|
||||
cli.remove
|
||||
cli.create
|
||||
end
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /(context not found|no builder|does not exist)/
|
||||
warn "Missing compatible builder, so creating a new one first"
|
||||
cli.create
|
||||
else
|
||||
raise
|
||||
end
|
||||
end
|
||||
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -74,7 +72,7 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
|
||||
desc "create", "Create a build setup"
|
||||
def create
|
||||
if (remote_host = KAMAL.config.builder.remote)
|
||||
if (remote_host = KAMAL.config.builder.remote_host)
|
||||
connect_to_remote_host(remote_host)
|
||||
end
|
||||
|
||||
@@ -109,42 +107,21 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "dev", "Build using the working directory, tag it as dirty, and push to local image store."
|
||||
option :output, type: :string, default: "docker", banner: "export_type", desc: "Exported type for the build result, and may be any exported type supported by 'buildx --output'."
|
||||
def dev
|
||||
cli = self
|
||||
|
||||
ensure_docker_installed
|
||||
|
||||
docker_included_files = Set.new(Kamal::Docker.included_files)
|
||||
git_uncommitted_files = Set.new(Kamal::Git.uncommitted_files)
|
||||
git_untracked_files = Set.new(Kamal::Git.untracked_files)
|
||||
|
||||
docker_uncommitted_files = docker_included_files & git_uncommitted_files
|
||||
if docker_uncommitted_files.any?
|
||||
say "WARNING: Files with uncommitted changes will be present in the dev container:", :yellow
|
||||
docker_uncommitted_files.sort.each { |f| say " #{f}", :yellow }
|
||||
say
|
||||
end
|
||||
|
||||
docker_untracked_files = docker_included_files & git_untracked_files
|
||||
if docker_untracked_files.any?
|
||||
say "WARNING: Untracked files will be present in the dev container:", :yellow
|
||||
docker_untracked_files.sort.each { |f| say " #{f}", :yellow }
|
||||
say
|
||||
end
|
||||
|
||||
with_env(KAMAL.config.builder.secrets) do
|
||||
private
|
||||
def verify_local_dependencies
|
||||
run_locally do
|
||||
build = KAMAL.builder.push(cli.options[:output], tag_as_dirty: true)
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
execute(*build)
|
||||
begin
|
||||
execute *KAMAL.builder.ensure_local_dependencies_installed
|
||||
rescue SSHKit::Command::Failed => e
|
||||
build_error = e.message =~ /command not found/ ?
|
||||
"Docker is not installed locally" :
|
||||
"Docker buildx plugin is not installed locally"
|
||||
|
||||
raise BuildError, build_error
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def connect_to_remote_host(remote_host)
|
||||
remote_uri = URI.parse(remote_host)
|
||||
if remote_uri.scheme == "ssh"
|
||||
|
||||
54
lib/kamal/cli/env.rb
Normal file
54
lib/kamal/cli/env.rb
Normal file
@@ -0,0 +1,54 @@
|
||||
require "tempfile"
|
||||
|
||||
class Kamal::Cli::Env < Kamal::Cli::Base
|
||||
desc "push", "Push the env file to the remote hosts"
|
||||
def push
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do
|
||||
execute *KAMAL.auditor.record("Pushed env files"), verbosity: :debug
|
||||
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
execute *KAMAL.app(role: role, host: host).make_env_directory
|
||||
upload! role.env(host).secrets_io, role.env(host).secrets_file, mode: 400
|
||||
end
|
||||
end
|
||||
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.traefik.make_env_directory
|
||||
upload! KAMAL.traefik.env.secrets_io, KAMAL.traefik.env.secrets_file, mode: 400
|
||||
end
|
||||
|
||||
on(KAMAL.accessory_hosts) do
|
||||
KAMAL.accessories_on(host).each do |accessory|
|
||||
accessory_config = KAMAL.config.accessory(accessory)
|
||||
execute *KAMAL.accessory(accessory).make_env_directory
|
||||
upload! accessory_config.env.secrets_io, accessory_config.env.secrets_file, mode: 400
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "delete", "Delete the env file from the remote hosts"
|
||||
def delete
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do
|
||||
execute *KAMAL.auditor.record("Deleted env files"), verbosity: :debug
|
||||
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
execute *KAMAL.app(role: role, host: host).remove_env_file
|
||||
end
|
||||
end
|
||||
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.traefik.remove_env_file
|
||||
end
|
||||
|
||||
on(KAMAL.accessory_hosts) do
|
||||
KAMAL.accessories_on(host).each do |accessory|
|
||||
accessory_config = KAMAL.config.accessory(accessory)
|
||||
execute *KAMAL.accessory(accessory).remove_env_file
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,5 +1,3 @@
|
||||
require "concurrent/ivar"
|
||||
|
||||
class Kamal::Cli::Healthcheck::Barrier
|
||||
def initialize
|
||||
@ivar = Concurrent::IVar.new
|
||||
|
||||
@@ -1,30 +1,26 @@
|
||||
module Kamal::Cli::Healthcheck::Poller
|
||||
extend self
|
||||
|
||||
def wait_for_healthy(role, &block)
|
||||
TRAEFIK_UPDATE_DELAY = 5
|
||||
|
||||
|
||||
def wait_for_healthy(pause_after_ready: false, &block)
|
||||
attempt = 1
|
||||
timeout_at = Time.now + KAMAL.config.deploy_timeout
|
||||
readiness_delay = KAMAL.config.readiness_delay
|
||||
max_attempts = KAMAL.config.healthcheck.max_attempts
|
||||
|
||||
begin
|
||||
status = block.call
|
||||
|
||||
if status == "running"
|
||||
# Wait for the readiness delay and confirm it is still running
|
||||
if readiness_delay > 0
|
||||
info "Container is running, waiting for readiness delay of #{readiness_delay} seconds"
|
||||
sleep readiness_delay
|
||||
status = block.call
|
||||
end
|
||||
end
|
||||
|
||||
unless %w[ running healthy ].include?(status)
|
||||
raise Kamal::Cli::Healthcheck::Error, "container not ready after #{KAMAL.config.deploy_timeout} seconds (#{status})"
|
||||
case status = block.call
|
||||
when "healthy"
|
||||
sleep TRAEFIK_UPDATE_DELAY if pause_after_ready
|
||||
when "running" # No health check configured
|
||||
sleep KAMAL.config.readiness_delay if pause_after_ready
|
||||
else
|
||||
raise Kamal::Cli::Healthcheck::Error, "container not ready (#{status})"
|
||||
end
|
||||
rescue Kamal::Cli::Healthcheck::Error => e
|
||||
time_left = timeout_at - Time.now
|
||||
if time_left > 0
|
||||
sleep [ attempt, time_left ].min
|
||||
if attempt <= max_attempts
|
||||
info "#{e.message}, retrying in #{attempt}s (attempt #{attempt}/#{max_attempts})..."
|
||||
sleep attempt
|
||||
attempt += 1
|
||||
retry
|
||||
else
|
||||
@@ -35,6 +31,31 @@ module Kamal::Cli::Healthcheck::Poller
|
||||
info "Container is healthy!"
|
||||
end
|
||||
|
||||
def wait_for_unhealthy(pause_after_ready: false, &block)
|
||||
attempt = 1
|
||||
max_attempts = KAMAL.config.healthcheck.max_attempts
|
||||
|
||||
begin
|
||||
case status = block.call
|
||||
when "unhealthy"
|
||||
sleep TRAEFIK_UPDATE_DELAY if pause_after_ready
|
||||
else
|
||||
raise Kamal::Cli::Healthcheck::Error, "container not unhealthy (#{status})"
|
||||
end
|
||||
rescue Kamal::Cli::Healthcheck::Error => e
|
||||
if attempt <= max_attempts
|
||||
info "#{e.message}, retrying in #{attempt}s (attempt #{attempt}/#{max_attempts})..."
|
||||
sleep attempt
|
||||
attempt += 1
|
||||
retry
|
||||
else
|
||||
raise
|
||||
end
|
||||
end
|
||||
|
||||
info "Container is unhealthy!"
|
||||
end
|
||||
|
||||
private
|
||||
def info(message)
|
||||
SSHKit.config.output.info(message)
|
||||
|
||||
@@ -3,6 +3,7 @@ class Kamal::Cli::Lock < Kamal::Cli::Base
|
||||
def status
|
||||
handle_missing_lock do
|
||||
on(KAMAL.primary_host) do
|
||||
execute *KAMAL.server.ensure_run_directory
|
||||
puts capture_with_debug(*KAMAL.lock.status)
|
||||
end
|
||||
end
|
||||
@@ -12,10 +13,9 @@ class Kamal::Cli::Lock < Kamal::Cli::Base
|
||||
option :message, aliases: "-m", type: :string, desc: "A lock message", required: true
|
||||
def acquire
|
||||
message = options[:message]
|
||||
ensure_run_directory
|
||||
|
||||
raise_if_locked do
|
||||
on(KAMAL.primary_host) do
|
||||
execute *KAMAL.server.ensure_run_directory
|
||||
execute *KAMAL.lock.acquire(message, KAMAL.config.version), verbosity: :debug
|
||||
end
|
||||
say "Acquired the deploy lock"
|
||||
@@ -26,6 +26,7 @@ class Kamal::Cli::Lock < Kamal::Cli::Base
|
||||
def release
|
||||
handle_missing_lock do
|
||||
on(KAMAL.primary_host) do
|
||||
execute *KAMAL.server.ensure_run_directory
|
||||
execute *KAMAL.lock.release, verbosity: :debug
|
||||
end
|
||||
say "Released the deploy lock"
|
||||
|
||||
@@ -9,14 +9,19 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
say "Ensure Docker is installed...", :magenta
|
||||
invoke "kamal:cli:server:bootstrap", [], invoke_options
|
||||
|
||||
deploy(boot_accessories: true)
|
||||
say "Evaluate and push env files...", :magenta
|
||||
invoke "kamal:cli:main:envify", [], invoke_options
|
||||
invoke "kamal:cli:env:push", [], invoke_options
|
||||
|
||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options
|
||||
deploy
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "deploy", "Deploy app to servers"
|
||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
||||
def deploy(boot_accessories: false)
|
||||
def deploy
|
||||
runtime = print_runtime do
|
||||
invoke_options = deploy_options
|
||||
|
||||
@@ -32,12 +37,10 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
with_lock do
|
||||
run_hook "pre-deploy", secrets: true
|
||||
run_hook "pre-deploy"
|
||||
|
||||
say "Ensure kamal-proxy is running...", :magenta
|
||||
invoke "kamal:cli:proxy:boot", [], invoke_options
|
||||
|
||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options if boot_accessories
|
||||
say "Ensure Traefik is running...", :magenta
|
||||
invoke "kamal:cli:traefik:boot", [], invoke_options
|
||||
|
||||
say "Detect stale containers...", :magenta
|
||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||
@@ -49,10 +52,10 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s
|
||||
run_hook "post-deploy", runtime: runtime.round
|
||||
end
|
||||
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting kamal-proxy, pruning, and registry login"
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting Traefik, pruning, and registry login"
|
||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip image build and push"
|
||||
def redeploy
|
||||
runtime = print_runtime do
|
||||
@@ -67,7 +70,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
with_lock do
|
||||
run_hook "pre-deploy", secrets: true
|
||||
run_hook "pre-deploy"
|
||||
|
||||
say "Detect stale containers...", :magenta
|
||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||
@@ -76,7 +79,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s
|
||||
run_hook "post-deploy", runtime: runtime.round
|
||||
end
|
||||
|
||||
desc "rollback [VERSION]", "Rollback app to VERSION"
|
||||
@@ -90,7 +93,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
old_version = nil
|
||||
|
||||
if container_available?(version)
|
||||
run_hook "pre-deploy", secrets: true
|
||||
run_hook "pre-deploy"
|
||||
|
||||
invoke "kamal:cli:app:boot", [], invoke_options.merge(version: version)
|
||||
rolled_back = true
|
||||
@@ -100,12 +103,12 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round.to_s if rolled_back
|
||||
run_hook "post-deploy", runtime: runtime.round if rolled_back
|
||||
end
|
||||
|
||||
desc "details", "Show details about all containers"
|
||||
def details
|
||||
invoke "kamal:cli:proxy:details"
|
||||
invoke "kamal:cli:traefik:details"
|
||||
invoke "kamal:cli:app:details"
|
||||
invoke "kamal:cli:accessory:details", [ "all" ]
|
||||
end
|
||||
@@ -124,7 +127,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "docs [SECTION]", "Show Kamal configuration documentation"
|
||||
desc "docs", "Show Kamal documentation for configuration setting"
|
||||
def docs(section = nil)
|
||||
case section
|
||||
when NilClass
|
||||
@@ -136,7 +139,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
puts "No documentation found for #{section}"
|
||||
end
|
||||
|
||||
desc "init", "Create config stub in config/deploy.yml and 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"
|
||||
def init
|
||||
require "fileutils"
|
||||
@@ -149,10 +152,9 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
puts "Created configuration file in config/deploy.yml"
|
||||
end
|
||||
|
||||
unless (secrets_file = Pathname.new(File.expand_path(".kamal/secrets"))).exist?
|
||||
FileUtils.mkdir_p secrets_file.dirname
|
||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/secrets", __dir__)), secrets_file
|
||||
puts "Created .kamal/secrets file"
|
||||
unless (deploy_file = Pathname.new(File.expand_path(".env"))).exist?
|
||||
FileUtils.cp_r Pathname.new(File.expand_path("templates/template.env", __dir__)), deploy_file
|
||||
puts "Created .env file"
|
||||
end
|
||||
|
||||
unless (hooks_dir = Pathname.new(File.expand_path(".kamal/hooks"))).exist?
|
||||
@@ -177,45 +179,70 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove", "Remove kamal-proxy, app, accessories, and registry session from servers"
|
||||
desc "envify", "Create .env by evaluating .env.erb (or .env.staging.erb -> .env.staging when using -d staging)"
|
||||
option :skip_push, aliases: "-P", type: :boolean, default: false, desc: "Skip .env file push"
|
||||
def envify
|
||||
if destination = options[:destination]
|
||||
env_template_path = ".env.#{destination}.erb"
|
||||
env_path = ".env.#{destination}"
|
||||
else
|
||||
env_template_path = ".env.erb"
|
||||
env_path = ".env"
|
||||
end
|
||||
|
||||
if Pathname.new(File.expand_path(env_template_path)).exist?
|
||||
# Ensure existing env doesn't pollute template evaluation
|
||||
content = with_original_env { ERB.new(File.read(env_template_path), trim_mode: "-").result }
|
||||
File.write(env_path, content, perm: 0600)
|
||||
|
||||
unless options[:skip_push]
|
||||
reload_env
|
||||
invoke "kamal:cli:env:push", options
|
||||
end
|
||||
else
|
||||
puts "Skipping envify (no #{env_template_path} exist)"
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove", "Remove Traefik, app, accessories, and registry session from servers"
|
||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||
def remove
|
||||
confirming "This will remove all containers and images. Are you sure?" do
|
||||
with_lock do
|
||||
invoke "kamal:cli:traefik:remove", [], options.without(:confirmed)
|
||||
invoke "kamal:cli:app:remove", [], options.without(:confirmed)
|
||||
invoke "kamal:cli:proxy:remove", [], options.without(:confirmed)
|
||||
invoke "kamal:cli:accessory:remove", [ "all" ], options
|
||||
invoke "kamal:cli:registry:logout", [], options.without(:confirmed).merge(skip_local: true)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "upgrade", "Upgrade from Kamal 1.x to 2.0"
|
||||
desc "downgrade", "Downgrade from Kamal 2 to 1.9"
|
||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||
option :rolling, type: :boolean, default: false, desc: "Upgrade one host at a time"
|
||||
def upgrade
|
||||
option :rolling, type: :boolean, default: false, desc: "Downgrade one host at a time"
|
||||
def downgrade
|
||||
confirming "This will replace Traefik with kamal-proxy and restart all accessories" do
|
||||
with_lock do
|
||||
if options[:rolling]
|
||||
(KAMAL.hosts | KAMAL.accessory_hosts).each do |host|
|
||||
KAMAL.with_specific_hosts(host) do
|
||||
say "Upgrading #{host}...", :magenta
|
||||
say "Downgrading #{host}...", :magenta
|
||||
if KAMAL.hosts.include?(host)
|
||||
invoke "kamal:cli:proxy:upgrade", [], options.merge(confirmed: true, rolling: false)
|
||||
reset_invocation(Kamal::Cli::Proxy)
|
||||
invoke "kamal:cli:traefik:downgrade", [], options.merge(confirmed: true, rolling: false)
|
||||
reset_invocation(Kamal::Cli::Traefik)
|
||||
end
|
||||
if KAMAL.accessory_hosts.include?(host)
|
||||
invoke "kamal:cli:accessory:upgrade", [ "all" ], options.merge(confirmed: true, rolling: false)
|
||||
invoke "kamal:cli:accessory:downgrade", [ "all" ], options.merge(confirmed: true, rolling: false)
|
||||
reset_invocation(Kamal::Cli::Accessory)
|
||||
end
|
||||
say "Upgraded #{host}", :magenta
|
||||
say "Downgraded #{host}", :magenta
|
||||
end
|
||||
end
|
||||
else
|
||||
say "Upgrading all hosts...", :magenta
|
||||
invoke "kamal:cli:proxy:upgrade", [], options.merge(confirmed: true)
|
||||
invoke "kamal:cli:accessory:upgrade", [ "all" ], options.merge(confirmed: true)
|
||||
say "Upgraded all hosts", :magenta
|
||||
say "Downgrading all hosts...", :magenta
|
||||
invoke "kamal:cli:traefik:downgrade", [], options.merge(confirmed: true)
|
||||
invoke "kamal:cli:accessory:downgrade", [ "all" ], options.merge(confirmed: true)
|
||||
say "Downgraded all hosts", :magenta
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -235,24 +262,24 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
desc "build", "Build application image"
|
||||
subcommand "build", Kamal::Cli::Build
|
||||
|
||||
desc "env", "Manage environment files"
|
||||
subcommand "env", Kamal::Cli::Env
|
||||
|
||||
desc "lock", "Manage the deploy lock"
|
||||
subcommand "lock", Kamal::Cli::Lock
|
||||
|
||||
desc "proxy", "Manage kamal-proxy"
|
||||
subcommand "proxy", Kamal::Cli::Proxy
|
||||
|
||||
desc "prune", "Prune old application images and containers"
|
||||
subcommand "prune", Kamal::Cli::Prune
|
||||
|
||||
desc "registry", "Login and -out of the image registry"
|
||||
subcommand "registry", Kamal::Cli::Registry
|
||||
|
||||
desc "secrets", "Helpers for extracting secrets"
|
||||
subcommand "secrets", Kamal::Cli::Secrets
|
||||
|
||||
desc "server", "Bootstrap servers with curl and Docker"
|
||||
subcommand "server", Kamal::Cli::Server
|
||||
|
||||
desc "traefik", "Manage Traefik load balancer"
|
||||
subcommand "traefik", Kamal::Cli::Traefik
|
||||
|
||||
private
|
||||
def container_available?(version)
|
||||
begin
|
||||
|
||||
@@ -1,255 +0,0 @@
|
||||
class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
desc "boot", "Boot proxy on servers"
|
||||
def boot
|
||||
with_lock do
|
||||
on(KAMAL.hosts) do |host|
|
||||
execute *KAMAL.docker.create_network
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise unless e.message.include?("already exists")
|
||||
end
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
version = capture_with_info(*KAMAL.proxy.version).strip.presence
|
||||
|
||||
if version && Kamal::Utils.older_version?(version, Kamal::Configuration::PROXY_MINIMUM_VERSION)
|
||||
raise "kamal-proxy version #{version} is too old, run `kamal proxy reboot` in order to update to at least #{Kamal::Configuration::PROXY_MINIMUM_VERSION}"
|
||||
end
|
||||
execute *KAMAL.proxy.start_or_run
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "boot_config <set|get|reset>", "Manage kamal-proxy boot configuration"
|
||||
option :publish, type: :boolean, default: true, desc: "Publish the proxy ports on the host"
|
||||
option :publish_host_ip, type: :string, repeatable: true, default: nil, desc: "Host IP address to bind HTTP/HTTPS traffic to. Defaults to all interfaces"
|
||||
option :http_port, type: :numeric, default: Kamal::Configuration::PROXY_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], options[:publish_host_ip]) if options[:publish]),
|
||||
*(KAMAL.config.proxy_logging_args(options[:log_max_size])),
|
||||
*options[:docker_options].map { |option| "--#{option}" }
|
||||
]
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute(*KAMAL.proxy.ensure_proxy_directory)
|
||||
upload! StringIO.new(boot_options.join(" ")), KAMAL.config.proxy_options_file
|
||||
end
|
||||
when "get"
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
puts "Host #{host}: #{capture_with_info(*KAMAL.proxy.get_boot_options)}"
|
||||
end
|
||||
when "reset"
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute *KAMAL.proxy.reset_boot_options
|
||||
end
|
||||
else
|
||||
raise ArgumentError, "Unknown boot_config subcommand #{subcommand}"
|
||||
end
|
||||
end
|
||||
|
||||
desc "reboot", "Reboot proxy on servers (stop container, remove container, start new container)"
|
||||
option :rolling, type: :boolean, default: false, desc: "Reboot proxy on hosts in sequence, rather than in parallel"
|
||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||
def reboot
|
||||
confirming "This will cause a brief outage on each host. Are you sure?" do
|
||||
with_lock do
|
||||
host_groups = options[:rolling] ? KAMAL.proxy_hosts : [ KAMAL.proxy_hosts ]
|
||||
host_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
run_hook "pre-proxy-reboot", hosts: host_list
|
||||
on(hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.remove_container
|
||||
|
||||
execute *KAMAL.proxy.run
|
||||
|
||||
KAMAL.roles_on(host).select(&:running_proxy?).each do |role|
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
|
||||
version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
|
||||
endpoint = capture_with_info(*app.container_id_for_version(version)).strip
|
||||
|
||||
if endpoint.present?
|
||||
info "Deploying #{endpoint} for role `#{role}` on #{host}..."
|
||||
execute *app.deploy(target: endpoint)
|
||||
end
|
||||
end
|
||||
end
|
||||
run_hook "post-proxy-reboot", hosts: host_list
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "upgrade", "Upgrade to kamal-proxy on servers (stop container, remove container, start new container, reboot app)", hide: true
|
||||
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"
|
||||
def upgrade
|
||||
invoke_options = { "version" => KAMAL.config.latest_tag }.merge(options)
|
||||
|
||||
confirming "This will cause a brief outage on each host. Are you sure?" do
|
||||
host_groups = options[:rolling] ? KAMAL.hosts : [ KAMAL.hosts ]
|
||||
host_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
say "Upgrading proxy on #{host_list}...", :magenta
|
||||
run_hook "pre-proxy-reboot", hosts: host_list
|
||||
on(hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
"Stopping and removing Traefik on #{host}, if running..."
|
||||
execute *KAMAL.proxy.cleanup_traefik
|
||||
|
||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.remove_container
|
||||
execute *KAMAL.proxy.remove_image
|
||||
end
|
||||
|
||||
KAMAL.with_specific_hosts(hosts) do
|
||||
invoke "kamal:cli:proxy:boot", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::Proxy)
|
||||
invoke "kamal:cli:app:boot", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::App)
|
||||
invoke "kamal:cli:prune:all", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::Prune)
|
||||
end
|
||||
|
||||
run_hook "post-proxy-reboot", hosts: host_list
|
||||
say "Upgraded proxy on #{host_list}", :magenta
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "start", "Start existing proxy container on servers"
|
||||
def start
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Started proxy"), verbosity: :debug
|
||||
execute *KAMAL.proxy.start
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "stop", "Stop existing proxy container on servers"
|
||||
def stop
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Stopped proxy"), verbosity: :debug
|
||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "restart", "Restart existing proxy container on servers"
|
||||
def restart
|
||||
with_lock do
|
||||
stop
|
||||
start
|
||||
end
|
||||
end
|
||||
|
||||
desc "details", "Show details about proxy container from servers"
|
||||
def details
|
||||
on(KAMAL.proxy_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.proxy.info), type: "Proxy" }
|
||||
end
|
||||
|
||||
desc "logs", "Show log lines from proxy on servers"
|
||||
option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||
option :skip_timestamps, type: :boolean, aliases: "-T", desc: "Skip appending timestamps to logging output"
|
||||
def logs
|
||||
grep = options[:grep]
|
||||
timestamps = !options[:skip_timestamps]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{KAMAL.primary_host}..."
|
||||
info KAMAL.proxy.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, grep: grep)
|
||||
exec KAMAL.proxy.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, grep: grep)
|
||||
end
|
||||
else
|
||||
since = options[:since]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
puts_by_host host, capture(*KAMAL.proxy.logs(timestamps: timestamps, since: since, lines: lines, grep: grep)), type: "Proxy"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove", "Remove proxy container and image from servers"
|
||||
option :force, type: :boolean, default: false, desc: "Force removing proxy when apps are still installed"
|
||||
def remove
|
||||
with_lock do
|
||||
if removal_allowed?(options[:force])
|
||||
stop
|
||||
remove_container
|
||||
remove_image
|
||||
remove_proxy_directory
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_container", "Remove proxy container from servers", hide: true
|
||||
def remove_container
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed proxy container"), verbosity: :debug
|
||||
execute *KAMAL.proxy.remove_container
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_image", "Remove proxy image from servers", hide: true
|
||||
def remove_image
|
||||
with_lock do
|
||||
on(KAMAL.proxy_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed proxy image"), verbosity: :debug
|
||||
execute *KAMAL.proxy.remove_image
|
||||
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
|
||||
def removal_allowed?(force)
|
||||
on(KAMAL.proxy_hosts) do |host|
|
||||
app_count = capture_with_info(*KAMAL.server.app_directory_count).chomp.to_i
|
||||
raise "The are other applications installed on #{host}" if app_count > 0
|
||||
end
|
||||
|
||||
true
|
||||
rescue SSHKit::Runner::ExecuteError => e
|
||||
raise unless e.message.include?("The are other applications installed on")
|
||||
|
||||
if force
|
||||
say "Forcing, so removing the proxy, even though other apps are installed", :magenta
|
||||
else
|
||||
say "Not removing the proxy, as other apps are installed, ignore this check with kamal proxy remove --force", :magenta
|
||||
end
|
||||
|
||||
force
|
||||
end
|
||||
end
|
||||
@@ -28,6 +28,7 @@ class Kamal::Cli::Prune < Kamal::Cli::Base
|
||||
on(KAMAL.hosts) do
|
||||
execute *KAMAL.auditor.record("Pruned containers"), verbosity: :debug
|
||||
execute *KAMAL.prune.app_containers(retain: retain)
|
||||
execute *KAMAL.prune.healthcheck_containers
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,8 +3,6 @@ class Kamal::Cli::Registry < Kamal::Cli::Base
|
||||
option :skip_local, aliases: "-L", type: :boolean, default: false, desc: "Skip local login"
|
||||
option :skip_remote, aliases: "-R", type: :boolean, default: false, desc: "Skip remote login"
|
||||
def login
|
||||
ensure_docker_installed unless options[:skip_local]
|
||||
|
||||
run_locally { execute *KAMAL.registry.login } unless options[:skip_local]
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.login } unless options[:skip_remote]
|
||||
end
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
class Kamal::Cli::Secrets < Kamal::Cli::Base
|
||||
desc "fetch [SECRETS...]", "Fetch secrets from a vault"
|
||||
option :adapter, type: :string, aliases: "-a", required: true, desc: "Which vault adapter to use"
|
||||
option :account, type: :string, required: false, desc: "The account identifier or username"
|
||||
option :from, type: :string, required: false, desc: "A vault or folder to fetch the secrets from"
|
||||
option :inline, type: :boolean, required: false, hidden: true
|
||||
def fetch(*secrets)
|
||||
adapter = initialize_adapter(options[:adapter])
|
||||
|
||||
if adapter.requires_account? && options[:account].blank?
|
||||
return puts "No value provided for required options '--account'"
|
||||
end
|
||||
|
||||
results = adapter.fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
||||
|
||||
return_or_puts JSON.dump(results).shellescape, inline: options[:inline]
|
||||
end
|
||||
|
||||
desc "extract", "Extract a single secret from the results of a fetch call"
|
||||
option :inline, type: :boolean, required: false, hidden: true
|
||||
def extract(name, secrets)
|
||||
parsed_secrets = JSON.parse(secrets)
|
||||
value = parsed_secrets[name] || parsed_secrets.find { |k, v| k.end_with?("/#{name}") }&.last
|
||||
|
||||
raise "Could not find secret #{name}" if value.nil?
|
||||
|
||||
return_or_puts value, inline: options[:inline]
|
||||
end
|
||||
|
||||
desc "print", "Print the secrets (for debugging)"
|
||||
def print
|
||||
KAMAL.config.secrets.to_h.each do |key, value|
|
||||
puts "#{key}=#{value}"
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def initialize_adapter(adapter)
|
||||
Kamal::Secrets::Adapters.lookup(adapter)
|
||||
end
|
||||
|
||||
def return_or_puts(value, inline: nil)
|
||||
if inline
|
||||
value
|
||||
else
|
||||
puts value
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,8 +1,7 @@
|
||||
class Kamal::Cli::Server < Kamal::Cli::Base
|
||||
desc "exec", "Run a custom command on the server (use --help to show options)"
|
||||
option :interactive, type: :boolean, aliases: "-i", default: false, desc: "Run the command interactively (use for console/bash)"
|
||||
def exec(*cmd)
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
def exec(cmd)
|
||||
hosts = KAMAL.hosts | KAMAL.accessory_hosts
|
||||
|
||||
case
|
||||
@@ -36,6 +35,8 @@ class Kamal::Cli::Server < Kamal::Cli::Base
|
||||
missing << host
|
||||
end
|
||||
end
|
||||
|
||||
execute(*KAMAL.server.ensure_run_directory)
|
||||
end
|
||||
|
||||
if missing.any?
|
||||
|
||||
@@ -2,26 +2,11 @@
|
||||
service: my-app
|
||||
|
||||
# Name of the container image.
|
||||
image: my-user/my-app
|
||||
image: user/my-app
|
||||
|
||||
# Deploy to these servers.
|
||||
servers:
|
||||
web:
|
||||
- 192.168.0.1
|
||||
# job:
|
||||
# hosts:
|
||||
# - 192.168.0.1
|
||||
# cmd: bin/jobs
|
||||
|
||||
# Enable SSL auto certification via Let's Encrypt and allow for multiple apps on a single web server.
|
||||
# Remove this section when using multiple web servers and ensure you terminate SSL at your load balancer.
|
||||
#
|
||||
# Note: If using Cloudflare, set encryption mode in SSL/TLS setting to "Full" to enable CF-to-app encryption.
|
||||
proxy:
|
||||
ssl: true
|
||||
host: app.example.com
|
||||
# Proxy connects to your container on port 80 by default.
|
||||
# app_port: 3000
|
||||
- 192.168.0.1
|
||||
|
||||
# Credentials for your image host.
|
||||
registry:
|
||||
@@ -29,55 +14,33 @@ registry:
|
||||
# server: registry.digitalocean.com / ghcr.io / ...
|
||||
username: my-user
|
||||
|
||||
# Always use an access token rather than real password (pulled from .kamal/secrets).
|
||||
# Always use an access token rather than real password when possible.
|
||||
password:
|
||||
- KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
# Configure builder setup.
|
||||
builder:
|
||||
arch: amd64
|
||||
# Pass in additional build args needed for your Dockerfile.
|
||||
# args:
|
||||
# RUBY_VERSION: <%= ENV["RBENV_VERSION"] || ENV["rvm_ruby_string"] || "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}" %>
|
||||
|
||||
# Inject ENV variables into containers (secrets come from .kamal/secrets).
|
||||
#
|
||||
# Inject ENV variables into containers (secrets come from .env).
|
||||
# Remember to run `kamal env push` after making changes!
|
||||
# env:
|
||||
# clear:
|
||||
# DB_HOST: 192.168.0.2
|
||||
# secret:
|
||||
# - RAILS_MASTER_KEY
|
||||
|
||||
# Aliases are triggered with "bin/kamal <alias>". You can overwrite arguments on invocation:
|
||||
# "bin/kamal app logs -r job" will tail logs from the first server in the job section.
|
||||
#
|
||||
# aliases:
|
||||
# shell: app exec --interactive --reuse "bash"
|
||||
|
||||
# Use a different ssh user than root
|
||||
#
|
||||
# ssh:
|
||||
# user: app
|
||||
|
||||
# Use a persistent storage volume.
|
||||
#
|
||||
# volumes:
|
||||
# - "app_storage:/app/storage"
|
||||
# Configure builder setup.
|
||||
# builder:
|
||||
# args:
|
||||
# RUBY_VERSION: 3.2.0
|
||||
# secrets:
|
||||
# - GITHUB_TOKEN
|
||||
# remote:
|
||||
# arch: amd64
|
||||
# host: ssh://app@192.168.0.1
|
||||
|
||||
# Bridge fingerprinted assets, like JS and CSS, between versions to avoid
|
||||
# hitting 404 on in-flight requests. Combines all files from new and old
|
||||
# version inside the asset_path.
|
||||
#
|
||||
# asset_path: /app/public/assets
|
||||
|
||||
# Configure rolling deploys by setting a wait time between batches of restarts.
|
||||
#
|
||||
# boot:
|
||||
# limit: 10 # Can also specify as a percentage of total hosts, such as "25%"
|
||||
# wait: 2
|
||||
|
||||
# Use accessory services (secrets come from .kamal/secrets).
|
||||
#
|
||||
# Use accessory services (secrets come from .env).
|
||||
# accessories:
|
||||
# db:
|
||||
# image: mysql:8.0
|
||||
@@ -94,8 +57,45 @@ builder:
|
||||
# directories:
|
||||
# - data:/var/lib/mysql
|
||||
# redis:
|
||||
# image: valkey/valkey:8
|
||||
# image: redis:7.0
|
||||
# host: 192.168.0.2
|
||||
# port: 6379
|
||||
# directories:
|
||||
# - data:/data
|
||||
|
||||
# Configure custom arguments for Traefik. Be sure to reboot traefik when you modify it.
|
||||
# traefik:
|
||||
# args:
|
||||
# accesslog: true
|
||||
# accesslog.format: json
|
||||
|
||||
# Configure a custom healthcheck (default is /up on port 3000)
|
||||
# healthcheck:
|
||||
# path: /healthz
|
||||
# port: 4000
|
||||
|
||||
# Bridge fingerprinted assets, like JS and CSS, between versions to avoid
|
||||
# hitting 404 on in-flight requests. Combines all files from new and old
|
||||
# version inside the asset_path.
|
||||
#
|
||||
# If your app is using the Sprockets gem, ensure it sets `config.assets.manifest`.
|
||||
# See https://github.com/basecamp/kamal/issues/626 for details
|
||||
#
|
||||
# asset_path: /rails/public/assets
|
||||
|
||||
# Configure rolling deploys by setting a wait time between batches of restarts.
|
||||
# boot:
|
||||
# limit: 10 # Can also specify as a percentage of total hosts, such as "25%"
|
||||
# wait: 2
|
||||
|
||||
# Configure the role used to determine the primary_host. This host takes
|
||||
# deploy locks, runs health checks during the deploy, and follow logs, etc.
|
||||
#
|
||||
# Caution: there's no support for role renaming yet, so be careful to cleanup
|
||||
# the previous role on the deployed hosts.
|
||||
# primary_role: web
|
||||
|
||||
# Controls if we abort when see a role with no hosts. Disabling this may be
|
||||
# useful for more complex deploy configurations.
|
||||
#
|
||||
# allow_empty_roles: false
|
||||
|
||||
@@ -1,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 application’s containers
|
||||
|
||||
hosts = ENV["KAMAL_HOSTS"].split(",")
|
||||
|
||||
hosts.each do |ip|
|
||||
destination = "root@#{ip}"
|
||||
puts "Creating a Docker network \"kamal\" on #{destination}"
|
||||
`ssh #{destination} docker network create kamal`
|
||||
end
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Booted app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||
@@ -1,3 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Rebooted kamal-proxy on $KAMAL_HOSTS"
|
||||
3
lib/kamal/cli/templates/sample_hooks/post-traefik-reboot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/post-traefik-reboot.sample
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Rebooted Traefik on $KAMAL_HOSTS"
|
||||
@@ -1,3 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Booting app version $KAMAL_VERSION on $KAMAL_HOSTS..."
|
||||
@@ -1,3 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Rebooting kamal-proxy on $KAMAL_HOSTS..."
|
||||
3
lib/kamal/cli/templates/sample_hooks/pre-traefik-reboot.sample
Executable file
3
lib/kamal/cli/templates/sample_hooks/pre-traefik-reboot.sample
Executable file
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "Rebooting Traefik on $KAMAL_HOSTS..."
|
||||
@@ -1,17 +0,0 @@
|
||||
# Secrets defined here are available for reference under registry/password, env/secret, builder/secrets,
|
||||
# and accessories/*/env/secret in config/deploy.yml. All secrets should be pulled from either
|
||||
# password manager, ENV, or a file. DO NOT ENTER RAW CREDENTIALS HERE! This file needs to be safe for git.
|
||||
|
||||
# Option 1: Read secrets from the environment
|
||||
KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
# Option 2: Read secrets via a command
|
||||
# RAILS_MASTER_KEY=$(cat config/master.key)
|
||||
|
||||
# Option 3: Read secrets via kamal secrets helpers
|
||||
# These will handle logging in and fetching the secrets in as few calls as possible
|
||||
# There are adapters for 1Password, LastPass + Bitwarden
|
||||
#
|
||||
# SECRETS=$(kamal secrets fetch --adapter 1password --account my-account --from MyVault/MyItem KAMAL_REGISTRY_PASSWORD RAILS_MASTER_KEY)
|
||||
# KAMAL_REGISTRY_PASSWORD=$(kamal secrets extract KAMAL_REGISTRY_PASSWORD $SECRETS)
|
||||
# RAILS_MASTER_KEY=$(kamal secrets extract RAILS_MASTER_KEY $SECRETS)
|
||||
2
lib/kamal/cli/templates/template.env
Normal file
2
lib/kamal/cli/templates/template.env
Normal file
@@ -0,0 +1,2 @@
|
||||
KAMAL_REGISTRY_PASSWORD=change-this
|
||||
RAILS_MASTER_KEY=another-env
|
||||
162
lib/kamal/cli/traefik.rb
Normal file
162
lib/kamal/cli/traefik.rb
Normal file
@@ -0,0 +1,162 @@
|
||||
class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
desc "boot", "Boot Traefik on servers"
|
||||
def boot
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
execute *KAMAL.traefik.start_or_run
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "reboot", "Reboot Traefik on servers (stop container, remove container, start new container)"
|
||||
option :rolling, type: :boolean, default: false, desc: "Reboot traefik on hosts in sequence, rather than in parallel"
|
||||
option :confirmed, aliases: "-y", type: :boolean, default: false, desc: "Proceed without confirmation question"
|
||||
def reboot
|
||||
confirming "This will cause a brief outage on each host. Are you sure?" do
|
||||
with_lock do
|
||||
host_groups = options[:rolling] ? KAMAL.traefik_hosts : [ KAMAL.traefik_hosts ]
|
||||
host_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
run_hook "pre-traefik-reboot", hosts: host_list
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Rebooted traefik"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
execute *KAMAL.traefik.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.traefik.remove_container
|
||||
execute *KAMAL.traefik.run
|
||||
end
|
||||
run_hook "post-traefik-reboot", hosts: host_list
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "start", "Start existing Traefik container on servers"
|
||||
def start
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Started traefik"), verbosity: :debug
|
||||
execute *KAMAL.traefik.start
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "stop", "Stop existing Traefik container on servers"
|
||||
def stop
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Stopped traefik"), verbosity: :debug
|
||||
execute *KAMAL.traefik.stop, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "restart", "Restart existing Traefik container on servers"
|
||||
def restart
|
||||
with_lock do
|
||||
stop
|
||||
start
|
||||
end
|
||||
end
|
||||
|
||||
desc "details", "Show details about Traefik container from servers"
|
||||
def details
|
||||
on(KAMAL.traefik_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.traefik.info), type: "Traefik" }
|
||||
end
|
||||
|
||||
desc "logs", "Show log lines from Traefik on servers"
|
||||
option :since, aliases: "-s", desc: "Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)"
|
||||
option :lines, type: :numeric, aliases: "-n", desc: "Number of log lines to pull from each server"
|
||||
option :grep, aliases: "-g", desc: "Show lines with grep match only (use this to fetch specific requests by id)"
|
||||
option :grep_options, aliases: "-o", desc: "Additional options supplied to grep"
|
||||
option :follow, aliases: "-f", desc: "Follow logs on primary server (or specific host set by --hosts)"
|
||||
def logs
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{KAMAL.primary_host}..."
|
||||
info KAMAL.traefik.follow_logs(host: KAMAL.primary_host, grep: grep, grep_options: grep_options)
|
||||
exec KAMAL.traefik.follow_logs(host: KAMAL.primary_host, grep: grep, grep_options: grep_options)
|
||||
end
|
||||
else
|
||||
since = options[:since]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set
|
||||
|
||||
on(KAMAL.traefik_hosts) do |host|
|
||||
puts_by_host host, capture(*KAMAL.traefik.logs(since: since, lines: lines, grep: grep, grep_options: grep_options)), type: "Traefik"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove", "Remove Traefik container and image from servers"
|
||||
def remove
|
||||
with_lock do
|
||||
stop
|
||||
remove_container
|
||||
remove_image
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_container", "Remove Traefik container from servers", hide: true
|
||||
def remove_container
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed traefik container"), verbosity: :debug
|
||||
execute *KAMAL.traefik.remove_container
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_image", "Remove Traefik image from servers", hide: true
|
||||
def remove_image
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed traefik image"), verbosity: :debug
|
||||
execute *KAMAL.traefik.remove_image
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "downgrade", "Downgrade to Traefik on servers (stop container, remove container, start new container, reboot app)"
|
||||
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"
|
||||
def downgrade
|
||||
invoke_options = { "version" => KAMAL.config.latest_tag }.merge(options)
|
||||
|
||||
confirming "This will cause a brief outage on each host. Are you sure?" do
|
||||
host_groups = options[:rolling] ? KAMAL.hosts : [ KAMAL.hosts ]
|
||||
host_groups.each do |hosts|
|
||||
host_list = Array(hosts).join(",")
|
||||
say "Downgrading to Traefik on #{host_list}...", :magenta
|
||||
run_hook "pre-traefik-reboot", hosts: host_list
|
||||
on(hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Rebooted Traefik"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||
execute *KAMAL.traefik.cleanup_kamal_proxy
|
||||
|
||||
"Stopping and removing Traefik on #{host}, if running..."
|
||||
execute *KAMAL.traefik.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.traefik.remove_container
|
||||
execute *KAMAL.traefik.remove_image
|
||||
end
|
||||
|
||||
KAMAL.with_specific_hosts(hosts) do
|
||||
invoke "kamal:cli:traefik:boot", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::Traefik)
|
||||
invoke "kamal:cli:app:boot", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::App)
|
||||
invoke "kamal:cli:prune:all", [], invoke_options
|
||||
reset_invocation(Kamal::Cli::Prune)
|
||||
end
|
||||
|
||||
run_hook "post-traefik-reboot", hosts: host_list
|
||||
say "Downgraded to Traefik on #{host_list}", :magenta
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,23 +1,15 @@
|
||||
require "active_support/core_ext/enumerable"
|
||||
require "active_support/core_ext/module/delegation"
|
||||
require "active_support/core_ext/object/blank"
|
||||
|
||||
class Kamal::Commander
|
||||
attr_accessor :verbosity, :holding_lock, :connected
|
||||
attr_reader :specific_roles, :specific_hosts
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :proxy_hosts, :accessory_hosts, to: :specifics
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :traefik_hosts, :accessory_hosts, to: :specifics
|
||||
|
||||
def initialize
|
||||
reset
|
||||
end
|
||||
|
||||
def reset
|
||||
self.verbosity = :info
|
||||
self.holding_lock = false
|
||||
self.connected = false
|
||||
@specifics = @specific_roles = @specific_hosts = nil
|
||||
@config = @config_kwargs = nil
|
||||
@commands = {}
|
||||
@specifics = nil
|
||||
end
|
||||
|
||||
def config
|
||||
@@ -31,17 +23,11 @@ class Kamal::Commander
|
||||
@config, @config_kwargs = nil, kwargs
|
||||
end
|
||||
|
||||
def configured?
|
||||
@config || @config_kwargs
|
||||
end
|
||||
attr_reader :specific_roles, :specific_hosts
|
||||
|
||||
def specific_primary!
|
||||
@specifics = nil
|
||||
if specific_roles.present?
|
||||
self.specific_hosts = [ specific_roles.first.primary_host ]
|
||||
else
|
||||
self.specific_hosts = [ config.primary_host ]
|
||||
end
|
||||
self.specific_hosts = [ config.primary_host ]
|
||||
end
|
||||
|
||||
def specific_roles=(role_names)
|
||||
@@ -81,6 +67,11 @@ class Kamal::Commander
|
||||
config.accessories&.collect(&:name) || []
|
||||
end
|
||||
|
||||
def accessories_on(host)
|
||||
config.accessories.select { |accessory| accessory.hosts.include?(host.to_s) }.map(&:name)
|
||||
end
|
||||
|
||||
|
||||
def app(role: nil, host: nil)
|
||||
Kamal::Commands::App.new(config, role: role, host: host)
|
||||
end
|
||||
@@ -94,41 +85,42 @@ class Kamal::Commander
|
||||
end
|
||||
|
||||
def builder
|
||||
@commands[:builder] ||= Kamal::Commands::Builder.new(config)
|
||||
@builder ||= Kamal::Commands::Builder.new(config)
|
||||
end
|
||||
|
||||
def docker
|
||||
@commands[:docker] ||= Kamal::Commands::Docker.new(config)
|
||||
@docker ||= Kamal::Commands::Docker.new(config)
|
||||
end
|
||||
|
||||
def healthcheck
|
||||
@healthcheck ||= Kamal::Commands::Healthcheck.new(config)
|
||||
end
|
||||
|
||||
def hook
|
||||
@commands[:hook] ||= Kamal::Commands::Hook.new(config)
|
||||
@hook ||= Kamal::Commands::Hook.new(config)
|
||||
end
|
||||
|
||||
def lock
|
||||
@commands[:lock] ||= Kamal::Commands::Lock.new(config)
|
||||
end
|
||||
|
||||
def proxy
|
||||
@commands[:proxy] ||= Kamal::Commands::Proxy.new(config)
|
||||
@lock ||= Kamal::Commands::Lock.new(config)
|
||||
end
|
||||
|
||||
def prune
|
||||
@commands[:prune] ||= Kamal::Commands::Prune.new(config)
|
||||
@prune ||= Kamal::Commands::Prune.new(config)
|
||||
end
|
||||
|
||||
def registry
|
||||
@commands[:registry] ||= Kamal::Commands::Registry.new(config)
|
||||
@registry ||= Kamal::Commands::Registry.new(config)
|
||||
end
|
||||
|
||||
def server
|
||||
@commands[:server] ||= Kamal::Commands::Server.new(config)
|
||||
@server ||= Kamal::Commands::Server.new(config)
|
||||
end
|
||||
|
||||
def alias(name)
|
||||
config.aliases[name]
|
||||
def traefik
|
||||
@traefik ||= Kamal::Commands::Traefik.new(config)
|
||||
end
|
||||
|
||||
|
||||
def with_verbosity(level)
|
||||
old_level = self.verbosity
|
||||
|
||||
@@ -141,6 +133,14 @@ class Kamal::Commander
|
||||
SSHKit.config.output_verbosity = old_level
|
||||
end
|
||||
|
||||
def boot_strategy
|
||||
if config.boot.limit.present?
|
||||
{ in: :groups, limit: config.boot.limit, wait: config.boot.wait }
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
def holding_lock?
|
||||
self.holding_lock
|
||||
end
|
||||
|
||||
@@ -18,8 +18,8 @@ class Kamal::Commander::Specifics
|
||||
roles.select { |role| role.hosts.include?(host.to_s) }
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
config.proxy_hosts & specified_hosts
|
||||
def traefik_hosts
|
||||
config.traefik_hosts & specified_hosts
|
||||
end
|
||||
|
||||
def accessory_hosts
|
||||
@@ -43,12 +43,7 @@ class Kamal::Commander::Specifics
|
||||
end
|
||||
|
||||
def specified_hosts
|
||||
specified_hosts = specific_hosts || config.all_hosts
|
||||
|
||||
if (specific_role_hosts = specific_roles&.flat_map(&:hosts)).present?
|
||||
specified_hosts.select { |host| specific_role_hosts.include?(host) }
|
||||
else
|
||||
specified_hosts
|
||||
end
|
||||
(specific_hosts || config.all_hosts) \
|
||||
.select { |host| (specific_roles || config.roles).flat_map(&:hosts).include?(host) }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,12 +1,7 @@
|
||||
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
include Proxy
|
||||
|
||||
attr_reader :accessory_config
|
||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||
:network_args, :publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||
:secrets_io, :secrets_path, :env_directory, :proxy, :running_proxy?, :registry,
|
||||
to: :accessory_config
|
||||
delegate :proxy_container_name, to: :config
|
||||
:publish_args, :env_args, :volume_args, :label_args, :option_args, to: :accessory_config
|
||||
|
||||
def initialize(config, name:)
|
||||
super(config)
|
||||
@@ -18,7 +13,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
"--name", service_name,
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
*network_args,
|
||||
*config.logging_args,
|
||||
*publish_args,
|
||||
*env_args,
|
||||
@@ -41,19 +35,21 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :ps, *service_filter
|
||||
end
|
||||
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||
docker(:logs, service_name, (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(timestamps: true, grep: nil, grep_options: nil)
|
||||
def follow_logs(grep: nil, grep_options: nil)
|
||||
run_over_ssh \
|
||||
pipe \
|
||||
docker(:logs, service_name, ("--timestamps" if timestamps), "--tail", "10", "--follow", "2>&1"),
|
||||
docker(:logs, service_name, "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
end
|
||||
|
||||
|
||||
def execute_in_existing_container(*command, interactive: false)
|
||||
docker :exec,
|
||||
("-it" if interactive),
|
||||
@@ -65,7 +61,6 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :run,
|
||||
("-it" if interactive),
|
||||
"--rm",
|
||||
*network_args,
|
||||
*env_args,
|
||||
*volume_args,
|
||||
image,
|
||||
@@ -84,6 +79,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
super command, host: hosts.first
|
||||
end
|
||||
|
||||
|
||||
def ensure_local_file_present(local_file)
|
||||
if !local_file.is_a?(StringIO) && !Pathname.new(local_file).exist?
|
||||
raise "Missing file: #{local_file}"
|
||||
@@ -102,8 +98,12 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :image, :rm, "--force", image
|
||||
end
|
||||
|
||||
def ensure_env_directory
|
||||
make_directory env_directory
|
||||
def make_env_directory
|
||||
make_directory accessory_config.env.secrets_directory
|
||||
end
|
||||
|
||||
def remove_env_file
|
||||
[ :rm, "-f", accessory_config.env.secrets_file ]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
module Kamal::Commands::Accessory::Proxy
|
||||
delegate :proxy_container_name, to: :config
|
||||
|
||||
def deploy(target:)
|
||||
proxy_exec :deploy, service_name, *proxy.deploy_command_args(target: target)
|
||||
end
|
||||
|
||||
def remove
|
||||
proxy_exec :remove, service_name
|
||||
end
|
||||
|
||||
private
|
||||
def proxy_exec(*command)
|
||||
docker :exec, proxy_container_name, "kamal-proxy", *command
|
||||
end
|
||||
end
|
||||
@@ -1,12 +1,10 @@
|
||||
class Kamal::Commands::App < Kamal::Commands::Base
|
||||
include Assets, Containers, Execution, Images, Logging, Proxy
|
||||
include Assets, Containers, Cord, Execution, Images, Logging
|
||||
|
||||
ACTIVE_DOCKER_STATUSES = [ :running, :restarting ]
|
||||
|
||||
attr_reader :role, :host
|
||||
|
||||
delegate :container_name, to: :role
|
||||
|
||||
def initialize(config, role: nil, host: nil)
|
||||
super(config)
|
||||
@role = role
|
||||
@@ -18,11 +16,11 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
"--detach",
|
||||
"--restart unless-stopped",
|
||||
"--name", container_name,
|
||||
"--network", "kamal",
|
||||
*([ "--hostname", hostname ] if hostname),
|
||||
"-e", "KAMAL_CONTAINER_NAME=\"#{container_name}\"",
|
||||
"-e", "KAMAL_VERSION=\"#{config.version}\"",
|
||||
*role.env_args(host),
|
||||
*role.health_check_args,
|
||||
*role.logging_args,
|
||||
*config.volume_args,
|
||||
*role.asset_volume_args,
|
||||
@@ -43,11 +41,11 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
def stop(version: nil)
|
||||
pipe \
|
||||
version ? container_id_for_version(version) : current_running_container_id,
|
||||
xargs(docker(:stop, *role.stop_args))
|
||||
xargs(config.stop_wait_time ? docker(:stop, "-t", config.stop_wait_time) : docker(:stop))
|
||||
end
|
||||
|
||||
def info
|
||||
docker :ps, *container_filter_args
|
||||
docker :ps, *filter_args
|
||||
end
|
||||
|
||||
|
||||
@@ -67,15 +65,25 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
|
||||
def list_versions(*docker_args, statuses: nil)
|
||||
pipe \
|
||||
docker(:ps, *container_filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
||||
docker(:ps, *filter_args(statuses: statuses), *docker_args, "--format", '"{{.Names}}"'),
|
||||
extract_version_from_name
|
||||
end
|
||||
|
||||
def ensure_env_directory
|
||||
make_directory role.env_directory
|
||||
|
||||
def make_env_directory
|
||||
make_directory role.env(host).secrets_directory
|
||||
end
|
||||
|
||||
def remove_env_file
|
||||
[ :rm, "-f", role.env(host).secrets_file ]
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
def container_name(version = nil)
|
||||
[ role.container_prefix, version || config.version ].compact.join("-")
|
||||
end
|
||||
|
||||
def latest_image_id
|
||||
docker :image, :ls, *argumentize("--filter", "reference=#{config.latest_image}"), "--format", "'{{.ID}}'"
|
||||
end
|
||||
@@ -91,15 +99,11 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def latest_container(format:, filters: nil)
|
||||
docker :ps, "--latest", *format, *container_filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
||||
docker :ps, "--latest", *format, *filter_args(statuses: ACTIVE_DOCKER_STATUSES), argumentize("--filter", filters)
|
||||
end
|
||||
|
||||
def container_filter_args(statuses: nil)
|
||||
argumentize "--filter", container_filters(statuses: statuses)
|
||||
end
|
||||
|
||||
def image_filter_args
|
||||
argumentize "--filter", image_filters
|
||||
def filter_args(statuses: nil)
|
||||
argumentize "--filter", filters(statuses: statuses)
|
||||
end
|
||||
|
||||
def extract_version_from_name
|
||||
@@ -107,17 +111,13 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
%(while read line; do echo ${line##{role.container_prefix}-}; done)
|
||||
end
|
||||
|
||||
def container_filters(statuses: nil)
|
||||
def filters(statuses: nil)
|
||||
[ "label=service=#{config.service}" ].tap do |filters|
|
||||
filters << "label=destination=#{config.destination}"
|
||||
filters << "label=destination=#{config.destination}" if config.destination
|
||||
filters << "label=role=#{role}" if role
|
||||
statuses&.each do |status|
|
||||
filters << "status=#{status}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def image_filters
|
||||
[ "label=service=#{config.service}" ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,18 +3,18 @@ module Kamal::Commands::App::Assets
|
||||
asset_container = "#{role.container_prefix}-assets"
|
||||
|
||||
combine \
|
||||
make_directory(role.asset_extracted_directory),
|
||||
[ *docker(:container, :rm, asset_container, "2> /dev/null"), "|| true" ],
|
||||
docker(:container, :create, "--name", asset_container, config.absolute_image),
|
||||
docker(:container, :cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_directory),
|
||||
docker(:container, :rm, asset_container),
|
||||
make_directory(role.asset_extracted_path),
|
||||
[ *docker(:stop, "-t 1", asset_container, "2> /dev/null"), "|| true" ],
|
||||
docker(:run, "--name", asset_container, "--detach", "--rm", config.absolute_image, "sleep 1000000"),
|
||||
docker(:cp, "-L", "#{asset_container}:#{role.asset_path}/.", role.asset_extracted_path),
|
||||
docker(:stop, "-t 1", asset_container),
|
||||
by: "&&"
|
||||
end
|
||||
|
||||
def sync_asset_volumes(old_version: nil)
|
||||
new_extracted_path, new_volume_path = role.asset_extracted_directory(config.version), role.asset_volume.host_path
|
||||
new_extracted_path, new_volume_path = role.asset_extracted_path(config.version), role.asset_volume.host_path
|
||||
if old_version.present?
|
||||
old_extracted_path, old_volume_path = role.asset_extracted_directory(old_version), role.asset_volume(old_version).host_path
|
||||
old_extracted_path, old_volume_path = role.asset_extracted_path(old_version), role.asset_volume(old_version).host_path
|
||||
end
|
||||
|
||||
commands = [ make_directory(new_volume_path), copy_contents(new_extracted_path, new_volume_path) ]
|
||||
@@ -29,8 +29,8 @@ module Kamal::Commands::App::Assets
|
||||
|
||||
def clean_up_assets
|
||||
chain \
|
||||
find_and_remove_older_siblings(role.asset_extracted_directory),
|
||||
find_and_remove_older_siblings(role.asset_volume_directory)
|
||||
find_and_remove_older_siblings(role.asset_extracted_path),
|
||||
find_and_remove_older_siblings(role.asset_volume_path)
|
||||
end
|
||||
|
||||
private
|
||||
@@ -39,7 +39,7 @@ module Kamal::Commands::App::Assets
|
||||
:find,
|
||||
Pathname.new(path).dirname.to_s,
|
||||
"-maxdepth 1",
|
||||
"-name", "'#{role.name}-*'",
|
||||
"-name", "'#{role.container_prefix}-*'",
|
||||
"!", "-name", Pathname.new(path).basename.to_s,
|
||||
"-exec rm -rf \"{}\" +"
|
||||
]
|
||||
|
||||
@@ -2,7 +2,7 @@ module Kamal::Commands::App::Containers
|
||||
DOCKER_HEALTH_LOG_FORMAT = "'{{json .State.Health}}'"
|
||||
|
||||
def list_containers
|
||||
docker :container, :ls, "--all", *container_filter_args
|
||||
docker :container, :ls, "--all", *filter_args
|
||||
end
|
||||
|
||||
def list_container_names
|
||||
@@ -20,7 +20,7 @@ module Kamal::Commands::App::Containers
|
||||
end
|
||||
|
||||
def remove_containers
|
||||
docker :container, :prune, "--force", *container_filter_args
|
||||
docker :container, :prune, "--force", *filter_args
|
||||
end
|
||||
|
||||
def container_health_log(version:)
|
||||
|
||||
22
lib/kamal/commands/app/cord.rb
Normal file
22
lib/kamal/commands/app/cord.rb
Normal file
@@ -0,0 +1,22 @@
|
||||
module Kamal::Commands::App::Cord
|
||||
def cord(version:)
|
||||
pipe \
|
||||
docker(:inspect, "-f '{{ range .Mounts }}{{printf \"%s %s\\n\" .Source .Destination}}{{ end }}'", container_name(version)),
|
||||
[ :awk, "'$2 == \"#{role.cord_volume.container_path}\" {print $1}'" ]
|
||||
end
|
||||
|
||||
def tie_cord(cord)
|
||||
create_empty_file(cord)
|
||||
end
|
||||
|
||||
def cut_cord(cord)
|
||||
remove_directory(cord)
|
||||
end
|
||||
|
||||
private
|
||||
def create_empty_file(file)
|
||||
chain \
|
||||
make_directory_for(file),
|
||||
[ :touch, file ]
|
||||
end
|
||||
end
|
||||
@@ -7,15 +7,12 @@ module Kamal::Commands::App::Execution
|
||||
*command
|
||||
end
|
||||
|
||||
def execute_in_new_container(*command, interactive: false, detach: false, env:)
|
||||
def execute_in_new_container(*command, interactive: false, env:)
|
||||
docker :run,
|
||||
("-it" if interactive),
|
||||
("--detach" if detach),
|
||||
("--rm" unless detach),
|
||||
"--network", "kamal",
|
||||
"--rm",
|
||||
*role&.env_args(host),
|
||||
*argumentize("--env", env),
|
||||
*role.logging_args,
|
||||
*config.volume_args,
|
||||
*role&.option_args,
|
||||
config.absolute_image,
|
||||
|
||||
@@ -4,7 +4,7 @@ module Kamal::Commands::App::Images
|
||||
end
|
||||
|
||||
def remove_images
|
||||
docker :image, :prune, "--all", "--force", *image_filter_args
|
||||
docker :image, :prune, "--all", "--force", *filter_args
|
||||
end
|
||||
|
||||
def tag_latest_image
|
||||
|
||||
@@ -1,28 +1,18 @@
|
||||
module Kamal::Commands::App::Logging
|
||||
def logs(container_id: nil, timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
def logs(version: nil, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
container_id_command(container_id),
|
||||
"xargs docker logs#{" --timestamps" if timestamps}#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
|
||||
version ? container_id_for_version(version) : current_running_container_id,
|
||||
"xargs docker logs#{" --since #{since}" if since}#{" --tail #{lines}" if lines} 2>&1",
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, container_id: nil, timestamps: true, lines: nil, grep: nil, grep_options: nil)
|
||||
def follow_logs(host:, lines: nil, grep: nil, grep_options: nil)
|
||||
run_over_ssh \
|
||||
pipe(
|
||||
container_id_command(container_id),
|
||||
"xargs docker logs#{" --timestamps" if timestamps}#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||
current_running_container_id,
|
||||
"xargs docker logs --timestamps#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
),
|
||||
host: host
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def container_id_command(container_id)
|
||||
case container_id
|
||||
when Array then container_id
|
||||
when String, Symbol then "echo #{container_id}"
|
||||
else current_running_container_id
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
module Kamal::Commands::App::Proxy
|
||||
delegate :proxy_container_name, to: :config
|
||||
|
||||
def deploy(target:)
|
||||
proxy_exec :deploy, role.container_prefix, *role.proxy.deploy_command_args(target: target)
|
||||
end
|
||||
|
||||
def remove
|
||||
proxy_exec :remove, role.container_prefix
|
||||
end
|
||||
|
||||
private
|
||||
def proxy_exec(*command)
|
||||
docker :exec, proxy_container_name, "kamal-proxy", *command
|
||||
end
|
||||
end
|
||||
@@ -8,12 +8,9 @@ class Kamal::Commands::Auditor < Kamal::Commands::Base
|
||||
|
||||
# Runs remotely
|
||||
def record(line, **details)
|
||||
combine \
|
||||
[ :mkdir, "-p", config.run_directory ],
|
||||
append(
|
||||
[ :echo, audit_tags(**details).except(:version, :service_version, :service).to_s, line ],
|
||||
audit_log_file
|
||||
)
|
||||
append \
|
||||
[ :echo, audit_tags(**details).except(:version, :service_version, :service).to_s, line ],
|
||||
audit_log_file
|
||||
end
|
||||
|
||||
def reveal
|
||||
|
||||
@@ -11,7 +11,14 @@ module Kamal::Commands
|
||||
end
|
||||
|
||||
def run_over_ssh(*command, host:)
|
||||
"ssh#{ssh_proxy_args}#{ssh_keys_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
|
||||
|
||||
def container_id_for(container_name:, only_running: false)
|
||||
@@ -30,16 +37,6 @@ module Kamal::Commands
|
||||
[ :rm, "-r", path ]
|
||||
end
|
||||
|
||||
def remove_file(path)
|
||||
[ :rm, path ]
|
||||
end
|
||||
|
||||
def ensure_docker_installed
|
||||
combine \
|
||||
ensure_local_docker_installed,
|
||||
ensure_local_buildx_installed
|
||||
end
|
||||
|
||||
private
|
||||
def combine(*commands, by: "&&")
|
||||
commands
|
||||
@@ -84,39 +81,8 @@ module Kamal::Commands
|
||||
[ :git, *([ "-C", path ] if path), *args.compact ]
|
||||
end
|
||||
|
||||
def grep(*args)
|
||||
args.compact.unshift :grep
|
||||
end
|
||||
|
||||
def tags(**details)
|
||||
Kamal::Tags.from_config(config, **details)
|
||||
end
|
||||
|
||||
def ssh_proxy_args
|
||||
case config.ssh.proxy
|
||||
when Net::SSH::Proxy::Jump
|
||||
" -J #{config.ssh.proxy.jump_proxies}"
|
||||
when Net::SSH::Proxy::Command
|
||||
" -o ProxyCommand='#{config.ssh.proxy.command_line_template}'"
|
||||
end
|
||||
end
|
||||
|
||||
def ssh_keys_args
|
||||
"#{ ssh_keys.join("") if ssh_keys}" + "#{" -o IdentitiesOnly=yes" if config.ssh&.keys_only}"
|
||||
end
|
||||
|
||||
def ssh_keys
|
||||
config.ssh.keys&.map do |key|
|
||||
" -i #{key}"
|
||||
end
|
||||
end
|
||||
|
||||
def ensure_local_docker_installed
|
||||
docker "--version"
|
||||
end
|
||||
|
||||
def ensure_local_buildx_installed
|
||||
docker :buildx, "version"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
require "active_support/core_ext/string/filters"
|
||||
|
||||
class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
delegate :create, :remove, :dev, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
||||
delegate :local?, :remote?, :cloud?, to: "config.builder"
|
||||
delegate :create, :remove, :push, :clean, :pull, :info, :context_hosts, :config_context_hosts, :validate_image,
|
||||
:first_mirror, to: :target
|
||||
|
||||
include Clone
|
||||
|
||||
@@ -11,32 +11,62 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def target
|
||||
if remote?
|
||||
if local?
|
||||
hybrid
|
||||
if config.builder.multiarch?
|
||||
if config.builder.remote?
|
||||
if config.builder.local?
|
||||
multiarch_remote
|
||||
else
|
||||
native_remote
|
||||
end
|
||||
else
|
||||
remote
|
||||
multiarch
|
||||
end
|
||||
elsif cloud?
|
||||
cloud
|
||||
else
|
||||
local
|
||||
if config.builder.cached?
|
||||
native_cached
|
||||
else
|
||||
native
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def remote
|
||||
@remote ||= Kamal::Commands::Builder::Remote.new(config)
|
||||
def native
|
||||
@native ||= Kamal::Commands::Builder::Native.new(config)
|
||||
end
|
||||
|
||||
def local
|
||||
@local ||= Kamal::Commands::Builder::Local.new(config)
|
||||
def native_cached
|
||||
@native ||= Kamal::Commands::Builder::Native::Cached.new(config)
|
||||
end
|
||||
|
||||
def hybrid
|
||||
@hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
|
||||
def native_remote
|
||||
@native ||= Kamal::Commands::Builder::Native::Remote.new(config)
|
||||
end
|
||||
|
||||
def cloud
|
||||
@cloud ||= Kamal::Commands::Builder::Cloud.new(config)
|
||||
def multiarch
|
||||
@multiarch ||= Kamal::Commands::Builder::Multiarch.new(config)
|
||||
end
|
||||
|
||||
def multiarch_remote
|
||||
@multiarch_remote ||= Kamal::Commands::Builder::Multiarch::Remote.new(config)
|
||||
end
|
||||
|
||||
|
||||
def ensure_local_dependencies_installed
|
||||
if name.native?
|
||||
ensure_local_docker_installed
|
||||
else
|
||||
combine \
|
||||
ensure_local_docker_installed,
|
||||
ensure_local_buildx_installed
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def ensure_local_docker_installed
|
||||
docker "--version"
|
||||
end
|
||||
|
||||
def ensure_local_buildx_installed
|
||||
docker :buildx, "version"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,44 +1,22 @@
|
||||
|
||||
class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
class BuilderError < StandardError; end
|
||||
|
||||
ENDPOINT_DOCKER_HOST_INSPECT = "'{{.Endpoints.docker.Host}}'"
|
||||
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
delegate \
|
||||
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
||||
:cache_from, :cache_to, :ssh, :provenance, :sbom, :driver, :docker_driver?,
|
||||
to: :builder_config
|
||||
delegate :args, :secrets, :dockerfile, :target, :local_arch, :local_host, :remote_arch, :remote_host, :cache_from, :cache_to, :ssh, to: :builder_config
|
||||
|
||||
def clean
|
||||
docker :image, :rm, "--force", config.absolute_image
|
||||
end
|
||||
|
||||
def push(export_action = "registry", tag_as_dirty: false)
|
||||
docker :buildx, :build,
|
||||
"--output=type=#{export_action}",
|
||||
*platform_options(arches),
|
||||
*([ "--builder", builder_name ] unless docker_driver?),
|
||||
*build_tag_options(tag_as_dirty: tag_as_dirty),
|
||||
*build_options,
|
||||
build_context
|
||||
end
|
||||
|
||||
def pull
|
||||
docker :pull, config.absolute_image
|
||||
end
|
||||
|
||||
def info
|
||||
combine \
|
||||
docker(:context, :ls),
|
||||
docker(:buildx, :ls)
|
||||
end
|
||||
|
||||
def inspect_builder
|
||||
docker :buildx, :inspect, builder_name unless docker_driver?
|
||||
end
|
||||
|
||||
def build_options
|
||||
[ *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh, *builder_provenance, *builder_sbom ]
|
||||
[ *build_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
|
||||
end
|
||||
|
||||
def build_context
|
||||
@@ -54,19 +32,21 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
)
|
||||
end
|
||||
|
||||
def context_hosts
|
||||
:true
|
||||
end
|
||||
|
||||
def config_context_hosts
|
||||
[]
|
||||
end
|
||||
|
||||
def first_mirror
|
||||
docker(:info, "--format '{{index .RegistryConfig.Mirrors 0}}'")
|
||||
end
|
||||
|
||||
private
|
||||
def build_tag_names(tag_as_dirty: false)
|
||||
tag_names = [ config.absolute_image, config.latest_image ]
|
||||
tag_names.map! { |t| "#{t}-dirty" } if tag_as_dirty
|
||||
tag_names
|
||||
end
|
||||
|
||||
def build_tag_options(tag_as_dirty: false)
|
||||
build_tag_names(tag_as_dirty: tag_as_dirty).flat_map { |name| [ "-t", name ] }
|
||||
def build_tags
|
||||
[ "-t", config.absolute_image, "-t", config.latest_image ]
|
||||
end
|
||||
|
||||
def build_cache
|
||||
@@ -85,7 +65,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def build_secrets
|
||||
argumentize "--secret", secrets.keys.collect { |secret| [ "id", secret ] }
|
||||
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
||||
end
|
||||
|
||||
def build_dockerfile
|
||||
@@ -104,19 +84,11 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
argumentize "--ssh", ssh if ssh.present?
|
||||
end
|
||||
|
||||
def builder_provenance
|
||||
argumentize "--provenance", provenance unless provenance.nil?
|
||||
end
|
||||
|
||||
def builder_sbom
|
||||
argumentize "--sbom", sbom unless sbom.nil?
|
||||
end
|
||||
|
||||
def builder_config
|
||||
config.builder
|
||||
end
|
||||
|
||||
def platform_options(arches)
|
||||
argumentize "--platform", arches.map { |arch| "linux/#{arch}" }.join(",") if arches.any?
|
||||
def context_host(builder_name)
|
||||
docker :context, :inspect, builder_name, "--format", ENDPOINT_DOCKER_HOST_INSPECT
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,31 +1,29 @@
|
||||
module Kamal::Commands::Builder::Clone
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
included do
|
||||
delegate :clone_directory, :build_directory, to: :"config.builder"
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def clone_reset_steps
|
||||
[
|
||||
git(:remote, "set-url", :origin, escaped_root, path: escaped_build_directory),
|
||||
git(:fetch, :origin, path: escaped_build_directory),
|
||||
git(:reset, "--hard", Kamal::Git.revision, path: escaped_build_directory),
|
||||
git(:clean, "-fdx", path: escaped_build_directory),
|
||||
git(:submodule, :update, "--init", path: escaped_build_directory)
|
||||
git(:remote, "set-url", :origin, Kamal::Git.root, path: build_directory),
|
||||
git(:fetch, :origin, path: build_directory),
|
||||
git(:reset, "--hard", Kamal::Git.revision, path: build_directory),
|
||||
git(:clean, "-fdx", path: build_directory),
|
||||
git(:submodule, :update, "--init", path: build_directory)
|
||||
]
|
||||
end
|
||||
|
||||
def clone_status
|
||||
git :status, "--porcelain", path: escaped_build_directory
|
||||
git :status, "--porcelain", path: build_directory
|
||||
end
|
||||
|
||||
def clone_revision
|
||||
git :"rev-parse", :HEAD, path: escaped_build_directory
|
||||
end
|
||||
|
||||
def escaped_root
|
||||
Kamal::Git.root.shellescape
|
||||
end
|
||||
|
||||
def escaped_build_directory
|
||||
config.builder.build_directory.shellescape
|
||||
git :"rev-parse", :HEAD, path: build_directory
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
class Kamal::Commands::Builder::Cloud < Kamal::Commands::Builder::Base
|
||||
# Expects `driver` to be of format "cloud docker-org-name/builder-name"
|
||||
|
||||
def create
|
||||
docker :buildx, :create, "--driver", driver
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
driver.gsub(/[ \/]/, "-")
|
||||
end
|
||||
|
||||
def inspect_buildx
|
||||
pipe \
|
||||
docker(:buildx, :inspect, builder_name),
|
||||
grep("-q", "Endpoint:.*cloud://.*")
|
||||
end
|
||||
end
|
||||
@@ -1,21 +0,0 @@
|
||||
class Kamal::Commands::Builder::Hybrid < Kamal::Commands::Builder::Remote
|
||||
def create
|
||||
combine \
|
||||
create_local_buildx,
|
||||
create_remote_context,
|
||||
append_remote_buildx
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-hybrid-#{driver}-#{remote.gsub(/[^a-z0-9_-]/, "-")}"
|
||||
end
|
||||
|
||||
def create_local_buildx
|
||||
docker :buildx, :create, *platform_options(local_arches), "--name", builder_name, "--driver=#{driver}"
|
||||
end
|
||||
|
||||
def append_remote_buildx
|
||||
docker :buildx, :create, *platform_options(remote_arches), "--append", "--name", builder_name, remote_context_name
|
||||
end
|
||||
end
|
||||
@@ -1,14 +0,0 @@
|
||||
class Kamal::Commands::Builder::Local < Kamal::Commands::Builder::Base
|
||||
def create
|
||||
docker :buildx, :create, "--name", builder_name, "--driver=#{driver}" unless docker_driver?
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name unless docker_driver?
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-local-#{driver}"
|
||||
end
|
||||
end
|
||||
41
lib/kamal/commands/builder/multiarch.rb
Normal file
41
lib/kamal/commands/builder/multiarch.rb
Normal file
@@ -0,0 +1,41 @@
|
||||
class Kamal::Commands::Builder::Multiarch < Kamal::Commands::Builder::Base
|
||||
def create
|
||||
docker :buildx, :create, "--use", "--name", builder_name
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
|
||||
def info
|
||||
combine \
|
||||
docker(:context, :ls),
|
||||
docker(:buildx, :ls)
|
||||
end
|
||||
|
||||
def push
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
"--platform", platform_names,
|
||||
"--builder", builder_name,
|
||||
*build_options,
|
||||
build_context
|
||||
end
|
||||
|
||||
def context_hosts
|
||||
docker :buildx, :inspect, builder_name, "> /dev/null"
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-#{config.service}-multiarch"
|
||||
end
|
||||
|
||||
def platform_names
|
||||
if local_arch
|
||||
"linux/#{local_arch}"
|
||||
else
|
||||
"linux/amd64,linux/arm64"
|
||||
end
|
||||
end
|
||||
end
|
||||
65
lib/kamal/commands/builder/multiarch/remote.rb
Normal file
65
lib/kamal/commands/builder/multiarch/remote.rb
Normal file
@@ -0,0 +1,65 @@
|
||||
class Kamal::Commands::Builder::Multiarch::Remote < Kamal::Commands::Builder::Multiarch
|
||||
def create
|
||||
combine \
|
||||
create_contexts,
|
||||
create_local_buildx,
|
||||
append_remote_buildx
|
||||
end
|
||||
|
||||
def remove
|
||||
combine \
|
||||
remove_contexts,
|
||||
super
|
||||
end
|
||||
|
||||
def context_hosts
|
||||
chain \
|
||||
context_host(builder_name_with_arch(local_arch)),
|
||||
context_host(builder_name_with_arch(remote_arch))
|
||||
end
|
||||
|
||||
def config_context_hosts
|
||||
[ local_host, remote_host ].compact
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
super + "-remote"
|
||||
end
|
||||
|
||||
def builder_name_with_arch(arch)
|
||||
"#{builder_name}-#{arch}"
|
||||
end
|
||||
|
||||
def create_local_buildx
|
||||
docker :buildx, :create, "--name", builder_name, builder_name_with_arch(local_arch), "--platform", "linux/#{local_arch}"
|
||||
end
|
||||
|
||||
def append_remote_buildx
|
||||
docker :buildx, :create, "--append", "--name", builder_name, builder_name_with_arch(remote_arch), "--platform", "linux/#{remote_arch}"
|
||||
end
|
||||
|
||||
def create_contexts
|
||||
combine \
|
||||
create_context(local_arch, local_host),
|
||||
create_context(remote_arch, remote_host)
|
||||
end
|
||||
|
||||
def create_context(arch, host)
|
||||
docker :context, :create, builder_name_with_arch(arch), "--description", "'#{builder_name} #{arch} native host'", "--docker", "'host=#{host}'"
|
||||
end
|
||||
|
||||
def remove_contexts
|
||||
combine \
|
||||
remove_context(local_arch),
|
||||
remove_context(remote_arch)
|
||||
end
|
||||
|
||||
def remove_context(arch)
|
||||
docker :context, :rm, builder_name_with_arch(arch)
|
||||
end
|
||||
|
||||
def platform_names
|
||||
"linux/#{local_arch},linux/#{remote_arch}"
|
||||
end
|
||||
end
|
||||
20
lib/kamal/commands/builder/native.rb
Normal file
20
lib/kamal/commands/builder/native.rb
Normal file
@@ -0,0 +1,20 @@
|
||||
class Kamal::Commands::Builder::Native < Kamal::Commands::Builder::Base
|
||||
def create
|
||||
# No-op on native without cache
|
||||
end
|
||||
|
||||
def remove
|
||||
# No-op on native without cache
|
||||
end
|
||||
|
||||
def info
|
||||
# No-op on native
|
||||
end
|
||||
|
||||
def push
|
||||
combine \
|
||||
docker(:build, *build_options, build_context),
|
||||
docker(:push, config.absolute_image),
|
||||
docker(:push, config.latest_image)
|
||||
end
|
||||
end
|
||||
25
lib/kamal/commands/builder/native/cached.rb
Normal file
25
lib/kamal/commands/builder/native/cached.rb
Normal file
@@ -0,0 +1,25 @@
|
||||
class Kamal::Commands::Builder::Native::Cached < Kamal::Commands::Builder::Native
|
||||
def create
|
||||
docker :buildx, :create, "--name", builder_name, "--use", "--driver=docker-container"
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
|
||||
def push
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
*build_options,
|
||||
build_context
|
||||
end
|
||||
|
||||
def context_hosts
|
||||
docker :buildx, :inspect, builder_name, "> /dev/null"
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-#{config.service}-native-cached"
|
||||
end
|
||||
end
|
||||
67
lib/kamal/commands/builder/native/remote.rb
Normal file
67
lib/kamal/commands/builder/native/remote.rb
Normal file
@@ -0,0 +1,67 @@
|
||||
class Kamal::Commands::Builder::Native::Remote < Kamal::Commands::Builder::Native
|
||||
def create
|
||||
chain \
|
||||
create_context,
|
||||
create_buildx
|
||||
end
|
||||
|
||||
def remove
|
||||
chain \
|
||||
remove_context,
|
||||
remove_buildx
|
||||
end
|
||||
|
||||
def info
|
||||
chain \
|
||||
docker(:context, :ls),
|
||||
docker(:buildx, :ls)
|
||||
end
|
||||
|
||||
def push
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
"--platform", platform,
|
||||
"--builder", builder_name,
|
||||
*build_options,
|
||||
build_context
|
||||
end
|
||||
|
||||
def context_hosts
|
||||
context_host(builder_name_with_arch)
|
||||
end
|
||||
|
||||
def config_context_hosts
|
||||
[ remote_host ]
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-#{config.service}-native-remote"
|
||||
end
|
||||
|
||||
def builder_name_with_arch
|
||||
"#{builder_name}-#{remote_arch}"
|
||||
end
|
||||
|
||||
def platform
|
||||
"linux/#{remote_arch}"
|
||||
end
|
||||
|
||||
def create_context
|
||||
docker :context, :create,
|
||||
builder_name_with_arch, "--description", "'#{builder_name} #{remote_arch} native host'", "--docker", "'host=#{remote_host}'"
|
||||
end
|
||||
|
||||
def remove_context
|
||||
docker :context, :rm, builder_name_with_arch
|
||||
end
|
||||
|
||||
def create_buildx
|
||||
docker :buildx, :create, "--name", builder_name, builder_name_with_arch, "--platform", platform
|
||||
end
|
||||
|
||||
def remove_buildx
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
end
|
||||
@@ -1,63 +0,0 @@
|
||||
class Kamal::Commands::Builder::Remote < Kamal::Commands::Builder::Base
|
||||
def create
|
||||
chain \
|
||||
create_remote_context,
|
||||
create_buildx
|
||||
end
|
||||
|
||||
def remove
|
||||
chain \
|
||||
remove_remote_context,
|
||||
remove_buildx
|
||||
end
|
||||
|
||||
def info
|
||||
chain \
|
||||
docker(:context, :ls),
|
||||
docker(:buildx, :ls)
|
||||
end
|
||||
|
||||
def inspect_builder
|
||||
combine \
|
||||
combine inspect_buildx, inspect_remote_context,
|
||||
[ "(echo no compatible builder && exit 1)" ],
|
||||
by: "||"
|
||||
end
|
||||
|
||||
private
|
||||
def builder_name
|
||||
"kamal-remote-#{remote.gsub(/[^a-z0-9_-]/, "-")}"
|
||||
end
|
||||
|
||||
def remote_context_name
|
||||
"#{builder_name}-context"
|
||||
end
|
||||
|
||||
def inspect_buildx
|
||||
pipe \
|
||||
docker(:buildx, :inspect, builder_name),
|
||||
grep("-q", "Endpoint:.*#{remote_context_name}")
|
||||
end
|
||||
|
||||
def inspect_remote_context
|
||||
pipe \
|
||||
docker(:context, :inspect, remote_context_name, "--format", ENDPOINT_DOCKER_HOST_INSPECT),
|
||||
grep("-xq", remote)
|
||||
end
|
||||
|
||||
def create_remote_context
|
||||
docker :context, :create, remote_context_name, "--description", "'#{builder_name} host'", "--docker", "'host=#{remote}'"
|
||||
end
|
||||
|
||||
def remove_remote_context
|
||||
docker :context, :rm, remote_context_name
|
||||
end
|
||||
|
||||
def create_buildx
|
||||
docker :buildx, :create, "--name", builder_name, remote_context_name
|
||||
end
|
||||
|
||||
def remove_buildx
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
end
|
||||
@@ -19,10 +19,6 @@ class Kamal::Commands::Docker < Kamal::Commands::Base
|
||||
[ '[ "${EUID:-$(id -u)}" -eq 0 ] || command -v sudo >/dev/null || command -v su >/dev/null' ]
|
||||
end
|
||||
|
||||
def create_network
|
||||
docker :network, :create, :kamal
|
||||
end
|
||||
|
||||
private
|
||||
def get_docker
|
||||
shell \
|
||||
|
||||
@@ -1,12 +1,6 @@
|
||||
class Kamal::Commands::Hook < Kamal::Commands::Base
|
||||
def run(hook)
|
||||
[ hook_file(hook) ]
|
||||
end
|
||||
|
||||
def env(secrets: false, **details)
|
||||
tags(**details).env.tap do |env|
|
||||
env.merge!(config.secrets.to_h) if secrets
|
||||
end
|
||||
def run(hook, **details)
|
||||
[ hook_file(hook), env: tags(**details).env ]
|
||||
end
|
||||
|
||||
def hook_exists?(hook)
|
||||
|
||||
@@ -44,10 +44,14 @@ class Kamal::Commands::Lock < Kamal::Commands::Base
|
||||
"/dev/null"
|
||||
end
|
||||
|
||||
def lock_dir
|
||||
dir_name = [ "lock", config.service, config.destination ].compact.join("-")
|
||||
def locks_dir
|
||||
File.join(config.run_directory, "locks")
|
||||
end
|
||||
|
||||
File.join(config.run_directory, dir_name)
|
||||
def lock_dir
|
||||
dir_name = [ config.service, config.destination ].compact.join("-")
|
||||
|
||||
File.join(locks_dir, dir_name)
|
||||
end
|
||||
|
||||
def lock_details_file
|
||||
|
||||
@@ -1,87 +0,0 @@
|
||||
class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
def run
|
||||
docker :run,
|
||||
"--name", container_name,
|
||||
"--network", "kamal",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
"--volume", "kamal-proxy-config:/home/kamal-proxy/.config/kamal-proxy",
|
||||
"\$\(#{get_boot_options.join(" ")}\)",
|
||||
config.proxy_image
|
||||
end
|
||||
|
||||
def start
|
||||
docker :container, :start, container_name
|
||||
end
|
||||
|
||||
def stop(name: container_name)
|
||||
docker :container, :stop, name
|
||||
end
|
||||
|
||||
def start_or_run
|
||||
combine start, run, by: "||"
|
||||
end
|
||||
|
||||
def info
|
||||
docker :ps, "--filter", "name=^#{container_name}$"
|
||||
end
|
||||
|
||||
def version
|
||||
pipe \
|
||||
docker(:inspect, container_name, "--format '{{.Config.Image}}'"),
|
||||
[ :cut, "-d:", "-f2" ]
|
||||
end
|
||||
|
||||
def logs(timestamps: true, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, container_name, ("--since #{since}" if since), ("--tail #{lines}" if lines), ("--timestamps" if timestamps), "2>&1"),
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, timestamps: true, grep: nil, grep_options: nil)
|
||||
run_over_ssh pipe(
|
||||
docker(:logs, container_name, ("--timestamps" if timestamps), "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
).join(" "), host: host
|
||||
end
|
||||
|
||||
def remove_container
|
||||
docker :container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy"
|
||||
end
|
||||
|
||||
def remove_image
|
||||
docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy"
|
||||
end
|
||||
|
||||
def cleanup_traefik
|
||||
chain \
|
||||
docker(:container, :stop, "traefik"),
|
||||
combine(
|
||||
docker(:container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=Traefik"),
|
||||
docker(:image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik")
|
||||
)
|
||||
end
|
||||
|
||||
def ensure_proxy_directory
|
||||
make_directory config.proxy_directory
|
||||
end
|
||||
|
||||
def remove_proxy_directory
|
||||
remove_directory config.proxy_directory
|
||||
end
|
||||
|
||||
def get_boot_options
|
||||
combine [ :cat, config.proxy_options_file ], [ :echo, "\"#{config.proxy_options_default.join(" ")}\"" ], by: "||"
|
||||
end
|
||||
|
||||
def reset_boot_options
|
||||
remove_file config.proxy_options_file
|
||||
end
|
||||
|
||||
private
|
||||
def container_name
|
||||
config.proxy_container_name
|
||||
end
|
||||
end
|
||||
@@ -9,7 +9,7 @@ class Kamal::Commands::Prune < Kamal::Commands::Base
|
||||
def tagged_images
|
||||
pipe \
|
||||
docker(:image, :ls, *service_filter, "--format", "'{{.ID}} {{.Repository}}:{{.Tag}}'"),
|
||||
grep("-v -w \"#{active_image_list}\""),
|
||||
"grep -v -w \"#{active_image_list}\"",
|
||||
"while read image tag; do docker rmi $tag; done"
|
||||
end
|
||||
|
||||
@@ -20,6 +20,10 @@ class Kamal::Commands::Prune < Kamal::Commands::Base
|
||||
"while read container_id; do docker rm $container_id; done"
|
||||
end
|
||||
|
||||
def healthcheck_containers
|
||||
docker :container, :prune, "--force", *healthcheck_service_filter
|
||||
end
|
||||
|
||||
private
|
||||
def stopped_containers_filters
|
||||
[ "created", "exited", "dead" ].flat_map { |status| [ "--filter", "status=#{status}" ] }
|
||||
@@ -35,4 +39,8 @@ class Kamal::Commands::Prune < Kamal::Commands::Base
|
||||
def service_filter
|
||||
[ "--filter", "label=service=#{config.service}" ]
|
||||
end
|
||||
|
||||
def healthcheck_service_filter
|
||||
[ "--filter", "label=service=#{config.healthcheck_service}" ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
class Kamal::Commands::Registry < Kamal::Commands::Base
|
||||
def login(registry_config: nil)
|
||||
registry_config ||= config.registry
|
||||
delegate :registry, to: :config
|
||||
|
||||
def login
|
||||
docker :login,
|
||||
registry_config.server,
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry_config.username)),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry_config.password))
|
||||
registry.server,
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry.username)),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry.password))
|
||||
end
|
||||
|
||||
def logout(registry_config: nil)
|
||||
registry_config ||= config.registry
|
||||
|
||||
docker :logout, registry_config.server
|
||||
def logout
|
||||
docker :logout, registry.server
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,15 +1,5 @@
|
||||
class Kamal::Commands::Server < Kamal::Commands::Base
|
||||
def ensure_run_directory
|
||||
make_directory config.run_directory
|
||||
end
|
||||
|
||||
def remove_app_directory
|
||||
remove_directory config.app_directory
|
||||
end
|
||||
|
||||
def app_directory_count
|
||||
pipe \
|
||||
[ :ls, config.apps_directory ],
|
||||
[ :wc, "-l" ]
|
||||
[ :mkdir, "-p", config.run_directory ]
|
||||
end
|
||||
end
|
||||
|
||||
94
lib/kamal/commands/traefik.rb
Normal file
94
lib/kamal/commands/traefik.rb
Normal file
@@ -0,0 +1,94 @@
|
||||
class Kamal::Commands::Traefik < Kamal::Commands::Base
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
delegate :port, :publish?, :labels, :env, :image, :options, :args, to: :"config.traefik"
|
||||
|
||||
def run
|
||||
docker :run, "--name traefik",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
*publish_args,
|
||||
"--volume", "/var/run/docker.sock:/var/run/docker.sock",
|
||||
*env_args,
|
||||
*config.logging_args,
|
||||
*label_args,
|
||||
*docker_options_args,
|
||||
image,
|
||||
"--providers.docker",
|
||||
*cmd_option_args
|
||||
end
|
||||
|
||||
def start
|
||||
docker :container, :start, "traefik"
|
||||
end
|
||||
|
||||
def stop
|
||||
docker :container, :stop, "traefik"
|
||||
end
|
||||
|
||||
def start_or_run
|
||||
any start, run
|
||||
end
|
||||
|
||||
def info
|
||||
docker :ps, "--filter", "name=^traefik$"
|
||||
end
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, "traefik", (" --since #{since}" if since), (" --tail #{lines}" if lines), "--timestamps", "2>&1"),
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, grep: nil, grep_options: nil)
|
||||
run_over_ssh pipe(
|
||||
docker(:logs, "traefik", "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
).join(" "), host: host
|
||||
end
|
||||
|
||||
def remove_container
|
||||
docker :container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
|
||||
end
|
||||
|
||||
def remove_image
|
||||
docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
|
||||
end
|
||||
|
||||
def make_env_directory
|
||||
make_directory(env.secrets_directory)
|
||||
end
|
||||
|
||||
def remove_env_file
|
||||
[ :rm, "-f", env.secrets_file ]
|
||||
end
|
||||
|
||||
def cleanup_kamal_proxy
|
||||
chain \
|
||||
docker(:container, :stop, "kamal-proxy"),
|
||||
combine(
|
||||
docker(:container, :prune, "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy"),
|
||||
docker(:image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=kamal-proxy")
|
||||
)
|
||||
end
|
||||
|
||||
private
|
||||
def publish_args
|
||||
argumentize "--publish", port if publish?
|
||||
end
|
||||
|
||||
def label_args
|
||||
argumentize "--label", labels
|
||||
end
|
||||
|
||||
def env_args
|
||||
env.args
|
||||
end
|
||||
|
||||
def docker_options_args
|
||||
optionize(options)
|
||||
end
|
||||
|
||||
def cmd_option_args
|
||||
optionize args, with: "="
|
||||
end
|
||||
end
|
||||
@@ -2,27 +2,21 @@ require "active_support/ordered_options"
|
||||
require "active_support/core_ext/string/inquiry"
|
||||
require "active_support/core_ext/module/delegation"
|
||||
require "active_support/core_ext/hash/keys"
|
||||
require "pathname"
|
||||
require "erb"
|
||||
require "net/ssh/proxy/jump"
|
||||
|
||||
class Kamal::Configuration
|
||||
delegate :service, :image, :labels, :hooks_path, to: :raw_config, allow_nil: true
|
||||
delegate :service, :image, :labels, :stop_wait_time, :hooks_path, to: :raw_config, allow_nil: true
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :destination, :raw_config, :secrets
|
||||
attr_reader :accessories, :aliases, :boot, :builder, :env, :logging, :proxy, :servers, :ssh, :sshkit, :registry
|
||||
attr_reader :destination, :raw_config
|
||||
attr_reader :accessories, :boot, :builder, :env, :healthcheck, :logging, :traefik, :servers, :ssh, :sshkit, :registry
|
||||
|
||||
include Validation
|
||||
|
||||
PROXY_MINIMUM_VERSION = "v0.8.4"
|
||||
PROXY_HTTP_PORT = 80
|
||||
PROXY_HTTPS_PORT = 443
|
||||
PROXY_LOG_MAX_SIZE = "10m"
|
||||
|
||||
class << self
|
||||
def create_from(config_file:, destination: nil, version: nil)
|
||||
ENV["KAMAL_DESTINATION"] = destination
|
||||
|
||||
raw_config = load_config_files(config_file, *destination_config_file(config_file, destination))
|
||||
|
||||
new raw_config, destination: destination, version: version
|
||||
@@ -37,7 +31,7 @@ class Kamal::Configuration
|
||||
if file.exist?
|
||||
# Newer Psych doesn't load aliases by default
|
||||
load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
|
||||
YAML.send(load_method, ERB.new(File.read(file)).result).symbolize_keys
|
||||
YAML.send(load_method, ERB.new(IO.read(file)).result).symbolize_keys
|
||||
else
|
||||
raise "Configuration file not found in #{file}"
|
||||
end
|
||||
@@ -55,20 +49,18 @@ class Kamal::Configuration
|
||||
|
||||
validate! raw_config, example: validation_yml.symbolize_keys, context: "", with: Kamal::Configuration::Validator::Configuration
|
||||
|
||||
@secrets = Kamal::Secrets.new(destination: destination)
|
||||
|
||||
# Eager load config to validate it, these are first as they have dependencies later on
|
||||
@servers = Servers.new(config: self)
|
||||
@registry = Registry.new(config: @raw_config, secrets: secrets)
|
||||
@registry = Registry.new(config: self)
|
||||
|
||||
@accessories = @raw_config.accessories&.keys&.collect { |name| Accessory.new(name, config: self) } || []
|
||||
@aliases = @raw_config.aliases&.keys&.to_h { |name| [ name, Alias.new(name, config: self) ] } || {}
|
||||
@boot = Boot.new(config: self)
|
||||
@builder = Builder.new(config: self)
|
||||
@env = Env.new(config: @raw_config.env || {}, secrets: secrets)
|
||||
@env = Env.new(config: @raw_config.env || {})
|
||||
|
||||
@healthcheck = Healthcheck.new(healthcheck_config: @raw_config.healthcheck)
|
||||
@logging = Logging.new(logging_config: @raw_config.logging)
|
||||
@proxy = Proxy.new(config: self, proxy_config: @raw_config.proxy || {})
|
||||
@traefik = Traefik.new(config: self)
|
||||
@ssh = Ssh.new(config: self)
|
||||
@sshkit = Sshkit.new(config: self)
|
||||
|
||||
@@ -77,11 +69,9 @@ class Kamal::Configuration
|
||||
ensure_valid_kamal_version
|
||||
ensure_retain_containers_valid
|
||||
ensure_valid_service_name
|
||||
ensure_no_traefik_reboot_hooks
|
||||
ensure_one_host_for_ssl_roles
|
||||
ensure_unique_hosts_for_ssl_roles
|
||||
end
|
||||
|
||||
|
||||
def version=(version)
|
||||
@declared_version = version
|
||||
end
|
||||
@@ -105,6 +95,7 @@ class Kamal::Configuration
|
||||
raw_config.minimum_version
|
||||
end
|
||||
|
||||
|
||||
def roles
|
||||
servers.roles
|
||||
end
|
||||
@@ -117,6 +108,7 @@ class Kamal::Configuration
|
||||
accessories.detect { |a| a.name == name.to_s }
|
||||
end
|
||||
|
||||
|
||||
def all_hosts
|
||||
(roles + accessories).flat_map(&:hosts).uniq
|
||||
end
|
||||
@@ -137,16 +129,16 @@ class Kamal::Configuration
|
||||
raw_config.allow_empty_roles
|
||||
end
|
||||
|
||||
def proxy_roles
|
||||
roles.select(&:running_proxy?)
|
||||
def traefik_roles
|
||||
roles.select(&:running_traefik?)
|
||||
end
|
||||
|
||||
def proxy_role_names
|
||||
proxy_roles.flat_map(&:name)
|
||||
def traefik_role_names
|
||||
traefik_roles.flat_map(&:name)
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
proxy_roles.flat_map(&:hosts).uniq
|
||||
def traefik_hosts
|
||||
traefik_roles.flat_map(&:hosts).uniq
|
||||
end
|
||||
|
||||
def repository
|
||||
@@ -177,6 +169,7 @@ class Kamal::Configuration
|
||||
raw_config.retain_containers || 5
|
||||
end
|
||||
|
||||
|
||||
def volume_args
|
||||
if raw_config.volumes.present?
|
||||
argumentize "--volume", raw_config.volumes
|
||||
@@ -189,36 +182,30 @@ class Kamal::Configuration
|
||||
logging.args
|
||||
end
|
||||
|
||||
|
||||
def healthcheck_service
|
||||
[ "healthcheck", service, destination ].compact.join("-")
|
||||
end
|
||||
|
||||
def readiness_delay
|
||||
raw_config.readiness_delay || 7
|
||||
end
|
||||
|
||||
def deploy_timeout
|
||||
raw_config.deploy_timeout || 30
|
||||
def run_id
|
||||
@run_id ||= SecureRandom.hex(16)
|
||||
end
|
||||
|
||||
def drain_timeout
|
||||
raw_config.drain_timeout || 30
|
||||
end
|
||||
|
||||
def run_directory
|
||||
".kamal"
|
||||
raw_config.run_directory || ".kamal"
|
||||
end
|
||||
|
||||
def apps_directory
|
||||
File.join run_directory, "apps"
|
||||
end
|
||||
|
||||
def app_directory
|
||||
File.join apps_directory, [ service, destination ].compact.join("-")
|
||||
end
|
||||
|
||||
def env_directory
|
||||
File.join app_directory, "env"
|
||||
end
|
||||
|
||||
def assets_directory
|
||||
File.join app_directory, "assets"
|
||||
def run_directory_as_docker_volume
|
||||
if Pathname.new(run_directory).absolute?
|
||||
run_directory
|
||||
else
|
||||
File.join "$(pwd)", run_directory
|
||||
end
|
||||
end
|
||||
|
||||
def hooks_path
|
||||
@@ -229,9 +216,14 @@ class Kamal::Configuration
|
||||
raw_config.asset_path
|
||||
end
|
||||
|
||||
|
||||
def host_env_directory
|
||||
File.join(run_directory, "env")
|
||||
end
|
||||
|
||||
def env_tags
|
||||
@env_tags ||= if (tags = raw_config.env["tags"])
|
||||
tags.collect { |name, config| Env::Tag.new(name, config: config, secrets: secrets) }
|
||||
tags.collect { |name, config| Env::Tag.new(name, config: config) }
|
||||
else
|
||||
[]
|
||||
end
|
||||
@@ -241,41 +233,6 @@ class Kamal::Configuration
|
||||
env_tags.detect { |t| t.name == name.to_s }
|
||||
end
|
||||
|
||||
def proxy_publish_args(http_port, https_port, bind_ips = nil)
|
||||
ensure_valid_bind_ips(bind_ips)
|
||||
|
||||
(bind_ips || [ nil ]).map do |bind_ip|
|
||||
bind_ip = format_bind_ip(bind_ip)
|
||||
publish_http = [ bind_ip, http_port, PROXY_HTTP_PORT ].compact.join(":")
|
||||
publish_https = [ bind_ip, https_port, PROXY_HTTPS_PORT ].compact.join(":")
|
||||
|
||||
argumentize "--publish", [ publish_http, publish_https ]
|
||||
end.join(" ")
|
||||
end
|
||||
|
||||
def proxy_logging_args(max_size)
|
||||
argumentize "--log-opt", "max-size=#{max_size}" if max_size.present?
|
||||
end
|
||||
|
||||
def proxy_options_default
|
||||
[ *proxy_publish_args(PROXY_HTTP_PORT, PROXY_HTTPS_PORT), *proxy_logging_args(PROXY_LOG_MAX_SIZE) ]
|
||||
end
|
||||
|
||||
def proxy_image
|
||||
"basecamp/kamal-proxy:#{PROXY_MINIMUM_VERSION}"
|
||||
end
|
||||
|
||||
def proxy_container_name
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def proxy_directory
|
||||
File.join run_directory, "proxy"
|
||||
end
|
||||
|
||||
def proxy_options_file
|
||||
File.join proxy_directory, "options"
|
||||
end
|
||||
|
||||
def to_h
|
||||
{
|
||||
@@ -291,7 +248,8 @@ class Kamal::Configuration
|
||||
sshkit: sshkit.to_h,
|
||||
builder: builder.to_h,
|
||||
accessories: raw_config.accessories,
|
||||
logging: logging_args
|
||||
logging: logging_args,
|
||||
healthcheck: healthcheck.to_h
|
||||
}.compact
|
||||
end
|
||||
|
||||
@@ -343,54 +301,12 @@ class Kamal::Configuration
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_valid_bind_ips(bind_ips)
|
||||
bind_ips.present? && bind_ips.each do |ip|
|
||||
next if ip =~ Resolv::IPv4::Regex || ip =~ Resolv::IPv6::Regex
|
||||
raise ArgumentError, "Invalid publish IP address: #{ip}"
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_retain_containers_valid
|
||||
raise Kamal::ConfigurationError, "Must retain at least 1 container" if retain_containers < 1
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_no_traefik_reboot_hooks
|
||||
hooks = %w[ pre-traefik-reboot post-traefik-reboot ].select { |hook_file| File.exist?(File.join(hooks_path, hook_file)) }
|
||||
|
||||
if hooks.any?
|
||||
raise Kamal::ConfigurationError, "Found #{hooks.join(", ")}, these should be renamed to (pre|post)-proxy-reboot"
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_one_host_for_ssl_roles
|
||||
roles.each(&:ensure_one_host_for_ssl)
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_unique_hosts_for_ssl_roles
|
||||
hosts = roles.select(&:ssl?).flat_map { |role| role.proxy.hosts }
|
||||
duplicates = hosts.tally.filter_map { |host, count| host if count > 1 }
|
||||
|
||||
raise Kamal::ConfigurationError, "Different roles can't share the same host for SSL: #{duplicates.join(", ")}" if duplicates.any?
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def format_bind_ip(ip)
|
||||
# Ensure IPv6 address inside square brackets - e.g. [::1]
|
||||
if ip =~ Resolv::IPv6::Regex && ip !~ /\[.*\]/
|
||||
"[#{ip}]"
|
||||
else
|
||||
ip
|
||||
end
|
||||
end
|
||||
|
||||
def role_names
|
||||
raw_config.servers.is_a?(Array) ? [ "web" ] : raw_config.servers.keys.sort
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
class Kamal::Configuration::Accessory
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
DEFAULT_NETWORK = "kamal"
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :name, :env, :proxy, :registry
|
||||
attr_reader :name, :accessory_config, :env
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
||||
@@ -16,11 +14,10 @@ class Kamal::Configuration::Accessory
|
||||
context: "accessories/#{name}",
|
||||
with: Kamal::Configuration::Validator::Accessory
|
||||
|
||||
ensure_valid_roles
|
||||
|
||||
@env = initialize_env
|
||||
@proxy = initialize_proxy if running_proxy?
|
||||
@registry = initialize_registry if accessory_config["registry"].present?
|
||||
@env = Kamal::Configuration::Env.new \
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets_file: File.join(config.host_env_directory, "accessories", "#{service_name}.env"),
|
||||
context: "accessories/#{name}/env"
|
||||
end
|
||||
|
||||
def service_name
|
||||
@@ -28,7 +25,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def image
|
||||
[ registry&.server, accessory_config["image"] ].compact.join("/")
|
||||
accessory_config["image"]
|
||||
end
|
||||
|
||||
def hosts
|
||||
@@ -41,10 +38,6 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
end
|
||||
|
||||
def network_args
|
||||
argumentize "--network", network
|
||||
end
|
||||
|
||||
def publish_args
|
||||
argumentize "--publish", port if port
|
||||
end
|
||||
@@ -58,19 +51,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def env_args
|
||||
[ *env.clear_args, *argumentize("--env-file", secrets_path) ]
|
||||
end
|
||||
|
||||
def env_directory
|
||||
File.join(config.env_directory, "accessories")
|
||||
end
|
||||
|
||||
def secrets_io
|
||||
env.secrets_io
|
||||
end
|
||||
|
||||
def secrets_path
|
||||
File.join(config.env_directory, "accessories", "#{name}.env")
|
||||
env.args
|
||||
end
|
||||
|
||||
def files
|
||||
@@ -107,33 +88,8 @@ class Kamal::Configuration::Accessory
|
||||
accessory_config["cmd"]
|
||||
end
|
||||
|
||||
def running_proxy?
|
||||
accessory_config["proxy"].present?
|
||||
end
|
||||
|
||||
private
|
||||
attr_reader :config, :accessory_config
|
||||
|
||||
def initialize_env
|
||||
Kamal::Configuration::Env.new \
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/env"
|
||||
end
|
||||
|
||||
def initialize_proxy
|
||||
Kamal::Configuration::Proxy.new \
|
||||
config: config,
|
||||
proxy_config: accessory_config["proxy"],
|
||||
context: "accessories/#{name}/proxy"
|
||||
end
|
||||
|
||||
def initialize_registry
|
||||
Kamal::Configuration::Registry.new \
|
||||
config: accessory_config,
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/registry"
|
||||
end
|
||||
attr_accessor :config
|
||||
|
||||
def default_labels
|
||||
{ "service" => service_name }
|
||||
@@ -155,7 +111,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def read_dynamic_file(local_file)
|
||||
StringIO.new(ERB.new(File.read(local_file)).result)
|
||||
StringIO.new(ERB.new(IO.read(local_file)).result)
|
||||
end
|
||||
|
||||
def expand_remote_file(remote_file)
|
||||
@@ -202,17 +158,7 @@ class Kamal::Configuration::Accessory
|
||||
|
||||
def hosts_from_roles
|
||||
if accessory_config.key?("roles")
|
||||
accessory_config["roles"].flat_map { |role| config.role(role)&.hosts }
|
||||
end
|
||||
end
|
||||
|
||||
def network
|
||||
accessory_config["network"] || DEFAULT_NETWORK
|
||||
end
|
||||
|
||||
def ensure_valid_roles
|
||||
if accessory_config["roles"] && (missing_roles = accessory_config["roles"] - config.roles.map(&:name)).any?
|
||||
raise Kamal::ConfigurationError, "accessories/#{name}: unknown roles #{missing_roles.join(", ")}"
|
||||
accessory_config["roles"].flat_map { |role| config.role(role).hosts }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
class Kamal::Configuration::Alias
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :name, :command
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @command = name.inquiry, config.raw_config["aliases"][name]
|
||||
|
||||
validate! \
|
||||
command,
|
||||
example: validation_yml["aliases"]["uname"],
|
||||
context: "aliases/#{name}",
|
||||
with: Kamal::Configuration::Validator::Alias
|
||||
end
|
||||
end
|
||||
@@ -19,42 +19,16 @@ class Kamal::Configuration::Builder
|
||||
builder_config
|
||||
end
|
||||
|
||||
def remote
|
||||
builder_config["remote"]
|
||||
end
|
||||
|
||||
def arches
|
||||
Array(builder_config.fetch("arch", default_arch))
|
||||
end
|
||||
|
||||
def local_arches
|
||||
@local_arches ||= if local_disabled?
|
||||
[]
|
||||
elsif remote
|
||||
arches & [ Kamal::Utils.docker_arch ]
|
||||
else
|
||||
arches
|
||||
end
|
||||
end
|
||||
|
||||
def remote_arches
|
||||
@remote_arches ||= if remote
|
||||
arches - local_arches
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
def remote?
|
||||
remote_arches.any?
|
||||
def multiarch?
|
||||
builder_config["multiarch"] != false
|
||||
end
|
||||
|
||||
def local?
|
||||
!local_disabled? && (arches.empty? || local_arches.any?)
|
||||
!!builder_config["local"]
|
||||
end
|
||||
|
||||
def cloud?
|
||||
driver.start_with? "cloud"
|
||||
def remote?
|
||||
!!builder_config["remote"]
|
||||
end
|
||||
|
||||
def cached?
|
||||
@@ -66,7 +40,7 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
|
||||
def secrets
|
||||
(builder_config["secrets"] || []).to_h { |key| [ key, config.secrets[key] ] }
|
||||
builder_config["secrets"] || []
|
||||
end
|
||||
|
||||
def dockerfile
|
||||
@@ -81,12 +55,20 @@ class Kamal::Configuration::Builder
|
||||
builder_config["context"] || "."
|
||||
end
|
||||
|
||||
def driver
|
||||
builder_config.fetch("driver", "docker-container")
|
||||
def local_arch
|
||||
builder_config["local"]["arch"] if local?
|
||||
end
|
||||
|
||||
def local_disabled?
|
||||
builder_config["local"] == false
|
||||
def local_host
|
||||
builder_config["local"]["host"] if local?
|
||||
end
|
||||
|
||||
def remote_arch
|
||||
builder_config["remote"]["arch"] if remote?
|
||||
end
|
||||
|
||||
def remote_host
|
||||
builder_config["remote"]["host"] if remote?
|
||||
end
|
||||
|
||||
def cache_from
|
||||
@@ -115,14 +97,6 @@ class Kamal::Configuration::Builder
|
||||
builder_config["ssh"]
|
||||
end
|
||||
|
||||
def provenance
|
||||
builder_config["provenance"]
|
||||
end
|
||||
|
||||
def sbom
|
||||
builder_config["sbom"]
|
||||
end
|
||||
|
||||
def git_clone?
|
||||
Kamal::Git.used? && builder_config["context"].nil?
|
||||
end
|
||||
@@ -140,23 +114,7 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
end
|
||||
|
||||
def docker_driver?
|
||||
driver == "docker"
|
||||
end
|
||||
|
||||
private
|
||||
def valid?
|
||||
if docker_driver?
|
||||
raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support remote builders" if remote
|
||||
raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support caching" if cached?
|
||||
raise ArgumentError, "Invalid builder configuration: the `docker` driver does not not support multiple arches" if arches.many?
|
||||
end
|
||||
|
||||
if @options["cache"] && @options["cache"]["type"]
|
||||
raise ArgumentError, "Invalid cache type: #{@options["cache"]["type"]}" unless [ "gha", "registry" ].include?(@options["cache"]["type"])
|
||||
end
|
||||
end
|
||||
|
||||
def cache_image
|
||||
builder_config["cache"]&.fetch("image", nil) || "#{image}-build-cache"
|
||||
end
|
||||
@@ -178,7 +136,7 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
def repo_basename
|
||||
@@ -192,8 +150,4 @@ class Kamal::Configuration::Builder
|
||||
def pwd_sha
|
||||
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
||||
end
|
||||
|
||||
def default_arch
|
||||
docker_driver? ? [] : [ "amd64", "arm64" ]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -3,50 +3,32 @@
|
||||
# Accessories can be booted on a single host, a list of hosts, or on specific roles.
|
||||
# The hosts do not need to be defined in the Kamal servers configuration.
|
||||
#
|
||||
# Accessories are managed separately from the main service — they are not updated
|
||||
# when you deploy, and they do not have zero-downtime deployments.
|
||||
# Accessories are managed separately from the main service - they are not updated
|
||||
# when you deploy and they do not have zero-downtime deployments.
|
||||
#
|
||||
# Run `kamal accessory boot <accessory>` to boot an accessory.
|
||||
# See `kamal accessory --help` for more information.
|
||||
|
||||
# Configuring accessories
|
||||
#
|
||||
# First, define the accessory in the `accessories`:
|
||||
# First define the accessory in the `accessories`
|
||||
accessories:
|
||||
mysql:
|
||||
|
||||
# Service name
|
||||
#
|
||||
# This is used in the service label and defaults to `<service>-<accessory>`,
|
||||
# where `<service>` is the main service name from the root configuration:
|
||||
# This is used in the service label and defaults to `<service>-<accessory>`
|
||||
# where `<service>` is the main service name from the root configuration
|
||||
service: mysql
|
||||
|
||||
# Image
|
||||
#
|
||||
# The Docker image to use.
|
||||
# Prefix it with its server when using root level registry different from Docker Hub.
|
||||
# Define registry directly or via anchors when it differs from root level registry.
|
||||
# The Docker image to use, prefix with a registry if not using Docker hub
|
||||
image: mysql:8.0
|
||||
|
||||
# Registry
|
||||
#
|
||||
# By default accessories use Docker Hub registry.
|
||||
# You can specify different registry per accessory with this option.
|
||||
# Don't prefix image with this registry server.
|
||||
# Use anchors if you need to set the same specific registry for several accessories.
|
||||
#
|
||||
# ```yml
|
||||
# registry:
|
||||
# <<: *specific-registry
|
||||
# ```
|
||||
#
|
||||
# See kamal docs registry for more information:
|
||||
registry:
|
||||
...
|
||||
|
||||
# Accessory hosts
|
||||
#
|
||||
# Specify one of `host`, `hosts`, or `roles`:
|
||||
# Specify one of `host`, `hosts` or `roles`
|
||||
host: mysql-db1
|
||||
hosts:
|
||||
- mysql-db1
|
||||
@@ -56,13 +38,13 @@ accessories:
|
||||
|
||||
# Custom command
|
||||
#
|
||||
# You can set a custom command to run in the container if you do not want to use the default:
|
||||
# You can set a custom command to run in the container, if you do not want to use the default
|
||||
cmd: "bin/mysqld"
|
||||
|
||||
# Port mappings
|
||||
#
|
||||
# See [https://docs.docker.com/network/](https://docs.docker.com/network/), and
|
||||
# especially note the warning about the security implications of exposing ports publicly.
|
||||
# See https://docs.docker.com/network/, especially note the warning about the security
|
||||
# implications of exposing ports publicly.
|
||||
port: "127.0.0.1:3306:3306"
|
||||
|
||||
# Labels
|
||||
@@ -70,22 +52,20 @@ accessories:
|
||||
app: myapp
|
||||
|
||||
# Options
|
||||
#
|
||||
# These are passed to the Docker run command in the form `--<name> <value>`:
|
||||
# These are passed to the Docker run command in the form `--<name> <value>`
|
||||
options:
|
||||
restart: always
|
||||
cpus: 2
|
||||
|
||||
# Environment variables
|
||||
#
|
||||
# See kamal docs env for more information:
|
||||
# See kamal docs env for more information
|
||||
env:
|
||||
...
|
||||
|
||||
# Copying files
|
||||
#
|
||||
# You can specify files to mount into the container.
|
||||
# The format is `local:remote`, where `local` is the path to the file on the local machine
|
||||
# The format is `local:remote` where `local` is the path to the file on the local machine
|
||||
# and `remote` is the path to the file in the container.
|
||||
#
|
||||
# They will be uploaded from the local repo to the host and then mounted.
|
||||
@@ -98,26 +78,13 @@ accessories:
|
||||
# Directories
|
||||
#
|
||||
# You can specify directories to mount into the container. They will be created on the host
|
||||
# before being mounted:
|
||||
# before being mounted
|
||||
directories:
|
||||
- mysql-logs:/var/log/mysql
|
||||
|
||||
# Volumes
|
||||
#
|
||||
# Any other volumes to mount, in addition to the files and directories.
|
||||
# They are not created or copied before mounting:
|
||||
# They are not created or copied before mounting
|
||||
volumes:
|
||||
- /path/to/mysql-logs:/var/log/mysql
|
||||
|
||||
# Network
|
||||
#
|
||||
# The network the accessory will be attached to.
|
||||
#
|
||||
# Defaults to kamal:
|
||||
network: custom
|
||||
|
||||
# Proxy
|
||||
#
|
||||
# You can run your accessory behind the Kamal proxy. See kamal docs proxy for more information
|
||||
proxy:
|
||||
...
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
# Aliases
|
||||
#
|
||||
# Aliases are shortcuts for Kamal commands.
|
||||
#
|
||||
# For example, for a Rails app, you might open a console with:
|
||||
#
|
||||
# ```shell
|
||||
# kamal app exec -i --reuse "bin/rails console"
|
||||
# ```
|
||||
#
|
||||
# By defining an alias, like this:
|
||||
aliases:
|
||||
console: app exec -i --reuse "bin/rails console"
|
||||
# You can now open the console with:
|
||||
#
|
||||
# ```shell
|
||||
# kamal console
|
||||
# ```
|
||||
|
||||
# Configuring aliases
|
||||
#
|
||||
# Aliases are defined in the root config under the alias key.
|
||||
#
|
||||
# Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores:
|
||||
aliases:
|
||||
uname: app exec -p -q -r web "uname -a"
|
||||
@@ -2,18 +2,18 @@
|
||||
#
|
||||
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
||||
#
|
||||
# Kamal’s default is to boot new containers on all hosts in parallel. However, you can control this with the boot configuration.
|
||||
# Kamal’s default is to boot new containers on all hosts in parallel. But you can control this with the boot configuration.
|
||||
|
||||
# Fixed group sizes
|
||||
#
|
||||
# Here, we boot 2 hosts at a time with a 10-second gap between each group:
|
||||
# Here we boot 2 hosts at a time with a 10 second gap between each group.
|
||||
boot:
|
||||
limit: 2
|
||||
wait: 10
|
||||
|
||||
# Percentage of hosts
|
||||
#
|
||||
# Here, we boot 25% of the hosts at a time with a 2-second gap between each group:
|
||||
# Here we boot 25% of the hosts at a time with a 2 second gap between each group.
|
||||
boot:
|
||||
limit: 25%
|
||||
wait: 2
|
||||
|
||||
@@ -1,41 +1,47 @@
|
||||
# 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` or `docker buildx build`
|
||||
#
|
||||
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information.
|
||||
# If no configuration is specified, Kamal will:
|
||||
# 1. Create a buildx context called `kamal-<service>-multiarch`
|
||||
# 2. Use `docker buildx build` to build a multiarch image for linux/amd64,linux/arm64 with that context
|
||||
#
|
||||
# See https://kamal-deploy.org/docs/configuration/builder-examples/ for more information
|
||||
|
||||
# Builder options
|
||||
#
|
||||
# Options go under the builder key in the root configuration.
|
||||
builder:
|
||||
|
||||
# Arch
|
||||
# Multiarch
|
||||
#
|
||||
# The architectures to build for — you can set an array or just a single value.
|
||||
#
|
||||
# Allowed values are `amd64` and `arm64`:
|
||||
arch:
|
||||
- amd64
|
||||
# Enables multiarch builds, defaults to `true`
|
||||
multiarch: false
|
||||
|
||||
# Remote
|
||||
# Local configuration
|
||||
#
|
||||
# The connection string for a remote builder. If supplied, Kamal will use this
|
||||
# for builds that do not match the local architecture of the deployment host.
|
||||
remote: ssh://docker@docker-builder
|
||||
# The build configuration for local builds, only used if multiarch is enabled (the default)
|
||||
#
|
||||
# If there is no remote configuration, by default we build for amd64 and arm64.
|
||||
# If you only want to build for one architecture, you can specify it here.
|
||||
# The docker socket is optional and uses the default docker host socket when not specified
|
||||
local:
|
||||
arch: amd64
|
||||
host: /var/run/docker.sock
|
||||
|
||||
# Local
|
||||
# Remote configuration
|
||||
#
|
||||
# If set to false, Kamal will always use the remote builder even when building
|
||||
# the local architecture.
|
||||
#
|
||||
# Defaults to true:
|
||||
local: true
|
||||
# The build configuration for remote builds, also only used if multiarch is enabled.
|
||||
# The arch is required and can be either amd64 or arm64.
|
||||
remote:
|
||||
arch: arm64
|
||||
host: ssh://docker@docker-builder
|
||||
|
||||
# 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
|
||||
cache:
|
||||
type: registry
|
||||
options: mode=max
|
||||
@@ -43,25 +49,25 @@ builder:
|
||||
|
||||
# Build context
|
||||
#
|
||||
# If this is not set, then a local Git clone of the repo is used.
|
||||
# If this is not set, then a local git clone of the repo is used.
|
||||
# This ensures a clean build with no uncommitted changes.
|
||||
#
|
||||
# To use the local checkout instead, you can set the context to `.`, or a path to another directory.
|
||||
# To use the local checkout instead you can set the context to `.`, or a path to another directory.
|
||||
context: .
|
||||
|
||||
# Dockerfile
|
||||
#
|
||||
# The Dockerfile to use for building, defaults to `Dockerfile`:
|
||||
# The Dockerfile to use for building, defaults to `Dockerfile`
|
||||
dockerfile: Dockerfile.production
|
||||
|
||||
# Build target
|
||||
#
|
||||
# If not set, then the default target is used:
|
||||
# If not set, then the default target is used
|
||||
target: production
|
||||
|
||||
# Build arguments
|
||||
# Build Arguments
|
||||
#
|
||||
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`:
|
||||
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`
|
||||
args:
|
||||
ENVIRONMENT: production
|
||||
|
||||
@@ -74,46 +80,28 @@ builder:
|
||||
|
||||
# Build secrets
|
||||
#
|
||||
# Values are read from `.kamal/secrets`:
|
||||
# Values are read from the environment.
|
||||
#
|
||||
secrets:
|
||||
- SECRET1
|
||||
- SECRET2
|
||||
|
||||
# Referencing build secrets
|
||||
# Referencing Build Secrets
|
||||
#
|
||||
# ```shell
|
||||
# # Copy Gemfiles
|
||||
# COPY Gemfile Gemfile.lock ./
|
||||
#
|
||||
# # Install dependencies, including private repositories via access token
|
||||
# # Then remove bundle cache with exposed GITHUB_TOKEN
|
||||
# # Then remove bundle cache with exposed GITHUB_TOKEN)
|
||||
# RUN --mount=type=secret,id=GITHUB_TOKEN \
|
||||
# BUNDLE_GITHUB__COM=x-access-token:$(cat /run/secrets/GITHUB_TOKEN) \
|
||||
# bundle install && \
|
||||
# rm -rf /usr/local/bundle/cache
|
||||
# ```
|
||||
|
||||
|
||||
# SSH
|
||||
#
|
||||
# SSH agent socket or keys to expose to the build:
|
||||
# SSH agent socket or keys to expose to the build
|
||||
ssh: default=$SSH_AUTH_SOCK
|
||||
|
||||
# Driver
|
||||
#
|
||||
# The build driver to use, defaults to `docker-container`:
|
||||
driver: docker
|
||||
#
|
||||
# If you want to use Docker Build Cloud (https://www.docker.com/products/build-cloud/), you can set the driver to:
|
||||
driver: cloud org-name/builder-name
|
||||
|
||||
# Provenance
|
||||
#
|
||||
# It is used to configure provenance attestations for the build result.
|
||||
# The value can also be a boolean to enable or disable provenance attestations.
|
||||
provenance: mode=max
|
||||
|
||||
# SBOM (Software Bill of Materials)
|
||||
#
|
||||
# It is used to configure SBOM generation for the build result.
|
||||
# The value can also be a boolean to enable or disable SBOM generation.
|
||||
sbom: true
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
# Kamal Configuration
|
||||
#
|
||||
# Configuration is read from the `config/deploy.yml`.
|
||||
# Configuration is read from the `config/deploy.yml`
|
||||
#
|
||||
|
||||
# Destinations
|
||||
#
|
||||
# When running commands, you can specify a destination with the `-d` flag,
|
||||
# e.g., `kamal deploy -d staging`.
|
||||
# e.g. `kamal deploy -d staging`
|
||||
#
|
||||
# In this case, the configuration will also be read from `config/deploy.staging.yml`
|
||||
# In this case the configuration will also be read from `config/deploy.staging.yml`
|
||||
# and merged with the base configuration.
|
||||
|
||||
# Extensions
|
||||
@@ -17,11 +18,10 @@
|
||||
# However, you might want to declare a configuration block using YAML anchors
|
||||
# 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.
|
||||
|
||||
# The service name
|
||||
#
|
||||
# This is a required value. It is used as the container name prefix.
|
||||
service: myapp
|
||||
|
||||
@@ -32,147 +32,137 @@ image: my-image
|
||||
|
||||
# Labels
|
||||
#
|
||||
# Additional labels to add to the container:
|
||||
# Additional labels to add to the container
|
||||
labels:
|
||||
my-label: my-value
|
||||
|
||||
# Volumes
|
||||
#
|
||||
# Additional volumes to mount into the container:
|
||||
# Additional volumes to mount into the container
|
||||
volumes:
|
||||
- /path/on/host:/path/in/container:ro
|
||||
|
||||
# Registry
|
||||
#
|
||||
# The Docker registry configuration, see kamal docs registry:
|
||||
# The Docker registry configuration, see kamal docs registry
|
||||
registry:
|
||||
...
|
||||
|
||||
# Servers
|
||||
#
|
||||
# The servers to deploy to, optionally with custom roles, see kamal docs servers:
|
||||
# The servers to deploy to, optionally with custom roles, see kamal docs servers
|
||||
servers:
|
||||
...
|
||||
|
||||
# Environment variables
|
||||
#
|
||||
# See kamal docs env:
|
||||
# See kamal docs env
|
||||
env:
|
||||
...
|
||||
|
||||
# Asset path
|
||||
# Asset Bridging
|
||||
#
|
||||
# Used for asset bridging across deployments, default to `nil`.
|
||||
# Used for asset bridging across deployments, default to `nil`
|
||||
#
|
||||
# If there are changes to CSS or JS files, we may get requests
|
||||
# for the old versions on the new container, and vice versa.
|
||||
# for the old versions on the new container and vice-versa.
|
||||
#
|
||||
# To avoid 404s, we can specify an asset path.
|
||||
# To avoid 404s we can specify an asset path.
|
||||
# Kamal will replace that path in the container with a mapped
|
||||
# volume containing both sets of files.
|
||||
# This requires that file names change when the contents change
|
||||
# (e.g., by including a hash of the contents in the name).
|
||||
#
|
||||
# (e.g. by including a hash of the contents in the name).
|
||||
|
||||
# To configure this, set the path to the assets:
|
||||
asset_path: /path/to/assets
|
||||
|
||||
# Hooks path
|
||||
#
|
||||
# Path to hooks, defaults to `.kamal/hooks`.
|
||||
# See https://kamal-deploy.org/docs/hooks for more information:
|
||||
# Path to hooks, defaults to `.kamal/hooks`
|
||||
# See https://kamal-deploy.org/docs/hooks for more information
|
||||
hooks_path: /user_home/kamal/hooks
|
||||
|
||||
# Require destinations
|
||||
#
|
||||
# Whether deployments require a destination to be specified, defaults to `false`:
|
||||
# Whether deployments require a destination to be specified, defaults to `false`
|
||||
require_destination: true
|
||||
|
||||
# Primary role
|
||||
# The primary role
|
||||
#
|
||||
# This defaults to `web`, but if you have no web role, you can change this:
|
||||
# This defaults to `web`, but if you have no web role, you can change this
|
||||
primary_role: workers
|
||||
|
||||
# Allowing empty roles
|
||||
#
|
||||
# Whether roles with no servers are allowed. Defaults to `false`:
|
||||
# Whether roles with no servers are allowed. Defaults to `false`.
|
||||
allow_empty_roles: false
|
||||
|
||||
# Stop wait time
|
||||
#
|
||||
# How long we wait for a container to stop before killing it, defaults to 30 seconds
|
||||
stop_wait_time: 60
|
||||
|
||||
# Retain containers
|
||||
#
|
||||
# How many old containers and images we retain, defaults to 5:
|
||||
# How many old containers and images we retain, defaults to 5
|
||||
retain_containers: 3
|
||||
|
||||
# Minimum version
|
||||
#
|
||||
# The minimum version of Kamal required to deploy this configuration, defaults to `nil`:
|
||||
# The minimum version of Kamal required to deploy this configuration, defaults to nil
|
||||
minimum_version: 1.3.0
|
||||
|
||||
# Readiness delay
|
||||
#
|
||||
# Seconds to wait for a container to boot after it is running, default 7.
|
||||
#
|
||||
# This only applies to containers that do not run a proxy or specify a healthcheck:
|
||||
# Seconds to wait for a container to boot after is running, default 7
|
||||
# This only applies to containers that do not specify a healthcheck
|
||||
readiness_delay: 4
|
||||
|
||||
# Deploy timeout
|
||||
#
|
||||
# How long to wait for a container to become ready, default 30:
|
||||
deploy_timeout: 10
|
||||
|
||||
# Drain timeout
|
||||
#
|
||||
# How long to wait for a container to drain, default 30:
|
||||
drain_timeout: 10
|
||||
|
||||
# Run directory
|
||||
#
|
||||
# Directory to store kamal runtime files in on the host, default `.kamal`:
|
||||
# Directory to store kamal runtime files in on the host, default `.kamal`
|
||||
run_directory: /etc/kamal
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# See kamal docs ssh:
|
||||
# See kamal docs ssh
|
||||
ssh:
|
||||
...
|
||||
|
||||
# Builder options
|
||||
#
|
||||
# See kamal docs builder:
|
||||
# See kamal docs builder
|
||||
builder:
|
||||
...
|
||||
|
||||
# Accessories
|
||||
#
|
||||
# Additional services to run in Docker, see kamal docs accessory:
|
||||
# Additionals services to run in Docker, see kamal docs accessory
|
||||
accessories:
|
||||
...
|
||||
|
||||
# Proxy
|
||||
# Traefik
|
||||
#
|
||||
# Configuration for kamal-proxy, see kamal docs proxy:
|
||||
proxy:
|
||||
# The Traefik proxy is used for zero-downtime deployments, see kamal docs traefik
|
||||
traefik:
|
||||
...
|
||||
|
||||
# SSHKit
|
||||
#
|
||||
# See kamal docs sshkit:
|
||||
# See kamal docs sshkit
|
||||
sshkit:
|
||||
...
|
||||
|
||||
# Boot options
|
||||
#
|
||||
# See kamal docs boot:
|
||||
# See kamal docs boot
|
||||
boot:
|
||||
...
|
||||
|
||||
# Healthcheck
|
||||
#
|
||||
# Configuring healthcheck commands, intervals and timeouts, see kamal docs healthcheck
|
||||
healthcheck:
|
||||
...
|
||||
|
||||
# Logging
|
||||
#
|
||||
# Docker logging configuration, see kamal docs logging:
|
||||
# Docker logging configuration, see kamal docs logging
|
||||
logging:
|
||||
...
|
||||
|
||||
# Aliases
|
||||
#
|
||||
# Alias configuration, see kamal docs alias:
|
||||
aliases:
|
||||
...
|
||||
|
||||
@@ -1,50 +1,37 @@
|
||||
# Environment variables
|
||||
#
|
||||
# Environment variables can be set directly in the Kamal configuration or
|
||||
# read from `.kamal/secrets`.
|
||||
# Environment variables can be set directory in the Kamal configuration or
|
||||
# for loaded from a .env file, for secrets that should not be checked into Git.
|
||||
|
||||
# Reading environment variables from the configuration
|
||||
#
|
||||
# Environment variables can be set directly in the configuration file.
|
||||
#
|
||||
# These are passed to the `docker run` command when deploying.
|
||||
# These are passed to the docker run command when deploying.
|
||||
env:
|
||||
DATABASE_HOST: mysql-db1
|
||||
DATABASE_PORT: 3306
|
||||
|
||||
# Secrets
|
||||
# Using .env file to load required environment variables
|
||||
#
|
||||
# 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 .env file present
|
||||
# in the application root.
|
||||
#
|
||||
# If you are using destinations, secrets will instead be read from `.kamal/secrets.<DESTINATION>` if
|
||||
# it exists.
|
||||
#
|
||||
# Common secrets across all destinations can be set in `.kamal/secrets-common`.
|
||||
#
|
||||
# This file can be used to set variables like `KAMAL_REGISTRY_PASSWORD` or database passwords.
|
||||
# You can use variable or command substitution in the secrets file.
|
||||
#
|
||||
# ```shell
|
||||
# KAMAL_REGISTRY_PASSWORD=$KAMAL_REGISTRY_PASSWORD
|
||||
# RAILS_MASTER_KEY=$(cat config/master.key)
|
||||
# This file can be used to set variables like KAMAL_REGISTRY_PASSWORD or database passwords.
|
||||
# But for this reason you must ensure that .env files are not checked into Git or included
|
||||
# in your Dockerfile! The format is just key-value like:
|
||||
# ```
|
||||
#
|
||||
# You can also use [secret helpers](../../commands/secrets) for some common password managers.
|
||||
#
|
||||
# ```shell
|
||||
# SECRETS=$(kamal secrets fetch ...)
|
||||
#
|
||||
# REGISTRY_PASSWORD=$(kamal secrets extract REGISTRY_PASSWORD $SECRETS)
|
||||
# DB_PASSWORD=$(kamal secrets extract DB_PASSWORD $SECRETS)
|
||||
# KAMAL_REGISTRY_PASSWORD=pw
|
||||
# DB_PASSWORD=secret123
|
||||
# ```
|
||||
# See https://kamal-deploy.org/docs/commands/envify/ for how to use generated .env files.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# Unlike clear values, secrets are not passed directly to the container
|
||||
# but are stored in an env file on the host:
|
||||
# Unlike clear values, secrets are not passed directly to the container,
|
||||
# but are stored in an env file on the host
|
||||
# The file is not updated when deploying, only when running `kamal envify` or `kamal env push`.
|
||||
env:
|
||||
clear:
|
||||
DB_USER: app
|
||||
@@ -56,7 +43,7 @@ env:
|
||||
# Tags are used to add extra env variables to specific hosts.
|
||||
# See kamal docs servers for how to tag hosts.
|
||||
#
|
||||
# Tags are only allowed in the top-level env configuration (i.e., not under a role-specific env).
|
||||
# Tags are only allowed in the top level env configuration (i.e not under a role specific env).
|
||||
#
|
||||
# The env variables can be specified with secret and clear values as explained above.
|
||||
env:
|
||||
|
||||
59
lib/kamal/configuration/docs/healthcheck.yml
Normal file
59
lib/kamal/configuration/docs/healthcheck.yml
Normal file
@@ -0,0 +1,59 @@
|
||||
# Healthcheck configuration
|
||||
#
|
||||
# On roles that are running Traefik, Kamal will supply a default healthcheck to `docker run`.
|
||||
# For other roles, by default no healthcheck is supplied.
|
||||
#
|
||||
# If no healthcheck is supplied and the image does not define one, they we wait for the container
|
||||
# to reach a running state and then pause for the readiness delay.
|
||||
#
|
||||
# The default healthcheck is `curl -f http://localhost:<port>/<path>`, so it assumes that `curl`
|
||||
# is available within the container.
|
||||
|
||||
# Healthcheck options
|
||||
#
|
||||
# These go under the `healthcheck` key in the root or role configuration.
|
||||
healthcheck:
|
||||
|
||||
# Command
|
||||
#
|
||||
# The command to run, defaults to `curl -f http://localhost:<port>/<path>` on roles running Traefik
|
||||
cmd: "curl -f http://localhost"
|
||||
|
||||
# Interval
|
||||
#
|
||||
# The Docker healthcheck interval, defaults to `1s`
|
||||
interval: 10s
|
||||
|
||||
# Max attempts
|
||||
#
|
||||
# The maximum number of times we poll the container to see if it is healthy, defaults to `7`
|
||||
# Each check is separated by an increasing interval starting with 1 second.
|
||||
max_attempts: 3
|
||||
|
||||
# Port
|
||||
#
|
||||
# The port to use in the healthcheck, defaults to `3000`
|
||||
port: "80"
|
||||
|
||||
# Path
|
||||
#
|
||||
# The path to use in the healthcheck, defaults to `/up`
|
||||
path: /health
|
||||
|
||||
# Cords for zero-downtime deployments
|
||||
#
|
||||
# The cord file is used for zero-downtime deployments. The healthcheck is augmented with a check
|
||||
# for the existance of the file. This allows us to delete the file and force the container to
|
||||
# become unhealthy, causing Traefik to stop routing traffic to it.
|
||||
#
|
||||
# Kamal mounts a volume at this location and creates the file before starting the container.
|
||||
# You can set the value to `false` to disable the cord file, but this loses the zero-downtime
|
||||
# guarantee.
|
||||
#
|
||||
# The default value is `/tmp/kamal-cord`
|
||||
cord: /cord
|
||||
|
||||
# Log lines
|
||||
#
|
||||
# Number of lines to log from the container when the healthcheck fails, defaults to `50`
|
||||
log_lines: 100
|
||||
@@ -6,16 +6,16 @@
|
||||
#
|
||||
# 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:
|
||||
|
||||
# Driver
|
||||
#
|
||||
# The logging driver to use, passed to Docker via `--log-driver`:
|
||||
# The logging driver to use, passed to Docker via `--log-driver`
|
||||
driver: json-file
|
||||
|
||||
# Options
|
||||
#
|
||||
# Any logging options to pass to the driver, passed to Docker via `--log-opt`:
|
||||
# Any logging options to pass to the driver, passed to Docker via `--log-opt`
|
||||
options:
|
||||
max-size: 100m
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
# Proxy
|
||||
#
|
||||
# Kamal uses [kamal-proxy](https://github.com/basecamp/kamal-proxy) to provide
|
||||
# gapless deployments. It runs on ports 80 and 443 and forwards requests to the
|
||||
# application container.
|
||||
#
|
||||
# The proxy is configured in the root configuration under `proxy`. These are
|
||||
# options that are set when deploying the application, not when booting the proxy.
|
||||
#
|
||||
# They are application-specific, so they are not shared when multiple applications
|
||||
# run on the same proxy.
|
||||
#
|
||||
# The proxy is enabled by default on the primary role but can be disabled by
|
||||
# setting `proxy: false`.
|
||||
#
|
||||
# It is disabled by default on all other roles but can be enabled by setting
|
||||
# `proxy: true` or providing a proxy configuration.
|
||||
proxy:
|
||||
|
||||
# Hosts
|
||||
#
|
||||
# The hosts that will be used to serve the app. The proxy will only route requests
|
||||
# to this host to your app.
|
||||
#
|
||||
# If no hosts are set, then all requests will be forwarded, except for matching
|
||||
# requests for other apps deployed on that server that do have a host set.
|
||||
#
|
||||
# Specify one of `host` or `hosts`.
|
||||
host: foo.example.com
|
||||
hosts:
|
||||
- foo.example.com
|
||||
- bar.example.com
|
||||
|
||||
# App port
|
||||
#
|
||||
# The port the application container is exposed on.
|
||||
#
|
||||
# Defaults to 80:
|
||||
app_port: 3000
|
||||
|
||||
# SSL
|
||||
#
|
||||
# kamal-proxy can provide automatic HTTPS for your application via Let's Encrypt.
|
||||
#
|
||||
# This requires that we are deploying to one server and the host option is set.
|
||||
# The host value must point to the server we are deploying to, and port 443 must be
|
||||
# open for the Let's Encrypt challenge to succeed.
|
||||
#
|
||||
# If you set `ssl` to `true`, `kamal-proxy` will stop forwarding headers to your app,
|
||||
# unless you explicitly set `forward_headers: true`
|
||||
#
|
||||
# Defaults to `false`:
|
||||
ssl: true
|
||||
|
||||
# Forward headers
|
||||
#
|
||||
# Whether to forward the `X-Forwarded-For` and `X-Forwarded-Proto` headers.
|
||||
#
|
||||
# If you are behind a trusted proxy, you can set this to `true` to forward the headers.
|
||||
#
|
||||
# By default, kamal-proxy will not forward the headers if the `ssl` option is set to `true`, and
|
||||
# will forward them if it is set to `false`.
|
||||
forward_headers: true
|
||||
|
||||
# Response timeout
|
||||
#
|
||||
# How long to wait for requests to complete before timing out, defaults to 30 seconds:
|
||||
response_timeout: 10
|
||||
|
||||
# Healthcheck
|
||||
#
|
||||
# When deploying, the proxy will by default hit `/up` once every second until we hit
|
||||
# the deploy timeout, with a 5-second timeout for each request.
|
||||
#
|
||||
# Once the app is up, the proxy will stop hitting the healthcheck endpoint.
|
||||
healthcheck:
|
||||
interval: 3
|
||||
path: /health
|
||||
timeout: 3
|
||||
|
||||
# Buffering
|
||||
#
|
||||
# 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
|
||||
# for response size.
|
||||
#
|
||||
# You can also set the memory limit for buffering, which defaults to 1MB; anything
|
||||
# larger than that is written to disk.
|
||||
buffering:
|
||||
requests: true
|
||||
responses: true
|
||||
max_request_body: 40_000_000
|
||||
max_response_body: 0
|
||||
memory: 2_000_000
|
||||
|
||||
# Logging
|
||||
#
|
||||
# Configure request logging for the proxy.
|
||||
# You can specify request and response headers to log.
|
||||
# By default, `Cache-Control`, `Last-Modified`, and `User-Agent` request headers are logged:
|
||||
logging:
|
||||
request_headers:
|
||||
- Cache-Control
|
||||
- X-Forwarded-Proto
|
||||
response_headers:
|
||||
- X-Request-ID
|
||||
- X-Request-Start
|
||||
@@ -1,13 +1,10 @@
|
||||
# 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:
|
||||
#
|
||||
# By default, Docker Hub creates public repositories. To avoid making your images public,
|
||||
# set up a private repository before deploying, or change the default repository privacy
|
||||
# settings to private in your [Docker Hub settings](https://hub.docker.com/repository-settings/default-privacy).
|
||||
#
|
||||
# A reference to a secret (in this case, `DOCKER_REGISTRY_TOKEN`) will look up the secret
|
||||
# in the local environment:
|
||||
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
|
||||
# in the local environment.
|
||||
|
||||
registry:
|
||||
server: registry.digitalocean.com
|
||||
username:
|
||||
@@ -16,31 +13,28 @@ registry:
|
||||
- DOCKER_REGISTRY_TOKEN
|
||||
|
||||
# Using AWS ECR as the container registry
|
||||
#
|
||||
# You will need to have the AWS CLI installed locally for this to work.
|
||||
# AWS ECR’s access token is only valid for 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:
|
||||
# You will need to have the aws CLI installed locally for this to work.
|
||||
# AWS ECR’s access token is only valid for 12hrs. In order to not have to manually regenerate the token every time, you can use ERB in the deploy.yml file to shell out to the aws cli command, and obtain the token:
|
||||
|
||||
registry:
|
||||
server: <your aws account id>.dkr.ecr.<your aws region id>.amazonaws.com
|
||||
username: AWS
|
||||
password: <%= %x(aws ecr get-login-password) %>
|
||||
|
||||
# Using GCP Artifact Registry as the container registry
|
||||
#
|
||||
# To sign into Artifact Registry, you need to
|
||||
# To sign into Artifact Registry, you would need to
|
||||
# [create a service account](https://cloud.google.com/iam/docs/service-accounts-create#creating)
|
||||
# and [set up roles and permissions](https://cloud.google.com/artifact-registry/docs/access-control#permissions).
|
||||
# Normally, assigning 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, base64 encode it and add to .env:
|
||||
#
|
||||
# ```shell
|
||||
# base64 -i /path/to/key.json | tr -d "\\n"
|
||||
# echo "KAMAL_REGISTRY_PASSWORD=$(base64 -i /path/to/key.json)" | tr -d "\\n" >> .env
|
||||
# ```
|
||||
#
|
||||
# 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.
|
||||
# Use the env variable as password along with _json_key_base64 as username.
|
||||
# Here’s the final configuration:
|
||||
|
||||
registry:
|
||||
server: <your registry region>-docker.pkg.dev
|
||||
username: _json_key_base64
|
||||
@@ -50,7 +44,6 @@ registry:
|
||||
# Validating the configuration
|
||||
#
|
||||
# You can validate the configuration by running:
|
||||
#
|
||||
# ```shell
|
||||
# kamal registry login
|
||||
# ```
|
||||
|
||||
@@ -1,21 +1,22 @@
|
||||
# Roles
|
||||
#
|
||||
# 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`
|
||||
# in the root configuration.
|
||||
|
||||
# Role configuration
|
||||
#
|
||||
# Roles are specified under the servers key:
|
||||
# Roles are specified under the servers key
|
||||
servers:
|
||||
|
||||
# Simple role configuration
|
||||
#
|
||||
# This can be a list of hosts if you don't need custom configuration for the role.
|
||||
#
|
||||
# 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:
|
||||
- 172.1.0.1
|
||||
- 172.1.0.2: experiment1
|
||||
@@ -23,31 +24,29 @@ servers:
|
||||
|
||||
# Custom role configuration
|
||||
#
|
||||
# When there are other options to set, the list of hosts goes under the `hosts` key.
|
||||
# When there are other options to set, the list of hosts goes under the `hosts` key
|
||||
#
|
||||
# By default, only the primary role uses a proxy.
|
||||
# By default only the primary role uses Traefik, but you can set `traefik` to change
|
||||
# it.
|
||||
#
|
||||
# For other roles, you can set it to `proxy: true` to enable it and inherit the root proxy
|
||||
# configuration or provide a map of options to override the root configuration.
|
||||
#
|
||||
# For the primary role, you can set `proxy: false` to disable the proxy.
|
||||
#
|
||||
# You can also set a custom `cmd` to run in the container and overwrite other settings
|
||||
# You can also set a custom cmd to run in the container, and overwrite other settings
|
||||
# from the root configuration.
|
||||
workers:
|
||||
hosts:
|
||||
- 172.1.0.3
|
||||
- 172.1.0.4: experiment1
|
||||
traefik: true
|
||||
cmd: "bin/jobs"
|
||||
options:
|
||||
memory: 2g
|
||||
cpus: 4
|
||||
logging:
|
||||
healthcheck:
|
||||
...
|
||||
proxy:
|
||||
logging:
|
||||
...
|
||||
labels:
|
||||
my-label: workers
|
||||
env:
|
||||
...
|
||||
asset_path: /public
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
#
|
||||
# Servers are split into different roles, with each role having its own configuration.
|
||||
#
|
||||
# For simpler deployments, though, where all servers are identical, you can just specify a list of servers.
|
||||
# For simpler deployments though where all servers are identical, you can just specify a list of servers
|
||||
# They will be implicitly assigned to the `web` role.
|
||||
servers:
|
||||
- 172.0.0.1
|
||||
@@ -19,7 +19,7 @@ servers:
|
||||
|
||||
# Roles
|
||||
#
|
||||
# For more complex deployments (e.g., if you are running job hosts), you can specify roles and configure each separately (see kamal docs role):
|
||||
# For more complex deployments (e.g. if you are running job hosts), you can specify roles, and configure each separately (see kamal docs role)
|
||||
servers:
|
||||
web:
|
||||
...
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# SSH configuration
|
||||
#
|
||||
# Kamal uses SSH to connect and run commands on your hosts.
|
||||
# By default, it will attempt to connect to the root user on port 22.
|
||||
# Kamal uses SSH to connect run commands on your hosts.
|
||||
# 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, you’d do:
|
||||
# If you are using non-root user, you may need to bootstrap your servers manually, before using them with Kamal. On Ubuntu, you’d do:
|
||||
#
|
||||
# ```shell
|
||||
# sudo apt update
|
||||
@@ -12,6 +12,7 @@
|
||||
# sudo usermod -a -G docker app
|
||||
# ```
|
||||
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# The options are specified under the ssh key in the configuration file.
|
||||
@@ -19,52 +20,47 @@ ssh:
|
||||
|
||||
# The SSH user
|
||||
#
|
||||
# Defaults to `root`:
|
||||
# Defaults to `root`
|
||||
#
|
||||
user: app
|
||||
|
||||
# The SSH port
|
||||
#
|
||||
# Defaults to 22:
|
||||
# Defaults to 22
|
||||
port: "2222"
|
||||
|
||||
# Proxy host
|
||||
#
|
||||
# Specified in the form <host> or <user>@<host>:
|
||||
# Specified in the form <host> or <user>@<host>
|
||||
proxy: root@proxy-host
|
||||
|
||||
# Proxy command
|
||||
#
|
||||
# A custom proxy command, required for older versions of SSH:
|
||||
# A custom proxy command, required for older versions of SSH
|
||||
proxy_command: "ssh -W %h:%p user@proxy"
|
||||
|
||||
# Log level
|
||||
#
|
||||
# Defaults to `fatal`. Set this to `debug` if you are having SSH connection issues.
|
||||
# Defaults to `fatal`. Set this to debug if you are having
|
||||
# SSH connection issues.
|
||||
log_level: debug
|
||||
|
||||
# Keys only
|
||||
# Keys Only
|
||||
#
|
||||
# Set to `true` to use only private keys from the `keys` and `key_data` parameters,
|
||||
# even if ssh-agent offers more identities. This option is intended for
|
||||
# situations where ssh-agent offers many different identities or you
|
||||
# need to overwrite all identities and force a single one.
|
||||
# Set to true to use only private keys from keys and key_data parameters,
|
||||
# even if ssh-agent offers more identities. This option is intended for
|
||||
# situations where ssh-agent offers many different identites or you have
|
||||
# a need to overwrite all identites and force a single one.
|
||||
keys_only: false
|
||||
|
||||
# Keys
|
||||
#
|
||||
# An array of file names of private keys to use for public key
|
||||
# and host-based authentication:
|
||||
# An array of file names of private keys to use for publickey
|
||||
# and hostbased authentication
|
||||
keys: [ "~/.ssh/id.pem" ]
|
||||
|
||||
# Key data
|
||||
# Key Data
|
||||
#
|
||||
# An array of strings, with each element of the array being
|
||||
# a raw private key in PEM format.
|
||||
key_data: [ "-----BEGIN OPENSSH PRIVATE KEY-----" ]
|
||||
|
||||
# Config
|
||||
#
|
||||
# Set to true to load the default OpenSSH config files (~/.ssh/config,
|
||||
# /etc/ssh_config), to false ignore config files, or to a file path
|
||||
# (or array of paths) to load specific configuration. Defaults to true.
|
||||
config: true
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
#
|
||||
# [SSHKit](https://github.com/capistrano/sshkit) is the SSH toolkit used by Kamal.
|
||||
#
|
||||
# The default, settings should be sufficient for most use cases, but
|
||||
# when connecting to a large number of hosts, you may need to adjust.
|
||||
# The default settings should be sufficient for most use cases, but
|
||||
# when connecting to a large number of hosts you may need to adjust
|
||||
|
||||
# SSHKit options
|
||||
#
|
||||
@@ -13,11 +13,11 @@ sshkit:
|
||||
# Max concurrent starts
|
||||
#
|
||||
# Creating SSH connections concurrently can be an issue when deploying to many servers.
|
||||
# By default, Kamal will limit concurrent connection starts to 30 at a time.
|
||||
# By default Kamal will limit concurrent connection starts to 30 at a time.
|
||||
max_concurrent_starts: 10
|
||||
|
||||
# Pool idle timeout
|
||||
#
|
||||
# Kamal sets a long idle timeout of 900 seconds on connections to try to avoid
|
||||
# re-connection storms after an idle period, 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
|
||||
|
||||
62
lib/kamal/configuration/docs/traefik.yml
Normal file
62
lib/kamal/configuration/docs/traefik.yml
Normal file
@@ -0,0 +1,62 @@
|
||||
# Traefik
|
||||
#
|
||||
# Traefik is a reverse proxy, used by Kamal for zero-downtime deployments.
|
||||
#
|
||||
# We start an instance on the hosts in it's own container.
|
||||
#
|
||||
# During a deployment:
|
||||
# 1. We start a new container which Traefik automatically detects due to the labels we have applied
|
||||
# 2. Traefik starts routing traffic to the new container
|
||||
# 3. We force the old container to fail it's healthcheck, causing Traefik to stop routing traffic to it
|
||||
# 4. We stop the old container
|
||||
|
||||
# Traefik settings
|
||||
#
|
||||
# Traekik is configured in the root configuration under `traefik`.
|
||||
traefik:
|
||||
|
||||
# Image
|
||||
#
|
||||
# The Traefik image to use, defaults to `traefik:v2.10`
|
||||
image: traefik:v2.9
|
||||
|
||||
# Host port
|
||||
#
|
||||
# The host port to publish the Traefik container on, defaults to `80`
|
||||
host_port: "8080"
|
||||
|
||||
# Disabling publishing
|
||||
#
|
||||
# To avoid publishing the Traefik container, set this to `false`
|
||||
publish: false
|
||||
|
||||
# Labels
|
||||
#
|
||||
# Additional labels to apply to the Traefik container
|
||||
labels:
|
||||
traefik.http.routers.catchall.entryPoints: http
|
||||
traefik.http.routers.catchall.rule: PathPrefix(`/`)
|
||||
traefik.http.routers.catchall.service: unavailable
|
||||
traefik.http.routers.catchall.priority: "1"
|
||||
traefik.http.services.unavailable.loadbalancer.server.port: "0"
|
||||
|
||||
# Arguments
|
||||
#
|
||||
# Additional arguments to pass to the Traefik container
|
||||
args:
|
||||
entryPoints.http.address: ":80"
|
||||
entryPoints.http.forwardedHeaders.insecure: true
|
||||
accesslog: true
|
||||
accesslog.format: json
|
||||
|
||||
# Options
|
||||
#
|
||||
# Additional options to pass to `docker run`
|
||||
options:
|
||||
cpus: 2
|
||||
|
||||
# Environment variables
|
||||
#
|
||||
# See kamal docs env
|
||||
env:
|
||||
...
|
||||
@@ -1,29 +1,36 @@
|
||||
class Kamal::Configuration::Env
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :context, :secrets
|
||||
attr_reader :clear, :secret_keys
|
||||
attr_reader :secrets_keys, :clear, :secrets_file, :context
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
|
||||
def initialize(config:, secrets:, context: "env")
|
||||
def initialize(config:, secrets_file: nil, context: "env")
|
||||
@clear = config.fetch("clear", config.key?("secret") || config.key?("tags") ? {} : config)
|
||||
@secrets = secrets
|
||||
@secret_keys = config.fetch("secret", [])
|
||||
@secrets_keys = config.fetch("secret", [])
|
||||
@secrets_file = secrets_file
|
||||
@context = context
|
||||
validate! config, context: context, with: Kamal::Configuration::Validator::Env
|
||||
end
|
||||
|
||||
def clear_args
|
||||
argumentize("--env", clear)
|
||||
def args
|
||||
[ "--env-file", secrets_file, *argumentize("--env", clear) ]
|
||||
end
|
||||
|
||||
def secrets_io
|
||||
Kamal::EnvFile.new(secret_keys.to_h { |key| [ key, secrets[key] ] }).to_io
|
||||
StringIO.new(Kamal::EnvFile.new(secrets).to_s)
|
||||
end
|
||||
|
||||
def secrets
|
||||
@secrets ||= secrets_keys.to_h { |key| [ key, ENV.fetch(key) ] }
|
||||
end
|
||||
|
||||
def secrets_directory
|
||||
File.dirname(secrets_file)
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new \
|
||||
config: { "clear" => clear.merge(other.clear), "secret" => secret_keys | other.secret_keys },
|
||||
secrets: secrets
|
||||
config: { "clear" => clear.merge(other.clear), "secret" => secrets_keys | other.secrets_keys },
|
||||
secrets_file: secrets_file || other.secrets_file
|
||||
end
|
||||
end
|
||||
|
||||
7
lib/kamal/configuration/env/tag.rb
vendored
7
lib/kamal/configuration/env/tag.rb
vendored
@@ -1,13 +1,12 @@
|
||||
class Kamal::Configuration::Env::Tag
|
||||
attr_reader :name, :config, :secrets
|
||||
attr_reader :name, :config
|
||||
|
||||
def initialize(name, config:, secrets:)
|
||||
def initialize(name, config:)
|
||||
@name = name
|
||||
@config = config
|
||||
@secrets = secrets
|
||||
end
|
||||
|
||||
def env
|
||||
Kamal::Configuration::Env.new(config: config, secrets: secrets)
|
||||
Kamal::Configuration::Env.new(config: config)
|
||||
end
|
||||
end
|
||||
|
||||
63
lib/kamal/configuration/healthcheck.rb
Normal file
63
lib/kamal/configuration/healthcheck.rb
Normal file
@@ -0,0 +1,63 @@
|
||||
class Kamal::Configuration::Healthcheck
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :healthcheck_config
|
||||
|
||||
def initialize(healthcheck_config:, context: "healthcheck")
|
||||
@healthcheck_config = healthcheck_config || {}
|
||||
validate! @healthcheck_config, context: context
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new healthcheck_config: healthcheck_config.deep_merge(other.healthcheck_config)
|
||||
end
|
||||
|
||||
def cmd
|
||||
healthcheck_config.fetch("cmd", http_health_check)
|
||||
end
|
||||
|
||||
def port
|
||||
healthcheck_config.fetch("port", 3000)
|
||||
end
|
||||
|
||||
def path
|
||||
healthcheck_config.fetch("path", "/up")
|
||||
end
|
||||
|
||||
def max_attempts
|
||||
healthcheck_config.fetch("max_attempts", 7)
|
||||
end
|
||||
|
||||
def interval
|
||||
healthcheck_config.fetch("interval", "1s")
|
||||
end
|
||||
|
||||
def cord
|
||||
healthcheck_config.fetch("cord", "/tmp/kamal-cord")
|
||||
end
|
||||
|
||||
def log_lines
|
||||
healthcheck_config.fetch("log_lines", 50)
|
||||
end
|
||||
|
||||
def set_port_or_path?
|
||||
healthcheck_config["port"].present? || healthcheck_config["path"].present?
|
||||
end
|
||||
|
||||
def to_h
|
||||
{
|
||||
"cmd" => cmd,
|
||||
"interval" => interval,
|
||||
"max_attempts" => max_attempts,
|
||||
"port" => port,
|
||||
"path" => path,
|
||||
"cord" => cord,
|
||||
"log_lines" => log_lines
|
||||
}
|
||||
end
|
||||
|
||||
private
|
||||
def http_health_check
|
||||
"curl -f #{URI.join("http://localhost:#{port}", path)} || exit 1" if path.present? || port.present?
|
||||
end
|
||||
end
|
||||
@@ -1,62 +0,0 @@
|
||||
class Kamal::Configuration::Proxy
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
DEFAULT_LOG_REQUEST_HEADERS = [ "Cache-Control", "Last-Modified", "User-Agent" ]
|
||||
CONTAINER_NAME = "kamal-proxy"
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :config, :proxy_config
|
||||
|
||||
def initialize(config:, proxy_config:, context: "proxy")
|
||||
@config = config
|
||||
@proxy_config = proxy_config
|
||||
validate! @proxy_config, with: Kamal::Configuration::Validator::Proxy, context: context
|
||||
end
|
||||
|
||||
def app_port
|
||||
proxy_config.fetch("app_port", 80)
|
||||
end
|
||||
|
||||
def ssl?
|
||||
proxy_config.fetch("ssl", false)
|
||||
end
|
||||
|
||||
def hosts
|
||||
proxy_config["hosts"] || proxy_config["host"]&.split(",") || []
|
||||
end
|
||||
|
||||
def deploy_options
|
||||
{
|
||||
host: hosts,
|
||||
tls: proxy_config["ssl"].presence,
|
||||
"deploy-timeout": seconds_duration(config.deploy_timeout),
|
||||
"drain-timeout": seconds_duration(config.drain_timeout),
|
||||
"health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")),
|
||||
"health-check-timeout": seconds_duration(proxy_config.dig("healthcheck", "timeout")),
|
||||
"health-check-path": proxy_config.dig("healthcheck", "path"),
|
||||
"target-timeout": seconds_duration(proxy_config["response_timeout"]),
|
||||
"buffer-requests": proxy_config.fetch("buffering", { "requests": true }).fetch("requests", true),
|
||||
"buffer-responses": proxy_config.fetch("buffering", { "responses": true }).fetch("responses", true),
|
||||
"buffer-memory": proxy_config.dig("buffering", "memory"),
|
||||
"max-request-body": proxy_config.dig("buffering", "max_request_body"),
|
||||
"max-response-body": proxy_config.dig("buffering", "max_response_body"),
|
||||
"forward-headers": proxy_config.dig("forward_headers"),
|
||||
"log-request-header": proxy_config.dig("logging", "request_headers") || DEFAULT_LOG_REQUEST_HEADERS,
|
||||
"log-response-header": proxy_config.dig("logging", "response_headers")
|
||||
}.compact
|
||||
end
|
||||
|
||||
def deploy_command_args(target:)
|
||||
optionize ({ target: "#{target}:#{app_port}" }).merge(deploy_options), with: "="
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new config: config, proxy_config: proxy_config.deep_merge(other.proxy_config)
|
||||
end
|
||||
|
||||
private
|
||||
def seconds_duration(value)
|
||||
value ? "#{value}s" : nil
|
||||
end
|
||||
end
|
||||
@@ -1,10 +1,11 @@
|
||||
class Kamal::Configuration::Registry
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
def initialize(config:, secrets:, context: "registry")
|
||||
@registry_config = config["registry"] || {}
|
||||
@secrets = secrets
|
||||
validate! registry_config, context: context, with: Kamal::Configuration::Validator::Registry
|
||||
attr_reader :registry_config
|
||||
|
||||
def initialize(config:)
|
||||
@registry_config = config.raw_config.registry || {}
|
||||
validate! registry_config, with: Kamal::Configuration::Validator::Registry
|
||||
end
|
||||
|
||||
def server
|
||||
@@ -20,11 +21,9 @@ class Kamal::Configuration::Registry
|
||||
end
|
||||
|
||||
private
|
||||
attr_reader :registry_config, :secrets
|
||||
|
||||
def lookup(key)
|
||||
if registry_config[key].is_a?(Array)
|
||||
secrets[registry_config[key].first]
|
||||
ENV.fetch(registry_config[key].first).dup
|
||||
else
|
||||
registry_config[key]
|
||||
end
|
||||
|
||||
@@ -1,30 +1,33 @@
|
||||
class Kamal::Configuration::Role
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
CORD_FILE = "cord"
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_reader :name, :config, :specialized_env, :specialized_logging, :specialized_proxy
|
||||
attr_reader :name, :config, :specialized_env, :specialized_logging, :specialized_healthcheck
|
||||
|
||||
alias to_s name
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config = name.inquiry, config
|
||||
validate! \
|
||||
role_config,
|
||||
specializations,
|
||||
example: validation_yml["servers"]["workers"],
|
||||
context: "servers/#{name}",
|
||||
with: Kamal::Configuration::Validator::Role
|
||||
|
||||
@specialized_env = Kamal::Configuration::Env.new \
|
||||
config: specializations.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
secrets_file: File.join(config.host_env_directory, "roles", "#{container_prefix}.env"),
|
||||
context: "servers/#{name}/env"
|
||||
|
||||
@specialized_logging = Kamal::Configuration::Logging.new \
|
||||
logging_config: specializations.fetch("logging", {}),
|
||||
context: "servers/#{name}/logging"
|
||||
|
||||
initialize_specialized_proxy
|
||||
@specialized_healthcheck = Kamal::Configuration::Healthcheck.new \
|
||||
healthcheck_config: specializations.fetch("healthcheck", {}),
|
||||
context: "servers/#{name}/healthcheck"
|
||||
end
|
||||
|
||||
def primary_host
|
||||
@@ -52,7 +55,7 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def labels
|
||||
default_labels.merge(custom_labels)
|
||||
default_labels.merge(traefik_labels).merge(custom_labels)
|
||||
end
|
||||
|
||||
def label_args
|
||||
@@ -67,24 +70,6 @@ class Kamal::Configuration::Role
|
||||
@logging ||= config.logging.merge(specialized_logging)
|
||||
end
|
||||
|
||||
def proxy
|
||||
@proxy ||= config.proxy.merge(specialized_proxy) if running_proxy?
|
||||
end
|
||||
|
||||
def running_proxy?
|
||||
@running_proxy
|
||||
end
|
||||
|
||||
def ssl?
|
||||
running_proxy? && proxy.ssl?
|
||||
end
|
||||
|
||||
def stop_args
|
||||
# When deploying with the proxy, kamal-proxy will drain request before returning so we don't need to wait.
|
||||
timeout = running_proxy? ? nil : config.drain_timeout
|
||||
|
||||
[ *argumentize("-t", timeout) ]
|
||||
end
|
||||
|
||||
def env(host)
|
||||
@envs ||= {}
|
||||
@@ -92,19 +77,7 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def env_args(host)
|
||||
[ *env(host).clear_args, *argumentize("--env-file", secrets_path) ]
|
||||
end
|
||||
|
||||
def env_directory
|
||||
File.join(config.env_directory, "roles")
|
||||
end
|
||||
|
||||
def secrets_io(host)
|
||||
env(host).secrets_io
|
||||
end
|
||||
|
||||
def secrets_path
|
||||
File.join(config.env_directory, "roles", "#{name}.env")
|
||||
env(host).args
|
||||
end
|
||||
|
||||
def asset_volume_args
|
||||
@@ -112,8 +85,72 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
|
||||
def health_check_args(cord: true)
|
||||
if running_traefik? || healthcheck.set_port_or_path?
|
||||
if cord && uses_cord?
|
||||
optionize({ "health-cmd" => health_check_cmd_with_cord, "health-interval" => healthcheck.interval })
|
||||
.concat(cord_volume.docker_args)
|
||||
else
|
||||
optionize({ "health-cmd" => healthcheck.cmd, "health-interval" => healthcheck.interval })
|
||||
end
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
def healthcheck
|
||||
@healthcheck ||=
|
||||
if running_traefik?
|
||||
config.healthcheck.merge(specialized_healthcheck)
|
||||
else
|
||||
specialized_healthcheck
|
||||
end
|
||||
end
|
||||
|
||||
def health_check_cmd_with_cord
|
||||
"(#{healthcheck.cmd}) && (stat #{cord_container_file} > /dev/null || exit 1)"
|
||||
end
|
||||
|
||||
|
||||
def running_traefik?
|
||||
if specializations["traefik"].nil?
|
||||
primary?
|
||||
else
|
||||
specializations["traefik"]
|
||||
end
|
||||
end
|
||||
|
||||
def primary?
|
||||
name == @config.primary_role_name
|
||||
self == @config.primary_role
|
||||
end
|
||||
|
||||
|
||||
def uses_cord?
|
||||
running_traefik? && cord_volume && healthcheck.cmd.present?
|
||||
end
|
||||
|
||||
def cord_host_directory
|
||||
File.join config.run_directory_as_docker_volume, "cords", [ container_prefix, config.run_id ].join("-")
|
||||
end
|
||||
|
||||
def cord_volume
|
||||
if (cord = healthcheck.cord)
|
||||
@cord_volume ||= Kamal::Configuration::Volume.new \
|
||||
host_path: File.join(config.run_directory, "cords", [ container_prefix, config.run_id ].join("-")),
|
||||
container_path: cord
|
||||
end
|
||||
end
|
||||
|
||||
def cord_host_file
|
||||
File.join cord_volume.host_path, CORD_FILE
|
||||
end
|
||||
|
||||
def cord_container_directory
|
||||
health_check_options.fetch("cord", nil)
|
||||
end
|
||||
|
||||
def cord_container_file
|
||||
File.join cord_volume.container_path, CORD_FILE
|
||||
end
|
||||
|
||||
|
||||
@@ -131,52 +168,25 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def assets?
|
||||
asset_path.present? && running_proxy?
|
||||
asset_path.present? && running_traefik?
|
||||
end
|
||||
|
||||
def asset_volume(version = config.version)
|
||||
def asset_volume(version = nil)
|
||||
if assets?
|
||||
Kamal::Configuration::Volume.new \
|
||||
host_path: asset_volume_directory(version), container_path: asset_path
|
||||
host_path: asset_volume_path(version), container_path: asset_path
|
||||
end
|
||||
end
|
||||
|
||||
def asset_extracted_directory(version = config.version)
|
||||
File.join config.assets_directory, "extracted", [ name, version ].join("-")
|
||||
def asset_extracted_path(version = nil)
|
||||
File.join config.run_directory, "assets", "extracted", container_name(version)
|
||||
end
|
||||
|
||||
def asset_volume_directory(version = config.version)
|
||||
File.join config.assets_directory, "volumes", [ name, version ].join("-")
|
||||
end
|
||||
|
||||
def ensure_one_host_for_ssl
|
||||
if running_proxy? && proxy.ssl? && hosts.size > 1
|
||||
raise Kamal::ConfigurationError, "SSL is only supported on a single server, found #{hosts.size} servers for role #{name}"
|
||||
end
|
||||
def asset_volume_path(version = nil)
|
||||
File.join config.run_directory, "assets", "volumes", container_name(version)
|
||||
end
|
||||
|
||||
private
|
||||
def initialize_specialized_proxy
|
||||
proxy_specializations = specializations["proxy"]
|
||||
|
||||
if primary?
|
||||
# only false means no proxy for non-primary roles
|
||||
@running_proxy = proxy_specializations != false
|
||||
else
|
||||
# false and nil both mean no proxy for non-primary roles
|
||||
@running_proxy = !!proxy_specializations
|
||||
end
|
||||
|
||||
if running_proxy?
|
||||
proxy_config = proxy_specializations == true || proxy_specializations.nil? ? {} : proxy_specializations
|
||||
|
||||
@specialized_proxy = Kamal::Configuration::Proxy.new \
|
||||
config: config,
|
||||
proxy_config: proxy_config,
|
||||
context: "servers/#{name}/proxy"
|
||||
end
|
||||
end
|
||||
|
||||
def tagged_hosts
|
||||
{}.tap do |tagged_hosts|
|
||||
extract_hosts_from_config.map do |host_config|
|
||||
@@ -204,11 +214,32 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def specializations
|
||||
@specializations ||= role_config.is_a?(Array) ? {} : role_config
|
||||
if config.raw_config.servers.is_a?(Array) || config.raw_config.servers[name].is_a?(Array)
|
||||
{}
|
||||
else
|
||||
config.raw_config.servers[name]
|
||||
end
|
||||
end
|
||||
|
||||
def role_config
|
||||
@role_config ||= config.raw_config.servers.is_a?(Array) ? {} : config.raw_config.servers[name]
|
||||
def traefik_labels
|
||||
if running_traefik?
|
||||
{
|
||||
# Setting a service property ensures that the generated service name will be consistent between versions
|
||||
"traefik.http.services.#{traefik_service}.loadbalancer.server.scheme" => "http",
|
||||
|
||||
"traefik.http.routers.#{traefik_service}.rule" => "PathPrefix(`/`)",
|
||||
"traefik.http.routers.#{traefik_service}.priority" => "2",
|
||||
"traefik.http.middlewares.#{traefik_service}-retry.retry.attempts" => "5",
|
||||
"traefik.http.middlewares.#{traefik_service}-retry.retry.initialinterval" => "500ms",
|
||||
"traefik.http.routers.#{traefik_service}.middlewares" => "#{traefik_service}-retry@docker"
|
||||
}
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
def traefik_service
|
||||
container_prefix
|
||||
end
|
||||
|
||||
def custom_labels
|
||||
|
||||
60
lib/kamal/configuration/traefik.rb
Normal file
60
lib/kamal/configuration/traefik.rb
Normal file
@@ -0,0 +1,60 @@
|
||||
class Kamal::Configuration::Traefik
|
||||
DEFAULT_IMAGE = "traefik:v2.10"
|
||||
CONTAINER_PORT = 80
|
||||
DEFAULT_ARGS = {
|
||||
"log.level" => "DEBUG"
|
||||
}
|
||||
DEFAULT_LABELS = {
|
||||
# These ensure we serve a 502 rather than a 404 if no containers are available
|
||||
"traefik.http.routers.catchall.entryPoints" => "http",
|
||||
"traefik.http.routers.catchall.rule" => "PathPrefix(`/`)",
|
||||
"traefik.http.routers.catchall.service" => "unavailable",
|
||||
"traefik.http.routers.catchall.priority" => 1,
|
||||
"traefik.http.services.unavailable.loadbalancer.server.port" => "0"
|
||||
}
|
||||
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :config, :traefik_config
|
||||
|
||||
def initialize(config:)
|
||||
@config = config
|
||||
@traefik_config = config.raw_config.traefik || {}
|
||||
validate! traefik_config
|
||||
end
|
||||
|
||||
def publish?
|
||||
traefik_config["publish"] != false
|
||||
end
|
||||
|
||||
def labels
|
||||
DEFAULT_LABELS.merge(traefik_config["labels"] || {})
|
||||
end
|
||||
|
||||
def env
|
||||
Kamal::Configuration::Env.new \
|
||||
config: traefik_config.fetch("env", {}),
|
||||
secrets_file: File.join(config.host_env_directory, "traefik", "traefik.env"),
|
||||
context: "traefik/env"
|
||||
end
|
||||
|
||||
def host_port
|
||||
traefik_config.fetch("host_port", CONTAINER_PORT)
|
||||
end
|
||||
|
||||
def options
|
||||
traefik_config.fetch("options", {})
|
||||
end
|
||||
|
||||
def port
|
||||
"#{host_port}:#{CONTAINER_PORT}"
|
||||
end
|
||||
|
||||
def args
|
||||
DEFAULT_ARGS.merge(traefik_config.fetch("args", {}))
|
||||
end
|
||||
|
||||
def image
|
||||
traefik_config.fetch("image", DEFAULT_IMAGE)
|
||||
end
|
||||
end
|
||||
@@ -13,40 +13,32 @@ class Kamal::Configuration::Validator
|
||||
|
||||
private
|
||||
def validate_against_example!(validation_config, example)
|
||||
validate_type! validation_config, example.class
|
||||
validate_type! validation_config, Hash
|
||||
|
||||
if example.class == Hash
|
||||
check_unknown_keys! validation_config, example
|
||||
check_unknown_keys! validation_config, example
|
||||
|
||||
validation_config.each do |key, value|
|
||||
next if extension?(key)
|
||||
with_context(key) do
|
||||
example_value = example[key]
|
||||
validation_config.each do |key, value|
|
||||
next if extension?(key)
|
||||
with_context(key) do
|
||||
example_value = example[key]
|
||||
|
||||
if example_value == "..."
|
||||
unless key.to_s == "proxy" && boolean?(value.class)
|
||||
validate_type! value, *(Array if key == :servers), Hash
|
||||
end
|
||||
elsif key == "hosts"
|
||||
validate_servers! value
|
||||
elsif example_value.is_a?(Array)
|
||||
if key == "arch"
|
||||
validate_array_of_or_type! value, example_value.first.class
|
||||
else
|
||||
validate_array_of! value, example_value.first.class
|
||||
end
|
||||
elsif example_value.is_a?(Hash)
|
||||
case key.to_s
|
||||
when "options", "args"
|
||||
validate_type! value, Hash
|
||||
when "labels"
|
||||
validate_hash_of! value, example_value.first[1].class
|
||||
else
|
||||
validate_against_example! value, example_value
|
||||
end
|
||||
if example_value == "..."
|
||||
validate_type! value, *(Array if key == :servers), Hash
|
||||
elsif key == "hosts"
|
||||
validate_servers! value
|
||||
elsif example_value.is_a?(Array)
|
||||
validate_array_of! value, example_value.first.class
|
||||
elsif example_value.is_a?(Hash)
|
||||
case key.to_s
|
||||
when "options", "args"
|
||||
validate_type! value, Hash
|
||||
when "labels"
|
||||
validate_hash_of! value, example_value.first[1].class
|
||||
else
|
||||
validate_type! value, example_value.class
|
||||
validate_against_example! value, example_value
|
||||
end
|
||||
else
|
||||
validate_type! value, example_value.class
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -77,16 +69,6 @@ class Kamal::Configuration::Validator
|
||||
value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
|
||||
end
|
||||
|
||||
def validate_array_of_or_type!(value, type)
|
||||
if value.is_a?(Array)
|
||||
validate_array_of! value, type
|
||||
else
|
||||
validate_type! value, type
|
||||
end
|
||||
rescue Kamal::ConfigurationError
|
||||
type_error(Array, type)
|
||||
end
|
||||
|
||||
def validate_array_of!(array, type)
|
||||
validate_type! array, Array
|
||||
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
class Kamal::Configuration::Validator::Alias < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
super
|
||||
|
||||
name = context.delete_prefix("aliases/")
|
||||
|
||||
if name !~ /\A[a-z0-9_-]+\z/
|
||||
error "Invalid alias name: '#{name}'. Must only contain lowercase letters, alphanumeric, hyphens and underscores."
|
||||
end
|
||||
|
||||
if Kamal::Cli::Main.commands.include?(name)
|
||||
error "Alias '#{name}' conflicts with a built-in command."
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -5,9 +5,5 @@ class Kamal::Configuration::Validator::Builder < Kamal::Configuration::Validator
|
||||
if config["cache"] && config["cache"]["type"]
|
||||
error "Invalid cache type: #{config["cache"]["type"]}" unless [ "gha", "registry" ].include?(config["cache"]["type"])
|
||||
end
|
||||
|
||||
error "Builder arch not set" unless config["arch"].present?
|
||||
|
||||
error "Cannot disable local builds, no remote is set" if config["local"] == false && config["remote"].blank?
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
unless config.nil?
|
||||
super
|
||||
|
||||
if config["host"].blank? && config["hosts"].blank? && config["ssl"]
|
||||
error "Must set a host to enable automatic SSL"
|
||||
end
|
||||
|
||||
if (config.keys & [ "host", "hosts" ]).size > 1
|
||||
error "Specify one of 'host' or 'hosts', not both"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -3,7 +3,7 @@ class Kamal::Configuration::Validator::Role < Kamal::Configuration::Validator
|
||||
validate_type! config, Array, Hash
|
||||
|
||||
if config.is_a?(Array)
|
||||
validate_servers!(config)
|
||||
validate_servers! "servers", config
|
||||
else
|
||||
super
|
||||
end
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user