kubes 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c14d045b8c029e76e1c001f26a0b77c97ecdabc45ddc964660372f2170f95690
-  data.tar.gz: 36a0b622a75cc18e74d78537a2a3f421e15de150cb89978434a58d31c37b799b
+  metadata.gz: d239ce306b5a9eea427cab3ec5ca5f753f0eae3d1822fce65017c23172779562
+  data.tar.gz: 3d97c8d85e6f5bfd02babaf14140f186ebd22c3981fa8eed76ddcdbe7f24958d
 SHA512:
-  metadata.gz: cd0f40a09c2909be4820c0575d6a8ef850b1977e21cd5d040cb82cb11411500a136608035635f743cb1a967116913856fc5e7997f3fef511b5c07d94d5fe4458
-  data.tar.gz: 9f29e9bf7a4615bb2a9864b9acdc9aa83b70583b5743decd5e8c6bac1b85b49bfc90a724403765afe2a86fa1cd1819cccedc53b7b91d6e858a20ececf2630f6a
+  metadata.gz: 74b0ad9bc27e15f1b8742d26f6b2c09e11e990a69623a7e0b54d12565dc08e3dec5d0c640bfd4f5457aa09f0069c0010a78d39dedc18bd9a2223ebdb34be9c31
+  data.tar.gz: 7f3508f0d3650677a48f1f0069f71b1801ddd0a760f052f725a81f564fd144b6eecbd8c08e79fd2e9ec571a0ada2308d4f84bdfbc6971f66a80a20eec8ffbaae

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.3.5]
+- #25 small fixes: show pod and fetch items nil
+
 ## [0.3.4]
 - #24 fix namespace newline and logs for single container
 - #23 init namespace option

data/docs/_docs/ci/cloudbuild.md

@@ -38,6 +38,8 @@ options:
     substitution_option: 'ALLOW_LOOSE'
 ```
 
+Make sure to replace the substitutions with your own values. IE: _GCP_REGION, _GKE_CLUSTER, _KUBES_ENV, etc.
+
 ## Run CloudBuild
 
 Run cloudbuild with:

data/docs/_docs/config/env.md

@@ -55,4 +55,4 @@ Kubes.configure do |config|
 end
 ```
 
-For more details refer to the [Auto Context Docs]({% link _docs/auto-context.md %}).
+For more details refer to the [Auto Context Docs]({% link _docs/misc/auto-context.md %}).

data/docs/_docs/config/kubectl.md

@@ -1,61 +1,10 @@
 ---
-title: Kubectl Config
+title: Kubectl Customizations
 ---
 
 ## General
 
 Kubes calls out the `kubectl` command. You can customize the command.
 
-## Args
-
-Here are some examples of customizing the kubectl args.
-
-.kubes/config/kubectl/args.rb
-
-```ruby
-command("apply",
-  args: ["--validate=true"],
-)
-
-command("delete",
-  args: ["--grace-period=-1"],
-)
-```
-
-## Hooks
-
-Here are some examples of running custom hooks before and after the kubectl commands.
-
-.kubes/config/kubectl/hooks.rb
-
-```ruby
-before("apply",
-  execute: "kubectl apply -f .kubes/shared/namespace.yaml",
-)
-
-after("delete",
-  execute: "echo 'delete hook',
-)
-```
-
-You can use hooks to do things that may not make sense to do in the `.kubes/resources` definition. Here's an example of automatically creating the namespace.
-
-.kubes/shared/namespace.yaml
-
-```yaml
-apiVersion: v1
-kind: Namespace
-metadata:
-  name: demo
-```
-
-### exit on fail
-
-By default, if the hook commands fail, then terraspace will exit with the original hook error code.  You can change this behavior with the `exit_on_fail` option.
-
-```ruby
-before("apply"
-  execute: "/command/will/fail/but/will/continue",
-  exit_on_fail: false,
-)
-```
+* [Args]({% link _docs/config/kubectl/args.md %}): Customize the CLI args.
+* [Hooks]({% link _docs/config/kubectl/hooks.md %}): Run hooks before and after the kubectl commands.

data/docs/_docs/config/kubectl/args.md

@@ -0,0 +1,17 @@
+---
+title: Kubectl Args
+---
+
+Here are some examples of customizing the kubectl args.
+
+.kubes/config/kubectl/args.rb
+
+```ruby
+command("apply",
+  args: ["--validate=true"],
+)
+
+command("delete",
+  args: ["--grace-period=-1"],
+)
+```

