health docs

cloudnativelabs · Feb 5, 2018 · 258cf2c · 258cf2c
1 parent f38dc79
commit 258cf2c
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/Documentation/healthz.md → Documentation/health.md b/Documentation/healthz.md → Documentation/health.md
@@ -1,9 +1,10 @@
 # Health checking kube-router
 
-kube-router currently has basic health checking in form of heartbeats sent from each controller to the health manager each time the main loop completes successfully.
+kube-router currently has basic health checking in form of heartbeats sent from each controller to the healthcontroller each time the main loop completes successfully.
+
+The health port is by default 20244 but can be changed with the startup option.
+The health path is `/healthz`
 
-The healthz port is by default 20244 but can be changed with the startup option
-
     --health-port=<port number>
 
 If port is set to 0 (zero) no HTTP endpoint will be made availible but the health controller will still run and print out any missed heartbeats to STDERR of kube-router