kubernetes_helper 1.0 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528e61587a3011330c7e474b523ce04079c8e49483bf894d5eb1806927436888
-  data.tar.gz: 9df4e7aab70108b75831077d2f4390067e5807664050f70e1557f504835144bd
+  metadata.gz: 954aee8be3740b9cedb7496bd66ad857328ee8e1bf72a3571947bc70f849d97a
+  data.tar.gz: e9a33fa7278d6fd5eb844067c5378490588ce44e71df439c6e5178e24fcc5e73
 SHA512:
-  metadata.gz: 9ed371a62084598f9bb4755df54ca059ffbeb729731555e4a6a6cf58dceecc0c347741921b5c46fc11408a937c914ea2d3fddaf3da94bc801dd6cd7f9ecc1ed8
-  data.tar.gz: 6248035be5a30995594a39ad56b73b811935b3b55988d067173a530ee0522294f6afb0e6361f664d4f696e7b370ce7b816ed74a53cb3f416c584e12c76ff023d
+  metadata.gz: bab608c022fec18c45f6a0aa84f5d3528d0e455d1cf9670a3c07c8cc65d4115642c924d9d1482140037892d7e48282826b98ed55ed87d923a8aed5b809ca0c52
+  data.tar.gz: a8a65ba45e6c362928f07788909497b8bb8ec8eb152ad72ea998c0af5f55bb9d0de06adc94ff256d97b2719da4b8aec43f606739999cd753825670cef020f3d1

data/README.md

