kubes 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2e59aafa5ea2023bdf23dc43ba38c5279dcd719c3db793eca0abf24c8e1da2
-  data.tar.gz: ed004f619cba70d0d6257ca9559b3fd1b1fa7cb6c48943c64c3abcb8cddf3d38
+  metadata.gz: 32e7414b0e237ec67d21e06089571c57671f5ec2fb946eb89a1b2220bc1ba87d
+  data.tar.gz: 76d393eee8b25ee806ca455efe521d4a690795a1f94690d16ba39a1a0dd05d4c
 SHA512:
-  metadata.gz: 7be4d6f0bd67e15b9ba3e3594f1b98d36c3fb5a4cc68c67fd603a75a973e4b90f8800a0a8fddf68951d0f3f09291c154bae5066830ec792aa167eb8675f5acca
-  data.tar.gz: 6187e6b6bc29e1a038f8c5a20530483a120cc6107854f718f8570648334f27cb7b4afb1a39d4d45ede4bb3cda97e8cc66d63c1cbbdde27a059997f65bd547704
+  metadata.gz: 4e5a7c052aaae9e0893293a9862979502f7bba65465d189691647ee5f4a4786c3e166c5e6ad2c908d72c3586a64db153253fe4e8f109fd278570c007d9ad6c53
+  data.tar.gz: ea95f2f305b03a32f2283ca103a4b69914229a238ace8527cea56898af33b7b15f563d8cc5041279758c98c9150e713a03b5acb96b08d789202c966ba34ecc03

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 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.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/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

@@ -51,13 +51,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 +70,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/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 ingress
+          create  .kubes/resources/web/ingress.yaml
+    $ kubes new service_account
+          create  .kubes/resources/shared/service_account.yaml
+    $
+
+Use `-h` to see the cli options:
+
+    kubes new -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/yaml) to all the resources that the generator supports.

data/docs/_docs/helpers.md

@@ -6,8 +6,8 @@ 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 | Basey64 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.
 extra | The `KUBES_EXTRA` value.

data/docs/_docs/helpers/google/service-account.md

@@ -41,6 +41,8 @@ metadata:
 
 The role permissions are currently always added to the existing permissions. So removing roles that were previously added does not remove them.
 
+## Variables
+
 ServiceAccount#initialize options:
 
 Variable | Description | Default
@@ -50,3 +52,9 @@ gsa | The Google Service Account name. The conventional name is APP-ENV. IE: dem
 ksa | The Kubernetes Service Account name. The conventional name is APP. IE: demo | APP
 namespace | The Kubernetes namespace. Defaults to the APP-ENV. IE: demo-dev. | APP-ENV
 roles | Google IAM roles to add. This adds permissions to the Google service account. | []
+
+Relevant environment variables:
+
+Name | Description
+---|---
+GOOGLE_PROJECT | Google project id. This is required as it's used to build the full service account name.

data/docs/_docs/intro.md

@@ -11,7 +11,9 @@ 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/args/kubectl.md %}). You can also run [hooks]({% link _docs/config/hooks/kubectl.md %}) before and after kubectl commands.
+* Generators: Kubes ships with a few generators to help you get building with Kubernetes quickly. See: [Generator Docs]({% link _docs/generators.md %}).
+* CLI Customizations: You can customize the [cli args]({% link _docs/config/args/kubectl.md %}).
+* Hooks: You can also run [hooks]({% link _docs/config/hooks.md %}) before and after [kubes]({% link _docs/config/hooks/kubes.md %}) and [kubectl]({% link _docs/config/hooks/kubectl.md %}) 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/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 %}).

data/docs/_docs/intro/docker-image.md

@@ -0,0 +1,66 @@
+---
+title: Docker Image
+---
+
+With Kubes, you can use the `docker_image` helper method to select which image to use. It can use images from these sources:
+
+1. CLI Option: The `--image` option specified with the CLI command
+2. Kubes Config: Specified by `config.image` in the `.kubes/config.rb`
+3. Built Docker Image: The image built from Dockerfile
+
+The CLI option has the highest precedence, and the Built Docker image has the lowest precedence.
+
+## 1. CLI Option
+
+Kubes uses the image from the `--image` option if specified. It's a quick way to override the Docker  image used by Kubes.  Example:
+
+    kubes deploy --image repo/image:tag
+
+When the `--image` option is set, Kubes skips the Docker build phase.
+
+## 2. Kubes Config
+
+If you set the `config.image` in the Kubes config, Kubes will use this prebuilt Docker image instead. Example:
+
+.kubes/config.rb:
+
+```ruby
+Kubes.configure do |config|
+  config.image = "nginx"
+end
+```
+
+When `config.image` is set, Kubes skips the Docker build phase.
+
+## 3. Built Docker Image
+
+Kubes can use a Docker image built from your Dockerfile. This is the default behavior of Kubes, as long as the CLI Option and the Kubes Config option is not set.
+
+## Template Example
+
+Here's an example usage of the `docker_image` helper.
+
+.kubes/resources/web/deployment.yaml
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: web
+  labels:
+    role: web
+spec:
+  selector:
+    matchLabels:
+      role: web
+  template:
+    metadata:
+      labels:
+        role: web
+    spec:
+      containers:
+      - name: web
+        image: <%= docker_image %>
+```
+
+When running `kubes deploy`, Kubes will replace `<%= docker_image %>` with the Docker image from one of the sources described above.

data/docs/_docs/layering/merge.md

@@ -67,7 +67,7 @@ The merging of simple String is a straightforward replacement.
 .kubes/resources/web/deployment.rb
 
 ```ruby
