kubernetes_helper 1.18.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dbeb51cb4e066084e681ea3a15c69b56780641bfbf38efa9dc8595b785de68c
-  data.tar.gz: 11c03302e5c59638b3fb0fa64602be15cfc24ddd41e7818c65afc5ac4df2cf2b
+  metadata.gz: c3ddc1acbc8178da9b6974ef51e84d193a819438a1ec47f3307399c4d09ab89e
+  data.tar.gz: 82a49cdadb9f156d8e0ba7092de2c30a1f912e5127ec8edfc8bbd51db48a3f93
 SHA512:
-  metadata.gz: addb118b0d1d53ccc36843b1ca108d449aba773382ea54dbff665131a8282d9173d57b81a4b95d87a5ffa27f8dbce039fac989a36afd1d579aa48260f823515e
-  data.tar.gz: 17b845c6b15502d98294a82b33d08ddf6109aa2b0e49685ac1f299722980ae17f1d8fb07dc2f4242e093703a0448f20f4556fc2016bc8afdabf3b5088c7eba7d
+  metadata.gz: 683358d87dd5f2d41515512b3d7dd46774dce3f04e57556f515b3238ecec878b7f1a0416afba026ebf1f229b9659cbe02b98c9368cd0bd7cdeddb403ecafc4c7
+  data.tar.gz: '0586f4298b889b1d2068f26f2772f492aa170d77e842207c79f18ee34383d20b00dcc48eb087bb7dad3aea1d79c997bf98515ea796578854b844f4c375b39058'

data/README.md

@@ -49,11 +49,44 @@ 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)
+Ideal to run sidekiq or similar jobs as a service without interacting via HTTP.
 - `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' } }`
+Sample:    
+  ```ruby
+  {
+    job_apps: [
+      {
+        name: "my-app-sidekiq",
+        command: 'bundle exec sidekiq',
+        services: %w[sidekiq],
+        resources: { mem: { max: '10Gi', min: '5Gi' } }
+      }
+    ]
+  }
+
+  ```
+
+### Required settings for Cronjob apps (Note: Cronjobs do not support `sidekiq_alive_gem` and `services`)
+Ideal to process periodic tasks
+- `deployment.job_apps[].schedule` (String): Cron schedule. Sample: `*/5 * * * *`
+- `deployment.job_apps[].kind` (String, default `Deployment`): Kind of job application [`Deployment` or `CronJob`]
+- `deployment.job_apps[].concurrency_policy` (String, default `Forbid`): [Documentation](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#concurrency-policy)
+- `deployment.job_apps[].suspend` (String, default `false`): If `true` then marks as finished the job application (stops creating new pods).
+Sample:    
+  ```ruby
+  {
+      job_apps: [{  
+        name: "my-promotions-cronjob",
+        command: 'bundle exec rake promotions:process > ./log/promotions.log 2>&1',
+        schedule: '0 22 * * *',
+        kind: 'CronJob'
+      }]
+  }
+  ```
 
 ### Applications secrets.yml (Optional)
 - `secrets.name` (String): K8s secrets name where env vars will be saved and fetched from. Sample: `my-app-secrets`

data/lib/kubernetes_helper/core.rb

@@ -78,6 +78,7 @@ module KubernetesHelper
     def render_template(template_name, locals = {})
       path = KubernetesHelper.settings_path(template_name, use_template: true)
       text = "\n#{File.read(path)}"
+      text = text.gsub("\n", "\n#{'  ' * locals[:tab]}") if locals[:tab]
       replace_config_variables(text, locals)
     end
 
@@ -94,12 +95,13 @@ module KubernetesHelper
 
     # parse secrets auto importer
     def parse_import_secrets(document) # rubocop:disable Metrics/AbcSize
-      containers = document.dig('spec', 'template', 'spec', 'containers') || []
+      cronjob_containers = document.dig('spec', 'jobTemplate', 'spec', 'template', 'spec', 'containers')
+      containers = document.dig('spec', 'template', 'spec', 'containers') || cronjob_containers || []
       containers.each do |container|
         container['env'] = (container['env'] || [])
-        container['env'] = container['env'] + static_env_vars if container.delete('static_env')
+        container['env'] = (container['env'] + static_env_vars).uniq if container.delete('static_env')
         if container['import_secrets']
-          container['env'] = container['env'] + import_secrets(*container['import_secrets'])
+          container['env'] = (container['env'] + import_secrets(*container['import_secrets'])).uniq
           container.delete('import_secrets')
         end
       end

data/lib/kubernetes_helper/version.rb

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

data/lib/templates/README.md

@@ -84,50 +84,10 @@ This gem comes with continuous deployment script out of the box which can be exe
     PROD_CLOUD_TOKEN=<secret content here>
   ```
   
-* Add github workflow to automatically run deployment when merged into master or staging, something like:    
-```yml
-name: "Continuous Deployment"
-on:
-  push:
-    branches: 
-      - master
-      - staging
-
-deployment:
-  runs-on: ubuntu-latest
-  jobs:
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          ref: ${{ env.DEPLOY_BRANCH }}
-      - name: Cancel previous Workflow Actions
-        uses: styfle/cancel-workflow-action@0.6.0
-        with:
-          access_token: ${{ github.token }}
-
-      - name: Set up Cloud SDK
-        uses: google-github-actions/setup-gcloud@master
-      - uses: satackey/action-docker-layer-caching@v0.0.11
-        continue-on-error: true
-        with:
-          key: CD-docker-cache-${{ hashFiles('Dockerfile', 'Gemfile.lock') }}
-
-      #### App deployment          
-      - run: sudo gem install kubernetes_helper
-      - name: App deployment
-        env:
-          KB_AUTH_TOKEN: ${{ github.ref_name == 'master' && secrets.PROD_CLOUD_TOKEN || secrets.BETA_CLOUD_TOKEN }}
-          DEPLOY_ENV: ${{ github.ref_name == 'master' && 'production' || 'beta' }}
-        run: kubernetes_helper run_deployment 'cd.sh'
-```   
+* Add github workflow to automatically run deployment when merged into master or staging: [See here](https://github.com/owen2345/reusable-ci-cd-actions#continuous-deployment)
   
-## Apply any k8s setting changes
-- Secrets    
-  Open kubernetes secrets and add/edit/remove values and then save it    
-  `kubectl edit secret ...`
-  Once secrets were updated, then restart all related pods, see: https://medium.com/devops-dudes/how-to-propagate-a-change-in-kubernetes-secrets-by-restarting-dependent-pods-b71231827656
-  
-- Other settings    
+## Apply deployment changes manually     
+  Note: it can be enable for auto update with (`settings.rb`): `update_deployment: true`
   ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'deployment.yml' 'kubectl apply'
-  ```  
+  ```

data/lib/templates/_cd_digital.sh

@@ -12,11 +12,7 @@ fi
 
 ## Build and push containers
 echo "****** building image..."
-<% if continuous_deployment.docker_cmd %>
-  <%= continuous_deployment.docker_cmd %>
-<% else %>
-  docker <%=continuous_deployment.docker_build_cmd || 'build -f Dockerfile'%> -t $DEPLOY_NAME .
-<% end %>
+eval $DOCKER_BUILD_CMD
 docker push $DEPLOY_NAME
 
 echo "****** tagging image $DEPLOY_NAME as $LATEST_NAME"

data/lib/templates/_cd_google.sh

@@ -23,11 +23,7 @@ if [ -z $ALREADY_DEPLOYED ]
 then
   ## Build and push containers
   echo "****** image not created yet, building image..."
-  <% if continuous_deployment.docker_cmd %>
-    <%= continuous_deployment.docker_cmd %>
-  <% else %>
-    docker <%=continuous_deployment.docker_build_cmd || 'build -f Dockerfile'%> -t $DEPLOY_NAME .
-  <% end %>
+  eval $DOCKER_BUILD_CMD
   docker push $DEPLOY_NAME
 else
   echo "****** image was already created: $ALREADY_DEPLOYED"

data/lib/templates/_cronjobs_pod.yml

@@ -0,0 +1,41 @@
+  - apiVersion: batch/v1
+    kind: CronJob
+    metadata:
+      name: &cronjob_name <%= locals[:job_app][:name] %>
+    spec:
+      schedule: "<%= locals[:job_app][:schedule] %>"
+      concurrencyPolicy: "<%= locals[:job_app][:concurrency_policy] || 'Forbid' %>"
+      suspend: <%= locals[:job_app][:suspend] || false %>
+      # startingDeadlineSeconds: 200
+      jobTemplate:
+        spec:
+          template:
+            spec:
+              <<: *template_spec
+              restartPolicy: OnFailure
+              containers:
+                - <<: *app_container
+                  name: *cronjob_name
+                  <% if locals[:job_app][:command] %>
+                  command: [ "/bin/bash", "-c", "<%= locals[:job_app][:command] %>" ]
+                  <% end %>
+                  <% if locals[:job_app][:resources] %>
+                  <%= include_template "_resources.yml", locals[:job_app][:resources].merge(tab: 2) %>
+                  <% end %>
+                  ports: [ ]
+                  livenessProbe: null
+                  readinessProbe: null
+                  <%= include_template "_container_extra_settings.yml", { pod: 'job', pod_name: locals[:job_app][:name], tab: 2 } %>
+
+                <% if deployment.cloud_secret_name %>
+                - *cloudsql_container
+                <% end %>
+
+                <% if deployment.log_container %>
+                - <<: *logs_container
+                <% end %>
+
+              <%= include_template "_custom_containers.yml", { pod: 'job', pod_name: locals[:job_app][:name], tab: 2 } %>
+
+              volumes:
+                <%= include_template "_volumes.yml", { pod: 'job', pod_name: locals[:job_app][:name], tab: 2 } %>

data/lib/templates/_job_liveness.yml

@@ -1,12 +1,15 @@
               ports: [ ]
-              <% if (deployment.job_services || []).any? %>
+              <% if (locals[:services] || []).any? %>
               livenessProbe: &liveness_probe
                 exec:
                    command: [ /bin/sh, -c,
-                     'if [ $(ps -ef | grep "<%= deployment.job_services.join("\\|") %>" | grep -v "grep" | wc -l) -lt <%= deployment.job_services.count %> ]; then
+                     'if [ $(ps -ef | grep "<%= locals[:services].join("\\|") %>" | grep -v "grep" | wc -l) -lt <%= locals[:services].count %> ]; then
                                echo "Some required services are not running"; exit 1;
                            fi' ]
                 initialDelaySeconds: 120
                 periodSeconds: 30
               readinessProbe: *liveness_probe
+              <% else %>
+              livenessProbe: null
+              readinessProbe: null
               <% end %>

data/lib/templates/_jobs_pod.yml

@@ -0,0 +1,47 @@
+  - apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      name: &job_app_name <%= locals[:job_app][:name] %>
+    spec:
+      replicas: 1
+      selector:
+        matchLabels:
+          name: *job_app_name
+      strategy:
+        type: Recreate
+      minReadySeconds: 10
+      template:
+        metadata:
+          labels:
+            name: *job_app_name
+        spec:
+          <<: *template_spec
+          containers:
+            - <<: *app_container
+              name: *job_app_name
+              <% if locals[:job_app][:command] %>
+              command: [ "/bin/bash", "-c", "<%= locals[:job_app][:command] %>" ]
+              <% end %>
+              <% if locals[:job_app][:resources] %>
+              <%= include_template "_resources.yml", locals[:job_app][:resources] %>
+              <% end %>
+            <%= include_template "_container_extra_settings.yml", { pod: 'job', pod_name: locals[:job_app][:name] } %>
+
+            <% if locals[:job_app][:sidekiq_alive_gem] %>
+            <%= include_template "_sidekiq_alive_gem.yml" %>
+            <% else %>
+            <%= include_template "_job_liveness.yml", { services: locals[:job_app][:services] } %>
+            <% end %>
+
+            <% if deployment.cloud_secret_name %>
+            - *cloudsql_container
+            <% end %>
+
+            <% if deployment.log_container %>
+            - <<: *logs_container
+            <% end %>
+
+          <%= include_template "_custom_containers.yml", { pod: 'job', pod_name: locals[:job_app][:name] } %>
+
+          volumes:
+            <%= include_template "_volumes.yml", { pod: 'job', pod_name: locals[:job_app][:name] } %>

data/lib/templates/_volumes.yml

@@ -18,4 +18,4 @@
                 <% end %>
               <% end %>
 
-            <%= include_template "_custom_volumes.yml", { pod: locals[:pod] } %>
+            <%= include_template "_custom_volumes.yml", { pod: locals[:pod], tab: locals[:tab] } %>

data/lib/templates/cd.sh

@@ -16,6 +16,12 @@ CI_COMMIT_SHA=${CI_COMMIT_SHA:-$(date +%s) }
 DEPLOY_NAME="${IMAGE_NAME}:${CI_COMMIT_SHA}"
 LATEST_NAME="${IMAGE_NAME}:<%= continuous_deployment.image_tag || 'latest' %>"
 
+<% if continuous_deployment.docker_cmd %>
+  DOCKER_BUILD_CMD="<%= continuous_deployment.docker_cmd %>"
+<% else %>
+  DOCKER_BUILD_CMD="docker <%=continuous_deployment.docker_build_cmd || 'build -f Dockerfile'%> -t $DEPLOY_NAME --build-arg DEPLOY_VERSION=${DEPLOY_VERSION} ."
+<% end %>
+
 <%= include_template "_cd_google.sh" if continuous_deployment.image_name.include?('gcr.io/') %>
 <%= include_template "_cd_digital.sh" if continuous_deployment.image_name.include?('digitalocean.com/') %>
 

data/lib/templates/deployment.yml

@@ -3,7 +3,7 @@ documents:
     kind: Deployment
     metadata:
       name: &app_name <%=deployment.name%>
-    spec: &default_spec
+    spec:
       replicas: <%=deployment.replicas%>
       selector:
         matchLabels:
@@ -107,53 +107,8 @@ documents:
             <%= include_template "_volumes.yml", { pod: 'web' } %>
 
   <% deployment.job_apps.each do |job_app| %>
-  - apiVersion: apps/v1
-    kind: Deployment
-    metadata:
-      name: &job_app_name <%= job_app[:name] %>
-    spec:
-      <<: *default_spec
-      replicas: 1
-      selector:
-        matchLabels:
-          name: *job_app_name
-      strategy:
-        type: Recreate
-      template:
-        metadata:
-          labels:
-            name: *job_app_name
-        spec:
-          <<: *template_spec
-          containers:
-            - <<: *app_container
-              name: *job_app_name
-              <% if job_app[:command] %>
-              command: [ "/bin/bash", "-c", "<%= job_app[:command] %>" ]
-              <% end %>
-              <% if job_app[:resources] %>
-              <%= include_template "_resources.yml", job_app[:resources] %>
-              <% end %>
-              <%= include_template "_container_extra_settings.yml", { pod: 'job', pod_name: job_app[:name] } %>
-
-            <% if job_app[:sidekiq_alive_gem] %>
-            <%= include_template "_sidekiq_alive_gem.yml" %>
-            <% else %>
-            <%= include_template "_job_liveness.yml" %>
-            <% end %>
-
-            <% if deployment.cloud_secret_name %>
-            - *cloudsql_container
-            <% end %>
-
-            <% if deployment.log_container %>
-            - <<: *logs_container
-            <% end %>
-
-            <%= include_template "_custom_containers.yml", { pod: 'job', pod_name: job_app[:name] } %>
-
-          volumes:
-            <%= include_template "_volumes.yml", { pod: 'job', pod_name: job_app[:name] } %>
+  <%= include_template '_jobs_pod.yml', job_app: job_app if job_app[:kind] != 'CronJob' %>
+  <%= include_template '_cronjobs_pod.yml', job_app: job_app if job_app[:kind] == 'CronJob' %>
   <% end %>
 
   <% if deployment.replicas_range %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -44,9 +44,11 @@ files:
 - lib/templates/_cd_digital.sh
 - lib/templates/_cd_google.sh
 - lib/templates/_container_extra_settings.yml
+- lib/templates/_cronjobs_pod.yml
 - lib/templates/_custom_containers.yml
 - lib/templates/_custom_volumes.yml
 - lib/templates/_job_liveness.yml
+- lib/templates/_jobs_pod.yml
 - lib/templates/_replicas.yml
 - lib/templates/_resources.yml
 - lib/templates/_sidekiq_alive_gem.yml