kubes 0.4.7 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2e59aafa5ea2023bdf23dc43ba38c5279dcd719c3db793eca0abf24c8e1da2
-  data.tar.gz: ed004f619cba70d0d6257ca9559b3fd1b1fa7cb6c48943c64c3abcb8cddf3d38
+  metadata.gz: 4068263aefa8212b17485e3a257813b806e0efc0617c01e7210db576759c2f27
+  data.tar.gz: e649b39644516f59a09c08ec33d05c9ceb9adde006c6bda386f370bec8e205d8
 SHA512:
-  metadata.gz: 7be4d6f0bd67e15b9ba3e3594f1b98d36c3fb5a4cc68c67fd603a75a973e4b90f8800a0a8fddf68951d0f3f09291c154bae5066830ec792aa167eb8675f5acca
-  data.tar.gz: 6187e6b6bc29e1a038f8c5a20530483a120cc6107854f718f8570648334f27cb7b4afb1a39d4d45ede4bb3cda97e8cc66d63c1cbbdde27a059997f65bd547704
+  metadata.gz: 0f65b2736c9967eee1a24b65513bed5bb79177c54f8870871e1428e4ba6ff4b2e2501e5d6a1a78ada9f2db971763a6b1f6d35b4818fcfaf76df95baa37aba049
+  data.tar.gz: cfb8c9a0371d7efd6e9a4d8deeb1c503a18c63fd291a0a89275b9bf84996fa7a6ce7f3dfc7c83e8ff98546fc94c80a65bf41f953121833b0f3614c5a635098de

data/CHANGELOG.md

@@ -3,6 +3,34 @@
 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.2]