data/docs/_docs/config/kubectl/hooks.md

@@ -0,0 +1,39 @@
+---
+title: Kubectl Hooks
+---
+
+Here are some examples of running custom hooks before and after the kubectl commands.
+
+.kubes/config/kubectl/hooks.rb
+
+```ruby
+before("apply",
+  execute: "kubectl apply -f .kubes/shared/namespace.yaml",
+)
+
+after("delete",
+  execute: "echo 'delete hook',
+)
+```
+
+You can use hooks to do things that may not make sense to do in the `.kubes/resources` definition. Here's an example of automatically creating the namespace.
+
+.kubes/shared/namespace.yaml
+
+```yaml
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: demo
+```
+
+### exit on fail
+
+By default, if the hook commands fail, then terraspace will exit with the original hook error code.  You can change this behavior with the `exit_on_fail` option.
+
+```ruby
+before("apply"
+  execute: "/command/will/fail/but/will/continue",
+  exit_on_fail: false,
+)
+```

data/docs/_docs/dsl/resources/backend_config.md

@@ -3,7 +3,7 @@ title: BackendConfig
 categories: dsl
 ---
 
-A BackendConfig is [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that allow you to further customize the load balancer.
+A [BackendConfig](https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#create_backendconfig) is [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) that allow you to further customize the load balancer.
 
 Here's an example of a BackendConfig.
 

data/docs/_docs/intro.md

@@ -9,7 +9,8 @@ title: What is Kubes?
 * 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 %}).
-* CLI Customizations: You can customize the [cli args]({% link _docs/config/kubectl.md %}). You can also run hooks before and after kubectl commands.
+* CLI Customizations: You can customize the [cli args]({% link _docs/config/kubectl/args.md %}). You can also run [hooks]({% link _docs/config/kubectl/hooks.md %}) before and after kubectl 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/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/auto-context.md %}).
+* 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/_docs/misc/separate-steps.md

@@ -0,0 +1,21 @@
+---
+title: Separate Steps
+---
+
+Sometimes you may want to run the 3 separate kubes steps directly. This may be useful if you are setting up CI/CD and need more control over the build process. Here are the 3 main steps:
+
+To build and push the docker image:
+
+    kubes docker build
+    kubes docker push
+
+Note, you must run a `kubes docker build` at least once. As the build step will store the image name in a `.kubes/state/docker_image.txt ` file for later use.
+
+To compile the Kubernetes YAML files.
+
+    kubes compile
+
+To apply the Kubernetes YAML files in the correct order and create resources on the cluster:
+
+    kubes apply
+

data/docs/_includes/sidebar.html

@@ -55,7 +55,12 @@
         <ul>
           <li><a href="{% link _docs/config/docker.md %}">Docker</a></li>
           <li><a href="{% link _docs/config/env.md %}">Env</a></li>
-          <li><a href="{% link _docs/config/kubectl.md %}">Kubectl</a></li>
+          <li><a href="{% link _docs/config/kubectl.md %}">Kubectl</a>
+            <ul>
+              <li><a href="{% link _docs/config/kubectl/args.md %}">Args</a></li>
+              <li><a href="{% link _docs/config/kubectl/hooks.md %}">Hooks</a></li>
+            </ul>
+          </li>
           <li><a href="{% link _docs/config/builder.md %}">Builder</a></li>
         </ul>
       </li>
@@ -92,8 +97,12 @@
           <li><a href="{% link _docs/extra-env/dsl.md %}">DSL</a></li>
         </ul>
       </li>
-      <li><a href="{% link _docs/kustomize.md %}">Kustomize Support</a></li>
-      <li><a href="{% link _docs/auto-context.md %}">Auto Context</a></li>
+      <li>Misc
+        <ul>
+          <li><a href="{% link _docs/misc/kustomize.md %}">Kustomize Support</a></li>
+          <li><a href="{% link _docs/misc/separate-steps.md %}">Separate Steps</a></li>
+          <li><a href="{% link _docs/misc/auto-context.md %}">Auto Context</a></li>
+        </ul>
       <li>CI/CD
         <ul>
           <li><a href="{% link _docs/ci/cloudbuild.md %}">CloudBuild</a></li>

data/docs/_reference/kubes-exec.md

