Skip to content

Commit 5aee2ce

Browse files
ciarams87sarthypartybjee19tatarutyADubhlaoich
authored
NGF: Release 2.2 (#1351)
* 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 Closes nginx/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 <[email protected]> Co-authored-by: bjee19 <[email protected]> Co-authored-by: Tina U. <[email protected]> Co-authored-by: Alan Dooley <[email protected]> Co-authored-by: Shaun <[email protected]>
1 parent b43e7ce commit 5aee2ce

File tree

6 files changed

+269
-8
lines changed

6 files changed

+269
-8
lines changed

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

Lines changed: 23 additions & 5 deletions
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
@@ -101,7 +104,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
101104
- `certificateRefs` - The TLS certificate and key must be stored in a Secret resource of type `kubernetes.io/tls`. Only a single reference is supported.
102105
- `options`: Not supported.
103106
- `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.
108+
- `type`: Partially supported. Allowed value: `IPAddress`.
109+
- `value`: Partially supported. Dynamic address allocation when value is unspecified is not supported.
105110
- `backendTLS`: Not supported.
106111
- `allowedListeners`: Not supported.
107112
- `status`
@@ -114,6 +119,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
114119
- `Accepted/False/UnsupportedValue`: Custom reason for when a value of a field in a Gateway is invalid or not supported.
115120
- `Programmed/True/Programmed`
116121
- `Programmed/False/Invalid`
122+
- `Accepted/True/UnsupportedField`: Custom reason for when the Gateway is accepted but contains an unsupported field
117123
- `listeners`
118124
- `name`: Supported.
119125
- `supportedKinds`: Supported.
@@ -146,7 +152,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
146152
**Fields**:
147153

148154
- `spec`
149-
- `parentRefs`: Partially supported. Port not supported.
155+
- `parentRefs`: Supported.
150156
- `hostnames`: Supported.
151157
- `rules`
152158
- `matches`
@@ -163,6 +169,10 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
163169
- `requestMirror`: Supported. Multiple mirrors can be specified. Percent and fraction-based mirroring are supported.
164170
- `extensionRef`: Supported for SnippetsFilters.
165171
- `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.
166176
- `status`
167177
- `parents`
168178
- `parentRef`: Supported.
@@ -183,6 +193,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
183193
- `ResolvedRefs/False/InvalidIPFamily`: Custom reason for when one of the HTTPRoute rules has a backendRef that has an invalid IPFamily.
184194
- `ResolvedRefs/False/UnsupportedProtocol`
185195
- `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 >}}
186199

187200
### GRPCRoute
188201

@@ -195,7 +208,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
195208
**Fields**:
196209

197210
- `spec`
198-
- `parentRefs`: Partially supported. Port not supported.
211+
- `parentRefs`: Supported.
199212
- `hostnames`: Supported.
200213
- `rules`
201214
- `matches`
@@ -208,6 +221,8 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
208221
- `requestMirror`: Supported. Multiple mirrors can be specified.
209222
- `extensionRef`: Supported for SnippetsFilters.
210223
- `backendRefs`: Partially supported. Backend ref `filters` are not supported.
224+
- `name`: Not supported.
225+
- `sessionPersistence`: Not supported.
211226
- `status`
212227
- `parents`
213228
- `parentRef`: Supported.
@@ -225,6 +240,9 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
225240
- `ResolvedRefs/False/BackendNotFound`
226241
- `ResolvedRefs/False/UnsupportedValue`: Custom reason for when one of the GRPCRoute rules has a backendRef with an unsupported value.
227242
- `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 >}}
228246

229247
### ReferenceGrant
230248

@@ -257,7 +275,7 @@ Fields:
257275
**Fields**:
258276

259277
- `spec`
260-
- `parentRefs`: Partially supported. Port not supported.
278+
- `parentRefs`: Supported.
261279
- `hostnames`: Supported.
262280
- `rules`
263281
- `backendRefs`: Partially supported. Only one backend ref allowed.

