2
apiVersion: apiextensions.k8s.io/v1
3
kind: CustomResourceDefinition
6
controller-gen.kubebuilder.io/version: v0.14.0
7
name: meshhealthchecks.kuma.io
14
listKind: MeshHealthCheckList
15
plural: meshhealthchecks
16
singular: meshhealthcheck
19
- additionalPrinterColumns:
20
- jsonPath: .spec.targetRef.kind
23
- jsonPath: .spec.targetRef.name
32
APIVersion defines the versioned schema of this representation of an object.
33
Servers should convert recognized schemas to the latest internal value, and
34
may reject unrecognized values.
35
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
39
Kind is a string value representing the REST resource this object represents.
40
Servers may infer this from the endpoint the client submits requests to.
43
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
48
description: Spec is the specification of the Kuma MeshHealthCheck resource.
52
TargetRef is a reference to the resource the policy takes an effect on.
53
The resource could be either a real store object or virtual resource
57
description: Kind of the referenced resource
67
description: Mesh is reserved for future use to identify cross
72
Name of the referenced resource. Can only be used with kinds: `MeshService`,
73
`MeshServiceSubset` and `MeshGatewayRoute`
77
ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
78
all data plane types are targeted by the policy.
90
Tags used to select a subset of proxies by tags. Can only be used with kinds
91
`MeshSubset` and `MeshServiceSubset`
95
description: To list makes a match between the consumed services and
96
corresponding configurations
101
Default is a configuration specific to the group of destinations referenced in
104
alwaysLogHealthCheckFailures:
106
If set to true, health check failure events will always be logged. If set
107
to false, only the initial health check failure event will be logged. The
108
default value is false.
112
Specifies the path to the file where Envoy can log health check events.
113
If empty, no event log will be written.
117
If set to true, Envoy will not consider any hosts when the cluster is in
118
'panic mode'. Instead, the cluster will fail all requests as if all hosts
119
are unhealthy. This can help avoid potentially overwhelming a failing
124
GrpcHealthCheck defines gRPC configuration which will instruct the service
125
the health check will be made for is a gRPC service.
129
The value of the :authority header in the gRPC health check request,
130
by default name of the cluster this health check is associated with
133
description: If true the GrpcHealthCheck is disabled
136
description: Service name parameter which will be sent
140
healthyPanicThreshold:
145
Allows to configure panic threshold for Envoy cluster. If not specified,
146
the default is 50%. To disable panic mode, set to 0%.
147
Either int or decimal represented as string.
148
x-kubernetes-int-or-string: true
151
description: Number of consecutive healthy checks before
152
considering a host healthy.
157
HttpHealthCheck defines HTTP configuration which will instruct the service
158
the health check will be made for is an HTTP service.
161
description: If true the HttpHealthCheck is disabled
164
description: List of HTTP response statuses which are
173
The HTTP path which will be requested during the health check
178
The list of HTTP headers which should be added to each health check
187
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
197
x-kubernetes-list-map-keys:
199
x-kubernetes-list-type: map
206
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
216
x-kubernetes-list-map-keys:
218
x-kubernetes-list-type: map
223
If specified, Envoy will start health checking after a random time in
224
ms between 0 and initialJitter. This only applies to the first health
229
description: Interval between consecutive health checks.
233
If specified, during every interval Envoy will add IntervalJitter to the
236
intervalJitterPercent:
238
If specified, during every interval Envoy will add IntervalJitter *
239
IntervalJitterPercent / 100 to the wait time. If IntervalJitter and
240
IntervalJitterPercent are both set, both of them will be used to
241
increase the wait time.
246
The "no traffic interval" is a special health check interval that is used
247
when a cluster has never had traffic routed to it. This lower interval
248
allows cluster information to be kept up to date, without sending a
249
potentially large amount of active health checking traffic for no reason.
250
Once a cluster has been used for traffic routing, Envoy will shift back
251
to using the standard health check interval that is defined. Note that
252
this interval takes precedence over any other. The default value for "no
253
traffic interval" is 60 seconds.
256
description: Reuse health check connection between health
257
checks. Default is true.
261
TcpHealthCheck defines configuration for specifying bytes to send and
262
expected response during the health check
265
description: If true the TcpHealthCheck is disabled
269
List of Base64 encoded blocks of strings expected as a response. When checking the response,
270
"fuzzy" matching is performed such that each block must be found, and
271
in the order specified, but not necessarily contiguous.
272
If not provided or empty, checks will be performed as "connect only" and be marked as successful when TCP connection is successfully established.
277
description: Base64 encoded content of the message which
278
will be sent during the health check to the target
283
description: Maximum time to wait for a health check response.
288
Number of consecutive unhealthy checks before considering a host
295
TargetRef is a reference to the resource that represents a group of
299
description: Kind of the referenced resource
309
description: Mesh is reserved for future use to identify
310
cross mesh resources.
314
Name of the referenced resource. Can only be used with kinds: `MeshService`,
315
`MeshServiceSubset` and `MeshGatewayRoute`
319
ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
320
all data plane types are targeted by the policy.
329
additionalProperties:
332
Tags used to select a subset of proxies by tags. Can only be used with kinds
333
`MeshSubset` and `MeshServiceSubset`