1---
2apiVersion: apiextensions.k8s.io/v1
3kind: CustomResourceDefinition
4metadata:
5 annotations:
6 controller-gen.kubebuilder.io/version: (unknown)
7 name: computehealthchecks.compute.cnrm.cloud.google.com
8spec:
9 group: compute.cnrm.cloud.google.com
10 names:
11 kind: ComputeHealthCheck
12 listKind: ComputeHealthCheckList
13 plural: computehealthchecks
14 singular: computehealthcheck
15 scope: Namespaced
16 versions:
17 - name: v1beta1
18 schema:
19 openAPIV3Schema:
20 description: ComputeHealthCheck is the Schema for the compute API
21 properties:
22 apiVersion:
23 description: |-
24 APIVersion defines the versioned schema of this representation of an object.
25 Servers should convert recognized schemas to the latest internal value, and
26 may reject unrecognized values.
27 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
28 type: string
29 kind:
30 description: |-
31 Kind is a string value representing the REST resource this object represents.
32 Servers may infer this from the endpoint the client submits requests to.
33 Cannot be updated.
34 In CamelCase.
35 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
36 type: string
37 metadata:
38 type: object
39 spec:
40 properties:
41 checkIntervalSec:
42 description: |-
43 How often (in seconds) to send a health check. The default value is 5
44 seconds.
45 type: integer
46 description:
47 description: |-
48 An optional description of this resource. Provide this property when
49 you create the resource.
50 type: string
51 grpcHealthCheck:
52 description: A nested object resource.
53 properties:
54 grpcServiceName:
55 description: |-
56 The gRPC service name for the health check.
57 The value of grpcServiceName has the following meanings by convention:
58 - Empty serviceName means the overall status of all services at the backend.
59 - Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service.
60 The grpcServiceName can only be ASCII.
61 type: string
62 port:
63 description: |-
64 The port number for the health check request.
65 Must be specified if portName and portSpecification are not set
66 or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
67 type: integer
68 portName:
69 description: |-
70 Port name as defined in InstanceGroup#NamedPort#name. If both port and
71 port_name are defined, port takes precedence.
72 type: string
73 portSpecification:
74 description: |-
75 Specifies how port is selected for health checking, can be one of the
76 following values:
77
78
79 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
80
81
82 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
83
84
85 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
86 network endpoint is used for health checking. For other backends, the
87 port or named port specified in the Backend Service is used for health
88 checking.
89
90
91 If not specified, gRPC health check follows behavior specified in 'port' and
92 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
93 type: string
94 type: object
95 healthyThreshold:
96 description: |-
97 A so-far unhealthy instance will be marked healthy after this many
98 consecutive successes. The default value is 2.
99 type: integer
100 http2HealthCheck:
101 description: A nested object resource.
102 properties:
103 host:
104 description: |-
105 The value of the host header in the HTTP2 health check request.
106 If left empty (default value), the public IP on behalf of which this health
107 check is performed will be used.
108 type: string
109 port:
110 description: |-
111 The TCP port number for the HTTP2 health check request.
112 The default value is 443.
113 type: integer
114 portName:
115 description: |-
116 Port name as defined in InstanceGroup#NamedPort#name. If both port and
117 port_name are defined, port takes precedence.
118 type: string
119 portSpecification:
120 description: |-
121 Specifies how port is selected for health checking, can be one of the
122 following values:
123
124
125 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
126
127
128 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
129
130
131 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
132 network endpoint is used for health checking. For other backends, the
133 port or named port specified in the Backend Service is used for health
134 checking.
135
136
137 If not specified, HTTP2 health check follows behavior specified in 'port' and
138 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
139 type: string
140 proxyHeader:
141 description: |-
142 Specifies the type of proxy header to append before sending data to the
143 backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
144 type: string
145 requestPath:
146 description: |-
147 The request path of the HTTP2 health check request.
148 The default value is /.
149 type: string
150 response:
151 description: |-
152 The bytes to match against the beginning of the response data. If left empty
153 (the default value), any response will indicate health. The response data
154 can only be ASCII.
155 type: string
156 type: object
157 httpHealthCheck:
158 description: A nested object resource.
159 properties:
160 host:
161 description: |-
162 The value of the host header in the HTTP health check request.
163 If left empty (default value), the public IP on behalf of which this health
164 check is performed will be used.
165 type: string
166 port:
167 description: |-
168 The TCP port number for the HTTP health check request.
169 The default value is 80.
170 type: integer
171 portName:
172 description: |-
173 Port name as defined in InstanceGroup#NamedPort#name. If both port and
174 port_name are defined, port takes precedence.
175 type: string
176 portSpecification:
177 description: |-
178 Specifies how port is selected for health checking, can be one of the
179 following values:
180
181
182 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
183
184
185 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
186
187
188 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
189 network endpoint is used for health checking. For other backends, the
190 port or named port specified in the Backend Service is used for health
191 checking.
192
193
194 If not specified, HTTP health check follows behavior specified in 'port' and
195 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
196 type: string
197 proxyHeader:
198 description: |-
199 Specifies the type of proxy header to append before sending data to the
200 backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
201 type: string
202 requestPath:
203 description: |-
204 The request path of the HTTP health check request.
205 The default value is /.
206 type: string
207 response:
208 description: |-
209 The bytes to match against the beginning of the response data. If left empty
210 (the default value), any response will indicate health. The response data
211 can only be ASCII.
212 type: string
213 type: object
214 httpsHealthCheck:
215 description: A nested object resource.
216 properties:
217 host:
218 description: |-
219 The value of the host header in the HTTPS health check request.
220 If left empty (default value), the public IP on behalf of which this health
221 check is performed will be used.
222 type: string
223 port:
224 description: |-
225 The TCP port number for the HTTPS health check request.
226 The default value is 443.
227 type: integer
228 portName:
229 description: |-
230 Port name as defined in InstanceGroup#NamedPort#name. If both port and
231 port_name are defined, port takes precedence.
232 type: string
233 portSpecification:
234 description: |-
235 Specifies how port is selected for health checking, can be one of the
236 following values:
237
238
239 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
240
241
242 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
243
244
245 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
246 network endpoint is used for health checking. For other backends, the
247 port or named port specified in the Backend Service is used for health
248 checking.
249
250
251 If not specified, HTTPS health check follows behavior specified in 'port' and
252 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
253 type: string
254 proxyHeader:
255 description: |-
256 Specifies the type of proxy header to append before sending data to the
257 backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
258 type: string
259 requestPath:
260 description: |-
261 The request path of the HTTPS health check request.
262 The default value is /.
263 type: string
264 response:
265 description: |-
266 The bytes to match against the beginning of the response data. If left empty
267 (the default value), any response will indicate health. The response data
268 can only be ASCII.
269 type: string
270 type: object
271 location:
272 description: 'Location represents the geographical location of the
273 ComputeHealthCheck. Specify a region name or "global" for global
274 resources. Reference: GCP definition of regions/zones (https://cloud.google.com/compute/docs/regions-zones/)'
275 type: string
276 logConfig:
277 description: Configure logging on this health check.
278 properties:
279 enable:
280 description: |-
281 Indicates whether or not to export logs. This is false by default,
282 which means no health check logging will be done.
283 type: boolean
284 type: object
285 resourceID:
286 description: Immutable. Optional. The name of the resource. Used for
287 creation and acquisition. When unset, the value of `metadata.name`
288 is used as the default.
289 type: string
290 sslHealthCheck:
291 description: A nested object resource.
292 properties:
293 port:
294 description: |-
295 The TCP port number for the SSL health check request.
296 The default value is 443.
297 type: integer
298 portName:
299 description: |-
300 Port name as defined in InstanceGroup#NamedPort#name. If both port and
301 port_name are defined, port takes precedence.
302 type: string
303 portSpecification:
304 description: |-
305 Specifies how port is selected for health checking, can be one of the
306 following values:
307
308
309 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
310
311
312 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
313
314
315 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
316 network endpoint is used for health checking. For other backends, the
317 port or named port specified in the Backend Service is used for health
318 checking.
319
320
321 If not specified, SSL health check follows behavior specified in 'port' and
322 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
323 type: string
324 proxyHeader:
325 description: |-
326 Specifies the type of proxy header to append before sending data to the
327 backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
328 type: string
329 request:
330 description: |-
331 The application data to send once the SSL connection has been
332 established (default value is empty). If both request and response are
333 empty, the connection establishment alone will indicate health. The request
334 data can only be ASCII.
335 type: string
336 response:
337 description: |-
338 The bytes to match against the beginning of the response data. If left empty
339 (the default value), any response will indicate health. The response data
340 can only be ASCII.
341 type: string
342 type: object
343 tcpHealthCheck:
344 description: A nested object resource.
345 properties:
346 port:
347 description: |-
348 The TCP port number for the TCP health check request.
349 The default value is 443.
350 type: integer
351 portName:
352 description: |-
353 Port name as defined in InstanceGroup#NamedPort#name. If both port and
354 port_name are defined, port takes precedence.
355 type: string
356 portSpecification:
357 description: |-
358 Specifies how port is selected for health checking, can be one of the
359 following values:
360
361
362 * 'USE_FIXED_PORT': The port number in 'port' is used for health checking.
363
364
365 * 'USE_NAMED_PORT': The 'portName' is used for health checking.
366
367
368 * 'USE_SERVING_PORT': For NetworkEndpointGroup, the port specified for each
369 network endpoint is used for health checking. For other backends, the
370 port or named port specified in the Backend Service is used for health
371 checking.
372
373
374 If not specified, TCP health check follows behavior specified in 'port' and
375 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"].
376 type: string
377 proxyHeader:
378 description: |-
379 Specifies the type of proxy header to append before sending data to the
380 backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"].
381 type: string
382 request:
383 description: |-
384 The application data to send once the TCP connection has been
385 established (default value is empty). If both request and response are
386 empty, the connection establishment alone will indicate health. The request
387 data can only be ASCII.
388 type: string
389 response:
390 description: |-
391 The bytes to match against the beginning of the response data. If left empty
392 (the default value), any response will indicate health. The response data
393 can only be ASCII.
394 type: string
395 type: object
396 timeoutSec:
397 description: |-
398 How long (in seconds) to wait before claiming failure.
399 The default value is 5 seconds. It is invalid for timeoutSec to have
400 greater value than checkIntervalSec.
401 type: integer
402 unhealthyThreshold:
403 description: |-
404 A so-far healthy instance will be marked unhealthy after this many
405 consecutive failures. The default value is 2.
406 type: integer
407 required:
408 - location
409 type: object
410 status:
411 properties:
412 conditions:
413 description: |-
414 Conditions represent the latest available observations of the
415 ComputeHealthCheck's current state.
416 items:
417 properties:
418 lastTransitionTime:
419 description: Last time the condition transitioned from one status
420 to another.
421 type: string
422 message:
423 description: Human-readable message indicating details about
424 last transition.
425 type: string
426 reason:
427 description: |-
428 Unique, one-word, CamelCase reason for the condition's last
429 transition.
430 type: string
431 status:
432 description: Status is the status of the condition. Can be True,
433 False, Unknown.
434 type: string
435 type:
436 description: Type is the type of the condition.
437 type: string
438 type: object
439 type: array
440 creationTimestamp:
441 description: Creation timestamp in RFC3339 text format.
442 type: string
443 observedGeneration:
444 description: ObservedGeneration is the generation of the resource
445 that was most recently observed by the Config Connector controller.
446 If this is equal to metadata.generation, then that means that the
447 current reported status reflects the most recent desired state of
448 the resource.
449 type: integer
450 selfLink:
451 type: string
452 type:
453 description: The type of the health check. One of HTTP, HTTPS, TCP,
454 or SSL.
455 type: string
456 type: object
457 type: object
458 served: true
459 storage: true
View as plain text