stax-helm 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 915820e964fa23b1d20b876f7e89d22ee55a97e4aa60fec75e508e47f36daf54
-  data.tar.gz: 6da2869fac93946398ec4c0c83df102f4cb2a883b0b5dd72ce6486d5a804ea63
+  metadata.gz: 90efb4bc5fd77b16200e4693747b303df7644ebfe21149d715327a56397f1d25
+  data.tar.gz: 19d2b39ef1cbd165dbd32091f317f8c11b12624d381920bdffd5295b8b8c5b68
 SHA512:
-  metadata.gz: 80d9424da2501a5b209af37868fd4b615d53acb125517effb7c3a759019cf3de9ef8c025f0e10b3473b48823b986ec11c4e9cf7a010b36e2f829ca2b878c939e
-  data.tar.gz: 4bef3ab94b44a3fec3c20d3df75b353bd89a823f2c5ad0959985130a8797cbe694388f4649bd1152cf53b3265e4d5e49ce897a0e1a6da8b90847632e34e25020
+  metadata.gz: 5566799f8341ace21b46a2ec7c3d90a3c5dc11d26f54c7efa1dc593df439e6dd59732286153823995573a53337252f8249000d54f26dd4813e72ebad23e943ff
+  data.tar.gz: 8d1b6ca7b1e7465cac0f77754438ccff9ad880e12bf7d1eb9b2c58a6f48921bbad3471696ab4cd2e609aeee1cd749c0ce6304c23ad248ece555a2291140c5785

data/lib/stax/helm.rb

@@ -1,4 +1,9 @@
+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/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/deployment.rb

@@ -0,0 +1,56 @@
+## tasks to work on deployments
+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/ingress.rb

@@ -0,0 +1,19 @@
+## tasks to get ingress details
+module Stax
+  module Helm
+    class Cmd < Base
+
+      desc 'ingresses', 'list ingresses'
+      def ingresses
+        kubectl_run(:get, :ingresses, '-l', helm_selector)
+      end
+
+      desc 'dns', 'list external-dns hostnames'
+      def dns
+        jsonpath = '{.items[].metadata.annotations.external-dns\.alpha\.kubernetes\.io/hostname}' + "\n"
+        kubectl_run(:get, :ingresses, "-o=jsonpath='#{jsonpath}'", '-l', helm_selector)
+      end
+
+    end
+  end
+end

data/lib/stax/helm/kubectl.rb

@@ -9,54 +9,24 @@ module Stax
 
         def kubectl_run(*args)
           cmd = [kubectl_bin, *args].join(' ')
-          options[:dry_run] ? puts(cmd) : system(cmd)
+          options[:recon] ? puts(cmd) : system(cmd)
         end
 
-        ## build a selector argument from a hash of label and value pairs
-        def selector(hash)
-          '-l ' + hash.compact.map { |k,v| "#{k}=#{v}" }.join(',')
+        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}"
         end
       end
 
       desc 'services', 'list services'
       def services
-        kubectl_run(:get, :services, selector('app.kubernetes.io/instance': helm_release_name))
-      end
-
-      desc 'ingresses', 'list ingresses'
-      def ingresses
-        kubectl_run(:get, :ingresses, selector('app.kubernetes.io/instance': helm_release_name))
-      end
-
-      desc 'deployments', 'list deployments'
-      def deployments
-        kubectl_run(:get, :deployments, selector('app.kubernetes.io/instance': helm_release_name))
-      end
-
-      desc 'pods', 'list pods'
-      def pods
-        kubectl_run(:get, :pods, selector('app.kubernetes.io/instance': helm_release_name))
-      end
-
-      desc 'containers', 'list containers'
-      def containers
-        columns = 'NAME:.metadata.name,CONTAINERS:.spec.containers[*].name'
-        kubectl_run(:get, :pods, '-o', "custom-columns=#{columns}", selector('app.kubernetes.io/instance': helm_release_name))
-      end
-
-      ## FIXME this is terrible, will be replaced with something better later
-      desc 'logs COMPONENT [CONTAINER]', 'show container logs'
-      method_option :container, aliases: '-c', type: :string, default: nil, desc: 'container from pod'
-      def logs(component)
-        container = options[:container] ? "-c #{options[:container]}" : ''
-        kubectl_run(
-          :logs,
-          container,
-          selector(
-            'app.kubernetes.io/instance': helm_release_name,
-            'app.kubernetes.io/component': component,
-          )
-        )
+        kubectl_run(:get, :services, '-l', helm_selector)
       end
 
     end

