kubernetes_helper 1.19.0 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d37444885845a0d47f9824c6b9e220f278ae7db62de9cc7d3222d3ea91da753
-  data.tar.gz: 64834c2950efa2394c032adfacdd13b8dcb392d7a5346a6101fb7c7c04e30c92
+  metadata.gz: 06d96c71b76d19776633e4c87af5dd1ef111411e1e547cc3c1ed02b02dd8dbe4
+  data.tar.gz: b1d06ffb2d9171a8ee8b2bdb3df4c040ae5e0b61e0ba4b2ade820b01c8633b21
 SHA512:
-  metadata.gz: aa17228790e2b026d284272ae7312d9a241d00646be1fb904b863fec037c266d95e853932d3d4c62147db54e9b167d30a89191f50d8d7ae5da74605b963f7100
-  data.tar.gz: 65a3991a40379500a37789b37af86c258d472d627a48e95f108366050ff9300f7cc4851981e3723092074dbe161d2366935022df629447117a6cce0e7d137609
+  metadata.gz: '09f1196d7c49cb45b312ce5f7b5a3a1a95a69687008d72387cee15bd7b587e0c86448c8084fb95c42e64f0590a970521be8c0900a46e4f742fa78f20e0a3f313'
+  data.tar.gz: 5f30b70d43b0d622a95ed011830bdf8f0df54458251a4f7382e894e7a1f2eac69d9e97e146f8372a8055a3d929bb0c4a832c7efabe7c60a1db346e963acfa79a

data/README.md

@@ -49,17 +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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KubernetesHelper
-  VERSION = '1.19.0'
+  VERSION = '1.20.1'
 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

@@ -22,6 +22,7 @@
                   <% 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 } %>

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

@@ -30,7 +30,7 @@
             <% if locals[:job_app][:sidekiq_alive_gem] %>
             <%= include_template "_sidekiq_alive_gem.yml" %>
             <% else %>
-            <%= include_template "_job_liveness.yml" %>
+            <%= include_template "_job_liveness.yml", { services: locals[:job_app][:services] } %>
             <% end %>
 
             <% if deployment.cloud_secret_name %>

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} --build-arg DEPLOY_ENV=${DEPLOY_ENV} ."
+<% 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/') %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.1
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb