add warning about counterintuitive readiness probe

As evidenced by https://github.com/kubernetes/kubernetes/issues/27114 the naming leads one to think that a liveness probe executes after a readiness probe. This is not the case.
pull/26387/head
Caleb Collins-Parks 2021-02-04 10:37:31 -08:00 committed by GitHub
parent f1c4f60bc1
commit bee671b579
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -293,6 +293,10 @@ Services.
Readiness probes runs on the container during its whole lifecycle.
{{< /note >}}
{{< warning >}}
Liveness probes *do not* wait for readiness probes to succeed. If you want to wait before executing a liveness probe you should use initialDelaySeconds or a startupProbe.
{{< /warning >}}
Readiness probes are configured similarly to liveness probes. The only difference
is that you use the `readinessProbe` field instead of the `livenessProbe` field.