Class: Pfab::CLI

Inherits:
Object
  • Object
show all
Includes:
Commander::Methods
Defined in:
lib/pfab/cli.rb

Instance Method Summary collapse

Instance Method Details

#all_runnables ⇒ Object 



443
444
445
 
# File 'lib/pfab/cli.rb', line 443

def all_runnables
  deployables.merge(run_locals)
end

#build_args ⇒ Object 



388
389
390
391
392
393
394
 
# File 'lib/pfab/cli.rb', line 388

def build_args
  args = @application_yaml["build_args"] || []
  if args.any?
    return args.map{|a| "--build-arg #{a}=$#{a}"}.join(" ")
  end
  ""
end

#calculate_runnables(runnable_type) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/pfab/cli.rb', line 447

def calculate_runnables(runnable_type)
  application = @application_yaml["name"]
  apps = {}
  (@application_yaml[runnable_type] || []).each do |deployable, dep|
    deployable_type = dep["type"]
    app_name = [application, deployable_type, deployable].join("-")
    apps[app_name] = {
      application: application,
      deployable: deployable,
      deployable_type: deployable_type,
      tags: dep["tags"],
      command: dep["command"],
    }
  end
  apps
end

#cmd_apply(timeout: 240, retries: 3, sleep_duration: 5, tagged: nil) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/pfab/cli.rb', line 222

def cmd_apply(timeout: 240, retries: 3, sleep_duration: 5, tagged: nil)
  set_kube_context
  success = true

  apps = tagged ? deployables.select { |k, v| v[:tags]&.include?(tagged) }.keys : get_apps

  apps.each do |app_name|
    app = deployables[app_name]
    if app[:deployable_type] == "cron"
      deployed_name = deployed_name(app)
      success &= kubectl("delete cronjob -l deployed-name=#{deployed_name}")
    end
    success &= kubectl("apply -f .application-k8s-#{$env}-#{app_name}.yaml")
    success &= puts_and_system("git tag release-#{$env}-#{app_name}-#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")} HEAD")
    success &= puts_and_system("git push origin --tags")
  end

  success &= wait_for_deployments_rollout(timeout, retries: retries, sleep_duration: sleep_duration)

  exit(success ? 0 : 1)
end

#cmd_build(force: false, checkonly: false) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/pfab/cli.rb', line 294

def cmd_build(force: false, checkonly: false)
  rev = get_current_sha
  say "This repo is at rev: #{rev}"
  uncommitted_changes = !`git diff-index HEAD --`.empty?
  if uncommitted_changes
    say "FYI! There are uncommitted changes."
    continue = agree("Continue anyway?")
    if continue
      say "carrying on and pushing local code to #{rev}"
    else
      return false
    end
  end

  full_image_name = "#{container_repository}/#{image_name}:#{rev}"

  unless force
    if image_exists?(full_image_name)
      say "Found image #{full_image_name} already, skipping prebuild, build & push"
      return true
    else
      say "No image #{full_image_name} present"
    end
    return if checkonly
  end

  say "No image #{full_image_name} present, building"

  prebuild = @application_yaml["prebuild"] || ""
  if prebuild.empty?
    say "No prebuild task"
  else
    say "Prebuild, running system(#{prebuild})"
    result = system(prebuild)
    if result
      say 'Pfab prebuild success'
    else
      say "Pfab prebuild did not return success. Exiting"
      return false
    end
  end

  build_cmd = "docker buildx build --tag #{image_name} --platform linux/amd64 #{build_args} ."
  puts build_cmd
  result = system(build_cmd)

  puts "Build Result #{result}"

  if result
    puts_and_system "docker tag #{image_name}:latest #{image_name}:#{rev}"
    puts_and_system "docker tag #{image_name}:#{rev} #{full_image_name}"

    puts_and_system "docker push #{container_repository}/#{image_name}:#{rev}"
    return true
  else
    say "Build Did Not Succeed"
    return false
  end

end

#cmd_generate_yaml ⇒ Object 



366
367
368
369
 
# File 'lib/pfab/cli.rb', line 366

def cmd_generate_yaml
  wrote = yy.generate(deployables.keys)
  puts "Generated #{wrote}"
end

#config ⇒ Object 



400
401
402
 
# File 'lib/pfab/cli.rb', line 400

def config
  @_config ||= YAML.load(File.read(File.join(Dir.home, ".pfab.yaml")))
end