data/lib/stax/helm/pod.rb

@@ -0,0 +1,49 @@
+## tasks to work on pods
+module Stax
+  module Helm
+    class Cmd < Base
+
+      no_commands do
+        def helm_pods
+          jsonpath = '{.items[*].metadata.name}'
+          %x[kubectl get pods -o=jsonpath='#{jsonpath}' -l #{helm_selector}].split
+        end
+
+        def helm_ask_pod(msg)
+          pods = helm_pods
+          index = 0
+          if pods.count > 1
+            puts pods.each_with_index.map { |p, i| "#{i}: #{p}" }
+            index = ask(msg, default: index)
+          end
+          pods[index.to_i]
+        end
+      end
+
+      desc 'pods', 'list pods'
+      def pods
+        kubectl_run(:get, :pods, '-l', helm_selector)
+      end
+
+      desc 'containers', 'list containers'
+      def containers
+        columns = 'NAME:.metadata.name,CONTAINERS:.spec.containers[*].name'
+        kubectl_run(:get, :pods, '-o', "custom-columns=#{columns}", '-l', helm_selector)
+      end
+
+      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
+
+      desc 'exec [CMD]', 'exec command in a web pod'
+      def exec(cmd = 'sh')
+        pod = helm_ask_pod('choose a pod')
+        kubectl_run(:exec, '-it', pod, '--', cmd)
+      end
+
+    end
+  end
+end

data/lib/stax/helm/runcmd.rb

@@ -0,0 +1,101 @@
+require 'securerandom'
+
+module Stax
+  module Helm
+    class Cmd
+
+      no_commands do
+        ## construct a Job template from passed container spec
+        def helm_run_template(name, container_spec)
+          {
+            apiVersion: 'batch/v1',
+            kind: :Job,
+            metadata: {
+              name: name,
+              labels: {
+                'app.kubernetes.io/managed-by' => :stax
+              }
+            },
+            spec: {
+              template: {
+                spec: {
+                  restartPolicy: :Never,
+                  containers: [ container_spec ],
+                }
+              }
+            }
+          }.to_json
+        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
+        job = helm_run_job
+
+        ## get deployment and extract container spec
+        deployment = kubectl_json(:get, :deployment, helm_run_deployment)
+        spec = deployment['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]]
+
+        ## create new unique Job based on the container spec
+        debug("Creating job #{job}")
+        Open3.popen2('kubectl create -f -') { |stdin, stdout, _|
+          stdin.print(helm_run_template(job, spec))
+          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,7 +16,8 @@ module Stax
       ## pass through args to stern
       desc 'stern [STERN_ARGS]', 'use stern to show logs'
       def stern(*args)
-        stern_run(selector('app.kubernetes.io/instance': helm_release_name), *args)
+        trap('SIGINT', 'EXIT')    # clean exit with ctrl-c
+        stern_run('-l', helm_selector, *args)
       end
 
     end

data/lib/stax/helm/version.rb

@@ -1,5 +1,5 @@
 module Stax
   module Helm
-    VERSION = '0.0.3'
+    VERSION = '0.0.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax-helm
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Richard Lister
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,8 +67,13 @@ files:
 - README.md
 - Rakefile
 - lib/stax/helm.rb
+- lib/stax/helm/base.rb
 - lib/stax/helm/cmd.rb
+- lib/stax/helm/deployment.rb
+- lib/stax/helm/ingress.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
@@ -76,7 +81,7 @@ homepage: https://github.com/rlister/stax-helm
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Control helm charts with stax.
 test_files: []