-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-16304 Hard stop after tuning options #109586
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
Open
jmanthei
wants to merge
1
commit into
openshift:main
Choose a base branch
from
jmanthei:OSDOCS-16304
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Module included in the following assemblies: | ||
| // * scalability_and_performance/optimization/routing-optimization.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="configuring-haproxy-hard-stop-after_{context}"] | ||
| = Configuring HAProxy hard-stop-after for router reloads | ||
|
|
||
| [role="_abstract"] | ||
| During a router reload, HAProxy performs a soft stop: the previous process keeps serving existing connections until they close. The HAProxy global option `hard-stop-after` sets the maximum time allowed for that graceful shutdown before remaining connections are forced closed. Setting this limit can reduce accumulation of old HAProxy processes when reloads are frequent and some connections stay open for a long time. | ||
|
|
||
| The Ingress Operator configures this option when you set the `ingress.operator.openshift.io/hard-stop-after` annotation on an `IngressController` or on the cluster `Ingress` configuration (`ingresses.config/cluster`). The value is a duration in HAProxy time format (for example, `30m` or `1h`). If the annotation is present on both resources, the value on the `IngressController` takes precedence. | ||
|
|
||
| This setting is not the same as `spec.tuningOptions.tunnelTimeout` on the `IngressController`, which limits how long an idle tunnel connection (including WebSockets) remains open during normal operation. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| If you set `idleConnectionTerminationPolicy` to `Deferred` on the `IngressController`, idle connections can remain open across reloads, which may increase the number of HAProxy processes in the router pod. In environments with frequent reloads, consider setting `ingress.operator.openshift.io/hard-stop-after` to avoid exhausting resources. | ||
| ==== | ||
|
|
||
| .Procedure | ||
|
|
||
| * To set `hard-stop-after` on a specific Ingress Controller, run the `oc annotate` command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc -n openshift-ingress-operator annotate ingresscontrollers/<ingresscontroller_name> ingress.operator.openshift.io/hard-stop-after=<duration> <1> | ||
| ---- | ||
| + | ||
| <1> Replace `<ingresscontroller_name>` with the name of your Ingress Controller. Replace `<duration>` with a valid HAProxy time value, for example `1h`. | ||
|
|
||
| * To set the same annotation for the entire cluster by using the cluster `Ingress` configuration, run the `oc annotate` command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc annotate ingresses.config/cluster ingress.operator.openshift.io/hard-stop-after=<duration> <1> | ||
| ---- | ||
| + | ||
| <1> Replace `<duration>` with a valid HAProxy time value, for example `1h`. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA. |
||
|
|
||
| * To remove the annotation from an Ingress Controller and stop setting `hard-stop-after` in HAProxy, run the `oc annotate` command with a trailing `-` on the annotation name: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc -n openshift-ingress-operator annotate ingresscontrollers/<ingresscontroller_name> ingress.operator.openshift.io/hard-stop-after- | ||
| ---- | ||
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
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.
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.
🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA.