kubes 0.8.9 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1089172c4489c77f34abd1cc5df408e11467950f40ae67ee062377f078c131d1
-  data.tar.gz: 1c29e074651e78963aa1fbc83314e49b6da006c7902056c2ef108dd91302b8a7
+  metadata.gz: 306b63f7f97138b489a5877a2726499b8329c805787e282f1e856ad76226ebec
+  data.tar.gz: 1943fd0f6e702d8bf285ba201d89da359f8425988a542a408f6635b70e57d3c7
 SHA512:
-  metadata.gz: ac9080b9f30461b48d4d4fbf5e6a9ca6be2a53385a0cde1b649e6da26c265ddb7adb7f3c66714ad179ebac3f3ae3ebd9ea112bc5a0f5e65beab7d51d30f9574d
-  data.tar.gz: c6424d462ba9c7b834fcf1944fd75275ae6fa8b6abf7ea7b29fa9575fa6f5ae0853529ca10b32e1eeff11ac094e2ee920008c326936e2c1bd5e153cb8dc3f915
+  metadata.gz: 32d2554b904d987cf40271cf1f924fc8c5aae7c309395c70bd0cef6ccd2b88fee401e34ad3b9f99f4c10056530b456be0713e740bb58972775b5e9e957b5e2c8
+  data.tar.gz: 7deec002773c177e201d5b8712a350cf087349260ecbc8945292325c76df4e9c4382be8ba9070a23493838c752281b204650538dcd71d0b71c8a6214496e7f63

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.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

data/docs/_docs/layering/debugging.md

@@ -0,0 +1,62 @@
+---
+title: "Debugging Layering"
+category: layering
+order: 9
+---
+
+Kube's Layering abilities are so powerful that they can be difficult to debug when overly used.  It is recommend 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

@@ -1,5 +1,7 @@
 ---
 title: Extra Layering
+category: layering
+order: 8
 ---
 
 Setting KUBES_EXTRA will process extra layers.

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,8 +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 %})
-* [Extra Layering]({% link _docs/layering/extra.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,12 +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>
-          <li><a href="{% link _docs/layering/extra.md %}">Extra Layering</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
@@ -72,6 +73,10 @@ module Kubes::Compiler::Shared
         "#{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|
@@ -82,8 +87,23 @@ module Kubes::Compiler::Shared
 
       layers.each do |layer|
         path = "#{Kubes.root}/.kubes/variables/#{layer}"
+        show_variable_layer_path(path)
         evaluate_file(path)
       end
     end
+
+    @@shown = {}
+    def show_variable_layer_path(path)
+      # Examples:
+      #   .kubes/resources/web/deployment.yaml
+      #   .kubes/resources/shared/namespace.yaml
+      main_path = @path # main path is main resource file
+      show_once = !@@shown.dig(main_path, path)
+      if ENV['KUBES_LAYERING_SHOW_ALL'] || (Kubes.config.layering.show && show_once && File.exist?(path))
+        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
+      logger.info "Compiling #{pretty_path(@path)}" if Kubes.config.layering.show
       result = render(@path) # main
       results = [result].flatten # ensure array
       data = results.map! do |main|
@@ -16,6 +17,7 @@ class Kubes::Compiler::Strategy
         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_ALL']
         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/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.8.9"
+  VERSION = "0.8.10"
 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.9
+  version: 0.8.10
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -367,6 +367,7 @@ files:
 - docs/_docs/intro/ordering/custom.md
 - docs/_docs/intro/structure.md
 - docs/_docs/layering.md
+- docs/_docs/layering/debugging.md
 - docs/_docs/layering/dsl.md
 - docs/_docs/layering/extra.md
 - docs/_docs/layering/merge-dsl.md
@@ -722,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