stax-helm 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39d86691aa95175038ebb17eea1a61d0c5c10c494de2a620cfa896621c646a5
-  data.tar.gz: 0bb2e82a0901daf51b69aaff4eda6b34edf8b77f2feecd991b127b797a0c2d86
+  metadata.gz: 7beb0767d7b08899165a52b8e58886c667a3d4d74a1a9e0e5918d599d0e755f8
+  data.tar.gz: 913a768e730ccdb511c1e2477d25d0b4438e1f14cdd81bd79099fd1766ccf1ba
 SHA512:
-  metadata.gz: 7c13bf85d7e78a3ae7494fb56d89cda5e7366d660c8b92bf7065dd859ba2b04761ef35db2e93a835a2f0945f629664fc53e495866e3fc639fb9264e5e59ade58
-  data.tar.gz: 13e34d76337048c8ab014427139f4f9f4373c1561ae29ee78b0b6a7ab4f0526d159557cb39f9f0fec97b359b6150d31d552d259b345f0a08c1faedb2b927c629
+  metadata.gz: 7b8aee9ce577d1ec38b3a33ce446ff00f44bde274bae2aa0b8cf5934eebae30f7831683c0ac8b79e6330951cacc98e3aa8b78e1f50fff31bffab5fbb90ca0283
+  data.tar.gz: 566b8097eb9e92660459b4cc252b7aa3c922df810417435a578c6a7d183111c6a70bc00322e6ee1e20a324ab7ada73b076cc7b11649343a0ac21c421ccde4dfc

data/README.md

@@ -1,5 +1,9 @@
 # Stax::Helm
 
+[Stax](https://github.com/rlister/stax) is a highly-opionated framework for managing Cloudformation stacks.
+
+Stax::Helm is highly-opionated framework for managing helm releases alongside their supporting Cloudformation stacks
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,24 +20,32 @@ Or install it yourself as:
 
     $ gem install stax-helm
 
-## Usage
+## Opinions
 
-TODO: Write usage instructions here
+- you have one chart per application repo
+- chart lives in `helm` dir alongside your `Staxfile`
+- objects are labeled per the suggestions in
+  https://helm.sh/docs/chart_best_practices/labels/ and
+  https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/
 
-## Development
+## Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In your `Staxfile` add:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+require 'stax/helm'
+```
 
-## Contributing
+and use commands like:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rlister/stax-helm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```
+stax helm create
+stax helm update
+stax helm delete
+```
+
+See inline help for other tasks.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Stax::Helm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rlister/stax-helm/blob/master/CODE_OF_CONDUCT.md).

data/lib/stax/helm.rb

@@ -1,2 +1,8 @@
+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'
 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 :dry_run, type: :boolean, default: false, desc: 'print command that would be run'
+      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')
@@ -21,7 +18,12 @@ module Stax
         ## run helm with args
         def helm_run(*args)
           cmd = [helm_bin, *args].join(' ')
-          options[:dry_run] ? puts(cmd) : system(cmd)
+          options[:recon] ? puts(cmd) : system(cmd)
+        end
+
+        ## description added to release
+        def helm_description
+          Git.sha
         end
 
         ## override with full path to a values.yaml file
@@ -37,6 +39,7 @@ module Stax
         ## construct args for install and upgrade commands
         def helm_update_args
           [].tap do |args|
+            args.push("--description #{helm_description}") if helm_description
             args.push("-f #{helm_values_file}") if helm_values_file
             args.push(helm_values&.map { |k,v| "--set #{k}=#{v}" })
           end.flatten
@@ -86,6 +89,11 @@ module Stax
         helm_run(:rollback, helm_release_name, revision)
       end
 
+      desc 'ls', 'list helm release'
+      def ls
+        helm_run(:ls, "--filter '^#{helm_release_name}$'")
+      end
+
     end
   end
 end

data/lib/stax/helm/deployment.rb

@@ -0,0 +1,41 @@
+## 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
+
+    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

@@ -0,0 +1,28 @@
+module Stax
+  module Helm
+    class Cmd < Base
+
+      no_commands do
+        def kubectl_bin
+          'kubectl'
+        end
+
+        def kubectl_run(*args)
+          cmd = [kubectl_bin, *args].join(' ')
+          options[:recon] ? puts(cmd) : system(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, '-l', helm_selector)
+      end
+
+    end
+  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/stern.rb

@@ -0,0 +1,25 @@
+module Stax
+  module Helm
+    class Cmd < Base
+
+      no_commands do
+        def stern_bin
+          'stern'
+        end
+
+        def stern_run(*args)
+          cmd = [stern_bin, *args].join(' ')
+          options[:dry_run] ? puts(cmd) : system(cmd)
+        end
+      end
+
+      ## 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
+
+    end
+  end
+end

data/lib/stax/helm/version.rb

@@ -1,5 +1,5 @@
 module Stax
   module Helm
-    VERSION = '0.0.1'
+    VERSION = '0.0.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax-helm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Richard Lister
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,14 +67,20 @@ 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/stern.rb
 - lib/stax/helm/version.rb
 - stax-helm.gemspec
 homepage: https://github.com/rlister/stax-helm
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Control helm charts with stax.
 test_files: []