Skip to content

Commit 3e6ab00

Browse files
BraeTroutmanalam0rt
BraeTroutman
authored and
alam0rt
committed
revise and regenerate doc comments and kubebuilder validations
1 parent c4ada5c commit 3e6ab00

7 files changed

+50
-24
lines changed

‎api/v1beta2/types.go‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -287,26 +287,27 @@ type Instance struct {
287287
HostID *string `json:"hostID,omitempty"`
288288

289289
// CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
290-
// "Open" (default): The instance may make use of open Capacity Reservations that match its AZ and InstanceType
290+
// "Open": The instance may make use of open Capacity Reservations that match its AZ and InstanceType
291291
// "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
292292
// "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
293+
// +kubebuilder:validation:Enum="";None;CapacityReservationsOnly;Open
293294
// +optional
294295
CapacityReservationPreference CapacityReservationPreference `json:"capacityReservationPreference,omitempty"`
295296
}
296297

297298
// CapacityReservationPreference describes the preferred use of capacity reservations
298299
// of an instance
299-
// +kubebuilder:validation:Enum:=None;CapacityReservationsOnly;Open
300+
// +kubebuilder:validation:Enum:="";None;CapacityReservationsOnly;Open
300301
type CapacityReservationPreference string
301302

302303
const (
303-
// CapacityReservationPreferenceNone is a CapacityReservationPreference enum value
304+
// CapacityReservationPreferenceNone the instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
304305
CapacityReservationPreferenceNone CapacityReservationPreference = "None"
305306

306-
// CapacityReservationPreferenceOnly is a CapacityReservationPreference enum value
307+
// CapacityReservationPreferenceOnly the instance will only run if matched or targeted to a Capacity Reservation
307308
CapacityReservationPreferenceOnly CapacityReservationPreference = "CapacityReservationsOnly"
308309

309-
// CapacityReservationPreferenceOpen is a CapacityReservationPreference enum value
310+
// CapacityReservationPreferenceOpen the instance may make use of open Capacity Reservations that match its AZ and InstanceType.
310311
CapacityReservationPreferenceOpen CapacityReservationPreference = "Open"
311312
)
312313

‎config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanes.yaml‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1220,15 +1220,22 @@ spec:
12201220
Reservation into which the instance should be launched.
12211221
type: string
12221222
capacityReservationPreference:
1223+
allOf:
1224+
- enum:
1225+
- ""
1226+
- None
1227+
- CapacityReservationsOnly
1228+
- Open
1229+
- enum:
1230+
- ""
1231+
- None
1232+
- CapacityReservationsOnly
1233+
- Open
12231234
description: |-
12241235
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
1225-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
1236+
"Open": The instance may make use of open Capacity Reservations that match its AZ and InstanceType
12261237
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
12271238
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
1228-
enum:
1229-
- None
1230-
- CapacityReservationsOnly
1231-
- Open
12321239
type: string
12331240
ebsOptimized:
12341241
description: Indicates whether the instance is optimized for Amazon
@@ -3432,15 +3439,22 @@ spec:
34323439
Reservation into which the instance should be launched.
34333440
type: string
34343441
capacityReservationPreference:
3442+
allOf:
3443+
- enum:
3444+
- ""
3445+
- None
3446+
- CapacityReservationsOnly
3447+
- Open
3448+
- enum:
3449+
- ""
3450+
- None
3451+
- CapacityReservationsOnly
3452+
- Open
34353453
description: |-
34363454
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
3437-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
3455+
"Open": The instance may make use of open Capacity Reservations that match its AZ and InstanceType
34383456
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
34393457
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
3440-
enum:
3441-
- None
3442-
- CapacityReservationsOnly
3443-
- Open
34443458
type: string
34453459
ebsOptimized:
34463460
description: Indicates whether the instance is optimized for Amazon

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsclusters.yaml‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2198,15 +2198,22 @@ spec:
21982198
Reservation into which the instance should be launched.
21992199
type: string
22002200
capacityReservationPreference:
2201+
allOf:
2202+
- enum:
2203+
- ""
2204+
- None
2205+
- CapacityReservationsOnly
2206+
- Open
2207+
- enum:
2208+
- ""
2209+
- None
2210+
- CapacityReservationsOnly
2211+
- Open
22012212
description: |-
22022213
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
2203-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
2214+
"Open": The instance may make use of open Capacity Reservations that match its AZ and InstanceType
22042215
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
22052216
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
2206-
enum:
2207-
- None
2208-
- CapacityReservationsOnly
2209-
- Open
22102217
type: string
22112218
ebsOptimized:
22122219
description: Indicates whether the instance is optimized for Amazon

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinepools.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,10 +647,11 @@ spec:
647647
capacityReservationPreference:
648648
description: |-
649649
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
650-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
650+
"Open" (default): The instance may make use of open Capacity Reservations that match its AZ and InstanceType
651651
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
652652
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
653653
enum:
654+
- ""
654655
- None
655656
- CapacityReservationsOnly
656657
- Open

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachines.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,10 +644,11 @@ spec:
644644
capacityReservationPreference:
645645
description: |-
646646
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
647-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
647+
"Open" (default): The instance may make use of open Capacity Reservations that match its AZ and InstanceType
648648
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
649649
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
650650
enum:
651+
- ""
651652
- None
652653
- CapacityReservationsOnly
653654
- Open

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinetemplates.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -563,10 +563,11 @@ spec:
563563
capacityReservationPreference:
564564
description: |-
565565
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
566-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
566+
"Open" (default): The instance may make use of open Capacity Reservations that match its AZ and InstanceType
567567
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
568568
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
569569
enum:
570+
- ""
570571
- None
571572
- CapacityReservationsOnly
572573
- Open

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsmanagedmachinepools.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -656,10 +656,11 @@ spec:
656656
capacityReservationPreference:
657657
description: |-
658658
CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
659-
"Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
659+
"Open" (default): The instance may make use of open Capacity Reservations that match its AZ and InstanceType
660660
"None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
661661
"CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
662662
enum:
663+
- ""
663664
- None
664665
- CapacityReservationsOnly
665666
- Open

0 commit comments

Comments
 (0)