stax-helm 0.0.7 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce6add2c9a7276df7ed801b49c7f3a7151ba4d98c34b3690a4fdaca6678fdeb5
-  data.tar.gz: c04af79c0c1fe2a14d7493e175980aeef5864f074f2f405bc67bd7fef35696c8
+  metadata.gz: e468498945819346be38bcecf9196c53f1710899e8d2818ba24e6e8d39e99f73
+  data.tar.gz: d63fcefed8ded8b86229794205e06fe9b7d3b83d61e0f29223e993219171e32d
 SHA512:
-  metadata.gz: fb825149e84265f3f50ea1d17554f4514d2db401d771251063f9f1ce81fb90cfe221053b4a7f9c168797777493679a11f56d850af34fbb3c548cff32237174c3
-  data.tar.gz: 29ff4a39a0ac91b12ea218cff57fd6afa81658ff9fc4ec26d8a90019bab133e8ef3fe5cf7adf3ae895a89a0c3b79f946a8b819e801093ffdf13e8d89418f668f
+  metadata.gz: ca3ffab05c1866c546deaf0a8fac5361ecdadecdd6a2bebc5bb9b46321b6a36824680c36a9294288b5007dd5903b86d89ea435ea5d42c45ee88f3f195c58f1d1
+  data.tar.gz: f0f59bceb82dee3cd0f9b8ef236e49b7c4f7b6737218ba76d6c79c107f38aa15dc099847467bcbfa234fbd8a3a74686cc49d45d03aa6243e7349e41df5fe5538

data/lib/stax/helm/base.rb

@@ -8,7 +8,7 @@ module Stax
 
       ## make string safe to use in naming helm stuff
       def helm_safe(string)
-        string.slice(0, 53).gsub(/[\W_]/, '-').downcase
+        string.slice(0, 53).gsub(/[\W_]/, '-').sub(/-+$/, '').downcase
       end
     end
 

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/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/runcmd.rb

@@ -0,0 +1,109 @@
+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('startupProbe')
+        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/version.rb

@@ -1,5 +1,5 @@
 module Stax
   module Helm
-    VERSION = '0.0.7'
+    VERSION = '0.0.11'
   end
 end

data/lib/stax/helm.rb

@@ -4,5 +4,8 @@ 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/stax-helm.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake', '>= 12.3.3'
 
   spec.add_dependency('stax')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax-helm
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.11
 platform: ruby
 authors:
 - Richard Lister
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -69,10 +69,13 @@ files:
 - 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
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Control helm charts with stax.