stax-helm 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c41b28fe1fde84c9dc771a618e0bfbeccd1718854aea285f41a4e115c73252f
-  data.tar.gz: '09525e2ae890c6b35306b578ac7099488f734920ac5f8aea250413652f7eebf7'
+  metadata.gz: 53e53de7fb96d2b35470594bbb80e1de7bcbcf41aad867d6d20217db8bc20aef
+  data.tar.gz: 99f8d5f4a0964e66303803885d4f065d0979606f33cceed2afc7b5e82869f650
 SHA512:
-  metadata.gz: f2a5c1f4c00e3211799a516e6645af725c537a7ad96bb4ae4f60dd48be1df90be961a78108fa0a11057f7ba9832a842561d9a47cd3d341b9aacaa83da87b7906
-  data.tar.gz: 7260772678070aa147160ec8e072fe912a1bd79d772917b9a347fd65565c8ab5b2724f1fddc6d02e6c5e400a4748f9ec0523e01777686a980472c9215ca8d2e1
+  metadata.gz: 5cf3d1c0a868fdb26deb92346704bb3dacf507f28c3b70761b6525d3ecca93891fa0e1276533cfd3096913a1944d418469de7b7dbcf2383417803cc11fd7396c
+  data.tar.gz: d581092b08654b29454a72ab0c1ff198d47caa0aa1663baa17123898bc0cd738d01994cb4f7f9daf20cd19542124f3e8d630d55188f2bacc632339b889c556b4

data/lib/stax/helm.rb

@@ -1,7 +1,11 @@
+require 'stax/helm/base'
 require 'stax/helm/cmd'
 require 'stax/helm/kubectl'
 require 'stax/helm/ingress'
 require 'stax/helm/pod'
 require 'stax/helm/deployment'
+require 'stax/helm/jobs'
+require 'stax/helm/cronjobs'
 require 'stax/helm/stern'
+require 'stax/helm/runcmd'
 Stax.add_command(:helm, Stax::Helm::Cmd)

data/lib/stax/helm/base.rb

@@ -0,0 +1,16 @@
+module Stax
+  class Base < Thor
+
+    no_commands do
+      def helm_release_name
+        @_helm_release_name ||= helm_safe("#{app_name}-#{branch_name}")
+      end
+
+      ## make string safe to use in naming helm stuff
+      def helm_safe(string)
+        string.slice(0, 53).gsub(/[\W_]/, '-').downcase
+      end
+    end
+
+  end
+end

data/lib/stax/helm/cmd.rb

@@ -1,13 +1,10 @@
 module Stax
   module Helm
+
     class Cmd < Base
       class_option :recon, aliases: '--just-print', type: :boolean, default: false, desc: 'print command that would be run'
 
       no_commands do
-        def helm_release_name
-          @_helm_release_name ||= "#{app_name}-#{branch_name}"
-        end
-
         ## location of helm chart
         def helm_dir
           File.join(Stax.root_path, 'helm')

data/lib/stax/helm/cronjobs.rb

@@ -0,0 +1,13 @@
+## tasks to get cronjob details
+module Stax
+  module Helm
+    class Cmd < Base
+
+      desc 'cronjobs', 'list cronjobs'
+      def cronjobs
+        kubectl_run(:get, :cronjobs, '-l', helm_selector)
+      end
+
+    end
+  end
+end

data/lib/stax/helm/deployment.rb

@@ -3,11 +3,54 @@ module Stax
   module Helm
     class Cmd < Base
 
+      no_commands do
+        def helm_deployments
+          jsonpath = '{.items[*].metadata.name}'
+          %x[kubectl get deployments -o=jsonpath='#{jsonpath}' -l #{helm_selector}].split
+        end
+
+        ## prompt user with a list of deployments to choose
+        def helm_ask_deployments(msg)
+          deployments = helm_deployments
+          if deployments.count > 1
+            puts deployments.each_with_index.map { |d, i| "#{i}: #{d}" }
+            resp = ask(msg, default: 'all')
+            if resp != 'all'
+              indices = resp.split.map(&:to_i)
+              deployments = Array(deployments.slice(*indices))
+            end
+          end
+          deployments
+        end
+      end
+
       desc 'deployments', 'list deployments'
       def deployments
         kubectl_run(:get, :deployments, '-l', helm_selector)
       end
 
+      desc 'restart', 'restart deployments'
+      def restart
+        helm_ask_deployments('choose deployments').each do |deployment|
+          kubectl_run(:rollout, :restart, :deployment, deployment)
+        end
+      end
+
+      desc 'scale', 'show/set scale for deployments'
+      method_option :replicas, aliases: '-r', type: :numeric, default: nil, desc: 'replicas'
+      def scale
+        if options[:replicas]
+          deployments = helm_ask_deployments('choose deployments').join(' ')
+          kubectl_run(:scale, :deployment, deployments, '--replicas', options[:replicas])
+        else
+          debug("Deployment replicas for #{helm_release_name}")
+          deployments = kubectl_json(:get, :deployments, '-l', helm_selector)
+          print_table deployments['items'].map { |i|
+            [ i['metadata']['name'], i['status']['replicas'] || 0 ]
+          }
+        end
+      end
+
     end
   end
 end

data/lib/stax/helm/jobs.rb

@@ -0,0 +1,13 @@
+## tasks to get job details
+module Stax
+  module Helm
+    class Cmd < Base
+
+      desc 'jobs', 'list jobs'
+      def jobs
+        kubectl_run(:get, :jobs, '-l', helm_selector)
+      end
+
+    end
+  end
+end

data/lib/stax/helm/kubectl.rb

@@ -12,6 +12,12 @@ module Stax
           options[:recon] ? puts(cmd) : system(cmd)
         end
 
+        def kubectl_json(*args)
+          args.push('-o=json')
+          cmd = [kubectl_bin, *args].join(' ')
+          options[:recon] ? puts(cmd) : JSON.parse(%x(#{cmd}))
+        end
+
         ## override this to match all objects in your helm release
         def helm_selector
           "app.kubernetes.io/instance=#{helm_release_name}"

data/lib/stax/helm/pod.rb

@@ -33,6 +33,7 @@ module Stax
 
       desc 'logs [OPTIONS]', 'run kubectl logs with same options'
       def logs(*args)
+        trap('SIGINT', 'EXIT')    # clean exit with ctrl-c
         args = [ '--all-containers', '--prefix', '--follow' ] if args.empty? # helpful default args
         kubectl_run(:logs, '-l', helm_selector, *args)
       end

data/lib/stax/helm/runcmd.rb

@@ -0,0 +1,108 @@
+require 'securerandom'
+
+module Stax
+  module Helm
+    class Cmd
+
+      no_commands do
+        ## construct a Job template
+        def helm_run_template(name)
+          {
+            apiVersion: 'batch/v1',
+            kind: :Job,
+            metadata: {
+              name: name,
+              labels: {
+                'app.kubernetes.io/managed-by' => :stax
+              }
+            },
+            spec: {
+              template: {
+                spec: {
+                  restartPolicy: :Never
+                }
+              }
+            }
+          }
+        end
+
+        ## Deployment to clone for container
+        def helm_run_deployment
+          "#{helm_release_name}-web"
+        end
+
+        ## name of container to clone from Deployment
+        def helm_run_container
+          'web'
+        end
+
+        ## name for Job to create based on container
+        def helm_run_job
+          "#{helm_release_name}-run-#{SecureRandom.hex(4)}"
+        end
+
+        ## default command to run
+        def helm_run_cmd
+          'bash'
+        end
+      end
+
+      ## task creates a dedicated unique kubernetes Job, with
+      ## container spec based on the helm release deployment
+      ## requested, then does an interactive exec to the pod and
+      ## container created, and deletes the Job on exit
+      desc 'runcmd [CMD]', 'run dedicated interactive container'
+      method_option :sleep, type: :string,  default: '1h',  description: 'kill container after time'
+      method_option :keep,  type: :boolean, default: false, description: 'do not delete job'
+      def runcmd(*cmd)
+        ## use default if not set
+        cmd = Array(helm_run_cmd) if cmd.empty?
+
+        ## name of k8s Job to create, and basic template
+        job = helm_run_job
+        template = helm_run_template(job)
+
+        ## get deployment and extract container spec
+        deployment = kubectl_json(:get, :deployment, helm_run_deployment)
+        spec = deployment.dig('spec', 'template', 'spec', 'containers').find do |c|
+          c['name'] == helm_run_container
+        end
+
+        ## cleanup the container spec so we can use it in a Job
+        spec.delete('livenessProbe')
+        spec.delete('readinessProbe')
+        spec.delete('volumeMounts')
+        spec['name'] = 'run'
+        spec['args'] = ['sleep', options[:sleep]]
+
+        ## add container to Job template
+        template[:spec][:template][:spec][:containers] = [ spec ]
+
+        ## get service account and add to template
+        service_account = deployment.dig('spec', 'template', 'spec', 'serviceAccountName')
+        template[:spec][:template][:spec][:serviceAccountName] = service_account if service_account
+
+        ## create new unique Job based on the container spec
+        debug("Creating job #{job}")
+        Open3.popen2('kubectl create -f -') { |stdin, stdout, _|
+          stdin.print(template.to_json)
+          stdin.close
+          puts stdout.gets
+        }
+
+        ## get name of the Pod created by the Job
+        pod = kubectl_json(:get, :pod, '-l', "job-name=#{job}")['items'].first['metadata']['name']
+
+        ## exec into the pod and run interactive command
+        debug("Connecting to pod #{pod}")
+        kubectl_run(:wait, '--for=condition=Ready', '--timeout=5m', :pod, pod)
+        kubectl_run(:exec, '-it', pod, '--', *cmd)
+      rescue JSON::ParserError
+        fail_task('cannot get kubernetes resource')
+      ensure
+        ## delete Job
+        kubectl_run(:delete, :job, job) unless options[:keep]
+      end
+    end
+  end
+end

data/lib/stax/helm/stern.rb

@@ -16,6 +16,7 @@ module Stax
       ## pass through args to stern
       desc 'stern [STERN_ARGS]', 'use stern to show logs'
       def stern(*args)
+        trap('SIGINT', 'EXIT')    # clean exit with ctrl-c
         stern_run('-l', helm_selector, *args)
       end
 

data/lib/stax/helm/version.rb

@@ -1,5 +1,5 @@
 module Stax
   module Helm
-    VERSION = '0.0.4'
+    VERSION = '0.0.9'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax-helm
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 platform: ruby
 authors:
 - Richard Lister
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,11 +67,15 @@ files:
 - README.md
 - Rakefile
 - lib/stax/helm.rb
+- lib/stax/helm/base.rb
 - lib/stax/helm/cmd.rb
+- lib/stax/helm/cronjobs.rb
 - lib/stax/helm/deployment.rb
 - lib/stax/helm/ingress.rb
+- lib/stax/helm/jobs.rb
 - lib/stax/helm/kubectl.rb
 - lib/stax/helm/pod.rb
+- lib/stax/helm/runcmd.rb
 - lib/stax/helm/stern.rb
 - lib/stax/helm/version.rb
 - stax-helm.gemspec