From 186f2bf8c3a5df6f5cf63ed0d24cd1f3f79ffbd1 Mon Sep 17 00:00:00 2001 From: Benjamin Jee Date: Tue, 10 Sep 2024 09:35:59 -0700 Subject: [PATCH] Fix rebase issues --- site/content/reference/api.md | 280 +++++++++++++++++++++++++++++++++- 1 file changed, 278 insertions(+), 2 deletions(-) diff --git a/site/content/reference/api.md b/site/content/reference/api.md index d5b191193b..c96741cd33 100644 --- a/site/content/reference/api.md +++ b/site/content/reference/api.md @@ -25,6 +25,8 @@ Resource Types: NginxProxy
  • ObservabilityPolicy +
  • +UpstreamSettingsPolicy

    • ClientSettingsPolicy @@ -467,6 +469,131 @@ sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyStatus +

    UpstreamSettingsPolicy + +

    +

    +

    UpstreamSettingsPolicy is a Direct Attached Policy. It provides a way to configure the behavior of +the connection between NGINX and the upstream applications.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +gateway.nginx.org/v1alpha1 + +
    +kind
    +string +    		UpstreamSettingsPolicy
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +UpstreamSettingsPolicySpec + + +    		 +

    Spec defines the desired state of the UpstreamSettingsPolicy.

    +
    +
    + + + + + + + + + + + + + +
    +zoneSize
    + + +Size + + +    		 +(Optional) +

    ZoneSize is the size of the shared memory zone used by the upstream. This memory zone is used to share +the upstream configuration between nginx worker processes. The more servers that an upstream has, +the larger memory zone is required. +Default: OSS: 512k, Plus: 1m. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone

    +
    +keepAlive
    + + +UpstreamKeepAlive + + +    		 +(Optional) +

    KeepAlive defines the keep-alive settings.

    +
    +targetRefs
    + + +[]sigs.k8s.io/gateway-api/apis/v1alpha2.LocalPolicyTargetReference + + +    		 +

    TargetRefs identifies API object(s) to apply the policy to. +Objects must be in the same namespace as the policy. +Support: Service

    +
    +
    +status
    + + +sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyStatus + + +    		 +

    Status defines the state of the UpstreamSettingsPolicy.

    +

    Address

    @@ -808,7 +935,8 @@ Support: Gateway, HTTPRoute, GRPCRoute.

    ClientBody, ClientKeepAlive, ClientKeepAliveTimeout, -TelemetryExporter) +TelemetryExporter, +UpstreamKeepAlive)

    Duration is a string value representing a duration in time. @@ -1226,7 +1354,8 @@ IP address in the X-Forwarded-For HTTP header.

    (Appears on: -ClientBody) +ClientBody, +UpstreamSettingsPolicySpec)

    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-“value”-name, unescap +

    UpstreamKeepAlive + +

    +

    +(Appears on: +UpstreamSettingsPolicySpec) +

    +

    +

    UpstreamKeepAlive defines the keep-alive settings for upstreams.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +connections
    + +int32 + +    		 +(Optional) +

    Connections sets the maximum number of idle keep-alive connections to upstream servers that are preserved +in the cache of each nginx worker process. When this number is exceeded, the least recently used +connections are closed. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive

    +
    +requests
    + +int32 + +    		 +(Optional) +

    Requests sets the maximum number of requests that can be served through one keep-alive connection. +After the maximum number of requests are made, the connection is closed. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests

    +
    +time
    + + +Duration + + +    		 +(Optional) +

    Time defines the maximum time during which requests can be processed through one keep-alive connection. +After this time is reached, the connection is closed following the subsequent request processing. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_time

    +
    +timeout
    + + +Duration + + +    		 +(Optional) +

    Timeout defines the keep-alive timeout for upstreams. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout

    +
    +

    UpstreamSettingsPolicySpec + +

    +

    +(Appears on: +UpstreamSettingsPolicy) +

    +

    +

    UpstreamSettingsPolicySpec defines the desired state of the UpstreamSettingsPolicy.

    +

    + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +zoneSize
    + + +Size + + +    		 +(Optional) +

    ZoneSize is the size of the shared memory zone used by the upstream. This memory zone is used to share +the upstream configuration between nginx worker processes. The more servers that an upstream has, +the larger memory zone is required. +Default: OSS: 512k, Plus: 1m. +Directive: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone

    +
    +keepAlive
    + + +UpstreamKeepAlive + + +    		 +(Optional) +

    KeepAlive defines the keep-alive settings.

    +
    +targetRefs
    + + +[]sigs.k8s.io/gateway-api/apis/v1alpha2.LocalPolicyTargetReference + + +    		 +

    TargetRefs identifies API object(s) to apply the policy to. +Objects must be in the same namespace as the policy. +Support: Service

    +

    Generated with gen-crd-api-reference-docs