This repository was archived by the owner on May 24, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathk8s.nginx.org_nginxingresscontrollers.yaml
338 lines (337 loc) · 14.8 KB
/
k8s.nginx.org_nginxingresscontrollers.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.7.0
creationTimestamp: null
name: nginxingresscontrollers.k8s.nginx.org
spec:
group: k8s.nginx.org
names:
kind: NginxIngressController
listKind: NginxIngressControllerList
plural: nginxingresscontrollers
singular: nginxingresscontroller
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: NginxIngressController is the Schema for the nginxingresscontrollers
API
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: NginxIngressControllerSpec defines the desired state of NginxIngressController
properties:
appProtect:
description: App Protect support configuration. Requires enableCRDs
set to true.
nullable: true
properties:
enable:
description: Enable App Protect WAF.
type: boolean
required:
- enable
type: object
appProtectDos:
description: App Protect Dos support configuration. Requires enableCRDs
set to true.
nullable: true
properties:
debug:
description: Enable debug mode.
type: boolean
enable:
description: Enable App Protect Dos.
type: boolean
maxDaemons:
description: Max number of ADMD instances.
type: integer
maxWorkers:
description: Max number of nginx processes to support.
type: integer
memory:
description: RAM memory size in MB.
type: integer
required:
- debug
- enable
- maxDaemons
- maxWorkers
- memory
type: object
configMapData:
additionalProperties:
type: string
description: Initial values of the Ingress Controller ConfigMap. Check
https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/configmap-resource/
for more information about possible values.
nullable: true
type: object
defaultSecret:
description: The TLS Secret for TLS termination of the default server.
The format is namespace/name. The secret must be of the type kubernetes.io/tls.
If not specified, the operator will generate and deploy a TLS Secret
with a self-signed certificate and key.
type: string
enableCRDs:
description: Enables the use of NGINX Ingress Resource Definitions
(VirtualServer and VirtualServerRoute). Default is true.
nullable: true
type: boolean
enableLatencyMetrics:
description: Bucketed response times from when NGINX establishes a
connection to an upstream server to when the last byte of the response
body is received by NGINX. **Note** The metric for the upstream
isn't available until traffic is sent to the upstream.
nullable: true
type: boolean
enableLeaderElection:
description: Enables Leader election to avoid multiple replicas of
the controller reporting the status of Ingress resources – only
one replica will report status. Default is true.
nullable: true
type: boolean
enablePreviewPolicies:
description: Enables preview policies. Requires enableCRDs set to
true.
type: boolean
enableSnippets:
description: Enable custom NGINX configuration snippets in VirtualServer,
VirtualServerRoute and TransportServer resources. Requires enableCRDs
set to true.
type: boolean
enableTLSPassthrough:
description: Enable TLS Passthrough on port 443. Requires enableCRDs
set to true.
type: boolean
globalConfiguration:
description: The GlobalConfiguration resource for global configuration
of the Ingress Controller. Format is namespace/name. Requires enableCRDs
set to true.
type: string
healthStatus:
description: Adds a new location to the default server. The location
responds with the 200 status code for any request. Useful for external
health-checking of the Ingress controller.
nullable: true
properties:
enable:
description: Enable the HealthStatus.
type: boolean
uri:
description: URI of the location. Default is `/nginx-health`.
type: string
required:
- enable
type: object
image:
description: The image of the Ingress Controller.
properties:
pullPolicy:
description: The ImagePullPolicy of the image.
enum:
- Never
- Always
- IfNotPresent
type: string
repository:
description: The repository of the image.
type: string
tag:
description: The tag (version) of the image.
type: string
required:
- pullPolicy
- repository
- tag
type: object
ingressClass:
description: A class of the Ingress controller. The Ingress controller
only processes Ingress resources that belong to its class (in other
words, have the annotation “kubernetes.io/ingress.class”). Default
is `nginx`.
type: string
logLevel:
description: Log level for V logs. Format is 0 - 3
maximum: 3
minimum: 0
type: integer
nginxDebug:
description: 'Enable debugging for NGINX. Uses the nginx-debug binary.
Requires ‘error-log-level: debug’ in the ConfigMapData.'
type: boolean
nginxPlus:
description: Deploys the Ingress Controller for NGINX Plus. The default
is false meaning the Ingress Controller will be deployed for NGINX
OSS.
type: boolean
nginxReloadTimeout:
description: Timeout in milliseconds which the Ingress Controller
will wait for a successful NGINX reload after a change or at the
initial start.
type: integer
nginxStatus:
description: NGINX stub_status, or the NGINX Plus API.
nullable: true
properties:
allowCidrs:
description: Whitelist IPv4 IP/CIDR blocks to allow access to
NGINX stub_status or the NGINX Plus API. Separate multiple IP/CIDR
by commas. (default “127.0.0.1”)
type: string
enable:
description: Enable the NginxStatus.
type: boolean
port:
description: Set the port where the NGINX stub_status or the NGINX
Plus API is exposed. Default is 8080. Format is 1023 - 65535
maximum: 65535
minimum: 1023
nullable: true
type: integer
required:
- enable
type: object
prometheus:
description: NGINX or NGINX Plus metrics in the Prometheus format.
nullable: true
properties:
enable:
description: Enable Prometheus metrics.
type: boolean
port:
description: Sets the port where the Prometheus metrics are exposed.
Default is 9113. Format is 1023 - 65535
maximum: 65535
minimum: 1023
nullable: true
type: integer
secret:
description: A Secret with a TLS certificate and key for TLS termination
of the Prometheus endpoint. The secret must be of the type kubernetes.io/tls.
If specified, but the Ingress controller is not able to fetch
the Secret from Kubernetes API, the Ingress Controller will
fail to start. Format is namespace/name.
type: string
required:
- enable
type: object
replicas:
description: The number of replicas of the Ingress Controller pod.
The default is 1. Only applies if the type is set to deployment.
format: int32
nullable: true
type: integer
reportIngressStatus:
description: Update the address field in the status of Ingresses resources.
nullable: true
properties:
enable:
description: Enable the ReportIngressStatus.
type: boolean
externalService:
description: 'Specifies the name of the service with the type
LoadBalancer through which the Ingress controller pods are exposed
externally. The external address of the service is used when
reporting the status of Ingress resources. Note: if serviceType
is LoadBalancer, the value of this field will be ignored, and
the operator will use the name of the created LoadBalancer service
instead.'
type: string
ingressLink:
description: 'Specifies the name of the IngressLink resource,
which exposes the Ingress Controller pods via a BIG-IP system.
The IP of the BIG-IP system is used when reporting the status
of Ingress, VirtualServer and VirtualServerRoute resources.
Requires reportIngressStatus.enable set to true. Note: If serviceType
is LoadBalancer or reportIngressStatus.externalService is set,
the value of this field will be ignored.'
type: string
required:
- enable
type: object
service:
description: The service of the Ingress controller.
nullable: true
properties:
extraAnnotations:
additionalProperties:
type: string
description: Specifies extra annotations of the service.
type: object
extraLabels:
additionalProperties:
type: string
description: Specifies extra labels of the service.
type: object
type: object
serviceType:
description: 'The type of the Service for the Ingress Controller.
Valid Service types are: NodePort and LoadBalancer.'
enum:
- NodePort
- LoadBalancer
type: string
type:
description: The type of the Ingress Controller installation - deployment
or daemonset.
enum:
- deployment
- daemonset
type: string
watchNamespace:
description: Namespace to watch for Ingress resources. By default
the Ingress controller watches all namespaces.
type: string
wildcardTLS:
description: A Secret with a TLS certificate and key for TLS termination
of every Ingress host for which TLS termination is enabled but the
Secret is not specified. The secret must be of the type kubernetes.io/tls.
If the argument is not set, for such Ingress hosts NGINX will break
any attempt to establish a TLS connection. If the argument is set,
but the Ingress controller is not able to fetch the Secret from
Kubernetes API, the Ingress Controller will fail to start. Format
is namespace/name.
type: string
required:
- image
- serviceType
- type
type: object
status:
description: NginxIngressControllerStatus defines the observed state of
NginxIngressController
properties:
deployed:
description: Deployed is true if the Operator has finished the deployment
of the NginxIngressController.
type: boolean
required:
- deployed
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []