Traefik-passthrough doc file#48556
Open
ruchikajha95 wants to merge 5 commits intokeycloak:mainfrom
Open
Conversation
Closes keycloak#48128 Signed-off-by: Ruchika <[email protected]>
Closes keycloak#48128 Signed-off-by: Ruchika <[email protected]>
Closes keycloak#48128 Signed-off-by: Ruchika <[email protected]>
pruivo
requested changes
Apr 29, 2026
Member
|
The PR looks good to me. Once Pedro's comments are addressed, this should be good for merging. The experiment on what happens to open TCP connections once Traefik detects a backend is down could be handled as a follow-up if we want to get this merged earlier. |
Closes keycloak#48128 Signed-off-by: Ruchika <[email protected]>
Contributor
Author
All the comments above have been addressed . Thank you @pruivo @ahus1 |
pruivo
requested changes
Apr 29, 2026
| <2> Ensures this router takes precedence over any other TCP routers that may be defined. | ||
| <3> Instructs Traefik to forward the raw TLS stream without terminating it. | ||
| {project_name} handles TLS termination directly. | ||
| <4> Enables link:https://doc.traefik.io/traefik/routing/services/#proxy-protocol[PROXY protocol v2] on all backend connections. |
Member
There was a problem hiding this comment.
Link points to an incorrect page
Suggested change
| <4> Enables link:https://doc.traefik.io/traefik/routing/services/#proxy-protocol[PROXY protocol v2] on all backend connections. | |
| <4> Enables link:https://doc.traefik.io/traefik/reference/routing-configuration/tcp/serverstransport/#proxyprotocolversion[PROXY protocol v2] on all backend connections. |
| This allows {project_name} to read the real client IP address from the PROXY protocol header added by Traefik. | ||
| This requires {project_name} to be configured with `--proxy-protocol-enabled=true` (see <<keycloak-configuration>>). | ||
| <5> Links the load balancer to the named transport above, activating PROXY protocol v2 for all connections to the backend servers. | ||
| <6> Configures a link:https://doc.traefik.io/traefik/routing/services/#health-check_1[TCP-level health check] against {project_name}'s management port (`9000`). |
Member
There was a problem hiding this comment.
incorrect link
Suggested change
| <6> Configures a link:https://doc.traefik.io/traefik/routing/services/#health-check_1[TCP-level health check] against {project_name}'s management port (`9000`). | |
| <6> Configures a link:https://doc.traefik.io/traefik/reference/routing-configuration/tcp/service/#health-check[TCP-level health check] against {project_name}'s management port (`9000`). |
| It would not detect split-brain, database connectivity failures, or an overloaded node. | ||
| Native HTTP health checks for TCP services are not yet supported in Traefik; track upstream progress at link:https://github.com/traefik/traefik/pull/12606[traefik/traefik#12606]. | ||
|
|
||
| <7> Defines the two {project_name} backend servers. |
Comment on lines
+142
to
+144
| Configures the management port (`9000`) to use plain HTTP instead of HTTPS. | ||
| Traefik cannot perform an HTTPS health check on a TCP passthrough service, so the management port must use plain HTTP. | ||
| This is safe because the management port is only reachable on the internal backend network and is not exposed to clients. |
Member
There was a problem hiding this comment.
Let me know if this sounds clearer @ruchikajha95 @ahus1
Suggested change
| Configures the management port (`9000`) to use plain HTTP instead of HTTPS. | |
| Traefik cannot perform an HTTPS health check on a TCP passthrough service, so the management port must use plain HTTP. | |
| This is safe because the management port is only reachable on the internal backend network and is not exposed to clients. | |
| Configures the management port (`9000`) to use plain HTTP instead of HTTPS. | |
| Traefik does not support native HTTP health checks for TCP services; it can only send and match raw bytes over a plain TCP connection. | |
| Disabling TLS on the management port allows the raw `send`/`expect` health check (see the health check configuration above) to communicate with {project_name} in plain HTTP. | |
| This is safe because the management port is only reachable on the internal backend network and is not exposed to clients. |
|
|
||
| <1> Matches all TLS connections regardless of the SNI hostname. | ||
| This is suitable when Traefik is dedicated to {project_name} only. | ||
| If Traefik handles multiple backend services, use a specific hostname instead of a wildcard (for example, `HostSNI(`keycloak.example.com`)`) to avoid routing unintended traffic to {project_name}. |
Member
There was a problem hiding this comment.
The rendering is broken.
The suggestion below seems to fix it
Suggested change
| If Traefik handles multiple backend services, use a specific hostname instead of a wildcard (for example, `HostSNI(`keycloak.example.com`)`) to avoid routing unintended traffic to {project_name}. | |
| If Traefik handles multiple backend services, use a specific hostname instead of a wildcard (for example, ``HostSNI(`keycloak.example.com`)``) to avoid routing unintended traffic to {project_name}. |
Closes keycloak#48128 Signed-off-by: Ruchika <[email protected]>
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
3 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.
Replicated the adoc file for Traefik using Haproxy as a reference.
Closes #48128