Skip to content

Commit 78c0660

Browse files
Update configure-liveness-readiness-startup-probes.md (#47098)
* Update configure-liveness-readiness-startup-probes.md Flip the order in which liveness and readiness probes are discussed in the TCP liveness probe section, because that makes more sense. * Some updates * More updates Some more edits as I read through the page...
1 parent 0e55112 commit 78c0660

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -208,17 +208,19 @@ can't it is considered a failure.
208208
{{% code_sample file="pods/probe/tcp-liveness-readiness.yaml" %}}
209209

210210
As you can see, configuration for a TCP check is quite similar to an HTTP check.
211-
This example uses both readiness and liveness probes. The kubelet will send the
212-
first readiness probe 15 seconds after the container starts. This will attempt to
213-
connect to the `goproxy` container on port 8080. If the probe succeeds, the Pod
214-
will be marked as ready. The kubelet will continue to run this check every 10
215-
seconds.
216-
217-
In addition to the readiness probe, this configuration includes a liveness probe.
218-
The kubelet will run the first liveness probe 15 seconds after the container
219-
starts. Similar to the readiness probe, this will attempt to connect to the
220-
`goproxy` container on port 8080. If the liveness probe fails, the container
221-
will be restarted.
211+
This example uses both readiness and liveness probes. The kubelet will run the
212+
first liveness probe 15 seconds after the container starts. This will attempt to
213+
connect to the `goproxy` container on port 8080. If the liveness probe fails,
214+
the container will be restarted. The kubelet will continue to run this check
215+
every 10 seconds.
216+
217+
In addition to the liveness probe, this configuration includes a readiness
218+
probe. The kubelet will run the first readiness probe 15 seconds after the
219+
container starts. Similar to the liveness probe, this will attempt to connect to
220+
the `goproxy` container on port 8080. If the probe succeeds, the Pod will be
221+
marked as ready and will receive traffic from services. If the readiness probe
222+
fails, the pod will be marked unready and will not receive traffic from any
223+
services.
222224

223225
To try the TCP liveness check, create a Pod:
224226

@@ -305,13 +307,12 @@ livenessProbe:
305307
306308
## Protect slow starting containers with startup probes {#define-startup-probes}
307309
308-
Sometimes, you have to deal with legacy applications that might require
309-
an additional startup time on their first initialization.
310-
In such cases, it can be tricky to set up liveness probe parameters without
311-
compromising the fast response to deadlocks that motivated such a probe.
312-
The trick is to set up a startup probe with the same command, HTTP or TCP
313-
check, with a `failureThreshold * periodSeconds` long enough to cover the
314-
worst case startup time.
310+
Sometimes, you have to deal with applications that require additional startup
311+
time on their first initialization. In such cases, it can be tricky to set up
312+
liveness probe parameters without compromising the fast response to deadlocks
313+
that motivated such a probe. The solution is to set up a startup probe with the
314+
same command, HTTP or TCP check, with a `failureThreshold * periodSeconds` long
315+
enough to cover the worst case startup time.
315316

316317
So, the previous example would become:
317318

@@ -394,7 +395,7 @@ liveness and readiness checks:
394395
* `initialDelaySeconds`: Number of seconds after the container has started before startup,
395396
liveness or readiness probes are initiated. If a startup probe is defined, liveness and
396397
readiness probe delays do not begin until the startup probe has succeeded. If the value of
397-
`periodSeconds` is greater than `initialDelaySeconds` then the `initialDelaySeconds` would be
398+
`periodSeconds` is greater than `initialDelaySeconds` then the `initialDelaySeconds` will be
398399
ignored. Defaults to 0 seconds. Minimum value is 0.
399400
* `periodSeconds`: How often (in seconds) to perform the probe. Default to 10 seconds.
400401
The minimum value is 1.

0 commit comments

Comments
 (0)