kubernetes_helper 1.19.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72fcd92010ce2e1144a926d617c13985b39941ff58e177f24eb8b68828bd572
-  data.tar.gz: f0798e685be4fde2efefd86e3869e05449c871a766686537db3085f7d6cb40d9
+  metadata.gz: c3ddc1acbc8178da9b6974ef51e84d193a819438a1ec47f3307399c4d09ab89e
+  data.tar.gz: 82a49cdadb9f156d8e0ba7092de2c30a1f912e5127ec8edfc8bbd51db48a3f93
 SHA512:
-  metadata.gz: fe823997d5ea50090e1389b1224cd78d9819f2c3f9c64e34451d1902aa1985b0a563f6768be1c873fcc63cc89ef06ea7494f756e2042984eb8d431f9fced8f16
-  data.tar.gz: ed8f9612237443578f3c6f862107e1e23639458290e2389409014f001734e6e71198c5b0abde07990d53ed6c4ee408ba3ea9abf4b409669103080cddded2eda1
+  metadata.gz: 683358d87dd5f2d41515512b3d7dd46774dce3f04e57556f515b3238ecec878b7f1a0416afba026ebf1f229b9659cbe02b98c9368cd0bd7cdeddb403ecafc4c7
+  data.tar.gz: '0586f4298b889b1d2068f26f2772f492aa170d77e842207c79f18ee34383d20b00dcc48eb087bb7dad3aea1d79c997bf98515ea796578854b844f4c375b39058'

data/README.md

@@ -49,19 +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 without internet connection. (TODO)
+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 asasas (TODO)
+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.1'
+  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/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/') %>
 

metadata

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