Skip to content

NGF: Update Gateway Compatibility Document #540

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: ngf-feature-cp-dp-split
Choose a base branch
from
Open

NGF: Update Gateway Compatibility Document #540

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2183e3a
docs: update gateway compatibility doc
salonichf5 May 8, 2025
1485056
Apply suggestions from code review
salonichf5 May 15, 2025
d9a769b
update docs
salonichf5 May 15, 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
17 changes: 7 additions & 10 deletions content/ngf/overview/gateway-api-compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,18 @@ NGINX Gateway Fabric supports a single GatewayClass resource configured with the

{{< /bootstrap-table >}}

NGINX Gateway Fabric supports a single Gateway resource. The Gateway resource must reference NGINX Gateway Fabric's corresponding GatewayClass.
NGINX Gateway Fabric supports multiple Gateway resources. The Gateway resources must reference NGINX Gateway Fabric's corresponding GatewayClass.

See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) command for more information.

**Fields**:

- `spec`
- `gatewayClassName`: Supported.
- `infrastructure`: Partially Supported.
- `infrastructure`: Supported.
- `parametersRef`: NginxProxy resource supported.
- `labels`: Not supported.
- `annotations`: Not supported.
- `labels`: Supported.
- `annotations`: Supported.
- `listeners`
- `name`: Supported.
- `hostname`: Supported.
Expand All @@ -113,21 +113,17 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma
- `options`: Not supported.
- `allowedRoutes`: Supported.
- `addresses`: Not supported.
- `infrastructure`: Not supported.
- `backendTLS`: Not supported.
- `status`
- `addresses`: Partially supported (LoadBalancer and Pod IP).
- `addresses`: Partially supported (LoadBalancer and ClusterIP).
- `conditions`: Supported (Condition/Status/Reason):
- `Accepted/True/Accepted`
- `Accepted/True/ListenersNotValid`
- `Accepted/False/ListenersNotValid`
- `Accepted/False/Invalid`
- `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported.
- `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway.
NGINX Gateway Fabric only supports a single Gateway.
- `Programmed/True/Programmed`
- `Programmed/False/Invalid`
- `Programmed/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. NGINX Gateway Fabric only supports a single Gateway.
- `listeners`
- `name`: Supported.
- `supportedKinds`: Supported.
Expand All @@ -139,7 +135,6 @@ See the [static-mode]({{< ref "/ngf/reference/cli-help.md#static-mode">}}) comma
- `Accepted/False/ProtocolConflict`
- `Accpeted/False/HostnameConflict`
- `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Listener is invalid or not supported.
- `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway. NGINX Gateway Fabric only supports a single Gateway.
- `Programmed/True/Programmed`
- `Programmed/False/Invalid`
- `ResolvedRefs/True/ResolvedRefs`
Expand Down Expand Up @@ -389,3 +384,5 @@ Custom policies are NGINX Gateway Fabric-specific CRDs (Custom Resource Definiti
While these CRDs are not part of the Gateway API, the mechanism to attach them to Gateway API resources is part of the Gateway API. See the [Policy Attachment documentation](https://gateway-api.sigs.k8s.io/references/policy-attachment/).

See the [custom policies]({{< ref "/ngf/overview/custom-policies.md" >}}) document for more information.

---
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this necessary at the end?

Copy link
Contributor

@sjberman sjberman May 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@ADubhlaoich is your thumbs up meaning it should exist or should not exist?

Copy link
Contributor

Choose a reason for hiding this comment

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

My bad, didn't realise how ambiguous that was.

It shouldn't exist, we're gradually excising horizontal lines from markdown.

As a stylistic element, the newer docs theme instead has better whitespace to meaningfully delineate sectiions.

Loading