kubernetes_helper 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304a3005e0ef0280b53a2d108a0880a5406354a135027fb57cefff5e0ed5c437
-  data.tar.gz: dfb38b6b47866ca50ba1c88d11dcad20101827f93a8f617dca95b3b3e225b31d
+  metadata.gz: 2dbeb51cb4e066084e681ea3a15c69b56780641bfbf38efa9dc8595b785de68c
+  data.tar.gz: 11c03302e5c59638b3fb0fa64602be15cfc24ddd41e7818c65afc5ac4df2cf2b
 SHA512:
-  metadata.gz: d02d6bfefa1404a9a906c964c0ebb2e3979835fbcf539aeb99179cf850e08d87d1aa1c75f878ffb051fa0769a5ea19cf4ff73707bffc8aa5031eed59ee1081fa
-  data.tar.gz: 3b40bf03b9498aed70c286170536764bd4ebe3ee8840b197584e831cbd4e5965e27671802dc30a4481de99093e18e9d9f8066728d4e95dbbed58c61032aa61b5
+  metadata.gz: addb118b0d1d53ccc36843b1ca108d449aba773382ea54dbff665131a8282d9173d57b81a4b95d87a5ffa27f8dbce039fac989a36afd1d579aa48260f823515e
+  data.tar.gz: 17b845c6b15502d98294a82b33d08ddf6109aa2b0e49685ac1f299722980ae17f1d8fb07dc2f4242e093703a0448f20f4556fc2016bc8afdabf3b5088c7eba7d

data/README.md

@@ -57,7 +57,10 @@ Configuration and customization can be done for multiple environments and at any
 
 ### 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

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.17.0'
+  VERSION = '1.18.0'
 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,7 +12,7 @@ documents:
         type: RollingUpdate
         rollingUpdate:
           maxSurge: 1
-          maxUnavailable: 1
+          maxUnavailable: 0
       minReadySeconds: 10
       template:
         metadata:
@@ -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'%>'

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/settings.rb

@@ -22,7 +22,8 @@ settings = {
     ]
   },
   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.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb