kubernetes_helper 1.12.7 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386faaa431a2175aef58d35449263616ceaa27eb50c7eed09e4b2f2273321e62
-  data.tar.gz: 9a34b266ab98773d7453c28aec664f37dbf49d21d87e6b6f8d919ef9079bded5
+  metadata.gz: 071cbd7243cf091dddbb90ae098afb3af88e8469c0b5db41a22f631907f1e529
+  data.tar.gz: c3d0a6f4bf022441862921cfca4fd3d8be219309a23312c15f693c15ce88f1b7
 SHA512:
-  metadata.gz: 8e328d4a95e718f3815abd517cd8e1bb0ade62b80fbd25770eb6fb2e3730a7993098940e61bc65c56aa5538f94d707517a4ad5867be2189825734a812162c641
-  data.tar.gz: e807a576fae8a3402dba6fd6f3dd964dc75cfe55b3afde6df16ae2c8584f319194c8da2c637c97576b07ef17e766d4440866d296eb8f1f9e353401c4bf7f7fab
+  metadata.gz: cc4adcdfc85d9b12cbfaf7d4b523a9585a12e9f6da55c140429e818aa05ab70380c1c45fd6209fb5a25c7ff59b28e73e45178a051031a4268321382a9f6afc03
+  data.tar.gz: 639e58559bb0768a78fd21e5d568db6c40747d225975679d6cd6873da52d388bd086bb53d0212b8828dd76ed4e562a600277004a41a3a121126db1b79d51a5d7

data/README.md

@@ -70,13 +70,17 @@ Below settings are used when configuring the application in the k8s environment
 - `deployment.replicas_range` (Array<min, max, cpu_percentage>, Optional): Defines the minimum and the maximum number of pods that could automatically be created when `CPUUtilizationPercentage` is above than defined. Sample: `[1, 3, 50]`
 - `deployment.cloud_secret_name` (String, Optional): K8s credentials name where cloud secrets will be saved (includes permission like DB). Sample: `my-app-cloud-secret`
 - `deployment.cloud_sql_instance` (String, Optional): Cloud sql instance name. Sample: `my-project:europe-west1:my-instance-name=tcp:5432` (5432 => postgres, 3306 => mysql)
-- `deployment.env_vars` (Hash, optional): List of static env variables (Note: Not recommended for sensitive values). Sample: `{ 'RAILS_ENV' => 'production' }`
+- `deployment.env_vars` (Hash, optional): List of static or external env variables (Note: Not recommended for sensitive values).      
+   Sample: `{ 'RAILS_ENV' => 'production' }`      
+   Example for external secrets: `{ PAPERTRAIL_PORT: { name: 'common_secrets', key: 'paper_trail_port' }` will import `paper_trail_port` value from `common_secrets` yml as `PAPERTRAIL_PORT`
+  
 - `deployment.command` (String, Optional): Bash command to be used for web containers. Sample: `rails s -b 0.0.0.0`
 - `deployment.liveness_path` (String, Optional): Relative path to be used for readiness and liveness checker of the web app. Sample: `/check_liveness`
 - `deployment.custom_volumes` (Hash<name: path>, Optional): Custom volumes to be mounted. 
     Sample volume: `{ my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }`    
     Sample secret: `{ pubsub_secret: { kind: 'secret', mount_path: '/secrets/pubsub', settings: { secretName: 'my_secret_name' } } }`
 - `deployment.log_container` (Boolean, default true): Permits to auto include logs container to print all logs from logs/*.log to stdout (required for papertrail using fluentd)
+- `deployment.log_folder` (String, default `/app/log`): Logs to be printed from
 - `deployment.app_port` (Integer, default 3000): Application port number
 
 - `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

data/lib/kubernetes_helper/core.rb

@@ -83,9 +83,11 @@ module KubernetesHelper
 
     def static_env_vars
       (config_values.dig(:deployment, :env_vars) || {}).map do |key, value|
+        external = value.is_a?(Hash)
+        value = { 'secretKeyRef' => { 'name' => value[:name], 'key' => value[:key].to_s } } if external
         {
           'name' => key.to_s,
-          'value' => value
+          (external ? 'valueFrom' : 'value') => value
         }
       end
     end

data/lib/kubernetes_helper/version.rb

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

data/lib/kubernetes_helper.rb

@@ -23,7 +23,9 @@ module KubernetesHelper
         name: 'gcloud'
       },
       deployment: {
-        log_container: true
+        log_container: true,
+        log_folder: '/app/log',
+        external_secrets: {}
       },
       service: {
         port_name: 'http-port',

data/lib/templates/deployment.yml

@@ -48,7 +48,7 @@ documents:
                 <% if deployment.log_container %>
                 - &log_volume
                   name: applog
-                  mountPath: /app/log
+                  mountPath: <%= deployment.log_folder %>
                 <% end %>
 
                 <% if deployment.cloud_secret_name %>
@@ -80,7 +80,7 @@ documents:
             - &logs_container # print to stdout all log files
               name: print-logs
               image: busybox
-              command: [/bin/sh, -c, 'until find /app/log/*.log; do sleep 1; done; tail -n+1 -f /app/log/*.log']
+              command: [/bin/sh, -c, 'until find <%= deployment.log_folder %>/*.log; do sleep 1; done; tail -n+1 -f <%= deployment.log_folder %>/*.log']
               env: []
               volumeMounts:
                 - *log_volume

data/lib/templates/settings.rb

@@ -17,6 +17,12 @@ settings = {
     # job_services: ['sidekiq', 'cron'] # list of linux services needed.
     # custom_volumes: { my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }
   },
+  secrets: {
+    name: "#{app_name}-secrets"
+  },
+  service: {
+    name: app_name,
+  },
   ingress: {
     name: "#{app_name}-ingress",
     ip_name: "#{app_name}-static-ip", # nil if static ip is not necessary
@@ -32,12 +38,6 @@ settings = {
     docker_build_cmd: 'build -f Dockerfile', # using target: 'build --target production -f Dockerfile '
     update_deployment: false # permits to reload secrets and re-generate/update deployment yaml
   },
-  secrets: {
-    name: "#{app_name}-secrets"
-  },
-  service: {
-    name: app_name,
-  }
 }
 
 KubernetesHelper.settings(settings)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.12.7
+  version: 1.13.1
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb