Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Add the support for capacity blocks #5211

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

athiruma
Copy link
Contributor

@athiruma athiruma commented Nov 8, 2024

What type of PR is this?
/kind feature

What this PR does / why we need it:
This PR added the support for CapacityBlocks for ML, by adding this we can get the support for capacity reservations of capacity blocks for ML provided by AWS.

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:

  • squashed commits
  • includes documentation
  • includes emojis
  • adds unit tests
  • adds or updates e2e tests

Release note:

Support running EC2 instances from a reserved capacity block (new API field `marketType`). i.e, marketType: capacity-block

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 8, 2024
@k8s-ci-robot
Copy link
Contributor

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.

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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 8, 2024
Copy link
Member

@damdo damdo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your PR @athiruma 👍
Left some suggestions to improve the overall readability.

pkg/cloud/services/ec2/instances.go Outdated Show resolved Hide resolved
api/v1beta2/awsmachine_types.go Outdated Show resolved Hide resolved
api/v1beta2/types.go Outdated Show resolved Hide resolved
pkg/cloud/services/ec2/instances_test.go Outdated Show resolved Hide resolved
pkg/cloud/services/ec2/instances_test.go Show resolved Hide resolved
pkg/cloud/services/ec2/instances_test.go Outdated Show resolved Hide resolved
pkg/cloud/services/ec2/instances_test.go Show resolved Hide resolved
pkg/cloud/services/ec2/instances_test.go Outdated Show resolved Hide resolved
@athiruma athiruma force-pushed the add_instance_market_option branch from 8ae7c7b to d34e59b Compare November 8, 2024 19:16
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 8, 2024
@athiruma
Copy link
Contributor Author

@damdo??

@richardcase
Copy link
Member

/ok-to-test

@k8s-ci-robot 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 Nov 12, 2024
@athiruma
Copy link
Contributor Author

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

@athiruma athiruma force-pushed the add_instance_market_option branch from d34e59b to f21fca7 Compare November 12, 2024 09:51
@damdo
Copy link
Member

damdo commented Nov 12, 2024

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

@damdo
Copy link
Member

damdo commented Nov 12, 2024

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

@damdo
Copy link
Member

damdo commented Nov 12, 2024

@athiruma The pull-cluster-api-provider-aws-e2e is failing on a the CloudFormation timeout.
We've just increased the timeout in #5193 so if you rebase this PR on the latest main you should pick up the bumped timeout and hopefully this will increase the chances of the e2e to pass.

@athiruma athiruma force-pushed the add_instance_market_option branch from f21fca7 to 05baf2d Compare November 12, 2024 12:52
@damdo
Copy link
Member

damdo commented Nov 12, 2024

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

@athiruma
Copy link
Contributor Author

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

1 similar comment
@athiruma
Copy link
Contributor Author

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

@damdo
Copy link
Member

damdo commented Nov 12, 2024

The eks test is still flakey. I'll take a look at it tomorrow, I think I know where we can improve it

@athiruma
Copy link
Contributor Author

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

@damdo
Copy link
Member

damdo commented Nov 14, 2024

@athiruma see #5215 to improve some issues in the EKS tests

@athiruma
Copy link
Contributor Author

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

1 similar comment
@athiruma
Copy link
Contributor Author

athiruma commented Dec 1, 2024

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

@athiruma
Copy link
Contributor Author

athiruma commented Dec 9, 2024

/retest

@k8s-ci-robot
Copy link
Contributor

@athiruma: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-provider-aws-e2e c975830 link false /test pull-cluster-api-provider-aws-e2e
pull-cluster-api-provider-aws-e2e-eks c975830 link false /test pull-cluster-api-provider-aws-e2e-eks

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@athiruma athiruma force-pushed the add_instance_market_option branch from c975830 to 6c1c6bd Compare December 9, 2024 15:31
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2024
Comment on lines 201 to 204
// UseCapacityBlock enables usage of pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations.
// If enabled, CapacityReservationID must be specified to identify the target reservation.
// +optional
UseCapacityBlock *bool `json:"useCapacityBlock,omitempty"`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this needed, if all it is doing is enabling the capacity reservation ID field?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need this to use for AWS capacity blocks for ml.

pkg/cloud/services/ec2/instances.go Show resolved Hide resolved
@athiruma
Copy link
Contributor Author

athiruma commented Dec 11, 2024

@damdo ptal ?

