whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

using-api/health-checks.md: use consistent casing

Browse Source 
This commit updates two instances so that the casing of `HTTP` and `API` is consistent throughout the document.
This commit is contained in:
Lucas Servén Marín
2021-07-07 00:49:43 +02:00
committed by GitHub
parent a64769c54f
commit df71479a6e
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/reference/using-api/health-checks.md
+2 -2
View File
@@ -25,7 +25,7 @@ The more verbose options shown below are intended to be used by human operators
The following examples will show how you can interact with the health API endpoints. The following examples will show how you can interact with the health API endpoints.
For all endpoints you can use the `verbose` parameter to print out the checks and their status. For all endpoints you can use the `verbose` parameter to print out the checks and their status.
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: 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 ```shell
curl -k https://localhost:6443/livez?verbose curl -k https://localhost:6443/livez?verbose
@@ -93,7 +93,7 @@ The output show that the `etcd` check is excluded:
{{< feature-state state="alpha" >}} {{< feature-state state="alpha" >}}
Each individual health check exposes an http endpoint and could can be checked individually. Each individual health check exposes an HTTP endpoint and could can be checked individually.
The schema for the individual health checks is `/livez/<healthcheck-name>` where `livez` and `readyz` and be used to indicate if you want to check the liveness or the readiness of the API server. The schema for the individual health checks is `/livez/<healthcheck-name>` where `livez` and `readyz` and be used to indicate if you want to check the liveness or the readiness of the API server.
The `<healthcheck-name>` path can be discovered using the `verbose` flag from above and take the path between `[+]` and `ok`. The `<healthcheck-name>` path can be discovered using the `verbose` flag from above and take the path between `[+]` and `ok`.
These individual health checks should not be consumed by machines but can be helpful for a human operator to debug a system: These individual health checks should not be consumed by machines but can be helpful for a human operator to debug a system: