Skip to content

Commit 6822326

Browse files
authored
RouteRules and Gateway unsupported fields update (#1268)
Added mention about unsupported fields for RouteRules and Gateways Closes nginx/nginx-gateway-fabric#3784
1 parent bf2aedf commit 6822326

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

content/ngf/overview/gateway-api-compatibility.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ Gateway API features has three [support levels](https://gateway-api.sigs.k8s.io/
3636
- _Not supported_. The resource or field is not yet supported. It will become partially or fully supported in future
3737
releases.
3838

39-
{{< call-out "note" >}} It's possible that NGINX Gateway Fabric will never support some resources or fields of the Gateway API. They will be documented on a case by case basis. {{< /call-out >}}
39+
{{< call-out "note" >}} It's possible that NGINX Gateway Fabric will never support some resources or fields of the Gateway API. They will be documented on a case by case basis.
40+
41+
Please note that while we make every effort to reflect the support status of experimental fields in our code and documentation, there may be instances where this is not explicitly
42+
indicated. Support for such fields is provided on a best-effort basis.{{< /call-out >}}
4043

4144

4245
## Resources
@@ -116,6 +119,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
116119
- `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported.
117120
- `Programmed/True/Programmed`
118121
- `Programmed/False/Invalid`
122+
- `Accepted/True/UnsupportedField`: Custom reason for when the Gateway is accepted but contains an unsupported field
119123
- `listeners`
120124
- `name`: Supported.
121125
- `supportedKinds`: Supported.
@@ -165,6 +169,10 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
165169
- `requestMirror`: Supported. Multiple mirrors can be specified. Percent and fraction-based mirroring are supported.
166170
- `extensionRef`: Supported for SnippetsFilters.
167171
- `backendRefs`: Partially supported. Backend ref `filters` are not supported.
172+
- `name`: Not supported.
173+
- `timeouts`: Not supported.
174+
- `retry`: Not supported.
175+
- `sessionPersistence`: Not supported.
168176
- `status`
169177
- `parents`
170178
- `parentRef`: Supported.
@@ -185,6 +193,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
185193
- `ResolvedRefs/False/InvalidIPFamily`: Custom reason for when one of the HTTPRoute rules has a backendRef that has an invalid IPFamily.
186194
- `ResolvedRefs/False/UnsupportedProtocol`
187195
- `PartiallyInvalid/True/UnsupportedValue`
196+
- `Accepted/True/UnsupportedField`: Custom reason for when the HTTPRouteRule is accepted but contains an unsupported field
197+
198+
{{< call-out "note" >}} If `name`, `timeouts`, `retry` or `sessionPersistence` are defined for a HTTPRoute rule, they will be ignored and rule still will be created. {{< /call-out >}}
188199

189200
### GRPCRoute
190201

@@ -210,6 +221,8 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
210221
- `requestMirror`: Supported. Multiple mirrors can be specified.
211222
- `extensionRef`: Supported for SnippetsFilters.
212223
- `backendRefs`: Partially supported. Backend ref `filters` are not supported.
224+
- `name`: Not supported.
225+
- `sessionPersistence`: Not supported.
213226
- `status`
214227
- `parents`
215228
- `parentRef`: Supported.
@@ -227,6 +240,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
227240
- `ResolvedRefs/False/BackendNotFound`
228241
- `ResolvedRefs/False/UnsupportedValue`: Custom reason for when one of the GRPCRoute rules has a backendRef with an unsupported value.
229242
- `PartiallyInvalid/True/UnsupportedValue`
243+
- `Accepted/True/UnsupportedField`: Custom reason for when the GRPCRouteRule is accepted but contains an unsupported field
244+
245+
{{< call-out "note" >}} If `name` or `sessionPersistence` are defined for a GRPCRoute rule, they will be ignored and rule still will be created. {{< /call-out >}}
230246

231247
### ReferenceGrant
232248

0 commit comments

Comments
 (0)