Class: Kamal::Configuration

Inherits:
Object
  • Object
show all
Includes:
Validation
Defined in:
lib/kamal/configuration.rb

Defined Under Namespace

Modules: Validation Classes: Accessory, Alias, Boot, Builder, Env, Loadbalancer, Logging, Output, Proxy, Registry, Role, Servers, Ssh, Sshkit, Validator, Volume

Constant Summary collapse

HOOKS_OUTPUT_LEVELS = 
[ :quiet, :verbose ].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Validation

#validate!, #validation_yml

Constructor Details

#initialize(raw_config, destination: nil, version: nil, validate: true) ⇒ Configuration

Returns a new instance of Configuration.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/kamal/configuration.rb', line 54

def initialize(raw_config, destination: nil, version: nil, validate: true)
  @raw_config = ActiveSupport::InheritableOptions.new(raw_config)
  @destination = destination
  @declared_version = version

  validate! raw_config, example: validation_yml.symbolize_keys, context: "", with: Kamal::Configuration::Validator::Configuration

  @secrets = Kamal::Secrets.new(destination: destination, secrets_path: secrets_path)

  # Eager load config to validate it, these are first as they have dependencies later on
  @servers = Servers.new(config: self)
  @registry = Registry.new(config: @raw_config, secrets: secrets)

  @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)

  @logging = Logging.new(logging_config: @raw_config.logging)
  @output = Output.new(config: self)
  @proxy = Proxy.new(config: self, proxy_config: @raw_config.proxy, secrets: secrets)
  @proxy_boot = Proxy::Boot.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
  ensure_no_traefik_reboot_hooks
  ensure_one_host_for_ssl_roles
  ensure_unique_hosts_for_ssl_roles
  ensure_local_registry_remote_builder_has_ssh_url
  ensure_no_conflicting_proxy_runs
  ensure_valid_hooks_output!
end

Instance Attribute Details

#accessories ⇒ Object (readonly)

Returns the value of attribute accessories.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def accessories
  @accessories
end

#aliases ⇒ Object (readonly)

Returns the value of attribute aliases.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def aliases
  @aliases
end

#boot ⇒ Object (readonly)

Returns the value of attribute boot.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def boot
  @boot
end

#builder ⇒ Object (readonly)

Returns the value of attribute builder.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def builder
  @builder
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



14
15
16
 
# File 'lib/kamal/configuration.rb', line 14

def destination
  @destination
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def env
  @env
end

#logging ⇒ Object (readonly)

Returns the value of attribute logging.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def logging
  @logging
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def output
  @output
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def proxy
  @proxy
end

#proxy_boot ⇒ Object (readonly)

Returns the value of attribute proxy_boot.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def proxy_boot
  @proxy_boot
end

#raw_config ⇒ Object (readonly)

Returns the value of attribute raw_config.



14
15
16
 
# File 'lib/kamal/configuration.rb', line 14

def raw_config
  @raw_config
end

#registry ⇒ Object (readonly)

Returns the value of attribute registry.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def registry
  @registry
end

#secrets ⇒ Object (readonly)

Returns the value of attribute secrets.



14
15
16
 
# File 'lib/kamal/configuration.rb', line 14

def secrets
  @secrets
end

#servers ⇒ Object (readonly)

Returns the value of attribute servers.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def servers
  @servers
end

#ssh ⇒ Object (readonly)

Returns the value of attribute ssh.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def ssh
  @ssh
end

#sshkit ⇒ Object (readonly)

Returns the value of attribute sshkit.



15
16
17
 
# File 'lib/kamal/configuration.rb', line 15

def sshkit
  @sshkit
end

Class Method Details

.create_from(config_file:, destination: nil, version: nil) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/kamal/configuration.rb', line 20

def create_from(config_file:, destination: nil, version: nil)
  ENV["KAMAL_DESTINATION"] = destination

  raw_config = load_raw_config(config_file: config_file, destination: destination)

  new raw_config, destination: destination, version: version
end

.load_raw_config(config_file:, destination: nil) ⇒ Object 



28
29
30
 
# File 'lib/kamal/configuration.rb', line 28

def load_raw_config(config_file:, destination: nil)
  load_config_files(config_file, *destination_config_file(config_file, destination))
end

Instance Method Details

#abbreviated_version ⇒ Object 



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/kamal/configuration.rb', line 101

def abbreviated_version
  if version
    # Don't abbreviate <sha>_uncommitted_<etc>
    if version.include?("_")
      version
    else
      version[0...7]
    end
  end
end

#absolute_image ⇒ Object 



200
201
202
 