+- [#36](https://github.com/boltops-tools/kubes/pull/36) add plugin hooks support
+
+## [0.6.1]
+- update gemspec dependency to plugins that provide the secrets helpers
+
+## [0.6.0]
+- [#35](https://github.com/boltops-tools/kubes/pull/35) mix layering support: evaluate DSL so layering can be mixed between YAML and DSL docs: https://kubes.guru/docs/layering/mix/
+- custom variables support: docs https://kubes.guru/docs/variables/basic/
+- custom helpers support: docs https://kubes.guru/docs/helpers/custom/
+- plugins helpers support
+- generators: new resource, new helper, new variable
+- setup autoloader earlier. removes need for shims
+- auth login for gcr also
+- fix cli -h when not within Kubes project
+
+## [0.5.1]
+- fix deployment generator
+
+## [0.5.0]
+- #34 Generators, docker_image helper, check project, also write full.yaml #34
+- new generators: docs: https://kubes.guru/docs/generators/
+- `docker_image` helper. deprecated `built_image`. `config.image` option support.
+- check_project: check within a Kubes project
+- job dsl
+- kubes compile: auto run docker build and push when if needed
+- also write .kubes/output/full.yaml
+
 ## [0.4.7]
 - #33 improve switch context: earlier and only when needed
 

data/README.md

@@ -18,13 +18,6 @@ Kubes will:
 2. Compile Kubernetes YAML files from YAML/ERB or a DSL and adjusts the Docker build image
 3. Deploy via kubectl apply on the compiled Kubernetes YAML files
 
-Features:
-
-* Automation: [Builds the Docker image](docs/docker.md) and updates the compiled YAML files
-* Syntactic Sugar: Use an optional [ERB/YAML](docs/yaml.md) or [DSL](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](docs/layering.md).
-* CLI Customizations: You can customize the [cli args](docs/kubectl.md). You can also run hooks before and after kubectl commands.
-
 ## Usage
 
     kubes init # creates .kubes structure
@@ -44,8 +37,8 @@ In fact, you can use Kubes to build the files first, and then run `kubectl` dire
 Now, use `kubectl` directly in the proper order:
 
     kubectl apply -f .kubes/output/shared/namespace.yaml
-    kubectl apply -f .kubes/output/web/deployment.yaml
     kubectl apply -f .kubes/output/web/service.yaml
+    kubectl apply -f .kubes/output/web/deployment.yaml
 
 You can also apply with kubes. This will compile the automatically files also.
 
@@ -55,10 +48,63 @@ The deploy command, does all 3 steps: builds the docker image, compiles the `.ku
 
     kubes deploy
 
+## Multiple Enviroments
+
+You can easily create multiple environments with the same YAML configs. Example:
+
+    KUBES_ENV=dev  kubes deploy
+    KUBES_ENV=prod kubes deploy
+
+See: [Multiple Enviroments Pattern](https://kubes.guru/docs/patterns/multiple-envs/)
+
+## Generators: Stop Writing Boilerplate
+
+Your time is precious. Why are we copying and pasting boilerplate structure in this day and age?
+
+Kubes provides generators to help you get going right away.
+
+Resources examples:
+
+    $ kubes new resource secret
+          create  .kubes/resources/shared/secret.yaml
+    $ kubes new resource service_account
+          create  .kubes/resources/shared/service_account.yaml
+
+Kubes components examples:
+
+    $ kubes new helper
+          create  .kubes/helpers/custom_helper.rb
+    $ kubes new variable
+          create  .kubes/variables/dev.rb
+    $
+
+## Features
+
+* Automation: [Builds the Docker image](https://kubes.guru/docs/config/docker/) and updates the compiled YAML files
+* Syntactic Sugar: Use an [ERB/YAML](https://kubes.guru/docs/yaml/) or a [DSL](https://kubes.guru/docs/dsl/) 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](https://kubes.guru/docs/layering/).
+* Secrets: Use helpers like [aws_secret](https://kubes.guru/docs/helpers/aws/secrets/), [aws_ssm](https://kubes.guru/docs/helpers/aws/ssm/), and [google_secret](https://kubes.guru/docs/helpers/google/secrets/) 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](https://kubes.guru/docs/generators/).
+* CLI Customizations: You can customize the [cli args](https://kubes.guru/docs/config/args/kubectl/).
+* Hooks: You can also run [hooks](https://kubes.guru/docs/config/hooks/) before and after [kubes](https://kubes.guru/docs/config/hooks/kubes/) and [kubectl](https://kubes.guru/docs/config/hooks/kubectl/) commands.
+* Automated Suffix Hashes: Automatically appends a suffix hash to ConfigMap and Secret resources. More details in [ConfigMap](https://kubes.guru/docs/dsl/resources/config_map/) and [Secret](https://kubes.guru/docs/dsl/resources/secret/) docs.
+* Kustomize Support: If you're a kustomization user, you can use it with Kubes. More details in [Kustomize Support Docs](https://kubes.guru/docs/misc/kustomize/).
+* 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](https://kubes.guru/docs/misc/auto-context/).
+* Ordering: Kubes run kubectl apply to create resources in the [correct order](https://kubes.guru/docs/intro/ordering/). For deleting, it kubes will run `kubectl delete` in the correct reverse order. The order is also [customizable](https://kubes.guru/docs/intro/ordering/custom/).
+
 ## Installation
 
 Install with:
 
     gem install kubes
 
+## Comparison
+
+Here are some useful comparisons to help you compare Kubes vs other tools in the ecosystem:
+
+* Blog Post: [Kustomize vs Helm vs Kubes: Kubernetes Deploy Tools](https://blog.boltops.com/2020/11/05/kustomize-vs-helm-vs-kubes-kubernetes-deploy-tools)
+* [Kubes vs Custom Solution](https://kubes.guru/docs/vs/custom/)
+* [Kubes vs Helm](https://kubes.guru/docs/vs/helm/)
+* [Kubes vs Kustomize](https://kubes.guru/docs/vs/kustomize/)
+
 For more info: [kubes.guru](https://kubes.guru)

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

@@ -13,6 +13,7 @@ Hook | Description
 compile | When kubes compiles the `.kubes/resources` to `.kubes/output`.
 apply | When kubes runs all the `kubectl apply` commands.
 delete | When kubes runs all the `kubectl delete` commands.
+prune | When kubes prunes. IE: To clean old secrets.
 
 ## Lifecycle At Kubes Level
 

data/docs/_docs/config/reference.md

@@ -6,6 +6,7 @@ Name | Description | Default
 ---|---|---
 auto_prune | Prune and delete old hashed resources like Secret and ConfigMap. | true
 builder | What docker build command to use. Can use `docker` or `gcloud` to build the Docker image. | docker
+image | Set a prebuilt Docker image to use. This is optional. Usually, you want to build an image from the Dockerfile.  Setting this will change the `docker_image` helper to use a predefined image. See: [Docker Image]({% link _docs/intro/docker-image.md %}) | nil
 kubectl.context | What kubectl context to auto-switch to. | nil
 kubectl.context_keep | Whether or not to keep the context switched | true
 kubectl.exit_on_fail.apply  | Whether or not continue if the `kubectl apply` fails. Note, can use `KUBES_EXIT_ON_FAIL=0` env var to set to false. | true

data/docs/_docs/config/skip.md

@@ -20,7 +20,7 @@ spec:
     spec:
       containers:
       - name: cleanup
-        image: <%= built_image %>
+        image: <%= docker_image %>
         command: ["bin/cleanup.sh"]
       restartPolicy: Never
 ```

data/docs/_docs/dsl/multiple-resources.md

@@ -39,7 +39,9 @@ Using multiple files is the general recommended approach.
 
 ## Multiple Resources: Block Form
 
-You can also use a block form to create multiple resources.  You name the resource files with plural names. An example helps explain:
+You can also use a block form to create multiple resources.  The multiple resources block form is an experimental feature.
+
+You name the resource files with plural names. An example helps explain:
 
     .kubes
     └── resources
@@ -51,13 +53,13 @@ You can also use a block form to create multiple resources.  You name the resour
 deployment "demo-web" do
   labels(role: "web")
   replicas 1
-  image built_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
+  image docker_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
 end
 
 deployment "demo-web-2" do
   labels(role: "web")
   replicas 1
-  image built_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
+  image docker_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
 end
 ```
 
@@ -70,7 +72,7 @@ You can also mix and matched resources. When you use the block form, the file na
 deployment "demo-web" do
   labels(role: "web")
   replicas 1
-  image built_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
+  image docker_image # IE: user/demo:kubes-2020-06-13T19-55-16-43afc6e
 end
 
 service "demo-web" do

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

@@ -0,0 +1,62 @@
+---
+title: Job
+categories: dsl
+---
+
+## Example 1
+
+Here's an example of an job.
+
+.kubes/resources/migrate/job.rb
+
+```ruby
+name "<%= app %>"
+image(docker_image)
+```
+
+Produces:
+
+.kubes/output/migrate/job.yaml
+
+```yaml
+---
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: demo
+  labels:
+    app: demo
+  namespace: demo-dev
+spec:
+  template:
+    metadata:
+      labels:
+        app: demo
+    spec:
+      containers:
+      - image: 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:kubes-2020-10-26T20-25-43
+        name: demo
+```
+
+## DSL Methods
+
+Here's a list of more common methods:
+
+job.spec.template.spec.containers fields:
+
+* args
+* command
+* env
+* envFrom
+* image
+* imagePullPolicy
+* lifecycle
+* livenessProbe
+* containerName
+* ports
+* readinessProbe
+* volumeDevices
+* volumeMounts
+* workingDir
+
+{% include dsl/methods.md name="job" %}

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

@@ -19,7 +19,7 @@ data(
 
 Produces:
 
-.kubes/output/shared/service.yaml
+.kubes/output/shared/secret.yaml
 
 ```yaml
 apiVersion: v1
@@ -38,6 +38,23 @@ data:
 
 {% include dsl/rolling_deployment.md kind="Secret" %}
 
+.kubes/resources/web/deployment.yaml:
+
+```yaml
+# ..
+spec:
+  template:
+    spec:
+      containers:
+      - name: demo
+        image: nginx
+        envFrom:
+        - secretRef:
+            name: demo-secret
+```
+
+Produces:
+
 .kubes/output/web/deployment.yaml:
 
 ```yaml
@@ -46,7 +63,7 @@ spec:
   template:
     spec:
       containers:
-      - name: demo-shared
+      - name: demo
         image: nginx
         envFrom:
         - secretRef:

data/docs/_docs/extra-env/dsl.md

@@ -14,7 +14,7 @@ labels(role: "web")
 namespace with_extra("default")
 
 replicas 1
-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
 ```
 
 .kubes/resources/web/service.rb
@@ -50,7 +50,7 @@ labels(app: name, extra: extra)
 namespace "default"
 
 replicas 1
-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
 ```
 
 .kubes/resources/web/service.rb

data/docs/_docs/extra-env/yaml.md

@@ -28,7 +28,7 @@ spec:
         app: demo
     spec:
       containers:
-      - image: <%= built_image %>
+      - image: <%= docker_image %>
         name: demo-web
 ```
 

data/docs/_docs/generators.md

@@ -0,0 +1,41 @@
+---
+title: Generators
+---
+
+Kubes ships with a few generators to help you get building with Kubernetes quickly.  The generated  starter YAML should be modified and customized for your needs.
+
+## Examples
+
+Here are a few examples:
+
+    $ kubes new resource ingress
+          create  .kubes/resources/web/ingress.yaml
+    $ kubes new resource service_account
+          create  .kubes/resources/shared/service_account.yaml
+    $
+
+Use `-h` to see the cli options:
+
+    kubes new resource -h
+
+## 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](https://github.com/boltops-tools/kubes/blob/master/lib/templates/new/resource/yaml) to all the resources that the generator supports.

data/docs/_docs/helpers.md

@@ -6,10 +6,10 @@ Kubes provides some helper methods to help write Kubernetes YAML files.  Here's
 
 Helper | Description
 --- | ---
-built_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource.
-decode64 | Basey64d decode a string.
+decode64 | Base64 decode a string.
+docker_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource. Note, this can be overridden with the `--image` cli option or the `Kubes.config.image` setting. See: [Docker Image]({% link _docs/intro/docker-image.md %})
 dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
-encode64 | Basey64 encode a string. Also available as `base64` method.
+encode64 | Base64 encode a string. Also available as `base64` method.
 extra | The `KUBES_EXTRA` value.
 with_extra | Appends the `KUBES_EXTRA` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
 
@@ -25,3 +25,17 @@ 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
+```

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

@@ -0,0 +1,10 @@
+---
+title: Advanced AWS Helpers
+nav_text: Advanced
+categories: helpers-aws
+---
+
+{% assign docs = site.docs | where: "categories","advanced-helpers-aws" %}
+{% for doc in docs -%}
+  * [{{ doc.nav_text }}]({{ doc.url }})
+{% endfor %}

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

@@ -0,0 +1,131 @@
+---
+title: AWS Secrets Advanced
+nav_text: Secrets
+categories: advanced-helpers-aws
+---
+
+This covers an advanced way so that Kubernetes Secrets are created from AWS Secrets Manager in a conventional way.
+
+## Simple Values
+
+For example if you have these secret values:
+
+    $ aws secretsmanager get-secret-value --secret-id demo/dev/db_user | jq '.SecretString'
+    user
+    $ aws secretsmanager get-secret-value --secret-id demo/dev/db_pass | jq '.SecretString'
+    pass
+
+Set up a [Kubes hook](https://kubes.guru/docs/config/hooks/kubes/).
+
+.kubes/config/hooks/kubes.rb
+
+```ruby
+secrets = KubesAws::Secrets.new(upcase: true, prefix: "demo/dev/")
+before("compile",
+  label: "Get secrets from AWS Secrets Manager",
+  execute: secrets,
+)
+```
+
+Then set the secrets in the YAML:
+
+.kubes/resources/shared/secret.yaml
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+<% KubesAws::Secrets.data.each do |k,v| -%>
+  <%= k %>: <%= base64(v) %>
+<% end -%>
+```
+
+This results in AWS secrets with the prefix the `demo/dev/` being added to the Kubernetes secret data.  The values are automatically base64 encoded. Produces:
+
+.kubes/output/shared/secret.yaml
+
+```yaml
+metadata:
+  namespace: demo
+  name: demo-2a78a13682
+  labels:
+    app: demo
+apiVersion: v1
+kind: Secret
+data:
+  db_pass: dGVzdDEK
+  db_user: dGVzdDIK
+```
+
+## JSON Values
+
+For example if you have these secret values:
+
+    $ aws secretsmanager get-secret-value --secret-id demo/dev/k2 | jq '.SecretString'
+    {\"a\":1,\"b\":2}"
+
+Set up a [Kubes hook](https://kubes.guru/docs/config/hooks/kubes/).
+
+.kubes/config/hooks/kubes.rb
+
+```ruby
+secrets = KubesAws::Secrets.new(prefix: "rails/dev/")
+before("compile",
+  label: "Get secrets from AWS Secrets Manager",
+  execute: secrets,
+)
+```
+
+Then set the secrets in the YAML:
+
+.kubes/resources/shared/secret.yaml
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+<% k2 = JSON.load(KubesAws::Secrets.data["k2"]) %>
+  a: <%= base64(k2["a"]) %>
+  b: <%= base64(k2["b"]) %>
+```
+
+Produces:
+
+```yaml
+metadata:
+  namespace: demo-dev
+  name: demo-a4cd604a95
+  labels:
+    app: demo
+apiVersion: v1
+kind: Secret
+data:
+  a: MQ==
+  b: Mg==
+```
+
+## Variables
+
+These environment variables can be set:
+
+Name | Description
+---|---
+AWS_SECRET_PREFIX | Prefixed used to list and filter AWS secrets. IE: `demo/dev/`.
+
+Secrets#initialize options:
+
+Variable | Description | Default
+---|---|---
+base64 | Automatically base64 encode the values. | false
+upcase | Automatically upcase the Kubernetes secret data keys. | false
+prefix | Prefixed used to list and filter AWS secrets. IE: `demo/dev/`. Can also be set with the `AWS_SECRET_PREFIX` env variable. The env variable takes the highest precedence. | nil
+
+{% include helpers/base64.md %}