Skip to content

Commit 70a7534

Browse files
finalising the updates types.go files
1 parent 14bf692 commit 70a7534

File tree

7 files changed

+331
-540
lines changed

7 files changed

+331
-540
lines changed

config/crd/bases/k8s.nginx.org_globalconfigurations.yaml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ spec:
3939
metadata:
4040
type: object
4141
spec:
42-
description: spec field of the GlobalConfiguration resource
42+
description: GlobalConfigurationSpec is the spec of the GlobalConfiguration
43+
resource.
4344
properties:
4445
listeners:
4546
description: Listeners field of the GlobalConfigurationSpec resource
4647
items:
4748
description: Listener defines a listener.
4849
properties:
4950
ipv4:
50-
description: ipv4 and ipv6 addresses that NGINX will listen
51-
on. Defaults to listening on all available IPv4 and IPv6 addresses.
51+
description: Specifies the IPv4 address to listen on.
5252
type: string
5353
ipv6:
5454
description: ipv6 addresses that NGINX will listen on.
@@ -57,10 +57,6 @@ spec:
5757
description: The name of the listener. The name must be unique
5858
across all listeners.
5959
type: string
60-
passSNI:
61-
description: Custom SNI processing for listener. Allows listener
62-
to be used as a passthrough for SNI processing
63-
type: boolean
6460
port:
6561
description: The port on which the listener will accept connections.
6662
type: integer

config/crd/bases/k8s.nginx.org_policies.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@ spec:
4949
metadata:
5050
type: object
5151
spec:
52-
description: spec field of the Policy resource
52+
description: |-
53+
PolicySpec is the spec of the Policy resource.
54+
The spec includes multiple fields, where each field represents a different policy.
55+
Only one policy (field) is allowed.
5356
properties:
5457
accessControl:
5558
description: The access control policy based on the client IP address.
@@ -350,7 +353,7 @@ spec:
350353
description: |-
351354
The key to which the rate limit is applied. Can contain text, variables, or a combination of them.
352355
Variables must be surrounded by ${}. For example: ${binary_remote_addr}. Accepted variables are
353-
$binary_remote_addr,$request_uri,$request_method,$url,$http_, $args,$arg_,$cookie_,$jwt_claim_.
356+
$binary_remote_addr , $request_uri , $request_method , $url , $http_ , $args , $arg_, $cookie_ ,$jwt_claim_ .
354357
type: string
355358
logLevel:
356359
description: Sets the desired logging level for cases when the

config/crd/bases/k8s.nginx.org_transportservers.yaml

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ spec:
5151
metadata:
5252
type: object
5353
spec:
54-
description: spec field of the TransportServer resource
54+
description: TransportServerSpec is the spec of the TransportServer resource.
5555
properties:
5656
action:
5757
description: The action to perform for a request.
@@ -66,8 +66,7 @@ spec:
6666
subdomain as defined in RFC 1123, such as my-app or hello.example.com.
6767
When using a wildcard domain like *.example.com the domain must
6868
be contained in double quotes. The host value needs to be unique
69-
among all Ingress and VirtualServer resources. See also Handling
70-
Host and Listener Collisions.
69+
among all Ingress and VirtualServer resources.
7170
type: string
7271
ingressClassName:
7372
description: Specifies which Ingress Controller must handle the VirtualServer
@@ -96,8 +95,8 @@ spec:
9695
properties:
9796
timeout:
9897
description: The timeout between two successive read or write
99-
operations on client or proxied server connections. See proxy_timeout
100-
directive. The default is 10m.
98+
operations on client or proxied server connections. The default
99+
is 10m.
101100
type: string
102101
type: object
103102
streamSnippets:
@@ -115,34 +114,30 @@ spec:
115114
properties:
116115
connectTimeout:
117116
description: The timeout for establishing a connection with a
118-
proxied server. See the proxy_connect_timeout directive. The
119-
default is 60s.
117+
proxied server. The default is 60s.
120118
type: string
121119
nextUpstream:
122120
description: If a connection to the proxied server cannot be established,
123121
determines whether a client connection will be passed to the
124-
next server. See the proxy_next_upstream directive. The default
125-
is true.
122+
next server. The default is true.
126123
type: boolean
127124
nextUpstreamTimeout:
128125
description: The time allowed to pass a connection to the next
129-
server. See the proxy_next_upstream_timeout directive. The default
130-
us 0.
126+
server. The default us 0.
131127
type: string
132128
nextUpstreamTries:
133129
description: The number of tries for passing a connection to the
134-
next server. See the proxy_next_upstream_tries directive. The
135-
default is 0.
130+
next server. The default is 0.
136131
type: integer
137132
udpRequests:
138133
description: The number of datagrams, after receiving which, the
139-
next datagram from the same client starts a new session. See
140-
the proxy_requests directive. The default is 0.
134+
next datagram from the same client starts a new session. The
135+
default is 0.
141136
type: integer
142137
udpResponses:
143138
description: The number of datagrams expected from the proxied
144-
server in response to a client datagram. See the proxy_responses
145-
directive. By default, the number of datagrams is not limited.
139+
server in response to a client datagram. By default, the number
140+
of datagrams is not limited.
146141
type: integer
147142
type: object
148143
upstreams:
@@ -169,8 +164,7 @@ spec:
169164
type: string
170165
healthCheck:
171166
description: 'The health check configuration for the Upstream.
172-
See the health_check directive. Note: this feature is supported
173-
only in NGINX Plus.'
167+
Note: this feature is supported only in NGINX Plus.'
174168
properties:
175169
enable:
176170
description: Enables a health check for an upstream server.
@@ -226,8 +220,7 @@ spec:
226220
loadBalancingMethod:
227221
description: The method used to load balance the upstream servers.
228222
By default, connections are distributed between the servers
229-
using a weighted round-robin balancing method. See the upstream
230-
section for available methods and their details.
223+
using a weighted round-robin balancing method.
231224
type: string
232225
maxConns:
233226
description: Sets the time during which the specified number

0 commit comments

Comments
 (0)