# File 'lib/kamal/configuration.rb', line 200

def absolute_image
  "#{repository}:#{version}"
end

#accessory(name) ⇒ Object 



128
129
130
 
# File 'lib/kamal/configuration.rb', line 128

def accessory(name)
  accessories.detect { |a| a.name == name.to_s }
end

#all_hosts ⇒ Object 



132
133
134
 
# File 'lib/kamal/configuration.rb', line 132

def all_hosts
  (roles + accessories).flat_map(&:hosts).uniq
end

#allow_empty_roles? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/kamal/configuration.rb', line 160

def allow_empty_roles?
  raw_config.allow_empty_roles
end

#app_directory ⇒ Object 



260
261
262
 
# File 'lib/kamal/configuration.rb', line 260

def app_directory
  File.join apps_directory, service_and_destination
end

#app_hosts ⇒ Object 



144
145
146
 
# File 'lib/kamal/configuration.rb', line 144

def app_hosts
  roles.flat_map(&:hosts).uniq
end

#apps_directory ⇒ Object 



256
257
258
 
# File 'lib/kamal/configuration.rb', line 256

def apps_directory
  File.join run_directory, "apps"
end

#asset_path ⇒ Object 



280
281
282
 
# File 'lib/kamal/configuration.rb', line 280

def asset_path
  raw_config.asset_path
end

#assets_directory ⇒ Object 



268
269
270
 
# File 'lib/kamal/configuration.rb', line 268

def assets_directory
  File.join app_directory, "assets"
end

#deploy_timeout ⇒ Object 



240
241
242
 
# File 'lib/kamal/configuration.rb', line 240

def deploy_timeout
  raw_config.deploy_timeout || 30
end

#drain_timeout ⇒ Object 



244
245
246
 
# File 'lib/kamal/configuration.rb', line 244

def drain_timeout
  raw_config.drain_timeout || 30
end

#env_directory ⇒ Object 



264
265
266
 
# File 'lib/kamal/configuration.rb', line 264

def env_directory
  File.join app_directory, "env"
end

#env_tag(name) ⇒ Object 



296
297
298
 
# File 'lib/kamal/configuration.rb', line 296

def env_tag(name)
  env_tags.detect { |t| t.name == name.to_s }
end

#env_tags ⇒ Object 



288
289
290
291
292
293
294
 
# File 'lib/kamal/configuration.rb', line 288

def env_tags
  @env_tags ||= if (tags = raw_config.env["tags"])
    tags.collect { |name, config| Env::Tag.new(name, config: config, secrets: secrets) }
  else
    []
  end
end

#error_pages_path ⇒ Object 



284
285
286
 
# File 'lib/kamal/configuration.rb', line 284

def error_pages_path
  raw_config.error_pages_path
end

#hooks_output_for(hook) ⇒ Object 



300
301
302
303
304
305
306
307
 
# File 'lib/kamal/configuration.rb', line 300

def hooks_output_for(hook)
  case raw_config.hooks_output
  when Symbol, String
    raw_config.hooks_output.to_sym
  when Hash
    raw_config.hooks_output[hook]&.to_sym
  end
end

#hooks_path ⇒ Object 



272
273
274
 
# File 'lib/kamal/configuration.rb', line 272

def hooks_path
  raw_config.hooks_path || ".kamal/hooks"
end

#host_accessories(host) ⇒ Object 



140
141
142
 
# File 'lib/kamal/configuration.rb', line 140

def host_accessories(host)
  accessories.select { |accessory| accessory.hosts.include?(host) }
end

#host_roles(host) ⇒ Object 



136
137
138
 
# File 'lib/kamal/configuration.rb', line 136

def host_roles(host)
  roles.select { |role| role.hosts.include?(host) }
end

#image ⇒ Object 



184
185
186
187
188
189
 
# File 'lib/kamal/configuration.rb', line 184

def image
  name = raw_config&.image.presence
  name ||= raw_config&.service if registry.local?

  name
end

#latest_image ⇒ Object 



204
205
206
 
# File 'lib/kamal/configuration.rb', line 204

def latest_image
  "#{repository}:#{latest_tag}"
end

#latest_tag ⇒ Object 



208
209
210
 
# File 'lib/kamal/configuration.rb', line 208

def latest_tag
  [ "latest", *destination ].join("-")
end

#load_balancing? ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/kamal/configuration.rb', line 168

def load_balancing?
  proxy&.load_balancing?
end

#logging_args ⇒ Object 



232
233
234
 
# File 'lib/kamal/configuration.rb', line 232

def logging_args
  logging.args
end

#minimum_version ⇒ Object 



112
113
114
 
# File 'lib/kamal/configuration.rb', line 112

def minimum_version
  raw_config.minimum_version
end

#primary_host ⇒ Object 



148
149
150
 
# File 'lib/kamal/configuration.rb', line 148

def primary_host
  primary_role&.primary_host
end

#primary_role ⇒ Object 



156
157
158
 
# File 'lib/kamal/configuration.rb', line 156

def primary_role
  role(primary_role_name)
end

#primary_role_name ⇒ Object 



152
153
154
 
# File 'lib/kamal/configuration.rb', line 152

def primary_role_name
  raw_config.primary_role || "web"
end

#proxy_accessories ⇒ Object 



176
177
178
 
# File 'lib/kamal/configuration.rb', line 176

def proxy_accessories
  accessories.select(&:running_proxy?)
end

#proxy_hosts ⇒ Object 



180
181
182
 
# File 'lib/kamal/configuration.rb', line 180

def proxy_hosts
  (proxy_roles.flat_map(&:hosts) + proxy_accessories.flat_map(&:hosts)).uniq
end

#proxy_role_names ⇒ Object 



172
173
174
 
# File 'lib/kamal/configuration.rb', line 172

def proxy_role_names
  proxy_roles.flat_map(&:name)
end

#proxy_roles ⇒ Object 



164
165
166
 
# File 'lib/kamal/configuration.rb', line 164

def proxy_roles
  roles.select(&:running_proxy?)
end

#proxy_run(host) ⇒ Object 



191
192
193
194
 
# File 'lib/kamal/configuration.rb', line 191

def proxy_run(host)
  # We validate that all the config are identical for a host
  proxy_runs(host.to_s).first
end

#readiness_delay ⇒ Object 



236
237
238
 
# File 'lib/kamal/configuration.rb', line 236

def readiness_delay
  raw_config.readiness_delay || 7
end

#repository ⇒ Object 



196
197
198
 
# File 'lib/kamal/configuration.rb', line 196

def repository
  [ registry.server, image ].compact.join("/")
end

#require_destination? ⇒ Boolean

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/kamal/configuration.rb', line 216

def require_destination?
  raw_config.require_destination
end

#retain_containers ⇒ Object 



220
221
222
 
# File 'lib/kamal/configuration.rb', line 220

def retain_containers
  raw_config.retain_containers || 5
end

#role(name) ⇒ Object 



124
125
126
 
# File 'lib/kamal/configuration.rb', line 124

def role(name)
  roles.detect { |r| r.name == name.to_s }
end

#roles ⇒ Object 



120
121
122
 
# File 'lib/kamal/configuration.rb', line 120

def roles
  servers.roles
end

#run_directory ⇒ Object 



252
253
254
 
# File 'lib/kamal/configuration.rb', line 252

def run_directory
  ".kamal"
end

#secrets_path ⇒ Object 



276
277
278
 
# File 'lib/kamal/configuration.rb', line 276

def secrets_path
  raw_config.secrets_path || ".kamal/secrets"
end

#service_and_destination ⇒ Object 



116
117
118
 
# File 'lib/kamal/configuration.rb', line 116

def service_and_destination
  [ service, destination ].compact.join("-")
end

#service_with_version ⇒ Object 



212
213
214
 
# File 'lib/kamal/configuration.rb', line 212

def service_with_version
  "#{service}-#{version}"
end

#stop_timeout ⇒ Object 



248
249
250
 
# File 'lib/kamal/configuration.rb', line 248

def stop_timeout
  raw_config.stop_timeout
end

#to_h ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/kamal/configuration.rb', line 309

def to_h
  {
    roles: role_names,
    hosts: all_hosts,
    primary_host: primary_host,
    version: version,
    repository: repository,
    absolute_image: absolute_image,
    service_with_version: service_with_version,
    volume_args: volume_args,
    ssh_options: ssh.to_h,
    sshkit: sshkit.to_h,
    builder: builder.to_h,
    accessories: raw_config.accessories,
    logging: logging_args
  }.compact
end

#version ⇒ Object 



97
98
99
 
# File 'lib/kamal/configuration.rb', line 97

def version
  @declared_version.presence || ENV["VERSION"] || git_version
end

#version=(version) ⇒ Object 



93
94
95
 
# File 'lib/kamal/configuration.rb', line 93

def version=(version)
  @declared_version = version
end

#volume_args ⇒ Object 



224
225
226
227
228
229
230
 
# File 'lib/kamal/configuration.rb', line 224

def volume_args
  if raw_config.volumes.present?
    argumentize "--volume", raw_config.volumes
  else
    []
  end
end