Skip to content

Docs experimental feature gate warning#771

Open
anvithagowda098 wants to merge 1 commit into
kgateway-dev:mainfrom
anvithagowda098:docs-experimental-feature-gate-warning
Open

Docs experimental feature gate warning#771
anvithagowda098 wants to merge 1 commit into
kgateway-dev:mainfrom
anvithagowda098:docs-experimental-feature-gate-warning

Conversation

@anvithagowda098

Copy link
Copy Markdown
Contributor

Description

Adds warnings to the TCPRoute and TLSRoute setup guides to clarify that experimental Gateway API features require the KGW_ENABLE_EXPERIMENTAL_GATEWAY_API_FEATURES=true environment variable in kgateway 2.2 and later.

This helps prevent configuration issues when following the setup documentation for experimental Gateway API features.

Change Type

/kind documentation

Additional Notes

Updated:

  • content/docs/envoy/main/setup/listeners/tcp.md
  • content/docs/envoy/main/setup/listeners/tls-termination-tcproute.md

…TLSRoute

Signed-off-by: Anvitha <anvitha.gowda098@gmail.com>
@anvithagowda098 anvithagowda098 force-pushed the docs-experimental-feature-gate-warning branch from c45bfed to 7e49fcd Compare May 19, 2026 07:13
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v{{< reuse "docs/versions/k8s-gw-version.md" >}}/experimental-install.yaml
```

{{< callout type="warning" >}}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In kgateway 2.2 and later, the KGW_ENABLE_EXPERIMENTAL_GATEWAY_API_FEATURES variable defaults to true, so experimental features like TCPRoute and TLSRoute are enabled by default and don't require any extra configuration (see the 2.2 release notes). The variable only comes into play when you want to disable them by setting it to false. So the current wording reads a little backwards for the 2.2+ versions it targets. A quick flip to something like "In kgateway 2.2 and later, these experimental features are enabled by default; set KGW_ENABLE_EXPERIMENTAL_GATEWAY_API_FEATURES=false to disable them" would line it up with the actual behavior, though I'm not sure it's necessary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Was there a scenario that came up that prompted this change? Maybe a little more context would help us understand how to fix this.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants