kubernetes_helper 1.6 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91be870ea9d9d07de0ef4fb9e5c02094929b6d89fa7229aed5286877ff48dbca
-  data.tar.gz: 656ec2ce0a6ef926e6166da26fff8a493b6648984915f09da47bbd2913c0fbb3
+  metadata.gz: 6e2e119480c5c91e09f658c135c25adc802c26acfd64255a60d71ef71f1d71f3
+  data.tar.gz: a47d27732e7c42f80dd00ee32e5a36bf67cf0fbba533f3650cd3eec528ce2ec6
 SHA512:
-  metadata.gz: 25e41a5e0a09dd15dcd6073d3d7278786d72916e6a9dc288e4c1d8380177d31d64c79e0ab3f164daae0e8f32e77ae52ec85d3a958856fd787a7be7b1523d2d49
-  data.tar.gz: 3de36d890e9c2211854cbaabe76e662a7fa4d60696c88d6c943ca05a55164fa829eee988bb80d6b2a2da914ad137e040c17ccc1644c9b0c981c193faafebce45
+  metadata.gz: bbdb0771ba124950ce8704528349c16e52f29d90af6b6581db3f423a377aba4f91d5ca1f82387e976d9a88394f327037c782185632e3f83eef7338b8cf50eb39
+  data.tar.gz: e74722f42ec99b9b22ad01d932203bf968a2610f0724032ca83141201ab3db46d231f666878d283fcc1020fc4c122f5388e938bdbb23c2b6dac901af5bc684ed

data/lib/kubernetes_helper/core.rb

@@ -11,8 +11,8 @@ module KubernetesHelper
       binding
     end
 
-    def include_template(name)
-      render_template.call(name)
+    def include_template(name, locals = {})
+      render_template.call(name, locals)
     end
   end
 
@@ -36,8 +36,8 @@ module KubernetesHelper
 
     # @param text (String)
     # Sample: replicas: '#{deployment.replicas}'
-    def replace_config_variables(text)
-      values = config_values.map do |key, value| # rubocop:disable Style/HashTransformValues
+    def replace_config_variables(text, locals = {})
+      values = config_values.merge(locals: locals).map do |key, value| # rubocop:disable Style/HashTransformValues
         [key, value.is_a?(Hash) ? OpenStruct.new(value) : value]
       end.to_h
       values[:render_template] = method(:render_template)
@@ -75,10 +75,10 @@ module KubernetesHelper
       end
     end
 
-    def render_template(template_name)
+    def render_template(template_name, locals = {})
       path = KubernetesHelper.settings_path(template_name, use_template: true)
       text = "\n#{File.read(path)}"
-      replace_config_variables(text)
+      replace_config_variables(text, locals)
     end
 
     def static_env_vars
@@ -91,10 +91,11 @@ module KubernetesHelper
     end
 
     # parse secrets auto importer
-    def parse_import_secrets(document)
+    def parse_import_secrets(document) # rubocop:disable Metrics/AbcSize
       containers = document.dig('spec', 'template', 'spec', 'containers') || []
       containers.each do |container|
-        container['env'] = (container['env'] || []) + static_env_vars
+        container['env'] = (container['env'] || [])
+        container['env'] = container['env'] + static_env_vars if container.delete('static_env')
         if container['import_secrets']
           container['env'] = container['env'] + import_secrets(*container['import_secrets'])
           container.delete('import_secrets')

data/lib/kubernetes_helper/version.rb

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

data/lib/templates/_container_extra_settings.yml

@@ -0,0 +1,9 @@
+#              <% if locals[:pod] == 'job' %>
+#              resources:
+#                requests:
+#                  cpu: 50m
+#                  memory: 256Mi
+#                limits:
+#                  cpu: 500m
+#                  memory: 1Gi
+#              <% end %>

data/lib/templates/_custom_containers.yml

@@ -0,0 +1,5 @@
+#            <% if locals[:pod] == 'job' %>
+#            - name: scraper
+#              image: owencio/easy_scraper
+#              ...
+#            <% end %>

data/lib/templates/_custom_volumes.yml

@@ -0,0 +1,3 @@
+#            - name: dshm
+#              emptyDir:
+#                medium: Memory

data/lib/templates/_job_liveness.yml

@@ -0,0 +1,12 @@
+              ports: [ ]
+              <% if (deployment.job_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
+                               echo "Some required services are not running"; exit 1;
+                           fi' ]
+                initialDelaySeconds: 120
+                periodSeconds: 30
+              readinessProbe: *liveness_probe
+              <% end %>

data/lib/templates/_volumes.yml

@@ -0,0 +1,20 @@
+            <% if deployment.cloud_secret_name %>
+            - name: gcloud-creds
+              secret:
+                secretName: '<%=deployment.cloud_secret_name%>'
+            <% end %>
+
+            - name: applog
+              emptyDir: {}
+
+            # Custom volumes
+            # { my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }
+            <% (deployment.custom_volumes || {}).each do |name, vol| %>
+            - name: <%= name %>
+              <%= vol[:kind] %>:
+                <% vol[:settings].each do |k, v| %>
+                <%= k %>: <%= v %>
+                <% end %>
+              <% end %>
+
+            <%= include_template "_custom_volumes.yml", { pod: locals[:pod] } %>

data/lib/templates/cd.sh

@@ -43,6 +43,11 @@ docker tag $DEPLOY_NAME $LATEST_NAME
 docker push $DEPLOY_NAME
 docker push $LATEST_NAME
 
+## 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'
+<% end %>
+
 ## Apply deployments
 IFS=',' read -r -a deployments <<< "$DEPLOYMENTS"
 for deployment in "${deployments[@]}"; do
@@ -50,3 +55,4 @@ for deployment in "${deployments[@]}"; do
 
   <%= include_template "_cd_apply_images.sh" %>
 done
+

data/lib/templates/deployment.yml

@@ -26,6 +26,7 @@ documents:
               command: ["/bin/bash", "-c", "<%= deployment.command %>"]
               <% end %>
               name: *app_name
+              static_env: true
               import_secrets: ['secrets.yml', '<%=secrets.name%>']
               ports:
                 - containerPort: &port 3000
@@ -41,6 +42,7 @@ documents:
                 periodSeconds: 15
               readinessProbe: *liveness_probe
               <% end %>
+              <%= include_template "_container_extra_settings.yml", { pod: 'web' } %>
 
               volumeMounts:
                 - &log_volume
@@ -69,6 +71,7 @@ documents:
               env: []
               volumeMounts:
                 - *cloud_credentials_volume
+              <%= include_template "_container_extra_settings.yml", { pod: 'cloudsql' } %>
             <% end %>
 
             - &logs_container # print to stdout all log files
@@ -78,27 +81,13 @@ documents:
               env: []
               volumeMounts:
                 - *log_volume
+              <%= include_template "_container_extra_settings.yml", { pod: 'logs' } %>
+
+            <%= include_template "_custom_containers.yml", { pod: 'web' } %>
 
           terminationGracePeriodSeconds: 120
           volumes:
-            <% if deployment.cloud_secret_name %>
-            - name: gcloud-creds
-              secret:
-                secretName: '<%=deployment.cloud_secret_name%>'
-            <% end %>
-
-            - name: applog
-              emptyDir: {}
-
-            # Custom volumes
-            # { my_volume: { kind: 'hostPath', mount_path: '/', settings: { path: '..', type: 'Directory' } }  }
-            <% (deployment.custom_volumes || {}).each do |name, vol| %>
-            - name: <%= name %>
-              <%= vol[:kind] %>:
-                <% vol[:settings].each do |k, v| %>
-                <%= k %>: <%= v %>
-                <% end %>
-            <% end %>
+            <%= include_template "_volumes.yml", { pod: 'web' } %>
 
 
   <% if deployment.job_name %>
@@ -124,22 +113,12 @@ documents:
               <% if deployment.job_command %>
               command: [ "/bin/bash", "-c", "<%= deployment.job_command %>" ]
               <% end %>
+              <%= include_template "_container_extra_settings.yml", { pod: 'job' } %>
 
             <% if deployment.job_sidekiq_alive_gem %>
               <%= include_template "_sidekiq_alive_gem.yml" %>
             <% else %>
-              ports: [ ]
-              <% if (deployment.job_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
-                           echo "Some required services are not running"; exit 1;
-                       fi' ]
-                initialDelaySeconds: 120
-                periodSeconds: 30
-              readinessProbe: *liveness_probe
-              <% end %>
+              <%= include_template "_job_liveness.yml" %>
             <% end %>
 
             <% if deployment.cloud_secret_name %>
@@ -147,6 +126,11 @@ documents:
             <% end %>
 
             - <<: *logs_container
+
+            <%= include_template "_custom_containers.yml", { pod: 'job' } %>
+
+          volumes:
+            <%= include_template "_volumes.yml", { pod: 'job' } %>
   <% end %>
 
   <% if deployment.replicas_range %>

data/lib/templates/settings.rb

@@ -27,7 +27,8 @@ settings = {
     project_name: 'my-project-name',
     cluster_name: 'my-cluster-name',
     cluster_region: 'europe-west4-a',
-    docker_build_cmd: 'build -f Dockerfile' # using target: 'build --target production -f Dockerfile '
+    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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: '1.6'
+  version: 1.9.0
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -41,8 +41,13 @@ files:
 - lib/kubernetes_helper/version.rb
 - lib/templates/README.md
 - lib/templates/_cd_apply_images.sh
+- lib/templates/_container_extra_settings.yml
+- lib/templates/_custom_containers.yml
+- lib/templates/_custom_volumes.yml
+- lib/templates/_job_liveness.yml
 - lib/templates/_replicas.yml
 - lib/templates/_sidekiq_alive_gem.yml
+- lib/templates/_volumes.yml
 - lib/templates/cd.sh
 - lib/templates/certificate.yml
 - lib/templates/deployment.yml