@@ -21,13 +21,20 @@ The exec command finds the latest pod from the deployment and runs `kubectl exec
 
 ## Multiple Deployments
 
-If you have have multiple deployments in your `.kubes/resources` then the command will use the first deployment by default. You can specify the specfic deployment with the `--name` option.  Examples:
+If you have have multiple deployments in your `.kubes/resources` then the command will use the first deployment by default. You can specify the specfic deployment with the `--name` or `-n` option.  Examples:
 
-    kubes exec --name demo-web
-    kubes exec --name demo-clock
-    kubes exec --name demo-worker
-    kubes exec --name demo-web sh
-    kubes exec --name demo-web ls -l
+    kubes exec --name web
+    kubes exec -n web
+    kubes exec -n clock
+    kubes exec -n worker
+    kubes exec -n web sh
+    kubes exec -n web ls -l
+
+## Multiple Pod Containers
+
+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
 
 
 ## Options
@@ -36,6 +43,7 @@ If you have have multiple deployments in your `.kubes/resources` then the comman
     [--compile], [--no-compile]  # whether or not to compile the .kube/resources
                                  # Default: true
 n, [--name=NAME]                 # 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

@@ -20,6 +20,7 @@ a, --app=APP                     # Docker repo name. Example: web. Generates .ku
 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
     [--verbose], [--no-verbose]  
     [--noop], [--no-noop]        
 ```

data/docs/_reference/kubes-logs.md

@@ -18,6 +18,7 @@ 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
+c, [--container=CONTAINER]       # Container name. If omitted, the first container in the pod will be chosen
 f, [--follow], [--no-follow]     # Follow logs
                                  # Default: true
     [--verbose], [--no-verbose]  

data/lib/kubes/cli/get.rb

@@ -3,8 +3,9 @@ class Kubes::CLI
     def run
       compile
       Kubes::Kubectl.run(:get, @options)
+      return unless @options[:show_pods]
       pods = Kubes::Kubectl::Fetch::Pods.new(@options)
-      pods.show if @options[:show_pods]
+      pods.show
     end
   end
 end

data/lib/kubes/kubectl/fetch/base.rb

@@ -18,7 +18,7 @@ module Kubes::Kubectl::Fetch
       kubectl = Kubes::Kubectl.new(:get, @options.merge(o)) # kubes get -f .kubes/output
       resp = kubectl.run
       data = JSON.load(resp)
-      data['items']
+      data['items'] || [] # Note: When fetching only 1 resource, items is not part of structure
     end
   end
 end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/lib/templates/dsl/.kubes/resources/web/deployment.rb

@@ -1,7 +1,7 @@
 name "web"
 labels(role: "web")
 
-replicas 1
+replicas 1 # overridden on a env basis
 image built_image # IE: user/<%= app %>:kubes-2020-06-13T19-55-16-43afc6e
 
 # revisionHistoryLimit 1 # uncomment to reduce old ReplicaSets, default is 10 https://bit.ly/3hqrzyP

data/lib/templates/yaml/.kubes/resources/web/deployment.yaml.tt

@@ -5,7 +5,7 @@ metadata:
   labels:
     role: web
 spec:
-  replicas: 1
+  replicas: 1  # overridden on a env basis
   selector:
     matchLabels:
       role: web

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -232,13 +232,14 @@ files:
 - docs/README.md
 - docs/Rakefile
 - docs/_config.yml
-- docs/_docs/auto-context.md
 - docs/_docs/ci/cloudbuild.md
 - docs/_docs/config.md
 - docs/_docs/config/builder.md
 - docs/_docs/config/docker.md
 - docs/_docs/config/env.md
 - docs/_docs/config/kubectl.md
+- docs/_docs/config/kubectl/args.md
+- docs/_docs/config/kubectl/hooks.md
 - docs/_docs/contributing.md
 - docs/_docs/dsl.md
 - docs/_docs/dsl/multiple-resources.md
@@ -269,7 +270,6 @@ files:
 - docs/_docs/intro/ordering.md
 - docs/_docs/intro/ordering/custom.md
 - docs/_docs/intro/structure.md
-- docs/_docs/kustomize.md
 - docs/_docs/layering.md
 - docs/_docs/layering/dsl.md
 - docs/_docs/layering/merge.md
@@ -294,6 +294,9 @@ files:
 - docs/_docs/learn/yaml/next-steps.md
 - docs/_docs/learn/yaml/review-project.md
 - docs/_docs/learn/yaml/update.md
+- docs/_docs/misc/auto-context.md
+- docs/_docs/misc/kustomize.md
+- docs/_docs/misc/separate-steps.md
 - docs/_docs/next-steps.md
 - docs/_docs/patterns.md
 - docs/_docs/patterns/clock-web-worker.md