Skip to content

W-18780384 flex environment variables gr #921

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.

Sign up for GitHub

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
wants to merge 3 commits into
base: latest
Choose a base branch
from
Open

W-18780384 flex environment variables gr #921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8535bc8
Add pages
glenn-rodgers-sf Sep 3, 2025
6d894b4
Added variables
glenn-rodgers-sf Sep 3, 2025
d6dc4a3
Edits
glenn-rodgers-sf Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions gateway/1.10/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
*** xref:flex-conn-proxy-protocol.adoc[Configure PROXY Protocol]
*** xref:flex-conn-jenkins-api.adoc[Automate Flex Gateway with a Jenkins Pipeline using the API Manager API]
*** xref:flex-conn-jenkins-cli.adoc[Automate Flex Gateway with a Jenkins Pipeline using Anypoint CLI]
*** xref:flex-conn-env-variables.adoc[Configure Environment Variables]
** xref:flex-local-configure.adoc[]
*** xref:flex-local-rep-run.adoc[Configure Replicas]
*** xref:flex-local-tls-config.adoc[Configure TLS Context]
Expand All @@ -67,6 +68,7 @@
*** xref:flex-local-tracing-config.adoc[Configure Distributed Tracing]
*** xref:flex-local-readiness-liveness.adoc[Configure a Readiness or Liveness Probe]
*** xref:flex-local-proxy-protocol.adoc[Configure PROXY Protocol]
*** xref:flex-local-env-variables.adoc[Configure Environment Variables]
*** xref:flex-local-configuration-reference-guide.adoc[Declarative Configuration Reference]

// Publishing Flex Gateway APIs
Expand Down
46 changes: 46 additions & 0 deletions gateway/1.10/modules/ROOT/pages/_partials/env-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Flex Gateway provides these environment variables to configure your gateway:

[cols="3,2,4"]
|===
|Variable Name |Default Value |Description

|FLEX_CONNECTION_IDLE_TIMEOUT_SECONDS
|60
|Maximum number of seconds a connection can be idle before it times out. For more information, see xref:flex-{page-mode}-timeout.adoc[].

|FLEX_STREAM_IDLE_TIMEOUT_SECONDS
|300
|Maximum number of seconds a stream can remain idle without receiving any data in either the inbound (client to Flex Gateway) or outbound (Flex Gateway to upstream service) direction. For more information, see xref:flex-{page-mode}-timeout.adoc[].

|FLEX_UPSTREAM_CONNECTION_IDLE_TIMEOUT_SECONDS
|60
|Maximum number of seconds a stream between Flex Gateway and the upstream service can remain idle between requests. For more information, see xref:flex-{page-mode}-timeout.adoc[].

|FLEX_UPSTREAM_RESPONSE_TIMEOUT_SECONDS
|15
|Maximum number of seconds a Flex Gateway waits for a response from an upstream service. For more information, see xref:flex-{page-mode}-timeout.adoc[].

|FLEX_ENVOY_HEADERS_ENABLED
|false
|Allows (`true`) or removes (`false`) Envoy headers from requests. For more information, see xref:flex-review-prerequisites.adoc[].

|FLEX_DOWNSTREAM_CONNECTION_BUFFER_LIMIT_BYTES
|1048576 (1 MB)
|Maximum size, in bytes, of read and write buffers for new connections. For more information, see xref:flex-review-prerequisites.adoc[].

|FLEX_REWRITE_HOST_HEADER
|true
|Rewrite HTTP Host header to match upstream.

|FLEX_DATASOURCE_CONTROL_NODE_ENABLED
|false
|Enable configuration caching in Redis shared storage for Connected Mode replicas. For more information, see xref:flex-conn-replica-caching.adoc[].

|FLEX_HEADER_RAW_VALUE_ENABLE
|true
|Controls header encoding for external authorization. Set to `false` to send headers encoded in UTF-8. For more information, see xref:policies-included-external-authorization.adoc[].

|FLEX_SERVICE_ENVOY_DRAIN_TIME
|25
|Drain period in seconds during shutdown before Flex Gateway exits gracefully. For more information, see xref:flex-{page-mode}-monitor.adoc[].
|===
8 changes: 8 additions & 0 deletions gateway/1.10/modules/ROOT/pages/flex-conn-env-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Configure Flex Gateway Environment Variables in Connected Mode
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]
:imagesdir: ../assets/images
:page-mode: conn

include::partial$env-variables.adoc[]
8 changes: 8 additions & 0 deletions gateway/1.10/modules/ROOT/pages/flex-local-env-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Configure Flex Gateway Environment Variables in Local Mode
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]
:imagesdir: ../assets/images
:page-mode: local

include::partial$env-variables.adoc[]
14 changes: 0 additions & 14 deletions gateway/1.10/modules/ROOT/pages/flex-review-prerequisites.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,20 +189,6 @@ To learn more, see xref:api-manager::create-instance-task-flex.adoc#limits[Multi
| APIs per Self-Managed Gateway instance | {gateway-api-max} | Exceeding this limit isn’t supported but doesn't cause errors.
|===

== Flex Gateway Environment Variables


[%header%autowidth.spread,cols="a,>.<a,a"]
|===
| Environment Variable | Default Value | Function
| FLEX_CONNECTION_IDLE_TIMEOUT_SECONDS | 60 | Maximum number of seconds a connection can be idle before it times out.
| FLEX_DOWNSTREAM_CONNECTION_BUFFER_LIMIT_BYTES | 1048576 (1 MB) | Maximum size, in bytes, of read and write buffers for new connections.
| FLEX_ENVOY_HEADERS_ENABLED | `false` | Allows (`true`) or removes (`false`) Envoy headers from requests.
| FLEX_STREAM_IDLE_TIMEOUT_SECONDS | 300 | Maximum number of seconds a stream can remain idle without receiving any data in either the inbound (client to Flex Gateway) or outbound (Flex Gateway to upstream service) direction.
| FLEX_UPSTREAM_CONNECTION_IDLE_TIMEOUT_SECONDS | 60 | Maximum number of seconds a stream between Flex Gateway and the upstream service can remain idle between requests.
| FLEX_UPSTREAM_RESPONSE_TIMEOUT_SECONDS | 15 | Maximum number of seconds a Flex Gateway waits for a response from an upstream service.
|===

=== See also

* xref:flex-conn-timeout.adoc[]
Expand Down