Skip to content

✨ Refactor to consolidate into LaunchTemplateNeedsUpdate #5511

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.

Sign up for GitHub

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

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

✨ Refactor to consolidate into LaunchTemplateNeedsUpdate #5511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 0 additions & 54 deletions exp/controllers/awsmachinepool_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,60 +749,6 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
g.Expect(err).To(Succeed())
})

t.Run("launch template and ASG exist and only AMI ID changed", func(t *testing.T) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is now tested inside the LaunchTemplateNeedsUpdate function.

g := NewWithT(t)
setup(t, g)
reconciler.reconcileServiceFactory = nil // use real implementation, but keep EC2 calls mocked (`ec2ServiceFactory`)
reconSvc = nil // not used
defer teardown(t, g)

// Latest ID and version already stored, no need to retrieve it
ms.AWSMachinePool.Status.LaunchTemplateID = launchTemplateIDExisting
ms.AWSMachinePool.Status.LaunchTemplateVersion = ptr.To[string]("1")

ec2Svc.EXPECT().GetLaunchTemplate(gomock.Eq("test")).Return(
&expinfrav1.AWSLaunchTemplate{
Name: "test",
AMI: infrav1.AMIReference{
ID: ptr.To[string]("ami-existing"),
},
},
// No change to user data
userdata.ComputeHash([]byte("shell-script")),
&userDataSecretKey,
nil)
ec2Svc.EXPECT().DiscoverLaunchTemplateAMI(gomock.Any()).Return(ptr.To[string]("ami-different"), nil)
ec2Svc.EXPECT().LaunchTemplateNeedsUpdate(gomock.Any(), gomock.Any(), gomock.Any()).Return(false, nil)
asgSvc.EXPECT().CanStartASGInstanceRefresh(gomock.Any()).Return(true, nil)
ec2Svc.EXPECT().PruneLaunchTemplateVersions(gomock.Any()).Return(nil)
ec2Svc.EXPECT().CreateLaunchTemplateVersion(gomock.Any(), gomock.Any(), gomock.Eq(ptr.To[string]("ami-different")), gomock.Eq(apimachinerytypes.NamespacedName{Namespace: "default", Name: "bootstrap-data"}), gomock.Any()).Return(nil)
ec2Svc.EXPECT().GetLaunchTemplateLatestVersion(gomock.Any()).Return("2", nil)
// AMI change should trigger rolling out new nodes
asgSvc.EXPECT().StartASGInstanceRefresh(gomock.Any())

asgSvc.EXPECT().GetASGByName(gomock.Any()).DoAndReturn(func(scope *scope.MachinePoolScope) (*expinfrav1.AutoScalingGroup, error) {
g.Expect(scope.Name()).To(Equal("test"))

// No difference to `AWSMachinePool.spec`
return &expinfrav1.AutoScalingGroup{
Name: scope.Name(),
Subnets: []string{
"subnet-1",
},
MinSize: awsMachinePool.Spec.MinSize,
MaxSize: awsMachinePool.Spec.MaxSize,
MixedInstancesPolicy: awsMachinePool.Spec.MixedInstancesPolicy.DeepCopy(),
}, nil
})
asgSvc.EXPECT().DescribeLifecycleHooks(gomock.Any()).Return(nil, nil)
asgSvc.EXPECT().SubnetIDs(gomock.Any()).Return([]string{"subnet-1"}, nil) // no change
// No changes, so there must not be an ASG update!
asgSvc.EXPECT().UpdateASG(gomock.Any()).Times(0)

_, err := reconciler.reconcileNormal(context.Background(), ms, cs, cs)
g.Expect(err).To(Succeed())
})

