Allow publishing per-service healthcheck endpoints - #227
Draft
kevinmcconnell wants to merge 1 commit into
Draft
Conversation
When running Kamal Proxy behind downstream load balancers, it can be
difficult to route those load balancers' health checks to the correct
service if those checks don't carry the correct `Host` header.
(Unfortunately, many cloud load balancers don't allow setting that
header in their healthcheck configuration).
To make this easier, we add the ability to publish a service's
configured healthcheck at a well-known service-specific path. For
example, a service `app` can be health-checked at
`/.kamal-proxy/app/health`.
To enable the published health check endpoint for a service, set the
`--publish-health-check` flag:
kamal-proxy deploy app --target web-1:3000 \
--host app1.example.com --publish-health-check
The published health check endpoints are not subject to host checking,
TLS requirements, or canonical redirects.
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
1 participant
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.
When running Kamal Proxy behind downstream load balancers, it can be difficult to route those load balancers' health checks to the correct service if those checks don't carry the correct
Hostheader. (Unfortunately, many cloud load balancers don't allow setting that header in their healthcheck configuration).To make this easier, we add the ability to publish a service's configured healthcheck at a well-known service-specific path. For example, a service
appcan be health-checked at/.kamal-proxy/app/health.To enable the published health check endpoint for a service, set the
--publish-health-checkflag:The published health check endpoints are not subject to host checking, TLS requirements, or canonical redirects.