Class: Kamal::Cli::App
Defined Under Namespace
Classes: Boot, PrepareAssets
Instance Method Summary collapse
- #boot ⇒ Object
- #containers ⇒ Object
- #details ⇒ Object
- #exec(cmd) ⇒ Object
- #images ⇒ Object
- #logs ⇒ Object
- #remove ⇒ Object
- #remove_container(version) ⇒ Object
- #remove_containers ⇒ Object
- #remove_images ⇒ Object
- #stale_containers ⇒ Object
- #start ⇒ Object
- #stop ⇒ Object
- #version ⇒ Object
Methods inherited from Base
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 [:version] using_version(version_or_latest) do |version| say "Start container with version #{version} using a #{KAMAL.config.readiness_delay}s readiness delay (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 = Kamal::Cli::Healthcheck::Barrier.new if KAMAL.roles.many? on(KAMAL.hosts, **KAMAL.boot_strategy) do |host| KAMAL.roles_on(host).each do |role| Kamal::Cli::App::Boot.new(host, role, self, version, ).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
129 130 131 |
# File 'lib/kamal/cli/app.rb', line 129 def containers on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_containers) } end |
#details ⇒ Object
64 65 66 67 68 69 70 71 72 |
# File 'lib/kamal/cli/app.rb', line 64 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
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 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 |
# File 'lib/kamal/cli/app.rb', line 78 def exec(cmd) env = [:env] case when [:interactive] && [:reuse] say "Get current version of running container...", :magenta unless [:version] using_version([: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 [:interactive] say "Get most recent version available as an image...", :magenta unless [: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 [:reuse] say "Get current version of running container...", :magenta unless [:version] using_version([: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 [: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
161 162 163 |
# File 'lib/kamal/cli/app.rb', line 161 def images on(KAMAL.hosts) { |host| puts_by_host host, capture_with_info(*KAMAL.app.list_images) } end |
#logs ⇒ Object
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/kamal/cli/app.rb', line 170 def logs # FIXME: Catch when app containers aren't running grep = [:grep] since = [:since] if [:follow] lines = [: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 ||= [ "web" ] 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) end else lines = [: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(since: since, lines: lines, grep: grep)) rescue SSHKit::Command::Failed puts_by_host host, "Nothing found" end end end end end |
#remove ⇒ Object
206 207 208 209 210 211 212 |
# File 'lib/kamal/cli/app.rb', line 206 def remove with_lock do stop remove_containers remove_images end end |
#remove_container(version) ⇒ Object
215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/kamal/cli/app.rb', line 215 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
229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/kamal/cli/app.rb', line 229 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
243 244 245 246 247 248 249 250 |
# File 'lib/kamal/cli/app.rb', line 243 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
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/kamal/cli/app.rb', line 135 def stale_containers stop = [: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 |
# 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| 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 end end end end |
#stop ⇒ Object
49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/kamal/cli/app.rb', line 49 def stop with_lock do on(KAMAL.hosts) do |host| roles = KAMAL.roles_on(host) roles.each do |role| execute *KAMAL.auditor.record("Stopped app", role: role), verbosity: :debug execute *KAMAL.app(role: role, host: host).stop, raise_on_non_zero_exit: false end end end end |