kubes 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0b62ecd7b432896bd1fbafc3aeae759f858bcbfb0f2ca9a02ecb60d91fcff3
-  data.tar.gz: 7faf78784573d6d1058fb3641e47356bf725c683cdfc53b081d8926bf2799249
+  metadata.gz: ce0d27f928a17e1013e97242990213cd4b375aee110dc14d3effc9aa8df2d490
+  data.tar.gz: 983312b9f64da2641ec8286dc76b9e7582dac9a575f77222ab4e9f9a145d26dd
 SHA512:
-  metadata.gz: b7d432057c49947c864594fb2049677b721ff084ccd60403a39e7e360aa2a05157fddef26593004a836eb130d39a2307c6443438861be119affe66a182a05380
-  data.tar.gz: 4a99ff9b1819db41ad13f1340707242a978c37cc83d7dbe8e10a6cf06cac9c3aa65335d9e6d8fc94a500cd267d3b197940d49ec71f76f4a4cb81c5ab71efff9f
+  metadata.gz: 36dc2af17c87d9c58eca05f8f63848f57d95cccdfcd51894ddb467c7424c7eefade4aed9133c871f400f05997143d1f537aeb38c1d8288815ab05558f25ae31c
+  data.tar.gz: 3ed8687d0f1af629a7645a002536e7a187057ea2da504e52fb3227da933b4a0c98db8ad0f1170a2a720248cbe517f7206ad8941299467695772d5fca289c1160

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.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.base64_secrets = 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/gke.md

@@ -23,6 +23,8 @@ KubesGoogle.configure do |config|
 end
 ```
 
+Note: The use of `KubesGoogle.configure` instead of `Kubes.configure` here.
+
 This enables `kubes apply` before and after hooks to add and remove the current machine IP.
 
 ## Options
@@ -31,12 +33,7 @@ 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
 
@@ -84,6 +81,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.base64_secrets = true
+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

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,17 @@
+---
+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.base64_secrets = false
+end
+```
+
+Name | Description | Default
+---|---|---
+base64_secrets | Whether or not to automatically base64 encoded values returned by the `aws_secret` helper. | true

data/docs/_docs/plugins/google.md

@@ -0,0 +1,18 @@
+---
+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.base64_secrets = true
+end
+```
+
+Name | Description | Default
+---|---|---
+base64_secrets | 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/_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,12 @@
+## 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"
+```

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.0"
+  spec.add_dependency "kubes_google", "~> 0.3.2"
 
   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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Tung Nguyen
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: kubes_google
   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: 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