t.Run("launch template and ASG exist and only bootstrap data secret name changed", func(t *testing.T) {
g := NewWithT(t)
setup(t, g)
Expand Down
69 changes: 36 additions & 33 deletions pkg/cloud/services/ec2/launchtemplate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,21 +71,21 @@ func (s *Service) ReconcileLaunchTemplate(
bootstrapDataHash := userdata.ComputeHash(bootstrapData)

scope.Info("checking for existing launch template")
launchTemplate, launchTemplateUserDataHash, launchTemplateUserDataSecretKey, err := ec2svc.GetLaunchTemplate(scope.LaunchTemplateName())
existingLaunchTemplate, launchTemplateUserDataHash, launchTemplateUserDataSecretKey, err := ec2svc.GetLaunchTemplate(scope.LaunchTemplateName())
if err != nil {
conditions.MarkUnknown(scope.GetSetter(), expinfrav1.LaunchTemplateReadyCondition, expinfrav1.LaunchTemplateNotFoundReason, "%s", err.Error())
return err
}

imageID, err := ec2svc.DiscoverLaunchTemplateAMI(scope)
currentlyUsedAMIID, err := ec2svc.DiscoverLaunchTemplateAMI(scope)
if err != nil {
conditions.MarkFalse(scope.GetSetter(), expinfrav1.LaunchTemplateReadyCondition, expinfrav1.LaunchTemplateCreateFailedReason, clusterv1.ConditionSeverityError, "%s", err.Error())
return err
}

if launchTemplate == nil {
if existingLaunchTemplate == nil {
scope.Info("no existing launch template found, creating")
launchTemplateID, err := ec2svc.CreateLaunchTemplate(scope, imageID, *bootstrapDataSecretKey, bootstrapData)
launchTemplateID, err := ec2svc.CreateLaunchTemplate(scope, currentlyUsedAMIID, *bootstrapDataSecretKey, bootstrapData)
if err != nil {
conditions.MarkFalse(scope.GetSetter(), expinfrav1.LaunchTemplateReadyCondition, expinfrav1.LaunchTemplateCreateFailedReason, clusterv1.ConditionSeverityError, "%s", err.Error())
return err
Expand Down Expand Up @@ -119,21 +119,11 @@ func (s *Service) ReconcileLaunchTemplate(
}
}

annotation, err := MachinePoolAnnotationJSON(scope, TagsLastAppliedAnnotation)
if err != nil {
return err
}

// Check if the instance tags were changed. If they were, create a new LaunchTemplate.
tagsChanged, _, _, _ := tagsChanged(annotation, scope.AdditionalTags()) //nolint:dogsled

needsUpdate, err := ec2svc.LaunchTemplateNeedsUpdate(scope, scope.GetLaunchTemplate(), launchTemplate)
needsUpdate, err := ec2svc.LaunchTemplateNeedsUpdate(scope, existingLaunchTemplate, currentlyUsedAMIID)
if err != nil {
return err
}

amiChanged := *imageID != *launchTemplate.AMI.ID

// `launchTemplateUserDataSecretKey` can be nil since it comes from a tag on the launch template
// which may not exist in older launch templates created by older CAPA versions.
// On change, we trigger instance refresh (rollout of new nodes). Therefore, do not consider it a change if the
Expand All @@ -142,7 +132,7 @@ func (s *Service) ReconcileLaunchTemplate(
userDataSecretKeyChanged := launchTemplateUserDataSecretKey != nil && bootstrapDataSecretKey.String() != launchTemplateUserDataSecretKey.String()
launchTemplateNeedsUserDataSecretKeyTag := launchTemplateUserDataSecretKey == nil

if needsUpdate || tagsChanged || amiChanged || userDataSecretKeyChanged {
if needsUpdate || userDataSecretKeyChanged {
canUpdate, err := canUpdateLaunchTemplate()
if err != nil {
return err
Expand All @@ -157,14 +147,14 @@ func (s *Service) ReconcileLaunchTemplate(

// Create a new launch template version if there's a difference in configuration, tags,
// userdata, OR we've discovered a new AMI ID.
if needsUpdate || tagsChanged || amiChanged || userDataHashChanged || userDataSecretKeyChanged || launchTemplateNeedsUserDataSecretKeyTag {
scope.Info("creating new version for launch template", "existing", launchTemplate, "incoming", scope.GetLaunchTemplate(), "needsUpdate", needsUpdate, "tagsChanged", tagsChanged, "amiChanged", amiChanged, "userDataHashChanged", userDataHashChanged, "userDataSecretKeyChanged", userDataSecretKeyChanged)
if needsUpdate || userDataHashChanged || userDataSecretKeyChanged || launchTemplateNeedsUserDataSecretKeyTag {
scope.Info("creating new version for launch template", "existing", existingLaunchTemplate, "incoming", scope.GetLaunchTemplate(), "needsUpdate", needsUpdate, "userDataHashChanged", userDataHashChanged, "userDataSecretKeyChanged", userDataSecretKeyChanged)
// There is a limit to the number of Launch Template Versions.
// We ensure that the number of versions does not grow without bound by following a simple rule: Before we create a new version, we delete one old version, if there is at least one old version that is not in use.
if err := ec2svc.PruneLaunchTemplateVersions(scope.GetLaunchTemplateIDStatus()); err != nil {
return err
}
if err := ec2svc.CreateLaunchTemplateVersion(scope.GetLaunchTemplateIDStatus(), scope, imageID, *bootstrapDataSecretKey, bootstrapData); err != nil {
if err := ec2svc.CreateLaunchTemplateVersion(scope.GetLaunchTemplateIDStatus(), scope, currentlyUsedAMIID, *bootstrapDataSecretKey, bootstrapData); err != nil {
return err
}
version, err := ec2svc.GetLaunchTemplateLatestVersion(scope.GetLaunchTemplateIDStatus())
Expand All @@ -178,7 +168,7 @@ func (s *Service) ReconcileLaunchTemplate(
}
}

if needsUpdate || tagsChanged || amiChanged || userDataSecretKeyChanged {
if needsUpdate || userDataSecretKeyChanged {
if err := runPostLaunchTemplateUpdateOperation(); err != nil {
conditions.MarkFalse(scope.GetSetter(), expinfrav1.PostLaunchTemplateUpdateOperationCondition, expinfrav1.PostLaunchTemplateUpdateOperationFailedReason, clusterv1.ConditionSeverityError, "%s", err.Error())
return err
Expand Down Expand Up @@ -788,39 +778,42 @@ func (s *Service) SDKToLaunchTemplate(d *ec2.LaunchTemplateVersion) (*expinfrav1
}

// LaunchTemplateNeedsUpdate checks if a new launch template version is needed.
//
// FIXME(dlipovetsky): This check should account for changed userdata, but does not yet do so.
// Although userdata is stored in an EC2 Launch Template, it is not a field of AWSLaunchTemplate.
func (s *Service) LaunchTemplateNeedsUpdate(scope scope.LaunchTemplateScope, incoming *expinfrav1.AWSLaunchTemplate, existing *expinfrav1.AWSLaunchTemplate) (bool, error) {
if incoming.IamInstanceProfile != existing.IamInstanceProfile {
func (s *Service) LaunchTemplateNeedsUpdate(scope scope.LaunchTemplateScope, existingLaunchTemplate *expinfrav1.AWSLaunchTemplate, currentlyUsedAMIID *string) (bool, error) {
incomingLaunchTemplate := scope.GetLaunchTemplate()

if incomingLaunchTemplate.IamInstanceProfile != existingLaunchTemplate.IamInstanceProfile {
return true, nil
}

if incoming.InstanceType != existing.InstanceType {
if incomingLaunchTemplate.InstanceType != existingLaunchTemplate.InstanceType {
return true, nil
}

if !cmp.Equal(incoming.InstanceMetadataOptions, existing.InstanceMetadataOptions) {
if !cmp.Equal(incomingLaunchTemplate.InstanceMetadataOptions, existingLaunchTemplate.InstanceMetadataOptions) {
return true, nil
}

if !cmp.Equal(incoming.SpotMarketOptions, existing.SpotMarketOptions) {
if !cmp.Equal(incomingLaunchTemplate.SpotMarketOptions, existingLaunchTemplate.SpotMarketOptions) {
return true, nil
}

if !cmp.Equal(incoming.CapacityReservationID, existing.CapacityReservationID) {
if incomingLaunchTemplate.AMI.ID != nil && *incomingLaunchTemplate.AMI.ID != *currentlyUsedAMIID {
return true, nil
}

if !cmp.Equal(incoming.PrivateDNSName, existing.PrivateDNSName) {
if !cmp.Equal(incomingLaunchTemplate.CapacityReservationID, existingLaunchTemplate.CapacityReservationID) {
return true, nil
}

if !cmp.Equal(incoming.SSHKeyName, existing.SSHKeyName) {
if !cmp.Equal(incomingLaunchTemplate.PrivateDNSName, existingLaunchTemplate.PrivateDNSName) {
return true, nil
}

incomingIDs, err := s.GetAdditionalSecurityGroupsIDs(incoming.AdditionalSecurityGroups)
if !cmp.Equal(incomingLaunchTemplate.SSHKeyName, existingLaunchTemplate.SSHKeyName) {
return true, nil
}

incomingIDs, err := s.GetAdditionalSecurityGroupsIDs(incomingLaunchTemplate.AdditionalSecurityGroups)
if err != nil {
return false, err
}
Expand All @@ -831,7 +824,7 @@ func (s *Service) LaunchTemplateNeedsUpdate(scope scope.LaunchTemplateScope, inc
}

incomingIDs = append(incomingIDs, coreIDs...)
existingIDs, err := s.GetAdditionalSecurityGroupsIDs(existing.AdditionalSecurityGroups)
existingIDs, err := s.GetAdditionalSecurityGroupsIDs(existingLaunchTemplate.AdditionalSecurityGroups)
if err != nil {
return false, err
}
Expand All @@ -842,6 +835,16 @@ func (s *Service) LaunchTemplateNeedsUpdate(scope scope.LaunchTemplateScope, inc
return true, nil
}

annotation, err := MachinePoolAnnotationJSON(scope, TagsLastAppliedAnnotation)
if err != nil {
return false, err
}
//nolint:dogsled
tagsHaveChanged, _, _, _ := tagsChanged(annotation, scope.AdditionalTags())
if tagsHaveChanged {
return true, nil
}

return false, nil
}

Expand Down
Loading