kubes 0.8.8 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c88d1788b4ecebd40180a69bcf8be5d7f8e8128ee40b1a4d7d862bc279697dd
-  data.tar.gz: 8a072ba5a27be585a0e278ec1aaff1b16e3240c9ad8a86caa97536d912832f67
+  metadata.gz: db6959c3513133da9d5340dc8c332e15f86be47e5f72d47188243fafb21b3bd0
+  data.tar.gz: 94762322cb38b47c1d4167060545012dd6416515628801efdd969fc8dd189b91
 SHA512:
-  metadata.gz: e2fb01f36269bc38b4123bc7321dc5f5787590af8b5ea74429aa0f494915378940ef7a22effd1edf67607c26a04ad040242009b0680b7e46a08747c257b8b357
-  data.tar.gz: 5526ece8f8f78d7ca8fe9fac76ee4fb4171b6a9f505003382cafd9239a5d1d828b9c5fd2e61c1c3c3e01d1f7a5336cf72ed3f896128f15f5d46607eba1695a31
+  metadata.gz: 9a506b81df303fd915146596f792fcbd6b0ede5b93c81d6bcd75f0fa3123a47129086969decef3d44b273e6740d518facf91053c8f10e61ad3de6698c673a0e9
+  data.tar.gz: f2ddb1238b542b0279069a5b7417d4ed458384729cdd3859511b55222161c6443131ade97534f91fe19df9f20fae3074943a40120a3470bbf91142cd8d419a89

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.9.0] - 2022-08-24
+- [#66](https://github.com/boltops-tools/kubes/pull/66) show layering improvements: show resource layers also
+- only show error if exit_on_fail
+
+## [0.8.10] - 2022-08-18
+- [#65](https://github.com/boltops-tools/kubes/pull/65) show variables layers support
+- improve new secret generator
+
+## [0.8.9] - 2022-08-11
+- [#64](https://github.com/boltops-tools/kubes/pull/64) extra variable layering
+- add extra layering docs
+
 ## [0.8.8] - 2022-08-11
 - add Kubes.extra method
 - update managed_certificate and ingress apiVersion

data/docs/_docs/layering/debug.md

@@ -0,0 +1,62 @@
+---
+title: "Debug Layering"
+category: layering
+order: 9
+---
+
+Kube's Layering abilities are so powerful that they can be difficult to debug when overly used.  It is recommended that you chose only a few layers that make sense for your goals and stick to them. Essentially, limit the rope length. Here are also some debugging tips.
+
+## Enable Logging
+
+You can debug layers by turning a config to show the **found** layers. Currently, only variables layering is shown.
+
+.kubes/config.rb
+
+```ruby
+Kubes.configure do |config|
+  config.layering.show = true
+end
+```
+
+This will show the **found** layers.
+
+    $ kubes compile
+    Compiling .kubes/resources/shared/namespace.yaml
+        .kubes/variables/base.rb
+        .kubes/variables/dev.rb
+    Compiling .kubes/resources/web/deployment.yaml
+        .kubes/variables/base.rb
+        .kubes/variables/dev.rb
+    Compiling .kubes/resources/web/service.yaml
+        .kubes/variables/base.rb
+        .kubes/variables/dev.rb
+
+## All Considered Layers
+
+If you want to also see all the considered layers use `KUBES_LAYERING_SHOW_ALL=1`. Note, this will show a lot of layers. Kubes considers many layers and for files `base/all.yml` also perform layering and results are ultimately merged together. Here's an example snippet of the output.
+
+    $ export KUBES_LAYERING_SHOW_ALL=1
+    Compiling .kubes/resources/web/deployment.yaml
+    Rendering .kubes/resources/web/deployment.yaml
+        .kubes/variables/base.rb
+        .kubes/variables/dev.rb
+        .kubes/variables/base/all.rb
+        .kubes/variables/base/all/dev.rb
+        .kubes/variables/base/deployment.rb
+        .kubes/variables/base/deployment/base.rb
+        .kubes/variables/base/deployment/dev.rb
+        .kubes/variables/web/deployment.rb
+        .kubes/variables/web/deployment/base.rb
+        .kubes/variables/web/deployment/dev.rb
+    Rendering .kubes/resources/base/all.yaml
+        .kubes/variables/base.rb
+        .kubes/variables/dev.rb
+        .kubes/variables/base/all.rb
+        .kubes/variables/base/all/dev.rb
+        .kubes/variables/base/deployment.rb
+        .kubes/variables/base/deployment/base.rb
+        .kubes/variables/base/deployment/dev.rb
+        .kubes/variables/web/deployment.rb
+        .kubes/variables/web/deployment/base.rb
+        .kubes/variables/web/deployment/dev.rb
+    ...

data/docs/_docs/layering/dsl.md

@@ -1,5 +1,8 @@
 ---
 title: DSL Layering
+nav_text: DSL
+category: layering
+order: 2
 ---
 
 {% include layering/layers.md ext="rb" %}

data/docs/_docs/layering/extra.md

@@ -0,0 +1,18 @@
+---
+title: Extra Layering
+category: layering
+order: 8
+---
+
+Setting KUBES_EXTRA will process extra layers.
+
+## Variables
+
+Example
+
+    KUBES_EXTRA=2 kubes deploy
+
+Will process:
+
+    .kubes/variables/dev.rb
+    .kubes/variables/dev-2.rb

data/docs/_docs/layering/merge-dsl.md

@@ -1,5 +1,8 @@
 ---
 title: DSL Merge Behavior
+nav_text: DSL Merge
+category: layering
+order: 4
 ---
 
 Generally, the merge should behave as expected. For example, map or Hash fields are merged together from multiple layers. Strings are simply replaced.

data/docs/_docs/layering/merge-options.md

@@ -1,5 +1,7 @@
 ---
 title: Merge Options
+category: layering
+order: 5
 ---
 
 Underneath the hood, Kubes uses the [danielsdeleo/deep_merge](https://github.com/danielsdeleo/deep_merge) library to merge layers together. You can control the merge behavior options with [config.merger.options]({% link _docs/config/reference.md %}).

data/docs/_docs/layering/mix.md

@@ -1,5 +1,8 @@
 ---
 title: Mixed Layering
+nav_text: Mix and Match
+category: layering
+order: 3
 ---
 
 You can mix and match the YAML and DSL forms together and layering still works.

data/docs/_docs/layering/yaml.md

@@ -1,5 +1,8 @@
 ---
 title: YAML Layering
+nav_text: YAML
+category: layering
+order: 1
 ---
 
 {% include layering/layers.md ext="yaml" %}

data/docs/_docs/layering.md

@@ -4,7 +4,7 @@ title: Layering
 
 Kubes supports layering files together so you can use the same Kubernetes files to build multiple environments like dev and prod.
 
-* [YAML Layering]({% link _docs/layering/yaml.md %})
-* [DSL Layering]({% link _docs/layering/dsl.md %})
-* [Mix Layering]({% link _docs/layering/mix.md %})
-* [Merge Behavior]({% link _docs/layering/merge-dsl.md %})
+{% assign docs = site.docs | where: "categories","layering" | sort: "order" %}
+{% for doc in docs -%}
+* [{{ doc.title }}]({{ doc.url }})
+{% endfor %}

data/docs/_includes/sidebar.html

@@ -123,11 +123,10 @@
       </li>
       <li><a href="{% link _docs/layering.md %}">Layering</a>
         <ul>
-          <li><a href="{% link _docs/layering/yaml.md %}">YAML</a></li>
-          <li><a href="{% link _docs/layering/dsl.md %}">DSL</a></li>
-          <li><a href="{% link _docs/layering/mix.md %}">Mix</a></li>
-          <li><a href="{% link _docs/layering/merge-dsl.md %}">Merge DSL</a></li>
-          <li><a href="{% link _docs/layering/merge-options.md %}">Merge Options</a></li>
+          {% assign docs = site.docs | where: "categories","layering" | sort: "order" %}
+          {% for doc in docs -%}
+            <li><a href="{{ doc.url }}">{% if doc.nav_text %}{{ doc.nav_text }}{% else %}{{ doc.title }}{% endif %}</a></li>
+          {% endfor %}
         </ul>
       </li>
       <li><a href="{% link _docs/dsl.md %}">DSL</a>

data/lib/kubes/compiler/shared/runtime_helpers.rb

@@ -1,6 +1,7 @@
 module Kubes::Compiler::Shared
   module RuntimeHelpers
     include Kubes::Compiler::Shared::Helpers
+    include Kubes::Util::Pretty
 
     def load_runtime_helpers
       load_plugin_helpers
@@ -59,15 +60,23 @@ module Kubes::Compiler::Shared
       layers = [
         "base.rb",
         "#{Kubes.env}.rb",
+        "#{Kubes.env}-#{Kubes.extra}.rb",
         "base/all.rb",
         "base/all/#{Kubes.env}.rb",
+        "base/all/#{Kubes.env}-#{Kubes.extra}.rb",
         "base/#{kind}.rb",
         "base/#{kind}/base.rb",
         "base/#{kind}/#{Kubes.env}.rb",
+        "base/#{kind}/#{Kubes.env}-#{Kubes.extra}.rb",
         "#{role}/#{kind}.rb",
         "#{role}/#{kind}/base.rb",
         "#{role}/#{kind}/#{Kubes.env}.rb",
+        "#{role}/#{kind}/#{Kubes.env}-#{Kubes.extra}.rb",
       ]
+      # filter out the -.rb layers when Kubes.extra is not set
+      # IE: .kubes/variables/dev-.rb
+      layers.reject! { |layer| layer.ends_with?('-.rb') }
+
       if Kubes.app
         app_layers = ["#{Kubes.app}.rb"]
         app_layers += layers.map do |path|
@@ -76,10 +85,34 @@ module Kubes::Compiler::Shared
         layers += app_layers
       end
 
-      layers.each do |layer|
-        path = "#{Kubes.root}/.kubes/variables/#{layer}"
+      layer_paths = layers.map { |layer| "#{Kubes.root}/.kubes/variables/#{layer}" }
+      layer_paths = layer_paths.select { |path| File.exist?(path) } unless ENV['KUBES_LAYERING_SHOW_ALL']
+      layer_paths.each do |path|
+        show_variable_layer_path(path)
         evaluate_file(path)
       end
     end
+
+    @@header_shown = {} # key is main @path
+    @@shown = {}
+    def show_variable_layer_path(path)
+      main_path = @path # main path is main resource file
+
+      show_header = !@@header_shown.dig(main_path)
+      if show_header && Kubes.config.layering.show
+        logger.info "    Variables layers:"
+        @@header_shown[main_path] = true
+      end
+      # Examples:
+      #   .kubes/resources/web/deployment.yaml
+      #   .kubes/resources/shared/namespace.yaml
+      show_once = !@@shown.dig(main_path, path)
+      show_layer = Kubes.config.layering.show && show_once
+      if show_layer
+        logger.info "    #{pretty_path(path)}"
+        @@shown[main_path] ||= {}
+        @@shown[main_path][path] = true
+      end
+    end
   end
 end

data/lib/kubes/compiler/strategy/base.rb

@@ -4,6 +4,7 @@ class Kubes::Compiler::Strategy
     include Kubes::Compiler::Util::Normalize
     include Kubes::Compiler::Util::SaveFile
     include Kubes::Logging
+    include Kubes::Util::Pretty
 
     def initialize(options={})
       @options = options

data/lib/kubes/compiler/strategy/dispatcher.rb

@@ -1,6 +1,7 @@
 class Kubes::Compiler::Strategy
   class Dispatcher < Base
     def dispatch
+      show_layers if Kubes.config.layering.show
       result = render(@path) # main
       results = [result].flatten # ensure array
       data = results.map! do |main|
@@ -10,12 +11,22 @@ class Kubes::Compiler::Strategy
       Result.new(@save_file, data)
     end
 
+    def show_layers
+      logger.info "Compiling #{pretty_path(@path)}"
+      logger.info "    Resource layers:"
+      all_layers = pre_layers + [@path] + post_layers
+      all_layers.each do |layer|
+        logger.info "    #{pretty_path(layer)}"
+      end
+    end
+
     # Render via to Erb or one of the DSL syntax classes or Core/Blocks class
     def render(path)
       if path.include?('.rb')
         klass = dsl_class(path) # IE: Kubes::Compiler::Dsl::Syntax::Deployment or Kubes::Compiler::Dsl::Core::Blocks
         klass.new(@options.merge(path: path, data: @data)).run
       else
+        logger.info "Rendering #{pretty_path(path)}" if ENV['KUBES_LAYERING_SHOW_RENDERING']
         Erb.new(@options.merge(data: @data)).render_result(path)
       end
     end

data/lib/kubes/config.rb

@@ -33,6 +33,9 @@ module Kubes
       config.repo = nil # expected to be set by .kubes/config.rb
       config.repo_auto_auth = true
 
+      config.layering = ActiveSupport::OrderedOptions.new
+      config.layering.show = ENV['KUBES_LAYERING_SHOW'] || false
+
       config.logger = Logger.new($stderr)
       config.logger.level = ENV['KUBES_LOG_LEVEL'] || :info
 

data/lib/kubes/util/pretty.rb

@@ -0,0 +1,7 @@
+module Kubes::Util
+  module Pretty
+    def pretty_path(path)
+      path.sub("#{Kubes.root}/",'')
+    end
+  end
+end

data/lib/kubes/util/sh.rb

@@ -24,7 +24,7 @@ module Kubes::Util
       logger.info "=> #{command}" if show_command
       success = system(env, command)
       unless success
-        logger.error "ERROR: running #{command}".color(:red)
+        logger.error "ERROR: running #{command}".color(:red) if exit_on_fail
         exit $?.exitstatus if exit_on_fail
       end
       success

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.8.8"
+  VERSION = "0.9.0"
 end

data/lib/templates/base/.kubes/config.rb.tt

@@ -1,6 +1,7 @@
 Kubes.configure do |config|
   config.repo = "<%= @options[:repo] %>"
-  config.logger.level = "info"
+  # config.logger.level = "debug"
+  # config.layering.show = true
   # auto-switching
   # config.kubectl.context = "dev-cluster"
   # config.kubectl.context_keep = true # keep context after switching

data/lib/templates/new/resource/yaml/secret.yaml

@@ -5,5 +5,5 @@ metadata:
   labels:
     app: <%= app %>
 data:
-  username: dXNlcg==
-  password: cGFzcw==
+  username: <%%= base64("user") %>
+  password: <%%= base64("pass") %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -367,7 +367,9 @@ files:
 - docs/_docs/intro/ordering/custom.md
 - docs/_docs/intro/structure.md
 - docs/_docs/layering.md
+- docs/_docs/layering/debug.md
 - docs/_docs/layering/dsl.md
+- docs/_docs/layering/extra.md
 - docs/_docs/layering/merge-dsl.md
 - docs/_docs/layering/merge-options.md
 - docs/_docs/layering/mix.md
@@ -721,6 +723,7 @@ files:
 - lib/kubes/logging.rb
 - lib/kubes/plugin.rb
 - lib/kubes/util/consider.rb
+- lib/kubes/util/pretty.rb
 - lib/kubes/util/sh.rb
 - lib/kubes/util/sure.rb
 - lib/kubes/util/time.rb