New probes page #49968
New probes page #49968
Conversation
k8s-ci-robot
added
language/en
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/L
|
/kind documention |
|
@AmarNathChary: The label(s) In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| Probes are configured as part of the Pod specification in YAML manifests. Each probe can define multiple parameters to suit specific application requirements. Below are the details for configuring each type of probe: | ||
|
|
||
| #### Key Fields |
There was a problem hiding this comment.
Please avoid H4 level of headers if possible.
| - **`periodSeconds`**: Interval between probe attempts. | ||
| - **`timeoutSeconds`**: Maximum time to wait for a response. | ||
| - **`failureThreshold`**: Number of consecutive failures before the probe is considered failed. | ||
| - **`successThreshold`**: Number of consecutive successes before the probe is considered successful. |
There was a problem hiding this comment.
You don't need to highlight field names with BOTH teletype fonts and bold.
Simply make them teletype would be good enough.
|
|
||
| An HTTP probe sends an HTTP GET request to a specific endpoint within the container. This is useful for applications exposing an HTTP server. | ||
|
|
||
| #### Example Configuration |
There was a problem hiding this comment.
Again. An example doesn't need a subsection.
|
|
||
| ## gRPC Health Checks | ||
|
|
||
| Kubernetes can use the gRPC Health Check Protocol for monitoring gRPC services. The gRPC health check response includes different statuses that can be leveraged for configuring liveliness and readiness probes. |
There was a problem hiding this comment.
"gRPC Health Check Protocol" is a term?
Why capitalize the first characters in each words?
|
|
||
| ## Best Practices | ||
|
|
||
| 1. **Choose the Right Probe for the Use Case:** |
There was a problem hiding this comment.
We don't need an ordered list here, right?
Why use bold fonts here?
|
|
||
| <!-- overview --> | ||
|
|
||
| This page provides an overview of Probes. Probes in Kubernetes serve as a health checker for the containers, ensuring their reliability and availability within the pods. These diagnostic tools enable Kubernetes to monitor the health of the workloads and take appropriate actions when issues arise, like restarting unhealthy containers or temporarily removing pods from service endpoints. Configuring probes is essential for maintaining the stability, resilience, and overall performance of applications in the Kubernetes cluster. |
There was a problem hiding this comment.
Please wrap the long lines as we do for other pages.
There was a problem hiding this comment.
Made the changes accordingly as suggested PTAL!
This PR partially fixes issue #46886