✨ Added the CapacityReservation support by athiruma · Pull Request #5047 · kubernetes-sigs/cluster-api-provider-aws

athiruma · 2024-07-11T04:36:49Z

What type of PR is this?

What this PR does / why we need it:
Add a new field to API - capacityReservationId, then use it to create capacity reserved instances by initializing a CapacityReservationSpecification and passing it to RunInstances().

Capacity Reservations only support a single availability zone

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

#5045

Special notes for your reviewer:

Checklist:

Release note:

Adding a new API field `capacityReservationId` to create capacity reserved instances

linux-foundation-easycla · 2024-07-11T04:36:54Z

The committers listed above are authorized under a signed CLA.

✅ login: athiruma / name: Thirumalesh Aaraveti (dc07755, 5e44fa5)

k8s-ci-robot · 2024-07-11T04:36:58Z

Welcome @athiruma!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-aws 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-aws has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-07-11T04:36:59Z

Hi @athiruma. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

nrb · 2024-07-11T15:01:06Z

/ok-to-test

muraee · 2024-07-12T16:15:08Z

api/v1beta1/awsmachine_types.go

 	// +kubebuilder:validation:Enum:=default;dedicated;host
 	Tenancy string `json:"tenancy,omitempty"`
+
+	// CapacityReservationID specifies the capacity reservation resource id that should be


I think you are missing the rest of the sentence :)

pkg/cloud/services/ec2/instances.go

nrb · 2024-07-15T15:12:07Z

api/v1beta1/awsmachine_types.go

+	// CapacityReservationID specifies the instance that should be launched in the
+	// reserved compute capacity.
+	// +optional
+	CapacityReservationID string `json:"capacityReservationId,omitempty"`


What's the motivation to add this field to v1beta1? In general, new fields should probably only go into v1beta2.

I added the same based on the spot market options PR. I will remove that.

Fixed the lint Fixed the description Removed the API in v1

athiruma · 2024-07-16T06:47:31Z

/test pull-cluster-api-provider-aws-test

AndiDog · 2024-07-16T08:43:26Z

api/v1beta2/awsmachine_types.go

+	// CapacityReservationID specifies the instance that should be launched in the
+	// reserved compute capacity.


This does not specify an instance.

Suggested change

// CapacityReservationID specifies the instance that should be launched in the

// reserved compute capacity.

// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.

pkg/cloud/services/ec2/instances.go

AndiDog · 2024-07-16T08:47:22Z

pkg/cloud/services/ec2/instances.go


