Skip to content

[RS-2690] Doc OpenShift restriction of Gateway API CRDs #2205

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

Merged
ctauchen merged 3 commits into from
Aug 20, 2025
Merged

[RS-2690] Doc OpenShift restriction of Gateway API CRDs #2205

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7414ecd
[RS-2690] Doc OpenShift restriction of Gateway API CRDs
nelljerram Jul 31, 2025
8d365db
Merge remote-tracking branch 'origin/main' into gapi-openshift
nelljerram Aug 19, 2025
f67b106
Improve presentation
nelljerram Aug 19, 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
6 changes: 6 additions & 0 deletions calico-cloud/networking/gateway-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ The Gateway API is an official Kubernetes API for advanced routing to services i
| TLSRoute | v1alpha2 |
| UDPRoute | v1alpha2 |

:::note

Some versions of OpenShift (currently just 4.19) restrict the Gateway API CRDs that may be installed: only `GatewayClass`, `Gateway`, `GRPCRoute`, `HTTPRoute` and `ReferenceGrant`. In clusters with those OpenShift versions the `BackendLBPolicy`, `BackendTLSPolicy`, `TCPRoute`, `TLSRoute` and `UDPRoute` APIs will not be available.

@ctauchen ctauchen Aug 13, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

How about something like this?

:::note
OpenShift 4.19 introduced restrictions for which the Gateway API CRDs can be installed. This change means that certain APIs are unavailable, a departure from OpenShift 4.18 and earlier, which provided full access to all CRDs.

This table shows which Gateway API CRDs are available for each OpenShift version.

| Gateway API CRD | OpenShift 4.18 and lower | OpenShift 4.19 |
| :--- | :--- | :--- |
| `GatewayClass` | ✅ Available | ✅ Available |
| `Gateway` | ✅ Available | ✅ Available |
| `GRPCRoute` | ✅ Available | ✅ Available |
| `HTTPRoute` | ✅ Available | ✅ Available |
| `ReferenceGrant` | ✅ Available | ✅ Available |
| `BackendLBPolicy` | ✅ Available | ❌ Not available |
| `BackendTLSPolicy` | ✅ Available | ❌ Not available |
| `TCPRoute` | ✅ Available | ❌ Not available |
| `TLSRoute` | ✅ Available | ❌ Not available |
| `UDPRoute` | ✅ Available | ❌ Not available |

@ctauchen ctauchen Aug 13, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If there's an OpenShift docs page that lists these, best would be to point there. I haven't found one yet.

@nelljerram nelljerram Aug 14, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is on this topic - WDYT?

@nelljerram nelljerram Aug 14, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

How about something like this?

For me the table is a bit overkill - I feel it will make the page as a whole heavier and give undeserved prominence to OpenShift's choices. But I see a little merit in listing the resources separately from the narrative. Perhaps a good compromise would be a bulleted form like:

  • Available in OpenShift 4.19: GatewayClass, Gateway, GRPCRoute, HTTPRoute and ReferenceGrant.
  • Not available in OpenShift 4.19: BackendLBPolicy, BackendTLSPolicy, TCPRoute, TLSRoute and UDPRoute.

As regards the other wording changes in the narrative, I don't feel that any of them are big wins - but happy to defer to you if you feel strongly that they are.

@ctauchen ctauchen Aug 19, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fair enough, let's try something like that.

I suggest we link to this OS Gateway API Overview: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/ingress_and_load_balancing/index#nw-ingress-gateway-api-overview_ingress-gateway-api

It lists the resources that are available, and will likely be updated to include expanded functionality in future versions.

@nelljerram

@nelljerram nelljerram Aug 19, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks @ctauchen , I've pushed an updating commit. Please take another look when you have time.


:::

### Envoy Gateway

Several implementations of the Gateway API are available, one of which is the [Envoy Gateway](https://gateway.envoyproxy.io/). $[prodname] integrates the Envoy Gateway implementation in order to provide support for the Gateway API.
Expand Down
6 changes: 6 additions & 0 deletions calico-enterprise/networking/gateway-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ The Gateway API is an official Kubernetes API for advanced routing to services i
| TLSRoute | v1alpha2 |
| UDPRoute | v1alpha2 |

:::note

Some versions of OpenShift (currently just 4.19) restrict the Gateway API CRDs that may be installed: only `GatewayClass`, `Gateway`, `GRPCRoute`, `HTTPRoute` and `ReferenceGrant`. In clusters with those OpenShift versions the `BackendLBPolicy`, `BackendTLSPolicy`, `TCPRoute`, `TLSRoute` and `UDPRoute` APIs will not be available.

:::

### Envoy Gateway

Several implementations of the Gateway API are available, one of which is the [Envoy Gateway](https://gateway.envoyproxy.io/). $[prodname] integrates the Envoy Gateway implementation in order to provide support for the Gateway API.
Expand Down
6 changes: 6 additions & 0 deletions calico/networking/gateway-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ The Gateway API is an official Kubernetes API for advanced routing to services i
| TLSRoute | v1alpha2 |
| UDPRoute | v1alpha2 |

:::note

Some versions of OpenShift (currently just 4.19) restrict the Gateway API CRDs that may be installed: only `GatewayClass`, `Gateway`, `GRPCRoute`, `HTTPRoute` and `ReferenceGrant`. In clusters with those OpenShift versions the `BackendLBPolicy`, `BackendTLSPolicy`, `TCPRoute`, `TLSRoute` and `UDPRoute` APIs will not be available.

:::

### Envoy Gateway

Several implementations of the Gateway API are available, one of which is the [Envoy Gateway](https://gateway.envoyproxy.io/). $[prodname] integrates the Envoy Gateway implementation in order to provide support for the Gateway API.
Expand Down