Skip to content

Commit 5cacae4

Browse files
author
Kate Osborn
committed
Update gateway compatibility doc
1 parent 9a55f8f commit 5cacae4

File tree

1 file changed

+39
-42
lines changed

1 file changed

+39
-42
lines changed

‎docs/gateway-api-compatibility.md

Lines changed: 39 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,21 @@ This document describes which Gateway API resources NGINX Kubernetes Gateway sup
44

55
## Summary
66

7-
| Resource | Support Status |
8-
|-------------------------------------|---------------------|
9-
| [GatewayClass](#gatewayclass) | Partially supported |
10-
| [Gateway](#gateway) | Partially supported |
11-
| [HTTPRoute](#httproute) | Partially supported |
12-
| [TLSRoute](#tlsroute) | Not supported |
13-
| [TCPRoute](#tcproute) | Not supported |
14-
| [UDPRoute](#udproute) | Not supported |
15-
| [ReferenceGrant](#referencegrant) | Supported |
16-
| [Custom policies](#custom-policies) | Not supported |
7+
| Resource | Support Level | API Version |
8+
|-------------------------------------|---------------|-------------|
9+
| [GatewayClass](#gatewayclass) | Core | v1beta1 |
10+
| [Gateway](#gateway) | Core | v1beta1 |
11+
| [HTTPRoute](#httproute) | Core | v1beta1 |
12+
| [ReferenceGrant](#referencegrant) | Core | v1beta1 |
13+
| [Custom policies](#custom-policies) | Not supported | N/A |
14+
| [TLSRoute](#tlsroute) | Not supported | N/A |
15+
| [TCPRoute](#tcproute) | Not supported | N/A |
16+
| [UDPRoute](#udproute) | Not supported | N/A |
1717

1818
## Terminology
1919

20-
We use the following words to describe support status:
21-
22-
- *Supported*. The resource or field is fully supported and conformant to the Gateway API specification.
20+
- *Support Level*. See the Gateway API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/#2-support-levels).
21+
- *Supported*. The resource or field is fully supported.
2322
- *Partially supported*. The resource or field is supported partially or with limitations. It will become fully
2423
supported in future releases.
2524
- *Not supported*. The resource or field is not yet supported. It will become partially or fully supported in future
@@ -37,7 +36,7 @@ the [Gateway API documentation](https://gateway-api.sigs.k8s.io/references/spec/
3736

3837
### GatewayClass
3938

40-
> Status: Partially supported.
39+
> Support Level: Core.
4140
4241
NGINX Kubernetes Gateway supports only a single GatewayClass resource configured via `--gatewayclass` flag
4342
of the [static-mode](./cli-help.md#static-mode) command.
@@ -57,7 +56,7 @@ Fields:
5756

5857
### Gateway
5958

60-
> Status: Partially supported.
59+
> Support Level: Core.
6160
6261
NGINX Kubernetes Gateway supports only a single Gateway resource. The Gateway resource must reference NGINX Kubernetes
6362
Gateway's corresponding GatewayClass.
@@ -75,38 +74,37 @@ Fields:
7574
* `tls`
7675
* `mode` - partially supported. Allowed value: `Terminate`.
7776
* `certificateRefs` - The TLS certificate and key must be stored in a Secret resource of
78-
type `kubernetes.io/tls`. Only a single reference is supported. You must deploy the Secret before the
79-
Gateway resource.
77+
type `kubernetes.io/tls`. Only a single reference is supported.
8078
* `options` - not supported.
8179
* `allowedRoutes` - supported.
8280
* `addresses` - not supported.
8381
* `status`
8482
* `addresses` - Pod IPAddress supported.
85-
* `conditions` - Supported (Condition/Status/Reason):
83+
* `conditions` - supported (Condition/Status/Reason):
8684
* `Accepted/True/Accepted`
8785
* `Accepted/True/ListenersNotValid`
8886
* `Accepted/False/ListenersNotValid`
8987
* `Accepted/False/Invalid`
90-
* `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not
88+
* `Accepted/False/UnsupportedValue`- custom reason for when a value of a field in a Gateway is invalid or not
9189
supported.
92-
* `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting Gateway.
90+
* `Accepted/False/GatewayConflict`- custom reason for when the Gateway is ignored due to a conflicting Gateway.
9391
NKG only supports a single Gateway.
9492
* `Programmed/True/Programmed`
9593
* `Programmed/False/Invalid`
96-
* `Programmed/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting
94+
* `Programmed/False/GatewayConflict`- custom reason for when the Gateway is ignored due to a conflicting
9795
Gateway. NKG only supports a single Gateway.
9896
* `listeners`
9997
* `name` - supported.
10098
* `supportedKinds` - supported.
10199
* `attachedRoutes` - supported.
102-
* `conditions` - Supported (Condition/Status/Reason):
100+
* `conditions` - supported (Condition/Status/Reason):
103101
* `Accepted/True/Accepted`
104102
* `Accepted/False/UnsupportedProtocol`
105103
* `Accepted/False/InvalidCertificateRef`
106104
* `Accepted/False/ProtocolConflict`
107-
* `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Listener is invalid or
105+
* `Accepted/False/UnsupportedValue`- custom reason for when a value of a field in a Listener is invalid or
108106
not supported.
109-
* `Accepted/False/GatewayConflict`: Custom reason for when the Gateway is ignored due to a conflicting
107+
* `Accepted/False/GatewayConflict` - custom reason for when the Gateway is ignored due to a conflicting
110108
Gateway. NKG only supports a single Gateway.
111109
* `Programmed/True/Programmed`
112110
* `Programmed/False/Invalid`
@@ -118,7 +116,7 @@ Fields:
118116

119117
### HTTPRoute
120118

121-
> Status: Partially supported.
119+
> Support Level: Core.
122120
123121
Fields:
124122

@@ -149,33 +147,20 @@ Fields:
149147
* `Accepted/False/NoMatchingListenerHostname`
150148
* `Accepted/False/NoMatchingParent`
151149
* `Accepted/False/NotAllowedByListeners`
152-
* `Accepted/False/UnsupportedValue`: Custom reason for when the HTTPRoute includes an invalid or unsupported
150+
* `Accepted/False/UnsupportedValue` - custom reason for when the HTTPRoute includes an invalid or unsupported
153151
value.
154-
* `Accepted/False/InvalidListener`: Custom reason for when the HTTPRoute references an invalid listener.
155-
* `Accepted/False/GatewayNotProgrammed`: Custom reason for when the Gateway is not Programmed. HTTPRoute may
152+
* `Accepted/False/InvalidListener` - custom reason for when the HTTPRoute references an invalid listener.
153+
* `Accepted/False/GatewayNotProgrammed` - custom reason for when the Gateway is not Programmed. HTTPRoute may
156154
be valid and configured, but will maintain this status as long as the Gateway is not Programmed.
157155
* `ResolvedRefs/True/ResolvedRefs`
158156
* `ResolvedRefs/False/InvalidKind`
159157
* `ResolvedRefs/False/RefNotPermitted`
160158
* `ResolvedRefs/False/BackendNotFound`
161-
* `ResolvedRefs/False/UnsupportedValue`: Custom reason for when one of the HTTPRoute rules has a backendRef
159+
* `ResolvedRefs/False/UnsupportedValue` - custom reason for when one of the HTTPRoute rules has a backendRef
162160
with an unsupported value.
163161

164-
### TLSRoute
165-
166-
> Status: Not supported.
167-
168-
### TCPRoute
169-
170-
> Status: Not supported.
171-
172-
### UDPRoute
173-
174-
> Status: Not supported.
175-
176162
### ReferenceGrant
177163

178-
> Status: Supported.
179164
> Support Level: Core
180165
181166
Fields:
@@ -190,6 +175,18 @@ Fields:
190175
* `kind` - supports `Gateway` and `HTTPRoute`.
191176
* `namespace`- supported.
192177

178+
### TLSRoute
179+
180+
> Status: Not supported.
181+
182+
### TCPRoute
183+
184+
> Status: Not supported.
185+
186+
### UDPRoute
187+
188+
> Status: Not supported.
189+
193190
### Custom Policies
194191

195192
> Status: Not supported.

0 commit comments

Comments
 (0)