stax-helm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39d86691aa95175038ebb17eea1a61d0c5c10c494de2a620cfa896621c646a5
-  data.tar.gz: 0bb2e82a0901daf51b69aaff4eda6b34edf8b77f2feecd991b127b797a0c2d86
+  metadata.gz: 8db16bbf17c66b24cf72a3e807ffeda939a1fda49ced1f7d9b708eae254b66ed
+  data.tar.gz: cd11b9f4eb2d4732a067e1aa51da1613e64903f3668e57e2b9886a084a599e95
 SHA512:
-  metadata.gz: 7c13bf85d7e78a3ae7494fb56d89cda5e7366d660c8b92bf7065dd859ba2b04761ef35db2e93a835a2f0945f629664fc53e495866e3fc639fb9264e5e59ade58
-  data.tar.gz: 13e34d76337048c8ab014427139f4f9f4373c1561ae29ee78b0b6a7ab4f0526d159557cb39f9f0fec97b359b6150d31d552d259b345f0a08c1faedb2b927c629
+  metadata.gz: c3a6d9400080112015b5dd688939d84f80df7cae7d9f094316f8b51c2cc6c8aa5a1ab127ef0876a148e0761c1e875ebae78ff33c51c12700925e03d72513def2
+  data.tar.gz: be3eb884e62f76be25450face25c860095380ddca05f72b98cb2ba971e538fb874c0ebd7e0e476bab36af2a9dec8d238f239e709844f44dc1e14acbe88bd58cf

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,4 @@
 require 'stax/helm/cmd'
+require 'stax/helm/kubectl'
+require 'stax/helm/stern'
 Stax.add_command(:helm, Stax::Helm::Cmd)

data/lib/stax/helm/cmd.rb

@@ -86,6 +86,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/kubectl.rb

@@ -0,0 +1,64 @@
+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[:dry_run] ? 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(',')
+        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,
+          )
+        )
+      end
+
+    end
+  end
+end

data/lib/stax/helm/stern.rb

@@ -0,0 +1,24 @@
+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)
+        stern_run(selector('app.kubernetes.io/instance': helm_release_name), *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.2'
   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.2
 platform: ruby
 authors:
 - Richard Lister
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,8 @@ files:
 - Rakefile
 - lib/stax/helm.rb
 - lib/stax/helm/cmd.rb
+- lib/stax/helm/kubectl.rb
+- lib/stax/helm/stern.rb
 - lib/stax/helm/version.rb
 - stax-helm.gemspec
 homepage: https://github.com/rlister/stax-helm