kubes 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a3c967287e0537aa037d433d02e0e31b1964bc1f4a87aed27472fbf11e6f9b
-  data.tar.gz: 0e50409529c1ca49356d651647cef3ff0c871fdc13aa2b8ab1b66a689f238543
+  metadata.gz: f5115dab9c9c9e52678c67ba1c6a956ffe9369961555d6393e8ad0ca40868fdd
+  data.tar.gz: 6f04422236a9df6a5833633c0fdc2b1bc49d31786c0fd1f1f599a75a7b7771eb
 SHA512:
-  metadata.gz: 9077b12f79344afe33ef89cc3895b729c92ca0014d4b0e54371d8a2504115c9d35cbbd10374a350a93bf340681e8d6354b2e8cd269490a9cfb64ecc5d02a03e8
-  data.tar.gz: 220fb55845ce19d85fb5fb3e527750638230cf1bc2b914f4aa3a5ac7ca2c0b9c0b96e7c1eb417c425d382dc9cd8a9a35ddd5358c0b5ba744faaf2972e411ae36
+  metadata.gz: c60e4d318db13f130929e1e554b93594f23cfda75b3a2e6974f395b1c1440734077bd85d9e11f0460371f62d8810e402db493c7fdf86b3f823ca8eb8810bb32e
+  data.tar.gz: b344b7af0da2964097d564407402cac1b880d134b1d213f1a40deb0234e661c7e08dc15fa3005fcfd4ba6f714d4262f5bd25c17fc876c545d0fac41898cb2a86

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.2.2]
+- #14 init template updates, dockerfile_port helper
+
 ## [0.2.1]
 - #13 improve network policy dsl
 

data/docs/_docs/helpers.md

@@ -7,8 +7,9 @@ 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.
-with_extra | Appends the `KUBES_ENV` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
+dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
 extra | The `KUBES_ENV` value.
+with_extra | Appends the `KUBES_ENV` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
 
 Here's also the source code with the helpers: [helpers.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/shared/helpers.rb).
 

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

@@ -15,6 +15,8 @@ You will be prompted to confirm before deletion. Here's out the output looks lik
     service "demo-web" deleted
     => kubectl delete -f .kubes/output/web/deployment.yaml
     deployment.apps "demo-web" deleted
+    => kubectl delete -f .kubes/output/shared/namespace.yaml
+    namespace "demo" deleted
     $
 
 Let's double-check that the resources have been deleted:

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

@@ -14,6 +14,8 @@ You'll see output like this:
     Pushed 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:kubes-2020-06-19T04-19-13 docker image.
     Docker push took 15s.
     Compiled  .kubes/resources files
+    => kubectl apply -f .kubes/output/shared/namespace.yaml
+    namespace/demo created
     => kubectl apply -f .kubes/output/web/service.yaml
     service/demo-web created
     => kubectl apply -f .kubes/output/web/deployment.yaml
@@ -34,6 +36,9 @@ Example output:
 
     $ kubes get
     => kubectl get --recursive -f .kubes/output
+    NAME             STATUS   AGE
+    namespace/demo   Active   10s
+
     NAME                       READY   UP-TO-DATE   AVAILABLE   AGE
     deployment.apps/demo-web   1/1     1            1           10s
 

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

@@ -17,6 +17,7 @@ Let's generate a starter project:
           create  .kubes/config/env/dev.rb
           create  .kubes/config/env/prod.rb
           create  .kubes/resources/base/all.rb
+          create  .kubes/resources/shared/namespace.rb
           create  .kubes/resources/web/deployment.rb
           create  .kubes/resources/web/deployment/dev.rb
           create  .kubes/resources/web/deployment/prod.rb

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

@@ -4,7 +4,18 @@ title: Review Project
 
 Let's review the resources.
 
-## Deployment Resource
+## Namespace
+
+We'll create a namespace for the app resources:
+
+.kubes/resources/shared/namespace.rb
+
+```ruby
+name "demo"
+labels(app: "demo")
+```
+
+## Deployment
 
 The `web/deployment.rb` file is a little more interesting:
 
@@ -21,7 +32,7 @@ image built_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.
 
-## Base Resource
+## Base Folder
 
 Also let's check the files in the base folder.
 

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

@@ -6,7 +6,7 @@ Let's update the app. In this case, we don't need to update the Docker image, so
 
     kubes apply
 
-Here's what the output looks like:
+Here's what the output looks like.  Note, the namespace is not shown for conciseness.
 
     $ kubes apply
     Compiled  .kubes/resources files

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

@@ -15,6 +15,8 @@ You will be prompted to confirm before deletion. Here's out the output looks lik
     service "demo-web" deleted
     => kubectl delete -f .kubes/output/web/deployment.yaml
     deployment.apps "demo-web" deleted
