Skip to content

OSDOCS-16473 Ingress controller route timeout configurable variables …#106920

Open
jmanthei wants to merge 1 commit intoopenshift:mainfrom
jmanthei:OSDOCS-16374
Open

OSDOCS-16473 Ingress controller route timeout configurable variables …#106920
jmanthei wants to merge 1 commit intoopenshift:mainfrom
jmanthei:OSDOCS-16374

Conversation

@jmanthei
Copy link
Contributor

…table placed in correct section

Version(s): 4.12+

Issue: https://issues.redhat.com/browse/OSDOCS-16374

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 18, 2026
@jmanthei jmanthei force-pushed the OSDOCS-16374 branch 3 times, most recently from e049e62 to b308dc1 Compare February 19, 2026 04:00
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskContents: The '.Procedure' block title is missing.

[role="_abstract"]
To manage connection durations and optimize performance of your Ingress Controller, you can configure router timeout variables. These variables control how long the router waits for client responses, server data, or established connections before closing them.

.Configuring a router timeout
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskTitle: Unsupported titles cannot be mapped to DITA tasks.

[role="_abstract"]
To manage connection durations and optimize performance of your Ingress Controller, you can configure router timeout variables. These variables control how long the router waits for client responses, server data, or established connections before closing them.

.Configuring a router timeout
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.


|===

.A route setting custom timeout
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.TaskTitle: Unsupported titles cannot be mapped to DITA tasks.

haproxy.router.openshift.io/timeout: 5500ms <1>
...
----
<1> Specifies the new timeout with HAProxy supported units (`us`, `ms`, `s`, `m`, `h`, `d`). If the unit is not provided, `ms` is the default.
Copy link
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.

@jmanthei
Copy link
Contributor Author

Passes asciiditavale check - one block title warning - fixing

@openshift-ci
Copy link

openshift-ci bot commented Feb 23, 2026

@jmanthei: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@jmanthei
Copy link
Contributor Author

All clear for asciiditavale checks
@melvinjoseph86 for QA check - when we updated the route information table, we removed the timeout configurable variables because they belonged in a different section.

Copy link

@melvinjoseph86 melvinjoseph86 left a comment

Choose a reason for hiding this comment

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

@jmanthei is PR commit message with OSDOCS-16473 is the intended one for https://issues.redhat.com/browse/OSDOCS-16374?

Comment on lines +24 to +25
| `ROUTER_DEFAULT_SERVER_TIMEOUT` | `30s` | Length of time that a server has to acknowledge or send data.
| `ROUTER_DEFAULT_TUNNEL_TIMEOUT` | `1h` | Length of time for TCP or WebSocket connections to remain open. This timeout period resets whenever HAProxy reloads.

Choose a reason for hiding this comment

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

Comment on lines +35 to +50
==Example of a route setting custom timeout
[source,yaml]
----
apiVersion: route.openshift.io/v1
kind: Route
metadata:
annotations:
haproxy.router.openshift.io/timeout: 5500ms
...
----

[NOTE]
====
Setting a server-side timeout value for passthrough routes too low can cause
WebSocket connections to timeout frequently on that route.
==== No newline at end of file

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants