kubernetes_helper 1.15.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b09fe0251ca84cfc1251acbf3f4079d02b5830abe77d3dc34c49b71ae2813ef
-  data.tar.gz: fff66310d7051331a334eb1e3a250c92413348f17818dda5426fcaca0581a3b1
+  metadata.gz: 2dbeb51cb4e066084e681ea3a15c69b56780641bfbf38efa9dc8595b785de68c
+  data.tar.gz: 11c03302e5c59638b3fb0fa64602be15cfc24ddd41e7818c65afc5ac4df2cf2b
 SHA512:
-  metadata.gz: ae4c26493643bc9fd8897ef362a476457e801868d8c3b12202889a1e7276fc8148b6bc247caec5a891985a81855296d142253b46517c7edd0f0e823fc4b2f77e
-  data.tar.gz: ee94f2b9c13ecae82253900502e3c00c20f0cc72fbf2e9046a31bbc2a56391f4098819b7725f404f220a8a38898398658f0dfc1d2524093350dd47c02ea81435
+  metadata.gz: addb118b0d1d53ccc36843b1ca108d449aba773382ea54dbff665131a8282d9173d57b81a4b95d87a5ffa27f8dbce039fac989a36afd1d579aa48260f823515e
+  data.tar.gz: 17b845c6b15502d98294a82b33d08ddf6109aa2b0e49685ac1f299722980ae17f1d8fb07dc2f4242e093703a0448f20f4556fc2016bc8afdabf3b5088c7eba7d

data/README.md

@@ -22,7 +22,7 @@ Configuration and customization can be done for multiple environments and at any
       Note: The local template will be used instead of the default one.
 
 3. Install/setup the application on kubernetes    
-  Open [.kubernetes/README.md](lib/templates/README.md) to see the instructions (customize the file according to your project and keep it updated)
+  Open [.kubernetes/README.md](lib/templates/README.md) to see the instructions (customize the file according to your project and keep it updated in your repository)
 
 
 ## Settings API
@@ -49,20 +49,25 @@ Configuration and customization can be done for multiple environments and at any
 - `deployment.logs_resources` (Hash, optional): Configure depending on the app requirements. Default: `{ cpu: { max: '200m', min: '50m' }, mem: { max: '200Mi', min: '50Mi' } }`
 
 ### Application deployment.yml for jobs or services without internet interaction (Optional)
-- `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']` 
-- `deployment.job_resources` (Hash, optional): Configure depending on the job app requirements. Sample: `{ cpu: { max: '1', min: '500m' }, mem: { max: '1Gi', min: '500Mi' } }`
+- `deployment.job_apps[].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_apps[].command` (String, optional): Bash command to be used for job container. Sample: `bundle exec sidekiq`
+- `deployment.job_apps[].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_apps[].services` (Array, Optional): List of linux service names that are required for a healthy job container. Sample: `['sidekiq', 'cron']`. Note: This will be ignored if `sidekiq_alive_gem` was defined.     
+- `deployment.job_apps[].resources` (Hash, optional): Configure depending on the job app requirements. Sample: `{ cpu: { max: '1', min: '500m' }, mem: { max: '1Gi', min: '500Mi' } }`
 
 ### Applications secrets.yml (Optional)
 - `secrets.name` (String): K8s secrets name where env vars will be saved and fetched from. Sample: `my-app-secrets`
-
+- `secrets.import_all_secrets` (Boolean, default false): 
+  - `true`: Allows k8s to auto import all secrets from `secrets.yml` as env values for the apps (No longer needed to update `deployment.yml` everytime there is a new env var)
+  - `false`: Permits to the gem to auto include each secret from `secrets.yml -> data` as env value for the apps (base64 encoded values. Requires to update `deployment.yml` everytime there is a new env var)
+    
 ### Application service.yml (Optional)
 - `service.name`: K8s service name. Sample: `my-app-service`
 - `service.port_name` (String, default `http-port`): Http port name to connect between k8s ingress and service. Sample: `http-port`. Note: max 15 characters
 - `service.backend_port_name` (String, default `b-port`): Web backend port name to be connected between k8s service and web deployments. Sample: `b-port`. Note: max 15 characters
 - `service.type`: K8s service type. By default `NodePort`
