kubernetes_helper 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2e119480c5c91e09f658c135c25adc802c26acfd64255a60d71ef71f1d71f3
-  data.tar.gz: a47d27732e7c42f80dd00ee32e5a36bf67cf0fbba533f3650cd3eec528ce2ec6
+  metadata.gz: ad11b73ac23d45b86c9b5789ae815af2ee565d6360462368e96c4b15dfcc3301
+  data.tar.gz: 61df31315a5b137c9e1c4575002b875f87175d72d5319cf0e1439d8c01afaee6
 SHA512:
-  metadata.gz: bbdb0771ba124950ce8704528349c16e52f29d90af6b6581db3f423a377aba4f91d5ca1f82387e976d9a88394f327037c782185632e3f83eef7338b8cf50eb39
-  data.tar.gz: e74722f42ec99b9b22ad01d932203bf968a2610f0724032ca83141201ab3db46d231f666878d283fcc1020fc4c122f5388e938bdbb23c2b6dac901af5bc684ed
+  metadata.gz: f1a177f81e8bf2a9337d233369c39dd7cc42e2baf0c7dca7fdba25984d86014837db2207bcab10a1b9f8b8bc2060b55dee8c0dc0054074ac4846592856c8d778
+  data.tar.gz: 8be87c0b86cc7e4a7711d20d6360e96d5b99d7655ea3a3bed0a8291dec59cc552a9a326911355d2427f0e5548c0976045d7d28204af1c9dcee2c5fd1bc2af1f9

data/README.md

@@ -9,7 +9,15 @@ cd my_app/
 gem install kubernetes_helper -v '~> 1.0'
 kubernetes_helper generate_templates
 ```
-Note: Requires ruby 1.7+      
+Note: Requires ruby 1.7+     
+
+## Configuration
+- Edit `.kubernetes/settings.rb` and enter or replace all settings with the valid ones
+- For special applications where default configurations are not enough, you can do the following: 
+    - Download the corresponding template from [lib/templates](lib/templates)
+    - Put it inside `.kubernetes` folder
+    - Customize based on your needs (You can add or use your custom variables from `settings.rb`)    
+    Note: The local template will be used instead of the default.
 
 ## Deployment
 Once you generated the basic templates, it comes with the corresponding [readme.md](/lib/templates/README.md) which includes all the steps to deploy your application.
@@ -21,7 +29,7 @@ Once you generated the basic templates, it comes with the corresponding [readme.
   - Supports for `- documents` to include multiple documents in a file and share yml variables between them (Sample: `lib/templates/deployment.yml#1`)
   - Replaces all setting values based on `DEPLOY_ENV`
   - Supports for secrets auto importer using `import_secrets: ['secrets.yml', '<%=secrets.name%>']` (Sample: `lib/templates/deployment.yml#29`)
-  - Supports for template including by `include_template 'template_name.yml.erb'`    
+  - Supports for sub templates by `include_template 'template_name.yml.erb', { my_local_var: 10 }`    
   Sample: `DEPLOY_ENV=beta kubernetes_helper run_deployment "deployment.yml" "kubectl create"`
    
 - Run kubernetes commands    
@@ -44,6 +52,67 @@ Once you generated the basic templates, it comes with the corresponding [readme.
 When performing a script it looks first for file inside .kubernetes folder, if not exist, 
 it looks for the file inside kubernetes_helper template folder.    
 
+## Settings API
+Below settings are used when running Continuous Deployment
+- `continuous_deployment.image_name` (String, Optional): Partial docker image url where `:latest` will be automatically added. Sample: `gcr.io/my-account/my_app_name`
+- `continuous_deployment.image` (String, Optional, is mandatory if `image_name` is empty): Full docker image url. Sample: `gcr.io/my-account/my_app_name:latest`
+- `continuous_deployment.project_name`: Cloud project name. Sample: `my-project-name`
+- `continuous_deployment.cluster_name`: Cluster cluster name. Sample: `my-cluster-name`
+- `continuous_deployment.cluster_region`: Cluster region name. Sample: `europe-west4-a`
+- `continuous_deployment.docker_build_cmd`: Docker command to build the corresponding image. Sample: `build --target production -f Dockerfile `
+- `continuous_deployment.update_deployment` (Boolean, default: false): If true permits to re-generate and update the k8s deployment(s) before applying the new version (new docker image) 
+
+Below settings are used when configuring the application in the k8s environment
+- `deployment.name` (String): Web deployment name (Note: Underscores are not accepted). Sample: `my-app`  
+- `deployment.replicas` (Integer): Quantity of replicas. Sample: `1`
+- `deployment.replicas_range` (Array<min, max, cpu_percentage>, Optional): Defines the minimum and the maximum number of pods that could automatically be created when `CPUUtilizationPercentage` is above than defined. Sample: `[1, 3, 50]`
+- `deployment.cloud_secret_name` (String, Optional): K8s credentials name where cloud secrets will be saved (includes permission like DB). Sample: `my-app-cloud-secret`
+- `deployment.cloud_sql_instance` (String, Optional): Cloud sql instance name. Sample: `my-project:europe-west1:my-instance-name=tcp:5432` (5432 => postgres, 3306 => mysql)
+- `deployment.env_vars` (Hash, optional): List of static env variables (Note: Not recommended for sensitive values). Sample: `{ 'RAILS_ENV' => 'production' }`
+- `deployment.command` (String, Optional): Bash command to be used for web containers. Sample: `rails s -b 0.0.0.0`
+- `deployment.liveness_path` (String, Optional): Relative path to be used for readiness and liveness checker of the web app. Sample: `/check_liveness`
+- `deployment.custom_volumes` (Hash<name: path>, Optional): Custom volumes to be mounted. Sample: `{ my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }`
+
+- `deployment.job_name` (String, optional): Job deployment name (Note: Underscores are not accepted). Sample: `my-app-job`. Note: This deployment is created only if this value is present
+- `deployment.job_command` (String, optional): Bash command to be used for job container. Sample: `bundle exec sidekiq`
+- `deployment.job_sidekiq_alive_gem` (Boolean, default false): If true will add liveness checker settings using `sidekiq_alive_gem` (`sidekiq_alive` gem needs to be present in your Gemfile)
+- `deployment.job_services` (Array, Optional, only `job_sidekiq_alive_gem` or `job_services` is allowed): List of linux service names that are required for a healthy job container. Sample: `['sidekiq', 'cron']` 
+
+
+- `secrets.name` (String): K8s secrets name where env vars will be saved and fetched from. Sample: `my-app-secrets`
+
+- `service.name`: K8s service name. Sample: `my-app-service`
+- `service.port_name`: Http port name to connect between k8s ingress and service. Sample: `http-port`. Note: max 15 characters
+- `service.backend_port_name` (String): Web backend port name to be connected between k8s service and web deployments. Sample: `b-port`. Note: max 15 characters
+
+- `ingress.name`: Name of k8s ingress for the app: Sample: `my-app-ingress`
+- `ingress.ip_name` (Optional): Static ip address is not created nor assigned if empty value. Sample: `my-app-static-ip`
+- `ingress.certificate_name` (Optional): Ssl certificate is not created nor assigned if empty value. Sample: `my-app-lets-encrypt`. Note: requires `certificate_domain` 
+- `ingress.certificate_domain` (Optional): Domain name for the certificate. Sample: `myapp.com`. Note: does not support for willcard domains
+
+### Partials
+- `_container_extra_settings.yml` Partial template to add custom container settings. Receives `pod` as local variable (`web` | `job` | `cloudsql` | `logs`). Sample:
+  ```yaml
+               <% if locals[:pod] == 'job' %>
+               resources:
+                 requests:
+                   cpu: 50m
+                   memory: 256Mi
+                 limits:
+                   cpu: 500m
+                   memory: 1Gi
+               <% end %>
+  ``` 
+- `_custom_containers.yml` Partial template to add extra containers (Receives `pod` as local variable: `web` | `job`). Sample:
+```yaml
+           <% if locals[:pod] == 'job' %>
+           - name: scraper
+             image: owencio/easy_scraper
+             ...
+           <% end %>
+```
+- `_cd_apply_images.sh` Partial template to customize the process to apply the new version (new docker image)
+
 ## Templating
 When performing a command or script, the setting variables are replaced based on `DEPLOY_ENV`. 
 All these setting variable values are configured in `.kubernetes/settings.rb` which defines the values based on `DEPLOY_ENV`.     

data/lib/kubernetes_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KubernetesHelper
-  VERSION = '1.9.0'
+  VERSION = '1.10.0'
 end

data/lib/templates/_replicas.yml

@@ -9,4 +9,4 @@
         name: <%= deployment.name %>
       minReplicas: <%= deployment.replicas_range[0] %>
       maxReplicas: <%= deployment.replicas_range[1] %>
-      targetCPUUtilizationPercentage: 50
+      targetCPUUtilizationPercentage: <%= deployment.replicas_range[2] || 50 %>

data/lib/templates/certificate.yml

@@ -4,4 +4,4 @@ metadata:
   name: '<%=ingress.certificate_name%>'
 spec:
   domains: # does not support for willcard domains
-    - '<%=ingress.domain_name%>'
+    - '<%= ingress.domain_name || ingress.certificate_domain %>'

data/lib/templates/deployment.yml

@@ -21,7 +21,12 @@ documents:
         spec: &template_spec
           containers:
             - &app_container
-              image: '<%=continuous_deployment.image_name%>:latest'
+              <% if continuous_deployment.image_name %>
+              image: '<%= continuous_deployment.image_name %>:latest'
+              <% else %>
+              image: '<%= continuous_deployment.image %>'
+              <% end %>
+
               <% if deployment.command %>
               command: ["/bin/bash", "-c", "<%= deployment.command %>"]
               <% end %>

data/lib/templates/ingress.yml

@@ -1,4 +1,4 @@
-<% if ingress.domain_name %>
+<% if ingress.certificate_name %>
 <%= include_template "certificate.yml" %>
 <% end %>
 
@@ -17,7 +17,7 @@ metadata:
     kubernetes.io/ingress.global-static-ip-name: "<%=ingress.ip_name%>"
     <% end %>
 
-    <% if ingress.domain_name %>
+    <% if ingress.certificate_name %>
     networking.gke.io/managed-certificates: '<%=ingress.certificate_name%>'
     <% end %>
 

data/lib/templates/service.yml

@@ -4,7 +4,7 @@
 apiVersion: cloud.google.com/v1beta1
 kind: BackendConfig
 metadata:
-  name: '<%=service.config_name%>'
+  name: '<%=service.name%>-bconfig'
 spec:
   timeoutSec: 1800
 ---
@@ -16,7 +16,7 @@ metadata:
   name: '<%=service.name%>'
   annotations:
     <% if cloud.name == 'gcloud' %>
-    beta.cloud.google.com/backend-config: '{"ports": {"80":"<%=service.config_name%>"}}'
+    beta.cloud.google.com/backend-config: '{"ports": {"80":"<%=service.name%>-bconfig"}}'
     <% end %>
 spec:
   selector:

data/lib/templates/settings.rb

@@ -6,6 +6,7 @@ settings = {
   deployment: {
     name: app_name,
     replicas: is_production ? 2 : 1,
+    replicas_range: nil, # [min, max] or nil to ignore, sample: is_production ? [1, 2] : nil
     cloud_secret_name: "#{is_production ? 'production' : 'beta'}-cloud-secret",
     cloud_sql_instance: 'xxx:xxx:xxx=tcp:5432', # 5432 => postgres, 3306 => mysql
     env_vars: {}, # Sample: { 'CUSTOM_VAR' => 'value' }
@@ -20,10 +21,10 @@ settings = {
     name: "#{app_name}-ingress",
     ip_name: "#{app_name}-static-ip", # nil if static ip is not necessary
     certificate_name: "#{app_name}-lets-encrypt", # nil if ssl is not required
-    domain_name: is_production ? 'myapp.com' : 'beta.myapp.com' # nil if domain is not required
+    certificate_domain: is_production ? 'myapp.com' : 'beta.myapp.com' # nil if domain is not required
   },
   continuous_deployment: {
-    image_name: "gcr.io/my-account/#{app_name}",
+    image: "gcr.io/my-account/#{app_name}:latest",
     project_name: 'my-project-name',
     cluster_name: 'my-cluster-name',
     cluster_region: 'europe-west4-a',
@@ -36,8 +37,7 @@ settings = {
   service: {
     name: app_name,
     port_name: 'http-port', # max 15 characters
-    backend_port_name: 'b-port', # max 15 characters
-    config_name: "#{app_name}-backend-config"
+    backend_port_name: 'b-port' # max 15 characters
   }
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb