447 lines
16 KiB
Go
447 lines
16 KiB
Go
//go:generate struct-markdown
|
|
//go:generate mapstructure-to-hcl2 -type Config
|
|
|
|
// The instance package contains a packersdk.Builder implementation that builds
|
|
// AMIs for Amazon EC2 backed by instance storage, as opposed to EBS storage.
|
|
package instance
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/aws/aws-sdk-go/service/ec2"
|
|
"github.com/aws/aws-sdk-go/service/iam"
|
|
"github.com/hashicorp/hcl/v2/hcldec"
|
|
"github.com/hashicorp/packer-plugin-sdk/common"
|
|
"github.com/hashicorp/packer-plugin-sdk/communicator"
|
|
"github.com/hashicorp/packer-plugin-sdk/multistep"
|
|
"github.com/hashicorp/packer-plugin-sdk/multistep/commonsteps"
|
|
packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
|
|
"github.com/hashicorp/packer-plugin-sdk/packerbuilderdata"
|
|
"github.com/hashicorp/packer-plugin-sdk/template/config"
|
|
"github.com/hashicorp/packer-plugin-sdk/template/interpolate"
|
|
awscommon "github.com/hashicorp/packer/builder/amazon/common"
|
|
)
|
|
|
|
// The unique ID for this builder
|
|
const BuilderId = "mitchellh.amazon.instance"
|
|
|
|
// Config is the configuration that is chained through the steps and settable
|
|
// from the template.
|
|
type Config struct {
|
|
common.PackerConfig `mapstructure:",squash"`
|
|
awscommon.AccessConfig `mapstructure:",squash"`
|
|
awscommon.AMIConfig `mapstructure:",squash"`
|
|
awscommon.RunConfig `mapstructure:",squash"`
|
|
|
|
// Add one or more block device mappings to the AMI. These will be attached
|
|
// when booting a new instance from your AMI. To add a block device during
|
|
// the Packer build see `launch_block_device_mappings` below. Your options
|
|
// here may vary depending on the type of VM you use. See the
|
|
// [BlockDevices](#block-devices-configuration) documentation for fields.
|
|
AMIMappings awscommon.BlockDevices `mapstructure:"ami_block_device_mappings" required:"false"`
|
|
// Add one or more block devices before the Packer build starts. If you add
|
|
// instance store volumes or EBS volumes in addition to the root device
|
|
// volume, the created AMI will contain block device mapping information
|
|
// for those volumes. Amazon creates snapshots of the source instance's
|
|
// root volume and any other EBS volumes described here. When you launch an
|
|
// instance from this new AMI, the instance automatically launches with
|
|
// these additional volumes, and will restore them from snapshots taken
|
|
// from the source instance. See the
|
|
// [BlockDevices](#block-devices-configuration) documentation for fields.
|
|
LaunchMappings awscommon.BlockDevices `mapstructure:"launch_block_device_mappings" required:"false"`
|
|
// Your AWS account ID. This is required for bundling the AMI. This is not
|
|
// the same as the access key. You can find your account ID in the security
|
|
// credentials page of your AWS account.
|
|
AccountId string `mapstructure:"account_id" required:"true"`
|
|
// The directory on the running instance where the bundled AMI will be
|
|
// saved prior to uploading. By default this is /tmp. This directory must
|
|
// exist and be writable.
|
|
BundleDestination string `mapstructure:"bundle_destination" required:"false"`
|
|
// The prefix for files created from bundling the root volume. By default
|
|
// this is `image-{{timestamp}}`. The timestamp variable should be used to
|
|
// make sure this is unique, otherwise it can collide with other created
|
|
// AMIs by Packer in your account.
|
|
BundlePrefix string `mapstructure:"bundle_prefix" required:"false"`
|
|
// The command to use to upload the bundled volume. See the "custom bundle
|
|
// commands" section below for more information.
|
|
BundleUploadCommand string `mapstructure:"bundle_upload_command" required:"false"`
|
|
// The command to use to bundle the volume. See the "custom bundle
|
|
// commands" section below for more information.
|
|
BundleVolCommand string `mapstructure:"bundle_vol_command" required:"false"`
|
|
// The name of the S3 bucket to upload the AMI. This bucket will be created
|
|
// if it doesn't exist.
|
|
S3Bucket string `mapstructure:"s3_bucket" required:"true"`
|
|
// The local path to a valid X509 certificate for your AWS account. This is
|
|
// used for bundling the AMI. This X509 certificate must be registered with
|
|
// your account from the security credentials page in the AWS console.
|
|
X509CertPath string `mapstructure:"x509_cert_path" required:"true"`
|
|
// The local path to the private key for the X509 certificate specified by
|
|
// x509_cert_path. This is used for bundling the AMI.
|
|
X509KeyPath string `mapstructure:"x509_key_path" required:"true"`
|
|
// The path on the remote machine where the X509 certificate will be
|
|
// uploaded. This path must already exist and be writable. X509
|
|
// certificates are uploaded after provisioning is run, so it is perfectly
|
|
// okay to create this directory as part of the provisioning process.
|
|
// Defaults to /tmp.
|
|
X509UploadPath string `mapstructure:"x509_upload_path" required:"false"`
|
|
|
|
ctx interpolate.Context
|
|
}
|
|
|
|
type Builder struct {
|
|
config Config
|
|
runner multistep.Runner
|
|
}
|
|
|
|
func (b *Builder) ConfigSpec() hcldec.ObjectSpec { return b.config.FlatMapstructure().HCL2Spec() }
|
|
|
|
func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
|
|
configs := make([]interface{}, len(raws)+1)
|
|
configs[0] = map[string]interface{}{
|
|
"bundle_prefix": "image-{{timestamp}}",
|
|
}
|
|
copy(configs[1:], raws)
|
|
|
|
b.config.ctx.Funcs = awscommon.TemplateFuncs
|
|
err := config.Decode(&b.config, &config.DecodeOpts{
|
|
PluginType: BuilderId,
|
|
Interpolate: true,
|
|
InterpolateContext: &b.config.ctx,
|
|
InterpolateFilter: &interpolate.RenderFilter{
|
|
Exclude: []string{
|
|
"ami_description",
|
|
"bundle_upload_command",
|
|
"bundle_vol_command",
|
|
"run_tags",
|
|
"run_volume_tags",
|
|
"snapshot_tags",
|
|
"tags",
|
|
"spot_tags",
|
|
},
|
|
},
|
|
}, configs...)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
if b.config.PackerConfig.PackerForce {
|
|
b.config.AMIForceDeregister = true
|
|
}
|
|
|
|
if b.config.BundleDestination == "" {
|
|
b.config.BundleDestination = "/tmp"
|
|
}
|
|
|
|
if b.config.BundleUploadCommand == "" {
|
|
if b.config.IamInstanceProfile != "" {
|
|
b.config.BundleUploadCommand = "sudo -i -n ec2-upload-bundle " +
|
|
"-b {{.BucketName}} " +
|
|
"-m {{.ManifestPath}} " +
|
|
"-d {{.BundleDirectory}} " +
|
|
"--batch " +
|
|
"--region {{.Region}} " +
|
|
"--retry"
|
|
} else {
|
|
b.config.BundleUploadCommand = "sudo -i -n ec2-upload-bundle " +
|
|
"-b {{.BucketName}} " +
|
|
"-m {{.ManifestPath}} " +
|
|
"-a {{.AccessKey}} " +
|
|
"-s {{.SecretKey}} " +
|
|
"-d {{.BundleDirectory}} " +
|
|
"--batch " +
|
|
"--region {{.Region}} " +
|
|
"--retry"
|
|
}
|
|
}
|
|
|
|
if b.config.BundleVolCommand == "" {
|
|
b.config.BundleVolCommand = "sudo -i -n ec2-bundle-vol " +
|
|
"-k {{.KeyPath}} " +
|
|
"-u {{.AccountId}} " +
|
|
"-c {{.CertPath}} " +
|
|
"-r {{.Architecture}} " +
|
|
"-e {{.PrivatePath}}/* " +
|
|
"-d {{.Destination}} " +
|
|
"-p {{.Prefix}} " +
|
|
"--batch " +
|
|
"--no-filter"
|
|
}
|
|
|
|
if b.config.X509UploadPath == "" {
|
|
b.config.X509UploadPath = "/tmp"
|
|
}
|
|
|
|
// Accumulate any errors
|
|
var errs *packersdk.MultiError
|
|
var warns []string
|
|
errs = packersdk.MultiErrorAppend(errs, b.config.AccessConfig.Prepare()...)
|
|
errs = packersdk.MultiErrorAppend(errs, b.config.AMIMappings.Prepare(&b.config.ctx)...)
|
|
errs = packersdk.MultiErrorAppend(errs, b.config.LaunchMappings.Prepare(&b.config.ctx)...)
|
|
errs = packersdk.MultiErrorAppend(errs,
|
|
b.config.AMIConfig.Prepare(&b.config.AccessConfig, &b.config.ctx)...)
|
|
errs = packersdk.MultiErrorAppend(errs, b.config.RunConfig.Prepare(&b.config.ctx)...)
|
|
|
|
if b.config.AccountId == "" {
|
|
errs = packersdk.MultiErrorAppend(errs, errors.New("account_id is required"))
|
|
} else {
|
|
b.config.AccountId = strings.Replace(b.config.AccountId, "-", "", -1)
|
|
}
|
|
|
|
if b.config.S3Bucket == "" {
|
|
errs = packersdk.MultiErrorAppend(errs, errors.New("s3_bucket is required"))
|
|
}
|
|
|
|
if b.config.X509CertPath == "" {
|
|
errs = packersdk.MultiErrorAppend(errs, errors.New("x509_cert_path is required"))
|
|
} else if _, err := os.Stat(b.config.X509CertPath); err != nil {
|
|
errs = packersdk.MultiErrorAppend(
|
|
errs, fmt.Errorf("x509_cert_path points to bad file: %s", err))
|
|
}
|
|
|
|
if b.config.X509KeyPath == "" {
|
|
errs = packersdk.MultiErrorAppend(errs, errors.New("x509_key_path is required"))
|
|
} else if _, err := os.Stat(b.config.X509KeyPath); err != nil {
|
|
errs = packersdk.MultiErrorAppend(
|
|
errs, fmt.Errorf("x509_key_path points to bad file: %s", err))
|
|
}
|
|
|
|
if b.config.IsSpotInstance() && ((b.config.AMIENASupport.True()) || b.config.AMISriovNetSupport) {
|
|
errs = packersdk.MultiErrorAppend(errs,
|
|
fmt.Errorf("Spot instances do not support modification, which is required "+
|
|
"when either `ena_support` or `sriov_support` are set. Please ensure "+
|
|
"you use an AMI that already has either SR-IOV or ENA enabled."))
|
|
}
|
|
|
|
if b.config.RunConfig.SpotPriceAutoProduct != "" {
|
|
warns = append(warns, "spot_price_auto_product is deprecated and no "+
|
|
"longer necessary for Packer builds. In future versions of "+
|
|
"Packer, inclusion of spot_price_auto_product will error your "+
|
|
"builds. Please take a look at our current documentation to "+
|
|
"understand how Packer requests Spot instances.")
|
|
}
|
|
|
|
if errs != nil && len(errs.Errors) > 0 {
|
|
return nil, warns, errs
|
|
}
|
|
packersdk.LogSecretFilter.Set(b.config.AccessKey, b.config.SecretKey, b.config.Token)
|
|
|
|
generatedData := awscommon.GetGeneratedDataList()
|
|
return generatedData, warns, nil
|
|
}
|
|
|
|
func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook) (packersdk.Artifact, error) {
|
|
session, err := b.config.Session()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
ec2conn := ec2.New(session)
|
|
iam := iam.New(session)
|
|
|
|
// Setup the state bag and initial state for the steps
|
|
state := new(multistep.BasicStateBag)
|
|
state.Put("config", &b.config)
|
|
state.Put("access_config", &b.config.AccessConfig)
|
|
state.Put("ami_config", &b.config.AMIConfig)
|
|
state.Put("ec2", ec2conn)
|
|
state.Put("iam", iam)
|
|
state.Put("awsSession", session)
|
|
state.Put("hook", hook)
|
|
state.Put("ui", ui)
|
|
generatedData := &packerbuilderdata.GeneratedData{State: state}
|
|
|
|
var instanceStep multistep.Step
|
|
|
|
if b.config.IsSpotInstance() {
|
|
instanceStep = &awscommon.StepRunSpotInstance{
|
|
PollingConfig: b.config.PollingConfig,
|
|
AssociatePublicIpAddress: b.config.AssociatePublicIpAddress,
|
|
LaunchMappings: b.config.LaunchMappings,
|
|
BlockDurationMinutes: b.config.BlockDurationMinutes,
|
|
Ctx: b.config.ctx,
|
|
Comm: &b.config.RunConfig.Comm,
|
|
Debug: b.config.PackerDebug,
|
|
EbsOptimized: b.config.EbsOptimized,
|
|
InstanceType: b.config.InstanceType,
|
|
Region: *ec2conn.Config.Region,
|
|
SourceAMI: b.config.SourceAmi,
|
|
SpotPrice: b.config.SpotPrice,
|
|
SpotInstanceTypes: b.config.SpotInstanceTypes,
|
|
Tags: b.config.RunTags,
|
|
SpotTags: b.config.SpotTags,
|
|
UserData: b.config.UserData,
|
|
UserDataFile: b.config.UserDataFile,
|
|
}
|
|
} else {
|
|
instanceStep = &awscommon.StepRunSourceInstance{
|
|
PollingConfig: b.config.PollingConfig,
|
|
AssociatePublicIpAddress: b.config.AssociatePublicIpAddress,
|
|
LaunchMappings: b.config.LaunchMappings,
|
|
Comm: &b.config.RunConfig.Comm,
|
|
Ctx: b.config.ctx,
|
|
Debug: b.config.PackerDebug,
|
|
EbsOptimized: b.config.EbsOptimized,
|
|
EnableT2Unlimited: b.config.EnableT2Unlimited,
|
|
InstanceType: b.config.InstanceType,
|
|
IsRestricted: b.config.IsChinaCloud() || b.config.IsGovCloud(),
|
|
SourceAMI: b.config.SourceAmi,
|
|
Tags: b.config.RunTags,
|
|
Tenancy: b.config.Tenancy,
|
|
UserData: b.config.UserData,
|
|
UserDataFile: b.config.UserDataFile,
|
|
}
|
|
}
|
|
|
|
// Build the steps
|
|
steps := []multistep.Step{
|
|
&awscommon.StepPreValidate{
|
|
DestAmiName: b.config.AMIName,
|
|
ForceDeregister: b.config.AMIForceDeregister,
|
|
VpcId: b.config.VpcId,
|
|
SubnetId: b.config.SubnetId,
|
|
HasSubnetFilter: !b.config.SubnetFilter.Empty(),
|
|
},
|
|
&awscommon.StepSourceAMIInfo{
|
|
SourceAmi: b.config.SourceAmi,
|
|
EnableAMISriovNetSupport: b.config.AMISriovNetSupport,
|
|
EnableAMIENASupport: b.config.AMIENASupport,
|
|
AmiFilters: b.config.SourceAmiFilter,
|
|
AMIVirtType: b.config.AMIVirtType,
|
|
},
|
|
&awscommon.StepNetworkInfo{
|
|
VpcId: b.config.VpcId,
|
|
VpcFilter: b.config.VpcFilter,
|
|
SecurityGroupIds: b.config.SecurityGroupIds,
|
|
SecurityGroupFilter: b.config.SecurityGroupFilter,
|
|
SubnetId: b.config.SubnetId,
|
|
SubnetFilter: b.config.SubnetFilter,
|
|
AvailabilityZone: b.config.AvailabilityZone,
|
|
},
|
|
&awscommon.StepKeyPair{
|
|
Debug: b.config.PackerDebug,
|
|
Comm: &b.config.RunConfig.Comm,
|
|
DebugKeyPath: fmt.Sprintf("ec2_%s.pem", b.config.PackerBuildName),
|
|
},
|
|
&awscommon.StepSecurityGroup{
|
|
CommConfig: &b.config.RunConfig.Comm,
|
|
SecurityGroupFilter: b.config.SecurityGroupFilter,
|
|
SecurityGroupIds: b.config.SecurityGroupIds,
|
|
TemporarySGSourceCidrs: b.config.TemporarySGSourceCidrs,
|
|
SkipSSHRuleCreation: b.config.SSMAgentEnabled(),
|
|
},
|
|
&awscommon.StepIamInstanceProfile{
|
|
IamInstanceProfile: b.config.IamInstanceProfile,
|
|
SkipProfileValidation: b.config.SkipProfileValidation,
|
|
TemporaryIamInstanceProfilePolicyDocument: b.config.TemporaryIamInstanceProfilePolicyDocument,
|
|
},
|
|
instanceStep,
|
|
&awscommon.StepGetPassword{
|
|
Debug: b.config.PackerDebug,
|
|
Comm: &b.config.RunConfig.Comm,
|
|
Timeout: b.config.WindowsPasswordTimeout,
|
|
BuildName: b.config.PackerBuildName,
|
|
},
|
|
&awscommon.StepCreateSSMTunnel{
|
|
AWSSession: session,
|
|
Region: *ec2conn.Config.Region,
|
|
PauseBeforeSSM: b.config.PauseBeforeSSM,
|
|
LocalPortNumber: b.config.SessionManagerPort,
|
|
RemotePortNumber: b.config.Comm.Port(),
|
|
SSMAgentEnabled: b.config.SSMAgentEnabled(),
|
|
},
|
|
&communicator.StepConnect{
|
|
// StepConnect is provided settings for WinRM and SSH, but
|
|
// the communicator will ultimately determine which port to use.
|
|
Config: &b.config.RunConfig.Comm,
|
|
Host: awscommon.SSHHost(
|
|
ec2conn,
|
|
b.config.SSHInterface,
|
|
b.config.Comm.Host(),
|
|
),
|
|
SSHPort: awscommon.Port(
|
|
b.config.SSHInterface,
|
|
b.config.Comm.Port(),
|
|
),
|
|
SSHConfig: b.config.RunConfig.Comm.SSHConfigFunc(),
|
|
},
|
|
&awscommon.StepSetGeneratedData{
|
|
GeneratedData: generatedData,
|
|
},
|
|
&commonsteps.StepProvision{},
|
|
&commonsteps.StepCleanupTempKeys{
|
|
Comm: &b.config.RunConfig.Comm,
|
|
},
|
|
&StepUploadX509Cert{},
|
|
&StepBundleVolume{
|
|
Debug: b.config.PackerDebug,
|
|
},
|
|
&StepUploadBundle{
|
|
Debug: b.config.PackerDebug,
|
|
},
|
|
&awscommon.StepDeregisterAMI{
|
|
AccessConfig: &b.config.AccessConfig,
|
|
ForceDeregister: b.config.AMIForceDeregister,
|
|
ForceDeleteSnapshot: b.config.AMIForceDeleteSnapshot,
|
|
AMIName: b.config.AMIName,
|
|
Regions: b.config.AMIRegions,
|
|
},
|
|
&StepRegisterAMI{
|
|
EnableAMISriovNetSupport: b.config.AMISriovNetSupport,
|
|
EnableAMIENASupport: b.config.AMIENASupport,
|
|
AMISkipBuildRegion: b.config.AMISkipBuildRegion,
|
|
PollingConfig: b.config.PollingConfig,
|
|
},
|
|
&awscommon.StepAMIRegionCopy{
|
|
AccessConfig: &b.config.AccessConfig,
|
|
Regions: b.config.AMIRegions,
|
|
AMIKmsKeyId: b.config.AMIKmsKeyId,
|
|
RegionKeyIds: b.config.AMIRegionKMSKeyIDs,
|
|
EncryptBootVolume: b.config.AMIEncryptBootVolume,
|
|
Name: b.config.AMIName,
|
|
OriginalRegion: *ec2conn.Config.Region,
|
|
},
|
|
&awscommon.StepModifyAMIAttributes{
|
|
Description: b.config.AMIDescription,
|
|
Users: b.config.AMIUsers,
|
|
Groups: b.config.AMIGroups,
|
|
ProductCodes: b.config.AMIProductCodes,
|
|
SnapshotUsers: b.config.SnapshotUsers,
|
|
SnapshotGroups: b.config.SnapshotGroups,
|
|
Ctx: b.config.ctx,
|
|
GeneratedData: generatedData,
|
|
},
|
|
&awscommon.StepCreateTags{
|
|
Tags: b.config.AMITags,
|
|
SnapshotTags: b.config.SnapshotTags,
|
|
Ctx: b.config.ctx,
|
|
},
|
|
}
|
|
|
|
// Run!
|
|
b.runner = commonsteps.NewRunner(steps, b.config.PackerConfig, ui)
|
|
b.runner.Run(ctx, state)
|
|
|
|
// If there was an error, return that
|
|
if rawErr, ok := state.GetOk("error"); ok {
|
|
return nil, rawErr.(error)
|
|
}
|
|
|
|
// If there are no AMIs, then just return
|
|
if _, ok := state.GetOk("amis"); !ok {
|
|
return nil, nil
|
|
}
|
|
|
|
// Build the artifact and return it
|
|
artifact := &awscommon.Artifact{
|
|
Amis: state.Get("amis").(map[string]string),
|
|
BuilderIdValue: BuilderId,
|
|
Session: session,
|
|
StateData: map[string]interface{}{"generated_data": state.Get("generated_data")},
|
|
}
|
|
|
|
return artifact, nil
|
|
}
|