+func getCapacityReservationSpecification(capacityReservationID string) *ec2.CapacityReservationSpecification {
+	if capacityReservationID == "" {
+		// Instance is not a CapacityReservation instance


See above. There's "[EC2] instance" and "Capacity Reservation" as two separate terms. Let's not mix those.

Suggested change

// Instance is not a CapacityReservation instance

// Not targetting any specific Capacity Reservation

AndiDog · 2024-07-16T08:49:41Z

pkg/cloud/services/ec2/instances.go

+	// Set required values for CapacityReservation
+	capacityReservationTargetOptions := &ec2.CapacityReservationTarget{}
+	capacityReservationTargetOptions.SetCapacityReservationId(capacityReservationID)
+
+	capacityReservationSpecification := &ec2.CapacityReservationSpecification{}
+	capacityReservationSpecification.SetCapacityReservationTarget(capacityReservationTargetOptions)
+
+	return capacityReservationSpecification


Suggested change

// Set required values for CapacityReservation

capacityReservationTargetOptions := &ec2.CapacityReservationTarget{}

capacityReservationTargetOptions.SetCapacityReservationId(capacityReservationID)

capacityReservationSpecification := &ec2.CapacityReservationSpecification{}

capacityReservationSpecification.SetCapacityReservationTarget(capacityReservationTargetOptions)

return capacityReservationSpecification

return &ec2.CapacityReservationSpecification{

CapacityReservationTarget: &ec2.CapacityReservationTarget{

CapacityReservationId: ptr.To[string](capacityReservationID),

}

}

AndiDog · 2024-07-16T08:50:27Z

pkg/cloud/services/ec2/instances_test.go

+		},
+		{
+			name:                  "with an valid CapacityReservationID specified",
+			capacityReservationID: *aws.String(mockCapacityReservationID),


Suggested change

capacityReservationID: *aws.String(mockCapacityReservationID),

capacityReservationID: mockCapacityReservationID,

capacityReservationID accepts only the *string. So it will be aws.String(mockCapacityReservationID)

AndiDog · 2024-07-16T08:50:35Z

pkg/cloud/services/ec2/instances_test.go

+			expectedRequest:       nil,
+		},
+		{
+			name:                  "with an valid CapacityReservationID specified",


Suggested change

name: "with an valid CapacityReservationID specified",

name: "with a valid CapacityReservationID specified",

Removed the tests by verify-gen

nrb · 2024-07-23T13:46:29Z

/lgtm

athiruma · 2024-07-25T06:45:33Z

/cc @AndiDog @muraee

muraee · 2024-07-26T09:21:26Z

/lgtm

AndiDog

/lgtm
/approve

k8s-ci-robot · 2024-07-29T08:20:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AndiDog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [AndiDog]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Jul 11, 2024

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-priority labels Jul 11, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 11, 2024

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 11, 2024

k8s-ci-robot requested review from AndiDog and nrb July 11, 2024 04:37

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 11, 2024

athiruma force-pushed the support_capacity_reservation branch from aa8cee7 to 7ed3c02 Compare July 11, 2024 16:37

muraee reviewed Jul 12, 2024

View reviewed changes

pkg/cloud/services/ec2/instances.go Show resolved Hide resolved

athiruma force-pushed the support_capacity_reservation branch 2 times, most recently from a934b6d to 1af019d Compare July 14, 2024 08:58

nrb reviewed Jul 15, 2024

View reviewed changes

athiruma force-pushed the support_capacity_reservation branch from 1af019d to 11045bb Compare July 15, 2024 19:21

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 15, 2024

Added the CapacityReservation support

dc07755

Fixed the lint Fixed the description Removed the API in v1

athiruma force-pushed the support_capacity_reservation branch from 11045bb to dc07755 Compare July 15, 2024 19:37

AndiDog reviewed Jul 16, 2024

View reviewed changes

athiruma force-pushed the support_capacity_reservation branch 3 times, most recently from 11012a7 to 35cf423 Compare July 16, 2024 10:33

Added the capacity reservation id

5e44fa5

Removed the tests by verify-gen

athiruma force-pushed the support_capacity_reservation branch from 35cf423 to 5e44fa5 Compare July 16, 2024 22:44

k8s-ci-robot assigned nrb Jul 23, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 23, 2024

k8s-ci-robot requested review from AndiDog and muraee July 25, 2024 06:45

k8s-ci-robot assigned muraee Jul 26, 2024

AndiDog reviewed Jul 29, 2024

View reviewed changes

k8s-ci-robot assigned AndiDog Jul 29, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 29, 2024

k8s-ci-robot merged commit 6ad02ef into kubernetes-sigs:main Jul 29, 2024

athiruma mentioned this pull request Jul 30, 2024

✨ Added the CapacityReservation support openshift/cluster-api-provider-aws#518

Closed

		// CapacityReservationID specifies the instance that should be launched in the
		// reserved compute capacity.

	// CapacityReservationID specifies the instance that should be launched in the
	// reserved compute capacity.
	// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.

	// Instance is not a CapacityReservation instance
	// Not targetting any specific Capacity Reservation

	capacityReservationID: *aws.String(mockCapacityReservationID),
	capacityReservationID: mockCapacityReservationID,

	name: "with an valid CapacityReservationID specified",
	name: "with a valid CapacityReservationID specified",

Conversation

athiruma commented Jul 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Jul 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Jul 11, 2024

Uh oh!

k8s-ci-robot commented Jul 11, 2024

Uh oh!

nrb commented Jul 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

athiruma commented Jul 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nrb commented Jul 23, 2024

Uh oh!

athiruma commented Jul 25, 2024

Uh oh!

muraee commented Jul 26, 2024

Uh oh!

AndiDog left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Jul 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

athiruma commented Jul 11, 2024 •

edited

Loading

linux-foundation-easycla bot commented Jul 11, 2024 •

edited

Loading