Skip to content

Commit 186f2bf

Browse files
bjee19bjee19
committed
Fix rebase issues
1 parent 9c53d99 commit 186f2bf

File tree

1 file changed

+278
-2
lines changed

1 file changed

+278
-2
lines changed

‎site/content/reference/api.md

Lines changed: 278 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Resource Types:
2525
<a href="#gateway.nginx.org/v1alpha1.NginxProxy">NginxProxy</a>
2626
</li><li>
2727
<a href="#gateway.nginx.org/v1alpha1.ObservabilityPolicy">ObservabilityPolicy</a>
28+
</li><li>
29+
<a href="#gateway.nginx.org/v1alpha1.UpstreamSettingsPolicy">UpstreamSettingsPolicy</a>
2830
</li></ul>
2931
<h3 id="gateway.nginx.org/v1alpha1.ClientSettingsPolicy">ClientSettingsPolicy
3032
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha1.ClientSettingsPolicy" title="Permanent link">¶</a>
@@ -467,6 +469,131 @@ sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyStatus
467469
</tr>
468470
</tbody>
469471
</table>
472+
<h3 id="gateway.nginx.org/v1alpha1.UpstreamSettingsPolicy">UpstreamSettingsPolicy
473+
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha1.UpstreamSettingsPolicy" title="Permanent link">¶</a>
474+
</h3>
475+
<p>
476+
<p>UpstreamSettingsPolicy is a Direct Attached Policy. It provides a way to configure the behavior of
477+
the connection between NGINX and the upstream applications.</p>
478+
</p>
479+
<table class="table table-bordered table-striped">
480+
<thead>
481+
<tr>
482+
<th>Field</th>
483+
<th>Description</th>
484+
</tr>
485+
</thead>
486+
<tbody>
487+
<tr>
488+
<td>
489+
<code>apiVersion</code><br/>
490+
string</td>
491+
<td>
492+
<code>
493+
gateway.nginx.org/v1alpha1
494+
</code>
495+
</td>
496+
</tr>
497+
<tr>
498+
<td>
499+
<code>kind</code><br/>
500+
string
501+
</td>
502+
<td><code>UpstreamSettingsPolicy</code></td>
503+
</tr>
504+
<tr>
505+
<td>
506+
<code>metadata</code><br/>
507+
<em>
508+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta">
509+
Kubernetes meta/v1.ObjectMeta
510+
</a>
511+
</em>
512+
</td>
513+
<td>
514+
Refer to the Kubernetes API documentation for the fields of the
515+
<code>metadata</code> field.
516+
</td>
517+
</tr>
518+
<tr>
519+
<td>
520+
<code>spec</code><br/>
521+
<em>
522+
<a href="#gateway.nginx.org/v1alpha1.UpstreamSettingsPolicySpec">
523+
UpstreamSettingsPolicySpec
524+
</a>
525+
</em>
526+
</td>
527+
<td>
528+
<p>Spec defines the desired state of the UpstreamSettingsPolicy.</p>
529+
<br/>
530+
<br/>
531+
<table class="table table-bordered table-striped">
532+
<tr>
533+
<td>
534+
<code>zoneSize</code><br/>
535+
<em>
536+
<a href="#gateway.nginx.org/v1alpha1.Size">
537+
Size
538+
</a>
539+
</em>
540+
</td>
541+
<td>
542+
<em>(Optional)</em>
543+
<p>ZoneSize is the size of the shared memory zone used by the upstream. This memory zone is used to share
544+
the upstream configuration between nginx worker processes. The more servers that an upstream has,
545+
the larger memory zone is required.
546+
Default: OSS: 512k, Plus: 1m.
547+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone</a></p>
548+
</td>
549+
</tr>
550+
<tr>
551+
<td>
552+
<code>keepAlive</code><br/>
553+
<em>
554+
<a href="#gateway.nginx.org/v1alpha1.UpstreamKeepAlive">
555+
UpstreamKeepAlive
556+
</a>
557+
</em>
558+
</td>
559+
<td>
560+
<em>(Optional)</em>
561+
<p>KeepAlive defines the keep-alive settings.</p>
562+
</td>
563+
</tr>
564+
<tr>
565+
<td>
566+
<code>targetRefs</code><br/>
567+
<em>
568+
<a href="https://pkg.go.dev/sigs.k8s.io/gateway-api/apis/v1alpha2#LocalPolicyTargetReference">
569+
[]sigs.k8s.io/gateway-api/apis/v1alpha2.LocalPolicyTargetReference
570+
</a>
571+
</em>
572+
</td>
573+
<td>
574+
<p>TargetRefs identifies API object(s) to apply the policy to.
575+
Objects must be in the same namespace as the policy.
576+
Support: Service</p>
577+
</td>
578+
</tr>
579+
</table>
580+
</td>
581+
</tr>
582+
<tr>
583+
<td>
584+
<code>status</code><br/>
585+
<em>
586+
<a href="https://pkg.go.dev/sigs.k8s.io/gateway-api/apis/v1alpha2#PolicyStatus">
587+
sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyStatus
588+
</a>
589+
</em>
590+
</td>
591+
<td>
592+
<p>Status defines the state of the UpstreamSettingsPolicy.</p>
593+
</td>
594+
</tr>
595+
</tbody>
596+
</table>
470597
<h3 id="gateway.nginx.org/v1alpha1.Address">Address
471598
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha1.Address" title="Permanent link">¶</a>
472599
</h3>
@@ -808,7 +935,8 @@ Support: Gateway, HTTPRoute, GRPCRoute.</p>
808935
<a href="#gateway.nginx.org/v1alpha1.ClientBody">ClientBody</a>,
809936
<a href="#gateway.nginx.org/v1alpha1.ClientKeepAlive">ClientKeepAlive</a>,
810937
<a href="#gateway.nginx.org/v1alpha1.ClientKeepAliveTimeout">ClientKeepAliveTimeout</a>,
811-
<a href="#gateway.nginx.org/v1alpha1.TelemetryExporter">TelemetryExporter</a>)
938+
<a href="#gateway.nginx.org/v1alpha1.TelemetryExporter">TelemetryExporter</a>,
939+
<a href="#gateway.nginx.org/v1alpha1.UpstreamKeepAlive">UpstreamKeepAlive</a>)
812940
</p>
813941
<p>
814942
<p>Duration is a string value representing a duration in time.
@@ -1226,7 +1354,8 @@ IP address in the X-Forwarded-For HTTP header.
12261354
</h3>
12271355
<p>
12281356
(<em>Appears on: </em>
1229-
<a href="#gateway.nginx.org/v1alpha1.ClientBody">ClientBody</a>)
1357+
<a href="#gateway.nginx.org/v1alpha1.ClientBody">ClientBody</a>,
1358+
<a href="#gateway.nginx.org/v1alpha1.UpstreamSettingsPolicySpec">UpstreamSettingsPolicySpec</a>)
12301359
</p>
12311360
<p>
12321361
<p>Size is a string value representing a size. Size can be specified in bytes, kilobytes (k), megabytes (m),
@@ -1561,6 +1690,153 @@ Examples of invalid names: some-$value, quoted-&ldquo;value&rdquo;-name, unescap
15611690
</tr>
15621691
</tbody>
15631692
</table>
1693+
<h3 id="gateway.nginx.org/v1alpha1.UpstreamKeepAlive">UpstreamKeepAlive
1694+
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha1.UpstreamKeepAlive" title="Permanent link">¶</a>
1695+
</h3>
1696+
<p>
1697+
(<em>Appears on: </em>
1698+
<a href="#gateway.nginx.org/v1alpha1.UpstreamSettingsPolicySpec">UpstreamSettingsPolicySpec</a>)
1699+
</p>
1700+
<p>
1701+
<p>UpstreamKeepAlive defines the keep-alive settings for upstreams.</p>
1702+
</p>
1703+
<table class="table table-bordered table-striped">
1704+
<thead>
1705+
<tr>
1706+
<th>Field</th>
1707+
<th>Description</th>
1708+
</tr>
1709+
</thead>
1710+
<tbody>
1711+
<tr>
1712+
<td>
1713+
<code>connections</code><br/>
1714+
<em>
1715+
int32
1716+
</em>
1717+
</td>
1718+
<td>
1719+
<em>(Optional)</em>
1720+
<p>Connections sets the maximum number of idle keep-alive connections to upstream servers that are preserved
1721+
in the cache of each nginx worker process. When this number is exceeded, the least recently used
1722+
connections are closed.
1723+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive</a></p>
1724+
</td>
1725+
</tr>
1726+
<tr>
1727+
<td>
1728+
<code>requests</code><br/>
1729+
<em>
1730+
int32
1731+
</em>
1732+
</td>
1733+
<td>
1734+
<em>(Optional)</em>
1735+
<p>Requests sets the maximum number of requests that can be served through one keep-alive connection.
1736+
After the maximum number of requests are made, the connection is closed.
1737+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests</a></p>
1738+
</td>
1739+
</tr>
1740+
<tr>
1741+
<td>
1742+
<code>time</code><br/>
1743+
<em>
1744+
<a href="#gateway.nginx.org/v1alpha1.Duration">
1745+
Duration
1746+
</a>
1747+
</em>
1748+
</td>
1749+
<td>
1750+
<em>(Optional)</em>
1751+
<p>Time defines the maximum time during which requests can be processed through one keep-alive connection.
1752+
After this time is reached, the connection is closed following the subsequent request processing.
1753+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_time">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_time</a></p>
1754+
</td>
1755+
</tr>
1756+
<tr>
1757+
<td>
1758+
<code>timeout</code><br/>
1759+
<em>
1760+
<a href="#gateway.nginx.org/v1alpha1.Duration">
1761+
Duration
1762+
</a>
1763+
</em>
1764+
</td>
1765+
<td>
1766+
<em>(Optional)</em>
1767+
<p>Timeout defines the keep-alive timeout for upstreams.
1768+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout</a></p>
1769+
</td>
1770+
</tr>
1771+
</tbody>
1772+
</table>
1773+
<h3 id="gateway.nginx.org/v1alpha1.UpstreamSettingsPolicySpec">UpstreamSettingsPolicySpec
1774+
<a class="headerlink" href="#gateway.nginx.org%2fv1alpha1.UpstreamSettingsPolicySpec" title="Permanent link">¶</a>
1775+
</h3>
1776+
<p>
1777+
(<em>Appears on: </em>
1778+
<a href="#gateway.nginx.org/v1alpha1.UpstreamSettingsPolicy">UpstreamSettingsPolicy</a>)
1779+
</p>
1780+
<p>
1781+
<p>UpstreamSettingsPolicySpec defines the desired state of the UpstreamSettingsPolicy.</p>
1782+
</p>
1783+
<table class="table table-bordered table-striped">
1784+
<thead>
1785+
<tr>
1786+
<th>Field</th>
1787+
<th>Description</th>
1788+
</tr>
1789+
</thead>
1790+
<tbody>
1791+
<tr>
1792+
<td>
1793+
<code>zoneSize</code><br/>
1794+
<em>
1795+
<a href="#gateway.nginx.org/v1alpha1.Size">
1796+
Size
1797+
</a>
1798+
</em>
1799+
</td>
1800+
<td>
1801+
<em>(Optional)</em>
1802+
<p>ZoneSize is the size of the shared memory zone used by the upstream. This memory zone is used to share
1803+
the upstream configuration between nginx worker processes. The more servers that an upstream has,
1804+
the larger memory zone is required.
1805+
Default: OSS: 512k, Plus: 1m.
1806+
Directive: <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone</a></p>
1807+
</td>
1808+
</tr>
1809+
<tr>
1810+
<td>
1811+
<code>keepAlive</code><br/>
1812+
<em>
1813+
<a href="#gateway.nginx.org/v1alpha1.UpstreamKeepAlive">
1814+
UpstreamKeepAlive
1815+
</a>
1816+
</em>
1817+
</td>
1818+
<td>
1819+
<em>(Optional)</em>
1820+
<p>KeepAlive defines the keep-alive settings.</p>
1821+
</td>
1822+
</tr>
1823+
<tr>
1824+
<td>
1825+
<code>targetRefs</code><br/>
1826+
<em>
1827+
<a href="https://pkg.go.dev/sigs.k8s.io/gateway-api/apis/v1alpha2#LocalPolicyTargetReference">
1828+
[]sigs.k8s.io/gateway-api/apis/v1alpha2.LocalPolicyTargetReference
1829+
</a>
1830+
</em>
1831+
</td>
1832+
<td>
1833+
<p>TargetRefs identifies API object(s) to apply the policy to.
1834+
Objects must be in the same namespace as the policy.
1835+
Support: Service</p>
1836+
</td>
1837+
</tr>
1838+
</tbody>
1839+
</table>
15641840
<hr/>
15651841
<p><em>
15661842
Generated with <code>gen-crd-api-reference-docs</code>

0 commit comments

Comments
 (0)