kubes 0.1.0 → 0.2.0

data/docs/_includes/footer.html

@@ -0,0 +1,37 @@
+<footer>
+  <div class="container">
+    <div class="row">
+      <div class="footer-col col-md-4">
+        <h3>More Tools</h3>
+        <ul class="list-unstyled tools">
+          <li><a href="http://terraspace.cloud">Terraspace</a></li>
+          <li><a href="http://rubyonjets.com">Jets</a></li>
+          <li><a href="http://lono.cloud">Lono</a></li>
+          <li><a href="http://ufoships.com">Ufo</a></li>
+          <li><a href="http://sonic-screwdriver.cloud">Sonic</a></li>
+          <li><a href="http://jack-eb.com">Jack</a></li>
+        </ul>
+      </div>
+      <div class="footer-col col-md-4">
+        <h3><a href="https://boltops.com"><img class="footer-logo" src="/img/logos/boltops-logo-full.png" /></a></h3>
+        <ul class="list-inline">
+          {% for network in site.social %}
+          <li>
+            <a href="{{ network.url }}" class="btn-social btn-outline"><i class="fa fa-fw fa-{{ network.title }}"></i></a>
+          </li>
+        {% endfor %}
+        </ul>
+      </div>
+      <div class="footer-col col-md-4">
+        <h3>Contact</h3>
+        <p>{{ site.footer.contact }}</p>
+        <p>{{ site.footer.phone }}</p>
+      </div>
+    </div>
+  </div>
+  <div class="container">
+    <div class="footer-below">
+    <p>Maintained by {{ site.footer.copyright }}  20{{ site.time | date: '%y' }}</p>
+    </div>
+  </div>
+</footer>

data/docs/_includes/google_analytics.html

@@ -0,0 +1,10 @@
+<!-- Google analytics -->
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+</script>

data/docs/_includes/header.html

@@ -0,0 +1,31 @@
+<div class="top-bar">
+  <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>
+
+    <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>
+
+    <div class="collapse navbar-collapse" id="navbarSupportedContent">
+      <ul class="navbar-nav ml-auto mt-2 mt-lg-0">
+        <li class="nav-item"><a class="nav-link" href="{% link getting-started.md %}">Getting Started</a></li>
+        <li class="nav-item"><a class="nav-link" href="{% link _docs/intro.md %}">Docs</a></li>
+        <li class="nav-item"><a class="nav-link" href="{% link support.md %}">Support</a></li>
+        <li class="nav-item"><a class="nav-link" href="https://github.com/boltops-tools/kubes">GitHub</a></li>
+
+        <!--<li class="nav-item dropdown">-->
+        <!--  <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">-->
+        <!--    Dropdown-->
+        <!--  </a>-->
+        <!--  <div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdown">-->
+        <!--    <a class="dropdown-item" href="#">Action</a>-->
+        <!--    <a class="dropdown-item" href="#">Another action</a>-->
+        <!--    <div class="dropdown-divider"></div>-->
+        <!--    <a class="dropdown-item" href="#">Something else here</a>-->
+        <!--  </div>-->
+        <!--</li>-->
+
+      </ul>
+    </div>
+  </nav>
+</div>

data/docs/_includes/intro/install.md

@@ -0,0 +1,15 @@
+## RubyGems
+
+Install kubes via RubyGems.
+
+    gem install kubes
+
+Ruby 2.7 and patch variants of it is recommended.
+
+## kubectl
+
+Kubes calls kubectl. Kubes has been tested with kubectl v1.15+. Generally, it should work with most versions of kubectl.
+
+## docker
+
+Kubes calls docker. Kubes has been tested with docker 18.x-ce+. Generally, it should work with most versions of docker.

data/docs/_includes/js.html

@@ -0,0 +1,3 @@
+{% if site.google_analytics and jekyll.environment == "production" %}
+{% include google_analytics.html %}
+{% endif %}

data/docs/_includes/kubes-steps.md

@@ -0,0 +1,3 @@
+1. Build the docker image and push it to repo
+2. Compile Kubernetes YAML files with the Docker build image
+3. Deploy via kubectl apply on the compiled Kubernetes YAML files