#container_repository ⇒ Object 



396
397
398
 
# File 'lib/pfab/cli.rb', line 396

def container_repository
  @_container_repository ||= config["container.repository"]
end

#deployables ⇒ Object 



435
436
437
 
# File 'lib/pfab/cli.rb', line 435

def deployables
  @_deployables ||= calculate_runnables("deployables")
end

#deployed_name(app) ⇒ Object 



371
372
373
 
# File 'lib/pfab/cli.rb', line 371

def deployed_name(app)
  [app[:application], app[:deployable_type], app[:deployable]].join("-")
end

#get_app_name(all: false, include_run_locals: false) ⇒ Object 



477
478
479
480
481
482
483
484
 
# File 'lib/pfab/cli.rb', line 477

def get_app_name(all: false, include_run_locals: false)
  return $app_name unless $app_name.nil?
  apps = []
  apps << "all" if all
  apps.concat(deployables.keys)
  apps.concat(run_locals.keys) if include_run_locals
  $app_name = choose("which app?", *apps)
end

#get_apps ⇒ Object 



486
487
488
489
 
# File 'lib/pfab/cli.rb', line 486

def get_apps
  name = get_app_name(all: true)
  (name == "all") ? deployables.keys : [name]
end

#get_current_sha ⇒ Object 



375
376
377
 
# File 'lib/pfab/cli.rb', line 375

def get_current_sha
  `git rev-parse --short=8 --verify HEAD`.chomp
end

#get_first_pod(app) ⇒ Object 



464
465
466
467
468
469
 
# File 'lib/pfab/cli.rb', line 464

def get_first_pod(app)
  if get_pods(app)["items"].empty?
    raise "There are no running pods for #{app}"
  end
  get_pods(app)["items"][0]["metadata"]["name"]
end

#get_pods(app) ⇒ Object 



471
472
473
474
475
 
# File 'lib/pfab/cli.rb', line 471

def get_pods(app)
  get_pods_str = "kubectl get pods -o json -l deployed-name=#{app} --namespace=#{yy.namespace}"
  pods_str = `#{get_pods_str}`
  JSON.parse(pods_str)
end

#image_exists?(full_image_name) ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
288
289
290
291
292
 
# File 'lib/pfab/cli.rb', line 285

def image_exists?(full_image_name)

  # return 0 if image exists 1 if not
  cmd = "docker manifest inspect #{full_image_name} > /dev/null ; echo $?"
  say "Looking for images with #{cmd}"
  existing = `#{cmd}`.strip
  existing == "0"
end

#image_name ⇒ Object 



384
385
386
 
# File 'lib/pfab/cli.rb', line 384

def image_name
  @application_yaml["name"]
end

#kubectl(cmd, post_cmd = "") ⇒ Object 



404
405
406
407
 
# File 'lib/pfab/cli.rb', line 404

def kubectl(cmd, post_cmd = "")
  result = puts_and_system("kubectl #{cmd} --namespace=#{yy.namespace} #{post_cmd}")
  result == true
end

#kubectl_with_output(cmd, post_cmd = "") ⇒ Object 



409
410
411
 
# File 'lib/pfab/cli.rb', line 409

def kubectl_with_output(cmd, post_cmd = "")
  puts_and_system_with_output("kubectl #{cmd} --namespace=#{yy.namespace} #{post_cmd}")
end

#puts_and_system(cmd) ⇒ Object 



413
414
415
416
417
418
419
420
421
 
# File 'lib/pfab/cli.rb', line 413

def puts_and_system(cmd)
  puts cmd
  if $dryrun
    puts "dry run, didn't run that"
    true
  else
    system(cmd)
  end
end

#puts_and_system_with_output(cmd) ⇒ Object 



423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/pfab/cli.rb', line 423

def puts_and_system_with_output(cmd)
  puts cmd
  if $dryrun
    dryrun_message = "dry run, didn't run that"
    puts dryrun_message
    CommandResult.new(stdout: dryrun_message, stderr: dryrun_message, exit_status_code: 0)
  else
    stdout, stderr, status = Open3.capture3(cmd)
    CommandResult.new(stdout: stdout, stderr: stderr, exit_status_code: status.exitstatus)
  end
end

#run ⇒ Object 



14
15
16
17
18
19
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
56
57
58
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
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
127
128
129
130
131
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
160
161
162
163
164
165
166
167
168
169
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/pfab/cli.rb', line 14