+    => kubectl delete -f .kubes/output/shared/namespace.yaml
+    namespace "demo" deleted
     $
 
 Let's double-check that the resources have been deleted:

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

@@ -14,6 +14,8 @@ You'll see output like this:
     Pushed 111111111111.dkr.ecr.us-west-2.amazonaws.com/demo:kubes-2020-06-19T04-19-13 docker image.
     Docker push took 15s.
     Compiled  .kubes/resources files
+    => kubectl apply -f .kubes/output/shared/namespace.yaml
+    namespace/demo created
     => kubectl apply -f .kubes/output/web/service.yaml
     service/demo-web created
     => kubectl apply -f .kubes/output/web/deployment.yaml
@@ -34,6 +36,9 @@ Example output:
 
     $ kubes get
     => kubectl get --recursive -f .kubes/output
+    NAME             STATUS   AGE
+    namespace/demo   Active   7s
+
     NAME                       READY   UP-TO-DATE   AVAILABLE   AGE
     deployment.apps/demo-web   1/1     1            1           7s
 

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

@@ -19,6 +19,7 @@ Let's generate a starter project:
           create  .kubes/config/env/prod.rb
           create  .kubes/resources/base/all.yaml
           create  .kubes/resources/base/deployment.yaml
+          create  .kubes/resources/shared/namespace.yaml
           create  .kubes/resources/web/deployment.yaml
           create  .kubes/resources/web/deployment/dev.yaml
           create  .kubes/resources/web/deployment/prod.yaml

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

@@ -4,7 +4,22 @@ title: Review Project
 
 Let's review the resources.
 
-## Deployment Resource
+## Namespace
+
+We'll create a namespace for the app resources:
+
+.kubes/resources/shared/namespace.yaml
+
+```yaml
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: demo
+  labels:
+    app: demo
+```
+
+## Deployment
 
 The `web/deployment.yaml` file is a little more interesting:
 
@@ -14,7 +29,7 @@ The `web/deployment.yaml` file is a little more interesting:
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: demo-web
+  name: web
   labels:
     role: web
 spec:
@@ -33,13 +48,13 @@ spec:
         role: web
     spec:
       containers:
-      - name: demo
+      - name: web
         image: <%= built_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.
 
-## Base Resource
+## Base Folder
 
 Also let's check the files in the base folder.
 
@@ -47,7 +62,7 @@ Also let's check the files in the base folder.
 
 ```yaml
 metadata:
-  namespace: default
+  namespace: demo
 ```
 
 .kubes/resources/base/deployment.yaml
@@ -68,6 +83,8 @@ spec:
 
 The base folder files are processed first as a part of [Kubes Layering]({% link _docs/layering.md %}). This allows you to define common fields and keep your code DRY.
 
+The `all.yaml` means all resources will use the demo namespace.  The `deployment.yaml` adds common labels to all deployment resource kinds.
+
 ## Service Resource
 
 Next, let's look at `service.yaml`
@@ -78,20 +95,19 @@ Next, let's look at `service.yaml`
 apiVersion: v1
 kind: Service
 metadata:
-  name: demo-web
+  name: web
   labels:
-    app: demo
-  namespace: default
+    role: web
 spec:
   ports:
   - port: 80
     protocol: TCP
-    targetPort: 8080
+    targetPort: <%= dockerfile_port %>
   selector:
-    app: demo
+    role: web
   type: ClusterIP
 ```
 
-There's no use of ERB templating here.
+The `dockerfile_port` helper returns the EXPOSE port in the Dockerfile. This spares you updating this manually, you only have to update the Dockerfile.
 
 Next, we'll deploy the app.

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

@@ -6,7 +6,7 @@ Let's update the app. In this case, we don't need to update the Docker image, so
 
     kubes apply
 
-Here's what the output looks like:
+Here's what the output looks like. Note, the namespace is not shown for conciseness.
 
     $ kubes apply
     Compiled  .kubes/resources files

data/docs/_includes/learn/review.md

@@ -15,7 +15,7 @@ This is where the `--repo` from `kubes init` got saved.  The other options are c
 
 ## Dockerfie
 
-The `Dockerfile` is a simple starter example that just runs nginx.
+The `Dockerfile` is a simple starter example that just runs nginx
 
 Dockerfile:
 
@@ -23,3 +23,5 @@ Dockerfile:
     FROM nginx
     EXPOSE 80
     CMD ["nginx", "-g", "daemon off;"]
+
+Note: If your project already has a Dockerfile, kubes will use that instead of generating a starter one.

data/lib/kubes/cli/init.rb

@@ -49,7 +49,7 @@ class Kubes::CLI
       ignores = %w[
         .kubes/output
         .kubes/state
-      ]
+      ].map {|l| "#{l}\n"} # the readlines will have lines with \n so keep consistent for processing
       if File.exist?(".gitignore")
         lines = IO.readlines(".gitignore")
         if lines.detect { |l| l.include?('.kubes/output') }
@@ -61,7 +61,7 @@ class Kubes::CLI
         lines = ignores
       end
 
-      text = lines.join("\n") + "\n"
+      text = lines.join('')
       IO.write(".gitignore", text)
       puts "Updated .gitignore"
     end

data/lib/kubes/compiler/dsl/core/helpers.rb

@@ -1,4 +1,19 @@
 module Kubes::Compiler::Dsl::Core
   module Helpers
+    def dockerfile_port
+      path = "#{Kubes.root}/Dockerfile"
+      File.exist?(path) ? parse_for_dockerfile_port(path) : 80
+    end
+
+  private
+    def parse_for_dockerfile_port(path)
+      lines = IO.read(path).split("\n")
+      expose_line = lines.find { |l| l =~ /^EXPOSE / }
+      if expose_line
+        md = expose_line.match(/EXPOSE (\d+)/)
+        port = md[1] if md
+      end
+      port ? port.to_i : 80
+    end
   end
 end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/templates/dsl/.kubes/resources/base/all.rb.tt

@@ -1,2 +1,2 @@
-namespace "default"
+namespace "<%= app %>"
 labels(app: "<%= app %>")

data/lib/templates/dsl/.kubes/resources/shared/namespace.rb.tt

@@ -0,0 +1,2 @@
+name "<%= app %>"
+labels(app: "<%= app %>")

data/lib/templates/dsl/.kubes/resources/web/{deployment.rb.tt → deployment.rb}

@@ -1,7 +1,9 @@
-name "<%= app %>-web"
+name "web"
 labels(role: "web")
 
 replicas 1
 image built_image # IE: user/<%= app %>:kubes-2020-06-13T19-55-16-43afc6e
 
+# revisionHistoryLimit 1 # uncomment to reduce old ReplicaSets, default is 10 https://bit.ly/3hqrzyP
+
 # More docs: kubes.guru/docs/dsl/deployment/

data/lib/templates/dsl/.kubes/resources/web/{service.rb.tt → service.rb}

@@ -1,8 +1,8 @@
-name "<%= app %>-web"
+name "web"
 labels(role: "web")
 
 # Optional since default port is 80
 # port 80
-# targetPort 80
+targetPort dockerfile_port # expose port in Dockerfile
 
 # More docs: kubes.guru/docs/dsl/service/

data/lib/templates/yaml/.kubes/resources/base/all.yaml.tt

@@ -1,2 +1,2 @@
 metadata:
-  namespace: default
+  namespace: <%= app %>

data/lib/templates/yaml/.kubes/resources/shared/namespace.yaml.tt

@@ -0,0 +1,6 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: <%= app %>
+  labels:
+    app: <%= app %>

data/lib/templates/yaml/.kubes/resources/web/deployment.yaml.tt

@@ -1,7 +1,7 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: <%= app %>-web
+  name: web
   labels:
     role: web
 spec:
@@ -20,5 +20,5 @@ spec:
         role: web
     spec:
       containers:
-      - name: <%= app %>-web
+      - name: web
         image: <%%= built_image %>

data/lib/templates/yaml/.kubes/resources/web/service.yaml.tt

@@ -1,14 +1,14 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: <%= app %>-web
+  name: web
   labels:
     role: web
 spec:
   ports:
   - port: 80
     protocol: TCP
-    targetPort: 80
+    targetPort: <%%= dockerfile_port %>
   selector:
     role: web
   type: ClusterIP

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -536,12 +536,14 @@ files:
 - lib/templates/base/.kubes/config/env/prod.rb
 - lib/templates/docker/Dockerfile
 - lib/templates/dsl/.kubes/resources/base/all.rb.tt
-- lib/templates/dsl/.kubes/resources/web/deployment.rb.tt
+- lib/templates/dsl/.kubes/resources/shared/namespace.rb.tt
+- lib/templates/dsl/.kubes/resources/web/deployment.rb
 - lib/templates/dsl/.kubes/resources/web/deployment/dev.rb
 - lib/templates/dsl/.kubes/resources/web/deployment/prod.rb
-- lib/templates/dsl/.kubes/resources/web/service.rb.tt
+- lib/templates/dsl/.kubes/resources/web/service.rb
 - lib/templates/yaml/.kubes/resources/base/all.yaml.tt
 - lib/templates/yaml/.kubes/resources/base/deployment.yaml.tt
+- lib/templates/yaml/.kubes/resources/shared/namespace.yaml.tt
 - lib/templates/yaml/.kubes/resources/web/deployment.yaml.tt
 - lib/templates/yaml/.kubes/resources/web/deployment/dev.yaml
 - lib/templates/yaml/.kubes/resources/web/deployment/prod.yaml