Class: Kamal::Cli::Main

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

Instance Method Summary collapse

Methods inherited from Base

exit_on_failure?, #initialize

Constructor Details

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

Instance Method Details

#audit ⇒ Object 



119
120
121
122
123
 
# File 'lib/kamal/cli/main.rb', line 119

def audit
  on(KAMAL.hosts) do |host|
    puts_by_host host, capture_with_info(*KAMAL.auditor.reveal)
  end
end

#config ⇒ Object 



126
127
128
129
130
 
# File 'lib/kamal/cli/main.rb', line 126

def config
  run_locally do
    puts Kamal::Utils.redacted(KAMAL.config.to_h).to_yaml
  end
end

#deploy ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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/main.rb', line 20

def deploy
  runtime = print_runtime do
    mutating do
      invoke_options = deploy_options

      say "Log into image registry...", :magenta
      invoke "kamal:cli:registry:login", [], invoke_options

      if options[:skip_push]
        say "Pull app image...", :magenta
        invoke "kamal:cli:build:pull", [], invoke_options
      else
        say "Build and push app image...", :magenta
        invoke "kamal:cli:build:deliver", [], invoke_options
      end

      run_hook "pre-deploy"

      say "Ensure Traefik is running...", :magenta
      invoke "kamal:cli:traefik:boot", [], invoke_options

      say "Ensure app can pass healthcheck...", :magenta
      invoke "kamal:cli:healthcheck:perform", [], invoke_options

      say "Detect stale containers...", :magenta
      invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)

      invoke "kamal:cli:app:boot", [], invoke_options

      say "Prune old containers and images...", :magenta
      invoke "kamal:cli:prune:all", [], invoke_options
    end
  end

  run_hook "post-deploy", runtime: runtime.round
end

#details ⇒ Object 



112
113
114
115
116
 
# File 'lib/kamal/cli/main.rb', line 112

def details
  invoke "kamal:cli:traefik:details"
  invoke "kamal:cli:app:details"
  invoke "kamal:cli:accessory:details", [ "all" ]
end

#envify ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/kamal/cli/main.rb', line 174

def envify
  if destination = options[:destination]
    env_template_path = ".env.#{destination}.erb"
    env_path          = ".env.#{destination}"
  else
    env_template_path = ".env.erb"
    env_path          = ".env"
  end

  File.write(env_path, ERB.new(File.read(env_template_path), trim_mode: "-").result, perm: 0600)

  unless options[:skip_push]
    reload_envs
    invoke "kamal:cli:env:push", options
  end
end

#init ⇒ Object 



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
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/kamal/cli/main.rb', line 134

def init
  require "fileutils"

  if (deploy_file = Pathname.new(File.expand_path("config/deploy.yml"))).exist?
    puts "Config file already exists in config/deploy.yml (remove first to create a new one)"
  else
    FileUtils.mkdir_p deploy_file.dirname
    FileUtils.cp_r Pathname.new(File.expand_path("templates/deploy.yml", __dir__)), deploy_file
    puts "Created configuration file in config/deploy.yml"
  end

  unless (deploy_file = Pathname.new(File.expand_path(".env"))).exist?
    FileUtils.cp_r Pathname.new(File.expand_path("templates/template.env", __dir__)), deploy_file
    puts "Created .env file"
  end

  unless (hooks_dir = Pathname.new(File.expand_path(".kamal/hooks"))).exist?
    hooks_dir.mkpath
    Pathname.new(File.expand_path("templates/sample_hooks", __dir__)).each_child do |sample_hook|
      FileUtils.cp sample_hook, hooks_dir, preserve: true
    end
    puts "Created sample hooks in .kamal/hooks"
  end

  if options[:bundle]
    if (binstub = Pathname.new(File.expand_path("bin/kamal"))).exist?
      puts "Binstub already exists in bin/kamal (remove first to create a new one)"
    else
      puts "Adding Kamal to Gemfile and bundle..."
      run_locally do
        execute :bundle, :add, :kamal
        execute :bundle, :binstubs, :kamal
      end
      puts "Created binstub file in bin/kamal"
    end
  end
end

#redeploy ⇒ Object 



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
 
# File 'lib/kamal/cli/main.rb', line 59

def redeploy
  runtime = print_runtime do
    mutating do
      invoke_options = deploy_options

      if options[:skip_push]
        say "Pull app image...", :magenta
        invoke "kamal:cli:build:pull", [], invoke_options
      else
        say "Build and push app image...", :magenta
        invoke "kamal:cli:build:deliver", [], invoke_options
      end

      run_hook "pre-deploy"

      say "Ensure app can pass healthcheck...", :magenta
      invoke "kamal:cli:healthcheck:perform", [], invoke_options

      say "Detect stale containers...", :magenta
      invoke "kamal:cli:app:stale_containers", [], invoke_options.merge(stop: true)

      invoke "kamal:cli:app:boot", [], invoke_options
    end
  end

  run_hook "post-deploy", runtime: runtime.round
end

#remove ⇒ Object 



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

def remove
  mutating do
    if options[:confirmed] || ask("This will remove all containers and images. Are you sure?", limited_to: %w( y N ), default: "N") == "y"
      invoke "kamal:cli:traefik:remove", [], options.without(:confirmed)
      invoke "kamal:cli:app:remove", [], options.without(:confirmed)
      invoke "kamal:cli:accessory:remove", [ "all" ], options
      invoke "kamal:cli:registry:logout", [], options.without(:confirmed)
    end
  end
end

#rollback(version) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/kamal/cli/main.rb', line 88

def rollback(version)
  rolled_back = false
  runtime = print_runtime do
    mutating do
      invoke_options = deploy_options

      KAMAL.config.version = version
      old_version = nil

      if container_available?(version)
        run_hook "pre-deploy"

        invoke "kamal:cli:app:boot", [], invoke_options.merge(version: version)
        rolled_back = true
      else
        say "The app version '#{version}' is not available as a container (use 'kamal app containers' for available versions)", :red
      end
    end
  end

  run_hook "post-deploy", runtime: runtime.round if rolled_back
end

#setup ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/kamal/cli/main.rb', line 3

def setup
  print_runtime do
    mutating do
      say "Ensure Docker is installed...", :magenta
      invoke "kamal:cli:server:bootstrap"

      say "Push env files...", :magenta
      invoke "kamal:cli:env:push"

      invoke "kamal:cli:accessory:boot", [ "all" ]
      deploy
    end
  end
end

#version ⇒ Object 



205
206
207
 
# File 'lib/kamal/cli/main.rb', line 205

def version
  puts Kamal::VERSION
end