kubes 0.8.0 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242d998c0a7f9c86c4db5d79eef556f3d5cac56d7131eedfd9c14b9b96975ef6
-  data.tar.gz: f38ef641ff71c45c84335723b3f0b67abe2a3d26132a8a407738391724a4acf7
+  metadata.gz: f78e6b8aa9788c03dbc38391b936a5792353249c5d9e743d7ebf87fc52c74488
+  data.tar.gz: a77d273302faaf434f751f36305cfafc9e7e5e7491db010f1468088d4806f8b7
 SHA512:
-  metadata.gz: 345a9b9bbf12abd164e7aaec68be929cb7d8d61a6f05334a749e987722e2992f828f322a77e6c31a904fa716f984943bd6d638a19830efdfbaa24e0969ab0e80
-  data.tar.gz: 47dc50264262dd94fd085426f99f1e138e61c0362a77c11a087bd9b3a99829897a30aadf52bde6603260386f606059326dbc6cb90bf15c51a5f51755dc6a88ba
+  metadata.gz: 1241bd270d3212d96a04b5e1edbd1085efee439105fff63896ec2b06dc84520e02ffbe7fd0830db246979c201c279c63adfcd41332e809cfbc3997b205a0459b
+  data.tar.gz: 6382b7380c842621e54f388e7d66fcf981e407a3952928996148be0037d0321e14779ea79a016991c0b5d0b0c5c02dccfe9de3ef77a62295a62fe549fa2a335c

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.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
+
+## [0.8.1] - 2022-02-06
+- allow --version command to run outside project
+
 ## [0.8.0] - 2022-02-06
 - [#58](https://github.com/boltops-tools/kubes/pull/58) standalone install docs
 - [#59](https://github.com/boltops-tools/kubes/pull/59) central deployer support

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 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,63 @@
+---
+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-scoped | .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 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/_docs/install/gem/custom-version.md

@@ -0,0 +1,70 @@
+---
+title: How to Use Custom Version of Kubes
+nav_text: Custom Version
+category: gem
+order: 1
+---
+
+If you want or need to run a forked version of kubes, here's how:
+
+## Change Version Number
+
+First, clone down the source and change version number so you can identify that it's a custom version.  Clone down the project:
+
+    $ git clone https://github.com/boltops-tools/kubes
+
+Update [lib/kubes/version.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/version.rb) so you'll be able to tell that it's a custom build.  For example:
+
+```ruby
+module kubes
+  VERSION = "0.8.2.custom"
+end
+```
+
+There are 2 ways to use the custom version:
+
+1. Gemfile: Forked Git Source
+2. Gem Package: Build and Install
+
+## Gemfile: Forked Git Source
+
+Point `kubes ` to use your repo with the forked version.  Example:
+
+Gemfile:
+
+```ruby
+source "https://rubygems.org"
+gem 'kubes', git: 'https://github.com/REPO/kubes', branch: "master"
+```
+
+Remember to change `REPO`, to your repo name.
+
+Then run:
+
+    bundle
+
+## Gem Package: Build and Install
+
+Build the gem package:
+
+    $ bundle
+    $ rake build
+    pkg/kubes-0.8.2.custom.gem
+
+The produced `.gem` file can used to install the gem. You can install it locally:
+
+    $ gem install pkg/kubes-0.8.2.custom.gem
+    $ kubes -v
+    0.8.2.custom
+
+Or on any machine with Ruby installed. You can copy it to the machine, ssh into it, and install the custom gem:
+
+    $ scp pkg/kubes-0.8.2.custom.gem user@server.com:
+    $ ssh user@server.com
+    $ gem install kubes-0.8.2.custom.gem
+    $ kubes -v
+    0.8.2.custom
+
+## Contributing
+
+Learning how to run a forked version of kubes allows you to make changes to the tool. Consider improving kubes by submitting a Pull Request. See: [Contributing]({% link _docs/contributing.md %}).

data/docs/_docs/patterns/central-deployer.md

@@ -7,18 +7,18 @@ categories: patterns
 Kubes can be use as either an app-centric or ops-centric tool.
 
 * **app-centric**: Each app repo has it's own `.kubes` settings files. This is useful if your applications are very differently setup.
-* **ops-centric**: Each app repo has pretty much the same `.kubes` settings files. This is useful if your applications are very similarly setup.
+* **ops-centric**: Each app repo has pretty much the same `.kubes` settings files. This is useful if your applications are very similarly set up.
 
 ## Setup
 
 With an ops-centric approach, you use the same `.kubes` settings files for the app repos you want to use. For example:
 
-    https://github.com/repo/app1
-    https://github.com/repo/app2
+    https://github.com/org/app1
+    https://github.com/org/app2
 
 You then also have a
 
-    https://github.com/repo/.kubes
+    https://github.com/org/.kubes
 
 You can simply copy the `.kubes` folder into the app repo folder or even add the `repo/.kubes` as a submodule.
 
@@ -31,6 +31,8 @@ Then to deploy different app level settings.
 
 {% include config/app-overrides-cheatsheet.md %}
 
+Also check out: [App Overrides Docs]({% link _docs/config/app-overrides.md %}).
+
 The central deployer approach is removes duplication of the kubes config files between projects. Leveraging app-level overrides gives provides a great degree of control.
 
 If the settings start to diverge too much, then it probably makes sense to use separate .kubes files in that app specific repo.

data/docs/_docs/yaml/erb-comment.md

@@ -30,7 +30,7 @@ spec:
   type: ClusterIP
 ```
 
-This allows IDB kubernetes autocompletion plugins and tools to work because the `.kubes/resources/web/service.yaml` source code itself is perfectly valid YAML.
+This allows IDE kubernetes autocompletion plugins and tools to work because the `.kubes/resources/web/service.yaml` source code itself is perfectly valid YAML.
 
 The `#ERB` comments are essentially replaced by `<% ... %>` tags before ERB processing happens. Example:
 

data/docs/_includes/sidebar.html

@@ -54,7 +54,11 @@
       </li>
       <li><a href="{% link _docs/install.md %}">Install</a>
         <ul>
-          <li><a href="{% link _docs/install/gem.md %}">Gem</a></li>
+          <li><a href="{% link _docs/install/gem.md %}">Gem</a>
+            <ul>
+              <li><a href="{% link _docs/install/gem/custom-version.md %}">Custom Version</a></li>
+            </ul>
+          </li>
           <li><a href="{% link _docs/install/standalone.md %}">Standalone</a>
             <ul>
               {% assign docs = site.docs | where: "categories","standalone" | sort:"order" %}
@@ -149,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" %}
@@ -188,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>
@@ -235,7 +244,7 @@
     <h2>sidebar options:</h2>
     <ul class="list-unstyled">
       <li><a href="#" id="expand-all">expand all</a></li>
-      <li><a href="{{ site.gh_url }}/blob/master/docs/{{ page.path }}" target="_blank">edit page</a></li>
+      <li><a href="{{ site.gh_url }}/blob/master/docs/" id="edit-page" target="_blank">edit page</a></li>
     </ul>
   </div>
 </div>

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.5"
+  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/command.rb

@@ -58,7 +58,7 @@ module Kubes
 
       def check_project!(command_name)
         return if command_name.nil?
-        return if %w[-h -v completion completion_script help init new version].include?(command_name)
+        return if %w[-h -v --version completion completion_script help init new version].include?(command_name)
         Kubes.check_project!
       end
 

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

@@ -0,0 +1,35 @@
+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, "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)
+        lines = IO.readlines(path)
+        lines.each do |line|
+          key, value = line.split('=').map(&:strip)
+          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,29 @@
+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]
+
+      full_data = send(plugin_secret_method, name, base64: false)
+      spacing = " " * indent
+      lines = full_data.split("\n")
+      new_lines = lines.map do |line|
+        key, value = line.split('=')
+        value = encode64(value) if base64
+        "#{spacing}#{key}: #{value}"
+      end
+      new_lines.join("\n")
+    end
+
+    def encode64(v)
+      Base64.strict_encode64(v.to_s).strip
+    end
+    alias_method :base64, :encode64
+
+    def decode64(v)
+      Base64.strict_decode64(v)
+    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.0"
+  VERSION = "0.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -154,30 +154,30 @@ dependencies:
   name: kubes_aws
   requirement: !ruby/object:Gem::Requirement
     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.5
+        version: 0.3.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 0.3.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -334,18 +334,23 @@ 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
 - docs/_docs/install/dependencies.md
 - docs/_docs/install/gem.md
+- docs/_docs/install/gem/custom-version.md
 - docs/_docs/install/standalone.md
 - docs/_docs/install/standalone/centos.md
 - docs/_docs/install/standalone/details.md
@@ -664,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