Compare commits
162 Commits
parachute
...
proxy-expe
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b0f5997aef | ||
|
|
85f62ebc22 | ||
|
|
e0df051756 | ||
|
|
0b22fea8a9 | ||
|
|
f088e0cb64 | ||
|
|
9b673c2114 | ||
|
|
e0d336dc11 | ||
|
|
1422ecaeb8 | ||
|
|
f8de2898c9 | ||
|
|
0cd1a4fb07 | ||
|
|
4381f3bc5f | ||
|
|
35de0891c0 | ||
|
|
fb9c8f16f1 | ||
|
|
d92b3628f4 | ||
|
|
4732543eca | ||
|
|
e58d33b389 | ||
|
|
97b842fcee | ||
|
|
98eb38f11c | ||
|
|
805fc1554e | ||
|
|
61715e0a4b | ||
|
|
debdf00cca | ||
|
|
9089c41f30 | ||
|
|
c9946808b1 | ||
|
|
deb2a6d298 | ||
|
|
0cb69a84f5 | ||
|
|
aa630f156a | ||
|
|
63d0b5ddfa | ||
|
|
06f4caa866 | ||
|
|
5aa3d1aeb0 | ||
|
|
a4d668cd39 | ||
|
|
7156c80f34 | ||
|
|
aed2ef99d0 | ||
|
|
57cbf7cdb5 | ||
|
|
b99c044327 | ||
|
|
8ad6a0ed16 | ||
|
|
8b62e2694a | ||
|
|
be1df4356a | ||
|
|
8210e8e768 | ||
|
|
9b96ef2412 | ||
|
|
1522d94ac9 | ||
|
|
a68294c384 | ||
|
|
31a347c285 | ||
|
|
3d502ab12d | ||
|
|
5226d52f8a | ||
|
|
9deb8af4a0 | ||
|
|
068aaa0bd0 | ||
|
|
a726a86a17 | ||
|
|
b2e1a4d4c1 | ||
|
|
9ade79fc84 | ||
|
|
79731da619 | ||
|
|
0ae8046905 | ||
|
|
d5ecca0fd4 | ||
|
|
0c6a593554 | ||
|
|
3f37fea7c3 | ||
|
|
7daaabd4d4 | ||
|
|
fcdef5fa06 | ||
|
|
5480b40ba3 | ||
|
|
1d0e81b00a | ||
|
|
5910249d02 | ||
|
|
b464c4fd4a | ||
|
|
56754fe40c | ||
|
|
6a06efc9d9 | ||
|
|
5c4c33e0a8 | ||
|
|
0b5506f6f2 | ||
|
|
a2549b1f60 | ||
|
|
9b9e60ec7f | ||
|
|
e557eea79c | ||
|
|
d7e785cd36 | ||
|
|
5cda3086c4 | ||
|
|
362f5d00f6 | ||
|
|
6adf3c117f | ||
|
|
9f0b10425c | ||
|
|
5f2384f123 | ||
|
|
eab7d3adc5 | ||
|
|
d2d0223c37 | ||
|
|
56268d724d | ||
|
|
cffb6c3d7e | ||
|
|
bd1726f305 | ||
|
|
7ddb122a22 | ||
|
|
98c951bbdb | ||
|
|
374c117b79 | ||
|
|
d6a5cf3c78 | ||
|
|
2aeabda455 | ||
|
|
c048c097ed | ||
|
|
ed148628fb | ||
|
|
d48080c772 | ||
|
|
3f64338929 | ||
|
|
0ab838bc25 | ||
|
|
b7382ceeaf | ||
|
|
69367fbc6b | ||
|
|
2515bd705c | ||
|
|
579e169be2 | ||
|
|
d6f5da92be | ||
|
|
9ccfe20b10 | ||
|
|
e871d347d5 | ||
|
|
b8af719bb7 | ||
|
|
f48987aa03 | ||
|
|
ef051eca1b | ||
|
|
173d44ee0a | ||
|
|
4e811372f8 | ||
|
|
ec4aa45852 | ||
|
|
5e11a64181 | ||
|
|
57d9ce177a | ||
|
|
b12de87388 | ||
|
|
8a98949634 | ||
|
|
0eb9f48082 | ||
|
|
9db6fc0704 | ||
|
|
27fede3caa | ||
|
|
29c723f7ec | ||
|
|
2755582c47 | ||
|
|
fa73d722ea | ||
|
|
c535e4e44f | ||
|
|
0ea07b1760 | ||
|
|
03b531f179 | ||
|
|
d8570d1c2c | ||
|
|
3fe70b458d | ||
|
|
ade8b43599 | ||
|
|
d24fc3ca4e | ||
|
|
7c244bbb98 | ||
|
|
1369c46a83 | ||
|
|
deccf1cfaf | ||
|
|
1573cebadf | ||
|
|
85a2926cde | ||
|
|
58a51b079e | ||
|
|
f1f3fc566f | ||
|
|
44726ff65a | ||
|
|
fd0d4af21f | ||
|
|
13409ada5a | ||
|
|
9a1379be6c | ||
|
|
31d6c198da | ||
|
|
22afe4de77 | ||
|
|
b63982c3a7 | ||
|
|
9e12d32cc3 | ||
|
|
ff03891d47 | ||
|
|
f21dc30875 | ||
|
|
69fa7286e2 | ||
|
|
e160852e4d | ||
|
|
4697f89441 | ||
|
|
dde637ffff | ||
|
|
f8f88af534 | ||
|
|
f6a9698f55 | ||
|
|
3da7fad9ee | ||
|
|
1109a864d0 | ||
|
|
da599d90c1 | ||
|
|
6bf3f4888a | ||
|
|
0a6b0b7133 | ||
|
|
6d6670a221 | ||
|
|
10e3229d7c | ||
|
|
c7bd377fa5 | ||
|
|
bdd951b756 | ||
|
|
080897dc4d | ||
|
|
d652221100 | ||
|
|
00e0e5073e | ||
|
|
b52e66814a | ||
|
|
29fbe7a98f | ||
|
|
4f317b8499 | ||
|
|
6e60ab918a | ||
|
|
90ecb6a12a | ||
|
|
2c2053558a | ||
|
|
beac539d8c | ||
|
|
eb79d93139 | ||
|
|
89994c8b20 |
13
.github/workflows/ci.yml
vendored
13
.github/workflows/ci.yml
vendored
@@ -24,25 +24,12 @@ jobs:
|
||||
strategy:
|
||||
matrix:
|
||||
ruby-version:
|
||||
- "2.7"
|
||||
- "3.1"
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
gemfile:
|
||||
- Gemfile
|
||||
- gemfiles/ruby_2.7.gemfile
|
||||
- gemfiles/rails_edge.gemfile
|
||||
exclude:
|
||||
- ruby-version: "2.7"
|
||||
gemfile: Gemfile
|
||||
- ruby-version: "2.7"
|
||||
gemfile: gemfiles/rails_edge.gemfile
|
||||
- ruby-version: "3.1"
|
||||
gemfile: gemfiles/ruby_2.7.gemfile
|
||||
- ruby-version: "3.2"
|
||||
gemfile: gemfiles/ruby_2.7.gemfile
|
||||
- ruby-version: "3.3"
|
||||
gemfile: gemfiles/ruby_2.7.gemfile
|
||||
name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
|
||||
@@ -14,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 --update build-base git docker openrc openssh-client-default \
|
||||
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
|
||||
|
||||
114
Gemfile.lock
114
Gemfile.lock
@@ -1,24 +1,24 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
kamal (1.5.2)
|
||||
kamal (2.0.0.alpha)
|
||||
activesupport (>= 7.0)
|
||||
base64 (~> 0.2)
|
||||
bcrypt_pbkdf (~> 1.0)
|
||||
concurrent-ruby (~> 1.2)
|
||||
dotenv (~> 2.8)
|
||||
dotenv (~> 3.1)
|
||||
ed25519 (~> 1.2)
|
||||
net-ssh (~> 7.0)
|
||||
sshkit (>= 1.22.2, < 2.0)
|
||||
thor (~> 1.2)
|
||||
sshkit (>= 1.23.0, < 2.0)
|
||||
thor (~> 1.3)
|
||||
zeitwerk (~> 2.5)
|
||||
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
actionpack (7.1.2)
|
||||
actionview (= 7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
actionpack (7.1.3.4)
|
||||
actionview (= 7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
nokogiri (>= 1.8.5)
|
||||
racc
|
||||
rack (>= 2.2.4)
|
||||
@@ -26,13 +26,13 @@ GEM
|
||||
rack-test (>= 0.6.3)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
actionview (7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
actionview (7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
builder (~> 3.1)
|
||||
erubi (~> 1.11)
|
||||
rails-dom-testing (~> 2.2)
|
||||
rails-html-sanitizer (~> 1.6)
|
||||
activesupport (7.1.2)
|
||||
activesupport (7.1.3.4)
|
||||
base64
|
||||
bigdecimal
|
||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
||||
@@ -44,54 +44,55 @@ GEM
|
||||
tzinfo (~> 2.0)
|
||||
ast (2.4.2)
|
||||
base64 (0.2.0)
|
||||
bcrypt_pbkdf (1.1.0)
|
||||
bigdecimal (3.1.5)
|
||||
builder (3.2.4)
|
||||
concurrent-ruby (1.2.2)
|
||||
bcrypt_pbkdf (1.1.1)
|
||||
bcrypt_pbkdf (1.1.1-arm64-darwin)
|
||||
bcrypt_pbkdf (1.1.1-x86_64-darwin)
|
||||
bigdecimal (3.1.8)
|
||||
builder (3.3.0)
|
||||
concurrent-ruby (1.3.3)
|
||||
connection_pool (2.4.1)
|
||||
crass (1.0.6)
|
||||
debug (1.9.1)
|
||||
debug (1.9.2)
|
||||
irb (~> 1.10)
|
||||
reline (>= 0.3.8)
|
||||
dotenv (2.8.1)
|
||||
drb (2.2.0)
|
||||
ruby2_keywords
|
||||
dotenv (3.1.2)
|
||||
drb (2.2.1)
|
||||
ed25519 (1.3.0)
|
||||
erubi (1.12.0)
|
||||
i18n (1.14.1)
|
||||
erubi (1.13.0)
|
||||
i18n (1.14.5)
|
||||
concurrent-ruby (~> 1.0)
|
||||
io-console (0.7.1)
|
||||
irb (1.11.0)
|
||||
rdoc
|
||||
reline (>= 0.3.8)
|
||||
json (2.7.1)
|
||||
io-console (0.7.2)
|
||||
irb (1.14.0)
|
||||
rdoc (>= 4.0.0)
|
||||
reline (>= 0.4.2)
|
||||
json (2.7.2)
|
||||
language_server-protocol (3.17.0.3)
|
||||
loofah (2.22.0)
|
||||
crass (~> 1.0.2)
|
||||
nokogiri (>= 1.12.0)
|
||||
minitest (5.20.0)
|
||||
mocha (2.1.0)
|
||||
minitest (5.24.1)
|
||||
mocha (2.4.5)
|
||||
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.2.1)
|
||||
nokogiri (1.16.0-arm64-darwin)
|
||||
net-ssh (7.2.3)
|
||||
nokogiri (1.16.7-arm64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.16.0-x86_64-darwin)
|
||||
nokogiri (1.16.7-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.16.0-x86_64-linux)
|
||||
nokogiri (1.16.7-x86_64-linux)
|
||||
racc (~> 1.4)
|
||||
parallel (1.24.0)
|
||||
parser (3.3.0.5)
|
||||
parallel (1.25.1)
|
||||
parser (3.3.4.0)
|
||||
ast (~> 2.4.1)
|
||||
racc
|
||||
psych (5.1.2)
|
||||
stringio
|
||||
racc (1.7.3)
|
||||
rack (3.0.8)
|
||||
racc (1.8.1)
|
||||
rack (3.1.7)
|
||||
rack-session (2.0.0)
|
||||
rack (>= 3.0.0)
|
||||
rack-test (2.1.0)
|
||||
@@ -106,42 +107,43 @@ GEM
|
||||
rails-html-sanitizer (1.6.0)
|
||||
loofah (~> 2.21)
|
||||
nokogiri (~> 1.14)
|
||||
railties (7.1.2)
|
||||
actionpack (= 7.1.2)
|
||||
activesupport (= 7.1.2)
|
||||
railties (7.1.3.4)
|
||||
actionpack (= 7.1.3.4)
|
||||
activesupport (= 7.1.3.4)
|
||||
irb
|
||||
rackup (>= 1.0.0)
|
||||
rake (>= 12.2)
|
||||
thor (~> 1.0, >= 1.2.2)
|
||||
zeitwerk (~> 2.6)
|
||||
rainbow (3.1.1)
|
||||
rake (13.1.0)
|
||||
rdoc (6.6.2)
|
||||
rake (13.2.1)
|
||||
rdoc (6.7.0)
|
||||
psych (>= 4.0.0)
|
||||
regexp_parser (2.9.0)
|
||||
reline (0.4.2)
|
||||
regexp_parser (2.9.2)
|
||||
reline (0.5.9)
|
||||
io-console (~> 0.5)
|
||||
rexml (3.2.6)
|
||||
rubocop (1.62.1)
|
||||
rexml (3.3.4)
|
||||
strscan
|
||||
rubocop (1.65.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 (>= 1.8, < 3.0)
|
||||
regexp_parser (>= 2.4, < 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, < 3.0)
|
||||
rubocop-ast (1.31.2)
|
||||
parser (>= 3.3.0.4)
|
||||
rubocop-minitest (0.35.0)
|
||||
rubocop-ast (1.32.0)
|
||||
parser (>= 3.3.1.0)
|
||||
rubocop-minitest (0.35.1)
|
||||
rubocop (>= 1.61, < 2.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-performance (1.20.2)
|
||||
rubocop-performance (1.21.1)
|
||||
rubocop (>= 1.48.1, < 2.0)
|
||||
rubocop-ast (>= 1.30.0, < 2.0)
|
||||
rubocop-rails (2.24.0)
|
||||
rubocop-ast (>= 1.31.1, < 2.0)
|
||||
rubocop-rails (2.25.1)
|
||||
activesupport (>= 4.2.0)
|
||||
rack (>= 1.1)
|
||||
rubocop (>= 1.33.0, < 2.0)
|
||||
@@ -153,19 +155,19 @@ GEM
|
||||
rubocop-rails
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
sshkit (1.22.2)
|
||||
sshkit (1.23.0)
|
||||
base64
|
||||
mutex_m
|
||||
net-scp (>= 1.1.2)
|
||||
net-sftp (>= 2.1.2)
|
||||
net-ssh (>= 2.8.0)
|
||||
stringio (3.1.0)
|
||||
thor (1.3.0)
|
||||
stringio (3.1.1)
|
||||
strscan (3.1.0)
|
||||
thor (1.3.1)
|
||||
tzinfo (2.0.6)
|
||||
concurrent-ruby (~> 1.0)
|
||||
unicode-display_width (2.5.0)
|
||||
webrick (1.8.1)
|
||||
zeitwerk (2.6.12)
|
||||
zeitwerk (2.6.17)
|
||||
|
||||
PLATFORMS
|
||||
arm64-darwin
|
||||
|
||||
137
bin/docs
Executable file
137
bin/docs
Executable file
@@ -0,0 +1,137 @@
|
||||
#!/usr/bin/env ruby
|
||||
require "stringio"
|
||||
|
||||
def usage
|
||||
puts "Usage: #{$0} <kamal_site_repo>"
|
||||
exit 1
|
||||
end
|
||||
|
||||
usage if ARGV.size != 1
|
||||
|
||||
kamal_site_repo = ARGV[0]
|
||||
|
||||
if !File.directory?(kamal_site_repo)
|
||||
puts "Error: #{kamal_site_repo} is not a directory"
|
||||
exit 1
|
||||
end
|
||||
|
||||
DOCS = {
|
||||
"accessory" => "Accessories",
|
||||
"alias" => "Aliases",
|
||||
"boot" => "Booting",
|
||||
"builder" => "Builders",
|
||||
"configuration" => "Configuration overview",
|
||||
"env" => "Environment variables",
|
||||
"healthcheck" => "Healthchecks",
|
||||
"logging" => "Logging",
|
||||
"proxy" => "Proxy (Experimental)",
|
||||
"registry" => "Docker Registry",
|
||||
"role" => "Roles",
|
||||
"servers" => "Servers",
|
||||
"ssh" => "SSH",
|
||||
"sshkit" => "SSHKit",
|
||||
"traefik" => "Traefik"
|
||||
}
|
||||
|
||||
class DocWriter
|
||||
attr_reader :from_file, :to_file, :key, :heading, :body, :output, :in_yaml
|
||||
|
||||
def initialize(from_file, to_dir)
|
||||
@from_file = from_file
|
||||
@key = File.basename(from_file, ".yml")
|
||||
@to_file = File.join(to_dir, "#{linkify(DOCS[key])}.md")
|
||||
@body = File.readlines(from_file)
|
||||
@heading = body.shift.chomp("\n")
|
||||
@output = nil
|
||||
end
|
||||
|
||||
def write
|
||||
puts "Writing #{to_file}"
|
||||
generate_markdown
|
||||
File.write(to_file, output.string)
|
||||
end
|
||||
|
||||
private
|
||||
def generate_markdown
|
||||
@output = StringIO.new
|
||||
|
||||
generate_header
|
||||
|
||||
place = :in_section
|
||||
|
||||
loop do
|
||||
line = body.shift&.chomp("\n")
|
||||
break if line.nil?
|
||||
|
||||
case place
|
||||
when :new_section, :in_section
|
||||
if line.empty?
|
||||
output.puts
|
||||
place = :new_section
|
||||
elsif line =~ /^ *#/
|
||||
generate_line(line, heading: place == :new_section)
|
||||
place = :in_section
|
||||
else
|
||||
output.puts "```yaml"
|
||||
output.puts line
|
||||
place = :in_yaml
|
||||
end
|
||||
when :in_yaml, :in_empty_line_yaml
|
||||
if line =~ /^ *#/
|
||||
output.puts "```"
|
||||
generate_line(line, heading: place == :in_empty_line_yaml)
|
||||
place = :in_section
|
||||
elsif line.empty?
|
||||
place = :in_empty_line_yaml
|
||||
else
|
||||
output.puts line
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
output.puts "```" if place == :in_yaml
|
||||
end
|
||||
|
||||
def generate_header
|
||||
output.puts "---"
|
||||
output.puts "title: #{heading[2..-1]}"
|
||||
output.puts "---"
|
||||
output.puts
|
||||
output.puts heading
|
||||
output.puts
|
||||
end
|
||||
|
||||
def generate_line(line, heading: false)
|
||||
line = line.gsub(/^ *#\s?/, "")
|
||||
|
||||
if line =~ /(.*)kamal docs ([a-z]*)(.*)/
|
||||
line = "#{$1}[#{DOCS[$2]}](../#{linkify(DOCS[$2])})#{$3}"
|
||||
end
|
||||
|
||||
if line =~ /(.*)https:\/\/kamal-deploy.org([a-z\/-]*)(.*)/
|
||||
line = "#{$1}[#{titlify($2.split("/").last)}](#{$2})#{$3}"
|
||||
end
|
||||
|
||||
if heading
|
||||
output.puts "## [#{line}](##{linkify(line)})"
|
||||
else
|
||||
output.puts line
|
||||
end
|
||||
end
|
||||
|
||||
def linkify(text)
|
||||
text.downcase.gsub(" ", "-")
|
||||
end
|
||||
|
||||
def titlify(text)
|
||||
text.capitalize.gsub("-", " ")
|
||||
end
|
||||
end
|
||||
|
||||
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
|
||||
@@ -1,6 +0,0 @@
|
||||
source 'https://rubygems.org'
|
||||
git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
gem "nokogiri", "~> 1.15.0"
|
||||
@@ -12,10 +12,10 @@ Gem::Specification.new do |spec|
|
||||
spec.executables = %w[ kamal ]
|
||||
|
||||
spec.add_dependency "activesupport", ">= 7.0"
|
||||
spec.add_dependency "sshkit", ">= 1.22.2", "< 2.0"
|
||||
spec.add_dependency "sshkit", ">= 1.23.0", "< 2.0"
|
||||
spec.add_dependency "net-ssh", "~> 7.0"
|
||||
spec.add_dependency "thor", "~> 1.2"
|
||||
spec.add_dependency "dotenv", "~> 2.8"
|
||||
spec.add_dependency "thor", "~> 1.3"
|
||||
spec.add_dependency "dotenv", "~> 3.1"
|
||||
spec.add_dependency "zeitwerk", "~> 2.5"
|
||||
spec.add_dependency "ed25519", "~> 1.2"
|
||||
spec.add_dependency "bcrypt_pbkdf", "~> 1.0"
|
||||
|
||||
@@ -1,10 +1,14 @@
|
||||
module Kamal
|
||||
class ConfigurationError < StandardError; end
|
||||
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 # We need all commands loaded.
|
||||
loader.eager_load_namespace(Kamal::Cli) # We need all commands loaded.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
module Kamal::Cli
|
||||
class LockError < StandardError; end
|
||||
class BootError < StandardError; end
|
||||
class HookError < StandardError; end
|
||||
class LockError < StandardError; end
|
||||
end
|
||||
|
||||
# SSHKit uses instance eval, so we need a global const for ergonomics
|
||||
|
||||
@@ -1,17 +1,20 @@
|
||||
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, login: true)
|
||||
def boot(name, prepare: 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
|
||||
end
|
||||
end
|
||||
@@ -55,15 +58,10 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
if name == "all"
|
||||
KAMAL.accessory_names.each { |accessory_name| reboot(accessory_name) }
|
||||
else
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
on(hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
end
|
||||
|
||||
prepare(name)
|
||||
stop(name)
|
||||
remove_container(name)
|
||||
boot(name, login: false)
|
||||
end
|
||||
boot(name, prepare: false)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -95,12 +93,10 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
desc "restart [NAME]", "Restart existing accessory container on host"
|
||||
def restart(name)
|
||||
with_lock do
|
||||
with_accessory(name) do
|
||||
stop(name)
|
||||
start(name)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "details [NAME]", "Show details about accessory on host (use NAME=all to show all accessories)"
|
||||
def details(name)
|
||||
@@ -149,23 +145,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, 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(name)
|
||||
with_accessory(name) do |accessory, hosts|
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{hosts}..."
|
||||
info accessory.follow_logs(grep: grep)
|
||||
exec accessory.follow_logs(grep: grep)
|
||||
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(since: since, lines: lines, grep: grep))
|
||||
puts capture_with_info(*accessory.logs(since: since, lines: lines, grep: grep, grep_options: grep_options))
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -247,11 +245,20 @@ class Kamal::Cli::Accessory < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
def remove_accessory(name)
|
||||
with_accessory(name) do
|
||||
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
|
||||
execute *KAMAL.docker.create_network
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise unless e.message.include?("already exists")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
9
lib/kamal/cli/alias/command.rb
Normal file
9
lib/kamal/cli/alias/command.rb
Normal file
@@ -0,0 +1,9 @@
|
||||
class Kamal::Cli::Alias::Command < Thor::DynamicCommand
|
||||
def run(instance, args = [])
|
||||
if (_alias = KAMAL.config.aliases[name])
|
||||
Kamal::Cli::Main.start(Shellwords.split(_alias.command) + ARGV[1..-1])
|
||||
else
|
||||
super
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -14,7 +14,7 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
# Primary hosts and roles are returned first, so they can open the barrier
|
||||
barrier = Kamal::Cli::Healthcheck::Barrier.new if KAMAL.roles.many?
|
||||
barrier = Kamal::Cli::Healthcheck::Barrier.new
|
||||
|
||||
on(KAMAL.hosts, **KAMAL.boot_strategy) do |host|
|
||||
KAMAL.roles_on(host).each do |role|
|
||||
@@ -38,8 +38,17 @@ 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 *KAMAL.app(role: role, host: host).start, raise_on_non_zero_exit: false
|
||||
execute *app.start, raise_on_non_zero_exit: false
|
||||
|
||||
if role.running_traefik? && KAMAL.proxy_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
|
||||
raise Kamal::Cli::BootError, "Failed to get endpoint for #{role} on #{host}, did the container boot?" if endpoint.empty?
|
||||
|
||||
execute *KAMAL.proxy.deploy(role.container_prefix, target: endpoint)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -52,8 +61,18 @@ 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
|
||||
execute *KAMAL.app(role: role, host: host).stop, raise_on_non_zero_exit: false
|
||||
|
||||
if role.running_traefik? && KAMAL.proxy_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?
|
||||
execute *KAMAL.proxy.remove(role.container_prefix, target: endpoint), raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
|
||||
execute *app.stop, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -71,11 +90,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"
|
||||
def exec(cmd)
|
||||
def exec(*cmd)
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
env = options[:env]
|
||||
case
|
||||
when options[:interactive] && options[:reuse]
|
||||
@@ -166,12 +186,15 @@ 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, aliases: "-o", desc: "Additional options supplied to grep"
|
||||
option :follow, aliases: "-f", desc: "Follow log on primary server (or specific host set by --hosts)"
|
||||
def logs
|
||||
# FIXME: Catch when app containers aren't running
|
||||
|
||||
grep = options[:grep]
|
||||
grep_options = options[:grep_options]
|
||||
since = options[:since]
|
||||
|
||||
if options[:follow]
|
||||
lines = options[:lines].presence || ((since || grep) ? nil : 10) # Default to 10 lines if since or grep isn't set
|
||||
|
||||
@@ -182,8 +205,8 @@ class Kamal::Cli::App < Kamal::Cli::Base
|
||||
role = KAMAL.roles_on(KAMAL.primary_host).first
|
||||
|
||||
app = KAMAL.app(role: role, host: host)
|
||||
info app.follow_logs(host: KAMAL.primary_host, lines: lines, grep: grep)
|
||||
exec app.follow_logs(host: KAMAL.primary_host, lines: lines, grep: grep)
|
||||
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
|
||||
@@ -193,7 +216,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(since: since, lines: lines, grep: grep))
|
||||
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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
class Kamal::Cli::App::Boot
|
||||
attr_reader :host, :role, :version, :barrier, :sshkit
|
||||
delegate :execute, :capture_with_info, :capture_with_pretty_json, :info, :error, to: :sshkit
|
||||
delegate :execute, :capture_with_info, :capture_with_pretty_json, :info, :error, :upload!, to: :sshkit
|
||||
delegate :uses_cord?, :assets?, :running_traefik?, to: :role
|
||||
|
||||
def initialize(host, role, sshkit, version, barrier)
|
||||
@@ -45,19 +45,33 @@ class Kamal::Cli::App::Boot
|
||||
|
||||
def start_new_version
|
||||
audit "Booted app version #{version}"
|
||||
|
||||
execute *app.tie_cord(role.cord_host_file) if uses_cord?
|
||||
hostname = "#{host.to_s[0...51].gsub(/\.+$/, '')}-#{SecureRandom.hex(6)}"
|
||||
|
||||
execute *app.ensure_env_directory
|
||||
upload! role.secrets_io(host), role.secrets_path, mode: "0600"
|
||||
|
||||
if proxy_host?
|
||||
execute *app.run_for_proxy(hostname: hostname)
|
||||
if running_traefik?
|
||||
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 *KAMAL.proxy.deploy(role.container_prefix, target: endpoint)
|
||||
else
|
||||
Kamal::Cli::Healthcheck::Poller.wait_for_healthy(pause_after_ready: true) { capture_with_info(*app.status(version: version)) }
|
||||
end
|
||||
else
|
||||
execute *app.tie_cord(role.cord_host_file) if uses_cord?
|
||||
execute *app.run(hostname: hostname)
|
||||
Kamal::Cli::Healthcheck::Poller.wait_for_healthy(pause_after_ready: true) { capture_with_info(*app.status(version: version)) }
|
||||
end
|
||||
end
|
||||
|
||||
def stop_new_version
|
||||
execute *app.stop(version: version), raise_on_non_zero_exit: false
|
||||
end
|
||||
|
||||
def stop_old_version(version)
|
||||
if uses_cord?
|
||||
if uses_cord? && !proxy_host?
|
||||
cord = capture_with_info(*app.cord(version: version), raise_on_non_zero_exit: false).strip
|
||||
if cord.present?
|
||||
execute *app.cut_cord(cord)
|
||||
@@ -72,7 +86,7 @@ class Kamal::Cli::App::Boot
|
||||
|
||||
def release_barrier
|
||||
if barrier.open
|
||||
info "First #{KAMAL.primary_role} container is healthy on #{host}, booting other roles"
|
||||
info "First #{KAMAL.primary_role} container is healthy on #{host}, booting any other roles"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -87,9 +101,13 @@ class Kamal::Cli::App::Boot
|
||||
|
||||
def close_barrier
|
||||
if barrier.close
|
||||
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting other roles"
|
||||
info "First #{KAMAL.primary_role} container is unhealthy on #{host}, not booting any other roles"
|
||||
begin
|
||||
error capture_with_info(*app.logs(version: version))
|
||||
error capture_with_info(*app.container_health_log(version: version))
|
||||
rescue SSHKit::Command::Failed
|
||||
error "Could not fetch logs for #{version}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -116,4 +134,8 @@ class Kamal::Cli::App::Boot
|
||||
def queuer?
|
||||
barrier && !barrier_role?
|
||||
end
|
||||
|
||||
def proxy_host?
|
||||
KAMAL.proxy_host?(host)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
require "thor"
|
||||
require "dotenv"
|
||||
require "kamal/sshkit_with_ext"
|
||||
|
||||
module Kamal::Cli
|
||||
class Base < Thor
|
||||
include SSHKit::DSL
|
||||
|
||||
def self.exit_on_failure?() true end
|
||||
def self.exit_on_failure?() false 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,33 +22,23 @@ module Kamal::Cli
|
||||
|
||||
class_option :skip_hooks, aliases: "-H", type: :boolean, default: false, desc: "Don't run hooks"
|
||||
|
||||
def initialize(*)
|
||||
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
|
||||
@original_env = ENV.to_h.dup
|
||||
load_envs
|
||||
initialize_commander(options_with_subcommand_class_options)
|
||||
end
|
||||
initialize_commander unless KAMAL.configured?
|
||||
end
|
||||
|
||||
private
|
||||
def load_envs
|
||||
if destination = options[:destination]
|
||||
Dotenv.load(".env.#{destination}", ".env")
|
||||
else
|
||||
Dotenv.load(".env")
|
||||
end
|
||||
end
|
||||
|
||||
def reload_envs
|
||||
ENV.clear
|
||||
ENV.update(@original_env)
|
||||
load_envs
|
||||
end
|
||||
|
||||
def options_with_subcommand_class_options
|
||||
options.merge(@_initializer.last[:class_options] || {})
|
||||
end
|
||||
|
||||
def initialize_commander(options)
|
||||
def initialize_commander
|
||||
KAMAL.tap do |commander|
|
||||
if options[:verbose]
|
||||
ENV["VERBOSE"] = "1" # For backtraces via cli/start
|
||||
@@ -83,8 +73,6 @@ module Kamal::Cli
|
||||
if KAMAL.holding_lock?
|
||||
yield
|
||||
else
|
||||
ensure_run_and_locks_directory
|
||||
|
||||
acquire_lock
|
||||
|
||||
begin
|
||||
@@ -113,6 +101,8 @@ module Kamal::Cli
|
||||
end
|
||||
|
||||
def acquire_lock
|
||||
ensure_run_and_locks_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 }
|
||||
|
||||
@@ -23,48 +23,55 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
say "Building from a local git clone, so ignoring these uncommitted changes:\n #{uncommitted_changes}", :yellow
|
||||
end
|
||||
|
||||
prepare_clone
|
||||
run_locally do
|
||||
Clone.new(self).prepare
|
||||
end
|
||||
elsif uncommitted_changes.present?
|
||||
say "Building with uncommitted changes:\n #{uncommitted_changes}", :yellow
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
run_locally do
|
||||
begin
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
end
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /(no builder)|(no such file or directory)/
|
||||
warn "Missing compatible builder, so creating a new one first"
|
||||
|
||||
if cli.create
|
||||
KAMAL.with_verbosity(:debug) do
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push }
|
||||
end
|
||||
end
|
||||
else
|
||||
raise
|
||||
end
|
||||
Dir.chdir(KAMAL.config.builder.build_directory) { execute *push, env: KAMAL.config.builder.secrets }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "pull", "Pull app image from registry onto servers"
|
||||
def pull
|
||||
on(KAMAL.hosts) do
|
||||
execute *KAMAL.auditor.record("Pulled image with version #{KAMAL.config.version}"), verbosity: :debug
|
||||
execute *KAMAL.builder.clean, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.builder.pull
|
||||
execute *KAMAL.builder.validate_image
|
||||
if (first_hosts = mirror_hosts).any?
|
||||
# Pull on a single host per mirror first to seed them
|
||||
say "Pulling image on #{first_hosts.join(", ")} to seed the #{"mirror".pluralize(first_hosts.count)}...", :magenta
|
||||
pull_on_hosts(first_hosts)
|
||||
say "Pulling image on remaining hosts...", :magenta
|
||||
pull_on_hosts(KAMAL.hosts - first_hosts)
|
||||
else
|
||||
pull_on_hosts(KAMAL.hosts)
|
||||
end
|
||||
end
|
||||
|
||||
desc "create", "Create a build setup"
|
||||
def create
|
||||
if (remote_host = KAMAL.config.builder.remote_host)
|
||||
if (remote_host = KAMAL.config.builder.remote)
|
||||
connect_to_remote_host(remote_host)
|
||||
end
|
||||
|
||||
@@ -127,22 +134,27 @@ class Kamal::Cli::Build < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
def prepare_clone
|
||||
run_locally do
|
||||
begin
|
||||
info "Cloning repo into build directory `#{KAMAL.config.builder.build_directory}`..."
|
||||
|
||||
execute *KAMAL.builder.create_clone_directory
|
||||
execute *KAMAL.builder.clone
|
||||
def mirror_hosts
|
||||
if KAMAL.hosts.many?
|
||||
mirror_hosts = Concurrent::Hash.new
|
||||
on(KAMAL.hosts) do |host|
|
||||
first_mirror = capture_with_info(*KAMAL.builder.first_mirror).strip.presence
|
||||
mirror_hosts[first_mirror] ||= host.to_s if first_mirror
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /already exists and is not an empty directory/
|
||||
info "Resetting local clone as `#{KAMAL.config.builder.build_directory}` already exists..."
|
||||
|
||||
KAMAL.builder.clone_reset_steps.each { |step| execute *step }
|
||||
raise unless e.message =~ /error calling index: reflect: slice index out of range/
|
||||
end
|
||||
mirror_hosts.values
|
||||
else
|
||||
raise
|
||||
end
|
||||
end
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
def pull_on_hosts(hosts)
|
||||
on(hosts) do
|
||||
execute *KAMAL.auditor.record("Pulled image with version #{KAMAL.config.version}"), verbosity: :debug
|
||||
execute *KAMAL.builder.clean, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.builder.pull
|
||||
execute *KAMAL.builder.validate_image
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
61
lib/kamal/cli/build/clone.rb
Normal file
61
lib/kamal/cli/build/clone.rb
Normal file
@@ -0,0 +1,61 @@
|
||||
require "uri"
|
||||
|
||||
class Kamal::Cli::Build::Clone
|
||||
attr_reader :sshkit
|
||||
delegate :info, :error, :execute, :capture_with_info, to: :sshkit
|
||||
|
||||
def initialize(sshkit)
|
||||
@sshkit = sshkit
|
||||
end
|
||||
|
||||
def prepare
|
||||
begin
|
||||
clone_repo
|
||||
rescue SSHKit::Command::Failed => e
|
||||
if e.message =~ /already exists and is not an empty directory/
|
||||
reset
|
||||
else
|
||||
raise Kamal::Cli::Build::BuildError, "Failed to clone repo: #{e.message}"
|
||||
end
|
||||
end
|
||||
|
||||
validate!
|
||||
rescue Kamal::Cli::Build::BuildError => e
|
||||
error "Error preparing clone: #{e.message}, deleting and retrying..."
|
||||
|
||||
FileUtils.rm_rf KAMAL.config.builder.clone_directory
|
||||
clone_repo
|
||||
validate!
|
||||
end
|
||||
|
||||
private
|
||||
def clone_repo
|
||||
info "Cloning repo into build directory `#{KAMAL.config.builder.build_directory}`..."
|
||||
|
||||
FileUtils.mkdir_p KAMAL.config.builder.clone_directory
|
||||
execute *KAMAL.builder.clone
|
||||
end
|
||||
|
||||
def reset
|
||||
info "Resetting local clone as `#{KAMAL.config.builder.build_directory}` already exists..."
|
||||
|
||||
KAMAL.builder.clone_reset_steps.each { |step| execute *step }
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise Kamal::Cli::Build::BuildError, "Failed to clone repo: #{e.message}"
|
||||
end
|
||||
|
||||
def validate!
|
||||
status = capture_with_info(*KAMAL.builder.clone_status).strip
|
||||
|
||||
unless status.empty?
|
||||
raise Kamal::Cli::Build::BuildError, "Clone in #{KAMAL.config.builder.build_directory} is dirty, #{status}"
|
||||
end
|
||||
|
||||
revision = capture_with_info(*KAMAL.builder.clone_revision).strip
|
||||
if revision != Kamal::Git.revision
|
||||
raise Kamal::Cli::Build::BuildError, "Clone in #{KAMAL.config.builder.build_directory} is not on the correct revision, expected `#{Kamal::Git.revision}` but got `#{revision}`"
|
||||
end
|
||||
rescue SSHKit::Command::Failed => e
|
||||
raise Kamal::Cli::Build::BuildError, "Failed to validate clone: #{e.message}"
|
||||
end
|
||||
end
|
||||
@@ -1,54 +0,0 @@
|
||||
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,3 +1,5 @@
|
||||
require "concurrent/ivar"
|
||||
|
||||
class Kamal::Cli::Healthcheck::Barrier
|
||||
def initialize
|
||||
@ivar = Concurrent::IVar.new
|
||||
|
||||
@@ -6,7 +6,7 @@ module Kamal::Cli::Healthcheck::Poller
|
||||
|
||||
def wait_for_healthy(pause_after_ready: false, &block)
|
||||
attempt = 1
|
||||
max_attempts = KAMAL.config.healthcheck["max_attempts"]
|
||||
max_attempts = KAMAL.config.healthcheck.max_attempts
|
||||
|
||||
begin
|
||||
case status = block.call
|
||||
@@ -33,7 +33,7 @@ module Kamal::Cli::Healthcheck::Poller
|
||||
|
||||
def wait_for_unhealthy(pause_after_ready: false, &block)
|
||||
attempt = 1
|
||||
max_attempts = KAMAL.config.healthcheck["max_attempts"]
|
||||
max_attempts = KAMAL.config.healthcheck.max_attempts
|
||||
|
||||
begin
|
||||
case status = block.call
|
||||
|
||||
@@ -3,7 +3,6 @@ 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
|
||||
@@ -13,9 +12,10 @@ 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_and_locks_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,7 +26,6 @@ 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,9 +9,6 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
say "Ensure Docker is installed...", :magenta
|
||||
invoke "kamal:cli:server:bootstrap", [], invoke_options
|
||||
|
||||
say "Evaluate and push env files...", :magenta
|
||||
invoke "kamal:cli:main:envify", [], invoke_options
|
||||
|
||||
invoke "kamal:cli:accessory:boot", [ "all" ], invoke_options
|
||||
deploy
|
||||
end
|
||||
@@ -25,7 +22,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
invoke_options = deploy_options
|
||||
|
||||
say "Log into image registry...", :magenta
|
||||
invoke "kamal:cli:registry:login", [], invoke_options
|
||||
invoke "kamal:cli:registry:login", [], invoke_options.merge(skip_local: options[:skip_push])
|
||||
|
||||
if options[:skip_push]
|
||||
say "Pull app image...", :magenta
|
||||
@@ -36,10 +33,15 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
with_lock do
|
||||
run_hook "pre-deploy"
|
||||
run_hook "pre-deploy", secrets: true
|
||||
|
||||
if KAMAL.config.proxy.enabled?
|
||||
say "Ensure Traefik/kamal-proxy is running...", :magenta
|
||||
invoke "kamal:cli:proxy:boot", [], invoke_options
|
||||
else
|
||||
say "Ensure Traefik is running...", :magenta
|
||||
invoke "kamal:cli:traefik:boot", [], invoke_options
|
||||
end
|
||||
|
||||
say "Detect stale containers...", :magenta
|
||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||
@@ -51,7 +53,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", runtime: runtime.round
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round
|
||||
end
|
||||
|
||||
desc "redeploy", "Deploy app to servers without bootstrapping servers, starting Traefik, pruning, and registry login"
|
||||
@@ -69,7 +71,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
|
||||
with_lock do
|
||||
run_hook "pre-deploy"
|
||||
run_hook "pre-deploy", secrets: true
|
||||
|
||||
say "Detect stale containers...", :magenta
|
||||
invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)
|
||||
@@ -78,7 +80,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", runtime: runtime.round
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round
|
||||
end
|
||||
|
||||
desc "rollback [VERSION]", "Rollback app to VERSION"
|
||||
@@ -92,7 +94,7 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
old_version = nil
|
||||
|
||||
if container_available?(version)
|
||||
run_hook "pre-deploy"
|
||||
run_hook "pre-deploy", secrets: true
|
||||
|
||||
invoke "kamal:cli:app:boot", [], invoke_options.merge(version: version)
|
||||
rolled_back = true
|
||||
@@ -102,12 +104,16 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
run_hook "post-deploy", runtime: runtime.round if rolled_back
|
||||
run_hook "post-deploy", secrets: true, runtime: runtime.round if rolled_back
|
||||
end
|
||||
|
||||
desc "details", "Show details about all containers"
|
||||
def details
|
||||
if KAMAL.config.proxy.enabled?
|
||||
invoke "kamal:cli:proxy:details"
|
||||
else
|
||||
invoke "kamal:cli:traefik:details"
|
||||
end
|
||||
invoke "kamal:cli:app:details"
|
||||
invoke "kamal:cli:accessory:details", [ "all" ]
|
||||
end
|
||||
@@ -126,6 +132,18 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
desc "docs", "Show Kamal documentation for configuration setting"
|
||||
def docs(section = nil)
|
||||
case section
|
||||
when NilClass
|
||||
puts Kamal::Configuration.validation_doc
|
||||
else
|
||||
puts Kamal::Configuration.const_get(section.titlecase.to_sym).validation_doc
|
||||
end
|
||||
rescue NameError
|
||||
puts "No documentation found for #{section}"
|
||||
end
|
||||
|
||||
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
|
||||
@@ -139,9 +157,10 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
puts "Created configuration file in config/deploy.yml"
|
||||
end
|
||||
|
||||
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"
|
||||
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"
|
||||
end
|
||||
|
||||
unless (hooks_dir = Pathname.new(File.expand_path(".kamal/hooks"))).exist?
|
||||
@@ -166,38 +185,19 @@ class Kamal::Cli::Main < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
|
||||
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?
|
||||
File.write(env_path, ERB.new(File.read(env_template_path), trim_mode: "-").result, perm: 0600)
|
||||
|
||||
unless options[:skip_push]
|
||||
reload_envs
|
||||
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
|
||||
if KAMAL.config.proxy.enabled?
|
||||
invoke "kamal:cli:proxy:remove", [], options.without(:confirmed)
|
||||
else
|
||||
invoke "kamal:cli:traefik:remove", [], options.without(:confirmed)
|
||||
end
|
||||
invoke "kamal:cli:app:remove", [], options.without(:confirmed)
|
||||
invoke "kamal:cli:accessory:remove", [ "all" ], options
|
||||
invoke "kamal:cli:registry:logout", [], options.without(:confirmed)
|
||||
invoke "kamal:cli:registry:logout", [], options.without(:confirmed).merge(skip_local: true)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -216,18 +216,21 @@ 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", "Prune old application images and containers"
|
||||
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
|
||||
|
||||
|
||||
213
lib/kamal/cli/proxy.rb
Normal file
213
lib/kamal/cli/proxy.rb
Normal file
@@ -0,0 +1,213 @@
|
||||
class Kamal::Cli::Proxy < Kamal::Cli::Base
|
||||
desc "boot", "Boot proxy on servers"
|
||||
def boot
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
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.traefik_hosts) do |host|
|
||||
execute *KAMAL.registry.login
|
||||
if KAMAL.proxy_host?(host)
|
||||
execute *KAMAL.proxy.start_or_run
|
||||
else
|
||||
execute *KAMAL.traefik.ensure_env_directory
|
||||
upload! KAMAL.traefik.secrets_io, KAMAL.traefik.secrets_path, mode: "0600"
|
||||
execute *KAMAL.traefik.start_or_run
|
||||
end
|
||||
end
|
||||
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
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
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 |host|
|
||||
execute *KAMAL.auditor.record("Rebooted proxy"), verbosity: :debug
|
||||
execute *KAMAL.registry.login
|
||||
|
||||
"Stopping and removing Traefik on #{host}, if running..."
|
||||
execute *KAMAL.traefik.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.traefik.remove_container
|
||||
|
||||
"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.traefik_or_proxy(host).run
|
||||
|
||||
if KAMAL.proxy_host?(host)
|
||||
KAMAL.roles_on(host).select(&:running_traefik?).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 *KAMAL.proxy.deploy(role.container_prefix, target: endpoint)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
run_hook "post-traefik-reboot", hosts: host_list
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "upgrade", "Upgrade to correct 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 upgrade
|
||||
invoke_options = { "version" => KAMAL.config.version }.merge(options)
|
||||
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
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(",")
|
||||
run_hook "pre-traefik-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.traefik.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.traefik.remove_container
|
||||
|
||||
"Stopping and removing kamal-proxy on #{host}, if running..."
|
||||
execute *KAMAL.proxy.stop, raise_on_non_zero_exit: false
|
||||
execute *KAMAL.proxy.remove_container
|
||||
end
|
||||
|
||||
invoke "kamal:cli:proxy:boot", [], invoke_options.merge("hosts" => host_list)
|
||||
reset_invocation(Kamal::Cli::Proxy)
|
||||
invoke "kamal:cli:app:boot", [], invoke_options.merge("hosts" => host_list, version: KAMAL.config.latest_tag)
|
||||
reset_invocation(Kamal::Cli::App)
|
||||
invoke "kamal:cli:prune:all", [], invoke_options.merge("hosts" => host_list)
|
||||
reset_invocation(Kamal::Cli::Prune)
|
||||
|
||||
run_hook "post-traefik-reboot", hosts: host_list
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "start", "Start existing proxy container on servers"
|
||||
def start
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Started proxy"), verbosity: :debug
|
||||
execute *KAMAL.traefik_or_proxy(host).start
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "stop", "Stop existing proxy container on servers"
|
||||
def stop
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do |host|
|
||||
execute *KAMAL.auditor.record("Stopped proxy"), verbosity: :debug
|
||||
execute *KAMAL.traefik_or_proxy(host).stop, raise_on_non_zero_exit: false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "restart", "Restart existing proxy container on servers"
|
||||
def restart
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
stop
|
||||
start
|
||||
end
|
||||
end
|
||||
|
||||
desc "details", "Show details about proxy container from servers"
|
||||
def details
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
on(KAMAL.traefik_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.traefik_or_proxy(host).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)"
|
||||
def logs
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
grep = options[:grep]
|
||||
|
||||
if options[:follow]
|
||||
run_locally do
|
||||
info "Following logs on #{KAMAL.primary_host}..."
|
||||
info KAMAL.traefik_or_proxy(KAMAL.primary_host).follow_logs(host: KAMAL.primary_host, grep: grep)
|
||||
exec KAMAL.traefik_or_proxy(KAMAL.primary_host).follow_logs(host: KAMAL.primary_host, 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.traefik_hosts) do |host|
|
||||
puts_by_host host, capture(*KAMAL.traefik_or_proxy(host).logs(since: since, lines: lines, grep: grep)), type: "Proxy"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove", "Remove proxy container and image from servers"
|
||||
def remove
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
stop
|
||||
remove_container
|
||||
remove_image
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_container", "Remove proxy container from servers", hide: true
|
||||
def remove_container
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed proxy container"), verbosity: :debug
|
||||
execute *KAMAL.proxy.remove_container
|
||||
execute *KAMAL.traefik.remove_container
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "remove_image", "Remove proxy image from servers", hide: true
|
||||
def remove_image
|
||||
raise_unless_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed proxy image"), verbosity: :debug
|
||||
execute *KAMAL.proxy.remove_image
|
||||
execute *KAMAL.traefik.remove_image
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def raise_unless_kamal_proxy_enabled!
|
||||
unless KAMAL.config.proxy.enabled?
|
||||
raise "kamal proxy commands are disabled unless experimental proxy support is enabled. Use `kamal traefik` commands instead."
|
||||
end
|
||||
end
|
||||
|
||||
def reset_invocation(cli_class)
|
||||
instance_variable_get("@_invocations")[cli_class].pop
|
||||
end
|
||||
end
|
||||
@@ -1,18 +1,17 @@
|
||||
class Kamal::Cli::Registry < Kamal::Cli::Base
|
||||
desc "login", "Log in to registry locally and remotely"
|
||||
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
|
||||
run_locally { execute *KAMAL.registry.login }
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.login }
|
||||
# FIXME: This rescue needed?
|
||||
rescue ArgumentError => e
|
||||
puts e.message
|
||||
run_locally { execute *KAMAL.registry.login } unless options[:skip_local]
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.login } unless options[:skip_remote]
|
||||
end
|
||||
|
||||
desc "logout", "Log out of registry remotely"
|
||||
desc "logout", "Log out of registry locally and remotely"
|
||||
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 logout
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.logout }
|
||||
# FIXME: This rescue needed?
|
||||
rescue ArgumentError => e
|
||||
puts e.message
|
||||
run_locally { execute *KAMAL.registry.logout } unless options[:skip_local]
|
||||
on(KAMAL.hosts) { execute *KAMAL.registry.logout } unless options[:skip_remote]
|
||||
end
|
||||
end
|
||||
|
||||
47
lib/kamal/cli/secrets.rb
Normal file
47
lib/kamal/cli/secrets.rb
Normal file
@@ -0,0 +1,47 @@
|
||||
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: true, 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)
|
||||
handle_output(inline: options[:inline]) do
|
||||
results = adapter(options[:adapter]).fetch(secrets, **options.slice(:account, :from).symbolize_keys)
|
||||
JSON.dump(results).shellescape
|
||||
end
|
||||
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)
|
||||
handle_output(inline: options[:inline]) do
|
||||
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?
|
||||
|
||||
value
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def adapter(adapter)
|
||||
Kamal::Secrets::Adapters.lookup(adapter)
|
||||
end
|
||||
|
||||
def handle_output(inline: nil)
|
||||
yield.tap do |output|
|
||||
puts output unless inline
|
||||
end
|
||||
rescue => e
|
||||
handle_error(e)
|
||||
end
|
||||
|
||||
def handle_error(e)
|
||||
$stderr.puts " \e[31mERROR (#{e.class}): #{e.message}\e[0m"
|
||||
$stderr.puts e.backtrace if ENV["VERBOSE"]
|
||||
|
||||
exit 1
|
||||
end
|
||||
end
|
||||
@@ -1,7 +1,8 @@
|
||||
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)
|
||||
def exec(*cmd)
|
||||
cmd = Kamal::Utils.join_commands(cmd)
|
||||
hosts = KAMAL.hosts | KAMAL.accessory_hosts
|
||||
|
||||
case
|
||||
|
||||
@@ -18,6 +18,10 @@ registry:
|
||||
password:
|
||||
- KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
# Configure builder setup.
|
||||
builder:
|
||||
arch: amd64
|
||||
|
||||
# Inject ENV variables into containers (secrets come from .env).
|
||||
# Remember to run `kamal env push` after making changes!
|
||||
# env:
|
||||
@@ -30,16 +34,6 @@ registry:
|
||||
# ssh:
|
||||
# user: app
|
||||
|
||||
# Configure builder setup.
|
||||
# builder:
|
||||
# args:
|
||||
# RUBY_VERSION: 3.2.0
|
||||
# secrets:
|
||||
# - GITHUB_TOKEN
|
||||
# remote:
|
||||
# arch: amd64
|
||||
# host: ssh://app@192.168.0.1
|
||||
|
||||
# Use accessory services (secrets come from .env).
|
||||
# accessories:
|
||||
# db:
|
||||
|
||||
@@ -2,6 +2,12 @@
|
||||
|
||||
# A sample docker-setup hook
|
||||
#
|
||||
# Sets up a Docker network which can then be used by the application’s containers
|
||||
# Sets up a Docker network on defined hosts which can then be used by the application’s containers
|
||||
|
||||
ssh user@example.com docker network create kamal
|
||||
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
|
||||
|
||||
16
lib/kamal/cli/templates/secrets
Normal file
16
lib/kamal/cli/templates/secrets
Normal file
@@ -0,0 +1,16 @@
|
||||
# WARNING: Avoid adding secrets directly to this file
|
||||
# If you must, then add `.kamal/secrets*` to your .gitignore file
|
||||
|
||||
# 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)
|
||||
@@ -1,2 +0,0 @@
|
||||
KAMAL_REGISTRY_PASSWORD=change-this
|
||||
RAILS_MASTER_KEY=another-env
|
||||
@@ -1,9 +1,12 @@
|
||||
class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
desc "boot", "Boot Traefik on servers"
|
||||
def boot
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.registry.login
|
||||
execute *KAMAL.traefik.ensure_env_directory
|
||||
upload! KAMAL.traefik.secrets_io, KAMAL.traefik.secrets_path, mode: "0600"
|
||||
execute *KAMAL.traefik.start_or_run
|
||||
end
|
||||
end
|
||||
@@ -13,6 +16,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
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
|
||||
raise_if_kamal_proxy_enabled!
|
||||
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 ]
|
||||
@@ -34,6 +38,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "start", "Start existing Traefik container on servers"
|
||||
def start
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Started traefik"), verbosity: :debug
|
||||
@@ -44,6 +49,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "stop", "Stop existing Traefik container on servers"
|
||||
def stop
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Stopped traefik"), verbosity: :debug
|
||||
@@ -54,6 +60,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "restart", "Restart existing Traefik container on servers"
|
||||
def restart
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
stop
|
||||
start
|
||||
@@ -62,6 +69,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "details", "Show details about Traefik container from servers"
|
||||
def details
|
||||
raise_if_kamal_proxy_enabled!
|
||||
on(KAMAL.traefik_hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.traefik.info), type: "Traefik" }
|
||||
end
|
||||
|
||||
@@ -69,28 +77,32 @@ class Kamal::Cli::Traefik < 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, 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
|
||||
raise_if_kamal_proxy_enabled!
|
||||
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)
|
||||
exec KAMAL.traefik.follow_logs(host: KAMAL.primary_host, grep: grep)
|
||||
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)), type: "Traefik"
|
||||
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
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
stop
|
||||
remove_container
|
||||
@@ -100,6 +112,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "remove_container", "Remove Traefik container from servers", hide: true
|
||||
def remove_container
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed traefik container"), verbosity: :debug
|
||||
@@ -110,6 +123,7 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
|
||||
desc "remove_image", "Remove Traefik image from servers", hide: true
|
||||
def remove_image
|
||||
raise_if_kamal_proxy_enabled!
|
||||
with_lock do
|
||||
on(KAMAL.traefik_hosts) do
|
||||
execute *KAMAL.auditor.record("Removed traefik image"), verbosity: :debug
|
||||
@@ -117,4 +131,11 @@ class Kamal::Cli::Traefik < Kamal::Cli::Base
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def raise_if_kamal_proxy_enabled!
|
||||
if KAMAL.config.proxy.enabled?
|
||||
raise "kamal traefik commands are disabled when experimental proxy support is enabled. Use `kamal proxy` commands instead."
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
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
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :traefik_hosts, :accessory_hosts, to: :specifics
|
||||
delegate :hosts, :roles, :primary_host, :primary_role, :roles_on, :traefik_hosts, :proxy_hosts, :proxy_host?, :accessory_hosts, to: :specifics
|
||||
|
||||
def initialize
|
||||
self.verbosity = :info
|
||||
@@ -23,12 +24,20 @@ 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
|
||||
end
|
||||
|
||||
def specific_roles=(role_names)
|
||||
@specifics = nil
|
||||
@@ -97,6 +106,10 @@ class Kamal::Commander
|
||||
@lock ||= Kamal::Commands::Lock.new(config)
|
||||
end
|
||||
|
||||
def proxy
|
||||
@proxy ||= Kamal::Commands::Proxy.new(config)
|
||||
end
|
||||
|
||||
def prune
|
||||
@prune ||= Kamal::Commands::Prune.new(config)
|
||||
end
|
||||
@@ -113,6 +126,14 @@ class Kamal::Commander
|
||||
@traefik ||= Kamal::Commands::Traefik.new(config)
|
||||
end
|
||||
|
||||
def alias(name)
|
||||
config.aliases[name]
|
||||
end
|
||||
|
||||
|
||||
def traefik_or_proxy(host)
|
||||
proxy_host?(host) ? proxy : traefik
|
||||
end
|
||||
|
||||
def with_verbosity(level)
|
||||
old_level = self.verbosity
|
||||
|
||||
@@ -22,6 +22,15 @@ class Kamal::Commander::Specifics
|
||||
config.traefik_hosts & specified_hosts
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
config.proxy_hosts
|
||||
end
|
||||
|
||||
def proxy_host?(host)
|
||||
host = host.hostname if host.is_a?(SSHKit::Host)
|
||||
proxy_hosts.include?(host)
|
||||
end
|
||||
|
||||
def accessory_hosts
|
||||
specific_hosts || config.accessories.flat_map(&:hosts)
|
||||
end
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
attr_reader :accessory_config
|
||||
delegate :service_name, :image, :hosts, :port, :files, :directories, :cmd,
|
||||
:publish_args, :env_args, :volume_args, :label_args, :option_args, to: :accessory_config
|
||||
:publish_args, :env_args, :volume_args, :label_args, :option_args,
|
||||
:secrets_io, :secrets_path, :env_directory,
|
||||
to: :accessory_config
|
||||
|
||||
def initialize(config, name:)
|
||||
super(config)
|
||||
@@ -13,6 +15,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
"--name", service_name,
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
"--network", "kamal",
|
||||
*config.logging_args,
|
||||
*publish_args,
|
||||
*env_args,
|
||||
@@ -36,17 +39,17 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
|
||||
def logs(since: nil, lines: nil, grep: 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", "2>&1"),
|
||||
("grep '#{grep}'" if grep)
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(grep: nil)
|
||||
def follow_logs(grep: nil, grep_options: nil)
|
||||
run_over_ssh \
|
||||
pipe \
|
||||
docker(:logs, service_name, "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}") if grep)
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
end
|
||||
|
||||
|
||||
@@ -61,6 +64,7 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :run,
|
||||
("-it" if interactive),
|
||||
"--rm",
|
||||
"--network", "kamal",
|
||||
*env_args,
|
||||
*volume_args,
|
||||
image,
|
||||
@@ -98,12 +102,8 @@ class Kamal::Commands::Accessory < Kamal::Commands::Base
|
||||
docker :image, :rm, "--force", image
|
||||
end
|
||||
|
||||
def make_env_directory
|
||||
make_directory accessory_config.env.secrets_directory
|
||||
end
|
||||
|
||||
def remove_env_file
|
||||
[ :rm, "-f", accessory_config.env.secrets_file ]
|
||||
def ensure_env_directory
|
||||
make_directory env_directory
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -5,6 +5,8 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
|
||||
attr_reader :role, :host
|
||||
|
||||
delegate :container_name, to: :role
|
||||
|
||||
def initialize(config, role: nil, host: nil)
|
||||
super(config)
|
||||
@role = role
|
||||
@@ -30,6 +32,25 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
role.cmd
|
||||
end
|
||||
|
||||
def run_for_proxy(hostname: nil)
|
||||
docker :run,
|
||||
"--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.logging_args,
|
||||
*config.volume_args,
|
||||
*role.asset_volume_args,
|
||||
*role.label_args_for_proxy,
|
||||
*role.option_args,
|
||||
config.absolute_image,
|
||||
role.cmd
|
||||
end
|
||||
|
||||
def start
|
||||
docker :start, container_name
|
||||
end
|
||||
@@ -69,21 +90,11 @@ class Kamal::Commands::App < Kamal::Commands::Base
|
||||
extract_version_from_name
|
||||
end
|
||||
|
||||
|
||||
def make_env_directory
|
||||
make_directory role.env(host).secrets_directory
|
||||
def ensure_env_directory
|
||||
make_directory role.env_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
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
module Kamal::Commands::App::Logging
|
||||
def logs(version: nil, since: nil, lines: nil, grep: nil)
|
||||
def logs(version: nil, since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
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}'" if grep)
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, lines: nil, grep: nil)
|
||||
def follow_logs(host:, lines: nil, grep: nil, grep_options: nil)
|
||||
run_over_ssh \
|
||||
pipe(
|
||||
current_running_container_id,
|
||||
"xargs docker logs --timestamps#{" --tail #{lines}" if lines} --follow 2>&1",
|
||||
(%(grep "#{grep}") if grep)
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
),
|
||||
host: host
|
||||
end
|
||||
|
||||
@@ -8,9 +8,12 @@ class Kamal::Commands::Auditor < Kamal::Commands::Base
|
||||
|
||||
# Runs remotely
|
||||
def record(line, **details)
|
||||
append \
|
||||
[ :echo, audit_tags(**details).except(:version, :service_version).to_s, line ],
|
||||
combine \
|
||||
[ :mkdir, "-p", config.run_directory ],
|
||||
append(
|
||||
[ :echo, audit_tags(**details).except(:version, :service_version, :service).to_s, line ],
|
||||
audit_log_file
|
||||
)
|
||||
end
|
||||
|
||||
def reveal
|
||||
|
||||
@@ -37,6 +37,10 @@ module Kamal::Commands
|
||||
[ :rm, "-r", path ]
|
||||
end
|
||||
|
||||
def remove_file(path)
|
||||
[ :rm, path ]
|
||||
end
|
||||
|
||||
private
|
||||
def combine(*commands, by: "&&")
|
||||
commands
|
||||
@@ -81,6 +85,10 @@ 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
|
||||
|
||||
@@ -1,46 +1,37 @@
|
||||
require "active_support/core_ext/string/filters"
|
||||
|
||||
class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
delegate :create, :remove, :push, :clean, :pull, :info, :validate_image, to: :target
|
||||
delegate :clone_directory, :build_directory, to: :"config.builder"
|
||||
delegate :create, :remove, :push, :clean, :pull, :info, :inspect_builder, :validate_image, :first_mirror, to: :target
|
||||
delegate :local?, :remote?, to: "config.builder"
|
||||
|
||||
include Clone
|
||||
|
||||
def name
|
||||
target.class.to_s.remove("Kamal::Commands::Builder::").underscore.inquiry
|
||||
end
|
||||
|
||||
def target
|
||||
case
|
||||
when !config.builder.multiarch? && !config.builder.cached?
|
||||
native
|
||||
when !config.builder.multiarch? && config.builder.cached?
|
||||
native_cached
|
||||
when config.builder.local? && config.builder.remote?
|
||||
multiarch_remote
|
||||
when config.builder.remote?
|
||||
native_remote
|
||||
if remote?
|
||||
if local?
|
||||
hybrid
|
||||
else
|
||||
multiarch
|
||||
remote
|
||||
end
|
||||
else
|
||||
local
|
||||
end
|
||||
end
|
||||
|
||||
def native
|
||||
@native ||= Kamal::Commands::Builder::Native.new(config)
|
||||
def remote
|
||||
@remote ||= Kamal::Commands::Builder::Remote.new(config)
|
||||
end
|
||||
|
||||
def native_cached
|
||||
@native ||= Kamal::Commands::Builder::Native::Cached.new(config)
|
||||
def local
|
||||
@local ||= Kamal::Commands::Builder::Local.new(config)
|
||||
end
|
||||
|
||||
def native_remote
|
||||
@native ||= Kamal::Commands::Builder::Native::Remote.new(config)
|
||||
end
|
||||
|
||||
def multiarch
|
||||
@multiarch ||= Kamal::Commands::Builder::Multiarch.new(config)
|
||||
end
|
||||
|
||||
def multiarch_remote
|
||||
@multiarch_remote ||= Kamal::Commands::Builder::Multiarch::Remote.new(config)
|
||||
def hybrid
|
||||
@hybrid ||= Kamal::Commands::Builder::Hybrid.new(config)
|
||||
end
|
||||
|
||||
|
||||
@@ -54,23 +45,6 @@ class Kamal::Commands::Builder < Kamal::Commands::Base
|
||||
end
|
||||
end
|
||||
|
||||
def create_clone_directory
|
||||
make_directory clone_directory
|
||||
end
|
||||
|
||||
def clone
|
||||
git :clone, Kamal::Git.root, path: clone_directory
|
||||
end
|
||||
|
||||
def clone_reset_steps
|
||||
[
|
||||
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)
|
||||
]
|
||||
end
|
||||
|
||||
private
|
||||
def ensure_local_docker_installed
|
||||
docker "--version"
|
||||
|
||||
@@ -1,18 +1,41 @@
|
||||
|
||||
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, :local_arch, :local_host, :remote_arch, :remote_host, :cache_from, :cache_to, :ssh, to: :builder_config
|
||||
delegate \
|
||||
:args, :secrets, :dockerfile, :target, :arches, :local_arches, :remote_arches, :remote,
|
||||
:cache_from, :cache_to, :ssh, :driver, :docker_driver?,
|
||||
to: :builder_config
|
||||
|
||||
def clean
|
||||
docker :image, :rm, "--force", config.absolute_image
|
||||
end
|
||||
|
||||
def push
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
*platform_options(arches),
|
||||
*([ "--builder", builder_name ] unless docker_driver?),
|
||||
*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_tags, *build_cache, *build_labels, *build_args, *build_secrets, *build_dockerfile, *build_target, *build_ssh ]
|
||||
end
|
||||
@@ -30,6 +53,9 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
)
|
||||
end
|
||||
|
||||
def first_mirror
|
||||
docker(:info, "--format '{{index .RegistryConfig.Mirrors 0}}'")
|
||||
end
|
||||
|
||||
private
|
||||
def build_tags
|
||||
@@ -52,7 +78,7 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
end
|
||||
|
||||
def build_secrets
|
||||
argumentize "--secret", secrets.collect { |secret| [ "id", secret ] }
|
||||
argumentize "--secret", secrets.keys.collect { |secret| [ "id", secret ] }
|
||||
end
|
||||
|
||||
def build_dockerfile
|
||||
@@ -74,4 +100,8 @@ class Kamal::Commands::Builder::Base < Kamal::Commands::Base
|
||||
def builder_config
|
||||
config.builder
|
||||
end
|
||||
|
||||
def platform_options(arches)
|
||||
argumentize "--platform", arches.map { |arch| "linux/#{arch}" }.join(",") if arches.any?
|
||||
end
|
||||
end
|
||||
|
||||
29
lib/kamal/commands/builder/clone.rb
Normal file
29
lib/kamal/commands/builder/clone.rb
Normal file
@@ -0,0 +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, Kamal::Git.root, "--recurse-submodules", path: clone_directory
|
||||
end
|
||||
|
||||
def clone_reset_steps
|
||||
[
|
||||
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: build_directory
|
||||
end
|
||||
|
||||
def clone_revision
|
||||
git :"rev-parse", :HEAD, path: build_directory
|
||||
end
|
||||
end
|
||||
21
lib/kamal/commands/builder/hybrid.rb
Normal file
21
lib/kamal/commands/builder/hybrid.rb
Normal file
@@ -0,0 +1,21 @@
|
||||
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
|
||||
14
lib/kamal/commands/builder/local.rb
Normal file
14
lib/kamal/commands/builder/local.rb
Normal file
@@ -0,0 +1,14 @@
|
||||
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
|
||||
@@ -1,37 +0,0 @@
|
||||
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
|
||||
|
||||
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
|
||||
@@ -1,51 +0,0 @@
|
||||
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
|
||||
|
||||
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
|
||||
end
|
||||
@@ -1,20 +0,0 @@
|
||||
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
|
||||
@@ -1,16 +0,0 @@
|
||||
class Kamal::Commands::Builder::Native::Cached < Kamal::Commands::Builder::Native
|
||||
def create
|
||||
docker :buildx, :create, "--use", "--driver=docker-container"
|
||||
end
|
||||
|
||||
def remove
|
||||
docker :buildx, :rm, builder_name
|
||||
end
|
||||
|
||||
def push
|
||||
docker :buildx, :build,
|
||||
"--push",
|
||||
*build_options,
|
||||
build_context
|
||||
end
|
||||
end
|
||||
@@ -1,59 +0,0 @@
|
||||
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
|
||||
|
||||
|
||||
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
|
||||
63
lib/kamal/commands/builder/remote.rb
Normal file
63
lib/kamal/commands/builder/remote.rb
Normal file
@@ -0,0 +1,63 @@
|
||||
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,6 +19,10 @@ 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,6 +1,9 @@
|
||||
class Kamal::Commands::Hook < Kamal::Commands::Base
|
||||
def run(hook, **details)
|
||||
[ hook_file(hook), env: tags(**details).env ]
|
||||
def run(hook, secrets: false, **details)
|
||||
env = tags(**details).env
|
||||
env.merge!(config.secrets.to_h) if secrets
|
||||
|
||||
[ hook_file(hook), env: env ]
|
||||
end
|
||||
|
||||
def hook_exists?(hook)
|
||||
|
||||
69
lib/kamal/commands/proxy.rb
Normal file
69
lib/kamal/commands/proxy.rb
Normal file
@@ -0,0 +1,69 @@
|
||||
class Kamal::Commands::Proxy < Kamal::Commands::Base
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
delegate :container_name, :app_port, to: :proxy_config
|
||||
|
||||
attr_reader :proxy_config
|
||||
|
||||
def initialize(config)
|
||||
super
|
||||
@proxy_config = config.proxy
|
||||
end
|
||||
|
||||
def run
|
||||
docker :run,
|
||||
"--name", container_name,
|
||||
"--network", "kamal",
|
||||
"--detach",
|
||||
"--restart", "unless-stopped",
|
||||
*proxy_config.publish_args,
|
||||
"--volume", "/var/run/docker.sock:/var/run/docker.sock",
|
||||
"--volume", "#{proxy_config.config_directory_as_docker_volume}:/root/.config/kamal-proxy",
|
||||
*config.logging_args,
|
||||
proxy_config.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 deploy(service, target:)
|
||||
docker :exec, container_name, "kamal-proxy", :deploy, service, *optionize({ target: "#{target}:#{app_port}" }), *proxy_config.deploy_command_args
|
||||
end
|
||||
|
||||
def remove(service, target:)
|
||||
docker :exec, container_name, "kamal-proxy", :remove, service, *optionize({ target: "#{target}:#{app_port}" })
|
||||
end
|
||||
|
||||
def info
|
||||
docker :ps, "--filter", "name=^#{container_name}$"
|
||||
end
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil, grep_options: nil)
|
||||
pipe \
|
||||
docker(:logs, container_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(host:, grep: nil, grep_options: nil)
|
||||
run_over_ssh pipe(
|
||||
docker(:logs, container_name, "--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
|
||||
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
|
||||
|
||||
|
||||
@@ -3,21 +3,12 @@ class Kamal::Commands::Registry < Kamal::Commands::Base
|
||||
|
||||
def login
|
||||
docker :login,
|
||||
registry["server"],
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(lookup("username"))),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(lookup("password")))
|
||||
registry.server,
|
||||
"-u", sensitive(Kamal::Utils.escape_shell_value(registry.username)),
|
||||
"-p", sensitive(Kamal::Utils.escape_shell_value(registry.password))
|
||||
end
|
||||
|
||||
def logout
|
||||
docker :logout, registry["server"]
|
||||
end
|
||||
|
||||
private
|
||||
def lookup(key)
|
||||
if registry[key].is_a?(Array)
|
||||
ENV.fetch(registry[key].first).dup
|
||||
else
|
||||
registry[key]
|
||||
end
|
||||
docker :logout, registry.server
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,19 +1,6 @@
|
||||
class Kamal::Commands::Traefik < Kamal::Commands::Base
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
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"
|
||||
}
|
||||
delegate :port, :publish?, :labels, :env, :image, :options, :args, :env_args, :secrets_io, :env_directory, :secrets_path, to: :"config.traefik"
|
||||
|
||||
def run
|
||||
docker :run, "--name traefik",
|
||||
@@ -46,16 +33,16 @@ class Kamal::Commands::Traefik < Kamal::Commands::Base
|
||||
docker :ps, "--filter", "name=^traefik$"
|
||||
end
|
||||
|
||||
def logs(since: nil, lines: nil, grep: nil)
|
||||
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}'" if grep)
|
||||
("grep '#{grep}'#{" #{grep_options}" if grep_options}" if grep)
|
||||
end
|
||||
|
||||
def follow_logs(host:, grep: nil)
|
||||
def follow_logs(host:, grep: nil, grep_options: nil)
|
||||
run_over_ssh pipe(
|
||||
docker(:logs, "traefik", "--timestamps", "--tail", "10", "--follow", "2>&1"),
|
||||
(%(grep "#{grep}") if grep)
|
||||
(%(grep "#{grep}"#{" #{grep_options}" if grep_options}) if grep)
|
||||
).join(" "), host: host
|
||||
end
|
||||
|
||||
@@ -67,58 +54,24 @@ class Kamal::Commands::Traefik < Kamal::Commands::Base
|
||||
docker :image, :prune, "--all", "--force", "--filter", "label=org.opencontainers.image.title=Traefik"
|
||||
end
|
||||
|
||||
def port
|
||||
"#{host_port}:#{CONTAINER_PORT}"
|
||||
end
|
||||
|
||||
def env
|
||||
Kamal::Configuration::Env.from_config \
|
||||
config: config.traefik.fetch("env", {}),
|
||||
secrets_file: File.join(config.host_env_directory, "traefik", "traefik.env")
|
||||
end
|
||||
|
||||
def make_env_directory
|
||||
make_directory(env.secrets_directory)
|
||||
end
|
||||
|
||||
def remove_env_file
|
||||
[ :rm, "-f", env.secrets_file ]
|
||||
def ensure_env_directory
|
||||
make_directory env_directory
|
||||
end
|
||||
|
||||
private
|
||||
def publish_args
|
||||
argumentize "--publish", port unless config.traefik["publish"] == false
|
||||
argumentize "--publish", port if publish?
|
||||
end
|
||||
|
||||
def label_args
|
||||
argumentize "--label", labels
|
||||
end
|
||||
|
||||
def env_args
|
||||
env.args
|
||||
end
|
||||
|
||||
def labels
|
||||
DEFAULT_LABELS.merge(config.traefik["labels"] || {})
|
||||
end
|
||||
|
||||
def image
|
||||
config.traefik.fetch("image") { DEFAULT_IMAGE }
|
||||
end
|
||||
|
||||
def docker_options_args
|
||||
optionize(config.traefik["options"] || {})
|
||||
optionize(options)
|
||||
end
|
||||
|
||||
def cmd_option_args
|
||||
if args = config.traefik["args"]
|
||||
optionize DEFAULT_ARGS.merge(args), with: "="
|
||||
else
|
||||
optionize DEFAULT_ARGS, with: "="
|
||||
end
|
||||
end
|
||||
|
||||
def host_port
|
||||
config.traefik["host_port"] || CONTAINER_PORT
|
||||
optionize args, with: "="
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,15 +1,18 @@
|
||||
require "active_support/ordered_options"
|
||||
require "active_support/core_ext/string/inquiry"
|
||||
require "active_support/core_ext/module/delegation"
|
||||
require "pathname"
|
||||
require "active_support/core_ext/hash/keys"
|
||||
require "erb"
|
||||
require "net/ssh/proxy/jump"
|
||||
|
||||
class Kamal::Configuration
|
||||
delegate :service, :image, :servers, :labels, :registry, :stop_wait_time, :hooks_path, :logging, 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
|
||||
attr_reader :accessories, :aliases, :boot, :builder, :env, :healthcheck, :logging, :proxy, :traefik, :servers, :ssh, :sshkit, :registry
|
||||
|
||||
include Validation
|
||||
|
||||
class << self
|
||||
def create_from(config_file:, destination: nil, version: nil)
|
||||
@@ -42,7 +45,31 @@ class Kamal::Configuration
|
||||
@raw_config = ActiveSupport::InheritableOptions.new(raw_config)
|
||||
@destination = destination
|
||||
@declared_version = version
|
||||
valid? if validate
|
||||
|
||||
validate! raw_config, example: validation_yml.symbolize_keys, context: "", with: Kamal::Configuration::Validator::Configuration
|
||||
|
||||
# Eager load config to validate it, these are first as they have dependencies later on
|
||||
@servers = Servers.new(config: self)
|
||||
@registry = Registry.new(config: self)
|
||||
|
||||
@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)
|
||||
|
||||
@healthcheck = Healthcheck.new(healthcheck_config: @raw_config.healthcheck)
|
||||
@logging = Logging.new(logging_config: @raw_config.logging)
|
||||
@proxy = Proxy.new(config: self)
|
||||
@traefik = Traefik.new(config: self)
|
||||
@ssh = Ssh.new(config: self)
|
||||
@sshkit = Sshkit.new(config: self)
|
||||
|
||||
ensure_destination_if_required
|
||||
ensure_required_keys_present
|
||||
ensure_valid_kamal_version
|
||||
ensure_retain_containers_valid
|
||||
ensure_valid_service_name
|
||||
end
|
||||
|
||||
|
||||
@@ -71,17 +98,13 @@ class Kamal::Configuration
|
||||
|
||||
|
||||
def roles
|
||||
@roles ||= role_names.collect { |role_name| Role.new(role_name, config: self) }
|
||||
servers.roles
|
||||
end
|
||||
|
||||
def role(name)
|
||||
roles.detect { |r| r.name == name.to_s }
|
||||
end
|
||||
|
||||
def accessories
|
||||
@accessories ||= raw_config.accessories&.keys&.collect { |name| Kamal::Configuration::Accessory.new(name, config: self) } || []
|
||||
end
|
||||
|
||||
def accessory(name)
|
||||
accessories.detect { |a| a.name == name.to_s }
|
||||
end
|
||||
@@ -119,8 +142,12 @@ class Kamal::Configuration
|
||||
traefik_roles.flat_map(&:hosts).uniq
|
||||
end
|
||||
|
||||
def proxy_hosts
|
||||
proxy.hosts
|
||||
end
|
||||
|
||||
def repository
|
||||
[ raw_config.registry["server"], image ].compact.join("/")
|
||||
[ registry.server, image ].compact.join("/")
|
||||
end
|
||||
|
||||
def absolute_image
|
||||
@@ -157,40 +184,10 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
def logging_args
|
||||
if logging.present?
|
||||
optionize({ "log-driver" => logging["driver"] }.compact) +
|
||||
argumentize("--log-opt", logging["options"])
|
||||
else
|
||||
argumentize("--log-opt", { "max-size" => "10m" })
|
||||
end
|
||||
logging.args
|
||||
end
|
||||
|
||||
|
||||
def boot
|
||||
Kamal::Configuration::Boot.new(config: self)
|
||||
end
|
||||
|
||||
def builder
|
||||
Kamal::Configuration::Builder.new(config: self)
|
||||
end
|
||||
|
||||
def traefik
|
||||
raw_config.traefik || {}
|
||||
end
|
||||
|
||||
def ssh
|
||||
Kamal::Configuration::Ssh.new(config: self)
|
||||
end
|
||||
|
||||
def sshkit
|
||||
Kamal::Configuration::Sshkit.new(config: self)
|
||||
end
|
||||
|
||||
|
||||
def healthcheck
|
||||
{ "path" => "/up", "port" => 3000, "max_attempts" => 7, "cord" => "/tmp/kamal-cord", "log_lines" => 50 }.merge(raw_config.healthcheck || {})
|
||||
end
|
||||
|
||||
def healthcheck_service
|
||||
[ "healthcheck", service, destination ].compact.join("-")
|
||||
end
|
||||
@@ -205,16 +202,12 @@ class Kamal::Configuration
|
||||
|
||||
|
||||
def run_directory
|
||||
raw_config.run_directory || ".kamal"
|
||||
".kamal"
|
||||
end
|
||||
|
||||
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
|
||||
raw_config.hooks_path || ".kamal/hooks"
|
||||
@@ -225,17 +218,13 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
|
||||
def host_env_directory
|
||||
def env_directory
|
||||
File.join(run_directory, "env")
|
||||
end
|
||||
|
||||
def env
|
||||
raw_config.env || {}
|
||||
end
|
||||
|
||||
def env_tags
|
||||
@env_tags ||= if (tags = raw_config.env["tags"])
|
||||
tags.collect { |name, config| Kamal::Configuration::Env::Tag.new(name, config: config) }
|
||||
tags.collect { |name, config| Env::Tag.new(name, config: config, secrets: secrets) }
|
||||
else
|
||||
[]
|
||||
end
|
||||
@@ -246,10 +235,6 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
|
||||
def valid?
|
||||
ensure_destination_if_required && ensure_required_keys_present && ensure_valid_kamal_version && ensure_retain_containers_valid && ensure_valid_service_name
|
||||
end
|
||||
|
||||
def to_h
|
||||
{
|
||||
roles: role_names,
|
||||
@@ -265,10 +250,13 @@ class Kamal::Configuration
|
||||
builder: builder.to_h,
|
||||
accessories: raw_config.accessories,
|
||||
logging: logging_args,
|
||||
healthcheck: healthcheck
|
||||
healthcheck: healthcheck.to_h
|
||||
}.compact
|
||||
end
|
||||
|
||||
def secrets
|
||||
@secrets ||= Kamal::Secrets.new(destination: destination)
|
||||
end
|
||||
|
||||
private
|
||||
# Will raise ArgumentError if any required config keys are missing
|
||||
@@ -282,29 +270,21 @@ class Kamal::Configuration
|
||||
|
||||
def ensure_required_keys_present
|
||||
%i[ service image registry servers ].each do |key|
|
||||
raise ArgumentError, "Missing required configuration for #{key}" unless raw_config[key].present?
|
||||
raise Kamal::ConfigurationError, "Missing required configuration for #{key}" unless raw_config[key].present?
|
||||
end
|
||||
|
||||
if raw_config.registry["username"].blank?
|
||||
raise ArgumentError, "You must specify a username for the registry in config/deploy.yml"
|
||||
end
|
||||
|
||||
if raw_config.registry["password"].blank?
|
||||
raise ArgumentError, "You must specify a password for the registry in config/deploy.yml (or set the ENV variable if that's used)"
|
||||
end
|
||||
|
||||
unless role_names.include?(primary_role_name)
|
||||
raise ArgumentError, "The primary_role #{primary_role_name} isn't defined"
|
||||
unless role(primary_role_name).present?
|
||||
raise Kamal::ConfigurationError, "The primary_role #{primary_role_name} isn't defined"
|
||||
end
|
||||
|
||||
if primary_role.hosts.empty?
|
||||
raise ArgumentError, "No servers specified for the #{primary_role.name} primary_role"
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{primary_role.name} primary_role"
|
||||
end
|
||||
|
||||
unless allow_empty_roles?
|
||||
roles.each do |role|
|
||||
if role.hosts.empty?
|
||||
raise ArgumentError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
|
||||
raise Kamal::ConfigurationError, "No servers specified for the #{role.name} role. You can ignore this with allow_empty_roles: true"
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -313,21 +293,21 @@ class Kamal::Configuration
|
||||
end
|
||||
|
||||
def ensure_valid_service_name
|
||||
raise ArgumentError, "Service name can only include alphanumeric characters, hyphens, and underscores" unless raw_config[:service] =~ /^[a-z0-9_-]+$/i
|
||||
raise Kamal::ConfigurationError, "Service name can only include alphanumeric characters, hyphens, and underscores" unless raw_config[:service] =~ /^[a-z0-9_-]+$/i
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_valid_kamal_version
|
||||
if minimum_version && Gem::Version.new(minimum_version) > Gem::Version.new(Kamal::VERSION)
|
||||
raise ArgumentError, "Current version is #{Kamal::VERSION}, minimum required is #{minimum_version}"
|
||||
raise Kamal::ConfigurationError, "Current version is #{Kamal::VERSION}, minimum required is #{minimum_version}"
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
def ensure_retain_containers_valid
|
||||
raise ArgumentError, "Must retain at least 1 container" if retain_containers < 1
|
||||
raise Kamal::ConfigurationError, "Must retain at least 1 container" if retain_containers < 1
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
@@ -1,30 +1,39 @@
|
||||
class Kamal::Configuration::Accessory
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_accessor :name, :specifics
|
||||
attr_reader :name, :accessory_config, :env
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config, @specifics = name.inquiry, config, config.raw_config["accessories"][name]
|
||||
@name, @config, @accessory_config = name.inquiry, config, config.raw_config["accessories"][name]
|
||||
|
||||
validate! \
|
||||
accessory_config,
|
||||
example: validation_yml["accessories"]["mysql"],
|
||||
context: "accessories/#{name}",
|
||||
with: Kamal::Configuration::Validator::Accessory
|
||||
|
||||
@env = Kamal::Configuration::Env.new \
|
||||
config: accessory_config.fetch("env", {}),
|
||||
secrets: config.secrets,
|
||||
context: "accessories/#{name}/env"
|
||||
end
|
||||
|
||||
def service_name
|
||||
specifics["service"] || "#{config.service}-#{name}"
|
||||
accessory_config["service"] || "#{config.service}-#{name}"
|
||||
end
|
||||
|
||||
def image
|
||||
specifics["image"]
|
||||
accessory_config["image"]
|
||||
end
|
||||
|
||||
def hosts
|
||||
if (specifics.keys & [ "host", "hosts", "roles" ]).size != 1
|
||||
raise ArgumentError, "Specify one of `host`, `hosts` or `roles` for accessory `#{name}`"
|
||||
end
|
||||
|
||||
hosts_from_host || hosts_from_hosts || hosts_from_roles
|
||||
end
|
||||
|
||||
def port
|
||||
if port = specifics["port"]&.to_s
|
||||
if port = accessory_config["port"]&.to_s
|
||||
port.include?(":") ? port : "#{port}:#{port}"
|
||||
end
|
||||
end
|
||||
@@ -34,32 +43,38 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def labels
|
||||
default_labels.merge(specifics["labels"] || {})
|
||||
default_labels.merge(accessory_config["labels"] || {})
|
||||
end
|
||||
|
||||
def label_args
|
||||
argumentize "--label", labels
|
||||
end
|
||||
|
||||
def env
|
||||
Kamal::Configuration::Env.from_config \
|
||||
config: specifics.fetch("env", {}),
|
||||
secrets_file: File.join(config.host_env_directory, "accessories", "#{service_name}.env")
|
||||
def env_args
|
||||
[ *env.clear_args, *argumentize("--env-file", secrets_path) ]
|
||||
end
|
||||
|
||||
def env_args
|
||||
env.args
|
||||
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", "#{service_name}.env")
|
||||
end
|
||||
|
||||
def files
|
||||
specifics["files"]&.to_h do |local_to_remote_mapping|
|
||||
accessory_config["files"]&.to_h do |local_to_remote_mapping|
|
||||
local_file, remote_file = local_to_remote_mapping.split(":")
|
||||
[ expand_local_file(local_file), expand_remote_file(remote_file) ]
|
||||
end || {}
|
||||
end
|
||||
|
||||
def directories
|
||||
specifics["directories"]&.to_h do |host_to_container_mapping|
|
||||
accessory_config["directories"]&.to_h do |host_to_container_mapping|
|
||||
host_path, container_path = host_to_container_mapping.split(":")
|
||||
[ expand_host_path(host_path), container_path ]
|
||||
end || {}
|
||||
@@ -74,7 +89,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def option_args
|
||||
if args = specifics["options"]
|
||||
if args = accessory_config["options"]
|
||||
optionize args
|
||||
else
|
||||
[]
|
||||
@@ -82,7 +97,7 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def cmd
|
||||
specifics["cmd"]
|
||||
accessory_config["cmd"]
|
||||
end
|
||||
|
||||
private
|
||||
@@ -116,18 +131,18 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def specific_volumes
|
||||
specifics["volumes"] || []
|
||||
accessory_config["volumes"] || []
|
||||
end
|
||||
|
||||
def remote_files_as_volumes
|
||||
specifics["files"]&.collect do |local_to_remote_mapping|
|
||||
accessory_config["files"]&.collect do |local_to_remote_mapping|
|
||||
_, remote_file = local_to_remote_mapping.split(":")
|
||||
"#{service_data_directory + remote_file}:#{remote_file}"
|
||||
end || []
|
||||
end
|
||||
|
||||
def remote_directories_as_volumes
|
||||
specifics["directories"]&.collect do |host_to_container_mapping|
|
||||
accessory_config["directories"]&.collect do |host_to_container_mapping|
|
||||
host_path, container_path = host_to_container_mapping.split(":")
|
||||
[ expand_host_path(host_path), container_path ].join(":")
|
||||
end || []
|
||||
@@ -146,30 +161,16 @@ class Kamal::Configuration::Accessory
|
||||
end
|
||||
|
||||
def hosts_from_host
|
||||
if specifics.key?("host")
|
||||
host = specifics["host"]
|
||||
if host
|
||||
[ host ]
|
||||
else
|
||||
raise ArgumentError, "Missing host for accessory `#{name}`"
|
||||
end
|
||||
end
|
||||
[ accessory_config["host"] ] if accessory_config.key?("host")
|
||||
end
|
||||
|
||||
def hosts_from_hosts
|
||||
if specifics.key?("hosts")
|
||||
hosts = specifics["hosts"]
|
||||
if hosts.is_a?(Array)
|
||||
hosts
|
||||
else
|
||||
raise ArgumentError, "Hosts should be an Array for accessory `#{name}`"
|
||||
end
|
||||
end
|
||||
accessory_config["hosts"] if accessory_config.key?("hosts")
|
||||
end
|
||||
|
||||
def hosts_from_roles
|
||||
if specifics.key?("roles")
|
||||
specifics["roles"].flat_map { |role| config.role(role).hosts }
|
||||
if accessory_config.key?("roles")
|
||||
accessory_config["roles"].flat_map { |role| config.role(role).hosts }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
15
lib/kamal/configuration/alias.rb
Normal file
15
lib/kamal/configuration/alias.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
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
|
||||
@@ -1,20 +1,25 @@
|
||||
class Kamal::Configuration::Boot
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :boot_config, :host_count
|
||||
|
||||
def initialize(config:)
|
||||
@options = config.raw_config.boot || {}
|
||||
@boot_config = config.raw_config.boot || {}
|
||||
@host_count = config.all_hosts.count
|
||||
validate! boot_config
|
||||
end
|
||||
|
||||
def limit
|
||||
limit = @options["limit"]
|
||||
limit = boot_config["limit"]
|
||||
|
||||
if limit.to_s.end_with?("%")
|
||||
[ @host_count * limit.to_i / 100, 1 ].max
|
||||
[ host_count * limit.to_i / 100, 1 ].max
|
||||
else
|
||||
limit
|
||||
end
|
||||
end
|
||||
|
||||
def wait
|
||||
@options["wait"]
|
||||
boot_config["wait"]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,73 +1,93 @@
|
||||
class Kamal::Configuration::Builder
|
||||
def initialize(config:)
|
||||
@options = config.raw_config.builder || {}
|
||||
@image = config.image
|
||||
@server = config.registry["server"]
|
||||
@service = config.service
|
||||
@destination = config.destination
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
valid?
|
||||
attr_reader :config, :builder_config
|
||||
delegate :image, :service, to: :config
|
||||
delegate :server, to: :"config.registry"
|
||||
|
||||
def initialize(config:)
|
||||
@config = config
|
||||
@builder_config = config.raw_config.builder || {}
|
||||
@image = config.image
|
||||
@server = config.registry.server
|
||||
@service = config.service
|
||||
|
||||
validate! builder_config, with: Kamal::Configuration::Validator::Builder
|
||||
end
|
||||
|
||||
def to_h
|
||||
@options
|
||||
builder_config
|
||||
end
|
||||
|
||||
def multiarch?
|
||||
@options["multiarch"] != false
|
||||
def remote
|
||||
builder_config["remote"]
|
||||
end
|
||||
|
||||
def local?
|
||||
!!@options["local"]
|
||||
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?
|
||||
!!@options["remote"]
|
||||
remote_arches.any?
|
||||
end
|
||||
|
||||
def local?
|
||||
!local_disabled? && (arches.empty? || local_arches.any?)
|
||||
end
|
||||
|
||||
def cached?
|
||||
!!@options["cache"]
|
||||
!!builder_config["cache"]
|
||||
end
|
||||
|
||||
def args
|
||||
@options["args"] || {}
|
||||
builder_config["args"] || {}
|
||||
end
|
||||
|
||||
def secrets
|
||||
@options["secrets"] || []
|
||||
(builder_config["secrets"] || []).to_h { |key| [ key, config.secrets[key] ] }
|
||||
end
|
||||
|
||||
def dockerfile
|
||||
@options["dockerfile"] || "Dockerfile"
|
||||
builder_config["dockerfile"] || "Dockerfile"
|
||||
end
|
||||
|
||||
def target
|
||||
@options["target"]
|
||||
builder_config["target"]
|
||||
end
|
||||
|
||||
def context
|
||||
@options["context"] || "."
|
||||
builder_config["context"] || "."
|
||||
end
|
||||
|
||||
def local_arch
|
||||
@options["local"]["arch"] if local?
|
||||
def driver
|
||||
builder_config.fetch("driver", "docker-container")
|
||||
end
|
||||
|
||||
def local_host
|
||||
@options["local"]["host"] if local?
|
||||
end
|
||||
|
||||
def remote_arch
|
||||
@options["remote"]["arch"] if remote?
|
||||
end
|
||||
|
||||
def remote_host
|
||||
@options["remote"]["host"] if remote?
|
||||
def local_disabled?
|
||||
builder_config["local"] == false
|
||||
end
|
||||
|
||||
def cache_from
|
||||
if cached?
|
||||
case @options["cache"]["type"]
|
||||
case builder_config["cache"]["type"]
|
||||
when "gha"
|
||||
cache_from_config_for_gha
|
||||
when "registry"
|
||||
@@ -78,7 +98,7 @@ class Kamal::Configuration::Builder
|
||||
|
||||
def cache_to
|
||||
if cached?
|
||||
case @options["cache"]["type"]
|
||||
case builder_config["cache"]["type"]
|
||||
when "gha"
|
||||
cache_to_config_for_gha
|
||||
when "registry"
|
||||
@@ -88,15 +108,15 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
|
||||
def ssh
|
||||
@options["ssh"]
|
||||
builder_config["ssh"]
|
||||
end
|
||||
|
||||
def git_clone?
|
||||
Kamal::Git.used? && @options["context"].nil?
|
||||
Kamal::Git.used? && builder_config["context"].nil?
|
||||
end
|
||||
|
||||
def clone_directory
|
||||
@clone_directory ||= File.join Dir.tmpdir, "kamal-clones", [ @service, pwd_sha ].compact.join("-")
|
||||
@clone_directory ||= File.join Dir.tmpdir, "kamal-clones", [ service, pwd_sha ].compact.join("-")
|
||||
end
|
||||
|
||||
def build_directory
|
||||
@@ -108,19 +128,29 @@ 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
|
||||
@options["cache"]&.fetch("image", nil) || "#{@image}-build-cache"
|
||||
builder_config["cache"]&.fetch("image", nil) || "#{image}-build-cache"
|
||||
end
|
||||
|
||||
def cache_image_ref
|
||||
[ @server, cache_image ].compact.join("/")
|
||||
[ server, cache_image ].compact.join("/")
|
||||
end
|
||||
|
||||
def cache_from_config_for_gha
|
||||
@@ -132,11 +162,11 @@ class Kamal::Configuration::Builder
|
||||
end
|
||||
|
||||
def cache_to_config_for_gha
|
||||
[ "type=gha", @options["cache"]&.fetch("options", nil) ].compact.join(",")
|
||||
[ "type=gha", builder_config["cache"]&.fetch("options", nil) ].compact.join(",")
|
||||
end
|
||||
|
||||
def cache_to_config_for_registry
|
||||
[ "type=registry", @options["cache"]&.fetch("options", nil), "ref=#{cache_image_ref}" ].compact.join(",")
|
||||
[ "type=registry", builder_config["cache"]&.fetch("options", nil), "ref=#{cache_image_ref}" ].compact.join(",")
|
||||
end
|
||||
|
||||
def repo_basename
|
||||
@@ -150,4 +180,8 @@ class Kamal::Configuration::Builder
|
||||
def pwd_sha
|
||||
Digest::SHA256.hexdigest(Dir.pwd)[0..12]
|
||||
end
|
||||
|
||||
def default_arch
|
||||
docker_driver? ? [] : [ "amd64", "arm64" ]
|
||||
end
|
||||
end
|
||||
|
||||
90
lib/kamal/configuration/docs/accessory.yml
Normal file
90
lib/kamal/configuration/docs/accessory.yml
Normal file
@@ -0,0 +1,90 @@
|
||||
# Accessories
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# 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`
|
||||
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
|
||||
service: mysql
|
||||
|
||||
# Image
|
||||
#
|
||||
# The Docker image to use, prefix with a registry if not using Docker hub
|
||||
image: mysql:8.0
|
||||
|
||||
# Accessory hosts
|
||||
#
|
||||
# Specify one of `host`, `hosts` or `roles`
|
||||
host: mysql-db1
|
||||
hosts:
|
||||
- mysql-db1
|
||||
- mysql-db2
|
||||
roles:
|
||||
- mysql
|
||||
|
||||
# Custom command
|
||||
#
|
||||
# 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/, especially note the warning about the security
|
||||
# implications of exposing ports publicly.
|
||||
port: "127.0.0.1:3306:3306"
|
||||
|
||||
# Labels
|
||||
labels:
|
||||
app: myapp
|
||||
|
||||
# Options
|
||||
# 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
|
||||
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
|
||||
# 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.
|
||||
#
|
||||
# ERB files will be evaluated before being copied.
|
||||
files:
|
||||
- config/my.cnf.erb:/etc/mysql/my.cnf
|
||||
- config/myoptions.cnf:/etc/mysql/myoptions.cnf
|
||||
|
||||
# Directories
|
||||
#
|
||||
# You can specify directories to mount into the container. They will be created on the host
|
||||
# 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
|
||||
volumes:
|
||||
- /path/to/mysql-logs:/var/log/mysql
|
||||
26
lib/kamal/configuration/docs/alias.yml
Normal file
26
lib/kamal/configuration/docs/alias.yml
Normal file
@@ -0,0 +1,26 @@
|
||||
# Aliases
|
||||
#
|
||||
# Aliases are shortcuts for Kamal commands.
|
||||
#
|
||||
# For example, for a Rails app, you might open a console with:
|
||||
#
|
||||
# ```shell
|
||||
# kamal app exec -i -r console "rails console"
|
||||
# ```
|
||||
#
|
||||
# By defining an alias, like this:
|
||||
aliases:
|
||||
console: app exec -r console -i "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"
|
||||
19
lib/kamal/configuration/docs/boot.yml
Normal file
19
lib/kamal/configuration/docs/boot.yml
Normal file
@@ -0,0 +1,19 @@
|
||||
# Booting
|
||||
#
|
||||
# When deploying to large numbers of hosts, you might prefer not to restart your services on every host at the same time.
|
||||
#
|
||||
# Kamal’s default is to boot new containers on all hosts in parallel. But you can control this with the boot configuration.
|
||||
|
||||
# Fixed group sizes
|
||||
#
|
||||
# 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.
|
||||
boot:
|
||||
limit: 25%
|
||||
wait: 2
|
||||
105
lib/kamal/configuration/docs/builder.yml
Normal file
105
lib/kamal/configuration/docs/builder.yml
Normal file
@@ -0,0 +1,105 @@
|
||||
# Builder
|
||||
#
|
||||
# The builder configuration controls how the application is built with `docker build`
|
||||
#
|
||||
# If no configuration is specified, Kamal will:
|
||||
# 1. Create a buildx context called `kamal-local-docker-container`, using the docker-container driver
|
||||
# 2. Use `docker 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:
|
||||
# Driver
|
||||
#
|
||||
# The build driver to use, defaults to `docker-container`
|
||||
driver: docker
|
||||
|
||||
# Arch
|
||||
#
|
||||
# The architectures to build for, defaults to `[ amd64, arm64 ]`
|
||||
# Unless you are using the docker driver, when it defaults to the local architecture
|
||||
# You can set an array or just a single value
|
||||
arch:
|
||||
- amd64
|
||||
|
||||
# Remote configuration
|
||||
#
|
||||
# If you have a remote builder, you can configure it here
|
||||
remote: ssh://docker@docker-builder
|
||||
|
||||
# Whether to allow local builds
|
||||
#
|
||||
# Defaults to true
|
||||
local: true
|
||||
|
||||
# Builder cache
|
||||
#
|
||||
# The type must be either 'gha' or 'registry'
|
||||
#
|
||||
# The image is only used for registry cache. Not compatible with the docker driver
|
||||
cache:
|
||||
type: registry
|
||||
options: mode=max
|
||||
image: kamal-app-build-cache
|
||||
|
||||
# Build context
|
||||
#
|
||||
# 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.
|
||||
context: .
|
||||
|
||||
# Dockerfile
|
||||
#
|
||||
# The Dockerfile to use for building, defaults to `Dockerfile`
|
||||
dockerfile: Dockerfile.production
|
||||
|
||||
# Build target
|
||||
#
|
||||
# If not set, then the default target is used
|
||||
target: production
|
||||
|
||||
# Build Arguments
|
||||
#
|
||||
# Any additional build arguments, passed to `docker build` with `--build-arg <key>=<value>`
|
||||
args:
|
||||
ENVIRONMENT: production
|
||||
|
||||
# Referencing build arguments
|
||||
#
|
||||
# ```shell
|
||||
# ARG RUBY_VERSION
|
||||
# FROM ruby:$RUBY_VERSION-slim as base
|
||||
# ```
|
||||
|
||||
# Build secrets
|
||||
#
|
||||
# Values are read from the environment.
|
||||
#
|
||||
secrets:
|
||||
- SECRET1
|
||||
- SECRET2
|
||||
|
||||
# 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)
|
||||
# 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: default=$SSH_AUTH_SOCK
|
||||
180
lib/kamal/configuration/docs/configuration.yml
Normal file
180
lib/kamal/configuration/docs/configuration.yml
Normal file
@@ -0,0 +1,180 @@
|
||||
# Kamal Configuration
|
||||
#
|
||||
# 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`
|
||||
#
|
||||
# In this case the configuration will also be read from `config/deploy.staging.yml`
|
||||
# and merged with the base configuration.
|
||||
|
||||
# Extensions
|
||||
#
|
||||
# Kamal will not accept unrecognized keys in the configuration file.
|
||||
#
|
||||
# However, you might want to declare a configuration block using YAML anchors
|
||||
# and aliases to avoid repetition.
|
||||
#
|
||||
# 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
|
||||
|
||||
# The Docker image name
|
||||
#
|
||||
# The image will be pushed to the configured registry.
|
||||
image: my-image
|
||||
|
||||
# Labels
|
||||
#
|
||||
# Additional labels to add to the container
|
||||
labels:
|
||||
my-label: my-value
|
||||
|
||||
# Additional volumes to mount into the container
|
||||
volumes:
|
||||
- /path/on/host:/path/in/container:ro
|
||||
|
||||
# Registry
|
||||
#
|
||||
# The Docker registry configuration, see kamal docs registry
|
||||
registry:
|
||||
...
|
||||
|
||||
# Servers
|
||||
#
|
||||
# The servers to deploy to, optionally with custom roles, see kamal docs servers
|
||||
servers:
|
||||
...
|
||||
|
||||
# Environment variables
|
||||
#
|
||||
# See kamal docs env
|
||||
env:
|
||||
...
|
||||
|
||||
# Asset Bridging
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# 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).
|
||||
|
||||
# To configure this, set the path to the assets:
|
||||
asset_path: /path/to/assets
|
||||
|
||||
# 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`
|
||||
require_destination: true
|
||||
|
||||
# The primary role
|
||||
#
|
||||
# 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`.
|
||||
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
|
||||
retain_containers: 3
|
||||
|
||||
# Minimum version
|
||||
#
|
||||
# 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 is running, default 7
|
||||
# This only applies to containers that do not specify a healthcheck
|
||||
readiness_delay: 4
|
||||
|
||||
# Run directory
|
||||
#
|
||||
# Directory to store kamal runtime files in on the host, default `.kamal`
|
||||
run_directory: /etc/kamal
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# See kamal docs ssh
|
||||
ssh:
|
||||
...
|
||||
|
||||
# Builder options
|
||||
#
|
||||
# See kamal docs builder
|
||||
builder:
|
||||
...
|
||||
|
||||
# Accessories
|
||||
#
|
||||
# Additionals services to run in Docker, see kamal docs accessory
|
||||
accessories:
|
||||
...
|
||||
|
||||
# Traefik
|
||||
#
|
||||
# The Traefik proxy is used for zero-downtime deployments, see kamal docs traefik
|
||||
traefik:
|
||||
...
|
||||
|
||||
# Proxy
|
||||
#
|
||||
# **Experimental** Configuration for kamal-proxy the replacement for Traefik, see kamal docs proxy
|
||||
proxy:
|
||||
...
|
||||
|
||||
# SSHKit
|
||||
#
|
||||
# See kamal docs sshkit
|
||||
sshkit:
|
||||
...
|
||||
|
||||
# Boot options
|
||||
#
|
||||
# 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
|
||||
logging:
|
||||
...
|
||||
|
||||
# Aliases
|
||||
#
|
||||
# Alias configuration, see kamal docs alias
|
||||
aliases:
|
||||
...
|
||||
70
lib/kamal/configuration/docs/env.yml
Normal file
70
lib/kamal/configuration/docs/env.yml
Normal file
@@ -0,0 +1,70 @@
|
||||
# Environment variables
|
||||
#
|
||||
# Environment variables can be set directly in the Kamal configuration or
|
||||
# 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.
|
||||
env:
|
||||
DATABASE_HOST: mysql-db1
|
||||
DATABASE_PORT: 3306
|
||||
|
||||
# Using .env file to load required environment variables
|
||||
#
|
||||
# Kamal uses dotenv to automatically load environment variables set in the .env file present
|
||||
# in the application root.
|
||||
#
|
||||
# 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:
|
||||
# ```
|
||||
# KAMAL_REGISTRY_PASSWORD=pw
|
||||
# DB_PASSWORD=secret123
|
||||
# ```
|
||||
#
|
||||
# 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
|
||||
env:
|
||||
clear:
|
||||
DB_USER: app
|
||||
secret:
|
||||
- DB_PASSWORD
|
||||
|
||||
# Tags
|
||||
#
|
||||
# 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).
|
||||
#
|
||||
# The env variables can be specified with secret and clear values as explained above.
|
||||
env:
|
||||
tags:
|
||||
<tag1>:
|
||||
MYSQL_USER: monitoring
|
||||
<tag2>:
|
||||
clear:
|
||||
MYSQL_USER: readonly
|
||||
secret:
|
||||
- MYSQL_PASSWORD
|
||||
|
||||
# Example configuration
|
||||
env:
|
||||
clear:
|
||||
MYSQL_USER: app
|
||||
secret:
|
||||
- MYSQL_PASSWORD
|
||||
tags:
|
||||
monitoring:
|
||||
MYSQL_USER: monitoring
|
||||
replica:
|
||||
clear:
|
||||
MYSQL_USER: readonly
|
||||
secret:
|
||||
- READONLY_PASSWORD
|
||||
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, then 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
|
||||
21
lib/kamal/configuration/docs/logging.yml
Normal file
21
lib/kamal/configuration/docs/logging.yml
Normal file
@@ -0,0 +1,21 @@
|
||||
# Custom logging configuration
|
||||
#
|
||||
# Set these to control the Docker logging driver and options.
|
||||
|
||||
# Logging settings
|
||||
#
|
||||
# These go under the logging key in the configuration file.
|
||||
#
|
||||
# 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`
|
||||
driver: json-file
|
||||
|
||||
# Options
|
||||
#
|
||||
# Any logging options to pass to the driver, passed to Docker via `--log-opt`
|
||||
options:
|
||||
max-size: 100m
|
||||
127
lib/kamal/configuration/docs/proxy.yml
Normal file
127
lib/kamal/configuration/docs/proxy.yml
Normal file
@@ -0,0 +1,127 @@
|
||||
# Proxy
|
||||
#
|
||||
# **Experimental** [kamal-proxy](http://github.com/basecamp/kamal-proxy) is a
|
||||
# custom built specifically for Kamal. It will replace Traefik in Kamal v2.0,
|
||||
# but currently is available as an experimental feature.
|
||||
#
|
||||
# When this is enabled, the proxy will be started on the hosts listed under the hosts key.
|
||||
# In addition, the kamal traefik command will be disabled and replaced by kamal proxy.
|
||||
#
|
||||
# The kamal proxy command works identically to kamal traefik on hosts that have not
|
||||
# been included. It will also handle switching between Traefik and kamal-proxy when you
|
||||
# run kamal proxy reboot.
|
||||
|
||||
# Limitations
|
||||
#
|
||||
# Currently the proxy will run on ports 80 and 443 and will bind to those
|
||||
# ports on the host.
|
||||
#
|
||||
# There is no way to set custom options for `docker run` when booting the proxy.
|
||||
#
|
||||
# If you have custom Traefik configuration via labels or boot arguments they may
|
||||
# not have an equivalent in kamal-proxy.
|
||||
|
||||
# Proxy settings
|
||||
#
|
||||
# The proxy is configured in the root configuration under `traefik`. These are
|
||||
# options that are set when deploying the application, not when booting the proxy
|
||||
#
|
||||
# They are application specific, so are not shared when multiple applications
|
||||
# with the same proxy.
|
||||
proxy:
|
||||
|
||||
# Enabled
|
||||
#
|
||||
# Whether to enable experimental proxy support. Defaults to false
|
||||
enabled: true
|
||||
|
||||
# Hosts
|
||||
#
|
||||
# The hosts to run the proxy on, instead of Traefik
|
||||
# This is a temporary setting and will be removed when we full switch to kamal-proxy
|
||||
#
|
||||
# If you run `kamal traefik reboot`, then the proxy will be started on these hosts
|
||||
# in place of traefik.
|
||||
hosts:
|
||||
- 10.0.0.1
|
||||
- 10.0.0.2
|
||||
|
||||
# Host
|
||||
#
|
||||
# This is the host that will be used to serve the app. By setting this you can run
|
||||
# multiple apps on the same server sharing the same instance of the proxy.
|
||||
#
|
||||
# If this is set only requests that match this host will be forwarded by the proxy.
|
||||
# if this is not set, then all requests will be forwarded, except for matching
|
||||
# requests for other apps that do have a host set.
|
||||
host: foo.example.com
|
||||
|
||||
# App port
|
||||
#
|
||||
# The port the application container is exposed on
|
||||
# Defaults to 80
|
||||
app_port: 3000
|
||||
|
||||
# SSL
|
||||
#
|
||||
# Kamal Proxy can automatically obtain and renew TLS certificates for your applications.
|
||||
# To ensure this set, the ssl flag. This only works if we are deploying to one server and
|
||||
# the host flag is set.
|
||||
ssl: true
|
||||
|
||||
# Deploy timeout
|
||||
#
|
||||
# How long to wait for the app to boot when deploying, defaults to 30 seconds
|
||||
deploy_timeout: 10s
|
||||
|
||||
# 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 and Last-Modified request headers are logged
|
||||
logging:
|
||||
request_headers:
|
||||
- Cache-Control
|
||||
- X-Forwarded-Proto
|
||||
response_headers:
|
||||
- X-Request-ID
|
||||
- X-Request-Start
|
||||
|
||||
# Forward headers
|
||||
#
|
||||
# Whether to forward the X-Forwarded-For and X-Forwarded-Proto headers (defaults to false)
|
||||
#
|
||||
# If you are behind a trusted proxy, you can set this to true to forward the headers.
|
||||
forward_headers: true
|
||||
49
lib/kamal/configuration/docs/registry.yml
Normal file
49
lib/kamal/configuration/docs/registry.yml
Normal file
@@ -0,0 +1,49 @@
|
||||
# Registry
|
||||
#
|
||||
# The default registry is Docker Hub, but you can change it using registry/server:
|
||||
#
|
||||
# A reference to secret (in this case DOCKER_REGISTRY_TOKEN) will look up the secret
|
||||
# in the local environment.
|
||||
|
||||
registry:
|
||||
server: registry.digitalocean.com
|
||||
username:
|
||||
- DOCKER_REGISTRY_TOKEN
|
||||
password:
|
||||
- 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 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 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 a roles/artifactregistry.writer role should be sufficient.
|
||||
#
|
||||
# Once the service account is ready, you need to generate and download a JSON key, base64 encode it and add to .env:
|
||||
#
|
||||
# ```shell
|
||||
# echo "KAMAL_REGISTRY_PASSWORD=$(base64 -i /path/to/key.json)" | tr -d "\\n" >> .env
|
||||
# ```
|
||||
# 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
|
||||
password:
|
||||
- KAMAL_REGISTRY_PASSWORD
|
||||
|
||||
# Validating the configuration
|
||||
#
|
||||
# You can validate the configuration by running:
|
||||
# ```shell
|
||||
# kamal registry login
|
||||
# ```
|
||||
52
lib/kamal/configuration/docs/role.yml
Normal file
52
lib/kamal/configuration/docs/role.yml
Normal file
@@ -0,0 +1,52 @@
|
||||
# Roles
|
||||
#
|
||||
# Roles are used to configure different types of servers in the deployment.
|
||||
# The most common use for this is to run a web servers and job servers.
|
||||
#
|
||||
# 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
|
||||
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)
|
||||
web:
|
||||
- 172.1.0.1
|
||||
- 172.1.0.2: experiment1
|
||||
- 172.1.0.2: [ experiment1, experiment2 ]
|
||||
|
||||
# Custom role configuration
|
||||
#
|
||||
# When there are other options to set, the list of hosts goes under the `hosts` key
|
||||
#
|
||||
# By default only the primary role uses Traefik, but you can set `traefik` to change
|
||||
# it.
|
||||
#
|
||||
# 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
|
||||
healthcheck:
|
||||
...
|
||||
logging:
|
||||
...
|
||||
labels:
|
||||
my-label: workers
|
||||
env:
|
||||
...
|
||||
asset_path: /public
|
||||
|
||||
27
lib/kamal/configuration/docs/servers.yml
Normal file
27
lib/kamal/configuration/docs/servers.yml
Normal file
@@ -0,0 +1,27 @@
|
||||
# Servers
|
||||
#
|
||||
# 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
|
||||
# They will be implicitly assigned to the `web` role.
|
||||
servers:
|
||||
- 172.0.0.1
|
||||
- 172.0.0.2
|
||||
- 172.0.0.3
|
||||
|
||||
# Tagging servers
|
||||
#
|
||||
# Servers can be tagged, with the tags used to add custom env variables (see kamal docs env).
|
||||
servers:
|
||||
- 172.0.0.1
|
||||
- 172.0.0.2: experiments
|
||||
- 172.0.0.3: [ experiments, three ]
|
||||
|
||||
# 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)
|
||||
servers:
|
||||
web:
|
||||
...
|
||||
workers:
|
||||
...
|
||||
66
lib/kamal/configuration/docs/ssh.yml
Normal file
66
lib/kamal/configuration/docs/ssh.yml
Normal file
@@ -0,0 +1,66 @@
|
||||
# SSH configuration
|
||||
#
|
||||
# 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 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
|
||||
# sudo apt upgrade -y
|
||||
# sudo apt install -y docker.io curl git
|
||||
# sudo usermod -a -G docker app
|
||||
# ```
|
||||
|
||||
|
||||
# SSH options
|
||||
#
|
||||
# The options are specified under the ssh key in the configuration file.
|
||||
ssh:
|
||||
|
||||
# The SSH user
|
||||
#
|
||||
# Defaults to `root`
|
||||
#
|
||||
user: app
|
||||
|
||||
# The SSH port
|
||||
#
|
||||
# Defaults to 22
|
||||
port: "2222"
|
||||
|
||||
# Proxy 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
|
||||
proxy_command: "ssh -W %h:%p user@proxy"
|
||||
|
||||
# Log level
|
||||
#
|
||||
# Defaults to `fatal`. Set this to debug if you are having
|
||||
# SSH connection issues.
|
||||
log_level: debug
|
||||
|
||||
# Keys Only
|
||||
#
|
||||
# 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 publickey
|
||||
# and hostbased authentication
|
||||
keys: [ "~/.ssh/id.pem" ]
|
||||
|
||||
# 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-----" ]
|
||||
23
lib/kamal/configuration/docs/sshkit.yml
Normal file
23
lib/kamal/configuration/docs/sshkit.yml
Normal file
@@ -0,0 +1,23 @@
|
||||
# SSHKit
|
||||
#
|
||||
# [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
|
||||
|
||||
# SSHKit options
|
||||
#
|
||||
# The options are specified under the sshkit key in the configuration file.
|
||||
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.
|
||||
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, 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,40 +1,29 @@
|
||||
class Kamal::Configuration::Env
|
||||
attr_reader :secrets_keys, :clear, :secrets_file
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :context, :secrets
|
||||
attr_reader :clear, :secret_keys
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
|
||||
def self.from_config(config:, secrets_file: nil)
|
||||
secrets_keys = config.fetch("secret", [])
|
||||
clear = config.fetch("clear", config.key?("secret") || config.key?("tags") ? {} : config)
|
||||
|
||||
new clear: clear, secrets_keys: secrets_keys, secrets_file: secrets_file
|
||||
def initialize(config:, secrets:, context: "env")
|
||||
@clear = config.fetch("clear", config.key?("secret") || config.key?("tags") ? {} : config)
|
||||
@secrets = secrets
|
||||
@secret_keys = config.fetch("secret", [])
|
||||
@context = context
|
||||
validate! config, context: context, with: Kamal::Configuration::Validator::Env
|
||||
end
|
||||
|
||||
def initialize(clear:, secrets_keys:, secrets_file:)
|
||||
@clear = clear
|
||||
@secrets_keys = secrets_keys
|
||||
@secrets_file = secrets_file
|
||||
end
|
||||
|
||||
def args
|
||||
[ "--env-file", secrets_file, *argumentize("--env", clear) ]
|
||||
def clear_args
|
||||
argumentize("--env", clear)
|
||||
end
|
||||
|
||||
def secrets_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)
|
||||
Kamal::EnvFile.new(secret_keys.to_h { |key| [ key, secrets[key] ] }).to_io
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new \
|
||||
clear: @clear.merge(other.clear),
|
||||
secrets_keys: @secrets_keys | other.secrets_keys,
|
||||
secrets_file: secrets_file
|
||||
config: { "clear" => clear.merge(other.clear), "secret" => secret_keys | other.secret_keys },
|
||||
secrets: secrets
|
||||
end
|
||||
end
|
||||
|
||||
7
lib/kamal/configuration/env/tag.rb
vendored
7
lib/kamal/configuration/env/tag.rb
vendored
@@ -1,12 +1,13 @@
|
||||
class Kamal::Configuration::Env::Tag
|
||||
attr_reader :name, :config
|
||||
attr_reader :name, :config, :secrets
|
||||
|
||||
def initialize(name, config:)
|
||||
def initialize(name, config:, secrets:)
|
||||
@name = name
|
||||
@config = config
|
||||
@secrets = secrets
|
||||
end
|
||||
|
||||
def env
|
||||
Kamal::Configuration::Env.from_config(config: config)
|
||||
Kamal::Configuration::Env.new(config: config, secrets: secrets)
|
||||
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
|
||||
33
lib/kamal/configuration/logging.rb
Normal file
33
lib/kamal/configuration/logging.rb
Normal file
@@ -0,0 +1,33 @@
|
||||
class Kamal::Configuration::Logging
|
||||
delegate :optionize, :argumentize, to: Kamal::Utils
|
||||
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :logging_config
|
||||
|
||||
def initialize(logging_config:, context: "logging")
|
||||
@logging_config = logging_config || {}
|
||||
validate! @logging_config, context: context
|
||||
end
|
||||
|
||||
def driver
|
||||
logging_config["driver"]
|
||||
end
|
||||
|
||||
def options
|
||||
logging_config.fetch("options", {})
|
||||
end
|
||||
|
||||
def merge(other)
|
||||
self.class.new logging_config: logging_config.deep_merge(other.logging_config)
|
||||
end
|
||||
|
||||
def args
|
||||
if driver.present? || options.present?
|
||||
optionize({ "log-driver" => driver }.compact) +
|
||||
argumentize("--log-opt", options)
|
||||
else
|
||||
argumentize("--log-opt", { "max-size" => "10m" })
|
||||
end
|
||||
end
|
||||
end
|
||||
80
lib/kamal/configuration/proxy.rb
Normal file
80
lib/kamal/configuration/proxy.rb
Normal file
@@ -0,0 +1,80 @@
|
||||
class Kamal::Configuration::Proxy
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
DEFAULT_HTTP_PORT = 80
|
||||
DEFAULT_HTTPS_PORT = 443
|
||||
DEFAULT_IMAGE = "basecamp/kamal-proxy:latest"
|
||||
DEFAULT_LOG_REQUEST_HEADERS = [ "Cache-Control", "Last-Modified" ]
|
||||
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
def initialize(config:)
|
||||
@config = config
|
||||
@proxy_config = config.raw_config.proxy || {}
|
||||
validate! proxy_config, with: Kamal::Configuration::Validator::Proxy
|
||||
end
|
||||
|
||||
def enabled?
|
||||
!!proxy_config.fetch("enabled", false)
|
||||
end
|
||||
|
||||
def hosts
|
||||
if enabled?
|
||||
proxy_config.fetch("hosts", [])
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
def app_port
|
||||
proxy_config.fetch("app_port", 80)
|
||||
end
|
||||
|
||||
def image
|
||||
proxy_config.fetch("image", DEFAULT_IMAGE)
|
||||
end
|
||||
|
||||
def container_name
|
||||
"kamal-proxy"
|
||||
end
|
||||
|
||||
def publish_args
|
||||
argumentize "--publish", [ "#{DEFAULT_HTTP_PORT}:#{DEFAULT_HTTP_PORT}", "#{DEFAULT_HTTPS_PORT}:#{DEFAULT_HTTPS_PORT}" ]
|
||||
end
|
||||
|
||||
def ssl?
|
||||
proxy_config.fetch("ssl", false)
|
||||
end
|
||||
|
||||
def deploy_options
|
||||
{
|
||||
host: proxy_config["host"],
|
||||
tls: proxy_config["ssl"],
|
||||
"deploy-timeout": proxy_config["deploy_timeout"],
|
||||
"drain-timeout": proxy_config["drain_timeout"],
|
||||
"health-check-interval": proxy_config.dig("health_check", "interval"),
|
||||
"health-check-timeout": proxy_config.dig("health_check", "timeout"),
|
||||
"health-check-path": proxy_config.dig("health_check", "path"),
|
||||
"target-timeout": 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
|
||||
optionize deploy_options
|
||||
end
|
||||
|
||||
def config_directory_as_docker_volume
|
||||
File.join config.run_directory_as_docker_volume, "proxy", "config"
|
||||
end
|
||||
|
||||
private
|
||||
attr_reader :config, :proxy_config
|
||||
end
|
||||
32
lib/kamal/configuration/registry.rb
Normal file
32
lib/kamal/configuration/registry.rb
Normal file
@@ -0,0 +1,32 @@
|
||||
class Kamal::Configuration::Registry
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :registry_config, :secrets
|
||||
|
||||
def initialize(config:)
|
||||
@registry_config = config.raw_config.registry || {}
|
||||
@secrets = config.secrets
|
||||
validate! registry_config, with: Kamal::Configuration::Validator::Registry
|
||||
end
|
||||
|
||||
def server
|
||||
registry_config["server"]
|
||||
end
|
||||
|
||||
def username
|
||||
lookup("username")
|
||||
end
|
||||
|
||||
def password
|
||||
lookup("password")
|
||||
end
|
||||
|
||||
private
|
||||
def lookup(key)
|
||||
if registry_config[key].is_a?(Array)
|
||||
secrets[registry_config[key].first]
|
||||
else
|
||||
registry_config[key]
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,13 +1,33 @@
|
||||
class Kamal::Configuration::Role
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
CORD_FILE = "cord"
|
||||
delegate :argumentize, :optionize, to: Kamal::Utils
|
||||
|
||||
attr_accessor :name
|
||||
attr_reader :name, :config, :specialized_env, :specialized_logging, :specialized_healthcheck
|
||||
|
||||
alias to_s name
|
||||
|
||||
def initialize(name, config:)
|
||||
@name, @config = name.inquiry, config
|
||||
@tagged_hosts ||= extract_tagged_hosts_from_config
|
||||
validate! \
|
||||
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,
|
||||
context: "servers/#{name}/env"
|
||||
|
||||
@specialized_logging = Kamal::Configuration::Logging.new \
|
||||
logging_config: specializations.fetch("logging", {}),
|
||||
context: "servers/#{name}/logging"
|
||||
|
||||
@specialized_healthcheck = Kamal::Configuration::Healthcheck.new \
|
||||
healthcheck_config: specializations.fetch("healthcheck", {}),
|
||||
context: "servers/#{name}/healthcheck"
|
||||
end
|
||||
|
||||
def primary_host
|
||||
@@ -38,30 +58,46 @@ class Kamal::Configuration::Role
|
||||
default_labels.merge(traefik_labels).merge(custom_labels)
|
||||
end
|
||||
|
||||
def labels_for_proxy
|
||||
default_labels.merge(custom_labels)
|
||||
end
|
||||
|
||||
def label_args
|
||||
argumentize "--label", labels
|
||||
end
|
||||
|
||||
def logging_args
|
||||
args = config.logging || {}
|
||||
args.deep_merge!(specializations["logging"]) if specializations["logging"].present?
|
||||
|
||||
if args.any?
|
||||
optionize({ "log-driver" => args["driver"] }.compact) +
|
||||
argumentize("--log-opt", args["options"])
|
||||
else
|
||||
config.logging_args
|
||||
def label_args_for_proxy
|
||||
argumentize "--label", labels_for_proxy
|
||||
end
|
||||
|
||||
def logging_args
|
||||
logging.args
|
||||
end
|
||||
|
||||
def logging
|
||||
@logging ||= config.logging.merge(specialized_logging)
|
||||
end
|
||||
|
||||
|
||||
def env(host)
|
||||
@envs ||= {}
|
||||
@envs[host] ||= [ base_env, specialized_env, *env_tags(host).map(&:env) ].reduce(:merge)
|
||||
@envs[host] ||= [ config.env, specialized_env, *env_tags(host).map(&:env) ].reduce(:merge)
|
||||
end
|
||||
|
||||
def env_args(host)
|
||||
env(host).args
|
||||
[ *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", "#{container_prefix}.env")
|
||||
end
|
||||
|
||||
def asset_volume_args
|
||||
@@ -70,28 +106,29 @@ class Kamal::Configuration::Role
|
||||
|
||||
|
||||
def health_check_args(cord: true)
|
||||
if health_check_cmd.present?
|
||||
if running_traefik? || healthcheck.set_port_or_path?
|
||||
if cord && uses_cord?
|
||||
optionize({ "health-cmd" => health_check_cmd_with_cord, "health-interval" => health_check_interval })
|
||||
optionize({ "health-cmd" => health_check_cmd_with_cord, "health-interval" => healthcheck.interval })
|
||||
.concat(cord_volume.docker_args)
|
||||
else
|
||||
optionize({ "health-cmd" => health_check_cmd, "health-interval" => health_check_interval })
|
||||
optionize({ "health-cmd" => healthcheck.cmd, "health-interval" => healthcheck.interval })
|
||||
end
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
def health_check_cmd
|
||||
health_check_options["cmd"] || http_health_check(port: health_check_options["port"], path: health_check_options["path"])
|
||||
def healthcheck
|
||||
@healthcheck ||=
|
||||
if running_traefik?
|
||||
config.healthcheck.merge(specialized_healthcheck)
|
||||
else
|
||||
specialized_healthcheck
|
||||
end
|
||||
end
|
||||
|
||||
def health_check_cmd_with_cord
|
||||
"(#{health_check_cmd}) && (stat #{cord_container_file} > /dev/null || exit 1)"
|
||||
end
|
||||
|
||||
def health_check_interval
|
||||
health_check_options["interval"] || "1s"
|
||||
"(#{healthcheck.cmd}) && (stat #{cord_container_file} > /dev/null || exit 1)"
|
||||
end
|
||||
|
||||
|
||||
@@ -109,7 +146,7 @@ class Kamal::Configuration::Role
|
||||
|
||||
|
||||
def uses_cord?
|
||||
running_traefik? && cord_volume && health_check_cmd.present?
|
||||
running_traefik? && cord_volume && healthcheck.cmd.present?
|
||||
end
|
||||
|
||||
def cord_host_directory
|
||||
@@ -117,7 +154,7 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
def cord_volume
|
||||
if (cord = health_check_options["cord"])
|
||||
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
|
||||
@@ -170,30 +207,24 @@ class Kamal::Configuration::Role
|
||||
end
|
||||
|
||||
private
|
||||
attr_accessor :config, :tagged_hosts
|
||||
|
||||
def extract_tagged_hosts_from_config
|
||||
def tagged_hosts
|
||||
{}.tap do |tagged_hosts|
|
||||
extract_hosts_from_config.map do |host_config|
|
||||
if host_config.is_a?(Hash)
|
||||
raise ArgumentError, "Multiple hosts found: #{host_config.inspect}" unless host_config.size == 1
|
||||
|
||||
host, tags = host_config.first
|
||||
tagged_hosts[host] = Array(tags)
|
||||
elsif host_config.is_a?(String) || host_config.is_a?(Symbol)
|
||||
elsif host_config.is_a?(String)
|
||||
tagged_hosts[host_config] = []
|
||||
else
|
||||
raise ArgumentError, "Invalid host config: #{host_config.inspect}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def extract_hosts_from_config
|
||||
if config.servers.is_a?(Array)
|
||||
config.servers
|
||||
if config.raw_config.servers.is_a?(Array)
|
||||
config.raw_config.servers
|
||||
else
|
||||
servers = config.servers[name]
|
||||
servers = config.raw_config.servers[name]
|
||||
servers.is_a?(Array) ? servers : Array(servers["hosts"])
|
||||
end
|
||||
end
|
||||
@@ -202,6 +233,14 @@ class Kamal::Configuration::Role
|
||||
{ "service" => config.service, "role" => name, "destination" => config.destination }
|
||||
end
|
||||
|
||||
def specializations
|
||||
if config.raw_config.servers.is_a?(Array) || config.raw_config.servers[name].is_a?(Array)
|
||||
{}
|
||||
else
|
||||
config.raw_config.servers[name]
|
||||
end
|
||||
end
|
||||
|
||||
def traefik_labels
|
||||
if running_traefik?
|
||||
{
|
||||
@@ -229,35 +268,4 @@ class Kamal::Configuration::Role
|
||||
labels.merge!(specializations["labels"]) if specializations["labels"].present?
|
||||
end
|
||||
end
|
||||
|
||||
def specializations
|
||||
if config.servers.is_a?(Array) || config.servers[name].is_a?(Array)
|
||||
{}
|
||||
else
|
||||
config.servers[name].except("hosts")
|
||||
end
|
||||
end
|
||||
|
||||
def specialized_env
|
||||
Kamal::Configuration::Env.from_config config: specializations.fetch("env", {})
|
||||
end
|
||||
|
||||
# Secrets are stored in an array, which won't merge by default, so have to do it by hand.
|
||||
def base_env
|
||||
Kamal::Configuration::Env.from_config \
|
||||
config: config.env,
|
||||
secrets_file: File.join(config.host_env_directory, "roles", "#{container_prefix}.env")
|
||||
end
|
||||
|
||||
def http_health_check(port:, path:)
|
||||
"curl -f #{URI.join("http://localhost:#{port}", path)} || exit 1" if path.present? || port.present?
|
||||
end
|
||||
|
||||
def health_check_options
|
||||
@health_check_options ||= begin
|
||||
options = specializations["healthcheck"] || {}
|
||||
options = config.healthcheck.merge(options) if running_traefik?
|
||||
options
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
18
lib/kamal/configuration/servers.rb
Normal file
18
lib/kamal/configuration/servers.rb
Normal file
@@ -0,0 +1,18 @@
|
||||
class Kamal::Configuration::Servers
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :config, :servers_config, :roles
|
||||
|
||||
def initialize(config:)
|
||||
@config = config
|
||||
@servers_config = config.raw_config.servers
|
||||
validate! servers_config, with: Kamal::Configuration::Validator::Servers
|
||||
|
||||
@roles = role_names.map { |role_name| Kamal::Configuration::Role.new role_name, config: config }
|
||||
end
|
||||
|
||||
private
|
||||
def role_names
|
||||
servers_config.is_a?(Array) ? [ "web" ] : servers_config.keys.sort
|
||||
end
|
||||
end
|
||||
@@ -1,28 +1,45 @@
|
||||
class Kamal::Configuration::Ssh
|
||||
LOGGER = ::Logger.new(STDERR)
|
||||
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :ssh_config
|
||||
|
||||
def initialize(config:)
|
||||
@config = config.raw_config.ssh || {}
|
||||
@ssh_config = config.raw_config.ssh || {}
|
||||
validate! ssh_config
|
||||
end
|
||||
|
||||
def user
|
||||
config.fetch("user", "root")
|
||||
ssh_config.fetch("user", "root")
|
||||
end
|
||||
|
||||
def port
|
||||
config.fetch("port", 22)
|
||||
ssh_config.fetch("port", 22)
|
||||
end
|
||||
|
||||
def proxy
|
||||
if (proxy = config["proxy"])
|
||||
if (proxy = ssh_config["proxy"])
|
||||
Net::SSH::Proxy::Jump.new(proxy.include?("@") ? proxy : "root@#{proxy}")
|
||||
elsif (proxy_command = config["proxy_command"])
|
||||
elsif (proxy_command = ssh_config["proxy_command"])
|
||||
Net::SSH::Proxy::Command.new(proxy_command)
|
||||
end
|
||||
end
|
||||
|
||||
def keys_only
|
||||
ssh_config["keys_only"]
|
||||
end
|
||||
|
||||
def keys
|
||||
ssh_config["keys"]
|
||||
end
|
||||
|
||||
def key_data
|
||||
ssh_config["key_data"]
|
||||
end
|
||||
|
||||
def options
|
||||
{ user: user, port: port, proxy: proxy, logger: logger, keepalive: true, keepalive_interval: 30 }.compact
|
||||
{ user: user, port: port, proxy: proxy, logger: logger, keepalive: true, keepalive_interval: 30, keys_only: keys_only, keys: keys, key_data: key_data }.compact
|
||||
end
|
||||
|
||||
def to_h
|
||||
@@ -30,13 +47,11 @@ class Kamal::Configuration::Ssh
|
||||
end
|
||||
|
||||
private
|
||||
attr_accessor :config
|
||||
|
||||
def logger
|
||||
LOGGER.tap { |logger| logger.level = log_level }
|
||||
end
|
||||
|
||||
def log_level
|
||||
config.fetch("log_level", :fatal)
|
||||
ssh_config.fetch("log_level", :fatal)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,20 +1,22 @@
|
||||
class Kamal::Configuration::Sshkit
|
||||
include Kamal::Configuration::Validation
|
||||
|
||||
attr_reader :sshkit_config
|
||||
|
||||
def initialize(config:)
|
||||
@options = config.raw_config.sshkit || {}
|
||||
@sshkit_config = config.raw_config.sshkit || {}
|
||||
validate! sshkit_config
|
||||
end
|
||||
|
||||
def max_concurrent_starts
|
||||
options.fetch("max_concurrent_starts", 30)
|
||||
sshkit_config.fetch("max_concurrent_starts", 30)
|
||||
end
|
||||
|
||||
def pool_idle_timeout
|
||||
options.fetch("pool_idle_timeout", 900)
|
||||
sshkit_config.fetch("pool_idle_timeout", 900)
|
||||
end
|
||||
|
||||
def to_h
|
||||
options
|
||||
sshkit_config
|
||||
end
|
||||
|
||||
private
|
||||
attr_accessor :options
|
||||
end
|
||||
|
||||
78
lib/kamal/configuration/traefik.rb
Normal file
78
lib/kamal/configuration/traefik.rb
Normal file
@@ -0,0 +1,78 @@
|
||||
class Kamal::Configuration::Traefik
|
||||
delegate :argumentize, to: Kamal::Utils
|
||||
|
||||
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: config.secrets,
|
||||
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
|
||||
|
||||
def env_args
|
||||
[ *env.clear_args, *argumentize("--env-file", secrets_path) ]
|
||||
end
|
||||
|
||||
def env_directory
|
||||
File.join(config.env_directory, "traefik")
|
||||
end
|
||||
|
||||
def secrets_io
|
||||
env.secrets_io
|
||||
end
|
||||
|
||||
def secrets_path
|
||||
File.join(config.env_directory, "traefik", "traefik.env")
|
||||
end
|
||||
end
|
||||
27
lib/kamal/configuration/validation.rb
Normal file
27
lib/kamal/configuration/validation.rb
Normal file
@@ -0,0 +1,27 @@
|
||||
require "yaml"
|
||||
require "active_support/inflector"
|
||||
|
||||
module Kamal::Configuration::Validation
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
class_methods do
|
||||
def validation_doc
|
||||
@validation_doc ||= File.read(File.join(File.dirname(__FILE__), "docs", "#{validation_config_key}.yml"))
|
||||
end
|
||||
|
||||
def validation_config_key
|
||||
@validation_config_key ||= name.demodulize.underscore
|
||||
end
|
||||
end
|
||||
|
||||
def validate!(config, example: nil, context: nil, with: Kamal::Configuration::Validator)
|
||||
context ||= self.class.validation_config_key
|
||||
example ||= validation_yml[self.class.validation_config_key]
|
||||
|
||||
with.new(config, example: example, context: context).validate!
|
||||
end
|
||||
|
||||
def validation_yml
|
||||
@validation_yml ||= YAML.load(self.class.validation_doc)
|
||||
end
|
||||
end
|
||||
169
lib/kamal/configuration/validator.rb
Normal file
169
lib/kamal/configuration/validator.rb
Normal file
@@ -0,0 +1,169 @@
|
||||
class Kamal::Configuration::Validator
|
||||
attr_reader :config, :example, :context
|
||||
|
||||
def initialize(config, example:, context:)
|
||||
@config = config
|
||||
@example = example
|
||||
@context = context
|
||||
end
|
||||
|
||||
def validate!
|
||||
validate_against_example! config, example
|
||||
end
|
||||
|
||||
private
|
||||
def validate_against_example!(validation_config, example)
|
||||
validate_type! validation_config, example.class
|
||||
|
||||
if example.class == Hash
|
||||
check_unknown_keys! validation_config, example
|
||||
|
||||
validation_config.each do |key, value|
|
||||
next if extension?(key)
|
||||
with_context(key) do
|
||||
example_value = example[key]
|
||||
|
||||
if example_value == "..."
|
||||
validate_type! value, *(Array if key == :servers), Hash
|
||||
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
|
||||
else
|
||||
validate_type! value, example_value.class
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
def valid_type?(value, type)
|
||||
value.is_a?(type) ||
|
||||
(type == String && stringish?(value)) ||
|
||||
(boolean?(type) && boolean?(value.class))
|
||||
end
|
||||
|
||||
def type_description(type)
|
||||
if type == Integer || type == Array
|
||||
"an #{type.name.downcase}"
|
||||
elsif type == TrueClass || type == FalseClass
|
||||
"a boolean"
|
||||
else
|
||||
"a #{type.name.downcase}"
|
||||
end
|
||||
end
|
||||
|
||||
def boolean?(type)
|
||||
type == TrueClass || type == FalseClass
|
||||
end
|
||||
|
||||
def stringish?(value)
|
||||
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
|
||||
|
||||
array.each_with_index do |value, index|
|
||||
with_context(index) do
|
||||
validate_type! value, type
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def validate_hash_of!(hash, type)
|
||||
validate_type! hash, Hash
|
||||
|
||||
hash.each do |key, value|
|
||||
with_context(key) do
|
||||
validate_type! value, type
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def validate_servers!(servers)
|
||||
validate_type! servers, Array
|
||||
|
||||
servers.each_with_index do |server, index|
|
||||
with_context(index) do
|
||||
validate_type! server, String, Hash
|
||||
|
||||
if server.is_a?(Hash)
|
||||
error "multiple hosts found" unless server.size == 1
|
||||
host, tags = server.first
|
||||
|
||||
with_context(host) do
|
||||
validate_type! tags, String, Array
|
||||
validate_array_of! tags, String if tags.is_a?(Array)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def validate_type!(value, *types)
|
||||
type_error(*types) unless types.any? { |type| valid_type?(value, type) }
|
||||
end
|
||||
|
||||
def error(message)
|
||||
raise Kamal::ConfigurationError, "#{error_context}#{message}"
|
||||
end
|
||||
|
||||
def type_error(*expected_types)
|
||||
error "should be #{expected_types.map { |type| type_description(type) }.join(" or ")}"
|
||||
end
|
||||
|
||||
def unknown_keys_error(unknown_keys)
|
||||
error "unknown #{"key".pluralize(unknown_keys.count)}: #{unknown_keys.join(", ")}"
|
||||
end
|
||||
|
||||
def error_context
|
||||
"#{context}: " if context.present?
|
||||
end
|
||||
|
||||
def with_context(context)
|
||||
old_context = @context
|
||||
@context = [ @context, context ].select(&:present?).join("/")
|
||||
yield
|
||||
ensure
|
||||
@context = old_context
|
||||
end
|
||||
|
||||
def allow_extensions?
|
||||
false
|
||||
end
|
||||
|
||||
def extension?(key)
|
||||
key.to_s.start_with?("x-")
|
||||
end
|
||||
|
||||
def check_unknown_keys!(config, example)
|
||||
unknown_keys = config.keys - example.keys
|
||||
unknown_keys.reject! { |key| extension?(key) } if allow_extensions?
|
||||
unknown_keys_error unknown_keys if unknown_keys.present?
|
||||
end
|
||||
end
|
||||
9
lib/kamal/configuration/validator/accessory.rb
Normal file
9
lib/kamal/configuration/validator/accessory.rb
Normal file
@@ -0,0 +1,9 @@
|
||||
class Kamal::Configuration::Validator::Accessory < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
super
|
||||
|
||||
if (config.keys & [ "host", "hosts", "roles" ]).size != 1
|
||||
error "specify one of `host`, `hosts` or `roles`"
|
||||
end
|
||||
end
|
||||
end
|
||||
15
lib/kamal/configuration/validator/alias.rb
Normal file
15
lib/kamal/configuration/validator/alias.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
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
|
||||
13
lib/kamal/configuration/validator/builder.rb
Normal file
13
lib/kamal/configuration/validator/builder.rb
Normal file
@@ -0,0 +1,13 @@
|
||||
class Kamal::Configuration::Validator::Builder < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
super
|
||||
|
||||
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
|
||||
6
lib/kamal/configuration/validator/configuration.rb
Normal file
6
lib/kamal/configuration/validator/configuration.rb
Normal file
@@ -0,0 +1,6 @@
|
||||
class Kamal::Configuration::Validator::Configuration < Kamal::Configuration::Validator
|
||||
private
|
||||
def allow_extensions?
|
||||
true
|
||||
end
|
||||
end
|
||||
54
lib/kamal/configuration/validator/env.rb
Normal file
54
lib/kamal/configuration/validator/env.rb
Normal file
@@ -0,0 +1,54 @@
|
||||
class Kamal::Configuration::Validator::Env < Kamal::Configuration::Validator
|
||||
SPECIAL_KEYS = [ "clear", "secret", "tags" ]
|
||||
|
||||
def validate!
|
||||
if known_keys.any?
|
||||
validate_complex_env!
|
||||
else
|
||||
validate_simple_env!
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def validate_simple_env!
|
||||
validate_hash_of!(config, String)
|
||||
end
|
||||
|
||||
def validate_complex_env!
|
||||
unknown_keys_error unknown_keys if unknown_keys.any?
|
||||
|
||||
with_context("clear") { validate_hash_of!(config["clear"], String) } if config.key?("clear")
|
||||
with_context("secret") { validate_array_of!(config["secret"], String) } if config.key?("secret")
|
||||
validate_tags! if config.key?("tags")
|
||||
end
|
||||
|
||||
def known_keys
|
||||
@known_keys ||= config.keys & SPECIAL_KEYS
|
||||
end
|
||||
|
||||
def unknown_keys
|
||||
@unknown_keys ||= config.keys - SPECIAL_KEYS
|
||||
end
|
||||
|
||||
def validate_tags!
|
||||
if context == "env"
|
||||
with_context("tags") do
|
||||
validate_type! config["tags"], Hash
|
||||
|
||||
config["tags"].each do |tag, value|
|
||||
with_context(tag) do
|
||||
validate_type! value, Hash
|
||||
|
||||
Kamal::Configuration::Validator::Env.new(
|
||||
value,
|
||||
example: example["tags"].values[1],
|
||||
context: context
|
||||
).validate!
|
||||
end
|
||||
end
|
||||
end
|
||||
else
|
||||
error "tags are only allowed in the root env"
|
||||
end
|
||||
end
|
||||
end
|
||||
9
lib/kamal/configuration/validator/proxy.rb
Normal file
9
lib/kamal/configuration/validator/proxy.rb
Normal file
@@ -0,0 +1,9 @@
|
||||
class Kamal::Configuration::Validator::Proxy < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
super
|
||||
|
||||
if config["host"].blank? && config["ssl"]
|
||||
error "Must set a host to enable automatic SSL"
|
||||
end
|
||||
end
|
||||
end
|
||||
25
lib/kamal/configuration/validator/registry.rb
Normal file
25
lib/kamal/configuration/validator/registry.rb
Normal file
@@ -0,0 +1,25 @@
|
||||
class Kamal::Configuration::Validator::Registry < Kamal::Configuration::Validator
|
||||
STRING_OR_ONE_ITEM_ARRAY_KEYS = [ "username", "password" ]
|
||||
|
||||
def validate!
|
||||
validate_against_example! \
|
||||
config.except(*STRING_OR_ONE_ITEM_ARRAY_KEYS),
|
||||
example.except(*STRING_OR_ONE_ITEM_ARRAY_KEYS)
|
||||
|
||||
validate_string_or_one_item_array! "username"
|
||||
validate_string_or_one_item_array! "password"
|
||||
end
|
||||
|
||||
private
|
||||
def validate_string_or_one_item_array!(key)
|
||||
with_context(key) do
|
||||
value = config[key]
|
||||
|
||||
error "is required" unless value.present?
|
||||
|
||||
unless value.is_a?(String) || (value.is_a?(Array) && value.size == 1 && value.first.is_a?(String))
|
||||
error "should be a string or an array with one string (for secret lookup)"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
11
lib/kamal/configuration/validator/role.rb
Normal file
11
lib/kamal/configuration/validator/role.rb
Normal file
@@ -0,0 +1,11 @@
|
||||
class Kamal::Configuration::Validator::Role < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
validate_type! config, Array, Hash
|
||||
|
||||
if config.is_a?(Array)
|
||||
validate_servers! "servers", config
|
||||
else
|
||||
super
|
||||
end
|
||||
end
|
||||
end
|
||||
7
lib/kamal/configuration/validator/servers.rb
Normal file
7
lib/kamal/configuration/validator/servers.rb
Normal file
@@ -0,0 +1,7 @@
|
||||
class Kamal::Configuration::Validator::Servers < Kamal::Configuration::Validator
|
||||
def validate!
|
||||
validate_type! config, Array, Hash
|
||||
|
||||
validate_servers! config if config.is_a?(Array)
|
||||
end
|
||||
end
|
||||
@@ -15,6 +15,10 @@ class Kamal::EnvFile
|
||||
env_file.presence || "\n"
|
||||
end
|
||||
|
||||
def to_io
|
||||
StringIO.new(to_s)
|
||||
end
|
||||
|
||||
alias to_str to_s
|
||||
|
||||
private
|
||||
|
||||
@@ -9,6 +9,10 @@ module Kamal::Git
|
||||
`git config user.name`.strip
|
||||
end
|
||||
|
||||
def email
|
||||
`git config user.email`.strip
|
||||
end
|
||||
|
||||
def revision
|
||||
`git rev-parse HEAD`.strip
|
||||
end
|
||||
|
||||
33
lib/kamal/secrets.rb
Normal file
33
lib/kamal/secrets.rb
Normal file
@@ -0,0 +1,33 @@
|
||||
require "dotenv"
|
||||
|
||||
class Kamal::Secrets
|
||||
attr_reader :secrets_files
|
||||
|
||||
Kamal::Secrets::Dotenv::InlineCommandSubstitution.install!
|
||||
|
||||
def initialize(destination: nil)
|
||||
@secrets_files = \
|
||||
[ ".kamal/secrets-common", ".kamal/secrets#{(".#{destination}" if destination)}" ].select { |f| File.exist?(f) }
|
||||
end
|
||||
|
||||
def [](key)
|
||||
secrets.fetch(key)
|
||||
rescue KeyError
|
||||
if secrets_files
|
||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found in #{secrets_files.join(", ")}"
|
||||
else
|
||||
raise Kamal::ConfigurationError, "Secret '#{key}' not found, no secret files provided"
|
||||
end
|
||||
end
|
||||
|
||||
def to_h
|
||||
secrets
|
||||
end
|
||||
|
||||
private
|
||||
def secrets
|
||||
@secrets ||= secrets_files.inject({}) do |secrets, secrets_file|
|
||||
secrets.merge!(::Dotenv.parse(secrets_file))
|
||||
end
|
||||
end
|
||||
end
|
||||
14
lib/kamal/secrets/adapters.rb
Normal file
14
lib/kamal/secrets/adapters.rb
Normal file
@@ -0,0 +1,14 @@
|
||||
require "active_support/core_ext/string/inflections"
|
||||
module Kamal::Secrets::Adapters
|
||||
def self.lookup(name)
|
||||
name = "one_password" if name.downcase == "1password"
|
||||
name = "last_pass" if name.downcase == "lastpass"
|
||||
adapter_class(name)
|
||||
end
|
||||
|
||||
def self.adapter_class(name)
|
||||
Object.const_get("Kamal::Secrets::Adapters::#{name.camelize}").new
|
||||
rescue NameError => e
|
||||
raise RuntimeError, "Unknown secrets adapter: #{name}"
|
||||
end
|
||||
end
|
||||
18
lib/kamal/secrets/adapters/base.rb
Normal file
18
lib/kamal/secrets/adapters/base.rb
Normal file
@@ -0,0 +1,18 @@
|
||||
class Kamal::Secrets::Adapters::Base
|
||||
delegate :optionize, to: Kamal::Utils
|
||||
|
||||
def fetch(secrets, account:, from: nil)
|
||||
session = login(account)
|
||||
full_secrets = secrets.map { |secret| [ from, secret ].compact.join("/") }
|
||||
fetch_secrets(full_secrets, account: account, session: session)
|
||||
end
|
||||
|
||||
private
|
||||
def login(...)
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
def fetch_secrets(...)
|
||||
raise NotImplementedError
|
||||
end
|
||||
end
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user