Skip to content
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.

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

honor offline caching in /v1/status API #412

Merged
merged 1 commit into from
Oct 31, 2023
Merged

honor offline caching in /v1/status API #412

merged 1 commit into from
Oct 31, 2023

Conversation

aead
Copy link
Member

@aead aead commented Oct 31, 2023

Now, the /v1/status API will not try fetch the backend keystore status if:

  • offline caching is enabled.
  • the keystore is considered offline.

The idea here is that if the cache considered the backend keystore as offline then it is unlikely that a Status suceeds. Instead, we can directly return unreachable.

Once, the keystore becomes available again, the cache will detect it eventually (on its next health check cycle).

Among other things, this improves pod availability when /v1/status is used as (part of) readiness probes. (i.e. MinIO) Such probes are now less likely to time out since /v1/status returns immediately.
However, if the backend keystore becomes unavailable and a /v1/status request arrives BEFORE the cache detects that the keystore is offline then these requests may time out. Hence, it is recommended to use readiness probes with a retry threshold > 1.

Now, the `/v1/status` API will not try fetch the backend
keystore status if:
 - offline caching is enabled.
 - the keystore is considered offline.

The idea here is that if the cache considered the backend
keystore as offline then it is unlikely that a `Status`
suceeds. Instead, we can directly return unreachable.

Once, the keystore becomes available again, the cache will
detect it eventually (on its next health check cycle).

Among other things, this improves pod availability when
`/v1/status` is used as (part of) readiness probes. (i.e. MinIO)
Such probes are now less likely to time out since `/v1/status`
returns immediately.
However, if the backend keystore becomes unavailable and a
`/v1/status` request arrives BEFORE the cache detects that
the keystore is offline then these requests may time out.
Hence, it is recommended to use readiness probes with a retry
threshold > 1.

Signed-off-by: Andreas Auernhammer <[email protected]>
Copy link
Contributor

@shtripat shtripat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@aead aead merged commit 3ee893d into master Oct 31, 2023
7 checks passed
@aead aead deleted the status-offline branch October 31, 2023 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants