Class: Kamal::Cli::App

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

Defined Under Namespace

Classes: Boot, PrepareAssets

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 ⇒ Object 



3
4
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
31
32
 
# File 'lib/kamal/cli/app.rb', line 3

def boot
  with_lock do
    say "Get most recent version available as an image...", :magenta unless options[:version]
    using_version(version_or_latest) do |version|
      say "Start container with version #{version} (or reboot if already running)...", :magenta

      # Assets are prepared in a separate step to ensure they are on all hosts before booting
      on(KAMAL.hosts) do
        KAMAL.roles_on(host).each do |role|
          Kamal::Cli::App::PrepareAssets.new(host, role, self).run
        end
      end

      # Primary hosts and roles are returned first, so they can open the barrier
      barrier = Kamal::Cli::Healthcheck::Barrier.new

      on(KAMAL.hosts, **KAMAL.boot_strategy) do |host|
        KAMAL.roles_on(host).each do |role|
          Kamal::Cli::App::Boot.new(host, role, self, version, barrier).run
        end
      end

      # Tag once the app booted on all hosts
      on(KAMAL.hosts) do |host|
        execute *KAMAL.auditor.record("Tagging #{KAMAL.config.absolute_image} as the latest image"), verbosity: :debug
        execute *KAMAL.app.tag_latest_image
      end
    end
  end
end

#containers ⇒ Object 



149
150
151
 
# File 'lib/kamal/cli/app.rb', line 149

def containers
  on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_containers) }
end

#details ⇒ Object 



83
84
85
86
87
88
89
90
91
 
# File 'lib/kamal/cli/app.rb', line 83

def details
  on(KAMAL.hosts) do |host|
    roles = KAMAL.roles_on(host)

    roles.each do |role|
      puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).info)
    end
  end
end

#exec(*cmd) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/kamal/cli/app.rb', line 97

def exec(*cmd)
  cmd = Kamal::Utils.join_commands(cmd)
  env = options[:env]
  case
  when options[:interactive] && options[:reuse]
    say "Get current version of running container...", :magenta unless options[:version]
    using_version(options[:version] || current_running_version) do |version|
      say "Launching interactive command with version #{version} via SSH from existing container on #{KAMAL.primary_host}...", :magenta
      run_locally { exec KAMAL.app(role: KAMAL.primary_role, host: KAMAL.primary_host).execute_in_existing_container_over_ssh(cmd, env: env) }
    end

  when options[:interactive]
    say "Get most recent version available as an image...", :magenta unless options[:version]
    using_version(version_or_latest) do |version|
      say "Launching interactive command with version #{version} via SSH from new container on #{KAMAL.primary_host}...", :magenta
      run_locally do
        exec KAMAL.app(role: KAMAL.primary_role, host: KAMAL.primary_host).execute_in_new_container_over_ssh(cmd, env: env)
      end
    end

  when options[:reuse]
    say "Get current version of running container...", :magenta unless options[:version]
    using_version(options[:version] || current_running_version) do |version|
      say "Launching command with version #{version} from existing container...", :magenta

      on(KAMAL.hosts) do |host|
        roles = KAMAL.roles_on(host)

        roles.each do |role|
          execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on app version #{version}", role: role), verbosity: :debug
          puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_existing_container(cmd, env: env))
        end
      end
    end

  else
    say "Get most recent version available as an image...", :magenta unless options[:version]
    using_version(version_or_latest) do |version|
      say "Launching command with version #{version} from new container...", :magenta
      on(KAMAL.hosts) do |host|
        roles = KAMAL.roles_on(host)

        roles.each do |role|
          execute *KAMAL.auditor.record("Executed cmd '#{cmd}' on app version #{version}"), verbosity: :debug
          puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).execute_in_new_container(cmd, env: env))
        end
      end
    end
  end
end

#images ⇒ Object 



181
182
183
 
# File 'lib/kamal/cli/app.rb', line 181

def images
  on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_images) }
end

#logs ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/kamal/cli/app.rb', line 192

def logs
  # FIXME: Catch when app containers aren't running

  grep = options[:grep]
  grep_options = options[:grep_options]
  since = options[:since]
  timestamps = !options[:skip_timestamps]

  if options[:follow]
    lines = options[:lines].presence || ((since || grep) ? nil : 10) # Default to 10 lines if since or grep isn't set

    run_locally do
      info "Following logs on #{KAMAL.primary_host}..."

      KAMAL.specific_roles ||= [ KAMAL.primary_role.name ]
      role = KAMAL.roles_on(KAMAL.primary_host).first

      app = KAMAL.app(role: role, host: host)
      info app.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, lines: lines, grep: grep, grep_options: grep_options)
      exec app.follow_logs(host: KAMAL.primary_host, timestamps: timestamps, 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

    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        begin
          puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).logs(timestamps: timestamps, since: since, lines: lines, grep: grep, grep_options: grep_options))
        rescue SSHKit::Command::Failed
          puts_by_host host, "Nothing found"
        end
      end
    end
  end
end

#remove ⇒ Object 



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

def remove
  with_lock do
    stop
    remove_containers
    remove_images
    remove_app_directory
  end
end

#remove_app_directory ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/kamal/cli/app.rb', line 279

def remove_app_directory
  with_lock do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        execute *KAMAL.auditor.record("Removed #{KAMAL.config.app_directory} on all servers", role: role), verbosity: :debug
        execute *KAMAL.server.remove_app_directory, raise_on_non_zero_exit: false
      end
    end
  end
end

#remove_container(version) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/kamal/cli/app.rb', line 241

def remove_container(version)
  with_lock do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        execute *KAMAL.auditor.record("Removed app container with version #{version}", role: role), verbosity: :debug
        execute *KAMAL.app(role: role, host: host).remove_container(version: version)
      end
    end
  end
end

#remove_containers ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/kamal/cli/app.rb', line 255

def remove_containers
  with_lock do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        execute *KAMAL.auditor.record("Removed all app containers", role: role), verbosity: :debug
        execute *KAMAL.app(role: role, host: host).remove_containers
      end
    end
  end
end

#remove_images ⇒ Object 



269
270
271
272
273
274
275
276
 
# File 'lib/kamal/cli/app.rb', line 269

def remove_images
  with_lock do
    on(KAMAL.hosts) do
      execute *KAMAL.auditor.record("Removed all app images"), verbosity: :debug
      execute *KAMAL.app.remove_images
    end
  end
end

#stale_containers ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/kamal/cli/app.rb', line 155

def stale_containers
  stop = options[:stop]

  with_lock_if_stopping do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        app = KAMAL.app(role: role, host: host)
        versions = capture_with_info(*app.list_versions, raise_on_non_zero_exit: false).split("\n")
        versions -= [ capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip ]

        versions.each do |version|
          if stop
            puts_by_host host, "Stopping stale container for role #{role} with version #{version}"
            execute *app.stop(version: version), raise_on_non_zero_exit: false
          else
            puts_by_host host,  "Detected stale container for role #{role} with version #{version} (use `kamal app stale_containers --stop` to stop)"
          end
        end
      end
    end
  end
end

#start ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/kamal/cli/app.rb', line 35

def start
  with_lock do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        app = KAMAL.app(role: role, host: host)
        execute *KAMAL.auditor.record("Started app version #{KAMAL.config.version}"), verbosity: :debug
        execute *app.start, raise_on_non_zero_exit: false

        if role.running_proxy?
          version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
          endpoint = capture_with_info(*app.container_id_for_version(version)).strip
          raise Kamal::Cli::BootError, "Failed to get endpoint for #{role} on #{host}, did the container boot?" if endpoint.empty?

          execute *app.deploy(target: endpoint)
        end
      end
    end
  end
end

#stop ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/kamal/cli/app.rb', line 58

def stop
  with_lock do
    on(KAMAL.hosts) do |host|
      roles = KAMAL.roles_on(host)

      roles.each do |role|
        app = KAMAL.app(role: role, host: host)
        execute *KAMAL.auditor.record("Stopped app", role: role), verbosity: :debug

        if role.running_proxy?
          version = capture_with_info(*app.current_running_version, raise_on_non_zero_exit: false).strip
          endpoint = capture_with_info(*app.container_id_for_version(version)).strip
          if endpoint.present?
            execute *app.remove, raise_on_non_zero_exit: false
          end
        end

        execute *app.stop, raise_on_non_zero_exit: false
      end
    end
  end
end

#version ⇒ Object 



293
294
295
296
297
298
 
# File 'lib/kamal/cli/app.rb', line 293

def version
  on(KAMAL.hosts) do |host|
    role = KAMAL.roles_on(host).first
    puts_by_host host, capture_with_info(*KAMAL.app(role: role, host: host).current_running_version).strip
  end
end