kubes 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73d57fba41a00e9ace349a4b3d9da7815e52a5025fcda97b64cfc185797ba35
-  data.tar.gz: a6114d33d48893ed2f748b0720aaf7dca8f71a75b4b3e3f4ae3f690680b35f26
+  metadata.gz: 4f8112935cf2c796869c81fb0ede6a5b6b9589ba5daf981aab7ca2a806217e4c
+  data.tar.gz: d84869a02096b266edc9e0c51ea2ec344f97f96afb0ce1dcc74d80ef71cb7567
 SHA512:
-  metadata.gz: e28f97ff9b675adbce4066afbbde6fa4c853f2172e430659db25b8865409d5fb19aace0a464c809a95ddee6152e8f389cd9e43c6dc9696c9297fd2b8465c5c77
-  data.tar.gz: 42c6780d303119bb42d65075043bcaaf38fd1eec20a8b4448695a598ae22e7ab1b28f6d3920116c7cd9c76630be4d332871833f194383e1c05537ac3bab00a73
+  metadata.gz: 11e5302088c91d06c41c3f1b3c6774b2361d7a1537d9e9c609152b2de215b35d0dd1f792d54788a557a6d39dcc3816aa7caaa1191c888aed135b2290d72d6355
+  data.tar.gz: 0a47dee57d4ccb4ccd1e9877830328d60ba1a0a49b2d3592a7994f63cbe01cb84ee29ca646d057662a1dba0fafb94bc61c0a4ee84547ed951942d9c35cecf2ed

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.7.7] - 2021-10-21
+- [#51](https://github.com/boltops-tools/kubes/pull/51) add hash checksum for tls secretName
+- [#52](https://github.com/boltops-tools/kubes/pull/52) add role all layer to pre_layers
+- [#53](https://github.com/boltops-tools/kubes/pull/53) Merger options
+
 ## [0.7.6] - 2021-10-12
 - remove init yaml templates, removed duplication
 - write full.yaml to .kubes/tmp instead

data/docs/_docs/config/reference.md

@@ -20,3 +20,4 @@ repo_auto_auth | Whether or not to try to auth authorize docker repo registry if
 skip | List of resources to skip. Can also be set with the `KUBES_SKIP` env var. `KUBES_SKIP` should be a list of strings separated by spaces. It adds onto the `config.skip` option. | []
 state.path | Where to store the state file with the last build Docker image. | .kubes/state/KUBES_ENV/data.json
 suffix_hash | Whether or not to append suffix hash to ConfigMap and Secret | true
+merger.options | Merger options that control how Hashes are merged. More info: [Merger Options]({% link _docs/layering/merge-options.md %}) | `{overwrite_arrays: true}`

data/docs/_docs/dsl.md

@@ -63,4 +63,4 @@ In general:
 
 ## Merge Behavior
 
-Generally, the merge should behave as expected. For example, map or Hash fields are merged together from multiple layers. Strings are simply replaced. See more details at [Layering Merge Behavior]({% link _docs/layering/merge.md %})
+Generally, the merge should behave as expected. For example, map or Hash fields are merged together from multiple layers. Strings are simply replaced. See more details at [Layering Merge Behavior]({% link _docs/layering/merge-dsl.md %})

data/docs/_docs/intro/structure.md

@@ -34,10 +34,10 @@ Here's what a .kubes folder structure can look like this:
 
 Name | Description
 --- | ---
-base | The base folder is processed first and can be used to define common fields and resources. Learn more on the [Layering Docs]({% link _docs/layering.md %}).
 config | The config folder can be used to configure behavior of Kubes.  The [docker]({% link _docs/config/docker.md %}) config is used to customize the docker command. The [env]({% link _docs/config/env.md %}) config is used to override `config.rb` settings on a `KUBES_ENV` basis. The [kubectl]({% link _docs/config/kubectl.md %}) config is used to customize the kubectl command.
 config.rb | The main thing to configure here is the repo to push the docker image to.
 output | Where kubes builds and writes the Kubernetes YAML to.
 resources | Where you define your Kubernetes resources.
-shared | The shared folder is where you can put shared resources. This folder gets applied first. More info: [Ordering]({% link _docs/intro/ordering.md %}).
+resources/base | The base folder is processed first and can be used to define common fields and resources. Learn more on the [Layering Docs]({% link _docs/layering.md %}).
+resources/shared | The shared folder is where you can put shared resources. This folder gets applied first. More info: [Ordering]({% link _docs/intro/ordering.md %}).
 state | Temporary state info that stores the built Docker image name.

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

@@ -0,0 +1,76 @@
+---
+title: Merge Options
+---
+
+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 %}).
+
+The default merge options is:
+
+    {overwrite_arrays: true}
+
+You can control the merge behavior by setting:
+
+.kubes/config.rb
+
+```ruby
+Kubes.configure do |config|
+  # ...
+  config.merger.options = {overwrite_arrays: false}
+end
+```
+
+See the [danielsdeleo/deep_merge](https://github.com/danielsdeleo/deep_merge) docs for the different options.
+
+## Example of overwrite_arrays false
+
+An example of where you might want to use `{overwrite_arrays: false}` is if you are using YAML and want a base sidecar container in all of your deployments.
+
+.kubes/resources/base/deployment.yaml
+
+```yaml
+spec:
+  template:
+    spec:
+      containers:
+      - name: sidecar
+        image: sidecar-image
+```
+
+.kubes/resources/web/deployment.yaml
+
+```yaml
+spec:
+  template:
+    metadata:
+      labels:
+        role: web
+    spec:
+      containers:
+      - name: web
+        image: <%= docker_image %>
+```
+
+Produces:
+
+```yaml
+# ...
+spec:
+  template:
+    metadata:
+      labels:
+        role: web
+    spec:
+      containers:
+      - name: sidecar
+        image: sidecar-image
+      - name: web
+        image: gcr.io/boltops-learn/demo:kubes-2021-10-21T18-06-48
+# ...
+```
+
+However, using this merge behavior will also add additional ports if you are assigning a `targetPort` in the DSL. See:
+
+* [DSL in service creates always default port 80 #45](https://github.com/boltops-tools/kubes/issues/45)
+* [use deep_merge overwrite_arrays option #48](https://github.com/boltops-tools/kubes/pull/48)
+
+Will welcome PRs for improvements.

data/docs/_docs/layering.md

@@ -7,4 +7,4 @@ Kubes supports layering files together so you can use the same Kubernetes files
 * [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.md %})
+* [Merge Behavior]({% link _docs/layering/merge-dsl.md %})

data/docs/_includes/layering/layers.md

@@ -11,6 +11,7 @@ Here's an example structure, so we can understand how layering works.
     ├── clock
     │   └── deployment.{{ include.ext }}
     └── web
+        ├── all.{{ include.ext }}
         ├── deployment
         │   ├── dev.{{ include.ext }}
         │   └── prod.{{ include.ext }}
@@ -34,16 +35,17 @@ Notes
 
 Here's a table showing the the full layering.
 
-Folder/Pattern     | Example
--------------------|--------------------------------------------
-base/all.{{ include.ext }}       | base/all.{{ include.ext }}
-base/all/ENV.{{ include.ext }}   | base/all/dev.{{ include.ext }}
-base/KIND.{{ include.ext }}      | base/deployment.{{ include.ext }}
-base/KIND/base.{{ include.ext }} | base/deployment/base.{{ include.ext }}
-base/KIND/ENV.{{ include.ext }}  | base/deployment/dev.{{ include.ext }}
-ROLE/KIND.{{ include.ext }}      | web/deployment.{{ include.ext }}
-ROLE/KIND/base.{{ include.ext }} | web/deployment/base.{{ include.ext }}
-ROLE/KIND/ENV.{{ include.ext }}  | web/deployment/dev.{{ include.ext }}
+Type | Folder/Pattern | Example
+---|---|---
+pre | base/all.{{ include.ext }}        | base/all.{{ include.ext }}
+pre | base/all/ENV.{{ include.ext }}    | base/all/dev.{{ include.ext }}
+pre | base/KIND.{{ include.ext }}       | base/deployment.{{ include.ext }}
+pre | base/KIND/base.{{ include.ext }}  | base/deployment/base.{{ include.ext }}
+pre | base/KIND/ENV.{{ include.ext }}   | base/deployment/dev.{{ include.ext }}
+pre | ROLE/all.{{ include.ext }}        | web/all.{{ include.ext }}
+main | ROLE/KIND.{{ include.ext }}      | web/deployment.{{ include.ext }}
+post | ROLE/KIND/base.{{ include.ext }} | web/deployment/base.{{ include.ext }}
+post | ROLE/KIND/ENV.{{ include.ext }}  | web/deployment/dev.{{ include.ext }}
 
 ## Real-World Uses
 

data/docs/_includes/sidebar.html

@@ -97,7 +97,8 @@
           <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.md %}">Merge Behavior</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>
         </ul>
       </li>
       <li><a href="{% link _docs/dsl.md %}">DSL</a>

data/lib/kubes/compiler/decorator/hashable/field.rb

@@ -47,6 +47,7 @@ class Kubes::Compiler::Decorator::Hashable
         'secretRef' => 'name',
         'secretKeyRef' => 'name',
         'secret' => 'secretName',
+        'tls' => 'secretName',
       }
     end
   end

data/lib/kubes/compiler/layering.rb

@@ -6,29 +6,21 @@ class Kubes::Compiler
       ext = File.extname(@path)
       kind = File.basename(@path).sub(ext,'') # IE: deployment
       kind = kind.pluralize if @block_form
+      role = @path.split('/')[-2] # .kubes/resources/web/deployment.yaml
       layers = [
-        "all",
-        "all/#{Kubes.env}",
-        "#{kind}",
-        "#{kind}/#{Kubes.env}",
+        "base/all",
+        "base/all/#{Kubes.env}",
+        "base/#{kind}",
+        "base/#{kind}/#{Kubes.env}",
+        "#{role}/all",
       ]
       layers = add_exts(layers)
       layers.map! do |layer|
-        "#{Kubes.root}/.kubes/resources/base/#{layer}"
+        "#{Kubes.root}/.kubes/resources/#{layer}"
       end
       layers.select { |layer| File.exist?(layer) }
     end
 
-    def add_exts(layers)
-      layers.map do |layer|
-        [
-          "#{layer}.rb",
-          "#{layer}.yaml",
-          "#{layer}.yml",
-        ]
-      end.flatten
-    end
-
     def post_layers
       return [] if Kubes.kustomize?
 
@@ -45,5 +37,15 @@ class Kubes::Compiler
       end
       layers.select { |layer| File.exist?(layer) }
     end
+
+    def add_exts(*layers)
+      layers.flatten.map do |layer|
+        [
+          "#{layer}.rb",
+          "#{layer}.yaml",
+          "#{layer}.yml",
+        ]
+      end.flatten
+    end
   end
 end

data/lib/kubes/config.rb

@@ -43,6 +43,9 @@ module Kubes
 
       config.suffix_hash = true # append suffix hash to ConfigMap and Secret
 
+      config.merger = ActiveSupport::OrderedOptions.new
+      config.merger.options = {overwrite_arrays: true}
+
       config
     end
 

data/lib/kubes/core.rb

@@ -37,7 +37,7 @@ module Kubes
 
     # wrapper to ensure we use the same deeper_merge options everywhere
     def deep_merge!(a, b)
-      a.deeper_merge!(b, overwrite_arrays: true)
+      a.deeper_merge!(b, config.merger.options)
       a
     end
   end

data/lib/kubes/util/consider.rb

@@ -3,8 +3,8 @@ module Kubes::Util
     def consider?(path)
       File.file?(path) &&
       !path.include?('/resources/base') &&
-      !path.include?('/base.yaml') &&
-      !path.include?('/base.yml')
+      !path.include?('/base.') &&
+      !path.include?('/all.')
     end
   end
 end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.7.6"
+  VERSION = "0.7.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -336,7 +336,8 @@ files:
 - docs/_docs/intro/structure.md
 - docs/_docs/layering.md
 - docs/_docs/layering/dsl.md
-- docs/_docs/layering/merge.md
+- docs/_docs/layering/merge-dsl.md
+- docs/_docs/layering/merge-options.md
 - docs/_docs/layering/mix.md
 - docs/_docs/layering/yaml.md
 - docs/_docs/learn/dsl.md