You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update compability doc (#1054)
Update compatability doc with Port for ParentRef
* NGF: Update gateway addresses compatibility document (#1109)
Update gateway addresses compatibility document.
* NGF: Update gateway addresses compatibility document with IP family comment (#1126)
Add a small comment on IP families to gateway addresses compatibility document.
* New NGF CLI parameter for Trial period enforcement (#1128)
* RouteRules and Gateway unsupported fields update (#1268)
Added mention about unsupported fields for RouteRules and Gateways
Closesnginx/nginx-gateway-fabric#3784
* NGF: Update advanced routing guide for Regex PathType (#1286)
feat: Update advanced routing guide for regex path
* Add details on BuildOS and InferencePoolCount to Product Telemetry docs (#1284)
* Add details on BuildOS and InferencePoolCount to Product Telemetry docs
* Add InferencePoolCount
* Move InferencePool resource into "Count of Resources" section
* Chore: Update api docs and version for release
---------
Co-authored-by: Sarthak Agrawal <68310924+sarthyparty@users.noreply.github.com>
Co-authored-by: bjee19 <139261241+bjee19@users.noreply.github.com>
Co-authored-by: Tina U. <t.usova@f5.com>
Co-authored-by: Alan Dooley <a.dooley@f5.com>
Co-authored-by: Shaun <s.odonovan@f5.com>
Copy file name to clipboardExpand all lines: content/ngf/overview/gateway-api-compatibility.md
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,10 @@ Gateway API features has three [support levels](https://gateway-api.sigs.k8s.io/
36
36
-_Not supported_. The resource or field is not yet supported. It will become partially or fully supported in future
37
37
releases.
38
38
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 >}}
40
43
41
44
42
45
## Resources
@@ -101,7 +104,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
101
104
-`certificateRefs` - The TLS certificate and key must be stored in a Secret resource of type `kubernetes.io/tls`. Only a single reference is supported.
102
105
-`options`: Not supported.
103
106
-`allowedRoutes`: Supported.
104
-
-`addresses`: Not supported.
107
+
-`addresses`: Valid IPAddresses will be added to the `externalIP` field in the related Services fronting NGINX. Users should ensure that the IP Family of the address matches the IP Family set in the NginxProxy resource (default is dual, meaning both IPv4 and IPv6), otherwise there may be networking issues.
-`value`: Partially supported. Dynamic address allocation when value is unspecified is not supported.
105
110
-`backendTLS`: Not supported.
106
111
-`allowedListeners`: Not supported.
107
112
-`status`
@@ -114,6 +119,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
114
119
-`Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported.
115
120
-`Programmed/True/Programmed`
116
121
-`Programmed/False/Invalid`
122
+
-`Accepted/True/UnsupportedField`: Custom reason for when the Gateway is accepted but contains an unsupported field
117
123
-`listeners`
118
124
-`name`: Supported.
119
125
-`supportedKinds`: Supported.
@@ -146,7 +152,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
146
152
**Fields**:
147
153
148
154
-`spec`
149
-
-`parentRefs`: Partially supported. Port not supported.
155
+
-`parentRefs`: Supported.
150
156
-`hostnames`: Supported.
151
157
-`rules`
152
158
-`matches`
@@ -163,6 +169,10 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
163
169
-`requestMirror`: Supported. Multiple mirrors can be specified. Percent and fraction-based mirroring are supported.
164
170
-`extensionRef`: Supported for SnippetsFilters.
165
171
-`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.
166
176
-`status`
167
177
-`parents`
168
178
-`parentRef`: Supported.
@@ -183,6 +193,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
183
193
-`ResolvedRefs/False/InvalidIPFamily`: Custom reason for when one of the HTTPRoute rules has a backendRef that has an invalid IPFamily.
184
194
-`ResolvedRefs/False/UnsupportedProtocol`
185
195
-`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 >}}
186
199
187
200
### GRPCRoute
188
201
@@ -195,7 +208,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
195
208
**Fields**:
196
209
197
210
-`spec`
198
-
-`parentRefs`: Partially supported. Port not supported.
211
+
-`parentRefs`: Supported.
199
212
-`hostnames`: Supported.
200
213
-`rules`
201
214
-`matches`
@@ -208,6 +221,8 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
208
221
-`requestMirror`: Supported. Multiple mirrors can be specified.
209
222
-`extensionRef`: Supported for SnippetsFilters.
210
223
-`backendRefs`: Partially supported. Backend ref `filters` are not supported.
224
+
-`name`: Not supported.
225
+
-`sessionPersistence`: Not supported.
211
226
-`status`
212
227
-`parents`
213
228
-`parentRef`: Supported.
@@ -225,6 +240,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
225
240
-`ResolvedRefs/False/BackendNotFound`
226
241
-`ResolvedRefs/False/UnsupportedValue`: Custom reason for when one of the GRPCRoute rules has a backendRef with an unsupported value.
227
242
-`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 >}}
228
246
229
247
### ReferenceGrant
230
248
@@ -257,7 +275,7 @@ Fields:
257
275
**Fields**:
258
276
259
277
-`spec`
260
-
-`parentRefs`: Partially supported. Port not supported.
278
+
-`parentRefs`: Supported.
261
279
-`hostnames`: Supported.
262
280
-`rules`
263
281
-`backendRefs`: Partially supported. Only one backend ref allowed.
Copy file name to clipboardExpand all lines: content/ngf/overview/product-telemetry.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,8 +27,9 @@ Telemetry data is collected once every 24 hours and sent to a service managed by
27
27
-**Version:** the version of the NGINX Gateway Fabric Deployment.
28
28
-**Deployment UID:** the UID of the NGINX Gateway Fabric Deployment.
29
29
-**Image Build Source:** whether the image was built by GitHub or locally (values are `gha`, `local`, or `unknown`). The source repository of the images is **not** collected.
30
+
-**Build OS:** the base operating system the image was built on (values are currently `alpine` or `ubi`).
30
31
-**Deployment Flags:** a list of NGINX Gateway Fabric Deployment flags that are specified by a user. The actual values of non-boolean flags are **not** collected; we only record that they are either `true` or `false` for boolean flags and `default` or `user-defined` for the rest.
31
-
-**Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`,`GRPCRoutes`, `TLSRoutes`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NginxProxies`, `ObservabilityPolicies`, `UpstreamSettingsPolicies`, `SnippetsFilters`, and `Endpoints`. The data within these resources is **not** collected.
32
+
-**Count of Resources:** the total count of resources related to NGINX Gateway Fabric. This includes `GatewayClasses`, `Gateways`, `HTTPRoutes`,`GRPCRoutes`, `TLSRoutes`, `InferencePool`, `Secrets`, `Services`, `BackendTLSPolicies`, `ClientSettingsPolicies`, `NginxProxies`, `ObservabilityPolicies`, `UpstreamSettingsPolicies`, `SnippetsFilters`, and `Endpoints`. The data within these resources is **not** collected.
32
33
-**SnippetsFilters Info** a list of directive-context strings from applied SnippetFilters and a total count per strings. The actual value of any NGINX directive is **not** collected.
33
34
-**Control Plane Pod Count** the count of NGINX Gateway Fabric Pods.
34
35
-**Data Plane Pod Count** the count of NGINX data plane Pods.
<p>DNSResolver specifies the DNS resolver configuration for NGINX.
2273
+
This enables dynamic DNS resolution for ExternalName Services.
2274
+
Corresponds to the NGINX resolver directive: <ahref="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver</a></p>
2275
+
</p>
2276
+
<tableclass="table table-bordered table-striped">
2277
+
<thead>
2278
+
<tr>
2279
+
<th>Field</th>
2280
+
<th>Description</th>
2281
+
</tr>
2282
+
</thead>
2283
+
<tbody>
2284
+
<tr>
2285
+
<td>
2286
+
<code>timeout</code><br/>
2287
+
<em>
2288
+
<ahref="#gateway.nginx.org/v1alpha1.Duration">
2289
+
Duration
2290
+
</a>
2291
+
</em>
2292
+
</td>
2293
+
<td>
2294
+
<em>(Optional)</em>
2295
+
<p>Timeout specifies the timeout for name resolution.</p>
2296
+
</td>
2297
+
</tr>
2298
+
<tr>
2299
+
<td>
2300
+
<code>cacheTTL</code><br/>
2301
+
<em>
2302
+
<ahref="#gateway.nginx.org/v1alpha1.Duration">
2303
+
Duration
2304
+
</a>
2305
+
</em>
2306
+
</td>
2307
+
<td>
2308
+
<em>(Optional)</em>
2309
+
<p>CacheTTL specifies how long to cache DNS responses.</p>
2310
+
</td>
2311
+
</tr>
2312
+
<tr>
2313
+
<td>
2314
+
<code>disableIPv6</code><br/>
2315
+
<em>
2316
+
bool
2317
+
</em>
2318
+
</td>
2319
+
<td>
2320
+
<em>(Optional)</em>
2321
+
<p>DisableIPv6 disables IPv6 lookups.
2322
+
If not specified, or set to false, IPv6 lookups will be enabled.</p>
Copy file name to clipboardExpand all lines: content/ngf/reference/cli-help.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,7 @@ This command runs the NGINX Gateway Fabric control plane.
50
50
|_usage-report-skip-verify_|_bool_| Disable client verification of the NGINX Plus usage reporting server certificate. |
51
51
|_usage-report-ca-secret_|_string_| The name of the Secret containing the NGINX Instance Manager CA certificate. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway) |
52
52
|_usage-report-client-ssl-secret_|_string_| The name of the Secret containing the client certificate and key for authenticating with NGINX Instance Manager. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway) |
53
+
|_usage-report-enforce-initial-report_|_bool_| Enables or disables the 180-day grace period for sending the initial usage report. |
53
54
|_snippets-filters_|_bool_| Enable SnippetsFilters feature. SnippetsFilters allow inserting NGINX configuration into the generated NGINX config for HTTPRoute and GRPCRoute resources. |
54
55
|_nginx-scc_|_string_| The name of the SecurityContextConstraints to be used with the NGINX data plane Pods. Only applicable in OpenShift. |
55
56
|_nginx-one-dataplane-key-secret_|_string_| The name of the secret which holds the dataplane key that is required to authenticate with the NGINX One Console. Secret must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway). |
0 commit comments