+- `service.do_certificate_id`: Digital Ocean certificate ID to be used for the loadbalancer to auto redirect http to https.       
+   Note: This value can be fetched via `doctl compute certificate list`. If there are no certificates available, you can generate a new one using digital ocean dashboard -> networking -> certificates.
 
 ### Application ingress.yml (Optional)
 - `ingress.name`: Name of k8s ingress for the app: Sample: `my-app-ingress`
@@ -71,7 +76,7 @@ Configuration and customization can be done for multiple environments and at any
 - `ingress.certificate_domain` (Optional): Domain name for the certificate. Sample: `myapp.com`. Note: does not support for willcard domains     
    To register multiple domains (Certificate names will be auto-generated like `mysite-com-lets-encrypt`): `certificate_domain: ['mysite.com', 'mysite.de', 'mysite.uk']`
 
-- `cloud.name` (String, optional): Cloud service name. Default `gcloud`.  
+- `cloud.name` (String, optional): Cloud service name: `gcloud | digital_ocean`. Default `gcloud`.  
 
 ### Application CD (continuous deployment)
 - `continuous_deployment.image_name` (String): Partial docker image url. Sample: `gcr.io/my-account/my_app_name`
@@ -86,7 +91,7 @@ Configuration and customization can be done for multiple environments and at any
 - `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)
 
 ### Gem templating partials
-- `_container_extra_settings.yml` Partial template to add custom container settings. Receives `pod` as local variable (`web` | `job` | `cloudsql` | `logs`). Sample:
+- `_container_extra_settings.yml` Partial template to add custom container settings. Receives `pod` as local variable (`web` | `job` | `cloudsql` | `logs`) and `pod_name`. Sample:
   ```yaml
                <% if locals[:pod] == 'job' %>
                resources:
@@ -98,7 +103,7 @@ Configuration and customization can be done for multiple environments and at any
                    memory: 1Gi
                <% end %>
   ``` 
-- `_custom_containers.yml` Partial template to add extra containers (Receives `pod` as local variable: `web` | `job`). Sample:
+- `_custom_containers.yml` Partial template to add extra containers (Receives `pod` as local variable: `web` | `job`) and `pod_name`. Sample:
 ```yaml
            <% if locals[:pod] == 'job' %>
            - name: scraper

data/lib/kubernetes_helper/core.rb

@@ -67,7 +67,7 @@ module KubernetesHelper
     def import_secrets(path, secrets_name)
       path = KubernetesHelper.settings_path(path)
       data = YAML.load(File.read(path)) # rubocop:disable Security/YAMLLoad
