kubernetes-health 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d1704a677ece777beeb57a3e9ad5f7db63afd78bbf00a58161aa3353aeb8a59
-  data.tar.gz: 73dc70adb7d1019e0b3c9c9fc0a4b2456feb655118f88216050f464a221c9003
+  metadata.gz: 4425830e42d12960033f406ddb4e3da9d33e7d4f2836362cfad272b2aefa7aee
+  data.tar.gz: 72ea97e57b9100f0e465abf1e1e17168a8706f8eeb85f9d14b3e4f5d5660d6ed
 SHA512:
-  metadata.gz: 8e534c0c28212798cc15a7311b4a6d0b7b6e04721c573abaf34442becaabea4d451a2ca80af3f7fcf1081305a500df48ae9360db3ea39e73e87a9d473754cc53
-  data.tar.gz: cb924de9d60c20f32d27d14c4e30a60e5992932e6a8c204be03fbfc1c0ec4c95f5af8827e45632ff12093532ab993c78d7b63a380994fac28ec094f974dcc2a7
+  metadata.gz: 779947240739615102d287539e8f9542c1e73c2af1c5cc4d2d11d2760c866b5b6669d4482a881518844d028be4e53e930549d80b41bbfb6af3136ea6207ad84f
+  data.tar.gz: 16127f3a04957449a1c731ff2649e5b480b88486c1d2d94d572c80c162cfdd802e05c8db36a722b7435624d4b604d5d4deae151281702468182cc3a2b95390ed

data/README.md

@@ -5,14 +5,15 @@ This gem allows kubernetes monitoring your app while it is running migrates and
 # Features
 - add routes `/_readiness` and `/_liveness` on rails stack by default.
 - allow custom checks for `/_readiness` and `/_liveness` on rails stack.
-- add routes `/_readiness` and `/_liveness` while `rake db:migrate` runs. (optional). 
+- add routes `/_readiness` and `/_liveness` while `rake db:migrate` runs. (optional)
+- add support to avoid parallel running of `rake db:migrate` while keep kubernetes waiting. (optional)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 2.0'
+gem 'kubernetes-health', '~> 2.1'
 ```
 
 ## Enabling monitoring while `rake db:migrate` runs
@@ -24,8 +25,8 @@ Add `KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE=true` environment variable.
 or add in your `application.rb`.
 
 ```
-    # default: false
-    Kubernetes::Health::Config.enable_rack_on_migrate = true
+# default: false
+Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
 
 In Kubernetes you need to configure your deployment `readinessProbe` like this:
@@ -46,7 +47,30 @@ In Kubernetes you need to configure your deployment `readinessProbe` like this:
 ```
 
 ### How `rake db:migrate` monitoring works
-It will run a RACK server for `/_readiness` and `/_liveness` routes while a `rake db:migrate` is running.
+It will run a RACK server for `/_readiness` and `/_liveness` routes while `rake db:migrate` is running.
+
+## Avoid `rake db:migrate` parallel running.
+
+Add `KUBERNETES_HEALTH_ENABLE_LOCK_ON_MIGRATE=true` environment variable.
+
+or add in your `application.rb`.
+
+```
+# default: false
+Kubernetes::Health::Config.enable_lock_on_migrate = true
+```
+
+### Customizing locking
+By default it is working for PostgreSQL, but you can customize it using a lambda:
+```
+Kubernetes::Health::Config.lock_or_wait = lambda {
+    ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);'
+}
+
+Kubernetes::Health::Config.unlock = lambda {
+    ActiveRecord::Base.connection.execute 'select pg_advisory_unlock(123456789123456789);'
+}
+```
 
 ## Customizing checks
 

data/kubernetes-health.gemspec

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rack"
+  spec.add_dependency "rails"
 end

data/lib/kubernetes/health/config.rb

@@ -3,9 +3,36 @@ module Kubernetes
     class Config
       @@live_if = lambda { true }
       @@ready_if = lambda { true }
+      @@enable_lock_on_migrate = ActiveRecord::Type::Boolean.new.cast(ENV['KUBERNETES_HEALTH_ENABLE_LOCK_ON_MIGRATE']) || false
       @@enable_rack_on_migrate = ActiveRecord::Type::Boolean.new.cast(ENV['KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE']) || false
       @@route_liveness = '/_liveness'
       @@route_readiness = '/_readiness'
+      @@lock_or_wait = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);' }
+      @@unlock = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_unlock(123456789123456789);' }
+
+      def self.lock_or_wait
+        @@lock_or_wait
+      end
+
+      def self.lock_or_wait=(value)
+        @@lock_or_wait = value
+      end
+
+      def self.unlock
+        @@unlock
+      end
+
+      def self.unlock=(value)
+        @@unlock = value
+      end
+
+      def self.enable_lock_on_migrate
+        @@enable_lock_on_migrate
+      end
+
+      def self.enable_lock_on_migrate=(value)
+        @@enable_lock_on_migrate = value
+      end
 
       def self.enable_rack_on_migrate
         @@enable_rack_on_migrate
@@ -46,6 +73,7 @@ module Kubernetes
       def self.ready_if=(value)
         @@ready_if = value
       end
+
     end
   end
 end

data/lib/kubernetes/health/lock_on_migrate.rake

@@ -0,0 +1,13 @@
+namespace :kubernetes_health do
+  task :lock_on_migrate do
+    Rails.logger.info "Kubernetes Health: Lock on Migrate - Locking or waiting started."
+    Kubernetes::Health::Config.lock_or_wait.call
+    Rails.logger.info "Kubernetes Health: Lock on Migrate - Locking or waiting finished."
+    at_exit {
+      Rails.logger.info "Kubernetes Health: Lock on Migrate - Unlocking started."
+      Kubernetes::Health::Config.unlock.call
+      Rails.logger.info "Kubernetes Health: Lock on Migrate - Unlocking finished."
+    }
+  end
+end
+Rake::Task['db:migrate'].enhance(['kubernetes_health:lock_on_migrate'])

data/lib/kubernetes/health/rack_on_migrate.rake

@@ -1,21 +1,10 @@
+require 'rack'
+require "kubernetes/health/rack_on_migrate"
 namespace :kubernetes_health do
-  task :before_migrate do
+  task :rack_on_migrate do
     Thread.new {
-      require 'rack'
-      Rack::Handler.default.run ->(env) {
-        req = Rack::Request.new(env)
-        case req.path_info
-        when Kubernetes::Health::Config.route_readiness
-          http_code = 503
-        when Kubernetes::Health::Config.route_liveness
-          http_code = 200
-        else
-          http_code = 404
-        end
-        Rails.logger.info "Kubernetes Health: Rack on Migrate - Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}"
-        [http_code, {}, []]
-      }
+      Rack::Handler.default.run Kubernetes::Health::RackOnMigrate.new
     }
   end
 end
-Rake::Task['db:migrate'].enhance(['kubernetes_health:before_migrate'])
+Rake::Task['db:migrate'].enhance(['kubernetes_health:rack_on_migrate'])

data/lib/kubernetes/health/rack_on_migrate.rb

@@ -0,0 +1,19 @@
+module Kubernetes
+  module Health
+    class RackOnMigrate
+      def call(env)
+        req = Rack::Request.new(env)
+        case req.path_info
+        when Kubernetes::Health::Config.route_readiness
+          http_code = 503
+        when Kubernetes::Health::Config.route_liveness
+          http_code = 200
+        else
+          http_code = 404
+        end
+        Rails.logger.info "Kubernetes Health: Rack on Migrate - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}"
+        [http_code, {}, []]
+      end
+    end
+  end
+end

data/lib/kubernetes/health/railtie.rb

@@ -3,6 +3,7 @@ module Kubernetes
     class Railtie < Rails::Railtie
       rake_tasks do
         load 'kubernetes/health/rack_on_migrate.rake' if Kubernetes::Health::Config.enable_rack_on_migrate
+        load 'kubernetes/health/lock_on_migrate.rake' if Kubernetes::Health::Config.enable_lock_on_migrate
       end
     end
   end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Wagner Caixeta
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "\n    This gem allows kubernetes monitoring your app while it is running
   migrates and after it started.\n    Features:\n    * add routes /_readiness and
   /_liveness on rails stack by default;\n    * allow custom checks for /_readiness
@@ -77,7 +105,9 @@ files:
 - lib/kubernetes/health.rb
 - lib/kubernetes/health/config.rb
 - lib/kubernetes/health/engine.rb
+- lib/kubernetes/health/lock_on_migrate.rake
 - lib/kubernetes/health/rack_on_migrate.rake
+- lib/kubernetes/health/rack_on_migrate.rb
 - lib/kubernetes/health/railtie.rb
 - lib/kubernetes/health/version.rb
 homepage: https://github.com/platbr/kubernetes-health