def run
  program :name, "pfab"
  program :version, Pfab::Version::STRING
  program :description, "k8s helper"

  if File.exist? "application.yaml"
    @application_yaml = YAML.load(File.read("application.yaml")).with_indifferent_access
    @application_yaml_hash = Digest::SHA256.hexdigest(@application_yaml.to_json)
  else
    raise "I need to be run in a directory with a application.yaml"
  end
  global_option("--verbose") { $verbose = true }
  $dryrun = false
  global_option("--dryrun") { $dryrun = true }
  $env = :staging
  global_option("-p") do
    puts "please use `-e production` next time!"
    $env = :production
  end
  global_option("-e", "--environment ENV", "specify target env") do |env_name|
    puts "Using environment #{env_name}"
    $env = env_name
  end
  global_option("-a", "--application_name APP_NAME", "run without prompting for app") do |app_name|
    $app_name = app_name
  end

  command :build do |c|
    c.syntax = "pfab build"
    c.summary = "build image"
    c.option "--force", "force build and push"
    c.option "--check", "just check if built"
    c.action do |_args, options|
      cmd_build(force: options.force, checkonly: options.check)
    end
  end

  command :generate_yaml do |c|
    c.syntax = "pfab generate_yaml"
    c.summary = "build k8s yaml"
    c.action do
      cmd_generate_yaml
    end
  end
  command :apply do |c|
    c.syntax = "pfab apply"
    c.summary = "kubectl apply"
    c.action do
      cmd_apply
    end
  end

  command :shipit do |c|
    c.syntax = "pfab shipit"
    c.summary = "build, generate, apply"
    c.option "-t", "--timeout TIMEOUT", Integer, "timeout for rollout (default 360s)"
    c.option "-r", "--retries RETRIES", Integer, "number of retries for rollout (default 3)"
    c.option "-s", "--sleep SLEEP", Integer, "sleep duration between retries in seconds (default 5)"
    c.option "-g", "--tagged TAGGED", String, "target deployables tagged with TAGGED"

    c.action do |args, options|
      options.default timeout: 360, retries: 3, sleep: 5
      app_name = ""
      if options.tagged && options.tagged != ""
        app_name = "Apps tagged with #{options.tagged}"
      else
        app_name = get_app_name(all: true)
      end

      puts "Shipping #{app_name}"
      success = cmd_build
      if success
        cmd_generate_yaml
        cmd_apply(timeout: options.timeout, retries: options.retries, sleep_duration: options.sleep, tagged: options.tagged)
      else
        raise "Build failed"
      end
    end
  end

  command :logs do |c|
    c.syntax = "pfab logs"
    c.summary = "tail logs"
    c.description = "show me my logs`"
    c.example "tail logs of the first pod in staging",
              "pfab logs"
    c.example "tail logs of the first pod in production",
              "pfab -p logs"
    c.action do
      set_kube_context
      app_name = get_app_name

      first_pod = get_first_pod(app_name)

      kubectl("logs -f #{first_pod}")
    end
  end

  command :restart do |c|
    c.syntax = "pfab restart"
    c.summary = "rolling restart of a deployment"
    c.description = "rolling restart of a deployment"
    c.action do
      set_kube_context
      app_name = get_app_name

      kubectl "rollout restart deployment.apps/#{app_name}"
    end
  end

  command :exec do |c|
    c.option "-c", "--command command", "use with exec to run a command and exit. default is /bin/sh"
    c.syntax = "pfab exec [-- command to execute]'"
    c.summary = "kubectl exec into a  pod"
    c.description = "CLI to the Cloud"
    c.example "exec into the first pod in staging",
              "pfab -e staging exec"
    c.example "exec into the first pod in production",
              "pfab -p exec"
    c.action do |args, options|
      set_kube_context
      # Access the command line input after "--"
      additional_args = ARGV[ARGV.index('--') + 1..-1] if ARGV.include?('--')
      app_name = get_app_name
      first_pod = get_first_pod app_name
      kubectl "exec -it #{first_pod}", "-- #{additional_args ? additional_args.join(' ') : (options.command || '/bin/sh')}"
    end
  end

  command :status do |c|
    c.syntax = "pfab status"
    c.summary = "status of an app"
    c.description = "what's happening"
    c.example "what's happening in my app?",
              "pfab status"
    c.example "what's happening in production",
              "pfab status -p status"
    c.example "pick a single app",
              "pfab status --pick "
    c.example "verbose mode",
              "pfab status --verbose "
    c.example "watch deploy",
              "pfab status --watch "
    c.option "--watch", "Watch"
    c.action do |_args, options|
      set_kube_context

      selector = "application=#{@application_yaml['name']}"

      if options.watch
        kubectl "get pods -l #{selector} -w"
      elsif $verbose
        kubectl "describe pods -l #{selector}"
      else
        kubectl "get ingresses,jobs,services,cronjobs,deployments,pods -l #{selector}"
      end
    end
  end

  command :run_local do |c|
    c.syntax = "pfab run_local"
    c.summary = "run an app LOCALLY"
    c.description = "run the application command with all env vars set"
    c.example "run a command locally",
              "pfab run_local"
    c.option "-c", "--command COMMAND", "Run a command with the ENV vars of the selected app"
    c.action do |_args, options|
      $env = :development
      app_name = get_app_name(include_run_locals: true)
      puts "RUNNING THE FOLLOWING LOCALLY"

      env_vars = yy.env_vars(app_name).
        reject { |v| v.has_key? :valueFrom }

      env_var_string = env_vars.map { |item| "#{item[:name]}=\"#{item[:value]}\"" }.join(" ")
      options.default command: all_runnables[app_name][:command]

      puts_and_system "#{env_var_string} #{options.command}"
    end
  end
  alias_command :rl, :run_local

  command :clean do |c|
    c.syntax = "pfab clean"
    c.summary = "clean up pods"
    c.description = "clean up old pods"
    c.example "clean up",
              "pfab clean"
    c.action do |_args, options|
      set_kube_context
      puts "THIS APPLIES TO THE ENTIRE NAMESPACE"
      types = %w(Failed Pending Succeeded)
      types.each do |type|
        kubectl("get pods --field-selector status.phase=#{type}")
        if agree("Delete those?")
          kubectl("delete pods --field-selector status.phase=#{type}")
          puts "Deleted"
        end
      end
    end
  end
  alias_command :rl, :run_local

  default_command :help

  run!
