kontena-mortar 0.2.0 → 0.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2786924c507d367859fbff5c5dc4b6bd0dc47a5103b354781679ceade5b6932f
-  data.tar.gz: 7d0dd79e456d242d03c5ea8137f12134a55913e8b996fde32dd19600f5ebfb29
+  metadata.gz: 073cb204d5c9614080090eb6ff92b97e07cf21309723c0bd7481d3c2de0dc1d7
+  data.tar.gz: 1879712cf8b82c82122c7f2fbab874fdb98fd49b9d1826fe0ba607a72e45a950
 SHA512:
-  metadata.gz: 2ec78292f39b4f4a7d51efa28bb537b18de39964f046089e14da20a0c3e9e1df1bec7ea71e174e9965aa980c6e9538cb9a04f364d8a5ca366fb2fda288a1ac7c
-  data.tar.gz: c6d1ea68376fa45c7802fa8b3ae2825fbad1d47606c87bbc04c70b68e26a4fe8be82e05b1e867e6ec56d0b2eda307724812917bb513396416d76851ab63da903
+  metadata.gz: 69bb7ba01aeaa3f56920206c25625298a5f228b276f381296d5b726dd8c6d5cd5a3b9fa5953ad8779deb4e1005e49019931a4a6ab0c3890976ed0165317e7da2
+  data.tar.gz: 785f6e6a9cf9e1d308c0db96f27be7cf724e4e9e3156328680693f080787e34390064fbb929bf62e08fb02b8d4bf78978338c5a54234588eb58aea6262143a49

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    kontena-mortar (0.2.0)
+    kontena-mortar (0.3.0.rc1)
       clamp (~> 1.3)
       deep_merge (~> 1.2)
-      k8s-client (~> 0.4.2)
+      k8s-client (~> 0.5.0)
       pastel (~> 0.7.2)
       rouge (~> 3.2)
+      tty-table (~> 0.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -46,12 +47,18 @@ GEM
     hashdiff (0.3.7)
     ice_nine (0.11.2)
     jaro_winkler (1.5.1)
-    k8s-client (0.4.2)
+    jsonpath (0.9.6)
+      multi_json
+      to_regexp (~> 0.2.1)
+    k8s-client (0.5.0)
       deep_merge (~> 1.2.1)
       dry-struct (~> 0.5.0)
       excon (~> 0.62.0)
       hashdiff (~> 0.3.7)
+      jsonpath (~> 0.9.5)
       recursive-open-struct (~> 1.1.0)
+    multi_json (1.13.1)
+    necromancer (0.4.0)
     parallel (1.12.1)
     parser (2.5.1.2)
       ast (~> 2.4.0)
@@ -62,7 +69,7 @@ GEM
     rainbow (3.0.0)
     rake (10.5.0)
     recursive-open-struct (1.1.0)
-    rouge (3.2.1)
+    rouge (3.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -85,8 +92,22 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.10.0)
+    strings (0.1.4)
+      strings-ansi (~> 0.1.0)
+      unicode-display_width (~> 1.4.0)
+      unicode_utils (~> 1.4.0)
+    strings-ansi (0.1.0)
+    to_regexp (0.2.1)
     tty-color (0.4.3)
+    tty-screen (0.6.5)
+    tty-table (0.10.0)
+      equatable (~> 0.5.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.0)
+      tty-screen (~> 0.6.4)
     unicode-display_width (1.4.0)
+    unicode_utils (1.4.0)
 
 PLATFORMS
   ruby
@@ -99,4 +120,4 @@ DEPENDENCIES
   rubocop (~> 0.57)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -14,6 +14,14 @@ While we were developing [Kontena Pharos](https://kontena.io/pharos) Kubernetes
 
 ## Installation
 
+### MacOS Homebrew
+
+`$ brew install kontena/mortar/mortar`
+
+Or to install the latest development version:
+
+`$ brew install --HEAD kontena/mortar/mortar`
+
 ### Rubygems:
 
 `$ gem install kontena-mortar`
@@ -41,13 +49,25 @@ For CI/CD use mortar also understands following environment variables:
 ### Deploying k8s yaml manifests
 
 ```
-$ mortar fire [options] <src-folder> <deployment-name>
+$ mortar fire [options] <src-folder> <shot-name>
 ```
 
 ### Removing a deployment
 
 ```
-$ mortar yank [options] <deployment-name>
+$ mortar yank [options] <shot-name>
+```
+
+### Listing all shots
+
+```
+$ mortar list [options]
+```
+
+### Describing a shot
+
+```
+$ mortar describe [options] <shot-name>
 ```
 
 ### Docker image
@@ -164,6 +184,26 @@ spec:
 
 You could shoot this resource with `mortar --var port.name=some-port --var port.number=80 my-app resources/pod.yml.erb`
 
+### Shot configuration file
+
+It is also possible to pass both [variables](#variables) and [overlays](#overlays) through a configuration file. As your templates complexity and the amount of variables used grows, it might be easier to manage the variables with an yaml configuration file. The config file has the following syntax:
+```
+variables:
+  ports:
+    - name: http
+      number: 80
+    - name: https
+      number: 443
+overlays:
+  - foo
+  - bar
+```
+
+Both `variables` and `overlays` are optional.
+
+For variables the hash is translated into a `RecursiveOpenStruct` object. What that means is that you can access each element with dotted path notation, just like the vars given through `--var` option. And of course arrays can be looped etc.. Check examples folder how to use variables effectively.
+
+The configuration file can be given using `-c` option to `mortar fire` command. By default Mortar will look for `shot.yml` or `shot.yaml` files present in current working directory.
 
 ## Contributing
 

data/build/drone/ubuntu_xenial.sh

@@ -10,7 +10,9 @@ chmod +x /usr/local/bin/rubyc
 gem install bundler
 version=${DRONE_TAG#"v"}
 package="mortar-linux-amd64-${version}"
-rubyc -o $package mortar
+mkdir -p /root/mortar-build.tmp
+rubyc -o $package -d /root/mortar-build.tmp mortar
+rm -rf /root/mortar-build.tmp
 ./$package --version
 
 # ship to github
@@ -21,4 +23,4 @@ chmod +x /usr/local/bin/github-release
     --repo mortar \
     --tag $DRONE_TAG \
     --name $package \
-    --file ./$package
+    --file ./$package

data/examples/config/config.yaml

@@ -0,0 +1,6 @@
+variables:
+  ports:
+    - name: http
+      number: 80
+    - name: https
+      number: 443

data/examples/config/pod.yml.erb

@@ -0,0 +1,16 @@
+kind: Pod
+apiVersion: v1
+metadata:
+  name: nginx
+  labels:
+    name: nginx
+  namespace: default
+spec:
+  containers:
+  - name: nginx
+    image: nginx:latest
+    ports:
+      <% var.ports.each { |port| %>
+      - containerPort: <%= port.number %>
+        name: <%= port.name %>
+      <% } %>

data/examples/config/shot.yaml

@@ -0,0 +1,6 @@
+variables:
+  ports:
+    - name: http
+      number: 80
+    - name: https
+      number: 443

data/examples/templates/variables/pod-vars.yml.erb

@@ -11,5 +11,5 @@ spec:
     image: nginx:latest
     ports:
       <%# Variables can be accessed by the name easily %>
-      - containerPort: <%= port.number %>
-        name: <%= port.name %>
+      - containerPort: <%= var.port.number %>
+        name: <%= var.port.name %>

data/kontena-mortar.gemspec

@@ -26,10 +26,11 @@ Gem::Specification.new do |spec|
   spec.post_install_message = "To install shell auto-completions, use:\n  mortar install-completions"
 
   spec.add_runtime_dependency "clamp", "~> 1.3"
-  spec.add_runtime_dependency "k8s-client", "~> 0.4.2"
+  spec.add_runtime_dependency "k8s-client", "~> 0.5.0"
   spec.add_runtime_dependency "rouge", "~> 3.2"
   spec.add_runtime_dependency "deep_merge", "~> 1.2"
   spec.add_runtime_dependency "pastel", "~> 0.7.2"
+  spec.add_runtime_dependency "tty-table", "~> 0.10.0"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/mortar.rb

@@ -4,6 +4,7 @@ require "clamp"
 require "deep_merge"
 require "mortar/version"
 require "mortar/root_command"
+require "mortar/config"
 
 autoload :K8s, "k8s-client"
 autoload :YAML, "yaml"
@@ -14,6 +15,10 @@ autoload :Pastel, "pastel"
 autoload :Pathname, "pathname"
 autoload :FileUtils, "fileutils"
 
+module TTY
+  autoload :Table, 'tty-table'
+end
+
 require "extensions/recursive_open_struct/each"
 
 module Mortar

data/lib/mortar/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mortar
+  class Config
+    class ConfigError < StandardError; end
+
+    def self.load(path)
+      cfg = YAML.safe_load(File.read(path))
+
+      raise ConfigError, "Failed to load config, check config file syntax" unless cfg.is_a? Hash
+      raise ConfigError, "Failed to load config, overlays needs to be an array" if cfg.key?('overlays') && !cfg['overlays'].is_a?(Array)
+
+      new(variables: cfg['variables'] || {}, overlays: cfg['overlays'] || [])
+    end
+
+    def initialize(variables: {}, overlays: [])
+      @variables = variables
+      @overlays = overlays
+    end
+
+    # @return [RecursiveOpenStruct]
+    def variables(other = {})
+      hash = @variables.dup
+      hash.deep_merge!(other)
+      RecursiveOpenStruct.new(hash, recurse_over_arrays: true)
+    end
+
+    def overlays(other = [])
+      return @overlays unless other
+
+      (@overlays + other).uniq.compact
+    end
+  end
+end

data/lib/mortar/describe_command.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "command"
+require_relative "mixins/client_helper"
+require_relative "mixins/tty_helper"
+
+module Mortar
+  class DescribeCommand < Mortar::Command
+    include Mortar::ClientHelper
+    include Mortar::TTYHelper
+    include Mortar::ResourceHelper
+
+    parameter "NAME", "deployment name"
+
+    option ["-o", "--output"], "OUTPUT", "Output format", default: 'table'
+
+    def execute
+      resources = client.list_resources(labelSelector: { LABEL => name }).select{ |r|
+        r.metadata.labels&.dig(LABEL) == name
+      }.uniq{ |r|
+        # Kube api returns same object from many api versions...
+        "#{r.kind}/#{r.metadata.name}/#{r.metadata.namespace}"
+      }.sort{ |a, b| # Sort resources so that non namespaced objects are outputted firts
+        if a.metadata.namespace == b.metadata.namespace
+          1
+        elsif a.metadata.namespace.nil? && !b.metadata.namespace.nil?
+          -1
+        else
+          0
+        end
+      }
+
+      case output
+      when 'table'
+        table(resources)
+      when 'yaml'
+        puts resources_output(resources)
+      when 'json'
+        puts json_output(resources)
+      else
+        signal_usage_error "Unknown output format: #{output}"
+      end
+    end
+
+    def table(resources)
+      table = TTY::Table.new %w(NAMESPACE KIND NAME), []
+      resources.each do |r|
+        table << [r.metadata.namespace || '', r.kind, r.metadata.name]
+      end
+      puts table.render(:basic)
+    end
+
+    def json_output(resources)
+      json = JSON.pretty_generate(resources.map(&:to_hash))
+      return json unless $stdout.tty?
+
+      lexer = Rouge::Lexers::JSON.new
+      rouge = Rouge::Formatters::Terminal256.new(Rouge::Themes::Github.new)
+      rouge.format(lexer.lex(json))
+    end
+  end
+end

data/lib/mortar/fire_command.rb

@@ -18,11 +18,32 @@ module Mortar
 
     option ["--var"], "VAR", "set template variables", multivalued: true
     option ["--output"], :flag, "only output generated yaml"
-    option ["--prune"], :flag, "automatically delete removed resources"
+    option ["--[no-]prune"], :flag, "automatically delete removed resources", default: true
     option ["--overlay"], "OVERLAY", "overlay dirs", multivalued: true
+    option ["-c", "--config"], "CONFIG", "variable and overlay configuration file"
+
+    def default_config
+      %w{shot.yml shot.yaml}.find { |path|
+        File.readable?(path)
+      }
+    end
+
+    def load_config
+      if config
+        signal_usage_error("Cannot read config file from #{path}") unless File.readable?(config)
+
+        @configuration = Config.load(config)
+      else
+        # No config provided nor the default config file present
+        @configuration = Config.new(variables: {}, overlays: [])
+      end
+    end
 
     def execute
       signal_usage_error("#{src} does not exist") unless File.exist?(src)
+
+      load_config
+
       resources = process_overlays
 
       if output?
@@ -46,9 +67,10 @@ module Mortar
     end
 
     def process_overlays
-      resources = load_resources(src)
-
-      overlay_list.each do |overlay|
+      # Reject any resource that do not have kind set
+      # Basically means the config or other random yml files found
+      resources = load_resources(src).reject { |r| r.kind.nil? }
+      @configuration.overlays(overlay_list).each do |overlay|
         overlay_resources = from_files(overlay)
         overlay_resources.each do |overlay_resource|
           match = false
@@ -67,44 +89,31 @@ module Mortar
       resources
     end
 
-    # @param resources [Array<K8s::Resource>]
-    # @return [String]
-    def resources_output(resources)
-      yaml = +''
-      resources.each do |resource|
-        yaml << ::YAML.dump(stringify_hash(resource.to_hash))
-      end
-      return yaml unless $stdout.tty?
-
-      lexer = Rouge::Lexers::YAML.new
-      rouge = Rouge::Formatters::Terminal256.new(Rouge::Themes::Github.new)
-      rouge.format(lexer.lex(yaml))
-    end
-
     # @return [RecursiveOpenStruct]
     def variables_struct
-      return @variables_struct if @variables_struct
+      @variables_struct ||= @configuration.variables(variables_hash)
+    end
 
+    def variables_hash
       set_hash = {}
       var_list.each do |var|
         k, v = var.split("=", 2)
         set_hash[k] = v
       end
-      RecursiveOpenStruct.new(dotted_path_to_hash(set_hash))
+
+      dotted_path_to_hash(set_hash)
     end
 
     def dotted_path_to_hash(hash)
-      hash.map do |pkey, pvalue|
+      h = hash.map do |pkey, pvalue|
         pkey.to_s.split(".").reverse.inject(pvalue) do |value, key|
           { key.to_sym => value }
         end
-      end.inject(&:deep_merge)
-    end
+      end
+      # Safer to return just empty hash instead of nil
+      return {} if h.empty?
 
-    # Stringifies all hash keys
-    # @return [Hash]
-    def stringify_hash(hash)
-      JSON.parse(JSON.dump(hash))
+      h.inject(&:deep_merge)
     end
   end
 end

data/lib/mortar/list_command.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "command"
+require_relative "mixins/client_helper"
+require_relative "mixins/tty_helper"
+
+module Mortar
+  class ListCommand < Mortar::Command
+    include Mortar::ClientHelper
+    include Mortar::TTYHelper
+
+    option ['-q', '--quiet'], :flag, "only output shot names"
+
+    def execute
+      shots = Hash.new(0)
+
+      client.list_resources(labelSelector: LABEL).select{ |r|
+        r.metadata.labels&.dig(LABEL)
+      }.uniq{ |r|
+        # Kube api returns same object from many api versions...
+        "#{r.kind}/#{r.metadata.name}/#{r.metadata.namespace}"
+      }.each do |resource|
+        shot_name = resource.metadata.labels&.dig(LABEL)
+        shots[shot_name] += 1
+      end
+
+      if quiet?
+        shots.each_key do |k|
+          puts k
+        end
+      else
+        table = TTY::Table.new %w(NAME RESOURCES), shots.to_a
+        puts table.render(:basic)
+      end
+    end
+  end
+end

data/lib/mortar/mixins/resource_helper.rb

@@ -38,5 +38,25 @@ module Mortar
         resource_a.kind == resource_b.kind &&
         resource_a.metadata[:name] == resource_b.metadata[:name]
     end
+
+    # @param resources [Array<K8s::Resource>]
+    # @return [String]
+    def resources_output(resources)
+      yaml = +''
+      resources.each do |resource|
+        yaml << ::YAML.dump(stringify_hash(resource.to_hash))
+      end
+      return yaml unless $stdout.tty?
+
+      lexer = Rouge::Lexers::YAML.new
+      rouge = Rouge::Formatters::Terminal256.new(Rouge::Themes::Github.new)
+      rouge.format(lexer.lex(yaml))
+    end
+
+    # Stringifies all hash keys
+    # @return [Hash]
+    def stringify_hash(hash)
+      JSON.parse(JSON.dump(hash))
+    end
   end
 end

data/lib/mortar/root_command.rb

@@ -3,6 +3,8 @@
 require "clamp"
 require_relative "fire_command"
 require_relative "yank_command"
+require_relative "describe_command"
+require_relative "list_command"
 require_relative "install_completions_command"
 
 Clamp.allow_options_after_parameters = true
@@ -18,6 +20,8 @@ module Mortar
 
     subcommand "fire", "Fire a shot (of k8s manifests)", FireCommand
     subcommand "yank", "Yank a shot (of k8s manifests)", YankCommand
+    subcommand "describe", "Describe a shot (of k8s manifests)", DescribeCommand
+    subcommand "list", "List shots (of k8s manifests)", ListCommand
 
     subcommand "install-completions", "Install shell autocompletions", InstallCompletionsCommand
   end

data/lib/mortar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mortar
-  VERSION = "0.2.0"
+  VERSION = "0.3.0.rc1"
 end

data/opt/bash-completion.sh

@@ -14,7 +14,7 @@ _mortar () {
       return
     fi
 
-    COMPREPLY=( $(compgen -W "fire yank" -- ${cur}) )
+    COMPREPLY=( $(compgen -W "fire yank describe list" -- ${cur}) )
     return
   else
     case "${COMP_WORDS[1]}" in
@@ -33,6 +33,18 @@ _mortar () {
           COMPREPLY=( $(compgen -W "--force --debug --help" -- ${cur}) )
         fi
         ;;
+      describe)
+        if [[ ${cur} == -* ]] ; then
+          COMPREPLY=( $(compgen -W "--output --debug --help" -- ${cur}) )
+        elif [ "$prev" = "--output" ]; then
+          COMPREPLY=( $(compgen -W "table yaml json" -- ${cur}) )
+        fi
+        ;;
+      list)
+        if [[ ${cur} == -* ]] ; then
+          COMPREPLY=( $(compgen -W "--quiet --debug --help" -- ${cur}) )
+        fi
+        ;;
     esac
   fi
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kontena-mortar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.rc1
 platform: ruby
 authors:
 - Kontena, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +176,9 @@ files:
 - build/travis/macos.sh
 - examples/basic/deployment.yml
 - examples/basic/service.yml
+- examples/config/config.yaml
+- examples/config/pod.yml.erb
+- examples/config/shot.yaml
 - examples/force-deployment/deployment.yml.erb
 - examples/overlays/echo-metal.yml
 - examples/overlays/foo/pod.yml.erb
@@ -176,8 +193,11 @@ files:
 - lib/extensions/recursive_open_struct/each.rb
 - lib/mortar.rb
 - lib/mortar/command.rb
+- lib/mortar/config.rb
+- lib/mortar/describe_command.rb
 - lib/mortar/fire_command.rb
 - lib/mortar/install_completions_command.rb
+- lib/mortar/list_command.rb
 - lib/mortar/mixins/client_helper.rb
 - lib/mortar/mixins/resource_helper.rb
 - lib/mortar/mixins/tty_helper.rb
@@ -203,9 +223,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6