kubernetes-health 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5ce6594cbd093d1eeee80c2eb544f216b5e9e88cdf13f737af125b766c38f5
-  data.tar.gz: ea119848c807d5dadd80209d4209ac2676fe5cdee4d26198fc9b72522908bc61
+  metadata.gz: 22eea741faba4096ddf070dc1135d466472913f5352db08a0e1a0e56e5199d21
+  data.tar.gz: 651e2e4a0057eec8cc7bc582767015c34ff90d0cbaf6e35f8993be2639801fc7
 SHA512:
-  metadata.gz: 017507ff1b871284d22b9a5576fb2893fa11422fcc10d9d4219d121dc655a62c5b8427f549ec22ddc9b226c2d7d24558625190e4d721cfc133714d88cd7b9cdf
-  data.tar.gz: e1c50dae1f62c05f1ee79634b74c7a14648cfac4718b4e07b6c94708498a567feeb21321c045d34f8dd34085890b6a957dc2f2871dfb4e87bcdbcf95eecaa95d
+  metadata.gz: d30a41632feaf497f2a1f1e144c661642f5a4dae8db114a484bef3651ec90134c652c8b0bbb1ccf1b2c8d27be603d4c38962f9ee557816d4568f5b353bdd853c
+  data.tar.gz: f1fa8dce9a80c68895050c66ce9be88cd6e412f1bbedf8352d7072c396763f2716d32ceead9bee742262cadbc3cf9780721bca89c47f31a1707253efc522ee07

data/README.md

@@ -1,6 +1,11 @@
 # Kubernetes::Health
 
-A gem that adds `/_readiness` and `/_liveness` and allows Kubernetes monitor your rails using HTTP while migrates are running.
+This gem allows kubernetes monitoring your app while it is running migrates and after it started.
+
+# 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). 
 
 ## Installation
 
@@ -10,35 +15,28 @@ Add this line to your application's Gemfile:
 gem 'kubernetes-health', '~> 2.0'
 ```
 
-And then execute:
-
-$ bundle
-
-## Enable migrates monitoring.
-
-This will run a Rack server for `/_readiness` route and will return `200` and `503` HTTP CODES alternately while your migrates are running.
+## Enabling monitoring while `rake db:migrate` runs
 
-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.
+Your Dockerfile's entry script needs to run migrates before start your web app.
 
 Add `KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE=true` environment variable.
 
-or
+or add in your `application.rb`.
 
 ```
-    Kubernetes::Health::Config.enable_rack_on_migrate = true # default: false
+    # default: false
+    Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
 
-On your app.
-
-If you need:
+If you need customize http rotating codes:
 
 ```
-    Kubernetes::Health::Config.rack_on_migrate_rotate_http_codes = [200, 503] # default: [202, 503]
+    # default: [200, 503]
+    Kubernetes::Health::Config.rack_on_migrate_rotate_http_codes = [200, 503]
 ```
 
-Configure your deployment readinessProbe:
+In Kubernetes you need to configure your deployment `readinessProbe` like this:
+
 ```
     readinessProbe:
         httpGet:
@@ -50,29 +48,31 @@ Configure your deployment readinessProbe:
         successThreshold: 3
 ```
 
-## Custom check
+### How `rake db:migrate` monitoring works
+It will run a RACK server for `/_readiness` and `/_liveness` routes while a `rake db:migrate` runs and it will return `200` and `503` HTTP CODES alternately avoiding to reach `failureThreshold` or `successThreshold`.
 
-Set Kubernetes::Health::Config.ready_if if you want to check other things.
+The `failureThreshold` and `successThreshold` values must to greater than `2` forcing kubernetes to wait.
+
+## Customizing checks
+
+It only works for routes in rails stack, they are not executed while `rake db:migrate` runs.
+
+Ex. Check if PostgreSQL is reachable. `params` is optional.
 
-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.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|
+Kubernetes::Health::Config.live_if = lambda { |params|
     ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
 }
 ```
 
-
-## Custom routes
+## Customizing routes
 ```
 Kubernetes::Health::Config.route_liveness = '/liveness'
 Kubernetes::Health::Config.route_readiness = '/readiness
-```
+```

data/kubernetes-health.gemspec

@@ -9,8 +9,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Wagner Caixeta"]
   spec.email         = ["wagner@baladapp.com.br"]
 
-  spec.summary       = %q{A simple gem to add /_health to your Rails APP.}
-  spec.description   = %q{A simple gem to add /_health to your Rails APP for using with Kubernetes}
+  spec.summary       = %q{This gem allows kubernetes monitoring your app while it is running migrates and after it started.}
+  spec.description   = %q{
+    This gem allows kubernetes monitoring your app while it is running migrates and after it started.
+    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.
+  }
   spec.homepage      = "https://github.com/platbr/kubernetes-health"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Wagner Caixeta
@@ -52,7 +52,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A simple gem to add /_health to your Rails APP for using with Kubernetes
+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
+  and /_liveness on rails stack;\n    * add routes /_readiness and /_liveness while
+  rake db:migrate runs.\n  "
 email:
 - wagner@baladapp.com.br
 executables: []
@@ -97,5 +101,6 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: A simple gem to add /_health to your Rails APP.
+summary: This gem allows kubernetes monitoring your app while it is running migrates
+  and after it started.
 test_files: []