kubes 0.4.3 → 0.5.0

data/docs/_docs/patterns/migrations.md

@@ -25,7 +25,7 @@ spec:
     spec:
       containers:
       - name: migrate
-        image: <%= built_image %>
+        image: <%= docker_image %>
         command: ["bin/job/migrate.sh"]
       restartPolicy: Never
   backoffLimit: 4

data/docs/_docs/patterns/secrets.md

@@ -78,5 +78,3 @@ upcase | Automatically upcase the Kubernetes secret data keys. | false
 prefix | Prefixed used to list and filter Google secrets. IE: `projects/686010496118/secrets/demo-dev-`. Can also be set with the `GCP_SECRET_PREFIX` env variable. The env variable takes the highest precedence. | nil
 
 Note, Kubernetes secrets are only base64 encoded. So users who have access to read Kubernetes secrets will be able to decode and get the value trivially. Depending on your security posture requirements, this may or may not suffice.
-
-The Google helpers are provided by the [boltops-tools/kubes_google](https://github.com/boltops-tools/kubes_google) library. For more details, check out its README.

data/docs/_docs/yaml.md

@@ -12,7 +12,7 @@ You can write your Kubernetes resources in YAML format.
 
 ## YAML and Templating
 
-Kubes provides a little extra power for the YAML format. The YAML files are processed through an ERB templating language.  So you have dynamic control. Here's an example with `Kubes.env` and the `built_image` helper.
+Kubes provides a little extra power for the YAML format. The YAML files are processed through an ERB templating language.  So you have dynamic control. Here's an example with `Kubes.env` and the `docker_image` helper.
 
 .kubes/resources/web/deployment.yaml
 
@@ -37,5 +37,5 @@ spec:
     spec:
       containers:
       - name: demo-web
-        image: <%= built_image %>
+        image: <%= docker_image %>
 ```

data/docs/_includes/commands.html

@@ -108,7 +108,7 @@ spec:
     spec:
       containers:
       - name: demo-web
-        image: <%= built_image %>
+        image: <%= docker_image %>
 {% endhighlight %}
               </div>
             </div>
@@ -121,7 +121,7 @@ namespace "default"
 labels(role: "web")
 
 replicas 2
-image built_image # IE: user/demo-web:kubes-2020-06-13T19-55-16-43afc6e
+image docker_image # IE: user/demo-web:kubes-2020-06-13T19-55-16-43afc6e
 {% endhighlight %}
               </div>
             </div>

data/docs/_includes/helpers/base64.md

@@ -0,0 +1 @@
+Note, Kubernetes secrets are only base64 encoded. So users who have access to read Kubernetes secrets will be able to decode and get the value trivially. Depending on your security posture requirements, this may or may not suffice.

data/docs/_includes/layering/layers.md

@@ -27,7 +27,7 @@ To explain the layering, here's the general processing order that Kubes takes.
 
 Note, both YAML and DSL forms support layering.
 
-Layering only combines resources definitions with the same form. For example, `base/all.rb` will not be combined with `web/deployment.yaml`.
+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`.
 
 ## Full Layering
 

data/docs/_includes/sidebar.html

@@ -42,6 +42,7 @@
             </ul>
           </li>
           <li><a href="{% link _docs/intro/install.md %}">Install</a></li>
+          <li><a href="{% link _docs/intro/docker-image.md %}">Docker Image</a></li>
         </ul>
       </li>
       <li><a href="{% link _docs/resources.md %}">Resources</a>
@@ -76,6 +77,7 @@
           <li><a href="{% link _docs/config/reference.md %}">Reference</a></li>
         </ul>
       </li>
+      <li><a href="{% link _docs/generators.md %}">Generators</a></li>
       <li><a href="{% link _docs/yaml.md %}">YAML</a></li>
       <li><a href="{% link _docs/layering.md %}">Layering</a>
         <ul>
@@ -97,7 +99,27 @@
           <li><a href="{% link _docs/dsl/multiple-resources.md %}">Multiple Resources</a>
         </ul>
       </li>
-      <li><a href="{% link _docs/helpers.md %}">Helpers</a></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/aws.md %}">AWS</a>
+            <ul>
+              {% assign docs = site.docs | where: "categories","helpers-aws" %}
+              {% for doc in docs -%}
+                <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+              {% endfor %}
+            </ul>
+          </li>
+          <li><a href="{% link _docs/helpers/google.md %}">Google</a>
+            <ul>
+              {% assign docs = site.docs | where: "categories","helpers-google" %}
+              {% for doc in docs -%}
+                <li><a href="{{ doc.url }}">{{ doc.nav_text }}</a></li>
+              {% endfor %}
+            </ul>
+          </li>
+        </ul>
+      </li>
       <li><a href="{% link _docs/patterns.md %}">Patterns</a>
         <ul>
           {% assign docs = site.docs | where: "categories","patterns" %}