data/docs/_includes/layering/layers.md

@@ -0,0 +1,64 @@
+Kubes Layering in it's full form allows you to keep your resource definitions DRY and create different environments with the same code.
+
+## Structure
+
+Here's an example structure, so we can understand how layering works.
+
+    .kubes/resources/
+    ├── base
+    │   ├── all.{{ include.ext }}
+    │   └── deployment.{{ include.ext }}
+    ├── clock
+    │   └── deployment.{{ include.ext }}
+    └── web
+        ├── deployment
+        │   ├── dev.{{ include.ext }}
+        │   └── prod.{{ include.ext }}
+        ├── deployment.{{ include.ext }}
+        └── service.{{ include.ext }}
+
+## Layering Basics
+
+To explain the layering, here's the general processing order that Kubes takes.
+
+1. The `.kubes/resources/base` folder is treated as a base layer.  It gets processed as pre-layers by Kubes.
+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, `base/all.rb` will not be combined with `web/deployment.yaml`.
+
+## Full Layering
+
+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 }}
+
+## Real-World Uses
+
+1. With Kubes layering you can define common fields in `base/all.{{ include.ext }}`. Examples: namespace, labels, annotations. If you have additional common base-level fields, but are specific to a Kind. Then you can defined them in `base/KIND.{{ include.ext }}`. Example: `base/deployment.{{ 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:
+
+    .kubes/resources/
+    ├── base
+    │   ├── all.{{ include.ext }}
+    │   └── deployment.{{ include.ext }}
+    └── web
+        ├── deployment
+        │   ├── dev.{{ include.ext }}
+        │   └── prod.{{ include.ext }}
+        ├── deployment.{{ include.ext }}
+        └── service.{{ include.ext }}

data/docs/_includes/learn/cluster.md

@@ -0,0 +1,22 @@
+You'll need a Kubernetes cluster and a Docker repo to be able to push to. Setting up a Kubernetes cluster is a little bit out scope for this tutorial. We'll provide the docs and links though. We'll also use an AWS EKS cluster and ECR.
+
+## Create an EKS cluster
+
+Here are the AWS docs to create an EKS cluster:
+
+* [Creating an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html)
+
+## Create an ECR Repo
+
+Here are the AWS docs to create a repo:
+
+* [Creating a Repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html)
+
+Here are also the commands to create an ECR repo:
+
+    aws ecr create-repository --repository-name demo
+    REPO=$(aws ecr describe-repositories --repository-name demo | jq -r '.repositories[].repositoryUri')
+
+We'll be using the `$REPO` variable for the rest of the tutorial.
+
+Note: Though we're using AWS here, Kubes works with any Cloud Provider. Please adjust your commands and the `$REPO` variable for your cloud provider.

data/docs/_includes/learn/next-steps.md

@@ -0,0 +1,6 @@
+You've seen how to get started with Kubes. From here, you can check out the Docs to learn more:
+
+* [Intro]({% link _docs/intro.md %}): General introduction.
+* [Layering]({% link _docs/layering.md %}): Use the same Kubernetes YAML to build multiple environments like dev and prod with [layering]({% link _docs/layering.md %}).
+* [CLI Customizations]({% link _docs/config.md %}): You can customize the [cli args]({% link _docs/config/kubectl.md %}). You can also run hooks before and after kubectl commands.
+* [Extra Env]({% link _docs/extra-env.md %}): Create additional envs with little effort.

data/docs/_includes/learn/review.md

@@ -0,0 +1,25 @@
+## Config
+
+The `config.rb` is where you can configure Kubes settings.
+
+```ruby
+Kubes.configure do |config|
+  config.repo = "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo"
+  config.logger.level = "info"
+  # auto-switching
+  # config.kubectl.context = "dev-services"
+end
+```
+
+This is where the `--repo` from `kubes init` got saved.  The other options are covered in the [Env Config Docs]({% link _docs/config/env.md %}).
+
+## Dockerfie
+
+The `Dockerfile` is a simple starter example that just runs nginx.
+
+Dockerfile:
+
+    # Simple example starter
+    FROM nginx
+    EXPOSE 80
+    CMD ["nginx", "-g", "daemon off;"]

data/docs/_includes/learn/start.md

@@ -0,0 +1,3 @@
+Kubes is a Kubernetes deployment tool. It automates the deployment process.
+
+In this guide we'll build a docker image, and build kubernetes YAML files, and deploy a demo app. We'll use the {{ include.type }} format.

data/docs/_includes/reference.md

@@ -0,0 +1,3 @@
+Kubes is a Kubernetes deployment tool. It automates the deployment process. Kubes will:
+
+{% include kubes-steps.md %}

data/docs/_includes/sidebar.html

@@ -0,0 +1,113 @@
+<div id="sidebar">
+  <section class="content-nav">
+    <h2><a href="{% link getting-started.md %}">Getting Started</a></h2>
+    <ul id="learn">
+      <li><a href="{% link _docs/learn/yaml.md %}">YAML</a>
+        <ul>
+          <li><a href="{% link _docs/learn/yaml/install.md %}">Install Kubes</a></li>
+          <li><a href="{% link _docs/learn/yaml/cluster.md %}">Cluster Setup</a></li>
+          <li><a href="{% link _docs/learn/yaml/new-project.md %}">New Project</a></li>
+          <li><a href="{% link _docs/learn/yaml/review-project.md %}">Review Project</a></li>
+          <li><a href="{% link _docs/learn/yaml/deploy.md %}">Deploy</a></li>
+          <li><a href="{% link _docs/learn/yaml/change.md %}">Change</a></li>
+          <li><a href="{% link _docs/learn/yaml/update.md %}">Update</a></li>
+          <li><a href="{% link _docs/learn/yaml/delete.md %}">Delete</a></li>
+          <li><a href="{% link _docs/learn/yaml/next-steps.md %}">Next Steps</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/learn/dsl.md %}">DSL</a>
+        <ul>
+          <li><a href="{% link _docs/learn/dsl/install.md %}">Install Kubes</a></li>
+          <li><a href="{% link _docs/learn/dsl/cluster.md %}">Cluster Setup</a></li>
+          <li><a href="{% link _docs/learn/dsl/new-project.md %}">New Project</a></li>
+          <li><a href="{% link _docs/learn/dsl/review-project.md %}">Review Project</a></li>
+          <li><a href="{% link _docs/learn/dsl/deploy.md %}">Deploy</a></li>
+          <li><a href="{% link _docs/learn/dsl/change.md %}">Change</a></li>
+          <li><a href="{% link _docs/learn/dsl/update.md %}">Update</a></li>
+          <li><a href="{% link _docs/learn/dsl/delete.md %}">Delete</a></li>
+          <li><a href="{% link _docs/learn/dsl/next-steps.md %}">Next Steps</a></li>
+        </ul>
+      </li>
+    </ul>
+    <h2><a href="{% link docs.md %}">Docs</a></h2>
+    <ul id="docs">
+      <li><a href="{% link _docs/intro.md %}">Intro</a>
+        <ul>
+          <li><a href="{% link _docs/intro/how-kubes-works.md %}">How Kubes Works</a></li>
+          <li><a href="{% link _docs/intro/concepts.md %}">Concepts</a></li>
+          <li><a href="{% link _docs/intro/structure.md %}">Structure</a></li>
+          <li><a href="{% link _docs/intro/ordering.md %}">Ordering</a>
+            <ul>
+              <li><a href="{% link _docs/intro/ordering/custom.md %}">Custom Order</a></li>
+            </ul>
+          </li>
+          <li><a href="{% link _docs/intro/install.md %}">Install</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/resources.md %}">Resources</a>
+        <ul>
+          <li><a href="{% link _docs/resources/role.md %}">Role</a></li>
+          <li><a href="{% link _docs/resources/base.md %}">Base</a></li>
+          <li><a href="{% link _docs/resources/shared.md %}">Shared</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/config.md %}">Config</a>
+        <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>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/yaml.md %}">YAML</a></li>
+      <li><a href="{% link _docs/dsl.md %}">DSL</a>
+        <ul>
+          <li><a href="{% link _docs/dsl/resources.md %}">Resources</a>
+            <ul>
+            {% assign docs = site.docs | where: "categories","dsl" %}
+            {% for doc in docs -%}
+              <li><a href="{{ doc.url }}">{{ doc.title }}</a></li>
+            {% endfor %}
+            </ul>
+          </li>
+          <li><a href="{% link _docs/dsl/multiple-resources.md %}">Multiple Resources</a>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/layering.md %}">Layering</a>
+        <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/merge.md %}">Merge Behavior</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/helpers.md %}">Helpers</a></li>
+      <li><a href="{% link _docs/patterns.md %}">Patterns</a>
+        <ul>
+          <li><a href="{% link _docs/patterns/clock-web-worker.md %}">Clock Web Worker</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link _docs/extra-env.md %}">Extra Env</a>
+        <ul>
+          <li><a href="{% link _docs/extra-env/yaml.md %}">YAML</a></li>
+          <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>More
+        <ul class="more">
+          <li><a href="{% link support.md %}">Support</a></li>
+          <li><a href="{% link _docs/contributing.md %}">Contributing</a></li>
+          <li><a href="{% link _docs/next-steps.md %}">Next Steps</a></li>
+        </ul>
+      </li>
+      <li><a href="{% link reference.md %}">CLI Reference</a></li>
+    </ul>
+  </section>
+  <div class="menu-options">
+    <h2>sidebar options:</h2>
+    <ul class="list-unstyled">
+      <li><a href="#" id="expand-all">expand all</a></li>
+      <li><a href="{{ site.gh_url }}/blob/master/docs/{{ page.path }}" target="_blank">edit page</a></li>
+    </ul>
+  </div>
+</div>

data/docs/_layouts/default.html

@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <meta name="description" content="{{ site.description }}">
+  <meta name="keywords" content="{{ site.keywords }}" />
+  {% if site.meta_author %}<meta name="author" content="{{ site.meta_author }}">{% endif %}
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.url }}">
+
+  {% if page.title %}
+  <title>{{ page.title }} - {{ site.title }}</title>
+  {% else %}
+  <title>Kubes | The Kubernetes Deployment Tool</title>
+  {% endif %}
+
+  <link rel="stylesheet" href="/vendor/bootstrap/css/bootstrap.min.css">
+  <link rel="stylesheet" href="/vendor/font-awesome/css/font-awesome.min.css">
+  <link rel="stylesheet" href="/vendor/simple-line-icons/css/simple-line-icons.css">
+  <link rel="stylesheet" href="/css/main.css">
+
+  <script src="/vendor/jquery/jquery.min.js"></script>
+  <script src="/vendor/bootstrap/js/bootstrap.bundle.min.js"></script>
+  <script src="/js/app.js"></script>
+</head>
+
+<body>
+  {% include header.html %}
+  {% include content.html %}
+  {% include footer.html %}
+  {% include js.html %}
+</body>
+</html>

data/docs/_reference/kubes-apply.md

@@ -0,0 +1,24 @@
+---
+title: kubes apply
+reference: true
+---
+
+## Usage
+
+    kubes apply [APP] [RESOURCE]
+
+## Description
+
+Apply the Kubernetes YAML files without changing them
+
+
+## Options
+
+```
+[--image=IMAGE]              # override image
+[--compile], [--no-compile]  # whether or not to compile the .kube/resources
+                             # Default: true
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/kubes-clean.md

@@ -0,0 +1,22 @@
+---
+title: kubes clean
+reference: true
+---
+
+## Usage
+
+    kubes clean
+
+## Description
+
+Remove .kubes/output files
+
+
+## Options
+
+```
+[--image=IMAGE]              # override image
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/kubes-compile.md

@@ -0,0 +1,22 @@
+---
+title: kubes compile
+reference: true
+---
+
+## Usage
+
+    kubes compile
+
+## Description
+
+Compile Kubernetes YAML files from DSL
+
+
+## Options
+
+```
+[--image=IMAGE]              # override image
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+