kubes 0.5.1 → 0.6.4

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/intro/features.md

@@ -0,0 +1,11 @@
+* Automation: [Builds the Docker image]({% link _docs/config/docker.md %}) and updates the compiled YAML files
+* Syntactic Sugar: Use an [ERB/YAML]({% link _docs/yaml.md %}) or a [DSL]({% link _docs/dsl.md %}) to write your Kubernetes YAML files. You can use a mix of DSL and YAML definitions in the `.kubes/resources` folder.
+* Layering: Use the same Kubernetes YAML to build multiple environments like dev and prod with [layering]({% link _docs/layering.md %}).
+* Secrets: Use helpers like [aws_secret]({% link _docs/helpers/aws/secrets.md %}), [aws_ssm]({% link _docs/helpers/aws/ssm.md %}), and [google_secret]({% link _docs/helpers/google/secrets.md %}) to build Kubernetes secrets.yaml from secret providers designed for it.
+* Generators: Kubes ships with a few generators to help you get building with Kubernetes quickly. See: [Generator Docs]({% link _docs/generators.md %}).
+* CLI Customizations: You can customize the [cli args]({% link _docs/config/args/kubectl.md %}).
+* Hooks: You can also run [hooks]({% link _docs/config/hooks.md %}) before and after [kubes]({% link _docs/config/hooks/kubes.md %}) and [kubectl]({% link _docs/config/hooks/kubectl.md %}) commands.
+* Automated Suffix Hashes: Automatically appends a suffix hash to ConfigMap and Secret resources. More details in [ConfigMap]({% link _docs/dsl/resources/config_map.md %}) and [Secret]({% link _docs/dsl/resources/secret.md %}) docs.
+* Kustomize Support: If you're a kustomization user, you can use it with Kubes. More details in [Kustomize Support Docs]({% link _docs/misc/kustomize.md %}).
+* Auto Context Switching: Map dev to a specific kubectl context and prod to another kubectl context and Kubes can switch them automatically so you won't have to remember. More details in [Auto Context Docs]({% link _docs/misc/auto-context.md %}).
+* Ordering: Kubes run kubectl apply to create resources in the [correct order]({% link _docs/intro/ordering.md %}). For deleting, it kubes will run `kubectl delete` in the correct reverse order. The order is also [customizable]({% link _docs/intro/ordering/custom.md %}).

data/docs/_includes/layering/layers.md

@@ -1,6 +1,6 @@
 Kubes Layering in it's full form allows you to keep your resource definitions DRY and create different environments with the same code.
 
-## Structure
+## Project Structure
 
 Here's an example structure, so we can understand how layering works.
 
@@ -25,9 +25,7 @@ To explain the layering, here's the general processing order that Kubes takes.
 2. Then Kubes will process your `.kubes/resources/ROLE` definitions.
 3. Lastly, Kubes processes any post-layers in the `.kubes/resources/ROLE/KIND` folders.
 
-Note, both YAML and DSL forms support layering.
-
-Layering only combines resources definitions with the same form. For example, the DSL form `base/all.rb` will not be combined with YAML form `web/deployment.yaml`.
+Note, both YAML and DSL forms support layering. They can be mixed together.
 
 ## Full Layering
 
@@ -50,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

@@ -28,6 +28,14 @@
           <li><a href="{% link _docs/learn/dsl/next-steps.md %}">Next Steps</a></li>
         </ul>
       </li>
+      <li><a href="{% link _docs/vs.md %}">Kubes vs Others</a>
+        <ul>
+        {% assign docs = site.docs | where: "categories","vs" %}
+        {% for doc in docs -%}
+          <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+        {% endfor %}
+        </ul>
+      </li>
     </ul>
     <h2><a href="{% link docs.md %}">Docs</a></h2>
     <ul id="docs">
@@ -83,6 +91,7 @@
         <ul>
           <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>
         </ul>
       </li>
@@ -99,6 +108,14 @@
           <li><a href="{% link _docs/dsl/multiple-resources.md %}">Multiple Resources</a>
         </ul>
       </li>
+      <li><a href="{% link _docs/variables.md %}">Variables</a>
+        <ul>
+          {% assign docs = site.docs | where: "categories","variables" %}
+          {% for doc in docs -%}
+            <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+          {% endfor %}
+        </ul>
+      </li>
       <li><a href="{% link _docs/helpers.md %}">Helpers</a>
         <ul>
           <li><a href="{% link _docs/helpers/custom.md %}">Custom</a></li>
