Skip to content

Commit 86f8051

Browse files
ciarams87ciarams87
committed
Chore: Update api docs and version for release
1 parent d67906e commit 86f8051

File tree

2 files changed

+181
-1
lines changed

2 files changed

+181
-1
lines changed

‎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

‎layouts/shortcodes/version-ngf.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.1.4
1+
2.2.0

0 commit comments

Comments
 (0)