Skip to content

Update NGF compatibility doc #214

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
merged 2 commits into from
Feb 21, 2025
Merged

Update NGF compatibility doc #214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7fecac
docs: Update NGF compatibility doc
sjberman Feb 20, 2025
e6f2511
Merge branch 'main' into ngf-compat
ADubhlaoich Feb 21, 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
56 changes: 30 additions & 26 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 @@ -13,18 +13,18 @@ Learn which Gateway API resources NGINX Gateway Fabric supports and to which lev

{{< bootstrap-table "table table-striped table-bordered" >}}

| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
|---------------------------------------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
| [GatewayClass](#gatewayclass) | Supported | Not supported | Supported | v1 | Standard |
| [Gateway](#gateway) | Supported | Partially supported | Not supported | v1 | Standard |
| [HTTPRoute](#httproute) | Supported | Partially supported | Not supported | v1 | Standard |
| [GRPCRoute](#grpcroute) | Supported | Partially supported | Not supported | v1 | Standard |
| [ReferenceGrant](#referencegrant) | Supported | N/A | Not supported | v1beta1 | Standard |
| [TLSRoute](#tlsroute) | Supported | Not supported | Not supported | v1alpha2 | Experimental |
| [TCPRoute](#tcproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
| [BackendTLSPolicy](#backendtlspolicy) | Supported | Supported | Not supported | v1alpha3 | Experimental |
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A | N/A |
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
|---------------------------------------|---------------------|------------------------|---------------------------------------|-------------|---------------------|
| [GatewayClass](#gatewayclass) | Supported | Not supported | Supported | v1 | Standard |
| [Gateway](#gateway) | Supported | Partially supported | Not supported | v1 | Standard |
| [HTTPRoute](#httproute) | Supported | Partially supported | Not supported | v1 | Standard |
| [GRPCRoute](#grpcroute) | Supported | Partially supported | Not supported | v1 | Standard |
| [ReferenceGrant](#referencegrant) | Supported | N/A | Not supported | v1beta1 | Standard |
| [TLSRoute](#tlsroute) | Supported | Not supported | Not supported | v1alpha2 | Experimental |
| [TCPRoute](#tcproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
| [BackendTLSPolicy](#backendtlspolicy) | Partially Supported | Supported | Partially supported | v1alpha3 | Experimental |
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A | N/A |

{{< /bootstrap-table >}}

Expand Down Expand Up @@ -109,6 +109,8 @@ 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).
- `conditions`: Supported (Condition/Status/Reason):
Expand Down Expand Up @@ -335,30 +337,32 @@ Fields:

{{< bootstrap-table "table table-striped table-bordered" >}}

| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
|------------------|--------------------|------------------------|---------------------------------------|-------------|---------------------|
| BackendTLSPolicy | Supported | Supported | Not supported | v1alpha3 | Experimental |
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
|------------------|---------------------|------------------------|---------------------------------------|-------------|---------------------|
| BackendTLSPolicy | Partially Supported | Supported | Partially Supported | v1alpha3 | Experimental |

{{< /bootstrap-table >}}

Fields:

- `spec`
- `targetRefs`
- `group` - supported.
- `kind` - supports `Service`.
- `name` - supported.
- `group`: Supported.
- `kind`: Supports `Service`.
- `name`: Supported.
- `validation`
- `caCertificateRefs` - supports single reference to a `ConfigMap`, with the CA certificate in a key named `ca.crt`.
- `name`- supported.
- `group` - supported.
- `kind` - supports `ConfigMap`.
- `hostname` - supported.
- `wellKnownCertificates` - supports `System`. This will set the CA certificate to the Alpine system root CA path `/etc/ssl/cert.pem`. NB: This option will only work if the NGINX image used is Alpine based. The NGF NGINX images are Alpine based by default.
- `caCertificateRefs`: Supports single reference to a `ConfigMap`, with the CA certificate in a key named `ca.crt`.
- `name`: Supported.
- `group`: Supported.
- `kind`: Supports `ConfigMap`.
- `hostname`: Supported.
- `wellKnownCertificates`: Supports `System`. This will set the CA certificate to the Alpine system root CA path `/etc/ssl/cert.pem`. NB: This option will only work if the NGINX image used is Alpine based. The NGF NGINX images are Alpine based by default.
- `subjectAltNames`: Not supported.
- `options`: Not supported.
- `status`
- `ancestors`
- `ancestorRef` - supported.
- `controllerName`: supported.
- `ancestorRef`: Supported.
- `controllerName`: Supported.
- `conditions`: Partially supported. Supported (Condition/Status/Reason):
- `Accepted/True/PolicyReasonAccepted`
- `Accepted/False/PolicyReasonInvalid`
Expand Down
Loading