@@ -106,7 +123,18 @@
             <ul>
               {% assign docs = site.docs | where: "categories","helpers-aws" %}
               {% for doc in docs -%}
+                {% if doc.nav_text == "Advanced" %}
+                <li><a href='{{ doc.url }}'>{{ doc.nav_text }}</a>
+                  <ul>
+                    {% assign docs = site.docs | where: "categories","advanced-helpers-aws" %}
+                    {% for doc in docs -%}
+                    <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+                    {% endfor %}
+                  </ul>
+                </li>
+                {% else %}
                 <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+                {% endif %}
               {% endfor %}
             </ul>
           </li>
@@ -114,7 +142,18 @@
             <ul>
               {% assign docs = site.docs | where: "categories","helpers-google" %}
               {% for doc in docs -%}
+                {% if doc.nav_text == "Advanced" %}
+                <li><a href='{{ doc.url }}'>{{ doc.nav_text }}</a>
+                  <ul>
+                    {% assign docs = site.docs | where: "categories","advanced-helpers-google" %}
+                    {% for doc in docs -%}
+                    <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+                    {% endfor %}
+                  </ul>
+                </li>
+                {% else %}
                 <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+                {% endif %}
               {% endfor %}
             </ul>
           </li>
@@ -134,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/docs/_includes/vs/article.md

