kubes 0.8.2 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f66db42d33089c27d90ea7daa749ae0e2b8298a06d5bd5a554c7bc2936a6734f
-  data.tar.gz: bde5c65bfb606523754dd653c1067a2ed99ccf94c7c88ce496df2409d5581fd6
+  metadata.gz: f84754c7f4ac3bb6b4cf9265e9a1996790e16f1a0d559c84a2b12bfd389a08c8
+  data.tar.gz: 952b720a88afa528925d0fe4f910b211d7891d930903ae36e8e7e35b69eec003
 SHA512:
-  metadata.gz: 940b22e57b741854513e1cee3367648189267ee34d1bd9ad4e0e07687ccc8d9d49f25b24977e43209e31af3967f7a7d47f251f5a0812b52d02f2a2cc64ad03c4
-  data.tar.gz: 89a6be8317b8e1a0aa49158f54376504d7f914ae4f8d2fd22845df23d1fb7cee1574d1ac6ef9416d14d3a793908b1d30ed8b624300cf6722512f8d46987f3b58
+  metadata.gz: c706ad8181772d2c7dbcee9de65d96548068de2840641786c58bc7fdfa1bbe6b1173dc8ec787ad42ef60d02bcce5f6ebc3f56d60549087c72d6f17a9a8cdbb34
+  data.tar.gz: 4282f36a11382932f19f355c1e9c9f286c191f9486f37de9328719f8ae8b3636f2266751f65c896fd31018396ddadc00803b6b064d83836c9023c751539575a3

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.8.6] - 2022-02-16
+- [#62](https://github.com/boltops-tools/kubes/pull/62) config map files: add Kubes.app txt layer
+
+## [0.8.5] - 2022-02-16
+- [#61](https://github.com/boltops-tools/kubes/pull/61) add erb support for config_map_files and generic_secret_data helpers
+
+## [0.8.4] - 2022-02-16
+- bump kubes_aws and kubes_google dependencies
+
+## [0.8.3] - 2022-02-16
+- [#60](https://github.com/boltops-tools/kubes/pull/60) Config files
+
 ## [0.8.2] - 2022-02-07
 - improve gem dependency version specifiers
 

data/docs/_docs/helpers/aws/secret_data.md

@@ -0,0 +1,55 @@
+---
+title: AWS Secrets
+nav_text: Secrets Data
+categories: helpers-aws
+---
+
+The `aws_secret_data` helper fetches secret data that is designed to be in one single file from AWS Secrets.
+
+## Example
+
+For example if you have these secret values stored as one file with multiple values separated by `=`.
+
+    $ aws secretsmanager get-secret-value --secret-id demo-dev-secret-data | jq '.SecretString'
+    KEY1=secretvalue1
+    KEY2=secretvalue2
+
+Kubes can fetch the secret data and base64 encode the values properly.  Example:
+
+.kubes/resources/shared/secret.yaml
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+<%= aws_secret_data("demo-dev-secret-data") %>
+```
+
+Notice how the text is idented properly by 2 spaces and the values are automatically base64 encoded.
+
+.kubes/output/shared/secret.yaml
+
+```yaml
+metadata:
+  namespace: demo
+  name: demo-2a78a13682
+  labels:
+    app: demo
+apiVersion: v1
+kind: Secret
+data:
+  KEY1: c2VjcmV0dmFsdWUx
+  KEY2: c2VjcmV0dmFsdWUy
+```
+
+## Options
+
+Here's an example of the available options for `aws_secret_data`.
+
+```ruby
+aws_secret_data("demo-#{Kubes.env}-secret-data", base64: true, ident: 2)
+```

data/docs/_docs/helpers/builtin/config-map-files.md

@@ -0,0 +1,64 @@
+---
+title: Config Map Files
+nav_text: Config Map Files
+---
+
+The `config_map_files` helper allows you to add config map data from a list of files. The files support layerying.
+
+## Example
+
+Here's how to use it.
+
+.kubes/resources/shared/config_map.yaml
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+<%= config_map_files %>
+```
+
+You can conveniently set multiple configmap values in files like so:
+
+.kubes/resources/shared/config_map/base.txt
+
+    KEY1=cmvalue1
+    KEY2=cmvalue2
+
+.kubes/resources/shared/config_map/dev.txt
+
+    KEY2=cmvalue2-dev-override
+    KEY3=cmvalue3
+
+The resulting generated ConfigMap will be:
+
+```yaml
+---
+metadata:
+  namespace: demo-dev
+  labels:
+    app: demo
+  name: demo-928146dd24
+apiVersion: v1
+kind: ConfigMap
+data:
+  KEY1: cmvalue1
+  KEY2: cmvalue2-dev-override
+  KEY3: cmvalue3
+```
+
+## Layering Details
+
+Layering for Config Map Files and also supports app-scoped layers.
+
+Name | Example
+--- | ---
+configmap root | .kubes/resources/shared/config_map/{base,dev}.txt
+configmap app file | .kubes/resources/shared/config_map/app1.txt
+configmap app folder | .kubes/resources/shared/config_map/app1/{base,dev}.txt
+
+So if `KUBES_APP=app1`, then the app-scoped layer is also used. This handles the [Central Deployer Pattern]({% link _docs/patterns/central-deployer.md %}).

data/docs/_docs/helpers/builtin.md

@@ -0,0 +1,16 @@
+---
+title: Core Built-In Helpers
+---
+
+Kubes provides some helper methods to help write Kubernetes YAML files.  Here's a list of the helper methods. These are available whether you write your resources in YAML or DSL.
+
+Helper | Description
+--- | ---
+decode64 | Base64 decode a string.
+docker_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource. Note, this can be overridden with the `--image` cli option or the `Kubes.config.image` setting. See: [Docker Image]({% link _docs/intro/docker-image.md %})
+dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
+encode64 | Base64 encode a string. Also available as `base64` method.
+extra | The `KUBES_EXTRA` value.
+with_extra | Appends the `KUBES_EXTRA` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
+
+Here's also the source code with most of the helpers: [helpers.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/shared/helpers.rb).

data/docs/_docs/helpers/google/secret_data.md

@@ -0,0 +1,55 @@
+---
+title: Google Secrets
+nav_text: Secrets Data
+categories: helpers-google
+---
+
+The `google_secret_data` helper fetches secret data that is designed to be in one single file from Google Secrets.
+
+## Example
+
+For example if you have these secret values stored as one file with multiple values separated by `=`.
+
+    $ gcloud secrets versions access latest --secret demo-dev-secret-data
+    KEY1=secretvalue1
+    KEY2=secretvalue2
+
+Kubes can fetch the secret data and base64 encode the values properly.  Example:
+
+.kubes/resources/shared/secret.yaml
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+<%= google_secret_data("demo-dev-secret-data") %>
+```
+
+Notice how the text is idented properly by 2 spaces and the values are automatically base64 encoded.
+
+.kubes/output/shared/secret.yaml
+
+```yaml
+metadata:
+  namespace: demo
+  name: demo-2a78a13682
+  labels:
+    app: demo
+apiVersion: v1
+kind: Secret
+data:
+  KEY1: c2VjcmV0dmFsdWUx
+  KEY2: c2VjcmV0dmFsdWUy
+```
+
+## Options
+
+Here's an example of the available options for `google_secret_data`.
+
+```ruby
+google_secret_data("demo-#{Kubes.env}-secret-data", base64: true, ident: 2)
+```

data/docs/_docs/helpers.md

@@ -2,18 +2,9 @@
 title: Helpers
 ---
 
-Kubes provides some helper methods to help write Kubernetes YAML files.  Here's a list of the helper methods. These are available whether you write your resources in YAML or DSL.
-
-Helper | Description
---- | ---
-decode64 | Base64 decode a string.
-docker_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource. Note, this can be overridden with the `--image` cli option or the `Kubes.config.image` setting. See: [Docker Image]({% link _docs/intro/docker-image.md %})
-dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
-encode64 | Base64 encode a string. Also available as `base64` method.
-extra | The `KUBES_EXTRA` value.
-with_extra | Appends the `KUBES_EXTRA` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
-
-Here's also the source code with most of the helpers: [helpers.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/shared/helpers.rb).
+## Built-In Helpers
+
+Kubes provides core helper methods to help write Kubernetes YAML files. Docs: [Built-In Helpers]({% link _docs/helpers/builtin.md %}).
 
 ## DSL Specific Methods
 

data/docs/_includes/sidebar.html

@@ -153,7 +153,11 @@
       </li>
       <li><a href="{% link _docs/helpers.md %}">Helpers</a>
         <ul>
-          <li><a href="{% link _docs/helpers/custom.md %}">Custom</a></li>
+          <li><a href="{% link _docs/helpers/builtin.md %}">Built-In</a>
+            <ul>
+              <li><a href="{% link _docs/helpers/builtin/config-map-files.md %}">Config Map Files</a>
+            </ul>
+          </li>
           <li><a href="{% link _docs/helpers/aws.md %}">AWS</a>
             <ul>
               {% assign docs = site.docs | where: "categories","helpers-aws" %}
@@ -192,6 +196,7 @@
               {% endfor %}
             </ul>
           </li>
+          <li><a href="{% link _docs/helpers/custom.md %}">Custom</a></li>
         </ul>
       </li>
       <li><a href="{% link _docs/patterns.md %}">Patterns</a>

data/kubes.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core helper libs
-  spec.add_dependency "kubes_aws", ">= 0.3.1"
-  spec.add_dependency "kubes_google", ">= 0.3.8"
+  spec.add_dependency "kubes_aws", ">= 0.3.2"
+  spec.add_dependency "kubes_google", ">= 0.3.9"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/kubes/compiler/shared/helpers/config_map_helper.rb

@@ -0,0 +1,37 @@
+module Kubes::Compiler::Shared::Helpers
+  module ConfigMapHelper
+    def config_map_files(options={})
+      indent = options[:indent] || 2
+
+      shared_config_map = "#{Kubes.root}/.kubes/resources/shared/config_map"
+      layers = [
+        [shared_config_map, "base.txt"],
+        [shared_config_map, "#{Kubes.env}.txt"],
+      ]
+      if Kubes.app
+        layers += [
+          [shared_config_map, "#{Kubes.app}.txt"],
+          [shared_config_map, Kubes.app, "base.txt"],
+          [shared_config_map, Kubes.app, "#{Kubes.env}.txt"],
+        ]
+      end
+      layers.map! { |layer| layer.compact.join('/') }
+      data = {}
+      layers.each do |path|
+        next unless File.exist?(path)
+        text = RenderMePretty.result(path, context: self)
+        lines = text.split("\n")
+        lines.each do |line|
+          key, value = parse_env_like_line(line)
+          data[key] = value
+        end
+      end
+
+      spacing = " " * indent
+      lines = data.map do |key,value|
+        "#{spacing}#{key}: #{value}"
+      end
+      lines.join("\n")
+    end
+  end
+end

data/lib/kubes/compiler/shared/helpers/docker_helper.rb

@@ -0,0 +1,23 @@
+module Kubes::Compiler::Shared::Helpers
+  module DockerHelper
+    def docker_image
+      return @options[:image] if @options[:image] # override
+      return Kubes.config.image if Kubes.config.image
+      built_image_helper
+    end
+
+    def built_image
+      Deprecated.new.built_image
+      built_image_helper
+    end
+
+    def built_image_helper
+      path = Kubes.config.state.path
+      unless File.exist?(path)
+        raise Kubes::MissingDockerImage.new("Missing file with docker image built by kubes: #{path}. Try first running: kubes docker build")
+      end
+      data = JSON.load(IO.read(path))
+      data['image']
+    end
+  end
+end

data/lib/kubes/compiler/shared/helpers/extra_helper.rb

@@ -0,0 +1,12 @@
+module Kubes::Compiler::Shared::Helpers
+  module ExtraHelper
+    def with_extra(value)
+      [value, extra].compact.join('-')
+    end
+
+    def extra
+      extra = ENV['KUBES_EXTRA']
+      extra&.strip&.empty? ? nil : extra # if blank string then also return nil
+    end
+  end
+end

data/lib/kubes/compiler/shared/helpers/secret_helper.rb

@@ -0,0 +1,45 @@
+module Kubes::Compiler::Shared::Helpers
+  module SecretHelper
+    # Meant to be used by plugins. IE:
+    # google_secret_data and aws_secret_data
+    def generic_secret_data(plugin_secret_method, name, options={})
+      indent = options[:indent] || 2
+      base64 = options[:base64].nil? ? true : options[:base64]
+
+      text = send(plugin_secret_method, name, base64: false)
+      path = create_generic_secret_data_temp_file(text)
+      text = RenderMePretty.result(path, context: self)
+      spacing = " " * indent
+      lines = text.split("\n")
+      new_lines = lines.map do |line|
+        key, value = parse_env_like_line(line)
+        value = encode64(value) if base64
+        "#{spacing}#{key}: #{value}"
+      end
+      new_lines.join("\n")
+    end
+
+    def parse_env_like_line(line)
+      key, *rest = line.split('=')
+      value = rest.join('=')
+      [key, value]
+    end
+
+    def encode64(v)
+      Base64.strict_encode64(v.to_s).strip
+    end
+    alias_method :base64, :encode64
+
+    def decode64(v)
+      Base64.strict_decode64(v)
+    end
+
+  private
+    def create_generic_secret_data_temp_file(text)
+      path = "/tmp/kubes/text.erb"
+      FileUtils.mkdir_p(File.dirname(path))
+      IO.write(path, text)
+      path
+    end
+  end
+end

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

@@ -6,42 +6,9 @@ module Kubes::Compiler::Shared
     extend Kubes::Compiler::Dsl::Core::Fields
     fields "name"
 
-    def docker_image
-      return @options[:image] if @options[:image] # override
-      return Kubes.config.image if Kubes.config.image
-      built_image_helper
-    end
-
-    def built_image
-      Deprecated.new.built_image
-      built_image_helper
-    end
-
-    def built_image_helper
-      path = Kubes.config.state.path
-      unless File.exist?(path)
-        raise Kubes::MissingDockerImage.new("Missing file with docker image built by kubes: #{path}. Try first running: kubes docker build")
-      end
-      data = JSON.load(IO.read(path))
-      data['image']
-    end
-
-    def with_extra(value)
-      [value, extra].compact.join('-')
-    end
-
-    def extra
-      extra = ENV['KUBES_EXTRA']
-      extra&.strip&.empty? ? nil : extra # if blank string then also return nil
-    end
-
-    def encode64(v)
-      Base64.strict_encode64(v.to_s).strip
-    end
-    alias_method :base64, :encode64
-
-    def decode64(v)
-      Base64.strict_decode64(v)
-    end
+    include ConfigMapHelper
+    include DockerHelper
+    include ExtraHelper
+    include SecretHelper
   end
 end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.8.2"
+  VERSION = "0.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: kubes_google
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -334,13 +334,17 @@ files:
 - docs/_docs/helpers/aws/advanced/secrets.md
 - docs/_docs/helpers/aws/advanced/ssm.md
 - docs/_docs/helpers/aws/iam-role.md
+- docs/_docs/helpers/aws/secret_data.md
 - docs/_docs/helpers/aws/secrets.md
 - docs/_docs/helpers/aws/ssm.md
+- docs/_docs/helpers/builtin.md
+- docs/_docs/helpers/builtin/config-map-files.md
 - docs/_docs/helpers/custom.md
 - docs/_docs/helpers/google.md
 - docs/_docs/helpers/google/advanced.md
 - docs/_docs/helpers/google/advanced/secrets.md
 - docs/_docs/helpers/google/gke.md
+- docs/_docs/helpers/google/secret_data.md
 - docs/_docs/helpers/google/secrets.md
 - docs/_docs/helpers/google/service-account.md
 - docs/_docs/install.md
@@ -665,7 +669,11 @@ files:
 - lib/kubes/compiler/dsl/syntax/service_account.rb
 - lib/kubes/compiler/layering.rb
 - lib/kubes/compiler/shared/helpers.rb
+- lib/kubes/compiler/shared/helpers/config_map_helper.rb
 - lib/kubes/compiler/shared/helpers/deprecated.rb
+- lib/kubes/compiler/shared/helpers/docker_helper.rb
+- lib/kubes/compiler/shared/helpers/extra_helper.rb
+- lib/kubes/compiler/shared/helpers/secret_helper.rb
 - lib/kubes/compiler/shared/runtime_helpers.rb
 - lib/kubes/compiler/strategy.rb
 - lib/kubes/compiler/strategy/base.rb