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 



358
359
360
 
# File 'lib/pfab/cli.rb', line 358

def all_runnables
  deployables.merge(run_locals)
end

#build_args ⇒ Object 



321
322
323
324
325
326
327
 
# File 'lib/pfab/cli.rb', line 321

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 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/pfab/cli.rb', line 362

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,
      command: dep["command"],
    }
  end
  apps
end

#cmd_apply ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/pfab/cli.rb', line 203

def cmd_apply
  set_kube_context
  get_apps.each do |app_name|
    app = deployables[app_name]
    if app[:deployable_type] == "cron"
      deployed_name = deployed_name(app)
      kubectl("delete cronjob -l deployed-name=#{deployed_name}")
    end
    kubectl("apply -f .application-k8s-#{$env}-#{app_name}.yaml")
    puts_and_system("git tag release-#{$env}-#{app_name}-#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")} HEAD")
    puts_and_system("git push origin --tags")
  end
  selector = "application=#{@application_yaml['name']}"
  kubectl "get pods -l #{selector} -w"
end

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
284
285
286
287
 
# File 'lib/pfab/cli.rb', line 228

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 -t #{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 



299
300
301
302
 
# File 'lib/pfab/cli.rb', line 299

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

#config ⇒ Object 



333
334
335
 
# File 'lib/pfab/cli.rb', line 333

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

#container_repository ⇒ Object 



329
330
331
 
# File 'lib/pfab/cli.rb', line 329

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

#deployables ⇒ Object 



350
351
352
 
# File 'lib/pfab/cli.rb', line 350

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

#deployed_name(app) ⇒ Object 



304
305
306
 
# File 'lib/pfab/cli.rb', line 304

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

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



391
392
393
394
395
396
397
 
# File 'lib/pfab/cli.rb', line 391

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

#get_apps ⇒ Object 



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

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

#get_current_sha ⇒ Object 



308
309
310
 
# File 'lib/pfab/cli.rb', line 308

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

#get_first_pod(app) ⇒ Object 



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

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 



385
386
387
388
389
 
# File 'lib/pfab/cli.rb', line 385

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) 


219
220
221
222
223
224
225
226
 
# File 'lib/pfab/cli.rb', line 219

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 



317
318
319
 
# File 'lib/pfab/cli.rb', line 317

def image_name
  @application_yaml["name"]
end

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



337
338
339
 
# File 'lib/pfab/cli.rb', line 337

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

#puts_and_system(cmd) ⇒ Object 



341
342
343
344
345
346
347
348
 
# File 'lib/pfab/cli.rb', line 341

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

#run ⇒ Object 



12
13
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
 
# File 'lib/pfab/cli.rb', line 12

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
  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.action do
      app_name = get_app_name(all: true)
      puts "Shipping #{app_name}"
      success = cmd_build
      if success
        cmd_generate_yaml
        cmd_apply
      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"
    c.summary = "kubectl exec into a  pod"
    c.description = "CLI to the Cloud"
    c.example "exec into the first pod in staging",
              "pfab exec"
    c.example "exec into the first pod in production",
              "ezp -p exec"
    c.action do |args, options|
      set_kube_context
      app_name = get_app_name
      first_pod = get_first_pod app_name
      kubectl "exec -it #{first_pod}", "-- #{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 



354
355
356
 
# File 'lib/pfab/cli.rb', line 354

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

#set_kube_context ⇒ Object 



312
313
314
315
 
# File 'lib/pfab/cli.rb', line 312

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

#yy ⇒ Object 



289
290
291
292
293
294
295
296
297
 
# File 'lib/pfab/cli.rb', line 289

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