data/docs/_reference/kubes-delete.md

@@ -9,7 +9,7 @@ reference: true
 
 ## Description
 
-Delete Kubernetes resources within the app folder
+Delete Kubernetes resources in defined .kubes/resources
 
 
 ## Options

data/docs/_reference/kubes-exec.md

@@ -36,13 +36,29 @@ If you have have multiple containers in your pod. You can specify the specfic co
 
     kubes exec --name web
 
+## Default Exec Command
+
+The default exec command is `sh`.  Example:
+
+    $ kubes exec
+    => kubectl exec -n demo-dev -ti web-568645f665-62j8f -- sh
+    /app #
+
+You can override the default with `KUBES_DEFAULT_EXEC`.  Example:
+
+    $ export KUBES_DEFAULT_EXEC=bash
+    $ kubes exec
+    => kubectl exec -n demo-dev -ti web-568645f665-62j8f -- bash
+    /app #
+
 
 ## Options
 
 ```
     [--compile], [--no-compile]  # whether or not to compile the .kube/resources
                                  # Default: true
-n, [--name=NAME]                 # deployment name to use. IE: demo-web
+p, [--pod=POD]                   # pod to use. IE: web
+d, [--deployment=DEPLOYMENT]     # deployment name to use. IE: demo-web
 c, [--container=CONTAINER]       # Container name. If omitted, the first container in the pod will be chosen
     [--verbose], [--no-verbose]  
     [--noop], [--no-noop]        

data/docs/_reference/kubes-init.md

@@ -16,11 +16,11 @@ Init project
 
 ```
 a, --app=APP                     # Docker repo name. Example: web. Generates .kubes/APP/resources folder
-    [--force]                    # Bypass overwrite are you sure prompt for existing files
+y, [--force]                     # Bypass overwrite are you sure prompt for existing files
 t, [--type=TYPE]                 # Type: dsl or yaml
                                  # Default: yaml
     --repo=REPO                  # Docker repo name. Example: user/repo. Configures .kubes/config.rb
-n, [--namespace=NAMESPACE]       # Namespace to use, defaults to the app option
+n, [--namespace=NAMESPACE]       # Namespace to use, defaults to APP-ENV. IE: demo-dev
     [--verbose], [--no-verbose]  
     [--noop], [--no-noop]        
 ```

data/docs/_reference/kubes-logs.md

@@ -17,7 +17,8 @@ logs from all deployment pods
 ```
     [--compile], [--no-compile]  # whether or not to compile the .kube/resources
                                  # Default: true
-n, [--name=NAME]                 # deployment name to use. IE: demo-web
+p, [--pod=POD]                   # pod to use. IE: web
+d, [--deployment=DEPLOYMENT]     # deployment name to use. IE: demo-web
 c, [--container=CONTAINER]       # Container name. If omitted, the first container in the pod will be chosen
 f, [--follow], [--no-follow]     # Follow logs
                                  # Default: true

data/docs/_reference/kubes-new.md

