kubernetes-health 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54838ac8e10fa7854b717ea39a0e10ce1af9b951f7300b808e0398768a46d269
-  data.tar.gz: e4f410ed1f9bdab67fe37029f6e2bdacd173796e389dc520d4d97d46f03453e4
+  metadata.gz: 809331bcf24f88f951d92290782878d1e52ae93f789bdeddafe9096fff731402
+  data.tar.gz: 83ca0cbff7856d12eb1fe5ac217cafb8d6c578c9cc891bc626f3645649d92eb5
 SHA512:
-  metadata.gz: 3c5a6e6f0c1fa828ba48e448c645870d04eb1ddf1e92e608ecd73cb3e3b06306bff9a3ca67dfe7ac64995328ef150890692e15ce18ebb6c05a736fd5d7c266c6
-  data.tar.gz: 92cc261f45e009c2334e6d2d43b8aa1d975d847b48070145d18e836e05e42a1380900560890a57dac6f2f8b953dd87472557891113284bf2b464e261745b1d81
+  metadata.gz: 6007ce776ce879c62b57756eaa5e179fb581f9549aa9e323cd252b4f422f6cfb72a67280691028b785d3a609e9a3c7d330bf2b6b86e539ec49b50ce0cb6e1511
+  data.tar.gz: dd4a6316ddbd1272b1cff7b2c79b0dab83125dfe4a4b1cae644e4dcd379a5e43498e4f3667d5ebe339c971e74b594afecf734caf1d1c5f9245d8ddcc3e900f2a

data/.gitignore

@@ -7,6 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+*.gem
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,40 +1,78 @@
 # Kubernetes::Health
 
-A simple gem that adds /_health in your APP.
+A gem that adds `/_readiness` and `/_liveness` and allows Kubernetes monitor your rails using HTTP while migrates are running.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 1.0'
+gem 'kubernetes-health', '~> 2.0'
 ```
 
 And then execute:
 
-    $ bundle
+$ bundle
 
-Or install it yourself as:
+## Enable migrates monitoring.
 
-    $ gem install kubernetes-health
+This will run a Rack server for `/_readiness` route and will return `200` and `503` HTTP CODES alternately while your migrates are running.
+
+If readinessProbe\`s failureThreshold=3 and successThreshold=3 it never will be reach until migrate ends.
+
+Of course your Dockerfile entry script needs to run migrates before start your web app.
+
+Add `KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE=true` environment variable.
+
+or
+
+```
+    Kubernetes::Health::Config.enable_rack_on_migrate = true # default: false
+```
+
+On your app.
+
+If you need:
+
+```
+    Kubernetes::Health::Config.rack_on_migrate_rotate_http_codes = [200, 503] # default: [202, 503]
+```
+
+Configure your deployment readinessProbe:
+```
+    readinessProbe:
+        httpGet:
+        path: /_readiness
+        port: 80
+        initialDelaySeconds: 10
+        timeoutSeconds: 5
+        failureThreshold: 3
+        successThreshold: 3
+```
 
 ## Custom check
 
-Set Kubernetes::Health::Config.sick_if if you want to check other things.
+Set Kubernetes::Health::Config.ready_if if you want to check other things.
 
-Ex. Check if PostgreSQL is working and wait for migrations.
+Ex. Check if PostgreSQL is working. `params` is optional.
 ```
-Kubernetes::Health::Config.sick_if = lambda { |params|
-    return true if params[:wait_migration] == 'true' && File.exists?('migration.lock')
+Kubernetes::Health::Config.ready_if = lambda { |params|
     ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
 }
 ```
 
-## Custom route
+Set Kubernetes::Health::Config.live_if if you want to check other things.
+
+Ex. Check if PostgreSQL is working. `params` is optional.
+```
+Kubernetes::Health::Config.ready_if = lambda { |params|
+    ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
+}
+```
 
-Set Kubernetes::Health::Config.route if you want to use other route.
 
-Ex.
+## Custom routes
 ```
-Kubernetes::Health::Config.route = '/status'
+Kubernetes::Health::Config.route_liveness = '/liveness'
+Kubernetes::Health::Config.route_readiness = '/readiness
 ```

data/app/controllers/kubernetes/health_controller.rb

@@ -1,9 +1,15 @@
 module Kubernetes
   class HealthController < ::ActionController::Base
-    def status
-      i_am_sick = Kubernetes::Health::Config.sick_if.arity == 0 ? Kubernetes::Health::Config.sick_if.call : Kubernetes::Health::Config.sick_if.call(params)
-      return head 503 if i_am_sick
-      head 200
+    def liveness
+      i_am_live = Kubernetes::Health::Config.live_if.arity == 0 ? Kubernetes::Health::Config.live_if.call : Kubernetes::Health::Config.live_if.call(params)
+      return head 200 if i_am_live
+      head 503
+    end
+
+    def readiness
+      i_am_ready = Kubernetes::Health::Config.ready_if.arity == 0 ? Kubernetes::Health::Config.ready_if.call : Kubernetes::Health::Config.ready_if.call(params)
+      return head 200 if i_am_ready
+      head 503
     end
   end
 end

data/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
-  get Kubernetes::Health::Config.route, to: 'kubernetes/health#status'
+  get Kubernetes::Health::Config.route_liveness, to: 'kubernetes/health#liveness'
+  get Kubernetes::Health::Config.route_readiness, to: 'kubernetes/health#readiness'
 end

data/lib/kubernetes/health/config.rb

@@ -1,23 +1,59 @@
 module Kubernetes
   module Health
     class Config
-      @@sick_if = lambda { false }
-      @@route = '/_health'
+      @@live_if = lambda { true }
+      @@ready_if = lambda { true }
+      @@enable_rack_on_migrate = ActiveRecord::Type::Boolean.new.cast(ENV['KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE']) || false
+      @@rack_on_migrate_rotate_http_codes = [503, 200]
+      @@route_liveness = '/_liveness'
+      @@route_readiness = '/_readiness'
 
-      def self.route
-        @@route
+      def self.enable_rack_on_migrate
+        @@enable_rack_on_migrate
       end
 
-      def self.route=(value)
-        @@route
+      def self.enable_rack_on_migrate=(value)
+        @@enable_rack_on_migrate = value
       end
 
-      def self.sick_if
-        @@sick_if
+      def self.rack_on_migrate_rotate_http_codes
+        @@rack_on_migrate_rotate_http_codes
       end
 
-      def self.sick_if=(value)
-        @@sick_if = value
+      def self.rack_on_migrate_rotate_http_codes=(value)
+        @@rack_on_migrate_rotate_http_codes = value
+      end
+
+      def self.route_liveness
+        @@route_liveness
+      end
+
+      def self.route_liveness=(value)
+        @@route_liveness = value
+      end
+
+      def self.route_readiness
+        @@route_readiness
+      end
+
+      def self.route_readiness=(value)
+        @@route_readiness = value
+      end
+
+      def self.live_if
+        @@live_if
+      end
+
+      def self.live_if=(value)
+        @@live_if = value
+      end
+
+      def self.ready_if
+        @@ready_if
+      end
+
+      def self.ready_if=(value)
+        @@ready_if = value
       end
     end
   end

data/lib/kubernetes/health/rack_on_migrate.rake

@@ -0,0 +1,22 @@
+namespace :kubernetes_health do
+  task :before_migrate do
+    Thread.new {
+      require 'rack'
+      @counter=0
+      Rack::Handler.default.run ->(env) {
+        req = Rack::Request.new(env)
+        valid = req.path_info == "#{Kubernetes::Health::Config.route_readiness}"
+        if valid
+          @counter=@counter+1
+          http_codes = Kubernetes::Health::Config.rack_on_migrate_rotate_http_codes
+          http_code = http_codes[(@counter % http_codes.size)]
+        else
+          http_code = 404
+        end
+        Rails.logger.info "Kubernetes Health: Rack on Migrate - Path: #{req.path_info} / Params: #{req.params} / Count: #{@counter} / HTTP Code: #{http_code}"
+        [http_code, {}, []]
+      }
+    }
+  end
+end
+Rake::Task['db:migrate'].enhance(['kubernetes_health:before_migrate'])

data/lib/kubernetes/health/railtie.rb

@@ -0,0 +1,9 @@
+module Kubernetes
+  module Health
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'kubernetes/health/rack_on_migrate.rake' if Kubernetes::Health::Config.enable_rack_on_migrate
+      end
+    end
+  end
+end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/kubernetes/health.rb

@@ -1,3 +1,4 @@
+require "kubernetes/health/config"
 require "kubernetes/health/version"
 require "kubernetes/health/engine"
-require "kubernetes/health/config"
+require "kubernetes/health/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,8 @@ files:
 - lib/kubernetes/health.rb
 - lib/kubernetes/health/config.rb
 - lib/kubernetes/health/engine.rb
+- lib/kubernetes/health/rack_on_migrate.rake
+- lib/kubernetes/health/railtie.rb
 - lib/kubernetes/health/version.rb
 homepage: https://github.com/platbr/kubernetes-health
 licenses: []