@@ -11,7 +11,10 @@ kubernetes_helper generate_templates
 ```
 Note: Requires ruby 1.7+      
 
-## Usage
+## Deployment
+Once you generated the basic templates, it comes with the corresponding [readme.md](/lib/templates/README.md) which includes all the steps to deploy your application.
+
+## API
 - Run any kubernetes document    
   `DEPLOY_ENV=<env name> kubernetes_helper run_deployment "<document name>" "<bash command>"`    
   Evaluates the kubernetes document with the following details:
@@ -46,10 +49,7 @@ When performing a command or script, the setting variables are replaced based on
 All these setting variable values are configured in `.kubernetes/settings.rb` which defines the values based on `DEPLOY_ENV`.     
 These setting variables use [erb](https://github.com/ruby/erb) template gem to define variable replacement and conditional blocks, and so on.
 Note: Setting variable values are referenced as an object format instead of a hash format for simplicity.
-
-
-## Deployment
-Once you generated the basic templates, it comes with the corresponding [readme.md](/lib/templates/README.md) which includes all the steps to deploy your application.  
+  
 
 ## Sample
 https://owen2345.github.io/kubernetes_helper/

data/lib/kubernetes_helper/core.rb

@@ -22,7 +22,7 @@ module KubernetesHelper
 
     # @param _env_name (String)
     def initialize(_env_name)
-      @config_values = KubernetesHelper.load_settings
+      @config_values = KubernetesHelper.default_settings.merge(KubernetesHelper.load_settings)
     end
 
     def parse_yml_file(file_path, output_path)
@@ -115,6 +115,8 @@ module KubernetesHelper
     def parse_documents(yml_data)
       documents = []
       Array(yml_data).each do |document|
+        next unless document
+
         document['documents'] ? documents.push(*document['documents']) : documents.push(document)
       end
       documents

data/lib/kubernetes_helper/version.rb

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

data/lib/kubernetes_helper.rb

@@ -20,6 +20,14 @@ module KubernetesHelper
     settings
   end
 
+  def self.default_settings
+    {
+      cloud: {
+        name: 'gcloud'
+      }
+    }
+  end
+
   def self.settings_path(file_name = nil, use_template: false)
     path = File.join(Dir.pwd, FOLDER_NAME)
     if file_name

data/lib/templates/cd.sh

@@ -12,26 +12,30 @@ PROJECT_NAME="<%=continuous_deployment.project_name%>"
 CLUSTER_REGION="<%=continuous_deployment.cluster_region%>"
 DOCKER_BUILD_CMD="<%=continuous_deployment.docker_build_cmd || 'build -f Dockerfile'%>"
 
-CI_COMMIT_SHA=$(git rev-parse --verify HEAD)
+CI_COMMIT_SHA=$(git rev-parse --verify HEAD || :)
+CI_COMMIT_SHA=${CI_COMMIT_SHA:-$(date +%s) }
 DEPLOY_NAME="${IMAGE_NAME}:${CI_COMMIT_SHA}"
 LATEST_NAME="${IMAGE_NAME}:latest"
-AUTH_PATH="$SCRIPT_DIR/k8s-auth-token.json"
 
-rm -f -- $AUTH_PATH
-echo $KB_AUTH_TOKEN >> $AUTH_PATH
-
-## ***** GOOGLE CONNECTOR
-# Download and install Google Cloud SDK
-if [ -z "$(which gcloud)" ]; then
-  export CLOUDSDK_CORE_DISABLE_PROMPTS=1; curl https://sdk.cloud.google.com | bash && source /home/runner/google-cloud-sdk/path.bash.inc &&  gcloud --quiet components update kubectl
+if [ ! -z "$KB_AUTH_TOKEN" ]
+then
+  AUTH_PATH="$SCRIPT_DIR/k8s-auth-token.json"
+  rm -f -- $AUTH_PATH
+  echo $KB_AUTH_TOKEN >> $AUTH_PATH
+
+  ## ***** GOOGLE CONNECTOR
+  # Download and install Google Cloud SDK
+  if [ -z "$(which gcloud)" ]; then
+    export CLOUDSDK_CORE_DISABLE_PROMPTS=1; curl https://sdk.cloud.google.com | bash && source /home/runner/google-cloud-sdk/path.bash.inc &&  gcloud --quiet components update kubectl
+  fi
+
+  # Connect to cluster
+  gcloud auth activate-service-account --key-file $AUTH_PATH --project $PROJECT_NAME
+  gcloud docker --authorize-only --project $PROJECT_NAME
+  gcloud container clusters get-credentials $CLUSTER_NAME --region $CLUSTER_REGION
+  ## ***** END GOOGLE CONNECTOR
 fi
 
-# Connect to cluster
-gcloud auth activate-service-account --key-file $AUTH_PATH --project $PROJECT_NAME
-gcloud docker --authorize-only --project $PROJECT_NAME
-gcloud container clusters get-credentials $CLUSTER_NAME --region $CLUSTER_REGION
-## ***** END GOOGLE CONNECTOR
-
 
 ## Build and push containers
 docker $DOCKER_BUILD_CMD -t $DEPLOY_NAME .

data/lib/templates/certificate.yml

@@ -0,0 +1,7 @@
+apiVersion: networking.gke.io/v1beta1
+kind: ManagedCertificate
+metadata:
+  name: '<%=ingress.certificate_name%>'
+spec:
+  domains: # does not support for willcard domains
+    - '<%=ingress.domain_name%>'

data/lib/templates/deployment.yml

@@ -46,32 +46,42 @@ documents:
                 - &log_volume
                   name: applog
                   mountPath: /app/log
+
+                <% if deployment.cloud_secret_name %>
                 - &cloud_credentials_volume
                   name: gcloud-creds
                   mountPath: /secrets/gcloud
                   readOnly: true
+                <% end %>
 
+            <% if deployment.cloud_secret_name %>
             - &cloudsql_container
               image: gcr.io/cloudsql-docker/gce-proxy:1.09 # Cloud sql proxy
               name: cloudsql-proxy
               command: ["/cloud_sql_proxy", "--dir=/cloudsql",
                         "-instances=<%=deployment.cloud_sql_instance%>",
                         "-credential_file=/secrets/gcloud/credentials.json"]
+              env: []
               volumeMounts:
                 - *cloud_credentials_volume
+            <% end %>
 
             - &logs_container # print to stdout all log files
               name: print-logs
               image: busybox
-              command: [/bin/sh, -c, 'until find log/*.log; do sleep 1; done; tail -n+1 -f log/*.log']
+              command: [/bin/sh, -c, 'until find /app/log/*.log; do sleep 1; done; tail -n+1 -f /app/log/*.log']
+              env: []
               volumeMounts:
                 - *log_volume
 
           terminationGracePeriodSeconds: 120
           volumes:
+            <% if deployment.cloud_secret_name %>
             - name: gcloud-creds
               secret:
                 secretName: '<%=deployment.cloud_secret_name%>'
+            <% end %>
+
             - name: applog
               emptyDir: {}
 
@@ -100,7 +110,7 @@ documents:
               <% end %>
 
             <% if deployment.job_sidekiq_alive_gem %>
-              <%= include_template "_sidekiq_alive_gem.yml.erb" %>
+              <%= include_template "_sidekiq_alive_gem.yml" %>
             <% else %>
               ports: [ ]
               <% if (deployment.job_services || []).any? %>
@@ -116,10 +126,13 @@ documents:
               <% end %>
             <% end %>
 
+            <% if deployment.cloud_secret_name %>
             - *cloudsql_container
+            <% end %>
+
             - <<: *logs_container
   <% end %>
 
   <% if deployment.replicas_range %>
-  <%= include_template "_replicas.yml.erb" %>
+  <%= include_template "_replicas.yml" %>
   <% end %>

data/lib/templates/ingress.yml

@@ -1,11 +1,5 @@
 <% if ingress.domain_name %>
-apiVersion: networking.gke.io/v1beta1
-kind: ManagedCertificate
-metadata:
-  name: '<%=ingress.certificate_name%>'
-spec:
-  domains: # does not support for willcard domains
-    - '<%=ingress.domain_name%>'
+<%= include_template "certificate.yml" %>
 <% end %>
 
 ---

data/lib/templates/service.yml

@@ -1,3 +1,4 @@
+<% if cloud.name == 'gcloud' %>
 ---
 # used to increase request timeout
 apiVersion: cloud.google.com/v1beta1
@@ -6,16 +7,17 @@ metadata:
   name: '<%=service.config_name%>'
 spec:
   timeoutSec: 1800
-
 ---
-
+<% end %>
 
 kind: Service
 apiVersion: v1
 metadata:
   name: '<%=service.name%>'
   annotations:
+    <% if cloud.name == 'gcloud' %>
     beta.cloud.google.com/backend-config: '{"ports": {"80":"<%=service.config_name%>"}}'
+    <% end %>
 spec:
   selector:
     name: '<%=deployment.name%>'

data/lib/templates/settings.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 is_production = ENV['DEPLOY_ENV'] == 'production'
-app_name = is_production ? 'my_app' : 'my_beta_app'
+app_name = is_production ? 'my-app' : 'my-beta-app' # underscore not accepted
 settings = {
   deployment: {
     name: app_name,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.4'
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -40,9 +40,10 @@ files:
 - lib/kubernetes_helper/railtie.rb
 - lib/kubernetes_helper/version.rb
 - lib/templates/README.md
-- lib/templates/_replicas.yml.erb
-- lib/templates/_sidekiq_alive_gem.yml.erb
+- lib/templates/_replicas.yml
+- lib/templates/_sidekiq_alive_gem.yml
 - lib/templates/cd.sh
+- lib/templates/certificate.yml
 - lib/templates/deployment.yml
 - lib/templates/ingress.yml
 - lib/templates/secrets.yml