package common import ( "context" "encoding/base64" "fmt" "io/ioutil" "log" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/service/ec2" "github.com/hashicorp/packer/common/random" "github.com/hashicorp/packer/common/retry" "github.com/hashicorp/packer/helper/communicator" "github.com/hashicorp/packer/helper/multistep" "github.com/hashicorp/packer/packer" "github.com/hashicorp/packer/template/interpolate" ) type EC2BlockDeviceMappingsBuilder interface { BuildEC2BlockDeviceMappings() []*ec2.BlockDeviceMapping } type StepRunSpotInstance struct { AssociatePublicIpAddress bool LaunchMappings EC2BlockDeviceMappingsBuilder BlockDurationMinutes int64 Debug bool Comm *communicator.Config EbsOptimized bool ExpectedRootDevice string InstanceInitiatedShutdownBehavior string InstanceType string SourceAMI string SpotPrice string SpotTags map[string]string SpotInstanceTypes []string Tags map[string]string VolumeTags map[string]string UserData string UserDataFile string Ctx interpolate.Context NoEphemeral bool instanceId string } func (s *StepRunSpotInstance) CreateTemplateData(userData *string, az string, state multistep.StateBag, marketOptions *ec2.LaunchTemplateInstanceMarketOptionsRequest) *ec2.RequestLaunchTemplateData { blockDeviceMappings := s.LaunchMappings.BuildEC2BlockDeviceMappings() if s.NoEphemeral { // This is only relevant for windows guests. Ephemeral drives by // default are assigned to drive names xvdca-xvdcz. // When vms are launched from the AWS console, they're automatically // removed from the block devices if the user hasn't said to use them, // but the SDK does not perform this cleanup. The following code just // manually removes the ephemeral drives from the mapping so that they // don't clutter up console views and cause confusion. log.Printf("no_ephemeral was set, so creating drives xvdca-xvdcz as empty mappings") DefaultEphemeralDeviceLetters := "abcdefghijklmnopqrstuvwxyz" for _, letter := range DefaultEphemeralDeviceLetters { bd := &ec2.BlockDeviceMapping{ DeviceName: aws.String("xvdc" + string(letter)), NoDevice: aws.String(""), } blockDeviceMappings = append(blockDeviceMappings, bd) } } // Convert the BlockDeviceMapping into a // LaunchTemplateBlockDeviceMappingRequest. These structs are identical, // except for the EBS field -- on one, that field contains a // LaunchTemplateEbsBlockDeviceRequest, and on the other, it contains an // EbsBlockDevice. The EbsBlockDevice and // LaunchTemplateEbsBlockDeviceRequest structs are themselves // identical except for the struct's name, so you can cast one directly // into the other. var launchMappingRequests []*ec2.LaunchTemplateBlockDeviceMappingRequest for _, mapping := range blockDeviceMappings { launchRequest := &ec2.LaunchTemplateBlockDeviceMappingRequest{ DeviceName: mapping.DeviceName, Ebs: (*ec2.LaunchTemplateEbsBlockDeviceRequest)(mapping.Ebs), NoDevice: mapping.NoDevice, VirtualName: mapping.VirtualName, } launchMappingRequests = append(launchMappingRequests, launchRequest) } iamInstanceProfile := aws.String(state.Get("iamInstanceProfile").(string)) // Create a launch template. templateData := ec2.RequestLaunchTemplateData{ BlockDeviceMappings: launchMappingRequests, DisableApiTermination: aws.Bool(false), EbsOptimized: &s.EbsOptimized, IamInstanceProfile: &ec2.LaunchTemplateIamInstanceProfileSpecificationRequest{Name: iamInstanceProfile}, ImageId: &s.SourceAMI, InstanceMarketOptions: marketOptions, Placement: &ec2.LaunchTemplatePlacementRequest{ AvailabilityZone: &az, }, UserData: userData, } // Create a network interface securityGroupIds := aws.StringSlice(state.Get("securityGroupIds").([]string)) subnetId := state.Get("subnet_id").(string) if subnetId != "" { // Set up a full network interface networkInterface := ec2.LaunchTemplateInstanceNetworkInterfaceSpecificationRequest{ Groups: securityGroupIds, DeleteOnTermination: aws.Bool(true), DeviceIndex: aws.Int64(0), SubnetId: aws.String(subnetId), } if s.AssociatePublicIpAddress { networkInterface.SetAssociatePublicIpAddress(s.AssociatePublicIpAddress) } templateData.SetNetworkInterfaces([]*ec2.LaunchTemplateInstanceNetworkInterfaceSpecificationRequest{&networkInterface}) } else { templateData.SetSecurityGroupIds(securityGroupIds) } // If instance type is not set, we'll just pick the lowest priced instance // available. if s.InstanceType != "" { templateData.SetInstanceType(s.InstanceType) } if s.Comm.SSHKeyPairName != "" { templateData.SetKeyName(s.Comm.SSHKeyPairName) } return &templateData } func (s *StepRunSpotInstance) LoadUserData() (string, error) { userData := s.UserData if s.UserDataFile != "" { contents, err := ioutil.ReadFile(s.UserDataFile) if err != nil { return "", fmt.Errorf("Problem reading user data file: %s", err) } userData = string(contents) } // Test if it is encoded already, and if not, encode it if _, err := base64.StdEncoding.DecodeString(userData); err != nil { log.Printf("[DEBUG] base64 encoding user data...") userData = base64.StdEncoding.EncodeToString([]byte(userData)) } return userData, nil } func (s *StepRunSpotInstance) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction { ec2conn := state.Get("ec2").(*ec2.EC2) ui := state.Get("ui").(packer.Ui) ui.Say("Launching a spot AWS instance...") // Get and validate the source AMI image, ok := state.Get("source_image").(*ec2.Image) if !ok { state.Put("error", fmt.Errorf("source_image type assertion failed")) return multistep.ActionHalt } s.SourceAMI = *image.ImageId if s.ExpectedRootDevice != "" && *image.RootDeviceType != s.ExpectedRootDevice { state.Put("error", fmt.Errorf( "The provided source AMI has an invalid root device type.\n"+ "Expected '%s', got '%s'.", s.ExpectedRootDevice, *image.RootDeviceType)) return multistep.ActionHalt } azConfig := "" if azRaw, ok := state.GetOk("availability_zone"); ok { azConfig = azRaw.(string) } az := azConfig var instanceId string ui.Say("Interpolating tags for spot instance...") // s.Tags will tag the eventually launched instance // s.SpotTags apply to the spot request itself, and do not automatically // get applied to the spot instance that is launched once the request is // fulfilled if _, exists := s.Tags["Name"]; !exists { s.Tags["Name"] = "Packer Builder" } // Convert tags from the tag map provided by the user into *ec2.Tag s ec2Tags, err := TagMap(s.Tags).EC2Tags(s.Ctx, *ec2conn.Config.Region, state) if err != nil { err := fmt.Errorf("Error generating tags for source instance: %s", err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } // This prints the tags to the ui; it doesn't actually add them to the // instance yet ec2Tags.Report(ui) spotOptions := ec2.LaunchTemplateSpotMarketOptionsRequest{} // The default is to set the maximum price to the OnDemand price. if s.SpotPrice != "auto" { spotOptions.SetMaxPrice(s.SpotPrice) } if s.BlockDurationMinutes != 0 { spotOptions.BlockDurationMinutes = &s.BlockDurationMinutes } marketOptions := &ec2.LaunchTemplateInstanceMarketOptionsRequest{ SpotOptions: &spotOptions, } marketOptions.SetMarketType(ec2.MarketTypeSpot) // Create a launch template for the instance ui.Message("Loading User Data File...") // Generate a random name to avoid conflicting with other // instances of packer running in this AWS account launchTemplateName := fmt.Sprintf( "packer-fleet-launch-template-%s", random.AlphaNum(7)) state.Put("launchTemplateName", launchTemplateName) // For the cleanup step userData, err := s.LoadUserData() if err != nil { state.Put("error", err) return multistep.ActionHalt } ui.Message("Creating Spot Fleet launch template...") templateData := s.CreateTemplateData(&userData, az, state, marketOptions) launchTemplate := &ec2.CreateLaunchTemplateInput{ LaunchTemplateData: templateData, LaunchTemplateName: aws.String(launchTemplateName), VersionDescription: aws.String("template generated by packer for launching spot instances"), } // Tell EC2 to create the template _, err = ec2conn.CreateLaunchTemplate(launchTemplate) if err != nil { err := fmt.Errorf("Error creating launch template for spot instance: %s", err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } // Add overrides for each user-provided instance type var overrides []*ec2.FleetLaunchTemplateOverridesRequest for _, instanceType := range s.SpotInstanceTypes { override := ec2.FleetLaunchTemplateOverridesRequest{ InstanceType: aws.String(instanceType), } overrides = append(overrides, &override) } createFleetInput := &ec2.CreateFleetInput{ LaunchTemplateConfigs: []*ec2.FleetLaunchTemplateConfigRequest{ { LaunchTemplateSpecification: &ec2.FleetLaunchTemplateSpecificationRequest{ LaunchTemplateName: aws.String(launchTemplateName), Version: aws.String("1"), }, Overrides: overrides, }, }, ReplaceUnhealthyInstances: aws.Bool(false), TargetCapacitySpecification: &ec2.TargetCapacitySpecificationRequest{ TotalTargetCapacity: aws.Int64(1), DefaultTargetCapacityType: aws.String("spot"), }, Type: aws.String("instant"), } // Create the request for the spot instance. req, createOutput := ec2conn.CreateFleetRequest(createFleetInput) ui.Message(fmt.Sprintf("Sending spot request (%s)...", req.RequestID)) // Actually send the spot connection request. err = req.Send() if err != nil { if createOutput.FleetId != nil { err = fmt.Errorf("Error waiting for fleet request (%s): %s", *createOutput.FleetId, err) } else { err = fmt.Errorf("Error waiting for fleet request: %s", err) } state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } if len(createOutput.Instances) == 0 { // We can end up with errors because one of the allowed availability // zones doesn't have one of the allowed instance types; as long as // an instance is launched, these errors aren't important. if len(createOutput.Errors) > 0 { errString := fmt.Sprintf("Error waiting for fleet request (%s) to become ready:", *createOutput.FleetId) for _, outErr := range createOutput.Errors { errString = errString + aws.StringValue(outErr.ErrorMessage) } err = fmt.Errorf(errString) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } } instanceId = *createOutput.Instances[0].InstanceIds[0] // Set the instance ID so that the cleanup works properly s.instanceId = instanceId ui.Message(fmt.Sprintf("Instance ID: %s", instanceId)) // Get information about the created instance var describeOutput *ec2.DescribeInstancesOutput err = retry.Config{ Tries: 11, RetryDelay: (&retry.Backoff{InitialBackoff: 200 * time.Millisecond, MaxBackoff: 30 * time.Second, Multiplier: 2}).Linear, }.Run(ctx, func(ctx context.Context) error { describeOutput, err = ec2conn.DescribeInstances(&ec2.DescribeInstancesInput{ InstanceIds: []*string{aws.String(instanceId)}, }) return err }) if err != nil || len(describeOutput.Reservations) == 0 || len(describeOutput.Reservations[0].Instances) == 0 { err := fmt.Errorf("Error finding source instance.") state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } instance := describeOutput.Reservations[0].Instances[0] // Tag the spot instance request (not the eventual spot instance) spotTags, err := TagMap(s.SpotTags).EC2Tags(s.Ctx, *ec2conn.Config.Region, state) if err != nil { err := fmt.Errorf("Error generating tags for spot request: %s", err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } if len(spotTags) > 0 && len(s.SpotTags) > 0 { spotTags.Report(ui) // Use the instance ID to find out the SIR, so that we can tag the spot // request associated with this instance. sir := describeOutput.Reservations[0].Instances[0].SpotInstanceRequestId // Apply tags to the spot request. err = retry.Config{ Tries: 11, ShouldRetry: func(error) bool { return false }, RetryDelay: (&retry.Backoff{InitialBackoff: 200 * time.Millisecond, MaxBackoff: 30 * time.Second, Multiplier: 2}).Linear, }.Run(ctx, func(ctx context.Context) error { _, err := ec2conn.CreateTags(&ec2.CreateTagsInput{ Tags: spotTags, Resources: []*string{sir}, }) return err }) if err != nil { err := fmt.Errorf("Error tagging spot request: %s", err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } } // Retry creating tags for about 2.5 minutes err = retry.Config{Tries: 11, ShouldRetry: func(error) bool { if isAWSErr(err, "InvalidInstanceID.NotFound", "") { return true } return false }, RetryDelay: (&retry.Backoff{InitialBackoff: 200 * time.Millisecond, MaxBackoff: 30 * time.Second, Multiplier: 2}).Linear, }.Run(ctx, func(ctx context.Context) error { _, err := ec2conn.CreateTags(&ec2.CreateTagsInput{ Tags: ec2Tags, Resources: []*string{instance.InstanceId}, }) return err }) if err != nil { err := fmt.Errorf("Error tagging source instance: %s", err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } volumeIds := make([]*string, 0) for _, v := range instance.BlockDeviceMappings { if ebs := v.Ebs; ebs != nil { volumeIds = append(volumeIds, ebs.VolumeId) } } if len(volumeIds) > 0 && len(s.VolumeTags) > 0 { ui.Say("Adding tags to source EBS Volumes") volumeTags, err := TagMap(s.VolumeTags).EC2Tags(s.Ctx, *ec2conn.Config.Region, state) if err != nil { err := fmt.Errorf("Error tagging source EBS Volumes on %s: %s", *instance.InstanceId, err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } volumeTags.Report(ui) _, err = ec2conn.CreateTags(&ec2.CreateTagsInput{ Resources: volumeIds, Tags: volumeTags, }) if err != nil { err := fmt.Errorf("Error tagging source EBS Volumes on %s: %s", *instance.InstanceId, err) state.Put("error", err) ui.Error(err.Error()) return multistep.ActionHalt } } if s.Debug { if instance.PublicDnsName != nil && *instance.PublicDnsName != "" { ui.Message(fmt.Sprintf("Public DNS: %s", *instance.PublicDnsName)) } if instance.PublicIpAddress != nil && *instance.PublicIpAddress != "" { ui.Message(fmt.Sprintf("Public IP: %s", *instance.PublicIpAddress)) } if instance.PrivateIpAddress != nil && *instance.PrivateIpAddress != "" { ui.Message(fmt.Sprintf("Private IP: %s", *instance.PrivateIpAddress)) } } state.Put("instance", instance) // instance_id is the generic term used so that users can have access to the // instance id inside of the provisioners, used in step_provision. state.Put("instance_id", instance.InstanceId) return multistep.ActionContinue } func (s *StepRunSpotInstance) Cleanup(state multistep.StateBag) { ec2conn := state.Get("ec2").(*ec2.EC2) ui := state.Get("ui").(packer.Ui) launchTemplateName := state.Get("launchTemplateName").(string) // Terminate the source instance if it exists if s.instanceId != "" { ui.Say("Terminating the source AWS instance...") if _, err := ec2conn.TerminateInstances(&ec2.TerminateInstancesInput{InstanceIds: []*string{&s.instanceId}}); err != nil { ui.Error(fmt.Sprintf("Error terminating instance, may still be around: %s", err)) return } if err := WaitUntilInstanceTerminated(aws.BackgroundContext(), ec2conn, s.instanceId); err != nil { ui.Error(err.Error()) } } // Delete the launch template used to create the spot fleet deleteInput := &ec2.DeleteLaunchTemplateInput{ LaunchTemplateName: aws.String(launchTemplateName), } if _, err := ec2conn.DeleteLaunchTemplate(deleteInput); err != nil { ui.Error(err.Error()) } }