From f0ce92e69d54b97aed9a04a99dfce21597cf3ec5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81d=C3=A1m=20S=C3=A1ndor?= Date: Mon, 20 Nov 2017 15:16:21 +0100 Subject: [PATCH] Mention readiness probe in configuration section The configuration values section only mentions liveness probes which is confusing for the reader. Additionally liveness and readiness probes behave differently if they time out. Readiness probe will not restart the Pod but the documentation looks like it would. --- .../configure-liveness-readiness-probes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md index ffd94bebfd..86ad07ecd9 100644 --- a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md +++ b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md @@ -252,7 +252,7 @@ you can use to more precisely control the behavior of liveness and readiness checks: * `initialDelaySeconds`: Number of seconds after the container has started -before liveness probes are initiated. +before liveness or readiness probes are initiated. * `periodSeconds`: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * `timeoutSeconds`: Number of seconds after which the probe times out. Defaults @@ -261,7 +261,7 @@ to 1 second. Minimum value is 1. considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. * `failureThreshold`: When a Pod starts and the probe fails, Kubernetes will -try `failureThreshold` times before giving up and restarting the Pod. +try `failureThreshold` times before giving up. Giving up in case of liveness probe means restarting the Pod. In case of readiness probe the Pod will be marked Unready. Defaults to 3. Minimum value is 1. [HTTP probes](/docs/api-reference/{{page.version}}/#httpgetaction-v1-core)