kubes 0.1.0 → 0.2.0

data/docs/_docs/next-steps.md

@@ -0,0 +1,13 @@
+---
+title: Next Steps
+---
+
+Hopefully, you have a good feel for how kubes works now. From here, there are a few resources that can help you continue along:
+
+* Check out the [kubes](https://github.com/boltops-tools/kubes) repo on GitHub
+* ⭐️ the kubes project on GitHub
+* Write a blog post about kubes
+* Post on your favorite discussion about kubes
+* Contribute a pull request
+
+Everyone can contribute to making kubes better, including the documentation. These docs are the kubes repo located the [docs folder](https://github.com/boltops-tools/tree/master/docs). Please fork the project and open a pull request!  We love your pull requests. Contributions are encouraged and welcomed!

data/docs/_docs/patterns.md

@@ -0,0 +1,7 @@
+---
+title: Patterns
+---
+
+We'll cover some common deployment patterns here:
+
+* [Clock Web Worker]({% link _docs/patterns/clock-web-worker.md %})

data/docs/_docs/patterns/clock-web-worker.md

@@ -0,0 +1,71 @@
+---
+title: Clock Web Worker Pattern
+---
+
+A common pattern is to use the same code to run different types of processes like clock, web, worker. Kubes is flexible enough to support this pattern.
+
+Note, often the clock process is also called a scheduler.
+
+## Structure
+
+Here's a structure that achieves this pattern with Kubes:
+
+    .kubes/resources
+    ├── clock
+    │   └── deployment.rb
+    ├── web
+    │   ├── deployment.rb
+    │   └── service.rb
+    └── worker
+        └── deployment.rb
+
+## Source Code
+
+.kubes/resources/demo-clock/deployment.rb
+
+```ruby
+name "demo-clock"
+namespace "default"
+labels(role: "web")
+
+replicas 1
+image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+command "bin/clock"
+```
+
+.kubes/resources/web/deployment.rb
+
+```ruby
+name "demo-web"
+namespace "default"
+labels(role: "web")
+
+replicas 1
+image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+```
+
+.kubes/resources/demo-worker/deployment.rb
+
+```ruby
+name "demo-worker"
+namespace "default"
+labels(role: "web")
+
+replicas 2
+image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+command "bin/worker"
+```
+
+## Deploy All-At-Once
+
+To deploy all 3 process types:
+
+    kubes deploy
+
+## Deploy Selectively
+
+To deploy selectively:
+
+    kubes deploy clock
+    kubes deploy web
+    kubes deploy worker

data/docs/_docs/resources.md

@@ -0,0 +1,11 @@
+---
+title: Resources
+---
+
+You define your Kubernetes resources in the `.kubes/resources` folder. Kubes categories items within this folder in 3 main buckets:
+
+* [Role-Based Resource]({% link _docs/resources/role.md %}): Role-based resources. This is your main project resources group in roles.
+* [Base Folder]({% link _docs/resources/base.md %}): The base folder contains definitions for common fields that is used for [Layering]({% link _docs/layering.md %}).
+* [Shared Resources]({% link _docs/resources/shared.md %}): Shared resources that are meant to be created first and shared by other resources.
+
+In the next sections, we'll cover how these resources are used.

data/docs/_docs/resources/base.md

@@ -0,0 +1,33 @@
+---
+title: Base
+---
+
+The base folder is used for purely layering.
+
+## Structure
+
+Here's an example structure, so we can understand how layering works with the base folder.
+
+    .kubes/resources/
+    ├── base
+    │   ├── all.rb
+    │   └── deployment.rb
+    └── web
+        ├── deployment.rb
+        └── service.rb
+
+## Layering
+
+Kubes process the files in the `base` folder first, then it process your [role-based resources]({% link _docs/resources/role.md %}) like web. So:
+
+    kubes deploy web deployment
+
+Will layer:
+
+1. .kubes/resources/base/all.rb
+2. .kubes/resources/base/deployment.rb
+3. .kubes/resources/web/deployment.rb
+
+More details on layering can be found in the [Layering Docs]({% link _docs/layering.md %}).
+
+Remember files in the base are used just for layering.

data/docs/_docs/resources/role.md

@@ -0,0 +1,41 @@
+---
+title: Role-Based Resources
+---
+
+Role-based resources are your main project's resources.  Kubes groups resources together under a "role".
+
+## Example Structure
+
+Here's an example structure to help explain how role-based resources work.
+
+    .kubes
+    └── resources
+        ├── clock
+        │   └── deployment.yaml
+        ├── web
+        │   ├── deployment.yaml
+        │   └── service.yaml
+        └── worker
+            └── deployment.yaml
+
+## Resource Roles
+
+Here the resource roles are:
+
+1. clock
+2. web
+3. worker
+
+You can freely add more roles if needed. This structure is flexible enough to account for most use-cases.
+
+## Deploy
+
+You can deploy specific roles like so:
+
+    kubes deploy clock
+    kubes deploy web
+    kubes deploy worker
+
+Or you can deploy all roles at once:
+
+    kubes deploy

data/docs/_docs/resources/shared.md

@@ -0,0 +1,36 @@
+---
+title: Shared
+---
+
+The `shared` folder purpose is to provide a place for Kubernetes resources that are shared between roles.
+
+## Example Structure
+
+Here's an example structure to help explain how shared resources work.
+
+    .kubes/resources
+    ├── clock
+    │   └── deployment.rb
+    ├── shared
+    │   └── secret.rb
+    └── web
+        ├── deployment.rb
+        └── service.rb
+
+## Deploy
+
+When you deploy with Kubes, it will run `kubectl apply` on the shared resources first and then your [role-based resources]({% link _docs/resources/role.md %}) like clock and web.  Example:
+
+    $ kubes apply
+    Deploying kubes resources
+    => kubectl apply -f .kubes/output/shared/secret.yaml
+    secret/demo-secret created
+    => kubectl apply -f .kubes/output/clock/deployment.yaml
+    deployment.apps/demo-clock created
+    => kubectl apply -f .kubes/output/web/service.yaml
+    service/demo-web created
+    => kubectl apply -f .kubes/output/web/deployment.yaml
+    deployment.apps/demo-web created
+    $
+
+Kubes will order the creation of shared resources first.  You can override the default ordering with an [Order config]({% link _docs/intro/ordering/custom.md %}).

data/docs/_docs/yaml.md

@@ -0,0 +1,46 @@
+---
+title: Kubes YAML
+---
+
+You can write your Kubernetes resources in YAML format.
+
+    .kubes
+    └── resources
+        └── web
+            ├── deployment.yaml
+            └── service.yaml
+
+## 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/resources/web/deployment.yaml
+
+```yaml
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: demo-web
+  labels:
+    app: demo
+  namespace: default
+spec:
+  replicas: <%= Kubes.env == "prod" ? 2 : 1 %>
+  selector:
+    matchLabels:
+      app: demo
+  strategy:
+    rollingUpdate:
+      maxSurge: 25
+      maxUnavailable: 25
+    type: RollingUpdate
+  template:
+    metadata:
+      labels:
+        app: demo
+    spec:
+      containers:
+      - name: demo-web
+        image: <%= built_image %>
+```

data/docs/_includes/commands.html

@@ -0,0 +1,131 @@
+<section class="features" id="features">
+  <div class="container">
+    <div class="section-heading text-center">
+      <h2>The Code</h2>
+      <p class="text-muted">Easy to learn</p>
+      <hr>
+    </div>
+    <div class="row">
+      <div class="col-lg-12">
+        <div class="container-fluid">
+          <div class="row">
+            <div class="col-lg-6">
+              <h3>Commands</h3>
+              <div class="commands">
+{% highlight sh %}
+kubes init
+kubes docker build
+kubes docker push
+kubes compile
+kubes deploy
+kubes apply
+kubes get
+kubes delete -y
+{% endhighlight %}
+              </div>
+            </div>
+            <div class="col-lg-6">
+              <h3>Structure</h3>
+              <div class="commands">
+{% highlight sh %}
+.kubes
+└── resources
+    ├── clock
+    │   └── deployment.yaml
+    ├── worker
+    │   └── deployment.yaml
+    └── web
+        ├── deployment.yaml
+        └── service.yaml
+{% endhighlight %}
+              </div>
+            </div>
+        </div>
+        <div class="row">
+          <div class="col-lg-6">
+              <h3>Init Generator</h3>
+              <div class="commands">
+{% highlight sh %}
+$ kubes init --app demo --repo user/repo                                                               ⎈ (gke-dev/demo)
+      create  .kubes/config.rb
+      create  .kubes/config/env/dev.rb
+      create  .kubes/config/env/prod.rb
+      create  .kubes/resources/web/deployment.yaml
+      create  .kubes/resources/web/deployment/dev.yaml
+      create  .kubes/resources/web/deployment/prod.yaml
+      create  .kubes/resources/web/service.yaml
+Initialized .kubes folder
+Updated .gitignore
+$
+{% endhighlight %}
+              </div>
+            </div>
+            <div class="col-lg-6">
+              <h3>Deploy</h3>
+              <div class="commands">
+{% highlight sh %}
+$ kubes deploy
+=> docker build -t user/demo-web:kubes-2020-06-19T00-20-28-1ef4db6 -f Dockerfile .
+Successfully built 1c5b10652c36
+=> docker push user/demo-web:kubes-2020-06-19T00-20-28-1ef4db6
+Compiled  .kubes/resources files
+Deploying kubes files
+=> kubectl apply -f .kubes/output/web/service.yaml
+service/demo-web created
+=> kubectl apply -f .kubes/output/web/deployment.yaml
+deployment.apps/demo-web created
+=> kubectl apply -f .kubes/output/web/ingress.yaml
+ingress.networking.k8s.io/demo-web created
+$
+{% endhighlight %}
+              </div>
+            </div>
+        </div>
+        <div class="row">
+          <div class="col-lg-6">
+              <h3>YAML</h3>
+              <div class="commands">
+{% highlight yaml %}
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: demo-web
+  labels:
+    app: demo
+  namespace: default
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: demo
+  template:
+    metadata:
+      labels:
+        app: demo
+    spec:
+      containers:
+      - name: demo-web
+        image: <%= built_image %>
+{% endhighlight %}
+              </div>
+            </div>
+            <div class="col-lg-6">
+              <h3>DSL</h3>
+              <div class="commands">
+{% highlight ruby %}
+name "demo-web"
+namespace "default"
+labels(role: "web")
+
+replicas 2
+image built_image # IE: user/demo-web:kubes-2020-06-13T19-55-16-43afc6e
+{% endhighlight %}
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</section>

data/docs/_includes/content.html

@@ -0,0 +1,25 @@
+{% if page.sidebar == false %}
+
+{{ content }}
+
+{% else %}
+
+<div class="d-flex" id="wrapper">
+  {% include sidebar.html %}
+  <div id="content">
+    <div class="menu-top-bar">
+      <div id="menu-toggle">
+        <div class="bar1"></div>
+        <div class="bar2"></div>
+        <div class="bar3"></div>
+      </div>
+    </div>
+
+    <div class="container-fluid">
+      <h1>{{ page.title }}</h1>
+      {{ content }}
+    </div>
+  </div>
+</div>
+
+{% endif %}

data/docs/_includes/dsl/methods.md

@@ -0,0 +1 @@
+For a full list of the available methods, refer to the source itself [syntax/{{ include.name }}.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/dsl/syntax/{{ include.name }}.rb).

data/docs/_includes/dsl/rolling_deployment.md

@@ -0,0 +1 @@
+A suffix hash based on the contents of the {{ include.kind }} is automatically appended to the {{ include.kind }} name. {{ include.kind }}s used in Deployment and Pod containers fields that use the same name will also have the suffix automatically appended. This is done to trigger a rolling deployment. Here's an example an deployment output with the hashed name.

data/docs/_includes/dsl/suffix_hash.md

@@ -0,0 +1,8 @@
+You can disable the auto hasher behavior with:
+
+```ruby
+Kubes.configure do |config|
+  # ...
+  config.suffix_hash = false
+end
+```

data/docs/_includes/example.html

@@ -0,0 +1,12 @@
+<section id="timeline">
+    <div class="container">
+        <div class="row">
+            <div class="col-lg-12 text-center">
+                <h2 class="section-heading">TODO</h2>
+            </div>
+        </div>
+        <div class="row justify-content-center">
+            <img src="/img/home/TODO.png" />
+        </div>
+    </div>
+</section>