kubes 0.6.3 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0b62ecd7b432896bd1fbafc3aeae759f858bcbfb0f2ca9a02ecb60d91fcff3
-  data.tar.gz: 7faf78784573d6d1058fb3641e47356bf725c683cdfc53b081d8926bf2799249
+  metadata.gz: 18a7d3b8deec0ae4cd5d7e8ba2be00309e8fbfe1be70b063c452335c7278c96d
+  data.tar.gz: a0d70be2e034c42a7cc916f919f1de42cd50af7941dc7058875825d0d9cd95d9
 SHA512:
-  metadata.gz: b7d432057c49947c864594fb2049677b721ff084ccd60403a39e7e360aa2a05157fddef26593004a836eb130d39a2307c6443438861be119affe66a182a05380
-  data.tar.gz: 4a99ff9b1819db41ad13f1340707242a978c37cc83d7dbe8e10a6cf06cac9c3aa65335d9e6d8fc94a500cd267d3b197940d49ec71f76f4a4cb81c5ab71efff9f
+  metadata.gz: fd2109ea8ab7141bd2c58b4c95a11a352851cf6ff9cf6512aded1236bb58e4344372ba444ce6a21870654113e80f208ee2d9908c6a14f775c6abfee9eaa33c1f
+  data.tar.gz: 3215ffdb98eda928dd6bb4975e1b7f309db8a41ca70b6869a77df76cb828589753a8d1d54ad8c3d76195dbc925ee7ebb15337b07ac111c91eed78fedaf6a5080

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 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.6.8] - 2020-11-14
+- [#40](https://github.com/boltops-tools/kubes/pull/40) fix version check
+
+## [0.6.7] - 2020-11-12
+- dependencies version bump: kubes_google
+
+## [0.6.6] - 2020-11-12
+- dependencies version bump: kubes_aws and kubes_google
+
+## [0.6.5] - 2020-11-12
+- [#39](https://github.com/boltops-tools/kubes/pull/39) google secrets fetcher option
+
+## [0.6.4] - 2020-11-11
+- [#38](https://github.com/boltops-tools/kubes/pull/38) fix auto auth for docker login to registry, docs for secret base64, update dependencies
+
 ## [0.6.3] - 2020-11-11
 - [#37](https://github.com/boltops-tools/kubes/pull/37) Dockerfile for ci and hook updates
 

data/docs/_docs/helpers.md

@@ -26,16 +26,4 @@ There are also provider-specific helpers:
 * [AWS Helpers]({% link _docs/helpers/aws.md %})
 * [Google Helpers]({% link _docs/helpers/google.md %})
 
-## Generator
-
-To help you get started quickly, you can generate starter helper code.
-
-    $ kubes new helper custom
-          create  .kubes/helpers/custom_helper.rb
-
-.kubes/helpers/custom_helper.rb
-
-```ruby
-module CustomHelper
-end
-```
+{% include helpers/generator.md %}

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

@@ -45,11 +45,23 @@ data:
   USER: dGVzdDIK
 ```
 
-The values are automatically base64 encoded.
+By default, the values are automatically base64 encoded.
 
 ## Base64 Option
 
-The value is automatically base64 encoded. You can set the `base64` option to turn on and off the automated base64 encoding.
+By default, the values are automatically base64 encoded. You can change the default behavior with a config option.
+
+.kubes/config.rb
+
+```ruby
+KubesAws.configure do |config|
+  config.secrets.base64 = false
+end
+```
+
+Note: The use of `KubesAws.configure` instead of `Kubes.configure` here.
+
+You can also set the `base64` option to turn on and off the automated base64 encoding on a per secret basis.
 
 ```ruby
 aws_secret("demo-#{Kubes.env}-USER", base64: true)  # default is base64=true

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

@@ -44,11 +44,11 @@ data:
   USER: dGVzdDIK
 ```
 
-The values are automatically base64 encoded.
+The values are base64 encoded based on the SSM parameter type. When the type is a `SecureString`, Kubes base64 encodes it. Other types are not base64 encoded.  You can override this behavior with the base64 option, described next.
 
 ## Base64 Option
 
-The value is automatically base64 encoded. You can set the `base64` option to turn on and off the automated base64 encoding.
+The value is automatically base64 encoded based on whether or not the SSM parameter type is a `SecureString`. You can explicitly the `base64` option if needed though. Example:
 
 ```ruby
 aws_ssm("/demo/#{Kubes.env}/USER", base64: true)  # default is base64=true

data/docs/_docs/helpers/custom.md

@@ -38,3 +38,4 @@ data:
   DATABASE_ENDPOINT: <%= database_endpoint %>
 ```
 
+{% include helpers/generator.md %}

data/docs/_docs/helpers/google.md

@@ -4,7 +4,7 @@ title: Google Helpers
 
 List of Google helpers:
 
-{% assign docs = site.docs | where: "categories","helpers-aws" %}
+{% assign docs = site.docs | where: "categories","helpers-google" %}
 {% for doc in docs -%}
   * [{{ doc.nav_text }}]({{ doc.url }})
 {% endfor %}
@@ -14,4 +14,22 @@ List of Google helpers:
 * By default, `KubeGoogle.logger = Kubes.logger`. This means, you can set `logger.level = "debug"` in `.kubes/config.rb` to see more details.
 * The `gcloud` cli is used to create IAM roles. So `gcloud` is required.
 * Note: Would like to use the google sdk, but it wasn't obvious how to do so. PRs are welcomed.
-* The Google helpers are provided by the [boltops-tools/kubes_google](https://github.com/boltops-tools/kubes_google) library.
+* The Google helpers are provided by the [boltops-tools/kubes_google](https://github.com/boltops-tools/kubes_google) library.
+
+## Authentication
+
+Most of the Google helpers use the SDK to call the Google Cloud API. As such, it needs to be authenticated.  You can do this by setting the `GOOGLE_APPLICATION_CREDENTIALS` environment variable point to the path with a service account credentials file. IE:
+
+.bash_profile
+
+    export GOOGLE_APPLICATION_CREDENTIALS=~/.gcp/service-account.json
+
+If you would like to use a user IAM credentials instead of a service account. You can also run use [application-default login](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login). Example:
+
+    gcloud auth application-default login
+
+This generates an Application Default Credentials at `.config/gcloud/application_default_credentials.json`. Note, make sure that `GOOGLE_APPLICATION_CREDENTIALS` is not set or else the `application_default_credentials.json` will not be used.  Also, the google sdk prints a warning to use a service account instead. You can suppress that warning with this:
+
+.bash_profile
+
+    export GOOGLE_AUTH_SUPPRESS_CREDENTIALS_WARNINGS=1

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

@@ -10,7 +10,7 @@ GKE Private Clusters whitelist and only allow authorized IPs to communicate with
 
 ## Setup
 
-To enable the GKE IP whitelisting feature, it's a single line:
+To enable the GKE IP whitelisting feature, it's a few simple configurations:
 
 .kubes/config/env/dev.rb
 
@@ -19,24 +19,25 @@ KubesGoogle.configure do |config|
   config.gke.cluster_name = "dev-cluster"
   config.gke.google_region = ENV['GOOGLE_REGION']
   config.gke.google_project = ENV['GOOGLE_PROJECT']
-  config.gke.enable_get_credentials = true # enable hook to call: gcloud container clusters get-credentials
+  config.gke.enable_hooks   = KubesGoogle.cloudbuild?
+  config.gke.enable_get_credentials = KubesGoogle.cloudbuild? # enable hook to call: gcloud container clusters get-credentials
 end
 ```
 
 This enables `kubes apply` before and after hooks to add and remove the current machine IP.
 
+Notes:
+
+* Notice the use of `KubesGoogle.configure` instead of `Kubes.configure` here.
+* The `KubesGoogle.cloudbuild?` checks if kubes is running on a CloudBuild machine.  So hooks don't run locally on your machine.
+
 ## Options
 
 Here are the `config.gke` settings:
 
 Name | Description | Default
 ---|---|---
-cluster_name | GKE cluster name. This is required. | nil
-enable_get_credentials | Whether or not to run the hook that calls `gcloud container clusters get-credentials`. This spares you from having to call it manually. | false
-enable_hooks | This will be true when the cluster_name is set. So there's no need to set it. The option provides a quick way to override and disable running the hooks. | true
-google_project | Google project. Can also be set with the env var `GOOGLE_PROJECT`. `GOOGLE_PROJECT` takes precedence. | nil
-google_region | Google region cluster is in. Can also be set with the env var `GOOGLE_REGION`. `GOOGLE_REGION` takes precedence. | nil
-whitelist_ip | Explicit IP to whitelist. By default the IP address of the current machine is automatically detected and used. | nil
+{% include plugins/gke-config.md %}
 
 ## Build Docker Image
 
@@ -61,7 +62,7 @@ steps:
   - 'GOOGLE_PROJECT=$PROJECT_ID' # .kubes/config.rb: config.repo
   - 'KUBES_ENV=$_KUBES_ENV'
   - 'KUBES_EXTRA=$_KUBES_EXTRA'
-  - 'KUBES_REPO_AUTH=0'
+  - 'KUBES_REPO_AUTO_AUTH=0'
 
 substitutions:
   _KUBES_ENV: dev
@@ -70,7 +71,7 @@ options:
     substitution_option: 'ALLOW_LOOSE'
 ```
 
-Make sure to replace the substitutions with your own values. IE: _GCP_REGION, _GKE_CLUSTER, _KUBES_ENV, etc.
+Make sure to replace the substitutions with your own values. IE: _KUBES_ENV, etc.
 
 ## Google CloudBuild IAM Permissions
 
@@ -84,6 +85,12 @@ Important: The "Kubernetes Engine Developer" that is available in the Cloud Buil
 
 ## Run CloudBuild
 
-Run cloudbuild with:
+Run cloudbuild to deploy the dev env:
 
     gcloud builds submit --config cloudbuild.yaml
+
+To deploy the prod env:
+
+    gcloud builds submit --config cloudbuild.yaml --substitutions _KUBES_ENV=prod
+
+See [gcloud builds submit](https://cloud.google.com/sdk/gcloud/reference/builds/submit) reference docs for more options.

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

@@ -57,7 +57,19 @@ GOOGLE_PROJECT | Google project id. This is required.
 
 ## Base64 Option
 
-The value is automatically base64 encoded. You can set the `base64` option to turn on and off the automated base64 encoding.
+By default, the values are automatically base64 encoded. You can change the default behavior with a config option.
+
+.kubes/config.rb
+
+```ruby
+KubesGoogle.configure do |config|
+  config.secrets.base64 = false
+end
+```
+
+Note: The use of `KubesGoogle.configure` instead of `Kubes.configure` here.
+
+You can also set the `base64` option to turn on and off the automated base64 encoding on a per secret basis.
 
 ```ruby
 google_secret("demo-#{Kubes.env}-USER", base64: true)  # default is base64=true
@@ -65,3 +77,19 @@ google_secret("demo-#{Kubes.env}-PASS", base64: false)
 ```
 
 {% include helpers/base64.md %}
+
+## Fetcher Strategy
+
+Some systems configured with a VPN seem to have issues with the Google secrets SDK. You may see an error:
+
+    Handshake failed with fatal error SSL_ERROR_SSL: error:100000f7:SSL routines:OPENSSL_internal:WRONG_VERSION_NUMBER.
+
+As a workaround to this error, you can use the `gcloud` instead of the default `sdk` fetcher strategy. To configure it:
+
+.kubes/config.rb
+
+```ruby
+KubesGoogle.configure do |config|
+  config.secrets.fetcher = "gcloud"
+end
+```

data/docs/_docs/plugins.md

@@ -0,0 +1,12 @@
+---
+title: Kubes Plugins
+---
+
+Kubes makes it easier to work with Kubernetes by automating the deployment workflow. Many of the conveniences it adds is done with plugins. For example, `aws_secret`, `aws_ssm`, `google_secret` are implemented with Cloud Provider specific Kubes plugins.
+
+## Baseline Plugins
+
+The baseline plugins that currently ship with Kubes are:
+
+* [kubes_aws]({% link _docs/plugins/aws.md %})
+* [kubes_google]({% link _docs/plugins/google.md %})

data/docs/_docs/plugins/aws.md

@@ -0,0 +1,21 @@
+---
+title: AWS Kubes Plugin
+---
+
+The AWS Kubes Plugin adds support helpers like `aws_secret`. You can configure it's behavior. Example:
+
+.kubes/config.rb
+
+```ruby
+KubesAws.configure do |config|
+  config.secrets.base64 = false
+end
+```
+
+## Options Reference Table
+
+Here's a table with the options:
+
+Name | Description | Default
+---|---|---
+secrets.base64 | Whether or not to automatically base64 encoded values returned by the `aws_secret` helper. | true

data/docs/_docs/plugins/google.md

@@ -0,0 +1,22 @@
+---
+title: Google Kubes Plugin
+---
+
+The Google Kubes Plugin adds support helpers like `google_secret`. You can configure it's behavior. Example:
+
+.kubes/config.rb
+
+```ruby
+KubesGoogle.configure do |config|
+  config.secrets.base64 = true
+end
+```
+
+## Options Reference Table
+
+Here's a table with the options:
+
+Name | Description | Default
+---|---|---
+secrets.base64 | Whether or not to automatically base64 encoded values returned by the `google_secret` helper. | true
+{% include plugins/gke-config.md %}

data/docs/_docs/variables.md

@@ -9,15 +9,4 @@ You can set variables to be made available to the templates. Generally, it is re
 * [{{ doc.title }}]({{ doc.url }})
 {% endfor %}
 
-## Generator
-
-To help you get started quickly, you can generate starter variable code.
-
-    $ kubes new variable
-          create  .kubes/variables/dev.rb
-
-.kubes/variables/dev.rb
-
-```ruby
-@example = "dev-value"
-```
+{% include variables/generator.md %}

data/docs/_docs/variables/advanced.md

@@ -60,3 +60,5 @@ base/KIND/ENV.rb  | base/deployment/dev.rb
 ROLE/KIND.rb      | web/deployment.rb
 ROLE/KIND/base.rb | web/deployment/base.rb
 ROLE/KIND/ENV.rb  | web/deployment/dev.rb
+
+{% include variables/generator.md %}

data/docs/_docs/variables/basic.md

@@ -135,3 +135,5 @@ spec:
 apiVersion: apps/v1
 kind: Deployment
 ```
+
+{% include variables/generator.md %}

data/docs/_docs/vs/custom.md

@@ -4,7 +4,7 @@ nav_text: Custom Solutions
 categories: vs
 ---
 
-Kubernetes provide a great platform to run and manage Docker containers. The `kubectl` command how you usually interact with a Kubernetes cluster.  It does its job well and is quite a powerful tool.
+Kubernetes provides a great platform to run and manage Docker containers. The `kubectl` command is usually how you interact with a Kubernetes cluster.  It does its job well and is quite a powerful tool.
 
 {% include vs/article.md %}
 
@@ -51,7 +51,7 @@ We've duplicated `service.yaml` and `deployment.yaml`, though. Instead, it'll be
 
 ## PreBuilt Docker Image
 
-Additionally, the Docker image is expected to be prebuilt. Because you must first build the Docker image, folks will usually write bash script that perform these additional steps and then glue things together.
+Additionally, the Docker image is expected to be prebuilt. Because you must first build the Docker image, folks will usually write bash script that performs these additional steps and then glue things together.
 
 ## Kubernetes Resources Galore
 
@@ -82,7 +82,7 @@ The same code is used to create different environments. Kubes achieves this with
 
 ## Hooks
 
-Kubes support a variety of hooks run scripts at any part of the `kubectl` commands. This allows you customize and add app-specific logic needed. Example:
+Kubes support a variety of hooks run scripts at any part of the `kubectl` commands. This allows you to customize and add app-specific logic needed. Example:
 
 .kubes/config/hooks/kubectl.rb
 

data/docs/_includes/config/hooks/options.md

@@ -18,3 +18,4 @@ exit_on_fail | Whether or not to continue process if the script returns an faile
 ## Ruby Hooks
 
 Instead of using a script for the hook `execute` option, you can also use a Ruby object. This provides some more control over the current process. See: [Ruby Hooks]({% link _docs/config/hooks/ruby.md %})
+

data/docs/_includes/helpers/generator.md

@@ -0,0 +1,13 @@
+## Generator
+
+To help you get started quickly, you can generate starter helper code.
+
+    $ kubes new helper custom
+          create  .kubes/helpers/custom_helper.rb
+
+.kubes/helpers/custom_helper.rb
+
+```ruby
+module CustomHelper
+end
+```

data/docs/_includes/layering/layers.md

@@ -48,15 +48,13 @@ ROLE/KIND/ENV.{{ include.ext }}  | web/deployment/dev.{{ include.ext }}
 2. Then you can define the core of your resource definition in the `ROLE/KIND.{{ include.ext }}`. Example: `web/deployment.{{ include.ext }}`
 3. Finally, you can provide environment-specific overrides in the `ROLE/KIND/ENV.{{ include.ext }}`. Example: `web/deployment/dev.{{ include.ext }}`.
 
-Here's an example of the structure:
+Here's a concrete example of layering with the deployment resource kind:
 
-    .kubes/resources/
-    ├── base
-    │   ├── all.{{ include.ext }}
-    │   └── deployment.{{ include.ext }}
-    └── web
-        ├── deployment
-        │   ├── dev.{{ include.ext }}
-        │   └── prod.{{ include.ext }}
-        ├── deployment.{{ include.ext }}
-        └── service.{{ include.ext }}
+    .kubes/resources/base/all.{{ include.ext }}
+    .kubes/resources/base/deployment.{{ include.ext }}
+    .kubes/resources/web/deployment.{{ include.ext }}
+    .kubes/resources/web/deployment/dev.{{ include.ext }}
+
+All of these files get layered and merged together to produce a resulting deployment.{{ include.ext }}
+
+    .kubes/output/web/deployment.{{ include.ext }}

data/docs/_includes/plugins/gke-config.md

@@ -0,0 +1,6 @@
+gke.cluster_name | GKE cluster name. This is required when using the [GKE whitelisting feature]({% link _docs/helpers/google/gke.md %}). | nil
+gke.enable_get_credentials | Whether or not to run the hook that calls `gcloud container clusters get-credentials`. This spares you from having to call it manually. | false
+gke.enable_hooks | This will be true when the cluster_name is set. So there's no need to set it. The option provides a quick way to override and disable running the hooks. | true
+gke.google_project | Google project. Can also be set with the env var `GOOGLE_PROJECT`. `GOOGLE_PROJECT` takes precedence. | nil
+gke.google_region | Google region cluster is in. Can also be set with the env var `GOOGLE_REGION`. `GOOGLE_REGION` takes precedence. | nil
+gke.whitelist_ip | Explicit IP to whitelist. By default the IP address of the current machine is automatically detected and used. | nil

data/docs/_includes/sidebar.html

@@ -173,6 +173,12 @@
           <li><a href="{% link _docs/extra-env/dsl.md %}">DSL</a></li>
         </ul>
       </li>
+      <li><a href="{% link _docs/plugins.md %}">Plugins</a>
+        <ul>
+          <li><a href="{% link _docs/plugins/aws.md %}">AWS</a></li>
+          <li><a href="{% link _docs/plugins/google.md %}">Google</a></li>
+        </ul>
+      </li>
       <li>Misc
         <ul>
           <li><a href="{% link _docs/misc/kustomize.md %}">Kustomize Support</a></li>

data/docs/_includes/variables/generator.md

@@ -0,0 +1,23 @@
+## Generator
+
+To help you get started quickly, you can generate starter variable code.
+
+    $ kubes new variable
+          create  .kubes/variables/dev.rb
+
+.kubes/variables/dev.rb
+
+```ruby
+@example = "dev-value"
+```
+
+To create the prod variables, set `KUBES_ENV=prod`.
+
+    $ KUBES_ENV=prod kubes new variable
+          create  .kubes/variables/prod.rb
+
+.kubes/variables/prod.rb
+
+```ruby
+@example = "prod-value"
+```

data/kubes.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core helper libs
-  spec.add_dependency "kubes_aws", "~> 0.2.0"
-  spec.add_dependency "kubes_google", "~> 0.3.1"
+  spec.add_dependency "kubes_aws", "~> 0.3.1"
+  spec.add_dependency "kubes_google", "~> 0.3.5"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/kubes/auth.rb

@@ -24,7 +24,7 @@ module Kubes
 
     def auth?
       if ENV['KUBES_REPO_AUTO_AUTH'].nil?
-        Kubes.config.repo_auth
+        Kubes.config.repo_auto_auth
       else
         %w[1 true].include?(ENV['KUBES_REPO_AUTO_AUTH'])
       end

data/lib/kubes/command.rb

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

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.6.3"
+  VERSION = "0.6.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.8
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: kubes_google
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -362,6 +362,9 @@ files:
 - docs/_docs/patterns/migrations.md
 - docs/_docs/patterns/multiple-envs.md
 - docs/_docs/patterns/secrets.md
+- docs/_docs/plugins.md
+- docs/_docs/plugins/aws.md
+- docs/_docs/plugins/google.md
 - docs/_docs/resources.md
 - docs/_docs/resources/base.md
 - docs/_docs/resources/role.md
@@ -385,6 +388,7 @@ files:
 - docs/_includes/google_analytics.html
 - docs/_includes/header.html
 - docs/_includes/helpers/base64.md
+- docs/_includes/helpers/generator.md
 - docs/_includes/intro/features.md
 - docs/_includes/intro/install.md
 - docs/_includes/js.html
@@ -396,8 +400,10 @@ files:
 - docs/_includes/learn/repos.md
 - docs/_includes/learn/review.md
 - docs/_includes/learn/start.md
+- docs/_includes/plugins/gke-config.md
 - docs/_includes/reference.md
 - docs/_includes/sidebar.html
+- docs/_includes/variables/generator.md
 - docs/_includes/vs/article.md
 - docs/_includes/vs/kubes/layering.md
 - docs/_includes/vs/kubes/structure.md