@@ -0,0 +1 @@
+This article also covers more differences in detail: [Kustomize vs Helm vs Kubes: Kubernetes Deploy Tools](https://blog.boltops.com/2020/11/05/kustomize-vs-helm-vs-kubes-kubernetes-deploy-tools)

data/docs/_includes/vs/kubes/layering.md

@@ -0,0 +1,10 @@
+### Kubes Layering
+
+To deploy and create multiple environments like dev and prod with the same YAML, we use a different KUBES_ENV setting:
+
+    KUBES_ENV=dev  kubes deploy
+    KUBES_ENV=prod kubes deploy
+
+The layering is achieved thanks to the conventional project structure. You don't have to do any extra work, you just create pre-process base layer files or post-process environment specific layer files.
+
+* [Kubes Layering Docs]({% link _docs/layering.md %})

data/docs/_includes/vs/kubes/structure.md

@@ -0,0 +1,24 @@
+### Kubes Project Structure
+
+On the other hand, Kubes defines a conventional project structure. Here's a project directory example:
+
+    .kubes
+    └── resources
+        ├── base
+        │   ├── all.yaml
+        │   └── deployment.yaml
+        ├── shared
+        │   └── namespace.yaml
+        └── web
+            ├── deployment
+            │   ├── dev.yaml
+            │   └── prod.yaml
+            ├── deployment.yaml
+            └── service.yaml
+
+A Kubes project structure also supports introduces a role concept or folder. The folder structure only shows a web role for simplicity. You can always add more roles.  For example:
+
+    .kubes/resources/ROLE/deployment.yaml
+    .kubes/resources/clock/deployment.yaml
+    .kubes/resources/web/deployment.yaml
+    .kubes/resources/worker/deployment.yaml

data/docs/_reference/kubes-new-help.md

@@ -0,0 +1,15 @@
+---
+title: kubes new help
+reference: true
+---
+
+## Usage
+
+    kubes new help [COMMAND]
+
+## Description
+
+Describe subcommands or one specific subcommand
+
+
+

data/docs/_reference/kubes-new-helper.md

@@ -0,0 +1,25 @@
+---
+title: kubes new helper
+reference: true
+---
+
+## Usage
+
+    kubes new helper
+
+## Description
+
+Generates kubes helper file.
+
+## Examples
+
+    $ kubes new helper custom
+          create  .kubes/helpers/custom_helper.rb
+
+
+## Options
+
+```
+y, [--force]  # Bypass overwrite are you sure prompt for existing files
+```
+

data/docs/_reference/kubes-new-resource.md

@@ -0,0 +1,56 @@
+---
+title: kubes new resource
+reference: true
+---
+
+## Usage
+
+    kubes new resource
+
+## Description
+
+Generates Kubes Kubernetes resource definition.
+
+## Examples
+
+    $ kubes new resource ingress
+          create  .kubes/resources/web/ingress.yaml
+    $ kubes new resource service_account
+          create  .kubes/resources/shared/service_account.yaml
+    $
+
+## Supported Resources
+
+Here's a list of some of the supported resources.
+
+    backend_config
+    config_map
+    daemon_set
+    deployment
+    ingress
+    job
+    managed_certificate
+    namespace
+    network_policy
+    pod
+    role_binding
+    role
+    secret
+    service_account
+    service
+
+Refer to the source code to all the resources that the generator supports:
+https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/resource/yaml
+
+
+## Options
+
+```
+a, [--app=APP]    # App name
+                  # Default: demo
+y, [--force]      # Bypass overwrite are you sure prompt for existing files
+r, [--role=ROLE]  # Role. IE: web, clock, worker, migrate, etc. Defaults to convention: web or shared when not set
+t, [--type=TYPE]  # Type: dsl or yaml
+                  # Default: yaml
+```
+

data/docs/_reference/kubes-new-variable.md

@@ -0,0 +1,20 @@
+---
+title: kubes new variable
+reference: true
+---
+
+## Usage
+
+    kubes new variable
+
+## Description
+
+Generates kubes variable file.
+
+
+## Options
+
+```
+y, [--force]  # Bypass overwrite are you sure prompt for existing files
+```
+

data/docs/_reference/kubes-new.md

@@ -11,48 +11,16 @@ reference: true
 
 Generates new resource.
 
-## Examples
-
-    $ kubes new ingress
-          create  .kubes/resources/web/ingress.yaml
-    $ kubes new service_account
-          create  .kubes/resources/shared/service_account.yaml
-    $
-
-## Supported Resources
-
-Here's a list of some of the supported resources.
-
-    backend_config
-    config_map
-    daemon_set
-    deployment
-    ingress
-    job
-    managed_certificate
-    namespace
-    network_policy
-    pod
-    role_binding
-    role
-    secret
-    service_account
-    service
-
-Refer to the source code to all the resources that the generator supports:
-https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/yaml
+## Subcommands
 
+* [kubes new helper]({% link _reference/kubes-new-helper.md %}) - Generates kubes helper file.
+* [kubes new resource]({% link _reference/kubes-new-resource.md %}) - Generates Kubes Kubernetes resource definition.
+* [kubes new variable]({% link _reference/kubes-new-variable.md %}) - Generates kubes variable file.
 
 ## Options
 
 ```
-a, [--app=APP]                   # App name
-                                 # Default: demo
-y, [--force]                     # Bypass overwrite are you sure prompt for existing files
-r, [--role=ROLE]                 # Role. IE: web, clock, worker, migrate, etc. Defaults to convention: web or shared when not set
-t, [--type=TYPE]                 # Type: dsl or yaml
-                                 # Default: yaml
-    [--verbose], [--no-verbose]  
-    [--noop], [--no-noop]        
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
 ```
 

data/kubes.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core helper libs
-  spec.add_dependency "kubes_aws"
-  spec.add_dependency "kubes_google"
+  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.rb

@@ -1,6 +1,10 @@
 $stdout.sync = true unless ENV["KUBES_STDOUT_SYNC"] == "0"
 
 $:.unshift(File.expand_path("../", __FILE__))
+
+require "kubes/autoloader"
+Kubes::Autoloader.setup
+
 require "active_support/core_ext/class"
 require "active_support/core_ext/hash"
 require "active_support/core_ext/string"
@@ -20,9 +24,6 @@ require "kubes_google"
 
 DslEvaluator.backtrace_reject = "lib/kubes"
 
-require "kubes/autoloader"
-Kubes::Autoloader.setup
-
 module Kubes
   class Error < StandardError; end
   class MissingDockerImage < Error; end

data/lib/kubes/auth.rb

@@ -10,11 +10,23 @@ module Kubes
       klass.new(@image).run
     end
 
-    # Currently only support ECR
+    # Currently only support ECR and GCR
+    # TODO: consider moving this to plugin gems
     def strategy_class
+      return unless auth?
       case @image
       when /\.amazonaws\.com/ # IE: 112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra
         Ecr
+      when /gcr\.io/
+        Gcr
+      end
+    end
+
+    def auth?
+      if ENV['KUBES_REPO_AUTO_AUTH'].nil?
+        Kubes.config.repo_auto_auth
+      else
+        %w[1 true].include?(ENV['KUBES_REPO_AUTO_AUTH'])
       end
     end
   end