kubernetes_helper 0.3.3 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24816e7925c930deb198ab8b10b9f820ad4f5f23b4b06ee5e65d8d1d0e82208
-  data.tar.gz: '06395250bc71d298cfcd7d56409fe98e1a4ecd614ee79e24d7dc9cdbf01d1d1b'
+  metadata.gz: 528e61587a3011330c7e474b523ce04079c8e49483bf894d5eb1806927436888
+  data.tar.gz: 9df4e7aab70108b75831077d2f4390067e5807664050f70e1557f504835144bd
 SHA512:
-  metadata.gz: 0a59e813c49a519036e6532537a9d194626395fdf0e5cee6c751f32cfb3e4c5fdff5454ae67dfe0ce500ec2f2c3317915aec8ed9c2f85b175a101e58b2d0d9ad
-  data.tar.gz: 915c6cebb2e9f5829274d564c449d5c57ae3aa06ef524002c41e48920379d4126e6da444a9a08dc69df4492ec541c825484d2d579ef39e4e01e325e9dc627417
+  metadata.gz: 9ed371a62084598f9bb4755df54ca059ffbeb729731555e4a6a6cf58dceecc0c347741921b5c46fc11408a937c914ea2d3fddaf3da94bc801dd6cd7f9ecc1ed8
+  data.tar.gz: 6248035be5a30995594a39ad56b73b811935b3b55988d067173a530ee0522294f6afb0e6361f664d4f696e7b370ce7b816ed74a53cb3f416c584e12c76ff023d

data/README.md

@@ -1,37 +1,61 @@
 # KubernetesHelper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kubernetes_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is a helper to manage easily Kubernetes settings for GCloud (easy customization for other cloud services) where configuring and deploying a new application can be done in a couple of minutes.
+Configuration and customization can be done for multiple environments and at any level which permits to deploy simple and complex applications.
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'kubernetes_helper'
+```bash
+cd my_app/
+gem install kubernetes_helper -v '~> 1.0'
+kubernetes_helper generate_templates
 ```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install kubernetes_helper
+Note: Requires ruby 1.7+      
 
 ## Usage
+- Run any kubernetes document    
+  `DEPLOY_ENV=<env name> kubernetes_helper run_deployment "<document name>" "<bash command>"`    
+  Evaluates the kubernetes document with the following details:
+  - Supports for `- documents` to include multiple documents in a file and share yml variables between them (Sample: `lib/templates/deployment.yml#1`)
+  - Replaces all setting values based on `DEPLOY_ENV`
+  - Supports for secrets auto importer using `import_secrets: ['secrets.yml', '<%=secrets.name%>']` (Sample: `lib/templates/deployment.yml#29`)
+  - Supports for template including by `include_template 'template_name.yml.erb'`    
+  Sample: `DEPLOY_ENV=beta kubernetes_helper run_deployment "deployment.yml" "kubectl create"`
+   
+- Run kubernetes commands    
+  `DEPLOY_ENV=<env name> rake kubernetes_helper:run_command "<bash or k8s commands>"`           
+  Replaces all setting variables inside command based on `DEPLOY_ENV` and performs it as a normal bash command.             
+  Sample: `DEPLOY_ENV=beta rake kubernetes_helper:run_command "gcloud compute addresses create \#{ingress.ip_name} --global"'`    
+  
+- Run kubernetes bash scripts     
+  `DEPLOY_ENV=<env name> kubernetes_helper run_script "<script name>"`    
+  Performs the script name located inside `.kubernetes` folder or kubernetes_helper template as the second option.
+  All setting variables inside the script will be replaced based on `DEPLOY_ENV`.      
+  Sample: `DEPLOY_ENV=beta kubernetes_helper run_script "cd.sh"`
+
+- Generate templates    
+  `DEPLOY_ENV=<env name> kubernetes_helper generate_templates "<mode_or_template_name>"`     
+  Copy files based on mode (`basic|advanced`) or a specific file from templates.     
+  Sample: `DEPLOY_ENV=beta kubernetes_helper generate_templates "basic"`    
+  Sample: `DEPLOY_ENV=beta kubernetes_helper generate_templates "ingress.yml"`    
+
+When performing a script it looks first for file inside .kubernetes folder, if not exist, 
+it looks for the file inside kubernetes_helper template folder.    
+
+## Templating
+When performing a command or script, the setting variables are replaced based on `DEPLOY_ENV`. 
+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/
 
 ## TODO
-- Documentation
-    - Include conditional blocks
-    - Include hardcoded env values
-    - Tasks
-    - Add docs to include partials using `include_template 'sample.yml.erb'`
-- Rake verify files
 - Add one_step_configuration.sh
-- Fix if/end_if for blocks
-- Ability to copy specific template
 
 ## Contributing
 

data/exe/kubernetes_helper

@@ -9,8 +9,8 @@ case ARGV[0]
 when 'run_command'
   KubernetesHelper::Core.new(ENV['DEPLOY_ENV']).run_command(ARGV[1])
 # Run the deployment script.
-#   Sample: DEPLOY_ENV=beta kubernetes_helper run_deployment "cd_gcloud.sh"
-when 'run_deployment'
+#   Sample: DEPLOY_ENV=beta kubernetes_helper run_deployment "cd.sh"
+when 'run_deployment', 'run_script'
   script_path = KubernetesHelper.settings_path(ARGV[1], use_template: true)
   KubernetesHelper::Core.new(ENV['DEPLOY_ENV']).run_script(script_path)
 # Parses kubernetes yml files (supporting multiple documents, Config variables replacement, include secrets).