‎content/ngf/overview/product-telemetry.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ Telemetry data is collected once every 24 hours and sent to a service managed by
2727
- **Version:** the version of the NGINX Gateway Fabric Deployment.
2828
- **Deployment UID:** the UID of the NGINX Gateway Fabric Deployment.
2929
- **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`).
3031
- **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.
3233
- **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.
3334
- **Control Plane Pod Count** the count of NGINX Gateway Fabric Pods.
3435
- **Data Plane Pod Count** the count of NGINX data plane Pods.

‎content/ngf/reference/api.md‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -899,6 +899,7 @@ longer necessary.</p>
899899
<a href="#gateway.nginx.org/v1alpha1.ClientKeepAlive">ClientKeepAlive</a>,
900900
<a href="#gateway.nginx.org/v1alpha1.ClientKeepAliveTimeout">ClientKeepAliveTimeout</a>,
901901
<a href="#gateway.nginx.org/v1alpha1.UpstreamKeepAlive">UpstreamKeepAlive</a>,
902+
<a href="#gateway.nginx.org/v1alpha2.DNSResolver">DNSResolver</a>,
902903
<a href="#gateway.nginx.org/v1alpha2.TelemetryExporter">TelemetryExporter</a>)
903904
</p>
904905
<p>
@@ -1869,6 +1870,21 @@ int32
18691870
Default is 1024.</p>
18701871
</td>
18711872
</tr>
1873+
<tr>
1874+
<td>
1875+
<code>dnsResolver</code><br/>
1876+
<em>
1877+
<a href="#gateway.nginx.org/v1alpha2.DNSResolver">
1878+
DNSResolver
1879+
</a>
1880+
</em>
1881+
</td>
1882+
<td>
1883+
<em>(Optional)</em>
1884+
<p>DNSResolver specifies the DNS resolver configuration for external name resolution.
1885+
This enables support for routing to ExternalName Services.</p>
1886+
</td>
1887+
</tr>
18721888
</table>
18731889
</td>
18741890
</tr>
@@ -2245,6 +2261,155 @@ ReadinessProbeSpec
22452261
</tr>
22462262
</tbody>
22472263
</table>
2264+
<h3 id="gateway.nginx.org/v1alpha2.DNSResolver">DNSResolver
2265+
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha2.DNSResolver" title="Permanent link">¶</a>
2266+
</h3>
2267+
<p>
2268+
(<em>Appears on: </em>
2269+
<a href="#gateway.nginx.org/v1alpha2.NginxProxySpec">NginxProxySpec</a>)
2270+
</p>
2271+
<p>
2272+
<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: <a href="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+
<table class="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+
<a href="#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+
<a href="#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>
2323+
</td>
2324+
</tr>
2325+
<tr>
2326+
<td>
2327+
<code>addresses</code><br/>
2328+
<em>
2329+
<a href="#gateway.nginx.org/v1alpha2.DNSResolverAddress">
2330+
[]DNSResolverAddress
2331+
</a>
2332+
</em>
2333+
</td>
2334+
<td>
2335+
<p>Addresses specifies the list of DNS server addresses.
2336+
Each address can be an IP address or hostname.
2337+
Example: [{&ldquo;type&rdquo;: &ldquo;IPAddress&rdquo;, &ldquo;value&rdquo;: &ldquo;8.8.8.8&rdquo;}, {&ldquo;type&rdquo;: &ldquo;Hostname&rdquo;, &ldquo;value&rdquo;: &ldquo;dns.google&rdquo;}]</p>
2338+
</td>
2339+
</tr>
2340+
</tbody>
2341+
</table>
2342+
<h3 id="gateway.nginx.org/v1alpha2.DNSResolverAddress">DNSResolverAddress
2343+
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha2.DNSResolverAddress" title="Permanent link">¶</a>
2344+
</h3>
2345+
<p>
2346+
(<em>Appears on: </em>
2347+
<a href="#gateway.nginx.org/v1alpha2.DNSResolver">DNSResolver</a>)
2348+
</p>
2349+
<p>
2350+
<p>DNSResolverAddress specifies the address type and value for a DNS resolver address.</p>
2351+
</p>
2352+
<table class="table table-bordered table-striped">
2353+
<thead>
2354+
<tr>
2355+
<th>Field</th>
2356+
<th>Description</th>
2357+
</tr>
2358+
</thead>
2359+
<tbody>
2360+
<tr>
2361+
<td>
2362+
<code>type</code><br/>
2363+
<em>
2364+
<a href="#gateway.nginx.org/v1alpha2.DNSResolverAddressType">
2365+
DNSResolverAddressType
2366+
</a>
2367+
</em>
2368+
</td>
2369+
<td>
2370+
<p>Type specifies the type of address.</p>
2371+
</td>
2372+
</tr>
2373+
<tr>
2374+
<td>
2375+
<code>value</code><br/>
2376+
<em>
2377+
string
2378+
</em>
2379+
</td>
2380+
<td>
2381+
<p>Value specifies the address value.
2382+
When Type is &ldquo;IPAddress&rdquo;, this must be a valid IPv4 or IPv6 address.
2383+
When Type is &ldquo;Hostname&rdquo;, this must be a valid hostname.</p>
2384+
</td>
2385+
</tr>
2386+
</tbody>
2387+
</table>
2388+
<h3 id="gateway.nginx.org/v1alpha2.DNSResolverAddressType">DNSResolverAddressType
2389+
(<code>string</code> alias)</p><a class="headerlink" href="#gateway.nginx.org%2fv1alpha2.DNSResolverAddressType" title="Permanent link">¶</a>
2390+
</h3>
2391+
<p>
2392+
(<em>Appears on: </em>
2393+
<a href="#gateway.nginx.org/v1alpha2.DNSResolverAddress">DNSResolverAddress</a>)
2394+
</p>
2395+
<p>
2396+
<p>DNSResolverAddressType specifies the type of DNS resolver address.</p>
2397+
</p>
2398+
<table class="table table-bordered table-striped">
2399+
<thead>
2400+
<tr>
2401+
<th>Value</th>
2402+
<th>Description</th>
2403+
</tr>
2404+
</thead>
2405+
<tbody><tr><td><p>&#34;Hostname&#34;</p></td>
2406+
<td><p>DNSResolverHostnameType specifies that the address is a hostname.</p>
2407+
</td>
2408+
</tr><tr><td><p>&#34;IPAddress&#34;</p></td>
2409+
<td><p>DNSResolverIPAddressType specifies that the address is an IP address.</p>
2410+
</td>
2411+
</tr></tbody>
2412+
</table>
22482413
<h3 id="gateway.nginx.org/v1alpha2.DaemonSetSpec">DaemonSetSpec
22492414
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha2.DaemonSetSpec" title="Permanent link">¶</a>
22502415
</h3>
@@ -3041,6 +3206,21 @@ int32
30413206
Default is 1024.</p>
30423207
</td>
30433208
</tr>
3209+
<tr>
3210+
<td>
3211+
<code>dnsResolver</code><br/>
3212+
<em>
3213+
<a href="#gateway.nginx.org/v1alpha2.DNSResolver">
3214+
DNSResolver
3215+
</a>
3216+
</em>
3217+
</td>
3218+
<td>
3219+
<em>(Optional)</em>
3220+
<p>DNSResolver specifies the DNS resolver configuration for external name resolution.
3221+
This enables support for routing to ExternalName Services.</p>
3222+
</td>
3223+
</tr>
30443224
</tbody>
30453225
</table>
30463226
<h3 id="gateway.nginx.org/v1alpha2.NodePort">NodePort

‎content/ngf/reference/cli-help.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ This command runs the NGINX Gateway Fabric control plane.
5050
| _usage-report-skip-verify_ | _bool_ | Disable client verification of the NGINX Plus usage reporting server certificate. |
5151
| _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) |
5252
| _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. |
5354
| _snippets-filters_ | _bool_ | Enable SnippetsFilters feature. SnippetsFilters allow inserting NGINX configuration into the generated NGINX config for HTTPRoute and GRPCRoute resources. |
5455
| _nginx-scc_ | _string_ | The name of the SecurityContextConstraints to be used with the NGINX data plane Pods. Only applicable in OpenShift. |
5556
| _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

Comments
 (0)