Skip to content

Commit 174bc4e

Browse files
author
Kate Osborn
committed
Add all support levels to table and resource support summaries
1 parent 5cacae4 commit 174bc4e

File tree

1 file changed

+40
-25
lines changed

1 file changed

+40
-25
lines changed

docs/gateway-api-compatibility.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,32 @@ This document describes which Gateway API resources NGINX Kubernetes Gateway sup
44

55
## Summary
66

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

1818
## Terminology
1919

20-
- *Support Level*. See the Gateway API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/#2-support-levels).
20+
Gateway API features has three [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/#2-support-levels):
21+
Core, Extended and Implementation-specific. We use the following terms to describe the support status for each level and
22+
resource field:
23+
2124
- *Supported*. The resource or field is fully supported.
2225
- *Partially supported*. The resource or field is supported partially or with limitations. It will become fully
2326
supported in future releases.
2427
- *Not supported*. The resource or field is not yet supported. It will become partially or fully supported in future
2528
releases.
2629

27-
Note: it might be possible that NGINX Kubernetes Gateway will never support some resources and/or fields of the Gateway
28-
API. We will document these decisions on a case by case basis.
30+
> Note: it might be possible that NGINX Kubernetes Gateway will never support some resources and/or fields of the Gateway API. We will document these decisions on a case by case basis.
31+
32+
> NGINX Kubernetes Gateway doesn't support any features from the experimental release channel.
2933
3034
## Resources
3135

@@ -36,10 +40,13 @@ the [Gateway API documentation](https://gateway-api.sigs.k8s.io/references/spec/
3640

3741
### GatewayClass
3842

39-
> Support Level: Core.
43+
> Support Levels:
44+
> - Core: Supported.
45+
> - Extended: Not supported.
46+
> - Implementation-specific: Not supported.
4047
41-
NGINX Kubernetes Gateway supports only a single GatewayClass resource configured via `--gatewayclass` flag
42-
of the [static-mode](./cli-help.md#static-mode) command.
48+
NGINX Kubernetes Gateway supports only a single GatewayClass resource configured via `--gatewayclass` flag of
49+
the [static-mode](./cli-help.md#static-mode) command.
4350

4451
Fields:
4552

@@ -56,11 +63,13 @@ Fields:
5663

5764
### Gateway
5865

59-
> Support Level: Core.
66+
> Support Levels:
67+
> - Core: Supported.
68+
> - Extended: Not supported.
69+
> - Implementation-specific: Not supported.
6070
6171
NGINX Kubernetes Gateway supports only a single Gateway resource. The Gateway resource must reference NGINX Kubernetes
62-
Gateway's corresponding GatewayClass.
63-
See [static-mode](./cli-help.md#static-mode) command for more info.
72+
Gateway's corresponding GatewayClass. See [static-mode](./cli-help.md#static-mode) command for more info.
6473

6574
Fields:
6675

@@ -116,7 +125,10 @@ Fields:
116125

117126
### HTTPRoute
118127

119-
> Support Level: Core.
128+
> Support Levels:
129+
> - Core: Supported.
130+
> - Extended: Partially supported.
131+
> - Implementation-specific: Not supported.
120132
121133
Fields:
122134

@@ -147,11 +159,11 @@ Fields:
147159
* `Accepted/False/NoMatchingListenerHostname`
148160
* `Accepted/False/NoMatchingParent`
149161
* `Accepted/False/NotAllowedByListeners`
150-
* `Accepted/False/UnsupportedValue` - custom reason for when the HTTPRoute includes an invalid or unsupported
151-
value.
162+
* `Accepted/False/UnsupportedValue` - custom reason for when the HTTPRoute includes an invalid or
163+
unsupported value.
152164
* `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
154-
be valid and configured, but will maintain this status as long as the Gateway is not Programmed.
165+
* `Accepted/False/GatewayNotProgrammed` - custom reason for when the Gateway is not Programmed. HTTPRoute
166+
may be valid and configured, but will maintain this status as long as the Gateway is not Programmed.
155167
* `ResolvedRefs/True/ResolvedRefs`
156168
* `ResolvedRefs/False/InvalidKind`
157169
* `ResolvedRefs/False/RefNotPermitted`
@@ -161,7 +173,10 @@ Fields:
161173

162174
### ReferenceGrant
163175

164-
> Support Level: Core
176+
> Support Levels:
177+
> - Core: Supported.
178+
> - Extended: N/A.
179+
> - Implementation-specific: N/A
165180
166181
Fields:
167182

0 commit comments

Comments
 (0)