PROJQUAY-5074: docs: add storage health check configuration fields#1667
Open
Rachimypala-RM wants to merge 1 commit into
Open
PROJQUAY-5074: docs: add storage health check configuration fields#1667Rachimypala-RM wants to merge 1 commit into
Rachimypala-RM wants to merge 1 commit into
Conversation
Add documentation for three new configuration parameters introduced to improve health check coverage for storage engines: - HEALTH_CHECKER_INSTANCE_CHECK_PREFERRED_STORAGE: enables preferred storage validation on /health/instance for Kubernetes liveness probes - DISTRIBUTED_STORAGE_VALIDATE_ENDTOEND: enables validation of all configured storage engines on /health/endtoend instead of only the preferred engine - DISTRIBUTED_STORAGE_REQUIRES_ALL_AVAILABLE: controls whether any single engine failure or all-engine failure triggers a 503 response Updates health-check-quay.adoc with new endpoint behavior descriptions and example JSON outputs. Creates a new config-fields-health-check.adoc reference module and wires it into config_quay/master.adoc. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
lechuk47
reviewed
Jun 23, 2026
| [id="config-fields-health-check"] | ||
| = Storage health check configuration fields | ||
|
|
||
| The following configuration fields control how {productname} validates storage engine availability during health checks. These fields allow you to tune the `GET /health/instance` and `GET /health/endtoend` endpoints for geo-replicated deployments and Kubernetes liveness probes. |
There was a problem hiding this comment.
I would say this suits better the readiness probe instead of liveness.
lechuk47
reviewed
Jun 23, 2026
| [source,yaml] | ||
| ---- | ||
| # ... | ||
| # Add preferred_storage check to /health/instance (recommended for Kubernetes liveness probes) |
There was a problem hiding this comment.
Same as before, dependencies should be checked in readiness, not liveness.
|
@kleesc Since you introduced this feature, could take an additional look please? I may be missing context on why this was added. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation for three new configuration parameters introduced to improve health check coverage for storage engines:
Updates health-check-quay.adoc with new endpoint behavior descriptions and example JSON outputs. Creates a new config-fields-health-check.adoc reference module and wires it into config_quay/master.adoc.