kubernetes_helper 1.12.6 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf87f6d177cb37e15c19d46f4a4441499d2626343fd37ca723e6145ec2d28129
-  data.tar.gz: 6460afab6ef2fbc33c928ff22844520e0996f5782b1f5d53b3e615dfeed154ff
+  metadata.gz: d7530d88e0f3442c2db0a7fa75d66fd03cac567ea179063ad57d14dcb87e98db
+  data.tar.gz: 21acb0413b2b62935e442a5ac4b03650ff8fc5e6eba8d7bb6daba0c94ecd937d
 SHA512:
-  metadata.gz: 816d757cc8ce84fb99cd8036a7f9aea425b47c012a7740f1ea1c158196d66dc94d806c158203a37562c5157ae89dfbb7f3820d5ec5405088db40ef623522b25c
-  data.tar.gz: a967a0be0baa0dc7c8f5706a709fe4e4e3e944a74d09c4007f6e8ba93ff979262126ad5ebe44725705c8df462344b401590651787ed77d177173d2f5304076ea
+  metadata.gz: eb2a26a7704e7500a37f06a5d6f56b5dd6979b68283324213e612ace1a9d45204714c761e0737cfd64d9e41700bdcfd6e143d1bcc4c6f957e4f7c29c479410d0
+  data.tar.gz: 59443675ec5cc8705383458ec25de2e3a0fd3488fcb5dbf575cf9375f4b63983d6d01089d8641e5f14be47c99cb5107bb307977858a9dcb29a69aa46789713c6

data/README.md

@@ -71,12 +71,17 @@ Below settings are used when configuring the application in the k8s environment
 - `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.external_secrets` (Hash, optional): List of env vars imported from external secret config.    
+  Basic example: `external_secrets: { paper_trail_port: 'common_secrets' }` will import `paper_trail_port` value from `common_secrets` yml as `PAPER_TRAIL_PORT`           
+  Advanced example: `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
@@ -88,8 +93,8 @@ Below settings are used when configuring the application in the k8s environment
 - `secrets.name` (String): K8s secrets name where env vars will be saved and fetched from. Sample: `my-app-secrets`
 
 - `service.name`: K8s service name. Sample: `my-app-service`
-- `service.port_name`: Http port name to connect between k8s ingress and service. Sample: `http-port`. Note: max 15 characters
-- `service.backend_port_name` (String): Web backend port name to be connected between k8s service and web deployments. Sample: `b-port`. Note: max 15 characters
+- `service.port_name` (String, default `http-port`): Http port name to connect between k8s ingress and service. Sample: `http-port`. Note: max 15 characters
+- `service.backend_port_name` (String, default `b-port`): Web backend port name to be connected between k8s service and web deployments. Sample: `b-port`. Note: max 15 characters
 
 - `ingress.name`: Name of k8s ingress for the app: Sample: `my-app-ingress`
 - `ingress.ip_name` (Optional): Static ip address is not created nor assigned if empty value. Sample: `my-app-static-ip`

data/lib/kubernetes_helper/core.rb

@@ -67,12 +67,26 @@ 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|
+      secrets = data['data'].keys.map do |secret|
         {
           'name' => secret.upcase,
           'valueFrom' => { 'secretKeyRef' => { 'name' => secrets_name, 'key' => secret } }
         }
       end
+      secrets + external_secrets
+    end
+
+    def external_secrets
+      data = config_values.dig(:deployment, :external_secrets) || {}
+      data.map do |key, source|
+        source = source.is_a?(Hash) ? source : { name: source.to_s, key: key }
+        {
+          'name' => key.upcase.to_s,
+          'valueFrom' => {
+            'secretKeyRef' => { 'name' => source[:name], 'key' => source[:key].to_s }
+          }
+        }
+      end
     end
 
     def render_template(template_name, locals = {})

data/lib/kubernetes_helper/version.rb

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

data/lib/kubernetes_helper.rb

@@ -23,9 +23,14 @@ module KubernetesHelper
         name: 'gcloud'
       },
       deployment: {
-        log_container: true
+        log_container: true,
+        log_folder: '/app/log',
+        external_secrets: {}
+      },
+      service: {
+        port_name: 'http-port',
+        backend_port_name: 'b-port'
       },
-      service: {},
       secrets: {},
       continuous_deployment: {},
       ingress: {}

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,14 +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,
-    port_name: 'http-port', # max 15 characters
-    backend_port_name: 'b-port' # max 15 characters
-  }
 }
 
 KubernetesHelper.settings(settings)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 1.12.6
+  version: 1.13.0
 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