Class: Kamal::Configuration::Accessory

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, config:) ⇒ Accessory

Returns a new instance of Accessory.



6
7
8
 
# File 'lib/kamal/configuration/accessory.rb', line 6

def initialize(name, config:)
  @name, @config, @specifics = name.inquiry, config, config.raw_config["accessories"][name]
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



4
5
6
 
# File 'lib/kamal/configuration/accessory.rb', line 4

def name
  @name
end

#specifics ⇒ Object

Returns the value of attribute specifics.



4
5
6
 
# File 'lib/kamal/configuration/accessory.rb', line 4

def specifics
  @specifics
end

Instance Method Details

#cmd ⇒ Object 



84
85
86
 
# File 'lib/kamal/configuration/accessory.rb', line 84

def cmd
  specifics["cmd"]
end

#directories ⇒ Object 



61
62
63
64
65
66
 
# File 'lib/kamal/configuration/accessory.rb', line 61

def directories
  specifics["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 || {}
end

#env ⇒ Object 



44
45
46
47
48
 
# File 'lib/kamal/configuration/accessory.rb', line 44

def env
  Kamal::Configuration::Env.from_config \
    config: specifics.fetch("env", {}),
    secrets_file: File.join(config.host_env_directory, "accessories", "#{service_name}.env")
end

#env_args ⇒ Object 



50
51
52
 
# File 'lib/kamal/configuration/accessory.rb', line 50

def env_args
  env.args
end

#files ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/kamal/configuration/accessory.rb', line 54

def files
  specifics["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

#hosts ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/kamal/configuration/accessory.rb', line 18

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

#image ⇒ Object 



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

def image
  specifics["image"]
end

#label_args ⇒ Object 



40
41
42
 
# File 'lib/kamal/configuration/accessory.rb', line 40

def label_args
  argumentize "--label", labels
end

#labels ⇒ Object 



36
37
38
 
# File 'lib/kamal/configuration/accessory.rb', line 36

def labels
  default_labels.merge(specifics["labels"] || {})
end

#option_args ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/kamal/configuration/accessory.rb', line 76

def option_args
  if args = specifics["options"]
    optionize args
  else
    []
  end
end

#port ⇒ Object 



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

def port
  if port = specifics["port"]&.to_s
    port.include?(":") ? port : "#{port}:#{port}"
  end
end

#publish_args ⇒ Object 



32
33
34
 
# File 'lib/kamal/configuration/accessory.rb', line 32

def publish_args
  argumentize "--publish", port if port
end

#service_name ⇒ Object 



10
11
12
 
# File 'lib/kamal/configuration/accessory.rb', line 10

def service_name
  specifics["service"] || "#{config.service}-#{name}"
end

#volume_args ⇒ Object 



72
73
74
 
# File 'lib/kamal/configuration/accessory.rb', line 72

def volume_args
  argumentize "--volume", volumes
end

#volumes ⇒ Object 



68
69
70
 
# File 'lib/kamal/configuration/accessory.rb', line 68

def volumes
  specific_volumes + remote_files_as_volumes + remote_directories_as_volumes
end