@@ -0,0 +1,58 @@
+---
+title: kubes new
+reference: true
+---
+
+## Usage
+
+    kubes new
+
+## Description
+
+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
+
+
+## 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]        
+```
+

data/docs/_reference/kubes-prune.md

@@ -0,0 +1,22 @@
+---
+title: kubes prune
+reference: true
+---
+
+## Usage
+
+    kubes prune
+
+## Description
+
+Prune old resources like secret and config maps
+
+
+## Options
+
+```
+y, [--yes], [--no-yes]           # Skip are you sure prompt
+    [--verbose], [--no-verbose]  
+    [--noop], [--no-noop]        
+```
+

data/docs/reference.md

@@ -16,4 +16,6 @@ title: CLI Reference
 * [kubes get]({% link _reference/kubes-get.md %})
 * [kubes init]({% link _reference/kubes-init.md %})
 * [kubes logs]({% link _reference/kubes-logs.md %})
+* [kubes new]({% link _reference/kubes-new.md %})
+* [kubes prune]({% link _reference/kubes-prune.md %})
 * [kubes version]({% link _reference/kubes-version.md %})

data/kubes.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk"
 
   # core helper libs
+  spec.add_dependency "kubes_aws"
   spec.add_dependency "kubes_google"
 
   spec.add_development_dependency "bundler"

data/lib/kubes.rb

@@ -15,14 +15,16 @@ require "rainbow/ext/string"
 require "yaml"
 
 # core helper libraries
+require "kubes_aws"
 require "kubes_google"
 
-DslEvaluator.backtrace_reject = ".kubes"
+DslEvaluator.backtrace_reject = "lib/kubes"
 
 require "kubes/autoloader"
 Kubes::Autoloader.setup
 
 module Kubes
   class Error < StandardError; end
+  class MissingDockerImage < Error; end
   extend Core
 end

data/lib/kubes/autoloader.rb

@@ -14,8 +14,17 @@ module Kubes
         loader = Zeitwerk::Loader.new
         loader.inflector = Inflector.new
         loader.push_dir(File.dirname(__dir__)) # lib
+
+        helpers = "#{kubes_root}/.kubes/helpers"
+        loader.push_dir(helpers) if File.exist?(helpers) # project helpers
+
         loader.setup
       end
+
+      # Autoloader runs so early that Kubes.root is not available, so we must declare it here
+      def kubes_root
+        ENV['KUBES_ROOT'] || '.'
+      end
     end
   end
 end

data/lib/kubes/cli.rb

@@ -26,6 +26,14 @@ module Kubes
     long_desc Help.text(:docker)
     subcommand "docker", Docker
 
+    desc "docker SUBCOMMAND", "Docker subcommands"
+    long_desc Help.text(:docker)
+    subcommand "docker", Docker
+
+    long_desc Help.text("new")
+    New.options.each { |args| option(*args) }
+    register(New, "new", "new", "Generates new resource.")
+
     desc "apply [ROLE] [RESOURCE]", "Apply the Kubernetes YAML files without building docker image"
     long_desc Help.text(:apply)
     image_option.call
@@ -48,7 +56,7 @@ module Kubes
       Compile.new(options).run
     end
 
-    desc "delete [ROLE] [RESOURCE]", "Delete Kubernetes resources within the app folder"
+    desc "delete [ROLE] [RESOURCE]", "Delete Kubernetes resources in defined .kubes/resources"
     long_desc Help.text(:delete)
     image_option.call
     yes_option.call

data/lib/kubes/cli/build.rb

@@ -1,8 +1,14 @@
 class Kubes::CLI
   class Build < Base
     def run
+      return unless build?
       Kubes::Docker.new(@options, "build").run
       Kubes::Docker.new(@options, "push").run
     end
+
+    def build?
+      return false if @options[:build] == false || @options[:image] || Kubes.config.image
+      @options[:resource].nil? || @options[:resource] == "deployment"
+    end
   end
 end

data/lib/kubes/cli/compile.rb

@@ -8,9 +8,16 @@ class Kubes::CLI
     @@compiled = false
     def run
       return if @@compiled
+      build_docker_image
       Clean.new(@options.merge(mute: true)).run
       Kubes::Compiler.new(@options).run
       @@compiled = true
     end
+
+    # auto build docker image and push image if kubes docker build not yet called
+    def build_docker_image
+      return if File.exist?("#{Kubes.root}/.kubes/state/docker_image.txt")
+      Build.new(@options).run
+    end
   end
 end

data/lib/kubes/cli/deploy.rb

@@ -1,13 +1,8 @@
 class Kubes::CLI
   class Deploy < Base
     def run
-      Build.new(@options).run if build?
+      Build.new(@options).run
       Apply.new(@options).run # also calls Compile
     end
-
-    def build?
-      return false if @options[:build] == false || @options[:image]
-      @options[:resource].nil? || @options[:resource] == "deployment"
-    end
   end
 end

data/lib/kubes/cli/exec.rb

@@ -20,10 +20,14 @@ class Kubes::CLI
       end
 
       container = " -c #{@options[:container]}" unless @options[:container].nil?
-      cmd = @options[:cmd].empty? ? "bash" : @options[:cmd].join(' ')
+      cmd = @options[:cmd].empty? ? default_exec : @options[:cmd].join(' ')
       sh("kubectl exec #{ns} -ti #{pod}#{container} -- #{cmd}")
     end
 
+    def default_exec
+      ENV['KUBES_DEFAULT_EXEC'] || "sh"
+    end
+
     def find_pod
       pod_name || deployment_pod
     end

data/lib/kubes/cli/help/exec.md

@@ -22,3 +22,18 @@ If you have have multiple deployments in your `.kubes/resources` then the comman
 If you have have multiple containers in your pod. You can specify the specfic container with the `--container` or `-c` option.  Examples:
 
     kubes exec --name web
+
+## Default Exec Command
+
+The default exec command is `sh`.  Example:
+
+    $ kubes exec
+    => kubectl exec -n demo-dev -ti web-568645f665-62j8f -- sh
+    /app #
+
+You can override the default with `KUBES_DEFAULT_EXEC`.  Example:
+
+    $ export KUBES_DEFAULT_EXEC=bash
+    $ kubes exec
+    => kubectl exec -n demo-dev -ti web-568645f665-62j8f -- bash
+    /app #

data/lib/kubes/cli/help/new.md

@@ -0,0 +1,30 @@
+## 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