@@ -22,6 +22,7 @@ when 'run_yml'
     .parse_yml_file(KubernetesHelper.settings_path(ARGV[1], use_template: true), output_path)
   KubernetesHelper.run_cmd("#{ARGV[2]} -f #{output_path}")
 # Generate template files
+#   Sample: DEPLOY_ENV=beta kubernetes_helper generate_templates "basic"
 when 'generate_templates' #  Sample: kubernetes_helper generate basic
   mode = ARGV[1] || 'basic'
   KubernetesHelper.copy_templates(mode)

data/lib/kubernetes_helper.rb

@@ -39,11 +39,14 @@ module KubernetesHelper
     file_name ? File.join(path, file_name) : path
   end
 
-  # @param mode (basic, advanced)
-  def self.copy_templates(mode)
+  # @param mode_or_file (basic, advanced, String) mode name or any specific template name
+  def self.copy_templates(mode_or_file)
     FileUtils.mkdir(settings_path) unless Dir.exist?(settings_path)
+    template_path = templates_path(mode_or_file)
+    return FileUtils.cp(template_path, settings_path(mode_or_file)) if File.exist?(template_path)
+
     files = %w[README.md secrets.yml settings.rb]
-    files += %w[deployment.yml cd.sh ingress.yml service.yml] if mode == 'advanced'
+    files += %w[deployment.yml cd.sh ingress.yml service.yml] if mode_or_file == 'advanced'
     files.each do |name|
       path = settings_path(name)
       FileUtils.cp(templates_path(name), path) unless File.exist?(path)

data/lib/kubernetes_helper/version.rb

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

data/lib/templates/README.md

@@ -2,54 +2,56 @@
 
 ## Configure a new application environment
 - Create the project on Gcloud
-- Set the project where to work on
+- Set the project where to work on     
     `gcloud config set project my-project`
     
-- Create the cluster (Only if not exist)
+- Create the cluster (Only if not exist)    
     `gcloud container clusters create my-cluster`
     `# gcloud container clusters list --region europe-west4-a # to list clusters`
+    Note: `--preemptible` recommended for non production environments   
   
-- Use the cluster/project as default
+- Use the cluster/project as default    
     `gcloud container clusters get-credentials my-cluster --zone europe-west4-a`
   
-- Install helper for the next commands
+- Install helper for the next commands    
   `gem install kubernetes_helper`
   
-- Verify or update k8s settings in .kubernetes/settings.rb
+- Verify or update k8s settings in .kubernetes/settings.rb        
+  Note: Please do not include sensitive values in this file, ENV values are recommended instead.
 
-- Register shared cloudsql proxy configuration (only if not exists)
+- Register shared cloudsql proxy configuration (only if not exists)    
     ```bash
     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 (values must be encrypted using base64)     
     Open and register secret values in `.kubernetes/secrets.yml`     
-    Note: Enter base64 encoded values
+    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
     ```
 
-- Create deployment to run application
+- Create deployment to run application    
     ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'deployment.yml' 'kubectl create'
     # kubectl get deployment # to list deployments
     ```
 
-- Create service to connect pods and ingress
+- Create service to connect pods and ingress    
     ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'service.yml' 'kubectl create'
     # kubectl get services # to list all registered services
     ```
 
-- Create the public ip address (only if static ip is required)
+- Create the public ip address (only if static ip is required)    
     ```bash
     DEPLOY_ENV=beta kubernetes_helper run_command "gcloud compute addresses create <%=ingress.ip_name%> --global"
     # gcloud compute addresses list # to list static ips generated
     # Copy new external ip generated by the previous command and point your domain to it
     ```
   
-- Register ingress to receive external http calls (includes ssl certificates if defined)
+- Register ingress to receive external http calls (includes ssl certificates if defined)    
     ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'ingress.yml' 'kubectl create'
     # kubectl get ingress # to list all registered ingresses
@@ -60,18 +62,18 @@
     ```
 
 ## Apply any k8s setting changes
-- Secrets
+- Secrets    
   Open kubernetes secrets and add/edit/remove values and then save it    
   `kubectl edit secret ...`
   Once secrets were updated, then restart all related pods, see: https://medium.com/devops-dudes/how-to-propagate-a-change-in-kubernetes-secrets-by-restarting-dependent-pods-b71231827656
   
-- Other settings
+- Other settings    
   ```bash
     DEPLOY_ENV=beta kubernetes_helper run_yml 'deployment.yml' 'kubectl apply'
   ```
 
 ## Configure continuous deployment for github actions
-* Go to github repository settings
+* Go to github repository settings    
 * Register a new secret variable with content downloaded from https://console.cloud.google.com/iam-admin/serviceaccounts 
     (Make sure to attach a "Editor", "Storage Admin" and "Kubernetes engine cluster admin" role to the service account)
   ```bash
@@ -79,14 +81,14 @@
     production: PROD_CLOUD_TOKEN=<secret content here>
   ```
   
-* Add action to run deployment:
+* Add action to run deployment:    
   ```bash
     env:
       KB_AUTH_TOKEN: secrets.BETA_CLOUD_TOKEN
     run: DEPLOY_ENV=beta kubernetes_helper run_deployment 'cd.sh'
   ``` 
   
-* Sample:
+* Sample:    
   ```yml
   - run: sudo gem install kubernetes_helper
   - name: Staging deployment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes_helper
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: '1.0'
 platform: ruby
 authors:
 - owen2345
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb