Skip to content

Update health check endpoints output examples to match the command example #55289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YutaHiguchi-bsn wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

Update health check endpoints output examples to match the command example #55289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/en/docs/reference/using-api/health-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For all endpoints, you can use the `verbose` parameter to print out the checks a
This can be useful for a human operator to debug the current status of the API server, it is not intended to be consumed by a machine:

```shell
curl -k https://localhost:6443/livez?verbose
curl -k https://localhost:6443/readyz?verbose
```

or from a remote host with authentication:
Expand Down Expand Up @@ -63,7 +63,7 @@ The output will look like this:
[+]poststarthook/kube-apiserver-autoregistration ok
[+]autoregister-completion ok
[+]poststarthook/apiservice-openapi-controller ok
healthz check passed
readyz check passed

The Kubernetes API server also supports to exclude specific checks.
The query parameters can also be combined like in this example:
Expand Down Expand Up @@ -93,7 +93,7 @@ The output show that the `etcd` check is excluded:
[+]autoregister-completion ok
[+]poststarthook/apiservice-openapi-controller ok
[+]shutdown ok
healthz check passed
readyz check passed

## Individual health checks

Expand Down