Skip to content

Commit 4f85c32

Browse files
mohamadaldawamnahmohamadaldawamnah
authored
Merge pull request #8038 from nginx/chore/update_crd_description
update crd descriptions
2 parents d2dea55 + bc763d3 commit 4f85c32

19 files changed

+6188
-1135
lines changed

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,33 @@ spec:
3939
metadata:
4040
type: object
4141
spec:
42-
description: GlobalConfigurationSpec is the spec of the GlobalConfiguration
43-
resource.
42+
description: GlobalConfigurationSpec resource defines the global configuration
43+
parameters of the Ingress Controller.
4444
properties:
4545
listeners:
46+
description: Listeners field of the GlobalConfigurationSpec resource
4647
items:
4748
description: Listener defines a listener.
4849
properties:
4950
ipv4:
51+
description: Specifies the IPv4 address to listen on.
5052
type: string
5153
ipv6:
54+
description: ipv6 addresse that NGINX will listen on.
5255
type: string
5356
name:
57+
description: The name of the listener. The name must be unique
58+
across all listeners.
5459
type: string
5560
port:
61+
description: The port on which the listener will accept connections.
5662
type: integer
5763
protocol:
64+
description: The protocol of the listener. For example, HTTP.
5865
type: string
5966
ssl:
67+
description: Whether the listener will be listening for SSL
68+
connections
6069
type: boolean
6170
type: object
6271
type: array

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

Lines changed: 188 additions & 15 deletions
Large diffs are not rendered by default.

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

Lines changed: 115 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,36 +54,57 @@ spec:
5454
description: TransportServerSpec is the spec of the TransportServer resource.
5555
properties:
5656
action:
57-
description: TransportServerAction defines an action.
57+
description: The action to perform for a request.
5858
properties:
5959
pass:
60+
description: Passes connections/datagrams to an upstream. The
61+
upstream with that name must be defined in the resource.
6062
type: string
6163
type: object
6264
host:
65+
description: The host (domain name) of the server. Must be a valid
66+
subdomain as defined in RFC 1123, such as my-app or hello.example.com.
67+
When using a wildcard domain like *.example.com the domain must
68+
be contained in double quotes. The host value needs to be unique
69+
among all Ingress and VirtualServer resources.
6370
type: string
6471
ingressClassName:
72+
description: Specifies which Ingress Controller must handle the VirtualServer
73+
resource.
6574
type: string
6675
listener:
67-
description: TransportServerListener defines a listener for a TransportServer.
76+
description: Sets a custom HTTP and/or HTTPS listener. Valid fields
77+
are listener.http and listener.https. Each field must reference
78+
the name of a valid listener defined in a GlobalConfiguration resource
6879
properties:
6980
name:
81+
description: The name of a listener defined in a GlobalConfiguration
82+
resource.
7083
type: string
7184
protocol:
85+
description: The protocol of the listener.
7286
type: string
7387
type: object
7488
serverSnippets:
89+
description: Sets a custom snippet in server context. Overrides the
90+
server-snippets ConfigMap key.
7591
type: string
7692
sessionParameters:
77-
description: SessionParameters defines session parameters.
93+
description: The parameters of the session to be used for the Server
94+
context
7895
properties:
7996
timeout:
97+
description: The timeout between two successive read or write
98+
operations on client or proxied server connections. The default
99+
is 10m.
80100
type: string
81101
type: object
82102
streamSnippets:
103+
description: Sets a custom snippet in the stream context. Overrides
104+
the stream-snippets ConfigMap key.
83105
type: string
84106
tls:
85-
description: TransportServerTLS defines TransportServerTLS configuration
86-
for a TransportServer.
107+
description: The TLS termination configuration.
87108
properties:
88109
secret:
89110
type: string
@@ -92,80 +113,163 @@ spec:
92113
description: UpstreamParameters defines parameters for an upstream.
93114
properties:
94115
connectTimeout:
116+
description: The timeout for establishing a connection with a
117+
proxied server. The default is 60s.
95118
type: string
96119
nextUpstream:
120+
description: If a connection to the proxied server cannot be established,
121+
determines whether a client connection will be passed to the
122+
next server. The default is true.
97123
type: boolean
98124
nextUpstreamTimeout:
125+
description: The time allowed to pass a connection to the next
126+
server. The default is 0.
99127
type: string
100128
nextUpstreamTries:
129+
description: The number of tries for passing a connection to the
130+
next server. The default is 0.
101131
type: integer
102132
udpRequests:
133+
description: The number of datagrams, after receiving which, the
134+
next datagram from the same client starts a new session. The
135+
default is 0.
103136
type: integer
104137
udpResponses:
138+
description: The number of datagrams expected from the proxied
139+
server in response to a client datagram. By default, the number
140+
of datagrams is not limited.
105141
type: integer
106142
type: object
107143
upstreams:
144+
description: A list of upstreams.
108145
items:
109146
description: TransportServerUpstream defines an upstream.
110147
properties:
111148
backup:
149+
description: 'The name of the backup service of type ExternalName.
150+
This will be used when the primary servers are unavailable.
151+
Note: The parameter cannot be used along with the random,
152+
hash or ip_hash load balancing methods.'
112153
type: string
113154
backupPort:
155+
description: The port of the backup service. The backup port
156+
is required if the backup service name is provided. The port
157+
must fall into the range 1..65535.
114158
type: integer
115159
failTimeout:
160+
description: Sets the number of unsuccessful attempts to communicate
161+
with the server that should happen in the duration set by
162+
the failTimeout parameter to consider the server unavailable.
163+
The default is 1.
116164
type: string
117165
healthCheck:
118-
description: TransportServerHealthCheck defines the parameters
119-
for active Upstream HealthChecks.
166+
description: 'The health check configuration for the Upstream.
167+
Note: this feature is supported only in NGINX Plus.'
120168
properties:
121169
enable:
170+
description: Enables a health check for an upstream server.
171+
The default is false.
122172
type: boolean
123173
fails:
174+
description: The number of consecutive failed health checks
175+
of a particular upstream server after which this server
176+
will be considered unhealthy. The default is 1.
124177
type: integer
125178
interval:
179+
description: The interval between two consecutive health
180+
checks. The default is 5s.
126181
type: string
127182
jitter:
183+
description: The time within which each health check will
184+
be randomly delayed. By default, there is no delay.
128185
type: string
129186
match:
130-
description: TransportServerMatch defines the parameters
131-
of a custom health check.
187+
description: Controls the data to send and the response
188+
to expect for the healthcheck.
132189
properties:
133190
expect:
191+
description: A literal string or a regular expression
192+
that the data obtained from the server should match.
193+
The regular expression is specified with the preceding
194+
~* modifier (for case-insensitive matching), or the
195+
~ modifier (for case-sensitive matching). NGINX Ingress
196+
Controller validates a regular expression using the
197+
RE2 syntax.
134198
type: string
135199
send:
200+
description: A string to send to an upstream server.
136201
type: string
137202
type: object
138203
passes:
204+
description: The number of consecutive passed health checks
205+
of a particular upstream server after which the server
206+
will be considered healthy. The default is 1.
139207
type: integer
140208
port:
209+
description: 'The port used for health check requests. By
210+
default, the server port is used. Note: in contrast with
211+
the port of the upstream, this port is not a service port,
212+
but a port of a pod.'
141213
type: integer
142214
timeout:
215+
description: This overrides the timeout set by proxy_timeout
216+
which is set in SessionParameters for health checks. The
217+
default value is 5s.
143218
type: string
144219
type: object
145220
loadBalancingMethod:
221+
description: The method used to load balance the upstream servers.
222+
By default, connections are distributed between the servers
223+
using a weighted round-robin balancing method.
146224
type: string
147225
maxConns:
226+
description: Sets the time during which the specified number
227+
of unsuccessful attempts to communicate with the server should
228+
happen to consider the server unavailable and the period of
229+
time the server will be considered unavailable. The default
230+
is 10s.
148231
type: integer
149232
maxFails:
233+
description: Sets the number of maximum connections to the proxied
234+
server. Default value is zero, meaning there is no limit.
235+
The default is 0.
150236
type: integer
151237
name:
238+
description: The name of the upstream. Must be a valid DNS label
239+
as defined in RFC 1035. For example, hello and upstream-123
240+
are valid. The name must be unique among all upstreams of
241+
the resource.
152242
type: string
153243
port:
244+
description: The port of the service. If the service doesn’t
245+
define that port, NGINX will assume the service has zero endpoints
246+
and close client connections/ignore datagrams. The port must
247+
fall into the range 1..65535.
154248
type: integer
155249
service:
250+
description: The name of a service. The service must belong
251+
to the same namespace as the resource. If the service doesn’t
252+
exist, NGINX will assume the service has zero endpoints and
253+
close client connections/ignore datagrams.
156254
type: string
157255
type: object
158256
type: array
159257
type: object
160258
status:
161-
description: TransportServerStatus defines the status for the TransportServer
162-
resource.
259+
description: The status of the TransportServer resource
163260
properties:
164261
message:
262+
description: The message of the current state of the resource. It
263+
can contain more detailed information about the reason.
165264
type: string
166265
reason:
266+
description: The reason of the current state of the resource.
167267
type: string
168268
state:
269+
description: 'Represents the current state of the resource. Possible
270+
values: Valid (resource validated and accepted), Invalid (validation
271+
failed or config reload failed), or Warning (validated but may work
272+
in degraded state).'
169273
type: string
170274
type: object
171275
type: object

0 commit comments

Comments
 (0)