-
Notifications
You must be signed in to change notification settings - Fork 134
Change success response status of health checks to 200 (OK) #1047
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
Change success response status of health checks to 200 (OK) #1047
Conversation
|
Thanks for the PR! I was wondering if this type of change would need a Strimzi proposal first in order to explain the motivation for the change (which is anyway in the description here) and the compatibility with current users. It would not be that complex and in the past we had similar proposals like https://github.com/strimzi/proposals/blob/main/063-pdb-generation-environment-variable.md and https://github.com/strimzi/proposals/blob/main/028-network-policy-generation-environment-variable.md to use an env var for changing the default behaviour within the Strimzi operator. @strimzi/maintainers wdyt? |
|
@joschi meanwhile please check that doc build is failing with the following error (in the Azure pipeline): ERROR: Uncommitted changes in documentation:
M documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256
M documentation/book/api/index.adoc
Run the following to add up-to-date resources:
make docu_api \
&& git add documentation/book/ \
&& git commit -s -m 'Update generated documentation'
make: *** [Makefile:69: docu_check] Error 1you should be able to fix it by just following the above instructions. |
93c17a7 to
e357b50
Compare
SGTM 👍 having the proposal to set motivation and make it more visible (to current users). |
This proposal introduces an environment variable to configure the HTTP response status code for Kafka Bridge health check endpoints, addressing compatibility issues with various cloud load balancers. Refs strimzi/strimzi-kafka-bridge#1047 Signed-off-by: Jochen Schalanda <[email protected]>
Some load balancers cannot handle HTTP response codes other than 200 (OK) in health checks and treat every other response codes (even in the 2xx range) as unhealthy. The response codes of the `/ready` and `/healthy` HTTP resources has been changed from 204 (No Content) to 200 (OK) to accommodate these load balancer health checks. Signed-off-by: Jochen Schalanda <[email protected]>
e357b50 to
f36e1cc
Compare
|
@ppatierno @see-quick changed the PR according to the latest proposal. |
|
Thanks @joschi let's wait for the proposal to be approved. |
This proposal introduces an environment variable to configure the HTTP response status code for Kafka Bridge health check endpoints, addressing compatibility issues with various cloud load balancers. Refs strimzi/strimzi-kafka-bridge#1047 Signed-off-by: Jochen Schalanda <[email protected]>
* Add configurable HTTP response status for health checks This proposal introduces an environment variable to configure the HTTP response status code for Kafka Bridge health check endpoints, addressing compatibility issues with various cloud load balancers. Refs strimzi/strimzi-kafka-bridge#1047 Signed-off-by: Jochen Schalanda <[email protected]> * Add more details about the proposal Signed-off-by: Jochen Schalanda <[email protected]> * Update 124-configurable-health-check-response-status.md Co-authored-by: Paolo Patierno <[email protected]> Signed-off-by: Jochen Schalanda <[email protected]> * Add proposal 125 to table in README Signed-off-by: Jochen Schalanda <[email protected]> * Update proposal Signed-off-by: Jochen Schalanda <[email protected]> * Update 124-configurable-health-check-response-status.md Signed-off-by: Jochen Schalanda <[email protected]> * Renumber proposal and update title Signed-off-by: Jochen Schalanda <[email protected]> --------- Signed-off-by: Jochen Schalanda <[email protected]> Co-authored-by: Paolo Patierno <[email protected]>
ppatierno
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
|
@ppatierno I guess we both missed the CHANGELOG update :-/ |
|
I realized right after merging but I opened the PR for that. |
Yeah, I somehow realized it immediately when I saw the merge email ... I guess the brain works in strange ways 🤷 😄 |
Some load balancers cannot handle HTTP response codes other than 200 (OK) in health checks and treat every other response codes (even in the 2xx range) as unhealthy.
The response codes of the
/readyand/healthyHTTP resources has been changed from 204 (No Content) to 200 (OK) to accommodate these load balancer health checks.