@athiruma athiruma force-pushed the add_instance_market_option branch from b5997f8 to 7a2948f Compare December 12, 2024 15:33
@@ -197,6 +197,14 @@ type AWSMachineSpec struct {
// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.
// +optional
CapacityReservationID *string `json:"capacityReservationId,omitempty"`

// MarketType specifies the type of market for the EC2 instance. Valid values include:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// MarketType specifies the type of market for the EC2 instance. Valid values include:
// marketType specifies the type of market for the EC2 instance. Valid values include:

// If this value is selected, CapacityReservationID must be specified to identify the target reservation.
// If MarketType is not specified and SpotMarketOptions is provided, the MarketType defaults to "spot".
// +optional
MarketType *MarketType `json:"marketType,omitempty"`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be a pointer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should allow empty values so I thought we should use a pointer here.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you care about the difference between marketType: "" and the field not being present at all? The controller will treat those two representations in the same way won't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I see then I'll make a change. Thanks

Comment on lines 278 to 288
const (
// MarketTypeOnDemand is a MarketType enum value
MarketTypeOnDemand MarketType = "on-demand"

// MarketTypeSpot is a MarketType enum value
MarketTypeSpot MarketType = "spot"

// MarketTypeCapacityBlock is a MarketType enum value
MarketTypeCapacityBlock MarketType = "capacity-block"
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kubernetes API conventions state that enum values should be PascalCase. We prefer this and then to convert to upstream APIs (EC2) in this case so that there's consistency across Kube like APIs. So these should really be OnDemand, Spot and CapacityBlock

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

}

// MarketType describes the market type of an Instance
type MarketType string

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need a kubebuilder:validation:Enum marker on here to make sure the correct schema is generated

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -361,6 +362,14 @@ func (r *AWSMachine) validateNetworkElasticIPPool() field.ErrorList {
return allErrs
}

func (r *AWSMachine) validateInstanceMarketType() field.ErrorList {
var allErrs field.ErrorList
if ptr.Deref(r.Spec.MarketType, "") == MarketTypeCapacityBlock && r.Spec.SpotMarketOptions != nil {
Copy link
Member

@enxebre enxebre Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this also check MarketType is not ondemand if SpotMarketOptions != nil? i.e. the check should be that the only valid when SpotMarketOptions != nil is MarketType==spot

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh yeah good catch thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -197,6 +197,14 @@ type AWSMachineSpec struct {
// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.
// +optional
CapacityReservationID *string `json:"capacityReservationId,omitempty"`

// MarketType specifies the type of market for the EC2 instance. Valid values include:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we describe in gdoc what's the default behaviour if I don't set spot or capacityBlock? i.e on demand

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@athiruma athiruma force-pushed the add_instance_market_option branch from 7a2948f to c1d94dc Compare December 20, 2024 15:26
Copy link

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some documentation fixes for the new casing and LGTM from the API perspective

func (r *AWSMachine) validateInstanceMarketType() field.ErrorList {
var allErrs field.ErrorList
if r.Spec.MarketType == MarketTypeCapacityBlock && r.Spec.SpotMarketOptions != nil {
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "MarketType"), "MarketType set to CapacityBlock and spotMarketOptions cannot be used together"))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "MarketType"), "MarketType set to CapacityBlock and spotMarketOptions cannot be used together"))
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "marketType"), "marketType set to CapacityBlock and spotMarketOptions cannot be used together"))

allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "MarketType"), "MarketType set to CapacityBlock and spotMarketOptions cannot be used together"))
}
if r.Spec.MarketType == MarketTypeOnDemand && r.Spec.SpotMarketOptions != nil {
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "MarketType"), "setting MarketType to OnDemand and spotMarketOptions cannot be used together"))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "MarketType"), "setting MarketType to OnDemand and spotMarketOptions cannot be used together"))
allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "marketType"), "setting marketType to OnDemand and spotMarketOptions cannot be used together"))

@@ -261,8 +261,32 @@ type Instance struct {
// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.
// +optional
CapacityReservationID *string `json:"capacityReservationId,omitempty"`

// marketType specifies the type of market for the EC2 instance. Valid values include:
// "on-demand" (default): The instance runs as a standard On-Demand instance.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// "on-demand" (default): The instance runs as a standard On-Demand instance.
// "OnDemand" (default): The instance runs as a standard On-Demand instance.


// marketType specifies the type of market for the EC2 instance. Valid values include:
// "on-demand" (default): The instance runs as a standard On-Demand instance.
// "spot": The instance runs as a Spot instance. When SpotMarketOptions is provided, the MarketType defaults to "spot".

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// "spot": The instance runs as a Spot instance. When SpotMarketOptions is provided, the MarketType defaults to "spot".
// "Spot": The instance runs as a Spot instance. When spotMarketOptions is provided, the marketType defaults to "Spot".

// marketType specifies the type of market for the EC2 instance. Valid values include:
// "on-demand" (default): The instance runs as a standard On-Demand instance.
// "spot": The instance runs as a Spot instance. When SpotMarketOptions is provided, the MarketType defaults to "spot".
// "capacity-block": The instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// "capacity-block": The instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations.
// "CapacityBlock": The instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations.

// "spot": The instance runs as a Spot instance. When SpotMarketOptions is provided, the MarketType defaults to "spot".
// "capacity-block": The instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations.
// If this value is selected, CapacityReservationID must be specified to identify the target reservation.
// If MarketType is not specified and SpotMarketOptions is provided, the MarketType defaults to "spot".

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// If MarketType is not specified and SpotMarketOptions is provided, the MarketType defaults to "spot".
// If marketType is not specified and spotMarketOptions is provided, the marketType defaults to "Spot".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@athiruma athiruma force-pushed the add_instance_market_option branch 2 times, most recently from 8f0b86f to a1fa3fd Compare January 2, 2025 15:58
@athiruma
Copy link
Contributor Author

athiruma commented Jan 2, 2025

Just some documentation fixes for the new casing and LGTM from the API perspective

fixed

@@ -128,6 +128,19 @@ type AWSLaunchTemplate struct {
// PrivateDNSName is the options for the instance hostname.
// +optional
PrivateDNSName *infrav1.PrivateDNSName `json:"privateDnsName,omitempty"`

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but this is supposed to be exactly the other way around. Go doc comments are meant to start with the name they describe, as shown for example in the rest of the file. Since the name is capital CapacityReservationID, it's also spelled this way in the comment. Same for all new fields.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is not true for Kubernetes APIs, it is convention to use the serialized version within the godoc so that commands like kubectl explain use the same language as the end user will be familiar with. Cluster API has also adopted this convention as well, see kubernetes-sigs/cluster-api#11238

I had assumed it was being adopted community wide?

pkg/cloud/services/ec2/instances.go Show resolved Hide resolved
@athiruma athiruma force-pushed the add_instance_market_option branch from a1fa3fd to af2ddda Compare January 2, 2025 18:06
@athiruma
Copy link
Contributor Author

athiruma commented Jan 7, 2025

@JoelSpeed

Copy link

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 8, 2025
@athiruma
Copy link
Contributor Author

athiruma commented Jan 9, 2025

@AndiDog

InstanceType: "test",
},
},
wantErr: false,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be an error because CapacityReservationID isn't filled. If I'm right, an additional positive/valid case should also be added.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed validating the capacityReservationId in the webhook when the marketType is set to CapacityBlock. Instead, I raised the error in the getInstanceMarketOptions method. It would be better to include the validation in the webhook as well. Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

},
},
},
wantErr: false,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, this is an error

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added the webhook and added one more test cases.

return nil, nil
default:
// Invalid MarketType provided
return nil, errors.Errorf("invalid MarketType %s, must be spot/capacity-block or empty", i.MarketType)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return nil, errors.Errorf("invalid MarketType %s, must be spot/capacity-block or empty", i.MarketType)
return nil, errors.Errorf("invalid MarketType %q", i.MarketType)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Comment on lines 969 to 970
func getLaunchTemplateInstanceMarketOptionsRequest(i *expinfrav1.AWSLaunchTemplate) (*ec2.LaunchTemplateInstanceMarketOptionsRequest, error) {
if i.MarketType != "" && i.MarketType != infrav1.MarketTypeCapacityBlock && i.SpotMarketOptions != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function does the same thing as getInstanceMarketOptionsRequest. Sad that the distinct types don't allow it to easily be one function.

From comparing both functions, I think this is a bug:

Suggested change
func getLaunchTemplateInstanceMarketOptionsRequest(i *expinfrav1.AWSLaunchTemplate) (*ec2.LaunchTemplateInstanceMarketOptionsRequest, error) {
if i.MarketType != "" && i.MarketType != infrav1.MarketTypeCapacityBlock && i.SpotMarketOptions != nil {
func getLaunchTemplateInstanceMarketOptionsRequest(i *expinfrav1.AWSLaunchTemplate) (*ec2.LaunchTemplateInstanceMarketOptionsRequest, error) {
if i.MarketType != "" && i.MarketType == infrav1.MarketTypeCapacityBlock && i.SpotMarketOptions != nil {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ahh, thanks. fixed

@@ -1076,6 +1076,7 @@ func TestCreateLaunchTemplateVersion(t *testing.T) {
awsResourceReference []infrav1.AWSResourceReference
expect func(m *mocks.MockEC2APIMockRecorder)
wantErr bool
MarketType *string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
MarketType *string
marketType *string

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@athiruma athiruma force-pushed the add_instance_market_option branch from af2ddda to 66769de Compare January 9, 2025 09:51
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 9, 2025
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from andidog. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. needs-priority ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants