-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathcluster.x-k8s.io_machinehealthchecks.yaml
More file actions
935 lines (921 loc) · 46.8 KB
/
cluster.x-k8s.io_machinehealthchecks.yaml
File metadata and controls
935 lines (921 loc) · 46.8 KB
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.20.0
name: machinehealthchecks.cluster.x-k8s.io
spec:
group: cluster.x-k8s.io
names:
categories:
- cluster-api
kind: MachineHealthCheck
listKind: MachineHealthCheckList
plural: machinehealthchecks
shortNames:
- mhc
- mhcs
singular: machinehealthcheck
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Cluster
jsonPath: .spec.clusterName
name: Cluster
type: string
- description: Number of machines currently monitored
jsonPath: .status.expectedMachines
name: ExpectedMachines
type: integer
- description: Maximum number of unhealthy machines allowed
jsonPath: .spec.maxUnhealthy
name: MaxUnhealthy
type: string
- description: Current observed healthy machines
jsonPath: .status.currentHealthy
name: CurrentHealthy
type: integer
- description: Time duration since creation of MachineHealthCheck
jsonPath: .metadata.creationTimestamp
name: Age
type: date
deprecated: true
name: v1beta1
schema:
openAPIV3Schema:
description: MachineHealthCheck is the Schema for the machinehealthchecks
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: spec is the specification of machine health check policy
properties:
clusterName:
description: clusterName is the name of the Cluster this object belongs
to.
maxLength: 63
minLength: 1
type: string
maxUnhealthy:
anyOf:
- type: integer
- type: string
description: |-
maxUnhealthy specifies the maximum number of unhealthy machines allowed.
Any further remediation is only allowed if at most "maxUnhealthy" machines selected by
"selector" are not healthy.
Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10722 for more details.
x-kubernetes-int-or-string: true
nodeStartupTimeout:
description: |-
nodeStartupTimeout allows to set the maximum time for MachineHealthCheck
to consider a Machine unhealthy if a corresponding Node isn't associated
through a `Spec.ProviderID` field.
The duration set in this field is compared to the greatest of:
- Cluster's infrastructure ready condition timestamp (if and when available)
- Control Plane's initialized condition timestamp (if and when available)
- Machine's infrastructure ready condition timestamp (if and when available)
- Machine's metadata creation timestamp
Defaults to 10 minutes.
If you wish to disable this feature, set the value explicitly to 0.
type: string
remediationTemplate:
description: |-
remediationTemplate is a reference to a remediation template
provided by an infrastructure provider.
This field is completely optional, when filled, the MachineHealthCheck controller
creates a new object from the template referenced and hands off remediation of the machine to
a controller that lives outside of Cluster API.
properties:
apiVersion:
description: API version of the referent.
type: string
fieldPath:
description: |-
If referring to a piece of an object instead of an entire object, this string
should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within a pod, this would take on a value like:
"spec.containers{name}" (where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]" (container with
index 2 in this pod). This syntax is chosen only to have some well-defined way of
referencing a part of an object.
type: string
kind:
description: |-
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
name:
description: |-
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
type: string
namespace:
description: |-
Namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
type: string
resourceVersion:
description: |-
Specific resourceVersion to which this reference is made, if any.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
type: string
uid:
description: |-
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
type: string
type: object
x-kubernetes-map-type: atomic
selector:
description: selector is a label selector to match machines whose
health will be exercised
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
description: |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
unhealthyConditions:
description: |-
unhealthyConditions contains a list of the conditions that determine
whether a node is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the node is unhealthy.
items:
description: |-
UnhealthyCondition represents a Node condition type and value with a timeout
specified as a duration. When the named condition has been in the given
status for at least the timeout value, a node is considered unhealthy.
properties:
status:
description: status of the condition, one of True, False, Unknown.
minLength: 1
type: string
timeout:
description: |-
timeout is the duration that a node must be in a given status for,
after which the node is considered unhealthy.
For example, with a value of "1h", the node must match the status
for at least 1 hour before being considered unhealthy.
type: string
type:
description: type of Node condition
minLength: 1
type: string
required:
- status
- timeout
- type
type: object
maxItems: 100
type: array
unhealthyMachineConditions:
description: |-
unhealthyMachineConditions contains a list of the machine conditions that determine
whether a machine is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the machine is unhealthy.
items:
description: |-
UnhealthyMachineCondition represents a Machine condition type and value with a timeout
specified as a duration. When the named condition has been in the given
status for at least the timeout value, a machine is considered unhealthy.
properties:
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
timeout:
description: |-
timeout is the duration that a Machine must be in a given status for,
after which the Machine is considered unhealthy.
For example, with a value of "1h", the Machine must match the status
for at least 1 hour before being considered unhealthy.
type: string
type:
description: type of Machine condition
maxLength: 316
minLength: 1
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
x-kubernetes-validations:
- message: 'type must not be one of: Ready, Available, HealthCheckSucceeded,
OwnerRemediated, ExternallyRemediated'
rule: '!(self in [''Ready'',''Available'',''HealthCheckSucceeded'',''OwnerRemediated'',''ExternallyRemediated''])'
required:
- status
- timeout
- type
type: object
maxItems: 100
minItems: 1
type: array
x-kubernetes-list-type: atomic
unhealthyRange:
description: |-
unhealthyRange specifies the range of unhealthy machines allowed.
Any further remediation is only allowed if the number of machines selected by "selector" as not healthy
is within the range of "unhealthyRange". Takes precedence over maxUnhealthy.
Eg. "[3-5]" - This means that remediation will be allowed only when:
(a) there are at least 3 unhealthy machines (and)
(b) there are at most 5 unhealthy machines
Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10722 for more details.
maxLength: 32
minLength: 1
pattern: ^\[[0-9]+-[0-9]+\]$
type: string
required:
- clusterName
- selector
type: object
status:
description: status is the most recently observed status of MachineHealthCheck
resource
properties:
conditions:
description: conditions defines current service state of the MachineHealthCheck.
items:
description: Condition defines an observation of a Cluster API resource
operational state.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when
the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This field may be empty.
maxLength: 10240
minLength: 1
type: string
reason:
description: |-
reason is the reason for the condition's last transition in CamelCase.
The specific API may choose whether or not this field is considered a guaranteed API.
This field may be empty.
maxLength: 256
minLength: 1
type: string
severity:
description: |-
severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
maxLength: 32
type: string
status:
description: status of the condition, one of True, False, Unknown.
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.
maxLength: 256
minLength: 1
type: string
required:
- lastTransitionTime
- status
- type
type: object
type: array
currentHealthy:
description: currentHealthy is the total number of healthy machines
counted by this machine health check
format: int32
minimum: 0
type: integer
expectedMachines:
description: expectedMachines is the total number of machines counted
by this machine health check
format: int32
minimum: 0
type: integer
observedGeneration:
description: observedGeneration is the latest generation observed
by the controller.
format: int64
type: integer
remediationsAllowed:
description: |-
remediationsAllowed is the number of further remediations allowed by this machine health check before
maxUnhealthy short circuiting will be applied
format: int32
minimum: 0
type: integer
targets:
description: targets shows the current list of machines the machine
health check is watching
items:
maxLength: 253
minLength: 1
type: string
maxItems: 10000
type: array
v1beta2:
description: v1beta2 groups all the fields that will be added or modified
in MachineHealthCheck's status with the V1Beta2 version.
properties:
conditions:
description: |-
conditions represents the observations of a MachineHealthCheck's current state.
Known condition types are RemediationAllowed, Paused.
items:
description: Condition contains details for one aspect of the
current state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
maxItems: 32
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
type: object
type: object
served: true
storage: false
subresources:
status: {}
- additionalPrinterColumns:
- description: Cluster
jsonPath: .spec.clusterName
name: Cluster
type: string
- description: Number of machines currently monitored
jsonPath: .status.expectedMachines
name: Replicas
type: integer
- description: Current observed healthy machines
jsonPath: .status.currentHealthy
name: Healthy
type: integer
- description: Reconciliation paused
jsonPath: .status.conditions[?(@.type=="Paused")].status
name: Paused
priority: 10
type: string
- description: Time duration since creation of MachineHealthCheck
jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1beta2
schema:
openAPIV3Schema:
description: MachineHealthCheck is the Schema for the machinehealthchecks
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: spec is the specification of machine health check policy
properties:
checks:
description: |-
checks are the checks that are used to evaluate if a Machine is healthy.
Independent of this configuration the MachineHealthCheck controller will always
flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
Machines with deleted Nodes as unhealthy.
Furthermore, if checks.nodeStartupTimeoutSeconds is not set it
is defaulted to 10 minutes and evaluated accordingly.
minProperties: 1
properties:
nodeStartupTimeoutSeconds:
description: |-
nodeStartupTimeoutSeconds allows to set the maximum time for MachineHealthCheck
to consider a Machine unhealthy if a corresponding Node isn't associated
through a `Spec.ProviderID` field.
The duration set in this field is compared to the greatest of:
- Cluster's infrastructure ready condition timestamp (if and when available)
- Control Plane's initialized condition timestamp (if and when available)
- Machine's infrastructure ready condition timestamp (if and when available)
- Machine's metadata creation timestamp
Defaults to 10 minutes.
If you wish to disable this feature, set the value explicitly to 0.
format: int32
minimum: 0
type: integer
unhealthyMachineConditions:
description: |-
unhealthyMachineConditions contains a list of the machine conditions that determine
whether a machine is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the machine is unhealthy.
items:
description: |-
UnhealthyMachineCondition represents a Machine condition type and value with a timeout
specified as a duration. When the named condition has been in the given
status for at least the timeout value, a machine is considered unhealthy.
properties:
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
timeoutSeconds:
description: |-
timeoutSeconds is the duration that a machine must be in a given status for,
after which the machine is considered unhealthy.
For example, with a value of "3600", the machine must match the status
for at least 1 hour before being considered unhealthy.
format: int32
minimum: 0
type: integer
type:
description: type of Machine condition
maxLength: 316
minLength: 1
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
x-kubernetes-validations:
- message: 'type must not be one of: Ready, Available, HealthCheckSucceeded,
OwnerRemediated, ExternallyRemediated'
rule: '!(self in [''Ready'',''Available'',''HealthCheckSucceeded'',''OwnerRemediated'',''ExternallyRemediated''])'
required:
- status
- timeoutSeconds
- type
type: object
maxItems: 100
minItems: 1
type: array
x-kubernetes-list-type: atomic
unhealthyNodeConditions:
description: |-
unhealthyNodeConditions contains a list of conditions that determine
whether a node is considered unhealthy. The conditions are combined in a
logical OR, i.e. if any of the conditions is met, the node is unhealthy.
items:
description: |-
UnhealthyNodeCondition represents a Node condition type and value with a timeout
specified as a duration. When the named condition has been in the given
status for at least the timeout value, a node is considered unhealthy.
properties:
status:
description: status of the condition, one of True, False,
Unknown.
minLength: 1
type: string
timeoutSeconds:
description: |-
timeoutSeconds is the duration that a node must be in a given status for,
after which the node is considered unhealthy.
For example, with a value of "3600", the node must match the status
for at least 1 hour before being considered unhealthy.
format: int32
minimum: 0
type: integer
type:
description: type of Node condition
minLength: 1
type: string
required:
- status
- timeoutSeconds
- type
type: object
maxItems: 100
minItems: 1
type: array
x-kubernetes-list-type: atomic
type: object
clusterName:
description: clusterName is the name of the Cluster this object belongs
to.
maxLength: 63
minLength: 1
type: string
remediation:
description: |-
remediation configures if and how remediations are triggered if a Machine is unhealthy.
If remediation or remediation.triggerIf is not set,
remediation will always be triggered for unhealthy Machines.
If remediation or remediation.templateRef is not set,
the OwnerRemediated condition will be set on unhealthy Machines to trigger remediation via
the owner of the Machines, for example a MachineSet or a KubeadmControlPlane.
minProperties: 1
properties:
templateRef:
description: |-
templateRef is a reference to a remediation template
provided by an infrastructure provider.
This field is completely optional, when filled, the MachineHealthCheck controller
creates a new object from the template referenced and hands off remediation of the machine to
a controller that lives outside of Cluster API.
properties:
apiVersion:
description: |-
apiVersion of the remediation template.
apiVersion must be fully qualified domain name followed by / and a version.
NOTE: This field must be kept in sync with the APIVersion of the remediation template.
maxLength: 317
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[a-z]([-a-z0-9]*[a-z0-9])?$
type: string
kind:
description: |-
kind of the remediation template.
kind must consist of alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character.
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
name:
description: |-
name of the remediation template.
name must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
required:
- apiVersion
- kind
- name
type: object
triggerIf:
description: |-
triggerIf configures if remediations are triggered.
If this field is not set, remediations are always triggered.
minProperties: 1
properties:
unhealthyInRange:
description: |-
unhealthyInRange specifies that remediations are only triggered if the number of
unhealthy Machines is in the configured range.
Takes precedence over unhealthyLessThanOrEqualTo.
Eg. "[3-5]" - This means that remediation will be allowed only when:
(a) there are at least 3 unhealthy Machines (and)
(b) there are at most 5 unhealthy Machines
maxLength: 32
minLength: 1
pattern: ^\[[0-9]+-[0-9]+\]$
type: string
unhealthyLessThanOrEqualTo:
anyOf:
- type: integer
- type: string
description: |-
unhealthyLessThanOrEqualTo specifies that remediations are only triggered if the number of
unhealthy Machines is less than or equal to the configured value.
unhealthyInRange takes precedence if set.
x-kubernetes-int-or-string: true
type: object
type: object
selector:
description: selector is a label selector to match machines whose
health will be exercised
properties:
matchExpressions:
description: matchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
description: |-
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
type: object
type: object
x-kubernetes-map-type: atomic
required:
- clusterName
- selector
type: object
status:
description: status is the most recently observed status of MachineHealthCheck
resource
minProperties: 1
properties:
conditions:
description: |-
conditions represents the observations of a MachineHealthCheck's current state.
Known condition types are RemediationAllowed, Paused.
items:
description: Condition contains details for one aspect of the current
state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
maxItems: 32
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
currentHealthy:
description: currentHealthy is the total number of healthy machines
counted by this machine health check
format: int32
minimum: 0
type: integer
deprecated:
description: deprecated groups all the status fields that are deprecated
and will be removed when all the nested field are removed.
properties:
v1beta1:
description: v1beta1 groups all the status fields that are deprecated
and will be removed when support for v1beta1 will be dropped.
properties:
conditions:
description: |-
conditions defines current service state of the MachineHealthCheck.
Deprecated: This field is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
items:
description: |-
Condition defines an observation of a Cluster API resource operational state.
Deprecated: This type is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when
the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This field may be empty.
maxLength: 10240
minLength: 1
type: string
reason:
description: |-
reason is the reason for the condition's last transition in CamelCase.
The specific API may choose whether or not this field is considered a guaranteed API.
This field may be empty.
maxLength: 256
minLength: 1
type: string
severity:
description: |-
severity provides an explicit classification of Reason code, so the users or machines can immediately
understand the current situation and act accordingly.
The Severity field MUST be set only when Status=False.
maxLength: 32
type: string
status:
description: status of the condition, one of True, False,
Unknown.
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability to deconflict is important.
maxLength: 256
minLength: 1
type: string
required:
- lastTransitionTime
- status
- type
type: object
type: array
type: object
type: object
expectedMachines:
description: expectedMachines is the total number of machines counted
by this machine health check
format: int32
minimum: 0
type: integer
observedGeneration:
description: observedGeneration is the latest generation observed
by the controller.
format: int64
minimum: 1
type: integer
remediationsAllowed:
description: |-
remediationsAllowed is the number of further remediations allowed by this machine health check before
maxUnhealthy short circuiting will be applied
format: int32
minimum: 0
type: integer
targets:
description: targets shows the current list of machines the machine
health check is watching
items:
maxLength: 253
minLength: 1
type: string
maxItems: 10000
type: array
x-kubernetes-list-type: atomic
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}