Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: update vault liveness probe to /sys/health for improved reliability #678

Merged
merged 2 commits into from
Jan 5, 2025

Conversation

roee-hersh
Copy link
Contributor

@roee-hersh roee-hersh commented Dec 18, 2024

Overview

This PR updates the Vault liveness probe from /v1/sys/init to /sys/health. The /v1/sys/init endpoint does not include health status, which can cause Vault to become inaccessible when its health fails. By aligning the liveness probe with the readiness probe to use /sys/health, we ensure consistent behavior and improved reliability.

Additionally, this change aligns with the Vault official Helm chart, which also uses /sys/health for both readiness and liveness probes, as specified here.

This change comes in response to an issue where Vault stopped responding due to an unhealthy state. The issue required manually deleting the unhealthy pod to restore functionality. By using /sys/health, this problem is mitigated as it ensures the liveness probe reflects Vault's actual health.

Notes for reviewer

  • This change improves the resilience of the deployment by ensuring the liveness probe reflects Vault's actual health.
  • No additional dependencies were introduced.

Let me know if you’d like further details or adjustments! 😊

@roee-hersh roee-hersh requested a review from a team as a code owner December 18, 2024 12:14
@roee-hersh roee-hersh requested review from lgecse and removed request for a team December 18, 2024 12:14
@github-actions github-actions bot added the size/XS Denotes a PR that changes 0-9 lines label Dec 18, 2024
@roee-hersh roee-hersh changed the title liveness should also check health Update Vault Liveness Probe to /sys/health for Improved Reliability Dec 18, 2024
@roee-hersh roee-hersh changed the title Update Vault Liveness Probe to /sys/health for Improved Reliability fix: update vault liveness probe to /sys/health for improved reliability Dec 18, 2024
@csatib02 csatib02 requested review from csatib02 and removed request for lgecse December 19, 2024 12:17
@csatib02 csatib02 added kind/enhancement Categorizes issue or PR as related to an improvement. area/provider/vault labels Dec 19, 2024
Copy link
Member

@csatib02 csatib02 left a comment

Choose a reason for hiding this comment

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

LGTM!

Can you please update the comment above the Liveness-probe to: https://developer.hashicorp.com/vault/api-docs/system/health

Also, could you please sign your commits, there are instructions here: https://github.com/bank-vaults/vault-operator/pull/678/checks?check_run_id=34592516515

Signed-off-by: Roee Hershko <roee.hershko@riskified.com>
Signed-off-by: Bence Csati <bence.csati@axoflow.com>
Copy link
Member

@csatib02 csatib02 left a comment

Choose a reason for hiding this comment

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

LGTM!

@csatib02 csatib02 merged commit 4511075 into bank-vaults:main Jan 5, 2025
18 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
area/provider/vault kind/enhancement Categorizes issue or PR as related to an improvement. size/XS Denotes a PR that changes 0-9 lines
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

2 participants