Merge pull request #2 from everpeace/change-default-probe-paths-and-port

change default probe paths and listen port.

README.md

@@ -83,10 +83,10 @@ It supports to setup kubernetes liveness/readiness probe really easily like this
   import com.github.everpeace.healthchecks._
   import com.github.everpeace.healthchecks.k8s._
 
-  // by default, listening localhost:9999
+  // by default, listening localhost:8086
   // and probe paths are
-  //   GET /k8s/liveness_probe
-  //   GET /k8s/readiness_probe
+  //   GET /live
+  //   GET /ready
   val probeBinding = bindAndHandleProbes(
     readinessProbe(healthCheck(name = "readiness_check")(healthy)),
     livenessProbe(asyncHealthCheck(name = "liveness_check")(Future(healthy)))
@@ -99,14 +99,14 @@ Then you can set kubernetes liveness/readiness probe in the kubernetes manifest
 ...
   livenessProbe:
     httpGet:
-      path: /k8s/liveness_probe
-      port: 9999
+      path: /live
+      port: 8086
       initialDelaySeconds: 3
       periodSeconds: 3
   readinessProbe:
     httpGet:
-      path: /k8s/readiness_probe
-      port: 9999
+      path: /ready
+      port: 8086
       initialDelaySeconds: 3
       periodSeconds: 3
 ...

k8s-probes/src/main/resources/reference.conf

@@ -1,8 +1,8 @@
 k8s_probe {
   host = "localhost"
-  port = "9999"
+  port = "8086"
   path {
-    liveness = "/k8s/liveness_probe"
-    readiness = "/k8s/readiness_probe"
+    liveness = "/live"
+    readiness = "/ready"
   }
 }

k8s-probes/src/test/scala/com/github/everpeace/healthchecks/k8s/K8sProbesTest.scala

@@ -48,9 +48,9 @@ class K8sProbesTest extends FreeSpec with Matchers {
       )
 
       def requestToLivenessProbe =
-        Http().singleRequest(HttpRequest(uri = "http://localhost:9999/k8s/liveness_probe"))
+        Http().singleRequest(HttpRequest(uri = "http://localhost:8086/live"))
       def requestToReadinessProbe =
-        Http().singleRequest(HttpRequest(uri = "http://localhost:9999/k8s/readiness_probe"))
+        Http().singleRequest(HttpRequest(uri = "http://localhost:8086/ready"))
 
       val livenessResponse = Await.result(requestToLivenessProbe, 10 seconds)
       val redinessResponse = Await.result(requestToReadinessProbe, 10 seconds)