Skip to content

Docs experimental feature gate warning #771

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
anvithagowda098 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs experimental feature gate warning #771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions content/docs/envoy/main/setup/listeners/tcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ The following guide deploys a sample TCP echo app, sets up a TCP listener on the
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" >}}

@kristin-kronstain-brown kristin-kronstain-brown Jun 5, 2026

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.

@kristin-kronstain-brown kristin-kronstain-brown Jun 5, 2026

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.

In kgateway 2.2 and later, experimental Gateway API features such as
`TCPRoute` require the
`KGW_ENABLE_EXPERIMENTAL_GATEWAY_API_FEATURES=true`
environment variable to be enabled.
{{< /callout >}}

3. {{< reuse "docs/snippets/prereq-listenerset.md" >}}

4. Deploy the sample TCP echo app.
Expand Down
6 changes: 6 additions & 0 deletions content/docs/envoy/main/setup/listeners/tls-termination-tcproute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Install the experimental channel of the {{< reuse "docs/snippets/k8s-gateway-api
```shell
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" >}}
In kgateway 2.2 and later, experimental Gateway API features such as
`TLSRoute` require the
`KGW_ENABLE_EXPERIMENTAL_GATEWAY_API_FEATURES=true`
environment variable to be enabled.
{{< /callout >}}

## Create a TLS certificate

Expand Down