kubes 0.7.4 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4af2cf517b3700069f8a144a3f5baf8daa06622b2eb01233010e7bb5c767d9f5
-  data.tar.gz: 42db274bfee2d38aa21487f2ffec104496174f7bbaff124437e2dd0807493708
+  metadata.gz: 55d217f4b05371a806a18151034bf36ff420fbc6724f1367c441d337a3ed71ad
+  data.tar.gz: 31912f0fb17ac8bb91acbc03cbb3cbbcd5f769170535ca7a48ea5dfe61aa0e40
 SHA512:
-  metadata.gz: d7a6237881ee0e3bf0e87eb71badacb44be99b57f422a8ee703f475a5dc433c13b4ec4425018a40fbf869dca72253d32211edc7f04cf90d78496422370a9e81f
-  data.tar.gz: dbea974415833b5d340ca6f02dfc2b6d9557eb7b461f33ac6775cafcec7b9a05523a7944df54b53ed3a05aba31bb9c67520c3a887bb3aac1273051e59977b902
+  metadata.gz: da80f1de9af4f31ae3b449261591979e499a70f29c85bea4aa2e87d2c4efba8c63ef6c09cd71a423e5164ed5f8598062d3ffbcb6cc5fb01855484a29794026d8
+  data.tar.gz: 926c67bb5cdef8be996b8ded90a251f4ef6643ea40aaa1a817ed596d6482dc1cfcecd6f99322730c0a68df5c113e7708b0c1222abdea2e299bcc79779cda2916

data/CHANGELOG.md

@@ -3,6 +3,22 @@
 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.7.8] - 2021-10-29