-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
 # ...
 ```
 

data/docs/_docs/learn/dsl/delete.md

@@ -6,11 +6,19 @@ Let's now delete the app and clean up:
 
     kubes delete
 
-You will be prompted to confirm before deletion. Here's out the output looks like:
+You will be prompted to confirm before deletion.
 
     $ kubes delete
+    Compiled  .kubes/resources files to .kubes/output
+    Will run:
+        kubectl delete -f .kubes/output/web/deployment.yaml
+        kubectl delete -f .kubes/output/web/service.yaml
+        kubectl delete -f .kubes/output/shared/namespace.yaml
+    This will delete resources. Are you sure? (y/N)
+
+Confirm to delete the resources:
+
     This will delete resources. Are you sure? (y/N) y
-    Compiled  .kubes/resources files
     => kubectl delete -f .kubes/output/web/service.yaml
     service "demo-web" deleted
     => kubectl delete -f .kubes/output/web/deployment.yaml

data/docs/_docs/learn/dsl/review-project.md

@@ -29,10 +29,10 @@ labels(role: "web")
 namespace "default"
 
 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
 ```
 
-The DSL form is more concise than the YAML form.  Also, notice the use of the `built_image` helper. The `built_image` is a kubes helper method that refers to the latest Docker image built. This spares you from updating the image manually.
+The DSL form is more concise than the YAML form.  Also, notice the use of the `docker_image` helper. The `docker_image` is a kubes helper method that refers to the latest Docker image built. This spares you from updating the image manually.
 
 ## Base Folder
 

data/docs/_docs/learn/yaml/delete.md

@@ -6,11 +6,19 @@ Let's now delete the app and clean up:
 
     kubes delete
 
-You will be prompted to confirm before deletion. Here's out the output looks like:
+You will be prompted to confirm before deletion.
 
     $ kubes delete
+    Compiled  .kubes/resources files to .kubes/output
+    Will run:
+        kubectl delete -f .kubes/output/web/deployment.yaml
+        kubectl delete -f .kubes/output/web/service.yaml
+        kubectl delete -f .kubes/output/shared/namespace.yaml
+    This will delete resources. Are you sure? (y/N)
+
+Confirm to delete the resources:
+
     This will delete resources. Are you sure? (y/N) y
-    Compiled  .kubes/resources files
     => kubectl delete -f .kubes/output/web/service.yaml
     service "demo-web" deleted
     => kubectl delete -f .kubes/output/web/deployment.yaml

data/docs/_docs/learn/yaml/review-project.md

@@ -46,10 +46,10 @@ spec:
     spec:
       containers:
       - name: web
-        image: <%= built_image %>
+        image: <%= docker_image %>
 ```
 
-Notice the `<%= built_image %>`.  Kubes processes the YAML files with ERB templating and replaces these tags.  The `built_image` is a kubes helper method that refers to the latest Docker image built by Kubes. This spares you updating the image manually.
+Notice the `<%= docker_image %>`.  Kubes processes the YAML files with ERB templating and replaces these tags.  The `docker_image` is a kubes helper method that refers to the latest Docker image built by Kubes. This spares you updating the image manually.
 
 ## Base Folder
 

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

@@ -31,7 +31,7 @@ namespace "default"
 labels(role: "web")
 
 replicas 1
-image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+image docker_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
 command "bin/clock"
 ```
 
@@ -43,7 +43,7 @@ namespace "default"
 labels(role: "web")
 
 replicas 1
-image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+image docker_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
 ```
 
 .kubes/resources/demo-worker/deployment.rb
@@ -54,7 +54,7 @@ namespace "default"
 labels(role: "web")
 
 replicas 2
-image built_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
+image docker_image # IE: user/demo-clock:kubes-2020-06-13T19-55-16-43afc6e
 command "bin/worker"
 ```
 

data/docs/_docs/patterns/migrations.md

@@ -25,7 +25,7 @@ spec:
     spec:
       containers:
       - name: migrate
-        image: <%= built_image %>
+        image: <%= docker_image %>
         command: ["bin/job/migrate.sh"]
       restartPolicy: Never
   backoffLimit: 4

data/docs/_docs/yaml.md

@@ -12,7 +12,7 @@ You can write your Kubernetes resources in YAML format.
 
 ## 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 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 `docker_image` helper.
 
 .kubes/resources/web/deployment.yaml
 
@@ -37,5 +37,5 @@ spec:
     spec:
       containers:
       - name: demo-web
-        image: <%= built_image %>
+        image: <%= docker_image %>
 ```