Class: Kamal::Cli::Accessory

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

Instance Method Summary collapse

Methods inherited from Base

dynamic_command_class, exit_on_failure?, #initialize

Constructor Details

This class inherits a constructor from Kamal::Cli::Base

Instance Method Details

#boot(name, prepare: true) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/kamal/cli/accessory.rb', line 5

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.auditor.record("Booted #{name} accessory"), verbosity: :debug
          execute *accessory.ensure_env_directory
          upload! accessory.secrets_io, accessory.secrets_path, mode: "0600"
          execute *accessory.run

          if accessory.running_proxy?
            target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
            execute *accessory.deploy(target: target)
          end
        end
      end
    end
  end
end

#details(name) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/kamal/cli/accessory.rb', line 118

def details(name)
  if name == "all"
    KAMAL.accessory_names.each { |accessory_name| details(accessory_name) }
  else
    type = "Accessory #{name}"
    with_accessory(name) do |accessory, hosts|
      on(hosts) { puts_by_host host, capture_with_info(*accessory.info), type: type }
    end
  end
end

#directories(name) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/kamal/cli/accessory.rb', line 50

def directories(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        accessory.directories.keys.each do |host_path|
          execute *accessory.make_directory(host_path)
        end
      end
    end
  end
end

#exec(name, *cmd) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/kamal/cli/accessory.rb', line 132

def exec(name, *cmd)
  cmd = Kamal::Utils.join_commands(cmd)
  with_accessory(name) do |accessory, hosts|
    case
    when options[:interactive] && options[:reuse]
      say "Launching interactive command via SSH from existing container...", :magenta
      run_locally { exec accessory.execute_in_existing_container_over_ssh(cmd) }

    when options[:interactive]
      say "Launching interactive command via SSH from new container...", :magenta
      run_locally { exec accessory.execute_in_new_container_over_ssh(cmd) }

    when options[:reuse]
      say "Launching command from existing container...", :magenta
      on(hosts) do |host|
        execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
        puts_by_host host, capture_with_info(*accessory.execute_in_existing_container(cmd))
      end

    else
      say "Launching command from new container...", :magenta
      on(hosts) do |host|
        execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on #{name} accessory"), verbosity: :debug
        puts_by_host host, capture_with_info(*accessory.execute_in_new_container(cmd))
      end
    end
  end
end

#logs(name) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/kamal/cli/accessory.rb', line 168

def logs(name)
  with_accessory(name) do |accessory, hosts|
    grep = options[:grep]
    grep_options = options[:grep_options]
    timestamps = !options[:skip_timestamps]

    if options[:follow]
      run_locally do
        info "Following logs on #{hosts}..."
        info accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
        exec accessory.follow_logs(timestamps: timestamps, grep: grep, grep_options: grep_options)
      end
    else
      since = options[:since]
      lines = options[:lines].presence || ((since || grep) ? nil : 100) # Default to 100 lines if since or grep isn't set

      on(hosts) do
        puts capture_with_info(*accessory.logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
      end
    end
  end
end

#reboot(name) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/kamal/cli/accessory.rb', line 63

def reboot(name)
  with_lock do
    if name == "all"
      KAMAL.accessory_names.each { |accessory_name| reboot(accessory_name) }
    else
      prepare(name)
      stop(name)
      remove_container(name)
      boot(name, prepare: false)
    end
  end
end

#remove(name) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/kamal/cli/accessory.rb', line 193

def remove(name)
  confirming "This will remove all containers, images and data directories for #{name}. Are you sure?" do
    with_lock do
      if name == "all"
        KAMAL.accessory_names.each { |accessory_name| remove_accessory(accessory_name) }
      else
        remove_accessory(name)
      end
    end
  end
end

#remove_container(name) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/kamal/cli/accessory.rb', line 206

def remove_container(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        execute *KAMAL.auditor.record("Remove #{name} accessory container"), verbosity: :debug
        execute *accessory.remove_container
      end
    end
  end
end

#remove_image(name) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/kamal/cli/accessory.rb', line 218

def remove_image(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        execute *KAMAL.auditor.record("Removed #{name} accessory image"), verbosity: :debug
        execute *accessory.remove_image
      end
    end
  end
end

#remove_service_directory(name) ⇒ Object 



230
231
232
233
234
235
236
237
238
 
# File 'lib/kamal/cli/accessory.rb', line 230

def remove_service_directory(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        execute *accessory.remove_service_directory
      end
    end
  end
end

#restart(name) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/kamal/cli/accessory.rb', line 110

def restart(name)
  with_lock do
    stop(name)
    start(name)
  end
end

#start(name) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/kamal/cli/accessory.rb', line 77

def start(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        execute *KAMAL.auditor.record("Started #{name} accessory"), verbosity: :debug
        execute *accessory.start
        if accessory.running_proxy?
          target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
          execute *accessory.deploy(target: target)
        end
      end
    end
  end
end

#stop(name) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/kamal/cli/accessory.rb', line 93

def stop(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        execute *KAMAL.auditor.record("Stopped #{name} accessory"), verbosity: :debug
        execute *accessory.stop, raise_on_non_zero_exit: false

        if accessory.running_proxy?
          target = capture_with_info(*accessory.container_id_for(container_name: accessory.service_name, only_running: true)).strip
          execute *accessory.remove if target
        end
      end
    end
  end
end

#upgrade(name) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/kamal/cli/accessory.rb', line 243

def upgrade(name)
  confirming "This will restart all accessories" do
    with_lock do
      host_groups = options[:rolling] ? KAMAL.accessory_hosts : [ KAMAL.accessory_hosts ]
      host_groups.each do |hosts|
        host_list = Array(hosts).join(",")
        KAMAL.with_specific_hosts(hosts) do
          say "Upgrading #{name} accessories on #{host_list}...", :magenta
          reboot name
          say "Upgraded #{name} accessories on #{host_list}...", :magenta
        end
      end
    end
  end
end

#upload(name) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/kamal/cli/accessory.rb', line 33

def upload(name)
  with_lock do
    with_accessory(name) do |accessory, hosts|
      on(hosts) do
        accessory.files.each do |(local, remote)|
          accessory.ensure_local_file_present(local)

          execute *accessory.make_directory_for(remote)
          upload! local, remote
          execute :chmod, "755", remote
        end
      end
    end
  end
end