+- [#54](https://github.com/boltops-tools/kubes/pull/54) fix configMap and secret hash when not first element in Array
+
+## [0.7.7] - 2021-10-21
+- [#51](https://github.com/boltops-tools/kubes/pull/51) add hash checksum for tls secretName
+- [#52](https://github.com/boltops-tools/kubes/pull/52) add role all layer to pre_layers
+- [#53](https://github.com/boltops-tools/kubes/pull/53) Merger options
+
+## [0.7.6] - 2021-10-12
+- remove init yaml templates, removed duplication
+- write full.yaml to .kubes/tmp instead
+
+## [0.7.5] - 2021-06-03
+- [#47](https://github.com/boltops-tools/kubes/pull/47) add search
+- [#48](https://github.com/boltops-tools/kubes/pull/48) use deep_merge overwrite_arrays option fixes #45
+
 ## [0.7.4] - 2021-03-02
 - [#46](https://github.com/boltops-tools/kubes/pull/46) call run method to respect config.suffix_hash
 

data/README.md

@@ -8,15 +8,17 @@
 
 [![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
-Kubernetes Deployment Tool: build docker image, compile Kubernetes YAML files, and apply them.
+Kubernetes App Deploy Tool: build docker image, compile Kubernetes YAML files, and apply them.
+
+Please **watch/star** this repo to help grow and support the project.
 
 Official Docs Site: [kubes.guru](https://kubes.guru)
 
 Kubes will:
 
 1. Build the docker image and push it to repo
-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
+2. Compile Kubernetes YAML files from YAML/ERB or a DSL with built Docker image
+3. Deploy via `kubectl apply` on the compiled Kubernetes YAML files
 
 ## Usage
 
@@ -40,7 +42,7 @@ Now, use `kubectl` directly in the proper order:
     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.
+You can also apply with kubes. This will automatically compile the files also.
 
     kubes apply
 
@@ -48,7 +50,7 @@ The deploy command, does all 3 steps: builds the docker image, compiles the `.ku
 
     kubes deploy
 
-## Multiple Enviroments
+## Multiple Environments
 
 You can easily create multiple environments with the same YAML configs. Example:
 

data/docs/_docs/config/reference.md

@@ -20,3 +20,4 @@ repo_auto_auth | Whether or not to try to auth authorize docker repo registry if
 skip | List of resources to skip. Can also be set with the `KUBES_SKIP` env var. `KUBES_SKIP` should be a list of strings separated by spaces. It adds onto the `config.skip` option. | []
 state.path | Where to store the state file with the last build Docker image. | .kubes/state/KUBES_ENV/data.json
 suffix_hash | Whether or not to append suffix hash to ConfigMap and Secret | true
+merger.options | Merger options that control how Hashes are merged. More info: [Merger Options]({% link _docs/layering/merge-options.md %}) | `{overwrite_arrays: true}`

data/docs/_docs/dsl/resources.md

@@ -6,7 +6,7 @@ Here's a list of the resources supported by the Kubes DSL.
 
 {% assign docs = site.docs | where: "categories","dsl" %}
 {% for doc in docs -%}
-* [{{ doc.nav_text }}]({{ doc.url }})
+* [{{ doc.title }}]({{ doc.url }})
 {% endfor %}
 
 For resources, that are not supported, you can use the [Generic resource]({% link _docs/dsl/resources/generic.md %}) or use [YAML]({% link _docs/yaml.md %}) instead. You can use a mix of DSL and YAML definitions in the `.kubes/resources` folder.

data/docs/_docs/dsl.md

@@ -58,9 +58,9 @@ Notice how `port` and `targetPort` correspond to `spec.ports.port` and `spec.por
 
 In general:
 
-* The DSL methods behave as reader methods when no arguments are passed to it. IE: `name "demo-web"` sets the value.
-* The DSL methods behave as writer methods when arguments are passed to it. IE: `name` returns the value.
+* The DSL methods behave as reader methods when no arguments are passed to it. IE: `name` returns the value.
+* The DSL methods behave as writer methods when arguments are passed to it. IE: `name "demo-web"` sets the value.
 
 ## Merge Behavior
 
-Generally, the merge should behave as expected. For example, map or Hash fields are merged together from multiple layers. Strings are simply replaced. See more details at [Layering Merge Behavior]({% link _docs/layering/merge.md %})
+Generally, the merge should behave as expected. For example, map or Hash fields are merged together from multiple layers. Strings are simply replaced. See more details at [Layering Merge Behavior]({% link _docs/layering/merge-dsl.md %})

data/docs/_docs/intro/how-kubes-works.md

@@ -20,6 +20,8 @@ The deploy command simpifily does all 3 steps: build, compile, and apply.
 
     kubes deploy
 
+Kubes is very transparent about it does.  It prints out the `kubectl` commands as they are being called.
+
 You can also run the `kubectl apply` only. The `kube apply` command compiles but will skip the docker build stage if it's already been built.
 
     kubes apply

data/docs/_docs/intro/structure.md

@@ -34,10 +34,10 @@ Here's what a .kubes folder structure can look like this:
 
 Name | Description
 --- | ---
-base | The base folder is processed first and can be used to define common fields and resources. Learn more on the [Layering Docs]({% link _docs/layering.md %}).
 config | The config folder can be used to configure behavior of Kubes.  The [docker]({% link _docs/config/docker.md %}) config is used to customize the docker command. The [env]({% link _docs/config/env.md %}) config is used to override `config.rb` settings on a `KUBES_ENV` basis. The [kubectl]({% link _docs/config/kubectl.md %}) config is used to customize the kubectl command.
 config.rb | The main thing to configure here is the repo to push the docker image to.
 output | Where kubes builds and writes the Kubernetes YAML to.
 resources | Where you define your Kubernetes resources.
-shared | The shared folder is where you can put shared resources. This folder gets applied first. More info: [Ordering]({% link _docs/intro/ordering.md %}).
+resources/base | The base folder is processed first and can be used to define common fields and resources. Learn more on the [Layering Docs]({% link _docs/layering.md %}).
+resources/shared | The shared folder is where you can put shared resources. This folder gets applied first. More info: [Ordering]({% link _docs/intro/ordering.md %}).
 state | Temporary state info that stores the built Docker image name.

data/docs/_docs/layering/merge-options.md

@@ -0,0 +1,76 @@
+---
+title: Merge Options
+---
+
+Underneath the hood, Kubes uses the [danielsdeleo/deep_merge](https://github.com/danielsdeleo/deep_merge) library to merge layers together. You can control the merge behavior options with [config.merger.options]({% link _docs/config/reference.md %}).
+
+The default merge options is:
+
+    {overwrite_arrays: true}
+
+You can control the merge behavior by setting:
+
+.kubes/config.rb
+
+```ruby
+Kubes.configure do |config|
+  # ...
+  config.merger.options = {overwrite_arrays: false}
+end
+```
+
+See the [danielsdeleo/deep_merge](https://github.com/danielsdeleo/deep_merge) docs for the different options.
+
+## Example of overwrite_arrays false
+
+An example of where you might want to use `{overwrite_arrays: false}` is if you are using YAML and want a base sidecar container in all of your deployments.
+
+.kubes/resources/base/deployment.yaml
+
+```yaml
+spec:
+  template:
+    spec:
+      containers:
+      - name: sidecar
+        image: sidecar-image
+```
+
+.kubes/resources/web/deployment.yaml
+
+```yaml
+spec:
+  template:
+    metadata:
+      labels:
+        role: web
+    spec:
+      containers:
+      - name: web
+        image: <%= docker_image %>
+```
+
+Produces:
+
+```yaml
+# ...
+spec:
+  template:
+    metadata:
+      labels:
+        role: web
+    spec:
+      containers:
+      - name: sidecar
+        image: sidecar-image
+      - name: web
+        image: gcr.io/boltops-learn/demo:kubes-2021-10-21T18-06-48
+# ...
+```
+
+However, using this merge behavior will also add additional ports if you are assigning a `targetPort` in the DSL. See:
+
+* [DSL in service creates always default port 80 #45](https://github.com/boltops-tools/kubes/issues/45)
+* [use deep_merge overwrite_arrays option #48](https://github.com/boltops-tools/kubes/pull/48)
+
+Will welcome PRs for improvements.

data/docs/_docs/layering.md

@@ -7,4 +7,4 @@ Kubes supports layering files together so you can use the same Kubernetes files
 * [YAML Layering]({% link _docs/layering/yaml.md %})
 * [DSL Layering]({% link _docs/layering/dsl.md %})
 * [Mix Layering]({% link _docs/layering/mix.md %})
-* [Merge Behavior]({% link _docs/layering/merge.md %})
+* [Merge Behavior]({% link _docs/layering/merge-dsl.md %})

data/docs/_docs/vs/helm.md

@@ -4,7 +4,7 @@ nav_text: Helm
 categories: vs
 ---
 
-Though both Kubes and Helm can be used to deploy applications to Kubernetes, they work quite differently.  Kubernetes is more focused on deploying your application. Helm is more like a package manager.
+Kubes and Helm are quite different.  Helm is a package manager tool. In contrast, Kubernetes is focused on deploying your application. While you can use package manager tools like Helm to deploy your application, application-focused deploy tools are better for the job. For example, apt-get and yum are also package manager tools. But few companies use `apt-get install` or `yum install` to deploy their application code. Instead, people usually use application-specific tools to deploy their web app.
 
 {% include vs/article.md %}
 
@@ -168,7 +168,7 @@ Helm supports a wide variety of hooks for the install, delete, upgrade, and roll
 
 Kubes also supports hook as the kubes-level; this is similar to the helm-level. Kubes also provide finer-grain control hooks at the kubectl-level.
 
-Overally, Helm and Kubes hooks work quite differently. We'll take a look at **some** examples:
+Overall, Helm and Kubes hooks work quite differently. We'll take a look at **some** examples:
 
 ### Helm Hook Example
 
@@ -240,4 +240,4 @@ Kubes supports the deployment workflow. It can build the docker image from your
 
 ## Summary
 
-Helm and Kubes are quite different. Helm is a full-fledge package management. Kubes is a more focused on deployment. Both tools support templating logic to help keep your code DRY. Additionally, Kubes supports layering to merge YAML files together for DRYness. Kubes also helps you build your Docker images.
+Helm and Kubes are quite different. Helm is a full-fledge package management tool. In contrast, Kubes is more focused on app deployment. Both tools support templating logic to help keep your code DRY. Additionally, Kubes supports layering to merge YAML files together for DRYness. Kubes also helps you build your Docker images.

data/docs/_includes/header.html

@@ -2,6 +2,13 @@
   <nav class="navbar navbar-expand-lg navbar-light bg-light border-bottom">
     <a class="navbar-brand" href="/"><img class="navbar-logo" src="/img/logos/kubes-black.png" /></a>
 
+    {% if page.url != '/' %}
+    <form class="search-form form-group has-search" method="get" action="/search" data-search-form>
+      <span class="fa fa-search form-control-feedback"></span>
+      <input type="text" class="form-control" name="q" id="q" placeholder="Search docs" data-search-input />
+    </form>
+    {% endif %}
+
     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>

data/docs/_includes/layering/layers.md

@@ -11,6 +11,7 @@ Here's an example structure, so we can understand how layering works.
     ├── clock
     │   └── deployment.{{ include.ext }}
     └── web
+        ├── all.{{ include.ext }}
         ├── deployment
         │   ├── dev.{{ include.ext }}
         │   └── prod.{{ include.ext }}
@@ -34,16 +35,17 @@ Notes
 
 Here's a table showing the the full layering.
 
-Folder/Pattern     | Example
--------------------|--------------------------------------------
-base/all.{{ include.ext }}       | base/all.{{ include.ext }}
-base/all/ENV.{{ include.ext }}   | base/all/dev.{{ include.ext }}
-base/KIND.{{ include.ext }}      | base/deployment.{{ include.ext }}
-base/KIND/base.{{ include.ext }} | base/deployment/base.{{ include.ext }}
-base/KIND/ENV.{{ include.ext }}  | base/deployment/dev.{{ include.ext }}
-ROLE/KIND.{{ include.ext }}      | web/deployment.{{ include.ext }}
-ROLE/KIND/base.{{ include.ext }} | web/deployment/base.{{ include.ext }}
-ROLE/KIND/ENV.{{ include.ext }}  | web/deployment/dev.{{ include.ext }}
+Type | Folder/Pattern | Example
+---|---|---
+pre | base/all.{{ include.ext }}        | base/all.{{ include.ext }}
+pre | base/all/ENV.{{ include.ext }}    | base/all/dev.{{ include.ext }}
+pre | base/KIND.{{ include.ext }}       | base/deployment.{{ include.ext }}
+pre | base/KIND/base.{{ include.ext }}  | base/deployment/base.{{ include.ext }}
+pre | base/KIND/ENV.{{ include.ext }}   | base/deployment/dev.{{ include.ext }}
+pre | ROLE/all.{{ include.ext }}        | web/all.{{ include.ext }}
+main | ROLE/KIND.{{ include.ext }}      | web/deployment.{{ include.ext }}
+post | ROLE/KIND/base.{{ include.ext }} | web/deployment/base.{{ include.ext }}
+post | ROLE/KIND/ENV.{{ include.ext }}  | web/deployment/dev.{{ include.ext }}
 
 ## Real-World Uses
 

data/docs/_includes/reference.md

@@ -1,3 +1,3 @@
-Kubes is a Kubernetes deployment tool. It automates the deployment process. Kubes will:
+Kubes is a Kubernetes deployment tool. It focuses on deploying your specific application. It is very good at automating the deployment process. Kubes will:
 
 {% include kubes-steps.md %}

data/docs/_includes/sidebar.html

@@ -97,7 +97,8 @@
           <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>
+          <li><a href="{% link _docs/layering/merge-dsl.md %}">Merge DSL</a></li>
+          <li><a href="{% link _docs/layering/merge-options.md %}">Merge Options</a></li>
         </ul>
       </li>
       <li><a href="{% link _docs/dsl.md %}">DSL</a>

data/docs/_sass/theme.scss

@@ -315,3 +315,95 @@ ul.toc {
     height:100%;
   }
 }
+
+
+#search-field {
+  // background-color: purple;
+
+  td {
+    padding: 0;
+    margin: 0;
+    border: none;
+  }
+
+  table {
+    // background-color: orange;
+    border: none;
+    margin: 0;
+  }
+
+  .gsc-input-box td {
+    vertical-align: top;
+    // padding-top: 15px;
+  }
+}
+
+.search-result {
+  padding-bottom: 24px;
+}
+
+.search-tips {
+  border: 1px solid gray;
+  // background-color: red;
+  font-size: 0.9em;
+  padding: 10px;
+  margin-bottom: 15px;
+  p {
+    margin: 0;
+  }
+}
+
+.search-terms {
+  background-color: #ffffcb;
+  padding: 0.25em;
+}
+
+.search-count {
+  font-weight: bold;
+}
+
+
+.top-bar {
+  .has-search {
+    // mobile
+    // without padding-left its centered
+    margin: 0;
+    padding: 0;
+    width: 200px;
+    // desktop
+    @media (min-width: 500px) {
+      // without padding-left its centered
+      width: 320px;
+    }
+    @media (min-width: 600px) {
+      // without padding-left its centered
+      width: 400px;
+    }
+    @media (min-width: 768px) {
+      padding-left: 64px;
+      width: 512px;
+    }
+
+
+    .form-control-feedback {
+      position: absolute;
+      z-index: 2;
+      width: 2.375rem;
+      height: 2.375rem;
+      line-height: 2.375rem;
+      text-align: center;
+      pointer-events: none;
+      color: #aaa;
+    }
+
+    .form-control {
+      padding-left: 2.375rem;
+      width: 100%;
+      display: inline;
+    }
+
+    input {
+      width: auto;
+    }
+  }
+}

data/docs/index.html

@@ -9,8 +9,8 @@ sidebar: false
       <div class="col-sm-8 col-sm-offset-2">
         <div class="header-content">
           <div class="header-content-inner">
-            <h1>Kubes: Kubernetes Deployment Tool</h1>
-            <h2>Kubes is a Kubernetes Deployment Tool. It builds the docker image, creates the Kubernetes YAML, and runs kubectl apply. It automates the deployment process and saves you precious finger-typing energy.</h2>
+            <h1>Kubes: Kubernetes App Deploy Tool</h1>
+            <h2>Kubes is a Kubernetes App Deployment Tool. It focuses on deploying your specific application. It builds the docker image, creates the Kubernetes YAML, and runs kubectl apply. It automates the deployment process and saves you precious finger-typing energy.</h2>
           </div>
         </div>
       </div>

data/docs/search/data.json

@@ -0,0 +1,44 @@
+---
+layout: null
+---
+{% assign first = true %}
+[
+{% for doc in site.docs %}
+    {% if doc.title != null and doc.title != empty %}
+    {% unless first %},{% endunless %}{
+        "title": {{doc.title | jsonify}},
+        "search_title": {{doc.search_title | jsonify}},
+        "content": {{doc.content | markdownify | strip_html | replace:'├','' | replace:'└','' | replace:'─','' | replace:'│','' | jsonify}},
+        "link": "{{ site.baseurl }}{{ doc.url }}",
+        "search_omit": "{{ doc.search_omit }}"
+    }
+    {% assign first = false %}
+    {% endif %}
+{% endfor %}
+
+{% for post in site.posts %}
+    {% if post.title != null and post.title != empty %}
+    {% unless first %},{% endunless %}{
+        "title": {{post.title | jsonify}},
+        "search_title": {{doc.search_title | jsonify}},
+        "content": {{post.content | markdownify | strip_html | jsonify}},
+        "link": "{{ site.baseurl }}{{ post.url }}",
+        "search_omit": "{{ post.search_omit }}"
+    }
+    {% assign first = false %}
+    {% endif %}
+{% endfor %}
+
+{% for page in site.pages %}
+    {% if page.title != null and page.title != empty %}
+    {% unless first %},{% endunless %}{
+        "title": {{page.title | jsonify}},
+        "search_title": {{doc.search_title | jsonify}},
+        "content": {{page.content | markdownify | strip_html | jsonify}},
+        "link": "{{ site.baseurl }}{{ page.url | replace: 'index.html', '' }}",
+        "search_omit": "{{ page.search_omit }}"
+    }
+    {% assign first = false %}
+    {% endif %}
+{% endfor %}
+]

data/docs/search/index.html

@@ -0,0 +1,30 @@
+---
+title: Search
+search_omit: true
+---
+
+<div class="search-tips">
+  <h3>Search Tips:</h3>
+  <p>To OR search terms: "install aws"</p>
+  <p>To AND search terms: "+install +aws"</p>
+  <p>To filter or reject search terms: "-aws"</p>
+  <p>More: <a href="{% link search/tips.md %}">Search Tips</a></p>
+</div>
+
+<!-- Search results placeholder -->
+<p class="search-summary" data-search-found>
+  <span class="search-count" data-search-found-count></span> <span data-search-found-word>results</span> found for: <span class="search-terms" data-search-found-term></span>
+</p>
+<div data-search-results></div>
+
+<!-- Search result template -->
+<script type="text/x-template" id="search-result">
+  <div class="search-result">
+    <h3><a href="##Url##">##Title##</a></h3>
+    <div class="content">##Content##</div>
+  </div>
+</script>
+
+<!-- Search script - Must appear after template -->
+<script src="/search/lunr.js"></script>
+<script src="/search/search.js"></script>