Document file-based probes support #805
Conversation
doc/user-guide-v1.adoc
Outdated
| | `probes.liveness` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request++[Kubernetes liveness probe] that controls when Kubernetes needs to restart the pod. | ||
| | `probes.readiness` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes++[Kubernetes readiness probe] that controls when the pod is ready to receive traffic. | ||
| | `probes.startup` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes++[Kubernetes startup probe] that controls when Kubernetes needs to startup the pod on its first initialization. | ||
| | `probes.enableFileBased` | A Boolean to enable file-based health checks within the `/output/health` directory of the Liberty container. Requires Liberty images 25.0.0.6 or later with `mpHealth-4.0` installed. For examples, see link:#configure-file-based-probes[Configure file-based probes with mpHealth-4.0]. |
There was a problem hiding this comment.
A Boolean to enable file-based health checks within the /output/health directory of the Liberty container. Requires Liberty images 25.0.0.6 or later with mpHealth-4.0 installed.
-->
Enable file-based health checks for the Liberty container. Requires Liberty 25.0.0.6 or later with mpHealth-4.0 feature installed and enabled within your application image at build time.
Add "Defaults to false" at the end.
doc/user-guide-v1.adoc
Outdated
| | `probes.startup` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes++[Kubernetes startup probe] that controls when Kubernetes needs to startup the pod on its first initialization. | ||
| | `probes.enableFileBased` | A Boolean to enable file-based health checks within the `/output/health` directory of the Liberty container. Requires Liberty images 25.0.0.6 or later with `mpHealth-4.0` installed. For examples, see link:#configure-file-based-probes[Configure file-based probes with mpHealth-4.0]. | ||
| | `probes.checkInterval` | The interval at which the Liberty runtime queries to update the file-based health check files. The value is a number followed by an optional time unit of `ms` for milliseconds or `s` for seconds. Only used when `.spec.probes.enableFiledBased` is set to `true`. Defaults to `5s`. | ||
| | `probes.startupCheckInterval` | The interval at which the Liberty runtime will query until an UP status is resolved and the health check file is created. The value is a number followed by an optional time unit of `ms` for milliseconds or `s` for seconds. If no time unit is specified for a value, the value is in milliseconds by default. Only used when `.spec.probes.enableFiledBased` is set to `true`. Defaults to `100ms`. |
There was a problem hiding this comment.
The interval at which the Liberty runtime will query until an UP status is resolved and the health check file is created.
-->
The interval at which the Liberty runtime queries until the UP statuses for all three health check types are established during the startup and the health check files are created.
doc/user-guide-v1.adoc
Outdated
|
|
||
| File-based probes are not enabled in applications by default. | ||
|
|
||
| - The Liberty image specified at `.spec.applicationImage` requires the `mpHealth-4.0` feature to be installed on a Liberty server running version `25.0.0.6` or higher. |
There was a problem hiding this comment.
requires the mpHealth-4.0 feature to be installed --> requires the mpHealth-4.0 feature to be installed and enabled
doc/user-guide-v1.adoc
Outdated
|
|
||
| Starting in Liberty Operator version 1.5.2, a new Boolean field, `.spec.probes.enableFileBased`, allows you to set file-based health checks using the link:++https://openliberty.io/docs/latest/health-check-microservices.html#_microprofile_health_v4_0++[MicroProfile Health 4.0 feature]. | ||
|
|
||
| File-based probes are not enabled in applications by default. |
There was a problem hiding this comment.
Mention that probes based on HTTP GET request are used by default.
|
@kabicin Thanks for addressing the review comments. I've approved it. But I'll hold off merging until release. |
What this PR does / why we need it?:
.spec.probes.enableFileBasedDoes this PR introduce a user-facing change?
CHANGELOG.mdWhich issue(s) this PR fixes:
Fixes #