end

#run_locals ⇒ Object 



439
440
441
 
# File 'lib/pfab/cli.rb', line 439

def run_locals
  @_rl ||= calculate_runnables("run_locals")
end

#set_kube_context ⇒ Object 



379
380
381
382
 
# File 'lib/pfab/cli.rb', line 379

def set_kube_context
  str = "kubectl config use-context #{config["envs"][$env.to_s]["context"]}"
  puts_and_system str
end

#wait_for_deployments_rollout(timeout, retries: 3, sleep_duration: 5) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/pfab/cli.rb', line 244

def wait_for_deployments_rollout(timeout, retries: 3, sleep_duration: 5)
  selector = "application=#{@application_yaml['name']}"
  deployment_json = `kubectl get deployment -l #{selector} -o json --namespace=#{yy.namespace}`
  deployments = JSON.parse(deployment_json)

  if deployments["items"].any?
    deployments["items"].each do |deployment|
      deployment_name = deployment["metadata"]["name"]
      puts "Waiting for deployment #{deployment_name} to roll out..."

      rollout_success = false

      retries.times do |attempt|
        rollout_result = kubectl_with_output("rollout status deployment/#{deployment_name} --timeout=#{timeout}s")
        rollout_success = rollout_result.success?
        if rollout_success
          puts "Deployment #{deployment_name} successfully rolled out. Attempt #{attempt + 1}/#{retries}."
          break
        else
          puts "Attempt #{attempt + 1}/#{retries}: Deployment #{deployment_name} failed to roll out within the specified timeout."
          puts "Output was #{rollout_result}"
          if attempt < retries - 1
            puts "Retrying in #{sleep_duration} seconds..."
            sleep(sleep_duration)
          end
        end
      end

      unless rollout_success
        puts "Deployment #{deployment_name} failed to roll out after #{retries} attempts."
        return false
      end
    end
    puts "All deployments successfully rolled out."
    true
  else
    puts "No deployments found for selector: #{selector}"
    false
  end
end

#yy ⇒ Object 



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/pfab/cli.rb', line 355

def yy
  Pfab::Yamls.new(apps: all_runnables,
                  application_yaml: @application_yaml,
                  application_yaml_hash: @application_yaml_hash,
                  env: $env,
                  sha: get_current_sha,
                  image_name: image_name,
                  config: config
  )
end