-      data['data'].keys.map do |secret|
+      (data['data'] || {}).keys.map do |secret|
         {
           'name' => secret.upcase,
           'valueFrom' => { 'secretKeyRef' => { 'name' => secrets_name, 'key' => secret } }

data/lib/kubernetes_helper/version.rb

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

data/lib/kubernetes_helper.rb

@@ -25,7 +25,8 @@ module KubernetesHelper
       deployment: {
         log_container: true,
         log_folder: '/app/log',
-        external_secrets: {}
+        external_secrets: {},
+        job_apps: settings[:job_apps] || job_apps_from_old_settings(settings)
       },
       service: {
         port_name: 'http-port',
@@ -75,4 +76,18 @@ module KubernetesHelper
       FileUtils.cp(templates_path(name), path) unless File.exist?(path)
     end
   end
+
+  def self.job_apps_from_old_settings(settings)
+    return [] unless settings[:deployment][:job_name]
+
+    [
+      {
+        name: settings[:deployment][:job_name],
+        command: settings[:deployment][:job_command],
+        services: settings[:deployment][:job_services],
+        resources: settings[:deployment][:job_resources],
+        sidekiq_alive_gem: settings[:deployment][:job_sidekiq_alive_gem]
+      }
+    ]
+  end
 end

data/lib/templates/README.md

@@ -25,9 +25,8 @@
     DEPLOY_ENV=beta kubernetes_helper run_command "kubectl create secret generic <%=deployment.cloud_secret_name%> --from-file=credentials.json=<path-to-downloaded/credentials.json>"
     ```
     
-- Register manually env vars (values must be encrypted using base64)     
+- Register manually env vars     
     Open and register secret values in `.kubernetes/secrets.yml`     
-    Note: Enter base64 encoded values      
     ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'secrets.yml' 'kubectl create'
     # kubectl get secrets # to list all secrets registered

data/lib/templates/cd.sh

@@ -5,7 +5,7 @@ set -e
 SCRIPT_DIR=`dirname "$(realpath -s "$0")"` # app_dir/.kubernetes/
 cd "$SCRIPT_DIR/../" # project directory
 
-DEPLOYMENTS="<%=[deployment.job_name, deployment.name].join(',')%>"
+DEPLOYMENTS="<%=(deployment.job_apps.map { |a| a[:name] } + [deployment.name]).join(',')%>"
 IMAGE_NAME="<%=continuous_deployment.image_name%>"
 CLUSTER_NAME="<%=continuous_deployment.cluster_name%>"
 PROJECT_NAME="<%=continuous_deployment.project_name%>"
@@ -21,7 +21,7 @@ LATEST_NAME="${IMAGE_NAME}:<%= continuous_deployment.image_tag || 'latest' %>"
 
 ## Update new secrets defined in secrets.yml as ENV vars for deployments
 <% if continuous_deployment.update_deployment %>
-  kubernetes_helper run_yml 'deployment.yml' 'kubectl apply'
+  DEPLOY_IMAGE_TAG=$CI_COMMIT_SHA kubernetes_helper run_yml 'deployment.yml' 'kubectl apply'
 <% end %>
 
 ## Apply deployments

data/lib/templates/deployment.yml

@@ -12,8 +12,8 @@ documents:
         type: RollingUpdate
         rollingUpdate:
           maxSurge: 1
-          maxUnavailable: 1
-      minReadySeconds: 5
+          maxUnavailable: 0
+      minReadySeconds: 10
       template:
         metadata:
           labels:
@@ -21,13 +21,21 @@ documents:
         spec: &template_spec
           containers:
             - &app_container
-              image: '<%= continuous_deployment.image_name %>:<%= continuous_deployment.image_tag || "latest" %>'
+              image: '<%= continuous_deployment.image_name %>:<%= ENV['DEPLOY_IMAGE_TAG'] || continuous_deployment.image_tag || "latest" %>'
               <% if deployment.command %>
               command: ["/bin/bash", "-c", "<%= deployment.command %>"]
               <% end %>
               name: *app_name
+
               static_env: true
+              <% if secrets.import_all_secrets %>
+              envFrom:
+              - secretRef:
+                  name: <%= secrets.name %>
+              <% else %>
               import_secrets: ['secrets.yml', '<%=secrets.name%>']
+              <% end %>
+
               ports:
                 - containerPort: &port <%= deployment.app_port || 3000 %>
                   name: '<%=service.backend_port_name || 'b-port'%>'
@@ -98,18 +106,19 @@ documents:
           volumes:
             <%= include_template "_volumes.yml", { pod: 'web' } %>
 
-
-  <% if deployment.job_name %>
+  <% deployment.job_apps.each do |job_app| %>
   - apiVersion: apps/v1
     kind: Deployment
     metadata:
-      name: &job_app_name <%=deployment.job_name%>
+      name: &job_app_name <%= job_app[:name] %>
     spec:
       <<: *default_spec
       replicas: 1
       selector:
         matchLabels:
           name: *job_app_name
+      strategy:
+        type: Recreate
       template:
         metadata:
           labels:
@@ -119,18 +128,18 @@ documents:
           containers:
             - <<: *app_container
               name: *job_app_name
-              <% if deployment.job_command %>
-              command: [ "/bin/bash", "-c", "<%= deployment.job_command %>" ]
+              <% if job_app[:command] %>
+              command: [ "/bin/bash", "-c", "<%= job_app[:command] %>" ]
               <% end %>
-              <% if deployment.job_resources %>
-              <%= include_template "_resources.yml", deployment.job_resources %>
+              <% if job_app[:resources] %>
+              <%= include_template "_resources.yml", job_app[:resources] %>
               <% end %>
-              <%= include_template "_container_extra_settings.yml", { pod: 'job' } %>
+              <%= include_template "_container_extra_settings.yml", { pod: 'job', pod_name: job_app[:name] } %>
 
-            <% if deployment.job_sidekiq_alive_gem %>
-              <%= include_template "_sidekiq_alive_gem.yml" %>
+            <% if job_app[:sidekiq_alive_gem] %>
+            <%= include_template "_sidekiq_alive_gem.yml" %>
             <% else %>
-              <%= include_template "_job_liveness.yml" %>
+            <%= include_template "_job_liveness.yml" %>
             <% end %>
 
             <% if deployment.cloud_secret_name %>
@@ -141,10 +150,10 @@ documents:
             - <<: *logs_container
             <% end %>
 
-            <%= include_template "_custom_containers.yml", { pod: 'job' } %>
+            <%= include_template "_custom_containers.yml", { pod: 'job', pod_name: job_app[:name] } %>
 
           volumes:
-            <%= include_template "_volumes.yml", { pod: 'job' } %>
+            <%= include_template "_volumes.yml", { pod: 'job', pod_name: job_app[:name] } %>
   <% end %>
 
   <% if deployment.replicas_range %>

data/lib/templates/secrets.yml

@@ -1,4 +1,3 @@
-# Every Value has to be base64 encoded
 # IMPORTANT: For security reason, never ever commit secret values, only keys
 
 apiVersion: v1
@@ -6,6 +5,6 @@ kind: Secret
 metadata:
   name: '<%=secrets.name%>'
 type: Opaque
-data:
-  my_key1: "based_64_value_encoded"
-  my_key2: "based_64_value_encoded"
+stringData:
+  MY_KEY1: "my value1"
+  MY_KEY2: "my value2"

data/lib/templates/service.yml

@@ -15,6 +15,11 @@ apiVersion: v1
 metadata:
   name: '<%=service.name%>'
   annotations:
+    <% if cloud.name == 'digital_ocean' && service.do_certificate_id %>
+    service.beta.kubernetes.io/do-loadbalancer-protocol: "https"
+    service.beta.kubernetes.io/do-loadbalancer-certificate-id: <%= service.do_certificate_id %>
+    service.beta.kubernetes.io/do-loadbalancer-redirect-http-to-https: "true"
+    <% end %>
     <% if cloud.name == 'gcloud' %>
     beta.cloud.google.com/backend-config: '{"ports": {"80":"<%=service.name%>-bconfig"}}'
     <% end %>
@@ -27,3 +32,10 @@ spec:
       protocol: TCP
       name: '<%=service.port_name%>'
       targetPort: '<%=service.backend_port_name%>'
+
+    <% if cloud.name == 'digital_ocean' && service.do_certificate_id %>
+    - name: https
+      protocol: TCP
+      port: 443
+      targetPort: '<%=service.backend_port_name%>'
+    <% end %>

data/lib/templates/settings.rb

@@ -12,13 +12,18 @@ settings = {
     env_vars: {}, # Sample: { 'CUSTOM_VAR' => 'value' }
     # command: '', # custom container command (default empty to be managed by Dockerfile)
     # liveness_path: '/check_liveness', # nil if not exist
-    # job_name: "#{app_name}-job", # enable if there is any background service
-    # job_command: 'bundle exec sidekiq -C config/sidekiq.yml',
-    # job_services: ['sidekiq', 'cron'] # list of linux services needed.
     # custom_volumes: { my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }
+    job_apps: [
+      # {
+      #   name: "#{app_name}-job", # enable if there is any background service
+      #   command: 'bundle exec sidekiq -C config/sidekiq.yml',
+      #   services: ['sidekiq', 'cron'] # list of linux services needed.
+      # }
+    ]
   },
   secrets: {
-    name: "#{app_name}-secrets"
+    name: "#{app_name}-secrets",
+    import_all_secrets: true
   },
   service: {
     name: app_name,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.15.2
+  version: 1.18.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb