iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

generate the comments for config struct of builders scraping doc website

This commit is contained in:
Adrien Delorme 2019-05-28 17:50:58 +02:00
parent feafa8b18b
commit f1917edd34
75 changed files with 3097 additions and 846 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
builder/alicloud/ecs/access_config.go
View File

@ -12,11 +12,24 @@ import (
// Config of alicloud // Config of alicloud
type AlicloudAccessConfig struct { type AlicloudAccessConfig struct {
AlicloudAccessKey string `mapstructure:"access_key"` // This is the Alicloud access key. It must be
AlicloudSecretKey string `mapstructure:"secret_key"` // provided, but it can also be sourced from the ALICLOUD_ACCESS_KEY
AlicloudRegion string `mapstructure:"region"` // environment variable.
AlicloudSkipValidation bool `mapstructure:"skip_region_validation"` AlicloudAccessKey string `mapstructure:"access_key" required:"true"`
SecurityToken string `mapstructure:"security_token"` // This is the Alicloud secret key. It must be
// provided, but it can also be sourced from the ALICLOUD_SECRET_KEY
// environment variable.
AlicloudSecretKey string `mapstructure:"secret_key" required:"true"`
// This is the Alicloud region. It must be provided, but
// it can also be sourced from the ALICLOUD_REGION environment variables.
AlicloudRegion string `mapstructure:"region" required:"true"`
// The region validation can be skipped
// if this value is true, the default value is false.
AlicloudSkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
// STS access token, can be set through template
// or by exporting as environment variable such as
// export SecurityToken=value.
SecurityToken string `mapstructure:"security_token" required:"false"`
client *ClientWrapper client *ClientWrapper
} }

119
builder/alicloud/ecs/image_config.go
View File

@ -9,36 +9,111 @@ import (
) )
type AlicloudDiskDevice struct { type AlicloudDiskDevice struct {
DiskName string `mapstructure:"disk_name"` // The value of disk name is blank by default. [2,
DiskCategory string `mapstructure:"disk_category"` // 128] English or Chinese characters, must begin with an
DiskSize int `mapstructure:"disk_size"` // uppercase/lowercase letter or Chinese character. Can contain numbers,
SnapshotId string `mapstructure:"disk_snapshot_id"` // ., _ and -. The disk name will appear on the console. It cannot
Description string `mapstructure:"disk_description"` // begin with http:// or https://.
DeleteWithInstance bool `mapstructure:"disk_delete_with_instance"` DiskName string `mapstructure:"disk_name" required:"false"`
Device string `mapstructure:"disk_device"` // Category of the system disk. Optional values
Encrypted *bool `mapstructure:"disk_encrypted"` // are:
// - cloud - general cloud disk
// - cloud_efficiency - efficiency cloud disk
// - cloud_ssd - cloud SSD
DiskCategory string `mapstructure:"disk_category" required:"false"`
// Size of the system disk, measured in GiB. Value
// range: [20, 500]. The specified value must be equal to or greater
// than max{20, ImageSize}. Default value: max{40, ImageSize}.
DiskSize int `mapstructure:"disk_size" required:"false"`
// Snapshots are used to create the data
// disk After this parameter is specified, Size is ignored. The actual
// size of the created disk is the size of the specified snapshot.
SnapshotId string `mapstructure:"disk_snapshot_id" required:"false"`
// The value of disk description is blank by
// default. [2, 256] characters. The disk description will appear on the
// console. It cannot begin with http:// or https://.
Description string `mapstructure:"disk_description" required:"false"`
// Whether or not the disk is
// released along with the instance:
DeleteWithInstance bool `mapstructure:"disk_delete_with_instance" required:"false"`
// Device information of the related instance:
// such as /dev/xvdb It is null unless the Status is In_use.
Device string `mapstructure:"disk_device" required:"false"`
// Whether or not to encrypt the data disk.
// If this option is set to true, the data disk will be encryped and corresponding snapshot in the target image will also be encrypted. By
// default, if this is an extra data disk, Packer will not encrypt the
// data disk. Otherwise, Packer will keep the encryption setting to what
// it was in the source image. Please refer to Introduction of ECS disk encryption
// for more details.
Encrypted *bool `mapstructure:"disk_encrypted" required:"false"`
} }
type AlicloudDiskDevices struct { type AlicloudDiskDevices struct {
ECSSystemDiskMapping AlicloudDiskDevice `mapstructure:"system_disk_mapping"` // Image disk mapping for system
ECSImagesDiskMappings []AlicloudDiskDevice `mapstructure:"image_disk_mappings"` // disk.
ECSSystemDiskMapping AlicloudDiskDevice `mapstructure:"system_disk_mapping" required:"false"`
// Add one or more data
// disks to the image.
ECSImagesDiskMappings []AlicloudDiskDevice `mapstructure:"image_disk_mappings" required:"false"`
} }
type AlicloudImageConfig struct { type AlicloudImageConfig struct {
AlicloudImageName string `mapstructure:"image_name"` // The name of the user-defined image, [2, 128]
AlicloudImageVersion string `mapstructure:"image_version"` // English or Chinese characters. It must begin with an uppercase/lowercase
AlicloudImageDescription string `mapstructure:"image_description"` // letter or a Chinese character, and may contain numbers, _ or -. It
AlicloudImageShareAccounts []string `mapstructure:"image_share_account"` // cannot begin with http:// or https://.
AlicloudImageName string `mapstructure:"image_name" required:"true"`
// The version number of the image, with a length
// limit of 1 to 40 English characters.
AlicloudImageVersion string `mapstructure:"image_version" required:"false"`
// The description of the image, with a length
// limit of 0 to 256 characters. Leaving it blank means null, which is the
// default value. It cannot begin with http:// or https://.
AlicloudImageDescription string `mapstructure:"image_description" required:"false"`
// The IDs of to-be-added Aliyun
// accounts to which the image is shared. The number of accounts is 1 to 10.
// If number of accounts is greater than 10, this parameter is ignored.
AlicloudImageShareAccounts []string `mapstructure:"image_share_account" required:"false"`
AlicloudImageUNShareAccounts []string `mapstructure:"image_unshare_account"` AlicloudImageUNShareAccounts []string `mapstructure:"image_unshare_account"`
AlicloudImageDestinationRegions []string `mapstructure:"image_copy_regions"` // Copy to the destination regionIds.
AlicloudImageDestinationNames []string `mapstructure:"image_copy_names"` AlicloudImageDestinationRegions []string `mapstructure:"image_copy_regions" required:"false"`
ImageEncrypted *bool `mapstructure:"image_encrypted"` // The name of the destination image,
AlicloudImageForceDelete bool `mapstructure:"image_force_delete"` // [2, 128] English or Chinese characters. It must begin with an
AlicloudImageForceDeleteSnapshots bool `mapstructure:"image_force_delete_snapshots"` // uppercase/lowercase letter or a Chinese character, and may contain numbers,
// _ or -. It cannot begin with http:// or https://.
AlicloudImageDestinationNames []string `mapstructure:"image_copy_names" required:"false"`
// Whether or not to encrypt the target images, including those copied if image_copy_regions is specified. If this option
// is set to true, a temporary image will be created from the provisioned
// instance in the main region and an encrypted copy will be generated in the
// same region. By default, Packer will keep the encryption setting to what
// it was in the source image.
ImageEncrypted *bool `mapstructure:"image_encrypted" required:"false"`
// If this value is true, when the target
// image names including those copied are duplicated with existing images, it
// will delete the existing images and then create the target images,
// otherwise, the creation will fail. The default value is false. Check
// image_name and image_copy_names options for names of target images. If
// -force option is
// provided in build command, this option can be omitted and taken as true.
AlicloudImageForceDelete bool `mapstructure:"image_force_delete" required:"false"`
// If this value is true, when
// delete the duplicated existing images, the source snapshots of those images
// will be delete either. If
// -force option is
// provided in build command, this option can be omitted and taken as true.
AlicloudImageForceDeleteSnapshots bool `mapstructure:"image_force_delete_snapshots" required:"false"`
AlicloudImageForceDeleteInstances bool `mapstructure:"image_force_delete_instances"` AlicloudImageForceDeleteInstances bool `mapstructure:"image_force_delete_instances"`
AlicloudImageIgnoreDataDisks bool `mapstructure:"image_ignore_data_disks"` // If this value is true, the image
AlicloudImageSkipRegionValidation bool `mapstructure:"skip_region_validation"` // created will not include any snapshot of data disks. This option would be
AlicloudImageTags map[string]string `mapstructure:"tags"` // useful for any circumstance that default data disks with instance types are
// not concerned. The default value is false.
AlicloudImageIgnoreDataDisks bool `mapstructure:"image_ignore_data_disks" required:"false"`
// The region validation can be skipped
// if this value is true, the default value is false.
AlicloudImageSkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"`
// Tags applied to the destination
// image and relevant snapshots.
AlicloudImageTags map[string]string `mapstructure:"tags" required:"false"`
AlicloudDiskDevices `mapstructure:",squash"` AlicloudDiskDevices `mapstructure:",squash"`
} }

105
builder/alicloud/ecs/run_config.go
View File

@ -13,30 +13,95 @@ import (
type RunConfig struct { type RunConfig struct {
AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address"` AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address"`
ZoneId string `mapstructure:"zone_id"` // ID of the zone to which the disk belongs.
IOOptimized bool `mapstructure:"io_optimized"` ZoneId string `mapstructure:"zone_id" required:"false"`
InstanceType string `mapstructure:"instance_type"` // Whether an ECS instance is I/O optimized or not.
// The default value is false.
IOOptimized bool `mapstructure:"io_optimized" required:"false"`
// Type of the instance. For values, see Instance
// Type
// Table.
// You can also obtain the latest instance type table by invoking the
// Querying Instance Type
// Table
// interface.
InstanceType string `mapstructure:"instance_type" required:"true"`
Description string `mapstructure:"description"` Description string `mapstructure:"description"`
AlicloudSourceImage string `mapstructure:"source_image"` // This is the base image id which you want to
ForceStopInstance bool `mapstructure:"force_stop_instance"` // create your customized images.
DisableStopInstance bool `mapstructure:"disable_stop_instance"` AlicloudSourceImage string `mapstructure:"source_image" required:"true"`
SecurityGroupId string `mapstructure:"security_group_id"` // Whether to force shutdown upon device
SecurityGroupName string `mapstructure:"security_group_name"` // restart. The default value is false.
UserData string `mapstructure:"user_data"` ForceStopInstance bool `mapstructure:"force_stop_instance" required:"false"`
UserDataFile string `mapstructure:"user_data_file"` // If this option is set to true, Packer
VpcId string `mapstructure:"vpc_id"` // will not stop the instance for you, and you need to make sure the instance
VpcName string `mapstructure:"vpc_name"` // will be stopped in the final provisioner command. Otherwise, Packer will
CidrBlock string `mapstructure:"vpc_cidr_block"` // timeout while waiting the instance to be stopped. This option is provided
VSwitchId string `mapstructure:"vswitch_id"` // for some specific scenarios that you want to stop the instance by yourself.
VSwitchName string `mapstructure:"vswitch_id"` // E.g., Sysprep a windows which may shutdown the instance within its command.
InstanceName string `mapstructure:"instance_name"` // The default value is false.
InternetChargeType string `mapstructure:"internet_charge_type"` DisableStopInstance bool `mapstructure:"disable_stop_instance" required:"false"`
InternetMaxBandwidthOut int `mapstructure:"internet_max_bandwidth_out"` // ID of the security group to which a newly
WaitSnapshotReadyTimeout int `mapstructure:"wait_snapshot_ready_timeout"` // created instance belongs. Mutual access is allowed between instances in one
// security group. If not specified, the newly created instance will be added
// to the default security group. If the default group doesn’t exist, or the
// number of instances in it has reached the maximum limit, a new security
// group will be created automatically.
SecurityGroupId string `mapstructure:"security_group_id" required:"false"`
// The security group name. The default value
// is blank. [2, 128] English or Chinese characters, must begin with an
// uppercase/lowercase letter or Chinese character. Can contain numbers, .,
// _ or -. It cannot begin with http:// or https://.
SecurityGroupName string `mapstructure:"security_group_name" required:"false"`
// User data to apply when launching the instance. Note
// that you need to be careful about escaping characters due to the templates
// being JSON. It is often more convenient to use user_data_file, instead.
// Packer will not automatically wait for a user script to finish before
// shutting down the instance this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the instance.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// VPC ID allocated by the system.
VpcId string `mapstructure:"vpc_id" required:"false"`
// The VPC name. The default value is blank. [2, 128]
// English or Chinese characters, must begin with an uppercase/lowercase
// letter or Chinese character. Can contain numbers, _ and -. The disk
// description will appear on the console. Cannot begin with http:// or
// https://.
VpcName string `mapstructure:"vpc_name" required:"false"`
// Value options: 192.168.0.0/16 and
// 172.16.0.0/16. When not specified, the default value is 172.16.0.0/16.
CidrBlock string `mapstructure:"vpc_cidr_block" required:"false"`
// The ID of the VSwitch to be used.
VSwitchId string `mapstructure:"vswitch_id" required:"false"`
// The ID of the VSwitch to be used.
VSwitchName string `mapstructure:"vswitch_id" required:"false"`
// Display name of the instance, which is a string
// of 2 to 128 Chinese or English characters. It must begin with an
// uppercase/lowercase letter or a Chinese character and can contain numerals,
// ., _, or -. The instance name is displayed on the Alibaba Cloud
// console. If this parameter is not specified, the default value is
// InstanceId of the instance. It cannot begin with http:// or https://.
InstanceName string `mapstructure:"instance_name" required:"false"`
// Internet charge type, which can be
// PayByTraffic or PayByBandwidth. Optional values:
InternetChargeType string `mapstructure:"internet_charge_type" required:"false"`
// Maximum outgoing bandwidth to the
// public network, measured in Mbps (Mega bits per second).
InternetMaxBandwidthOut int `mapstructure:"internet_max_bandwidth_out" required:"false"`
// Timeout of creating snapshot(s).
// The default timeout is 3600 seconds if this option is not set or is set
// to 0. For those disks containing lots of data, it may require a higher
// timeout value.
WaitSnapshotReadyTimeout int `mapstructure:"wait_snapshot_ready_timeout" required:"false"`
// Communicator settings // Communicator settings
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
SSHPrivateIp bool `mapstructure:"ssh_private_ip"` // If this value is true, packer will connect to
// the ECS created through private ip instead of allocating a public ip or an
// EIP. The default value is false.
SSHPrivateIp bool `mapstructure:"ssh_private_ip" required:"false"`
} }
func (c *RunConfig) Prepare(ctx *interpolate.Context) []error { func (c *RunConfig) Prepare(ctx *interpolate.Context) []error {

113
builder/amazon/chroot/builder.go
View File

@ -28,25 +28,100 @@ type Config struct {
awscommon.AMIBlockDevices `mapstructure:",squash"` awscommon.AMIBlockDevices `mapstructure:",squash"`
awscommon.AMIConfig `mapstructure:",squash"` awscommon.AMIConfig `mapstructure:",squash"`
awscommon.AccessConfig `mapstructure:",squash"` awscommon.AccessConfig `mapstructure:",squash"`
// This is a list of devices to
ChrootMounts [][]string `mapstructure:"chroot_mounts"` // mount into the chroot environment. This configuration parameter requires
CommandWrapper string `mapstructure:"command_wrapper"` // some additional documentation which is in the Chroot
CopyFiles []string `mapstructure:"copy_files"` // Mounts section. Please read that section for more
DevicePath string `mapstructure:"device_path"` // information on how to use this.
NVMEDevicePath string `mapstructure:"nvme_device_path"` ChrootMounts [][]string `mapstructure:"chroot_mounts" required:"false"`
FromScratch bool `mapstructure:"from_scratch"` // How to run shell commands. This defaults to
MountOptions []string `mapstructure:"mount_options"` // {{.Command}}. This may be useful to set if you want to set environmental
MountPartition string `mapstructure:"mount_partition"` // variables or perhaps run it with sudo or so on. This is a configuration
MountPath string `mapstructure:"mount_path"` // template where the .Command variable is replaced with the command to be
PostMountCommands []string `mapstructure:"post_mount_commands"` // run. Defaults to {{.Command}}.
PreMountCommands []string `mapstructure:"pre_mount_commands"` CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
RootDeviceName string `mapstructure:"root_device_name"` // Paths to files on the running EC2
RootVolumeSize int64 `mapstructure:"root_volume_size"` // instance that will be copied into the chroot environment prior to
RootVolumeType string `mapstructure:"root_volume_type"` // provisioning. Defaults to /etc/resolv.conf so that DNS lookups work. Pass
SourceAmi string `mapstructure:"source_ami"` // an empty list to skip copying /etc/resolv.conf. You may need to do this
SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter"` // if you're building an image that uses systemd.
RootVolumeTags awscommon.TagMap `mapstructure:"root_volume_tags"` CopyFiles []string `mapstructure:"copy_files" required:"false"`
Architecture string `mapstructure:"ami_architecture"` // The path to the device where the root volume of
// the source AMI will be attached. This defaults to "" (empty string), which
// forces Packer to find an open device automatically.
DevicePath string `mapstructure:"device_path" required:"false"`
// When we call the mount command (by default
// mount -o device dir), the string provided in nvme_mount_path will
// replace device in that command. When this option is not set, device in
// that command will be something like /dev/sdf1, mirroring the attached
// device name. This assumption works for most instances but will fail with c5
// and m5 instances. In order to use the chroot builder with c5 and m5
// instances, you must manually set nvme_device_path and device_path.
NVMEDevicePath string `mapstructure:"nvme_device_path" required:"false"`
// Build a new volume instead of starting from an
// existing AMI root volume snapshot. Default false. If true, source_ami
// is no longer used and the following options become required:
// ami_virtualization_type, pre_mount_commands and root_volume_size. The
// below options are also required in this mode only:
FromScratch bool `mapstructure:"from_scratch" required:"false"`
// Options to supply the mount command
// when mounting devices. Each option will be prefixed with -o and supplied
// to the mount command ran by Packer. Because this command is ran in a
// shell, user discretion is advised. See this manual page for the mount
// command for valid file
// system specific options.
MountOptions []string `mapstructure:"mount_options" required:"false"`
// The partition number containing the /
// partition. By default this is the first partition of the volume, (for
// example, xvda1) but you can designate the entire block device by setting
// "mount_partition": "0" in your config, which will mount xvda instead.
MountPartition string `mapstructure:"mount_partition" required:"false"`
// The path where the volume will be mounted. This is
// where the chroot environment will be. This defaults to
// /mnt/packer-amazon-chroot-volumes/{{.Device}}. This is a configuration
// template where the .Device variable is replaced with the name of the
// device where the volume is attached.
MountPath string `mapstructure:"mount_path" required:"false"`
// As pre_mount_commands, but the
// commands are executed after mounting the root device and before the extra
// mount and copy steps. The device and mount path are provided by
// {{.Device}} and {{.MountPath}}.
PostMountCommands []string `mapstructure:"post_mount_commands" required:"false"`
// A series of commands to execute
// after attaching the root volume and before mounting the chroot. This is not
// required unless using from_scratch. If so, this should include any
// partitioning and filesystem creation commands. The path to the device is
// provided by {{.Device}}.
PreMountCommands []string `mapstructure:"pre_mount_commands" required:"false"`
// The root device name. For example, xvda.
RootDeviceName string `mapstructure:"root_device_name" required:"false"`
// The size of the root volume in GB for the
// chroot environment and the resulting AMI. Default size is the snapshot size
// of the source_ami unless from_scratch is true, in which case this
// field must be defined.
RootVolumeSize int64 `mapstructure:"root_volume_size" required:"false"`
// The type of EBS volume for the chroot
// environment and resulting AMI. The default value is the type of the
// source_ami, unless from_scratch is true, in which case the default
// value is gp2. You can only specify io1 if building based on top of a
// source_ami which is also io1.
RootVolumeType string `mapstructure:"root_volume_type" required:"false"`
// The source AMI whose root volume will be copied and
// provisioned on the currently running instance. This must be an EBS-backed
// AMI with a root volume snapshot that you have access to. Note: this is not
// used when from_scratch is set to true.
SourceAmi string `mapstructure:"source_ami" required:"true"`
// Filters used to populate the source_ami
// field. Example:
SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"`
// Tags to apply to the
// volumes that are launched. This is a template
// engine, see Build template
// data for more information.
RootVolumeTags awscommon.TagMap `mapstructure:"root_volume_tags" required:"false"`
// what architecture to use when registering the
// final AMI; valid options are "x86_64" or "arm64". Defaults to "x86_64".
Architecture string `mapstructure:"ami_architecture" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

69
builder/amazon/common/access_config.go
View File

@ -21,7 +21,16 @@ import (
type VaultAWSEngineOptions struct { type VaultAWSEngineOptions struct {
Name string `mapstructure:"name"` Name string `mapstructure:"name"`
RoleARN string `mapstructure:"role_arn"` RoleARN string `mapstructure:"role_arn"`
TTL string `mapstructure:"ttl"` // Specifies the TTL for the use of the STS token. This
// is specified as a string with a duration suffix. Valid only when
// credential_type is assumed_role or federation_token. When not
// specified, the default_sts_ttl set for the role will be used. If that
// is also not set, then the default value of 3600s will be used. AWS
// places limits on the maximum TTL allowed. See the AWS documentation on
// the DurationSeconds parameter for AssumeRole (for assumed_role
// credential types) and GetFederationToken (for federation_token
// credential types) for more details.
TTL string `mapstructure:"ttl" required:"false"`
EngineName string `mapstructure:"engine_name"` EngineName string `mapstructure:"engine_name"`
} }
@ -32,19 +41,55 @@ func (v *VaultAWSEngineOptions) Empty() bool {
// AccessConfig is for common configuration related to AWS access // AccessConfig is for common configuration related to AWS access
type AccessConfig struct { type AccessConfig struct {
AccessKey string `mapstructure:"access_key"` // The access key used to communicate with AWS. Learn
CustomEndpointEc2 string `mapstructure:"custom_endpoint_ec2"` // how to set this
DecodeAuthZMessages bool `mapstructure:"decode_authorization_messages"` AccessKey string `mapstructure:"access_key" required:"true"`
InsecureSkipTLSVerify bool `mapstructure:"insecure_skip_tls_verify"` // This option is useful if you use a cloud
MFACode string `mapstructure:"mfa_code"` // provider whose API is compatible with aws EC2. Specify another endpoint
ProfileName string `mapstructure:"profile"` // like this https://ec2.custom.endpoint.com.
RawRegion string `mapstructure:"region"` CustomEndpointEc2 string `mapstructure:"custom_endpoint_ec2" required:"false"`
SecretKey string `mapstructure:"secret_key"` // Enable automatic decoding of
SkipValidation bool `mapstructure:"skip_region_validation"` // any encoded authorization (error) messages using the
// sts:DecodeAuthorizationMessage API. Note: requires that the effective
// user/role have permissions to sts:DecodeAuthorizationMessage on resource
// *. Default false.
DecodeAuthZMessages bool `mapstructure:"decode_authorization_messages" required:"false"`
// This allows skipping TLS
// verification of the AWS EC2 endpoint. The default is false.
InsecureSkipTLSVerify bool `mapstructure:"insecure_skip_tls_verify" required:"false"`
// The MFA
// TOTP
// code. This should probably be a user variable since it changes all the
// time.
MFACode string `mapstructure:"mfa_code" required:"false"`
// The profile to use in the shared credentials file for
// AWS. See Amazon's documentation on specifying
// profiles
// for more details.
ProfileName string `mapstructure:"profile" required:"false"`
// The name of the region, such as us-east-1, in which
// to launch the EC2 instance to create the AMI.
RawRegion string `mapstructure:"region" required:"true"`
// The secret key used to communicate with AWS. Learn
// how to set this
SecretKey string `mapstructure:"secret_key" required:"true"`
// Set to true if you want to skip
// validation of the ami_regions configuration option. Default false.
SkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
SkipMetadataApiCheck bool `mapstructure:"skip_metadata_api_check"` SkipMetadataApiCheck bool `mapstructure:"skip_metadata_api_check"`
Token string `mapstructure:"token"` // The access token to use. This is different from the
// access key and secret key. If you're not sure what this is, then you
// probably don't need it. This will also be read from the AWS_SESSION_TOKEN
// environmental variable.
Token string `mapstructure:"token" required:"false"`
session *session.Session session *session.Session
VaultAWSEngine VaultAWSEngineOptions `mapstructure:"vault_aws_engine"` // Get credentials from Hashicorp Vault's aws
// secrets engine. You must already have created a role to use. For more
// information about generating credentials via the Vault engine, see the
// Vault
// docs.
// If you set this flag, you must also set the below options:
VaultAWSEngine VaultAWSEngineOptions `mapstructure:"vault_aws_engine" required:"false"`
getEC2Connection func() ec2iface.EC2API getEC2Connection func() ec2iface.EC2API
} }

120
builder/amazon/common/ami_config.go
View File

@ -10,25 +10,107 @@ import (
// AMIConfig is for common configuration related to creating AMIs. // AMIConfig is for common configuration related to creating AMIs.
type AMIConfig struct { type AMIConfig struct {
AMIName string `mapstructure:"ami_name"` // The name of the resulting AMI that will appear when
AMIDescription string `mapstructure:"ami_description"` // managing AMIs in the AWS console or via APIs. This must be unique. To help
AMIVirtType string `mapstructure:"ami_virtualization_type"` // make this unique, use a function like timestamp (see template
AMIUsers []string `mapstructure:"ami_users"` // engine for more info).
AMIGroups []string `mapstructure:"ami_groups"` AMIName string `mapstructure:"ami_name" required:"true"`
AMIProductCodes []string `mapstructure:"ami_product_codes"` // The description to set for the resulting
AMIRegions []string `mapstructure:"ami_regions"` // AMI(s). By default this description is empty. This is a template
AMISkipRegionValidation bool `mapstructure:"skip_region_validation"` // engine, see Build template
AMITags TagMap `mapstructure:"tags"` // data for more information.
AMIENASupport *bool `mapstructure:"ena_support"` AMIDescription string `mapstructure:"ami_description" required:"false"`
AMISriovNetSupport bool `mapstructure:"sriov_support"` // The type of virtualization for the AMI
AMIForceDeregister bool `mapstructure:"force_deregister"` // you are building. This option is required to register HVM images. Can be
AMIForceDeleteSnapshot bool `mapstructure:"force_delete_snapshot"` // paravirtual (default) or hvm.
AMIEncryptBootVolume *bool `mapstructure:"encrypt_boot"` AMIVirtType string `mapstructure:"ami_virtualization_type" required:"false"`
AMIKmsKeyId string `mapstructure:"kms_key_id"` // A list of account IDs that have access to
AMIRegionKMSKeyIDs map[string]string `mapstructure:"region_kms_key_ids"` // launch the resulting AMI(s). By default no additional users other than the
SnapshotTags TagMap `mapstructure:"snapshot_tags"` // user creating the AMI has permissions to launch it.
SnapshotUsers []string `mapstructure:"snapshot_users"` AMIUsers []string `mapstructure:"ami_users" required:"false"`
SnapshotGroups []string `mapstructure:"snapshot_groups"` // A list of groups that have access to
// launch the resulting AMI(s). By default no groups have permission to launch
// the AMI. all will make the AMI publicly accessible.
AMIGroups []string `mapstructure:"ami_groups" required:"false"`
// A list of product codes to
// associate with the AMI. By default no product codes are associated with the
// AMI.
AMIProductCodes []string `mapstructure:"ami_product_codes" required:"false"`
// A list of regions to copy the AMI to.
// Tags and attributes are copied along with the AMI. AMI copying takes time
// depending on the size of the AMI, but will generally take many minutes.
AMIRegions []string `mapstructure:"ami_regions" required:"false"`
// Set to true if you want to skip
// validation of the ami_regions configuration option. Default false.
AMISkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"`
// Tags applied to the AMI. This is a
// template engine, see Build template
// data for more information.
AMITags TagMap `mapstructure:"tags" required:"false"`
// Enable enhanced networking (ENA but not
// SriovNetSupport) on HVM-compatible AMIs. If set, add
// ec2:ModifyInstanceAttribute to your AWS IAM policy. If false, this will
// disable enhanced networking in the final AMI as opposed to passing the
// setting through unchanged from the source. Note: you must make sure
// enhanced networking is enabled on your instance. See Amazon's
// documentation on enabling enhanced
// networking.
AMIENASupport *bool `mapstructure:"ena_support" required:"false"`
// Enable enhanced networking (SriovNetSupport but
// not ENA) on HVM-compatible AMIs. If true, add
// ec2:ModifyInstanceAttribute to your AWS IAM policy. Note: you must make
// sure enhanced networking is enabled on your instance. See Amazon's
// documentation on enabling enhanced
// networking.
// Default false.
AMISriovNetSupport bool `mapstructure:"sriov_support" required:"false"`
// Force Packer to first deregister an existing
// AMI if one with the same name already exists. Default false.
AMIForceDeregister bool `mapstructure:"force_deregister" required:"false"`
// Force Packer to delete snapshots
// associated with AMIs, which have been deregistered by force_deregister.
// Default false.
AMIForceDeleteSnapshot bool `mapstructure:"force_delete_snapshot" required:"false"`
// Whether or not to encrypt the resulting AMI when
// copying a provisioned instance to an AMI. By default, Packer will keep the
// encryption setting to what it was in the source image. Setting false will
// result in an unencrypted image, and true will result in an encrypted one.
AMIEncryptBootVolume *bool `mapstructure:"encrypt_boot" required:"false"`
// ID, alias or ARN of the KMS key to use for boot
// volume encryption. This only applies to the main region, other regions
// where the AMI will be copied will be encrypted by the default EBS KMS key.
// For valid formats see KmsKeyId in the AWS API docs -
// CopyImage.
// This field is validated by Packer, when using an alias, you will have to
// prefix kms_key_id with alias/.
AMIKmsKeyId string `mapstructure:"kms_key_id" required:"false"`
// a map of regions to copy the ami
// to, along with the custom kms key id (alias or arn) to use for encryption
// for that region. Keys must match the regions provided in ami_regions. If
// you just want to encrypt using a default ID, you can stick with
// kms_key_id and ami_regions. If you want a region to be encrypted with
// that region's default key ID, you can use an empty string "" instead of a
// key id in this map. (e.g. "us-east-1": "") However, you cannot use
// default key IDs if you are using this in conjunction with snapshot_users
// -- in that situation you must use custom keys. For valid formats see
// KmsKeyId in the AWS API docs -
// CopyImage.
AMIRegionKMSKeyIDs map[string]string `mapstructure:"region_kms_key_ids" required:"false"`
// Tags to apply to snapshot.
// They will override AMI tags if already applied to snapshot. This is a
// template engine, see Build template
// data for more information.
SnapshotTags TagMap `mapstructure:"snapshot_tags" required:"false"`
// A list of account IDs that have
// access to create volumes from the snapshot(s). By default no additional
// users other than the user creating the AMI has permissions to create
// volumes from the backing snapshot(s).
SnapshotUsers []string `mapstructure:"snapshot_users" required:"false"`
// A list of groups that have access to
// create volumes from the snapshot(s). By default no groups have permission
// to create volumes from the snapshot(s). all will make the snapshot
// publicly accessible.
SnapshotGroups []string `mapstructure:"snapshot_groups" required:"false"`
} }
func stringInSlice(s []string, searchstr string) bool { func stringInSlice(s []string, searchstr string) bool {

77
builder/amazon/common/block_device.go
View File

@ -11,16 +11,52 @@ import (
// BlockDevice // BlockDevice
type BlockDevice struct { type BlockDevice struct {
DeleteOnTermination bool `mapstructure:"delete_on_termination"` // Indicates whether the EBS volume is
DeviceName string `mapstructure:"device_name"` // deleted on instance termination. Default false. NOTE: If this
Encrypted *bool `mapstructure:"encrypted"` // value is not explicitly set to true and volumes are not cleaned up by
IOPS int64 `mapstructure:"iops"` // an alternative method, additional volumes will accumulate after every
NoDevice bool `mapstructure:"no_device"` // build.
SnapshotId string `mapstructure:"snapshot_id"` DeleteOnTermination bool `mapstructure:"delete_on_termination" required:"false"`
VirtualName string `mapstructure:"virtual_name"` // The device name exposed to the instance (for
VolumeType string `mapstructure:"volume_type"` // example, /dev/sdh or xvdh). Required for every device in the block
VolumeSize int64 `mapstructure:"volume_size"` // device mapping.
KmsKeyId string `mapstructure:"kms_key_id"` DeviceName string `mapstructure:"device_name" required:"false"`
// Indicates whether or not to encrypt the volume.
// By default, Packer will keep the encryption setting to what it was in
// the source image. Setting false will result in an unencrypted device,
// and true will result in an encrypted one.
Encrypted *bool `mapstructure:"encrypted" required:"false"`
// The number of I/O operations per second (IOPS) that
// the volume supports. See the documentation on
// IOPs
// for more information
IOPS int64 `mapstructure:"iops" required:"false"`
// Suppresses the specified device included in the
// block device mapping of the AMI.
NoDevice bool `mapstructure:"no_device" required:"false"`
// The ID of the snapshot.
SnapshotId string `mapstructure:"snapshot_id" required:"false"`
// The virtual device name. See the
// documentation on Block Device
// Mapping
// for more information.
VirtualName string `mapstructure:"virtual_name" required:"false"`
// The volume type. gp2 for General Purpose
// (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for
// Throughput Optimized HDD, sc1 for Cold HDD, and standard for
// Magnetic volumes.
VolumeType string `mapstructure:"volume_type" required:"false"`
// The size of the volume, in GiB. Required if
// not specifying a snapshot_id.
VolumeSize int64 `mapstructure:"volume_size" required:"false"`
// ID, alias or ARN of the KMS key to use for boot
// volume encryption. This only applies to the main region, other regions
// where the AMI will be copied will be encrypted by the default EBS KMS key.
// For valid formats see KmsKeyId in the AWS API docs -
// CopyImage.
// This field is validated by Packer, when using an alias, you will have to
// prefix kms_key_id with alias/.
KmsKeyId string `mapstructure:"kms_key_id" required:"false"`
// ebssurrogate only // ebssurrogate only
OmitFromArtifact bool `mapstructure:"omit_from_artifact"` OmitFromArtifact bool `mapstructure:"omit_from_artifact"`
} }
@ -31,11 +67,28 @@ type BlockDevices struct {
} }
type AMIBlockDevices struct { type AMIBlockDevices struct {
AMIMappings []BlockDevice `mapstructure:"ami_block_device_mappings"` // Add one or
// more block device
// mappings
// to the AMI. These will be attached when booting a new instance from your
// AMI. If this field is populated, and you are building from an existing source image,
// the block device mappings in the source image will be overwritten. This means you
// must have a block device mapping entry for your root volume, root_volume_size,
// and root_device_name. `Your options here may vary depending on the type of VM
// you use. The block device mappings allow for the following configuration:
AMIMappings []BlockDevice `mapstructure:"ami_block_device_mappings" required:"false"`
} }
type LaunchBlockDevices struct { type LaunchBlockDevices struct {
LaunchMappings []BlockDevice `mapstructure:"launch_block_device_mappings"` // 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.
LaunchMappings []BlockDevice `mapstructure:"launch_block_device_mappings" required:"false"`
} }
func buildBlockDevices(b []BlockDevice) []*ec2.BlockDeviceMapping { func buildBlockDevices(b []BlockDevice) []*ec2.BlockDeviceMapping {

170
builder/amazon/common/run_config.go
View File

@ -58,34 +58,148 @@ func (d *SecurityGroupFilterOptions) Empty() bool {
// RunConfig contains configuration for running an instance from a source // RunConfig contains configuration for running an instance from a source
// AMI and details on how to access that launched image. // AMI and details on how to access that launched image.
type RunConfig struct { type RunConfig struct {
AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address"` // If using a non-default VPC,
AvailabilityZone string `mapstructure:"availability_zone"` // public IP addresses are not provided by default. If this is true, your
BlockDurationMinutes int64 `mapstructure:"block_duration_minutes"` // new instance will get a Public IP. default: false
DisableStopInstance bool `mapstructure:"disable_stop_instance"` AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address" required:"false"`
EbsOptimized bool `mapstructure:"ebs_optimized"` // Destination availability zone to launch
EnableT2Unlimited bool `mapstructure:"enable_t2_unlimited"` // instance in. Leave this empty to allow Amazon to auto-assign.
IamInstanceProfile string `mapstructure:"iam_instance_profile"` AvailabilityZone string `mapstructure:"availability_zone" required:"false"`
InstanceInitiatedShutdownBehavior string `mapstructure:"shutdown_behavior"` // Requires spot_price to be set. The
InstanceType string `mapstructure:"instance_type"` // required duration for the Spot Instances (also known as Spot blocks). This
SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter"` // value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). You can't
RunTags map[string]string `mapstructure:"run_tags"` // specify an Availability Zone group or a launch group if you specify a
SecurityGroupId string `mapstructure:"security_group_id"` // duration.
SecurityGroupIds []string `mapstructure:"security_group_ids"` BlockDurationMinutes int64 `mapstructure:"block_duration_minutes" required:"false"`
SourceAmi string `mapstructure:"source_ami"` // Packer normally stops the build
SourceAmiFilter AmiFilterOptions `mapstructure:"source_ami_filter"` // instance after all provisioners have run. For Windows instances, it is
SpotInstanceTypes []string `mapstructure:"spot_instance_types"` // sometimes desirable to run
SpotPrice string `mapstructure:"spot_price"` // Sysprep
SpotPriceAutoProduct string `mapstructure:"spot_price_auto_product"` // which will stop the instance for you. If this is set to true, Packer
SpotTags map[string]string `mapstructure:"spot_tags"` // will not stop the instance but will assume that you will send the stop
SubnetFilter SubnetFilterOptions `mapstructure:"subnet_filter"` // signal yourself through your final provisioner. You can do this with a
SubnetId string `mapstructure:"subnet_id"` // windows-shell
TemporaryKeyPairName string `mapstructure:"temporary_key_pair_name"` // provisioner.
TemporarySGSourceCidrs []string `mapstructure:"temporary_security_group_source_cidrs"` DisableStopInstance bool `mapstructure:"disable_stop_instance" required:"false"`
UserData string `mapstructure:"user_data"` // Mark instance as EBS
UserDataFile string `mapstructure:"user_data_file"` // Optimized.
VpcFilter VpcFilterOptions `mapstructure:"vpc_filter"` // Default false.
VpcId string `mapstructure:"vpc_id"` EbsOptimized bool `mapstructure:"ebs_optimized" required:"false"`
WindowsPasswordTimeout time.Duration `mapstructure:"windows_password_timeout"` // Enabling T2 Unlimited allows the source
// instance to burst additional CPU beyond its available CPU
// Credits
// for as long as the demand exists. This is in contrast to the standard
// configuration that only allows an instance to consume up to its available
// CPU Credits. See the AWS documentation for T2
// Unlimited
// and the T2 Unlimited Pricing section of the Amazon EC2 On-Demand
// Pricing document for more
// information. By default this option is disabled and Packer will set up a
// T2
// Standard
// instance instead.
EnableT2Unlimited bool `mapstructure:"enable_t2_unlimited" required:"false"`
// The name of an IAM instance
// profile
// to launch the EC2 instance with.
IamInstanceProfile string `mapstructure:"iam_instance_profile" required:"false"`
// Automatically terminate instances on
// shutdown in case Packer exits ungracefully. Possible values are stop and
// terminate. Defaults to stop.
InstanceInitiatedShutdownBehavior string `mapstructure:"shutdown_behavior" required:"false"`
// The EC2 instance type to use while building the
// AMI, such as t2.small.
InstanceType string `mapstructure:"instance_type" required:"true"`
// Filters used to populate the
// security_group_ids field. Example:
SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false"`
// Tags to apply to the instance
// that is launched to create the AMI. These tags are not applied to the
// resulting AMI unless they're duplicated in tags. This is a template
// engine, see Build template
// data for more information.
RunTags map[string]string `mapstructure:"run_tags" required:"false"`
// The ID (not the name) of the security
// group to assign to the instance. By default this is not set and Packer will
// automatically create a new temporary security group to allow SSH access.
// Note that if this is specified, you must be sure the security group allows
// access to the ssh_port given below.
SecurityGroupId string `mapstructure:"security_group_id" required:"false"`
// A list of security groups as
// described above. Note that if this is specified, you must omit the
// security_group_id.
SecurityGroupIds []string `mapstructure:"security_group_ids" required:"false"`
// The source AMI whose root volume will be copied and
// provisioned on the currently running instance. This must be an EBS-backed
// AMI with a root volume snapshot that you have access to. Note: this is not
// used when from_scratch is set to true.
SourceAmi string `mapstructure:"source_ami" required:"true"`
// Filters used to populate the source_ami
// field. Example:
SourceAmiFilter AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"`
// a list of acceptable instance
// types to run your build on. We will request a spot instance using the max
// price of spot_price and the allocation strategy of "lowest price".
// Your instance will be launched on an instance type of the lowest available
// price that you have in your list. This is used in place of instance_type.
// You may only set either spot_instance_types or instance_type, not both.
// This feature exists to help prevent situations where a Packer build fails
// because a particular availability zone does not have capacity for the
// specific instance_type requested in instance_type.
SpotInstanceTypes []string `mapstructure:"spot_instance_types" required:"false"`
// The maximum hourly price to pay for a spot instance
// to create the AMI. Spot instances are a type of instance that EC2 starts
// when the current spot price is less than the maximum price you specify.
// Spot price will be updated based on available spot instance capacity and
// current spot instance requests. It may save you some costs. You can set
// this to auto for Packer to automatically discover the best spot price or
// to "0" to use an on demand instance (default).
SpotPrice string `mapstructure:"spot_price" required:"false"`
// Required if spot_price is set to
// auto. This tells Packer what sort of AMI you're launching to find the
// best spot price. This must be one of: Linux/UNIX, SUSE Linux,
// Windows, Linux/UNIX (Amazon VPC), SUSE Linux (Amazon VPC),
// Windows (Amazon VPC)
SpotPriceAutoProduct string `mapstructure:"spot_price_auto_product" required:"false"`
// Requires spot_price to be
// set. This tells Packer to apply tags to the spot request that is issued.
SpotTags map[string]string `mapstructure:"spot_tags" required:"false"`
// Filters used to populate the subnet_id field.
// Example:
SubnetFilter SubnetFilterOptions `mapstructure:"subnet_filter" required:"false"`
// If using VPC, the ID of the subnet, such as
// subnet-12345def, where Packer will launch the EC2 instance. This field is
// required if you are using an non-default VPC.
SubnetId string `mapstructure:"subnet_id" required:"false"`
// The name of the temporary key pair to
// generate. By default, Packer generates a name that looks like
// packer_<UUID>, where <UUID> is a 36 character unique identifier.
TemporaryKeyPairName string `mapstructure:"temporary_key_pair_name" required:"false"`
// A list of IPv4
// CIDR blocks to be authorized access to the instance, when packer is creating a temporary security group.
TemporarySGSourceCidrs []string `mapstructure:"temporary_security_group_source_cidrs" required:"false"`
// User data to apply when launching the instance. Note
// that you need to be careful about escaping characters due to the templates
// being JSON. It is often more convenient to use user_data_file, instead.
// Packer will not automatically wait for a user script to finish before
// shutting down the instance this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the instance.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// Filters used to populate the vpc_id field.
// vpc_id take precedence over this.
// Example:
VpcFilter VpcFilterOptions `mapstructure:"vpc_filter" required:"false"`
// If launching into a VPC subnet, Packer needs the VPC ID
// in order to create a temporary security group within the VPC. Requires
// subnet_id to be set. If this field is left blank, Packer will try to get
// the VPC ID from the subnet_id.
VpcId string `mapstructure:"vpc_id" required:"false"`
// The timeout for waiting for a Windows
// password for Windows instances. Defaults to 20 minutes. Example value:
// 10m
WindowsPasswordTimeout time.Duration `mapstructure:"windows_password_timeout" required:"false"`
// Communicator settings // Communicator settings
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`

10
builder/amazon/ebssurrogate/builder.go
View File

@ -25,10 +25,14 @@ type Config struct {
awscommon.RunConfig `mapstructure:",squash"` awscommon.RunConfig `mapstructure:",squash"`
awscommon.BlockDevices `mapstructure:",squash"` awscommon.BlockDevices `mapstructure:",squash"`
awscommon.AMIConfig `mapstructure:",squash"` awscommon.AMIConfig `mapstructure:",squash"`
// A block device mapping
RootDevice RootBlockDevice `mapstructure:"ami_root_device"` // describing the root device of the AMI. This looks like the mappings in
// ami_block_device_mapping, except with an additional field:
RootDevice RootBlockDevice `mapstructure:"ami_root_device" required:"true"`
VolumeRunTags awscommon.TagMap `mapstructure:"run_volume_tags"` VolumeRunTags awscommon.TagMap `mapstructure:"run_volume_tags"`
Architecture string `mapstructure:"ami_architecture"` // what architecture to use when registering the
// final AMI; valid options are "x86_64" or "arm64". Defaults to "x86_64".
Architecture string `mapstructure:"ami_architecture" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

28
builder/amazon/ebssurrogate/root_block_device.go
View File

@ -8,11 +8,29 @@ import (
type RootBlockDevice struct { type RootBlockDevice struct {
SourceDeviceName string `mapstructure:"source_device_name"` SourceDeviceName string `mapstructure:"source_device_name"`
DeviceName string `mapstructure:"device_name"` // The device name exposed to the instance (for
DeleteOnTermination bool `mapstructure:"delete_on_termination"` // example, /dev/sdh or xvdh). Required for every device in the block
IOPS int64 `mapstructure:"iops"` // device mapping.
VolumeType string `mapstructure:"volume_type"` DeviceName string `mapstructure:"device_name" required:"false"`
VolumeSize int64 `mapstructure:"volume_size"` // Indicates whether the EBS volume is
// deleted on instance termination. Default false. NOTE: If this
// value is not explicitly set to true and volumes are not cleaned up by
// an alternative method, additional volumes will accumulate after every
// build.
DeleteOnTermination bool `mapstructure:"delete_on_termination" required:"false"`
// The number of I/O operations per second (IOPS) that
// the volume supports. See the documentation on
// IOPs
// for more information
IOPS int64 `mapstructure:"iops" required:"false"`
// The volume type. gp2 for General Purpose
// (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for
// Throughput Optimized HDD, sc1 for Cold HDD, and standard for
// Magnetic volumes.
VolumeType string `mapstructure:"volume_type" required:"false"`
// The size of the volume, in GiB. Required if
// not specifying a snapshot_id.
VolumeSize int64 `mapstructure:"volume_size" required:"false"`
} }
func (c *RootBlockDevice) Prepare(ctx *interpolate.Context) []error { func (c *RootBlockDevice) Prepare(ctx *interpolate.Context) []error {

5
builder/amazon/ebsvolume/block_device.go
View File

@ -7,7 +7,10 @@ import (
type BlockDevice struct { type BlockDevice struct {
awscommon.BlockDevice `mapstructure:"-,squash"` awscommon.BlockDevice `mapstructure:"-,squash"`
Tags awscommon.TagMap `mapstructure:"tags"` // Tags applied to the AMI. This is a
// template engine, see Build template
// data for more information.
Tags awscommon.TagMap `mapstructure:"tags" required:"false"`
} }
func commonBlockDevices(mappings []BlockDevice, ctx *interpolate.Context) (awscommon.BlockDevices, error) { func commonBlockDevices(mappings []BlockDevice, ctx *interpolate.Context) (awscommon.BlockDevices, error) {

24
builder/amazon/ebsvolume/builder.go
View File

@ -22,10 +22,26 @@ type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
awscommon.AccessConfig `mapstructure:",squash"` awscommon.AccessConfig `mapstructure:",squash"`
awscommon.RunConfig `mapstructure:",squash"` awscommon.RunConfig `mapstructure:",squash"`
// Add the block device
VolumeMappings []BlockDevice `mapstructure:"ebs_volumes"` // mappings to the AMI. The block device mappings allow for keys:
AMIENASupport *bool `mapstructure:"ena_support"` VolumeMappings []BlockDevice `mapstructure:"ebs_volumes" required:"false"`
AMISriovNetSupport bool `mapstructure:"sriov_support"` // Enable enhanced networking (ENA but not
// SriovNetSupport) on HVM-compatible AMIs. If set, add
// ec2:ModifyInstanceAttribute to your AWS IAM policy. If false, this will
// disable enhanced networking in the final AMI as opposed to passing the
// setting through unchanged from the source. Note: you must make sure
// enhanced networking is enabled on your instance. See Amazon's
// documentation on enabling enhanced
// networking.
AMIENASupport *bool `mapstructure:"ena_support" required:"false"`
// Enable enhanced networking (SriovNetSupport but
// not ENA) on HVM-compatible AMIs. If true, add
// ec2:ModifyInstanceAttribute to your AWS IAM policy. Note: you must make
// sure enhanced networking is enabled on your instance. See Amazon's
// documentation on enabling enhanced
// networking.
// Default false.
AMISriovNetSupport bool `mapstructure:"sriov_support" required:"false"`
launchBlockDevices awscommon.BlockDevices launchBlockDevices awscommon.BlockDevices
ctx interpolate.Context ctx interpolate.Context

48
builder/amazon/instance/builder.go
View File

@ -30,16 +30,44 @@ type Config struct {
awscommon.AMIConfig `mapstructure:",squash"` awscommon.AMIConfig `mapstructure:",squash"`
awscommon.BlockDevices `mapstructure:",squash"` awscommon.BlockDevices `mapstructure:",squash"`
awscommon.RunConfig `mapstructure:",squash"` awscommon.RunConfig `mapstructure:",squash"`
// Your AWS account ID. This is required for bundling
AccountId string `mapstructure:"account_id"` // the AMI. This is not the same as the access key. You can find your
BundleDestination string `mapstructure:"bundle_destination"` // account ID in the security credentials page of your AWS account.
BundlePrefix string `mapstructure:"bundle_prefix"` AccountId string `mapstructure:"account_id" required:"true"`
BundleUploadCommand string `mapstructure:"bundle_upload_command"` // The directory on the running instance where
BundleVolCommand string `mapstructure:"bundle_vol_command"` // the bundled AMI will be saved prior to uploading. By default this is
S3Bucket string `mapstructure:"s3_bucket"` // /tmp. This directory must exist and be writable.
X509CertPath string `mapstructure:"x509_cert_path"` BundleDestination string `mapstructure:"bundle_destination" required:"false"`
X509KeyPath string `mapstructure:"x509_key_path"` // The prefix for files created from bundling the
X509UploadPath string `mapstructure:"x509_upload_path"` // 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 ctx interpolate.Context
} }

12
builder/azure/arm/clientconfig.go
View File

@ -14,9 +14,10 @@ import (
// ClientConfig allows for various ways to authenticate Azure clients // ClientConfig allows for various ways to authenticate Azure clients
type ClientConfig struct { type ClientConfig struct {
// Describes where API's are // One of Public, China, Germany, or
// USGovernment. Defaults to Public. Long forms such as
CloudEnvironmentName string `mapstructure:"cloud_environment_name"` // USGovernmentCloud and AzureUSGovernmentCloud are also supported.
CloudEnvironmentName string `mapstructure:"cloud_environment_name" required:"false"`
cloudEnvironment *azure.Environment cloudEnvironment *azure.Environment
// Authentication fields // Authentication fields
@ -30,7 +31,10 @@ type ClientConfig struct {
// JWT bearer token for client auth (RFC 7523, Sec. 2.2) // JWT bearer token for client auth (RFC 7523, Sec. 2.2)
ClientJWT string `mapstructure:"client_jwt"` ClientJWT string `mapstructure:"client_jwt"`
ObjectID string `mapstructure:"object_id"` ObjectID string `mapstructure:"object_id"`
TenantID string `mapstructure:"tenant_id"` // The account identifier with which your client_id and
// subscription_id are associated. If not specified, tenant_id will be
// looked up using subscription_id.
TenantID string `mapstructure:"tenant_id" required:"false"`
SubscriptionID string `mapstructure:"subscription_id"` SubscriptionID string `mapstructure:"subscription_id"`
} }

178
builder/azure/arm/config.go
View File

@ -70,7 +70,12 @@ type SharedImageGallery struct {
ResourceGroup string `mapstructure:"resource_group"` ResourceGroup string `mapstructure:"resource_group"`
GalleryName string `mapstructure:"gallery_name"` GalleryName string `mapstructure:"gallery_name"`
ImageName string `mapstructure:"image_name"` ImageName string `mapstructure:"image_name"`
ImageVersion string `mapstructure:"image_version"` // Specify a specific version of an OS to boot from.
// Defaults to latest. There may be a difference in versions available
// across regions due to image synchronization latency. To ensure a consistent
// version across regions set this value to one that is available in all
// regions where you are deploying.
ImageVersion string `mapstructure:"image_version" required:"false"`
} }
type Config struct { type Config struct {
@ -82,56 +87,147 @@ type Config struct {
// Capture // Capture
CaptureNamePrefix string `mapstructure:"capture_name_prefix"` CaptureNamePrefix string `mapstructure:"capture_name_prefix"`
CaptureContainerName string `mapstructure:"capture_container_name"` CaptureContainerName string `mapstructure:"capture_container_name"`
// Use a Shared Gallery
// Shared Gallery // image
SharedGallery SharedImageGallery `mapstructure:"shared_image_gallery"` // as the source for this build. VHD targets are incompatible with this build
// type - the target must be a Managed Image.
// Compute SharedGallery SharedImageGallery `mapstructure:"shared_image_gallery" required:"false"`
ImagePublisher string `mapstructure:"image_publisher"` // PublisherName for your base image. See
ImageOffer string `mapstructure:"image_offer"` // documentation
ImageSku string `mapstructure:"image_sku"` // for details.
ImageVersion string `mapstructure:"image_version"` ImagePublisher string `mapstructure:"image_publisher" required:"true"`
ImageUrl string `mapstructure:"image_url"` // Offer for your base image. See
// documentation
CustomManagedImageResourceGroupName string `mapstructure:"custom_managed_image_resource_group_name"` // for details.
CustomManagedImageName string `mapstructure:"custom_managed_image_name"` ImageOffer string `mapstructure:"image_offer" required:"true"`
// SKU for your base image. See
// documentation
// for details.
ImageSku string `mapstructure:"image_sku" required:"true"`
// Specify a specific version of an OS to boot from.
// Defaults to latest. There may be a difference in versions available
// across regions due to image synchronization latency. To ensure a consistent
// version across regions set this value to one that is available in all
// regions where you are deploying.
ImageVersion string `mapstructure:"image_version" required:"false"`
// Specify a custom VHD to use. If this value is set, do
// not set image_publisher, image_offer, image_sku, or image_version.
ImageUrl string `mapstructure:"image_url" required:"false"`
// Specify the source
// managed image's resource group used to use. If this value is set, do not
// set image_publisher, image_offer, image_sku, or image_version. If this
// value is set, the value custom_managed_image_name must also be set. See
// documentation
// to learn more about managed images.
CustomManagedImageResourceGroupName string `mapstructure:"custom_managed_image_resource_group_name" required:"false"`
// Specify the source managed image's
// name to use. If this value is set, do not set image_publisher,
// image_offer, image_sku, or image_version. If this value is set, the
// value custom_managed_image_resource_group_name must also be set. See
// documentation
// to learn more about managed images.
CustomManagedImageName string `mapstructure:"custom_managed_image_name" required:"false"`
customManagedImageID string customManagedImageID string
Location string `mapstructure:"location"` Location string `mapstructure:"location"`
VMSize string `mapstructure:"vm_size"` // Size of the VM used for building. This can be changed
// when you deploy a VM from your VHD. See
// pricing
// information. Defaults to Standard_A1.
VMSize string `mapstructure:"vm_size" required:"false"`
ManagedImageResourceGroupName string `mapstructure:"managed_image_resource_group_name"` ManagedImageResourceGroupName string `mapstructure:"managed_image_resource_group_name"`
ManagedImageName string `mapstructure:"managed_image_name"` ManagedImageName string `mapstructure:"managed_image_name"`
ManagedImageStorageAccountType string `mapstructure:"managed_image_storage_account_type"` // Specify the storage account
// type for a managed image. Valid values are Standard_LRS and Premium_LRS.
// The default is Standard_LRS.
ManagedImageStorageAccountType string `mapstructure:"managed_image_storage_account_type" required:"false"`
managedImageStorageAccountType compute.StorageAccountTypes managedImageStorageAccountType compute.StorageAccountTypes
ManagedImageOSDiskSnapshotName string `mapstructure:"managed_image_os_disk_snapshot_name"` // If
ManagedImageDataDiskSnapshotPrefix string `mapstructure:"managed_image_data_disk_snapshot_prefix"` // managed_image_os_disk_snapshot_name is set, a snapshot of the OS disk
// is created with the same name as this value before the VM is captured.
ManagedImageOSDiskSnapshotName string `mapstructure:"managed_image_os_disk_snapshot_name" required:"false"`
// If
// managed_image_data_disk_snapshot_prefix is set, snapshot of the data
// disk(s) is created with the same prefix as this value before the VM is
// captured.
ManagedImageDataDiskSnapshotPrefix string `mapstructure:"managed_image_data_disk_snapshot_prefix" required:"false"`
manageImageLocation string manageImageLocation string
ManagedImageZoneResilient bool `mapstructure:"managed_image_zone_resilient"` // Store the image in zone-resilient storage. You need to create it
// in a region that supports availability zones.
// Deployment ManagedImageZoneResilient bool `mapstructure:"managed_image_zone_resilient" required:"false"`
AzureTags map[string]*string `mapstructure:"azure_tags"` // the user can define up to 15
// tags. Tag names cannot exceed 512 characters, and tag values cannot exceed
// 256 characters. Tags are applied to every resource deployed by a Packer
// build, i.e. Resource Group, VM, NIC, VNET, Public IP, KeyVault, etc.
AzureTags map[string]*string `mapstructure:"azure_tags" required:"false"`
ResourceGroupName string `mapstructure:"resource_group_name"` ResourceGroupName string `mapstructure:"resource_group_name"`
StorageAccount string `mapstructure:"storage_account"` StorageAccount string `mapstructure:"storage_account"`
TempComputeName string `mapstructure:"temp_compute_name"` // temporary name assigned to the VM. If this
// value is not set, a random value will be assigned. Knowing the resource
// group and VM name allows one to execute commands to update the VM during a
// Packer build, e.g. attach a resource disk to the VM.
TempComputeName string `mapstructure:"temp_compute_name" required:"false"`
TempResourceGroupName string `mapstructure:"temp_resource_group_name"` TempResourceGroupName string `mapstructure:"temp_resource_group_name"`
BuildResourceGroupName string `mapstructure:"build_resource_group_name"` BuildResourceGroupName string `mapstructure:"build_resource_group_name"`
storageAccountBlobEndpoint string storageAccountBlobEndpoint string
PrivateVirtualNetworkWithPublicIp bool `mapstructure:"private_virtual_network_with_public_ip"` // This value allows you to
VirtualNetworkName string `mapstructure:"virtual_network_name"` // set a virtual_network_name and obtain a public IP. If this value is not
VirtualNetworkSubnetName string `mapstructure:"virtual_network_subnet_name"` // set and virtual_network_name is defined Packer is only allowed to be
VirtualNetworkResourceGroupName string `mapstructure:"virtual_network_resource_group_name"` // executed from a host on the same subnet / virtual network.
CustomDataFile string `mapstructure:"custom_data_file"` PrivateVirtualNetworkWithPublicIp bool `mapstructure:"private_virtual_network_with_public_ip" required:"false"`
// Use a pre-existing virtual network for the
// VM. This option enables private communication with the VM, no public IP
// address is used or provisioned (unless you set
// private_virtual_network_with_public_ip).
VirtualNetworkName string `mapstructure:"virtual_network_name" required:"false"`
// If virtual_network_name is set,
// this value may also be set. If virtual_network_name is set, and this
// value is not set the builder attempts to determine the subnet to use with
// the virtual network. If the subnet cannot be found, or it cannot be
// disambiguated, this value should be set.
VirtualNetworkSubnetName string `mapstructure:"virtual_network_subnet_name" required:"false"`
// If virtual_network_name is
// set, this value may also be set. If virtual_network_name is set, and
// this value is not set the builder attempts to determine the resource group
// containing the virtual network. If the resource group cannot be found, or
// it cannot be disambiguated, this value should be set.
VirtualNetworkResourceGroupName string `mapstructure:"virtual_network_resource_group_name" required:"false"`
// Specify a file containing custom data to inject
// into the cloud-init process. The contents of the file are read and injected
// into the ARM template. The custom data will be passed to cloud-init for
// processing at the time of provisioning. See
// documentation
// to learn more about custom data, and how it can be used to influence the
// provisioning process.
CustomDataFile string `mapstructure:"custom_data_file" required:"false"`
customData string customData string
PlanInfo PlanInformation `mapstructure:"plan_info"` // Used for creating images from Marketplace images.
// Please refer to Deploy an image with Marketplace
// OS // terms for more details. Not
OSType string `mapstructure:"os_type"` // all Marketplace images support programmatic deployment, and support is
OSDiskSizeGB int32 `mapstructure:"os_disk_size_gb"` // controlled by the image publisher.
PlanInfo PlanInformation `mapstructure:"plan_info" required:"false"`
// Additional Disks // If either Linux or Windows is specified Packer will
AdditionalDiskSize []int32 `mapstructure:"disk_additional_size"` // automatically configure authentication credentials for the provisioned
DiskCachingType string `mapstructure:"disk_caching_type"` // machine. For Linux this configures an SSH authorized key. For Windows
// this configures a WinRM certificate.
OSType string `mapstructure:"os_type" required:"false"`
// Specify the size of the OS disk in GB
// (gigabytes). Values of zero or less than zero are ignored.
OSDiskSizeGB int32 `mapstructure:"os_disk_size_gb" required:"false"`
// The size(s) of any additional
// hard disks for the VM in gigabytes. If this is not specified then the VM
// will only contain an OS disk. The number of additional disks and maximum
// size of a disk depends on the configuration of your VM. See
// Windows
// or
// Linux
// for more information.
AdditionalDiskSize []int32 `mapstructure:"disk_additional_size" required:"false"`
// Specify the disk caching type. Valid values
// are None, ReadOnly, and ReadWrite. The default value is ReadWrite.
DiskCachingType string `mapstructure:"disk_caching_type" required:"false"`
diskCachingType compute.CachingTypes diskCachingType compute.CachingTypes
// Runtime Values // Runtime Values
@ -158,9 +254,11 @@ type Config struct {
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
ctx interpolate.Context ctx interpolate.Context
// If you want packer to delete the
//Cleanup // temporary resource group asynchronously set this value. It's a boolean
AsyncResourceGroupDelete bool `mapstructure:"async_resourcegroup_delete"` // value and defaults to false. Important Setting this true means that
// your builds are faster, however any failed deletes are not reported.
AsyncResourceGroupDelete bool `mapstructure:"async_resourcegroup_delete" required:"false"`
} }
type keyVaultCertificate struct { type keyVaultCertificate struct {

162
builder/cloudstack/config.go
View File

@ -19,44 +19,130 @@ type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
common.HTTPConfig `mapstructure:",squash"` common.HTTPConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The CloudStack API endpoint we will connect to. It can
APIURL string `mapstructure:"api_url"` // also be specified via environment variable CLOUDSTACK_API_URL, if set.
APIKey string `mapstructure:"api_key"` APIURL string `mapstructure:"api_url" required:"true"`
SecretKey string `mapstructure:"secret_key"` // The API key used to sign all API requests. It can also
AsyncTimeout time.Duration `mapstructure:"async_timeout"` // be specified via environment variable CLOUDSTACK_API_KEY, if set.
HTTPGetOnly bool `mapstructure:"http_get_only"` APIKey string `mapstructure:"api_key" required:"true"`
SSLNoVerify bool `mapstructure:"ssl_no_verify"` // The secret key used to sign all API requests. It
// can also be specified via environment variable CLOUDSTACK_SECRET_KEY, if
CIDRList []string `mapstructure:"cidr_list"` // set.
CreateSecurityGroup bool `mapstructure:"create_security_group"` SecretKey string `mapstructure:"secret_key" required:"true"`
DiskOffering string `mapstructure:"disk_offering"` // The time duration to wait for async calls to
DiskSize int64 `mapstructure:"disk_size"` // finish. Defaults to 30m.
Expunge bool `mapstructure:"expunge"` AsyncTimeout time.Duration `mapstructure:"async_timeout" required:"false"`
Hypervisor string `mapstructure:"hypervisor"` // Some cloud providers only allow HTTP GET calls
InstanceName string `mapstructure:"instance_name"` // to their CloudStack API. If using such a provider, you need to set this to
Network string `mapstructure:"network"` // true in order for the provider to only make GET calls and no POST calls.
Project string `mapstructure:"project"` HTTPGetOnly bool `mapstructure:"http_get_only" required:"false"`
PublicIPAddress string `mapstructure:"public_ip_address"` // Set to true to skip SSL verification.
PublicPort int `mapstructure:"public_port"` // Defaults to false.
SecurityGroups []string `mapstructure:"security_groups"` SSLNoVerify bool `mapstructure:"ssl_no_verify" required:"false"`
ServiceOffering string `mapstructure:"service_offering"` // List of CIDR's that will have access to the new
PreventFirewallChanges bool `mapstructure:"prevent_firewall_changes"` // instance. This is needed in order for any provisioners to be able to
SourceISO string `mapstructure:"source_iso"` // connect to the instance. Defaults to [ "0.0.0.0/0" ]. Only required when
SourceTemplate string `mapstructure:"source_template"` // use_local_ip_address is false.
TemporaryKeypairName string `mapstructure:"temporary_keypair_name"` CIDRList []string `mapstructure:"cidr_list" required:"false"`
UseLocalIPAddress bool `mapstructure:"use_local_ip_address"` // If true a temporary security group
UserData string `mapstructure:"user_data"` // will be created which allows traffic towards the instance from the
UserDataFile string `mapstructure:"user_data_file"` // cidr_list. This option will be ignored if security_groups is also
Zone string `mapstructure:"zone"` // defined. Requires expunge set to true. Defaults to false.
CreateSecurityGroup bool `mapstructure:"create_security_group" required:"false"`
TemplateName string `mapstructure:"template_name"` // The name or ID of the disk offering used for the
TemplateDisplayText string `mapstructure:"template_display_text"` // instance. This option is only available (and also required) when using
TemplateOS string `mapstructure:"template_os"` // source_iso.
TemplateFeatured bool `mapstructure:"template_featured"` DiskOffering string `mapstructure:"disk_offering" required:"false"`
TemplatePublic bool `mapstructure:"template_public"` // The size (in GB) of the root disk of the new
TemplatePasswordEnabled bool `mapstructure:"template_password_enabled"` // instance. This option is only available when using source_template.
TemplateRequiresHVM bool `mapstructure:"template_requires_hvm"` DiskSize int64 `mapstructure:"disk_size" required:"false"`
TemplateScalable bool `mapstructure:"template_scalable"` // Set to true to expunge the instance when it is
// destroyed. Defaults to false.
Expunge bool `mapstructure:"expunge" required:"false"`
// The target hypervisor (e.g. XenServer, KVM) for
// the new template. This option is required when using source_iso.
Hypervisor string `mapstructure:"hypervisor" required:"false"`
// The name of the instance. Defaults to
// "packer-UUID" where UUID is dynamically generated.
InstanceName string `mapstructure:"instance_name" required:"false"`
// The name or ID of the network to connect the instance
// to.
Network string `mapstructure:"network" required:"true"`
// The name or ID of the project to deploy the instance
// to.
Project string `mapstructure:"project" required:"false"`
// The public IP address or it's ID used for
// connecting any provisioners to. If not provided, a temporary public IP
// address will be associated and released during the Packer run.
PublicIPAddress string `mapstructure:"public_ip_address" required:"false"`
// The fixed port you want to configure in the port
// forwarding rule. Set this attribute if you do not want to use the a random
// public port.
PublicPort int `mapstructure:"public_port" required:"false"`
// A list of security group IDs or
// names to associate the instance with.
SecurityGroups []string `mapstructure:"security_groups" required:"false"`
// The name or ID of the service offering used
// for the instance.
ServiceOffering string `mapstructure:"service_offering" required:"true"`
// Set to true to prevent network
// ACLs or firewall rules creation. Defaults to false.
PreventFirewallChanges bool `mapstructure:"prevent_firewall_changes" required:"false"`
// The name or ID of an ISO that will be mounted
// before booting the instance. This option is mutually exclusive with
// source_template. When using source_iso, both disk_offering and
// hypervisor are required.
SourceISO string `mapstructure:"source_iso" required:"true"`
// The name or ID of the template used as base
// template for the instance. This option is mutually exclusive with
// source_iso.
SourceTemplate string `mapstructure:"source_template" required:"true"`
// The name of the temporary SSH key pair
// to generate. By default, Packer generates a name that looks like
// packer_<UUID>, where <UUID> is a 36 character unique identifier.
TemporaryKeypairName string `mapstructure:"temporary_keypair_name" required:"false"`
// Set to true to indicate that the
// provisioners should connect to the local IP address of the instance.
UseLocalIPAddress bool `mapstructure:"use_local_ip_address" required:"false"`
// User data to launch with the instance. This is a
// template engine see User Data bellow for
// more details. Packer will not automatically wait for a user script to
// finish before shutting down the instance this must be handled in a
// provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the instance. This file will be parsed as a template
// engine see User Data bellow for more
// details.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// The name or ID of the zone where the instance will be
// created.
Zone string `mapstructure:"zone" required:"true"`
// The name of the new template. Defaults to
// "packer-{{timestamp}}" where timestamp will be the current time.
TemplateName string `mapstructure:"template_name" required:"false"`
// The display text of the new template.
// Defaults to the template_name.
TemplateDisplayText string `mapstructure:"template_display_text" required:"false"`
// The name or ID of the template OS for the new
// template that will be created.
TemplateOS string `mapstructure:"template_os" required:"true"`
// Set to true to indicate that the template
// is featured. Defaults to false.
TemplateFeatured bool `mapstructure:"template_featured" required:"false"`
// Set to true to indicate that the template
// is available for all accounts. Defaults to false.
TemplatePublic bool `mapstructure:"template_public" required:"false"`
// Set to true to indicate the
// template should be password enabled. Defaults to false.
TemplatePasswordEnabled bool `mapstructure:"template_password_enabled" required:"false"`
// Set to true to indicate the template
// requires hardware-assisted virtualization. Defaults to false.
TemplateRequiresHVM bool `mapstructure:"template_requires_hvm" required:"false"`
// Set to true to indicate that the template
// contains tools to support dynamic scaling of VM cpu/memory. Defaults to
// false.
TemplateScalable bool `mapstructure:"template_scalable" required:"false"`
TemplateTag string `mapstructure:"template_tag"` TemplateTag string `mapstructure:"template_tag"`
Tags map[string]string `mapstructure:"tags"` Tags map[string]string `mapstructure:"tags"`

73
builder/digitalocean/config.go
View File

@ -19,24 +19,61 @@ import (
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The client TOKEN to use to access your account. It
APIToken string `mapstructure:"api_token"` // can also be specified via environment variable DIGITALOCEAN_API_TOKEN, if
APIURL string `mapstructure:"api_url"` // set.
APIToken string `mapstructure:"api_token" required:"true"`
Region string `mapstructure:"region"` // Non standard api endpoint URL. Set this if you are
Size string `mapstructure:"size"` // using a DigitalOcean API compatible service. It can also be specified via
Image string `mapstructure:"image"` // environment variable DIGITALOCEAN_API_URL.
APIURL string `mapstructure:"api_url" required:"false"`
PrivateNetworking bool `mapstructure:"private_networking"` // The name (or slug) of the region to launch the droplet
Monitoring bool `mapstructure:"monitoring"` // in. Consequently, this is the region where the snapshot will be available.
IPv6 bool `mapstructure:"ipv6"` // See
SnapshotName string `mapstructure:"snapshot_name"` // https://developers.digitalocean.com/documentation/v2/#list-all-regions
SnapshotRegions []string `mapstructure:"snapshot_regions"` // for the accepted region names/slugs.
StateTimeout time.Duration `mapstructure:"state_timeout"` Region string `mapstructure:"region" required:"true"`
DropletName string `mapstructure:"droplet_name"` // The name (or slug) of the droplet size to use. See
UserData string `mapstructure:"user_data"` // https://developers.digitalocean.com/documentation/v2/#list-all-sizes
UserDataFile string `mapstructure:"user_data_file"` // for the accepted size names/slugs.
Tags []string `mapstructure:"tags"` Size string `mapstructure:"size" required:"true"`
// The name (or slug) of the base image to use. This is the
// image that will be used to launch a new droplet and provision it. See
// https://developers.digitalocean.com/documentation/v2/#list-all-images
// for details on how to get a list of the accepted image names/slugs.
Image string `mapstructure:"image" required:"true"`
// Set to true to enable private networking
// for the droplet being created. This defaults to false, or not enabled.
PrivateNetworking bool `mapstructure:"private_networking" required:"false"`
// Set to true to enable monitoring for the droplet
// being created. This defaults to false, or not enabled.
Monitoring bool `mapstructure:"monitoring" required:"false"`
// Set to true to enable ipv6 for the droplet being
// created. This defaults to false, or not enabled.
IPv6 bool `mapstructure:"ipv6" required:"false"`
// The name of the resulting snapshot that will
// appear in your account. Defaults to "packer-{{timestamp}}" (see
// configuration templates for more info).
SnapshotName string `mapstructure:"snapshot_name" required:"false"`
// The regions of the resulting
// snapshot that will appear in your account.
SnapshotRegions []string `mapstructure:"snapshot_regions" required:"false"`
// The time to wait, as a duration string, for a
// droplet to enter a desired state (such as "active") before timing out. The
// default state timeout is "6m".
StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`
// The name assigned to the droplet. DigitalOcean
// sets the hostname of the machine to this value.
DropletName string `mapstructure:"droplet_name" required:"false"`
// User data to launch with the Droplet. Packer will
// not automatically wait for a user script to finish before shutting down the
// instance this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the Droplet.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// Tags to apply to the droplet when it is created
Tags []string `mapstructure:"tags" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

59
builder/docker/config.go
View File

@ -27,27 +27,66 @@ type Config struct {
Author string Author string
Changes []string Changes []string
Commit bool Commit bool
ContainerDir string `mapstructure:"container_dir"` // The directory inside container to mount temp
// directory from host server for work file
// provisioner. This defaults to
// c:/packer-files on windows and /packer-files on other systems.
ContainerDir string `mapstructure:"container_dir" required:"false"`
Discard bool Discard bool
ExecUser string `mapstructure:"exec_user"` // Username (UID) to run remote commands with. You can
// also set the group name/ID if you want: (UID or UID:GID).
// You may need this if you get permission errors trying to run the shell or
// other provisioners.
ExecUser string `mapstructure:"exec_user" required:"false"`
ExportPath string `mapstructure:"export_path"` ExportPath string `mapstructure:"export_path"`
Image string Image string
Message string Message string
Privileged bool `mapstructure:"privileged"` // If true, run the docker container with the
// --privileged flag. This defaults to false if not set.
Privileged bool `mapstructure:"privileged" required:"false"`
Pty bool Pty bool
Pull bool Pull bool
RunCommand []string `mapstructure:"run_command"` // An array of arguments to pass to
// docker run in order to run the container. By default this is set to
// ["-d", "-i", "-t", "--entrypoint=/bin/sh", "--", "{{.Image}}"] if you are
// using a linux container, and
// ["-d", "-i", "-t", "--entrypoint=powershell", "--", "{{.Image}}"] if you
// are running a windows container. {{.Image}} is a template variable that
// corresponds to the image template option. Passing the entrypoint option
// this way will make it the default entrypoint of the resulting image, so
// running docker run -it --rm will start the docker image from the
// /bin/sh shell interpreter; you could run a script or another shell by
// running docker run -it --rm -c /bin/bash. If your docker image
// embeds a binary intended to be run often, you should consider changing the
// default entrypoint to point to it.
RunCommand []string `mapstructure:"run_command" required:"false"`
Volumes map[string]string Volumes map[string]string
FixUploadOwner bool `mapstructure:"fix_upload_owner"` // If true, files uploaded to the container
WindowsContainer bool `mapstructure:"windows_container"` // will be owned by the user the container is running as. If false, the owner
// will depend on the version of docker installed in the system. Defaults to
// true.
FixUploadOwner bool `mapstructure:"fix_upload_owner" required:"false"`
// If "true", tells Packer that you are building a
// Windows container running on a windows host. This is necessary for building
// Windows containers, because our normal docker bindings do not work for them.
WindowsContainer bool `mapstructure:"windows_container" required:"false"`
// This is used to login to dockerhub to pull a private base container. For // This is used to login to dockerhub to pull a private base container. For
// pushing to dockerhub, see the docker post-processors // pushing to dockerhub, see the docker post-processors
Login bool Login bool
LoginPassword string `mapstructure:"login_password"` // The password to use to authenticate to login.
LoginServer string `mapstructure:"login_server"` LoginPassword string `mapstructure:"login_password" required:"false"`
LoginUsername string `mapstructure:"login_username"` // The server address to login to.
EcrLogin bool `mapstructure:"ecr_login"` LoginServer string `mapstructure:"login_server" required:"false"`
// The username to use to authenticate to login.
LoginUsername string `mapstructure:"login_username" required:"false"`
// Defaults to false. If true, the builder will login
// in order to pull the image from Amazon EC2 Container Registry
// (ECR). The builder only logs in for the
// duration of the pull. If true login_server is required and login,
// login_username, and login_password will be ignored. For more
// information see the section on ECR.
EcrLogin bool `mapstructure:"ecr_login" required:"false"`
AwsAccessConfig `mapstructure:",squash"` AwsAccessConfig `mapstructure:",squash"`
ctx interpolate.Context ctx interpolate.Context

21
builder/docker/ecr_login.go
View File

@ -13,10 +13,23 @@ import (
) )
type AwsAccessConfig struct { type AwsAccessConfig struct {
AccessKey string `mapstructure:"aws_access_key"` // The AWS access key used to communicate with
SecretKey string `mapstructure:"aws_secret_key"` // AWS. Learn how to set
Token string `mapstructure:"aws_token"` // this.
Profile string `mapstructure:"aws_profile"` AccessKey string `mapstructure:"aws_access_key" required:"false"`
// The AWS secret key used to communicate with
// AWS. Learn how to set
// this.
SecretKey string `mapstructure:"aws_secret_key" required:"false"`
// The AWS access token to use. This is different from
// the access key and secret key. If you're not sure what this is, then you
// probably don't need it. This will also be read from the AWS_SESSION_TOKEN
// environmental variable.
Token string `mapstructure:"aws_token" required:"false"`
// The AWS shared credentials profile used to
// communicate with AWS. Learn how to set
// this.
Profile string `mapstructure:"aws_profile" required:"false"`
cfg *common.AccessConfig cfg *common.AccessConfig
} }

171
builder/googlecompute/config.go
View File

@ -24,45 +24,138 @@ var reImageFamily = regexp.MustCompile(`^[a-z]([-a-z0-9]{0,61}[a-z0-9])?$`)
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The JSON file containing your account
AccountFile string `mapstructure:"account_file"` // credentials. Not required if you run Packer on a GCE instance with a
ProjectId string `mapstructure:"project_id"` // service account. Instructions for creating the file or using service
// accounts are above.
AcceleratorType string `mapstructure:"accelerator_type"` AccountFile string `mapstructure:"account_file" required:"false"`
AcceleratorCount int64 `mapstructure:"accelerator_count"` // The project ID that will be used to launch
Address string `mapstructure:"address"` // instances and store images.
DisableDefaultServiceAccount bool `mapstructure:"disable_default_service_account"` ProjectId string `mapstructure:"project_id" required:"true"`
DiskName string `mapstructure:"disk_name"` // Full or partial URL of the guest accelerator
DiskSizeGb int64 `mapstructure:"disk_size"` // type. GPU accelerators can only be used with
DiskType string `mapstructure:"disk_type"` // "on_host_maintenance": "TERMINATE" option set. Example:
ImageName string `mapstructure:"image_name"` // "projects/project_id/zones/europe-west1-b/acceleratorTypes/nvidia-tesla-k80"
ImageDescription string `mapstructure:"image_description"` AcceleratorType string `mapstructure:"accelerator_type" required:"false"`
ImageEncryptionKey *compute.CustomerEncryptionKey `mapstructure:"image_encryption_key"` // Number of guest accelerator cards to add to
ImageFamily string `mapstructure:"image_family"` // the launched instance.
ImageLabels map[string]string `mapstructure:"image_labels"` AcceleratorCount int64 `mapstructure:"accelerator_count" required:"false"`
ImageLicenses []string `mapstructure:"image_licenses"` // The name of a pre-allocated static external IP
InstanceName string `mapstructure:"instance_name"` // address. Note, must be the name and not the actual IP address.
Labels map[string]string `mapstructure:"labels"` Address string `mapstructure:"address" required:"false"`
MachineType string `mapstructure:"machine_type"` // If true, the default service
Metadata map[string]string `mapstructure:"metadata"` // account will not be used if service_account_email is not specified. Set
MinCpuPlatform string `mapstructure:"min_cpu_platform"` // this value to true and omit service_account_email to provision a VM with
Network string `mapstructure:"network"` // no service account.
NetworkProjectId string `mapstructure:"network_project_id"` DisableDefaultServiceAccount bool `mapstructure:"disable_default_service_account" required:"false"`
OmitExternalIP bool `mapstructure:"omit_external_ip"` // The name of the disk, if unset the instance name
OnHostMaintenance string `mapstructure:"on_host_maintenance"` // will be used.
Preemptible bool `mapstructure:"preemptible"` DiskName string `mapstructure:"disk_name" required:"false"`
RawStateTimeout string `mapstructure:"state_timeout"` // The size of the disk in GB. This defaults to 10,
Region string `mapstructure:"region"` // which is 10GB.
Scopes []string `mapstructure:"scopes"` DiskSizeGb int64 `mapstructure:"disk_size" required:"false"`
ServiceAccountEmail string `mapstructure:"service_account_email"` // Type of disk used to back your instance, like
SourceImage string `mapstructure:"source_image"` // pd-ssd or pd-standard. Defaults to pd-standard.
SourceImageFamily string `mapstructure:"source_image_family"` DiskType string `mapstructure:"disk_type" required:"false"`
SourceImageProjectId string `mapstructure:"source_image_project_id"` // The unique name of the resulting image. Defaults to
StartupScriptFile string `mapstructure:"startup_script_file"` // "packer-{{timestamp}}".
Subnetwork string `mapstructure:"subnetwork"` ImageName string `mapstructure:"image_name" required:"false"`
Tags []string `mapstructure:"tags"` // The description of the resulting image.
UseInternalIP bool `mapstructure:"use_internal_ip"` ImageDescription string `mapstructure:"image_description" required:"false"`
Zone string `mapstructure:"zone"` // Image encryption key to apply to the created image. Possible values:
ImageEncryptionKey *compute.CustomerEncryptionKey `mapstructure:"image_encryption_key" required:"false"`
// The name of the image family to which the
// resulting image belongs. You can create disks by specifying an image family
// instead of a specific image name. The image family always returns its
// latest image that is not deprecated.
ImageFamily string `mapstructure:"image_family" required:"false"`
// Key/value pair labels to
// apply to the created image.
ImageLabels map[string]string `mapstructure:"image_labels" required:"false"`
// Licenses to apply to the created
// image.
ImageLicenses []string `mapstructure:"image_licenses" required:"false"`
// A name to give the launched instance. Beware
// that this must be unique. Defaults to "packer-{{uuid}}".
InstanceName string `mapstructure:"instance_name" required:"false"`
// Key/value pair labels to apply to
// the launched instance.
Labels map[string]string `mapstructure:"labels" required:"false"`
// The machine type. Defaults to "n1-standard-1".
MachineType string `mapstructure:"machine_type" required:"false"`
// Metadata applied to the launched
// instance.
Metadata map[string]string `mapstructure:"metadata" required:"false"`
// A Minimum CPU Platform for VM Instance.
// Availability and default CPU platforms vary across zones, based on the
// hardware available in each GCP zone.
// Details
MinCpuPlatform string `mapstructure:"min_cpu_platform" required:"false"`
// The Google Compute network id or URL to use for the
// launched instance. Defaults to "default". If the value is not a URL, it
// will be interpolated to
// projects/((network_project_id))/global/networks/((network)). This value
// is not required if a subnet is specified.
Network string `mapstructure:"network" required:"false"`
// The project ID for the network and
// subnetwork to use for launched instance. Defaults to project_id.
NetworkProjectId string `mapstructure:"network_project_id" required:"false"`
// If true, the instance will not have an
// external IP. use_internal_ip must be true if this property is true.
OmitExternalIP bool `mapstructure:"omit_external_ip" required:"false"`
// Sets Host Maintenance Option. Valid
// choices are MIGRATE and TERMINATE. Please see GCE Instance Scheduling
// Options,
// as not all machine_types support MIGRATE (i.e. machines with GPUs). If
// preemptible is true this can only be TERMINATE. If preemptible is false,
// it defaults to MIGRATE
OnHostMaintenance string `mapstructure:"on_host_maintenance" required:"false"`
// If true, launch a preemptible instance.
Preemptible bool `mapstructure:"preemptible" required:"false"`
// The time to wait for instance state changes.
// Defaults to "5m".
RawStateTimeout string `mapstructure:"state_timeout" required:"false"`
// The region in which to launch the instance. Defaults to
// the region hosting the specified zone.
Region string `mapstructure:"region" required:"false"`
// The service account scopes for launched
// instance. Defaults to:
Scopes []string `mapstructure:"scopes" required:"false"`
// The service account to be used for
// launched instance. Defaults to the project's default service account unless
// disable_default_service_account is true.
ServiceAccountEmail string `mapstructure:"service_account_email" required:"false"`
// The source image to use to create the new image
// from. You can also specify source_image_family instead. If both
// source_image and source_image_family are specified, source_image
// takes precedence. Example: "debian-8-jessie-v20161027"
SourceImage string `mapstructure:"source_image" required:"true"`
// The source image family to use to create
// the new image from. The image family always returns its latest image that
// is not deprecated. Example: "debian-8".
SourceImageFamily string `mapstructure:"source_image_family" required:"true"`
// The project ID of the project
// containing the source image.
SourceImageProjectId string `mapstructure:"source_image_project_id" required:"false"`
// The path to a startup script to run on the
// VM from which the image will be made.
StartupScriptFile string `mapstructure:"startup_script_file" required:"false"`
// The Google Compute subnetwork id or URL to use for
// the launched instance. Only required if the network has been created with
// custom subnetting. Note, the region of the subnetwork must match the
// region or zone in which the VM is launched. If the value is not a URL,
// it will be interpolated to
// projects/((network_project_id))/regions/((region))/subnetworks/((subnetwork))
Subnetwork string `mapstructure:"subnetwork" required:"false"`
// Assign network tags to apply firewall rules to
// VM instance.
Tags []string `mapstructure:"tags" required:"false"`
// If true, use the instance's internal IP
// instead of its external IP during building.
UseInternalIP bool `mapstructure:"use_internal_ip" required:"false"`
// The zone in which to launch the instance used to create
// the image. Example: "us-central1-a"
Zone string `mapstructure:"zone" required:"true"`
Account AccountFile Account AccountFile
stateTimeout time.Duration stateTimeout time.Duration

91
builder/hyperone/config.go
View File

@ -32,32 +32,61 @@ const (
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// Custom API endpoint URL, compatible with HyperOne.
APIURL string `mapstructure:"api_url"` // It can also be specified via environment variable HYPERONE_API_URL.
Token string `mapstructure:"token"` APIURL string `mapstructure:"api_url" required:"false"`
Project string `mapstructure:"project"` // The authentication token used to access your account.
TokenLogin string `mapstructure:"token_login"` // This can be either a session token or a service account token.
// If not defined, the builder will attempt to find it in the following order:
StateTimeout time.Duration `mapstructure:"state_timeout"` Token string `mapstructure:"token" required:"true"`
// The id or name of the project. This field is required
SourceImage string `mapstructure:"source_image"` // only if using session tokens. It should be skipped when using service
ImageName string `mapstructure:"image_name"` // account authentication.
ImageDescription string `mapstructure:"image_description"` Project string `mapstructure:"project" required:"true"`
ImageTags map[string]interface{} `mapstructure:"image_tags"` // Login (an e-mail) on HyperOne platform. Set this
ImageService string `mapstructure:"image_service"` // if you want to fetch the token by SSH authentication.
TokenLogin string `mapstructure:"token_login" required:"false"`
VmType string `mapstructure:"vm_type"` // Timeout for waiting on the API to complete
VmName string `mapstructure:"vm_name"` // a request. Defaults to 5m.
VmTags map[string]interface{} `mapstructure:"vm_tags"` StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`
// ID or name of the image to launch server from.
DiskName string `mapstructure:"disk_name"` SourceImage string `mapstructure:"source_image" required:"true"`
DiskType string `mapstructure:"disk_type"` // The name of the resulting image. Defaults to
DiskSize float32 `mapstructure:"disk_size"` // "packer-{{timestamp}}"
// (see configuration templates for more info).
Network string `mapstructure:"network"` ImageName string `mapstructure:"image_name" required:"false"`
PrivateIP string `mapstructure:"private_ip"` // The description of the resulting image.
PublicIP string `mapstructure:"public_ip"` ImageDescription string `mapstructure:"image_description" required:"false"`
PublicNetAdpService string `mapstructure:"public_netadp_service"` // Key/value pair tags to
// add to the created image.
ImageTags map[string]interface{} `mapstructure:"image_tags" required:"false"`
// The service of the resulting image.
ImageService string `mapstructure:"image_service" required:"false"`
// ID or name of the type this server should be created with.
VmType string `mapstructure:"vm_type" required:"true"`
// The name of the created server.
VmName string `mapstructure:"vm_name" required:"false"`
// Key/value pair tags to
// add to the created server.
VmTags map[string]interface{} `mapstructure:"vm_tags" required:"false"`
// The name of the created disk.
DiskName string `mapstructure:"disk_name" required:"false"`
// The type of the created disk. Defaults to ssd.
DiskType string `mapstructure:"disk_type" required:"false"`
// Size of the created disk, in GiB.
DiskSize float32 `mapstructure:"disk_size" required:"true"`
// The ID of the network to attach to the created server.
Network string `mapstructure:"network" required:"false"`
// The ID of the private IP within chosen network
// that should be assigned to the created server.
PrivateIP string `mapstructure:"private_ip" required:"false"`
// The ID of the public IP that should be assigned to
// the created server. If network is chosen, the public IP will be associated
// with server's private IP.
PublicIP string `mapstructure:"public_ip" required:"false"`
// Custom service of public network adapter.
// Can be useful when using custom api_url. Defaults to public.
PublicNetAdpService string `mapstructure:"public_netadp_service" required:"false"`
ChrootDisk bool `mapstructure:"chroot_disk"` ChrootDisk bool `mapstructure:"chroot_disk"`
ChrootDiskSize float32 `mapstructure:"chroot_disk_size"` ChrootDiskSize float32 `mapstructure:"chroot_disk_size"`
@ -71,9 +100,13 @@ type Config struct {
MountPartition string `mapstructure:"mount_partition"` MountPartition string `mapstructure:"mount_partition"`
PreMountCommands []string `mapstructure:"pre_mount_commands"` PreMountCommands []string `mapstructure:"pre_mount_commands"`
PostMountCommands []string `mapstructure:"post_mount_commands"` PostMountCommands []string `mapstructure:"post_mount_commands"`
// List of SSH keys by name or id to be added
SSHKeys []string `mapstructure:"ssh_keys"` // to the server on launch.
UserData string `mapstructure:"user_data"` SSHKeys []string `mapstructure:"ssh_keys" required:"false"`
// User data to launch with the server. Packer will not
// automatically wait for a user script to finish before shutting down the
// instance, this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

9
builder/hyperv/common/output_config.go
View File

@ -8,7 +8,14 @@ import (
) )
type OutputConfig struct { type OutputConfig struct {
OutputDir string `mapstructure:"output_directory"` // This setting specifies the directory that
// artifacts from the build, such as the virtual machine files and disks,
// will be output to. The path to the directory may be relative or
// absolute. If relative, the path is relative to the working directory
// packer is executed from. This directory must not exist or, if
// created, must be empty prior to running the builder. By default this is
// "output-BUILDNAME" where "BUILDNAME" is the name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"`
} }
func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error { func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error {

16
builder/hyperv/common/shutdown_config.go
View File

@ -8,8 +8,20 @@ import (
) )
type ShutdownConfig struct { type ShutdownConfig struct {
ShutdownCommand string `mapstructure:"shutdown_command"` // The command to use to gracefully shut down
RawShutdownTimeout string `mapstructure:"shutdown_timeout"` // the machine once all provisioning is complete. By default this is an
// empty string, which tells Packer to just forcefully shut down the
// machine. This setting can be safely omitted if for example, a shutdown
// command to gracefully halt the machine is configured inside a
// provisioning script. If one or more scripts require a reboot it is
// suggested to leave this blank (since reboots may fail) and instead
// specify the final shutdown command in your last script.
ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
// The amount of time to wait after executing
// the shutdown_command for the virtual machine to actually shut down.
// If the machine doesn't shut down in this time it is considered an
// error. By default, the time out is "5m" (five minutes).
RawShutdownTimeout string `mapstructure:"shutdown_timeout" required:"false"`
ShutdownTimeout time.Duration `` ShutdownTimeout time.Duration ``
} }

180
builder/hyperv/iso/builder.go
View File

@ -58,63 +58,133 @@ type Config struct {
hypervcommon.OutputConfig `mapstructure:",squash"` hypervcommon.OutputConfig `mapstructure:",squash"`
hypervcommon.SSHConfig `mapstructure:",squash"` hypervcommon.SSHConfig `mapstructure:",squash"`
hypervcommon.ShutdownConfig `mapstructure:",squash"` hypervcommon.ShutdownConfig `mapstructure:",squash"`
// The size, in megabytes, of the hard disk to create
// The size, in megabytes, of the hard disk to create for the VM. // for the VM. By default, this is 40 GB.
// By default, this is 130048 (about 127 GB). DiskSize uint `mapstructure:"disk_size" required:"false"`
DiskSize uint `mapstructure:"disk_size"` // The block size of the VHD to be created.
// Recommended disk block size for Linux hyper-v guests is 1 MiB. This
// The size, in megabytes, of the block size used to create the hard disk. // defaults to "32 MiB".
// By default, this is 32768 (about 32 MB) DiskBlockSize uint `mapstructure:"disk_block_size" required:"false"`
DiskBlockSize uint `mapstructure:"disk_block_size"` // The amount, in megabytes, of RAM to assign to the
// VM. By default, this is 1 GB.
// The size, in megabytes, of the computer memory in the VM. RamSize uint `mapstructure:"memory" required:"false"`
// By default, this is 1024 (about 1 GB). // A list of ISO paths to
RamSize uint `mapstructure:"memory"` // attach to a VM when it is booted. This is most useful for unattended
// Windows installs, which look for an Autounattend.xml file on removable
// // media. By default, no secondary ISO will be attached.
SecondaryDvdImages []string `mapstructure:"secondary_iso_images"` SecondaryDvdImages []string `mapstructure:"secondary_iso_images" required:"false"`
// If set to attach then attach and
// Should integration services iso be mounted // mount the ISO image specified in guest_additions_path. If set to
GuestAdditionsMode string `mapstructure:"guest_additions_mode"` // none then guest additions are not attached and mounted; This is the
// default.
// The path to the integration services iso GuestAdditionsMode string `mapstructure:"guest_additions_mode" required:"false"`
GuestAdditionsPath string `mapstructure:"guest_additions_path"` // The path to the ISO image for guest
// additions.
// This is the name of the new virtual machine. GuestAdditionsPath string `mapstructure:"guest_additions_path" required:"false"`
// By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build. // This is the name of the new virtual machine,
VMName string `mapstructure:"vm_name"` // without the file extension. By default this is "packer-BUILDNAME",
// where "BUILDNAME" is the name of the build.
SwitchName string `mapstructure:"switch_name"` VMName string `mapstructure:"vm_name" required:"false"`
SwitchVlanId string `mapstructure:"switch_vlan_id"` // The name of the switch to connect the virtual
MacAddress string `mapstructure:"mac_address"` // machine to. By default, leaving this value unset will cause Packer to
VlanId string `mapstructure:"vlan_id"` // try and determine the switch to use by looking for an external switch
Cpu uint `mapstructure:"cpus"` // that is up and running.
Generation uint `mapstructure:"generation"` SwitchName string `mapstructure:"switch_name" required:"false"`
EnableMacSpoofing bool `mapstructure:"enable_mac_spoofing"` // This is the VLAN of the virtual switch's
UseLegacyNetworkAdapter bool `mapstructure:"use_legacy_network_adapter"` // network card. By default none is set. If none is set then a VLAN is not
EnableDynamicMemory bool `mapstructure:"enable_dynamic_memory"` // set on the switch's network card. If this value is set it should match
EnableSecureBoot bool `mapstructure:"enable_secure_boot"` // the VLAN specified in by vlan_id.
SecureBootTemplate string `mapstructure:"secure_boot_template"` SwitchVlanId string `mapstructure:"switch_vlan_id" required:"false"`
EnableVirtualizationExtensions bool `mapstructure:"enable_virtualization_extensions"` // This allows a specific MAC address to be used on
TempPath string `mapstructure:"temp_path"` // the default virtual network card. The MAC address must be a string with
Version string `mapstructure:"configuration_version"` // no delimiters, for example "0000deadbeef".
KeepRegistered bool `mapstructure:"keep_registered"` MacAddress string `mapstructure:"mac_address" required:"false"`
// This is the VLAN of the virtual machine's network
// card for the new virtual machine. By default none is set. If none is set
// then VLANs are not set on the virtual machine's network card.
VlanId string `mapstructure:"vlan_id" required:"false"`
// The number of CPUs the virtual machine should use. If
// this isn't specified, the default is 1 CPU.
Cpu uint `mapstructure:"cpus" required:"false"`
// The Hyper-V generation for the virtual machine. By
// default, this is 1. Generation 2 Hyper-V virtual machines do not support
// floppy drives. In this scenario use secondary_iso_images instead. Hard
// drives and DVD drives will also be SCSI and not IDE.
Generation uint `mapstructure:"generation" required:"false"`
// If true enable MAC address spoofing
// for the virtual machine. This defaults to false.
EnableMacSpoofing bool `mapstructure:"enable_mac_spoofing" required:"false"`
// If true use a legacy network adapter as the NIC.
// This defaults to false. A legacy network adapter is fully emulated NIC, and is thus
// supported by various exotic operating systems, but this emulation requires
// additional overhead and should only be used if absolutely necessary.
UseLegacyNetworkAdapter bool `mapstructure:"use_legacy_network_adapter" required:"false"`
// If true enable dynamic memory for
// the virtual machine. This defaults to false.
EnableDynamicMemory bool `mapstructure:"enable_dynamic_memory" required:"false"`
// If true enable secure boot for the
// virtual machine. This defaults to false. See secure_boot_template
// below for additional settings.
EnableSecureBoot bool `mapstructure:"enable_secure_boot" required:"false"`
// The secure boot template to be
// configured. Valid values are "MicrosoftWindows" (Windows) or
// "MicrosoftUEFICertificateAuthority" (Linux). This only takes effect if
// enable_secure_boot is set to "true". This defaults to "MicrosoftWindows".
SecureBootTemplate string `mapstructure:"secure_boot_template" required:"false"`
// If true enable
// virtualization extensions for the virtual machine. This defaults to
// false. For nested virtualization you need to enable MAC spoofing,
// disable dynamic memory and have at least 4GB of RAM assigned to the
// virtual machine.
EnableVirtualizationExtensions bool `mapstructure:"enable_virtualization_extensions" required:"false"`
// The location under which Packer will create a
// directory to house all the VM files and folders during the build.
// By default %TEMP% is used which, for most systems, will evaluate to
// %USERPROFILE%/AppData/Local/Temp.
TempPath string `mapstructure:"temp_path" required:"false"`
// This allows you to set the vm version when
// calling New-VM to generate the vm.
Version string `mapstructure:"configuration_version" required:"false"`
// If "true", Packer will not delete the VM from
// The Hyper-V manager.
KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
Communicator string `mapstructure:"communicator"` Communicator string `mapstructure:"communicator"`
// The size or sizes of any
AdditionalDiskSize []uint `mapstructure:"disk_additional_size"` // additional hard disks for the VM in megabytes. If this is not specified
// then the VM will only contain a primary hard disk. Additional drives
SkipCompaction bool `mapstructure:"skip_compaction"` // will be attached to the SCSI interface only. The builder uses
// expandable rather than fixed-size virtual hard disks, so the actual
SkipExport bool `mapstructure:"skip_export"` // file representing the disk will not use the full size unless it is
// full.
// Use differencing disk AdditionalDiskSize []uint `mapstructure:"disk_additional_size" required:"false"`
DifferencingDisk bool `mapstructure:"differencing_disk"` // If true skip compacting the hard disk for
// the virtual machine when exporting. This defaults to false.
// Create the VM with a Fixed VHD format disk instead of Dynamic VHDX SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
FixedVHD bool `mapstructure:"use_fixed_vhd_format"` // If true Packer will skip the export of the VM.
// If you are interested only in the VHD/VHDX files, you can enable this
Headless bool `mapstructure:"headless"` // option. The resulting VHD/VHDX file will be output to
// <output_directory>/Virtual Hard Disks. By default this option is false
// and Packer will export the VM to output_directory.
SkipExport bool `mapstructure:"skip_export" required:"false"`
// If true enables differencing disks. Only
// the changes will be written to the new disk. This is especially useful if
// your source is a VHD/VHDX. This defaults to false.
DifferencingDisk bool `mapstructure:"differencing_disk" required:"false"`
// If true, creates the boot disk on the
// virtual machine as a fixed VHD format disk. The default is false, which
// creates a dynamic VHDX format disk. This option requires setting
// generation to 1, skip_compaction to true, and
// differencing_disk to false. Additionally, any value entered for
// disk_block_size will be ignored. The most likely use case for this
// option is outputing a disk that is in the format required for upload to
// Azure.
FixedVHD bool `mapstructure:"use_fixed_vhd_format" required:"false"`
// Packer defaults to building Hyper-V virtual
// machines by launching a GUI that shows the console of the machine being
// built. When this value is set to true, the machine will start without a
// console.
Headless bool `mapstructure:"headless" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

158
builder/hyperv/vmcx/builder.go
View File

@ -48,62 +48,124 @@ type Config struct {
hypervcommon.OutputConfig `mapstructure:",squash"` hypervcommon.OutputConfig `mapstructure:",squash"`
hypervcommon.SSHConfig `mapstructure:",squash"` hypervcommon.SSHConfig `mapstructure:",squash"`
hypervcommon.ShutdownConfig `mapstructure:",squash"` hypervcommon.ShutdownConfig `mapstructure:",squash"`
// The amount, in megabytes, of RAM to assign to the
// The size, in megabytes, of the computer memory in the VM. // VM. By default, this is 1 GB.
// By default, this is 1024 (about 1 GB). RamSize uint `mapstructure:"memory" required:"false"`
RamSize uint `mapstructure:"memory"` // A list of ISO paths to
// attach to a VM when it is booted. This is most useful for unattended
// // Windows installs, which look for an Autounattend.xml file on removable
SecondaryDvdImages []string `mapstructure:"secondary_iso_images"` // media. By default, no secondary ISO will be attached.
SecondaryDvdImages []string `mapstructure:"secondary_iso_images" required:"false"`
// Should integration services iso be mounted // If set to attach then attach and
GuestAdditionsMode string `mapstructure:"guest_additions_mode"` // mount the ISO image specified in guest_additions_path. If set to
// none then guest additions are not attached and mounted; This is the
// The path to the integration services iso // default.
GuestAdditionsPath string `mapstructure:"guest_additions_path"` GuestAdditionsMode string `mapstructure:"guest_additions_mode" required:"false"`
// The path to the ISO image for guest
// additions.
GuestAdditionsPath string `mapstructure:"guest_additions_path" required:"false"`
// This is the path to a directory containing an exported virtual machine. // This is the path to a directory containing an exported virtual machine.
CloneFromVMCXPath string `mapstructure:"clone_from_vmcx_path"` CloneFromVMCXPath string `mapstructure:"clone_from_vmcx_path"`
// This is the name of the virtual machine to clone from. // This is the name of the virtual machine to clone from.
CloneFromVMName string `mapstructure:"clone_from_vm_name"` CloneFromVMName string `mapstructure:"clone_from_vm_name"`
// The name of a snapshot in the
// This is the name of the snapshot to clone from. A blank snapshot name will use the latest snapshot. // source machine to use as a starting point for the clone. If the value
CloneFromSnapshotName string `mapstructure:"clone_from_snapshot_name"` // given is an empty string, the last snapshot present in the source will
// be chosen as the starting point for the new VM.
// This will clone all snapshots if true. It will clone latest snapshot if false. CloneFromSnapshotName string `mapstructure:"clone_from_snapshot_name" required:"false"`
CloneAllSnapshots bool `mapstructure:"clone_all_snapshots"` // If set to true all snapshots
// present in the source machine will be copied when the machine is
// This is the name of the new virtual machine. // cloned. The final result of the build will be an exported virtual
// By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build. // machine that contains all the snapshots of the parent.
VMName string `mapstructure:"vm_name"` CloneAllSnapshots bool `mapstructure:"clone_all_snapshots" required:"false"`
// This is the name of the new virtual machine,
// Use differencing disk // without the file extension. By default this is "packer-BUILDNAME",
DifferencingDisk bool `mapstructure:"differencing_disk"` // where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
SwitchName string `mapstructure:"switch_name"` // If true enables differencing disks. Only
CompareCopy bool `mapstructure:"copy_in_compare"` // the changes will be written to the new disk. This is especially useful if
SwitchVlanId string `mapstructure:"switch_vlan_id"` // your source is a VHD/VHDX. This defaults to false.
MacAddress string `mapstructure:"mac_address"` DifferencingDisk bool `mapstructure:"differencing_disk" required:"false"`
VlanId string `mapstructure:"vlan_id"` // The name of the switch to connect the virtual
Cpu uint `mapstructure:"cpus"` // machine to. By default, leaving this value unset will cause Packer to
Generation uint `mapstructure:"generation"` // try and determine the switch to use by looking for an external switch
EnableMacSpoofing bool `mapstructure:"enable_mac_spoofing"` // that is up and running.
EnableDynamicMemory bool `mapstructure:"enable_dynamic_memory"` SwitchName string `mapstructure:"switch_name" required:"false"`
EnableSecureBoot bool `mapstructure:"enable_secure_boot"` // When cloning a vm to build from, we run a powershell
SecureBootTemplate string `mapstructure:"secure_boot_template"` // Compare-VM command, which, depending on your version of Windows, may need
EnableVirtualizationExtensions bool `mapstructure:"enable_virtualization_extensions"` // the "Copy" flag to be set to true or false. Defaults to "false". Command:
TempPath string `mapstructure:"temp_path"` CompareCopy bool `mapstructure:"copy_in_compare" required:"false"`
Version string `mapstructure:"configuration_version"` // This is the VLAN of the virtual switch's
KeepRegistered bool `mapstructure:"keep_registered"` // network card. By default none is set. If none is set then a VLAN is not
// set on the switch's network card. If this value is set it should match
// the VLAN specified in by vlan_id.
SwitchVlanId string `mapstructure:"switch_vlan_id" required:"false"`
// This allows a specific MAC address to be used on
// the default virtual network card. The MAC address must be a string with
// no delimiters, for example "0000deadbeef".
MacAddress string `mapstructure:"mac_address" required:"false"`
// This is the VLAN of the virtual machine's network
// card for the new virtual machine. By default none is set. If none is set
// then VLANs are not set on the virtual machine's network card.
VlanId string `mapstructure:"vlan_id" required:"false"`
// The number of CPUs the virtual machine should use. If
// this isn't specified, the default is 1 CPU.
Cpu uint `mapstructure:"cpus" required:"false"`
// The Hyper-V generation for the virtual machine. By
// default, this is 1. Generation 2 Hyper-V virtual machines do not support
// floppy drives. In this scenario use secondary_iso_images instead. Hard
// drives and DVD drives will also be SCSI and not IDE.
Generation uint `mapstructure:"generation" required:"false"`
// If true enable MAC address spoofing
// for the virtual machine. This defaults to false.
EnableMacSpoofing bool `mapstructure:"enable_mac_spoofing" required:"false"`
// If true enable dynamic memory for
// the virtual machine. This defaults to false.
EnableDynamicMemory bool `mapstructure:"enable_dynamic_memory" required:"false"`
// If true enable secure boot for the
// virtual machine. This defaults to false. See secure_boot_template
// below for additional settings.
EnableSecureBoot bool `mapstructure:"enable_secure_boot" required:"false"`
// The secure boot template to be
// configured. Valid values are "MicrosoftWindows" (Windows) or
// "MicrosoftUEFICertificateAuthority" (Linux). This only takes effect if
// enable_secure_boot is set to "true". This defaults to "MicrosoftWindows".
SecureBootTemplate string `mapstructure:"secure_boot_template" required:"false"`
// If true enable
// virtualization extensions for the virtual machine. This defaults to
// false. For nested virtualization you need to enable MAC spoofing,
// disable dynamic memory and have at least 4GB of RAM assigned to the
// virtual machine.
EnableVirtualizationExtensions bool `mapstructure:"enable_virtualization_extensions" required:"false"`
// The location under which Packer will create a
// directory to house all the VM files and folders during the build.
// By default %TEMP% is used which, for most systems, will evaluate to
// %USERPROFILE%/AppData/Local/Temp.
TempPath string `mapstructure:"temp_path" required:"false"`
// This allows you to set the vm version when
// calling New-VM to generate the vm.
Version string `mapstructure:"configuration_version" required:"false"`
// If "true", Packer will not delete the VM from
// The Hyper-V manager.
KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
Communicator string `mapstructure:"communicator"` Communicator string `mapstructure:"communicator"`
// If true skip compacting the hard disk for
SkipCompaction bool `mapstructure:"skip_compaction"` // the virtual machine when exporting. This defaults to false.
SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
SkipExport bool `mapstructure:"skip_export"` // If true Packer will skip the export of the VM.
// If you are interested only in the VHD/VHDX files, you can enable this
Headless bool `mapstructure:"headless"` // option. The resulting VHD/VHDX file will be output to
// <output_directory>/Virtual Hard Disks. By default this option is false
// and Packer will export the VM to output_directory.
SkipExport bool `mapstructure:"skip_export" required:"false"`
// Packer defaults to building Hyper-V virtual
// machines by launching a GUI that shows the console of the machine being
// built. When this value is set to true, the machine will start without a
// console.
Headless bool `mapstructure:"headless" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

58
builder/lxc/config.go
View File

@ -14,18 +14,52 @@ import (
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
ConfigFile string `mapstructure:"config_file"` // The path to the lxc configuration file.
OutputDir string `mapstructure:"output_directory"` ConfigFile string `mapstructure:"config_file" required:"true"`
ContainerName string `mapstructure:"container_name"` // The directory in which to save the exported
CommandWrapper string `mapstructure:"command_wrapper"` // tar.gz. Defaults to output-<BuildName> in the current directory.
RawInitTimeout string `mapstructure:"init_timeout"` OutputDir string `mapstructure:"output_directory" required:"false"`
CreateOptions []string `mapstructure:"create_options"` // The name of the LXC container. Usually stored
StartOptions []string `mapstructure:"start_options"` // in /var/lib/lxc/containers/<container_name>. Defaults to
AttachOptions []string `mapstructure:"attach_options"` // packer-<BuildName>.
Name string `mapstructure:"template_name"` ContainerName string `mapstructure:"container_name" required:"false"`
Parameters []string `mapstructure:"template_parameters"` // Allows you to specify a wrapper command, such
EnvVars []string `mapstructure:"template_environment_vars"` // as ssh so you can execute packer builds on a remote host. Defaults to
TargetRunlevel int `mapstructure:"target_runlevel"` // Empty.
CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
// The timeout in seconds to wait for the the
// container to start. Defaults to 20 seconds.
RawInitTimeout string `mapstructure:"init_timeout" required:"false"`
// Options to pass to lxc-create. For
// instance, you can specify a custom LXC container configuration file with
// ["-f", "/path/to/lxc.conf"]. Defaults to []. See man 1 lxc-create for
// available options.
CreateOptions []string `mapstructure:"create_options" required:"false"`
// Options to pass to lxc-start. For
// instance, you can override parameters from the LXC container configuration
// file via ["--define", "KEY=VALUE"]. Defaults to []. See
// man 1 lxc-start for available options.
StartOptions []string `mapstructure:"start_options" required:"false"`
// Options to pass to lxc-attach. For
// instance, you can prevent the container from inheriting the host machine's
// environment by specifying ["--clear-env"]. Defaults to []. See
// man 1 lxc-attach for available options.
AttachOptions []string `mapstructure:"attach_options" required:"false"`
// The LXC template name to use.
Name string `mapstructure:"template_name" required:"true"`
// Options to pass to the given
// lxc-template command, usually located in
// /usr/share/lxc/templates/lxc-<template_name>. Note: This gets passed as
// ARGV to the template command. Ensure you have an array of strings, as a
// single string with spaces probably won't work. Defaults to [].
Parameters []string `mapstructure:"template_parameters" required:"false"`
// Environmental variables to
// use to build the template with.
EnvVars []string `mapstructure:"template_environment_vars" required:"true"`
// The minimum run level to wait for the
// container to reach. Note some distributions (Ubuntu) simulate run levels
// and may report 5 rather than 3.
TargetRunlevel int `mapstructure:"target_runlevel" required:"false"`
InitTimeout time.Duration InitTimeout time.Duration
ctx interpolate.Context ctx interpolate.Context

28
builder/lxd/config.go
View File

@ -12,14 +12,30 @@ import (
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
OutputImage string `mapstructure:"output_image"` // The name of the output artifact. Defaults to
// name.
OutputImage string `mapstructure:"output_image" required:"false"`
ContainerName string `mapstructure:"container_name"` ContainerName string `mapstructure:"container_name"`
CommandWrapper string `mapstructure:"command_wrapper"` // Lets you prefix all builder commands, such as
Image string `mapstructure:"image"` // with ssh for a remote build host. Defaults to "".
CommandWrapper string `mapstructure:"command_wrapper" required:"false"`
// The source image to use when creating the build
// container. This can be a (local or remote) image (name or fingerprint).
// E.G. my-base-image, ubuntu-daily:x, 08fababf6f27, ...
Image string `mapstructure:"image" required:"true"`
Profile string `mapstructure:"profile"` Profile string `mapstructure:"profile"`
InitSleep string `mapstructure:"init_sleep"` // The number of seconds to sleep between launching
PublishProperties map[string]string `mapstructure:"publish_properties"` // the LXD instance and provisioning it; defaults to 3 seconds.
LaunchConfig map[string]string `mapstructure:"launch_config"` InitSleep string `mapstructure:"init_sleep" required:"false"`
// Pass key values to the publish
// step to be set as properties on the output image. This is most helpful to
// set the description, but can be used to set anything needed. See
// https://stgraber.org/2016/03/30/lxd-2-0-image-management-512/
// for more properties.
PublishProperties map[string]string `mapstructure:"publish_properties" required:"false"`
// List of key/value pairs you wish to
// pass to lxc launch via --config. Defaults to empty.
LaunchConfig map[string]string `mapstructure:"launch_config" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

43
builder/ncloud/config.go
View File

@ -18,16 +18,39 @@ type Config struct {
AccessKey string `mapstructure:"access_key"` AccessKey string `mapstructure:"access_key"`
SecretKey string `mapstructure:"secret_key"` SecretKey string `mapstructure:"secret_key"`
ServerImageProductCode string `mapstructure:"server_image_product_code"` // Product code of an image to create.
ServerProductCode string `mapstructure:"server_product_code"` // (member_server_image_no is required if not specified)
MemberServerImageNo string `mapstructure:"member_server_image_no"` ServerImageProductCode string `mapstructure:"server_image_product_code" required:"true"`
ServerImageName string `mapstructure:"server_image_name"` // Product (spec) code to create.
ServerImageDescription string `mapstructure:"server_image_description"` ServerProductCode string `mapstructure:"server_product_code" required:"true"`
UserData string `mapstructure:"user_data"` // Previous image code. If there is an
UserDataFile string `mapstructure:"user_data_file"` // image previously created, it can be used to create a new image.
BlockStorageSize int `mapstructure:"block_storage_size"` // (server_image_product_code is required if not specified)
Region string `mapstructure:"region"` MemberServerImageNo string `mapstructure:"member_server_image_no" required:"false"`
AccessControlGroupConfigurationNo string `mapstructure:"access_control_group_configuration_no"` // Name of an image to create.
ServerImageName string `mapstructure:"server_image_name" required:"false"`
// Description of an image to create.
ServerImageDescription string `mapstructure:"server_image_description" required:"false"`
// User data to apply when launching the instance. Note
// that you need to be careful about escaping characters due to the templates
// being JSON. It is often more convenient to use user_data_file, instead.
// Packer will not automatically wait for a user script to finish before
// shutting down the instance this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the instance.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// You can add block storage ranging from 10
// GB to 2000 GB, in increments of 10 GB.
BlockStorageSize int `mapstructure:"block_storage_size" required:"false"`
// Name of the region where you want to create an image.
// (default: Korea)
Region string `mapstructure:"region" required:"false"`
// This is used to allow
// winrm access when you create a Windows server. An ACG that specifies an
// access source (0.0.0.0/0) and allowed port (5985) must be created in
// advance.
AccessControlGroupConfigurationNo string `mapstructure:"access_control_group_configuration_no" required:"false"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
ctx *interpolate.Context ctx *interpolate.Context

83
builder/openstack/access_config.go
View File

@ -16,25 +16,76 @@ import (
// AccessConfig is for common configuration related to openstack access // AccessConfig is for common configuration related to openstack access
type AccessConfig struct { type AccessConfig struct {
Username string `mapstructure:"username"` // The username or id used to connect to
// the OpenStack service. If not specified, Packer will use the environment
// variable OS_USERNAME or OS_USERID, if set. This is not required if
// using access token or application credential instead of password, or if using
// cloud.yaml.
Username string `mapstructure:"username" required:"true"`
UserID string `mapstructure:"user_id"` UserID string `mapstructure:"user_id"`
Password string `mapstructure:"password"` // The password used to connect to the OpenStack
IdentityEndpoint string `mapstructure:"identity_endpoint"` // service. If not specified, Packer will use the environment variables
TenantID string `mapstructure:"tenant_id"` // OS_PASSWORD, if set. This is not required if using access token or
// application credential instead of password, or if using cloud.yaml.
Password string `mapstructure:"password" required:"true"`
// The URL to the OpenStack Identity service.
// If not specified, Packer will use the environment variables OS_AUTH_URL,
// if set. This is not required if using cloud.yaml.
IdentityEndpoint string `mapstructure:"identity_endpoint" required:"true"`
// The tenant ID or name to boot the
// instance into. Some OpenStack installations require this. If not specified,
// Packer will use the environment variable OS_TENANT_NAME or
// OS_TENANT_ID, if set. Tenant is also called Project in later versions of
// OpenStack.
TenantID string `mapstructure:"tenant_id" required:"false"`
TenantName string `mapstructure:"tenant_name"` TenantName string `mapstructure:"tenant_name"`
DomainID string `mapstructure:"domain_id"` DomainID string `mapstructure:"domain_id"`
DomainName string `mapstructure:"domain_name"` // The Domain name or ID you are
Insecure bool `mapstructure:"insecure"` // authenticating with. OpenStack installations require this if identity v3 is
Region string `mapstructure:"region"` // used. Packer will use the environment variable OS_DOMAIN_NAME or
EndpointType string `mapstructure:"endpoint_type"` // OS_DOMAIN_ID, if set.
CACertFile string `mapstructure:"cacert"` DomainName string `mapstructure:"domain_name" required:"false"`
ClientCertFile string `mapstructure:"cert"` // Whether or not the connection to OpenStack can be
ClientKeyFile string `mapstructure:"key"` // done over an insecure connection. By default this is false.
Token string `mapstructure:"token"` Insecure bool `mapstructure:"insecure" required:"false"`
ApplicationCredentialName string `mapstructure:"application_credential_name"` // The name of the region, such as "DFW", in which to
ApplicationCredentialID string `mapstructure:"application_credential_id"` // launch the server to create the image. If not specified, Packer will use
ApplicationCredentialSecret string `mapstructure:"application_credential_secret"` // the environment variable OS_REGION_NAME, if set.
Cloud string `mapstructure:"cloud"` Region string `mapstructure:"region" required:"false"`
// The endpoint type to use. Can be any of
// "internal", "internalURL", "admin", "adminURL", "public", and "publicURL".
// By default this is "public".
EndpointType string `mapstructure:"endpoint_type" required:"false"`
// Custom CA certificate file path. If omitted the
// OS_CACERT environment variable can be used.
CACertFile string `mapstructure:"cacert" required:"false"`
// Client certificate file path for SSL client
// authentication. If omitted the OS_CERT environment variable can be used.
ClientCertFile string `mapstructure:"cert" required:"false"`
// Client private key file path for SSL client
// authentication. If omitted the OS_KEY environment variable can be used.
ClientKeyFile string `mapstructure:"key" required:"false"`
// the token (id) to use with token based authorization.
// Packer will use the environment variable OS_TOKEN, if set.
Token string `mapstructure:"token" required:"false"`
// The application credential name to
// use with application credential based authorization. Packer will use the
// environment variable OS_APPLICATION_CREDENTIAL_NAME, if set.
ApplicationCredentialName string `mapstructure:"application_credential_name" required:"false"`
// The application credential id to
// use with application credential based authorization. Packer will use the
// environment variable OS_APPLICATION_CREDENTIAL_ID, if set.
ApplicationCredentialID string `mapstructure:"application_credential_id" required:"false"`
// The application credential secret
// to use with application credential based authorization. Packer will use the
// environment variable OS_APPLICATION_CREDENTIAL_SECRET, if set.
ApplicationCredentialSecret string `mapstructure:"application_credential_secret" required:"false"`
// An entry in a clouds.yaml file. See the OpenStack
// os-client-config
// documentation
// for more information about clouds.yaml files. If omitted, the OS_CLOUD
// environment variable is used.
Cloud string `mapstructure:"cloud" required:"false"`
osClient *gophercloud.ProviderClient osClient *gophercloud.ProviderClient
} }

24
builder/openstack/image_config.go
View File

@ -10,12 +10,24 @@ import (
// ImageConfig is for common configuration related to creating Images. // ImageConfig is for common configuration related to creating Images.
type ImageConfig struct { type ImageConfig struct {
ImageName string `mapstructure:"image_name"` // The name of the resulting image.
ImageMetadata map[string]string `mapstructure:"metadata"` ImageName string `mapstructure:"image_name" required:"true"`
ImageVisibility imageservice.ImageVisibility `mapstructure:"image_visibility"` // Glance metadata that will be
ImageMembers []string `mapstructure:"image_members"` // applied to the image.
ImageDiskFormat string `mapstructure:"image_disk_format"` ImageMetadata map[string]string `mapstructure:"metadata" required:"false"`
ImageTags []string `mapstructure:"image_tags"` // One of "public", "private", "shared", or
// "community".
ImageVisibility imageservice.ImageVisibility `mapstructure:"image_visibility" required:"false"`
// List of members to add to the image
// after creation. An image member is usually a project (also called the
// "tenant") with whom the image is shared.
ImageMembers []string `mapstructure:"image_members" required:"false"`
// Disk format of the resulting image. This
// option works if use_blockstorage_volume is true.
ImageDiskFormat string `mapstructure:"image_disk_format" required:"false"`
// List of tags to add to the image after
// creation.
ImageTags []string `mapstructure:"image_tags" required:"false"`
} }
func (c *ImageConfig) Prepare(ctx *interpolate.Context) []error { func (c *ImageConfig) Prepare(ctx *interpolate.Context) []error {

139
builder/openstack/run_config.go
View File

@ -14,46 +14,121 @@ import (
// image and details on how to access that launched image. // image and details on how to access that launched image.
type RunConfig struct { type RunConfig struct {
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The ID or full URL to the base image to use. This
SourceImage string `mapstructure:"source_image"` // is the image that will be used to launch a new server and provision it.
SourceImageName string `mapstructure:"source_image_name"` // Unless you specify completely custom SSH settings, the source image must
SourceImageFilters ImageFilter `mapstructure:"source_image_filter"` // have cloud-init installed so that the keypair gets assigned properly.
Flavor string `mapstructure:"flavor"` SourceImage string `mapstructure:"source_image" required:"true"`
AvailabilityZone string `mapstructure:"availability_zone"` // The name of the base image to use. This is
RackconnectWait bool `mapstructure:"rackconnect_wait"` // an alternative way of providing source_image and only either of them can
FloatingIPNetwork string `mapstructure:"floating_ip_network"` // be specified.
FloatingIP string `mapstructure:"floating_ip"` SourceImageName string `mapstructure:"source_image_name" required:"true"`
ReuseIPs bool `mapstructure:"reuse_ips"` // The search filters for determining the base
SecurityGroups []string `mapstructure:"security_groups"` // image to use. This is an alternative way of providing source_image and
Networks []string `mapstructure:"networks"` // only one of these methods can be used. source_image will override the
Ports []string `mapstructure:"ports"` // filters.
UserData string `mapstructure:"user_data"` SourceImageFilters ImageFilter `mapstructure:"source_image_filter" required:"true"`
UserDataFile string `mapstructure:"user_data_file"` // The ID, name, or full URL for the desired flavor for
InstanceName string `mapstructure:"instance_name"` // the server to be created.
InstanceMetadata map[string]string `mapstructure:"instance_metadata"` Flavor string `mapstructure:"flavor" required:"true"`
ForceDelete bool `mapstructure:"force_delete"` // The availability zone to launch the server
// in. If this isn't specified, the default enforced by your OpenStack cluster
ConfigDrive bool `mapstructure:"config_drive"` // will be used. This may be required for some OpenStack clusters.
AvailabilityZone string `mapstructure:"availability_zone" required:"false"`
// Used for BC, value will be passed to the "floating_ip_network" // For rackspace, whether or not to wait for
FloatingIPPool string `mapstructure:"floating_ip_pool"` // Rackconnect to assign the machine an IP address before connecting via SSH.
// Defaults to false.
UseBlockStorageVolume bool `mapstructure:"use_blockstorage_volume"` RackconnectWait bool `mapstructure:"rackconnect_wait" required:"false"`
VolumeName string `mapstructure:"volume_name"` // The ID or name of an external network that
VolumeType string `mapstructure:"volume_type"` // can be used for creation of a new floating IP.
VolumeSize int `mapstructure:"volume_size"` FloatingIPNetwork string `mapstructure:"floating_ip_network" required:"false"`
VolumeAvailabilityZone string `mapstructure:"volume_availability_zone"` // A specific floating IP to assign to this instance.
FloatingIP string `mapstructure:"floating_ip" required:"false"`
// Whether or not to attempt to reuse existing
// unassigned floating ips in the project before allocating a new one. Note
// that it is not possible to safely do this concurrently, so if you are
// running multiple openstack builds concurrently, or if other processes are
// assigning and using floating IPs in the same openstack project while packer
// is running, you should not set this to true. Defaults to false.
ReuseIPs bool `mapstructure:"reuse_ips" required:"false"`
// A list of security groups by name to
// add to this instance.
SecurityGroups []string `mapstructure:"security_groups" required:"false"`
// A list of networks by UUID to attach to
// this instance.
Networks []string `mapstructure:"networks" required:"false"`
// A list of ports by UUID to attach to this
// instance.
Ports []string `mapstructure:"ports" required:"false"`
// User data to apply when launching the instance. Note
// that you need to be careful about escaping characters due to the templates
// being JSON. It is often more convenient to use user_data_file, instead.
// Packer will not automatically wait for a user script to finish before
// shutting down the instance this must be handled in a provisioner.
UserData string `mapstructure:"user_data" required:"false"`
// Path to a file that will be used for the user
// data when launching the instance.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// Name that is applied to the server instance
// created by Packer. If this isn't specified, the default is same as
// image_name.
InstanceName string `mapstructure:"instance_name" required:"false"`
// Metadata that is
// applied to the server instance created by Packer. Also called server
// properties in some documentation. The strings have a max size of 255 bytes
// each.
InstanceMetadata map[string]string `mapstructure:"instance_metadata" required:"false"`
// Whether to force the OpenStack instance to be
// forcefully deleted. This is useful for environments that have
// reclaim / soft deletion enabled. By default this is false.
ForceDelete bool `mapstructure:"force_delete" required:"false"`
// Whether or not nova should use ConfigDrive for
// cloud-init metadata.
ConfigDrive bool `mapstructure:"config_drive" required:"false"`
// Deprecated use floating_ip_network
// instead.
FloatingIPPool string `mapstructure:"floating_ip_pool" required:"false"`
// Use Block Storage service volume for
// the instance root volume instead of Compute service local volume (default).
UseBlockStorageVolume bool `mapstructure:"use_blockstorage_volume" required:"false"`
// Name of the Block Storage service volume. If this
// isn't specified, random string will be used.
VolumeName string `mapstructure:"volume_name" required:"false"`
// Type of the Block Storage service volume. If this
// isn't specified, the default enforced by your OpenStack cluster will be
// used.
VolumeType string `mapstructure:"volume_type" required:"false"`
// Size of the Block Storage service volume in GB. If
// this isn't specified, it is set to source image min disk value (if set) or
// calculated from the source image bytes size. Note that in some cases this
// needs to be specified, if use_blockstorage_volume is true.
VolumeSize int `mapstructure:"volume_size" required:"false"`
// Availability zone of the Block
// Storage service volume. If omitted, Compute instance availability zone will
// be used. If both of Compute instance and Block Storage volume availability
// zones aren't specified, the default enforced by your OpenStack cluster will
// be used.
VolumeAvailabilityZone string `mapstructure:"volume_availability_zone" required:"false"`
// Not really used, but here for BC // Not really used, but here for BC
OpenstackProvider string `mapstructure:"openstack_provider"` OpenstackProvider string `mapstructure:"openstack_provider"`
UseFloatingIp bool `mapstructure:"use_floating_ip"` // Deprecated use floating_ip or
// floating_ip_pool instead.
UseFloatingIp bool `mapstructure:"use_floating_ip" required:"false"`
sourceImageOpts images.ListOpts sourceImageOpts images.ListOpts
} }
type ImageFilter struct { type ImageFilter struct {
Filters ImageFilterOptions `mapstructure:"filters"` // filters used to select a source_image.
MostRecent bool `mapstructure:"most_recent"` // NOTE: This will fail unless exactly one image is returned, or
// most_recent is set to true. Of the filters described in
// ImageService, the
// following are valid:
Filters ImageFilterOptions `mapstructure:"filters" required:"false"`
// Selects the newest created image when true.
// This is most useful for selecting a daily distro build.
MostRecent bool `mapstructure:"most_recent" required:"false"`
} }
type ImageFilterOptions struct { type ImageFilterOptions struct {

20
builder/parallels/common/hw_config.go
View File

@ -7,14 +7,18 @@ import (
) )
type HWConfig struct { type HWConfig struct {
// The number of cpus to use for building the VM.
// cpu information // Defaults to 1.
CpuCount int `mapstructure:"cpus"` CpuCount int `mapstructure:"cpus" required:"false"`
MemorySize int `mapstructure:"memory"` // The amount of memory to use for building the VM in
// megabytes. Defaults to 512 megabytes.
// device presence MemorySize int `mapstructure:"memory" required:"false"`
Sound bool `mapstructure:"sound"` // Specifies whether to enable the sound device when
USB bool `mapstructure:"usb"` // building the VM. Defaults to false.
Sound bool `mapstructure:"sound" required:"false"`
// Specifies whether to enable the USB bus when building
// the VM. Defaults to false.
USB bool `mapstructure:"usb" required:"false"`
} }
func (c *HWConfig) Prepare(ctx *interpolate.Context) []error { func (c *HWConfig) Prepare(ctx *interpolate.Context) []error {

8
builder/parallels/common/output_config.go
View File

@ -11,7 +11,13 @@ import (
// OutputConfig contains the configuration for builder's output. // OutputConfig contains the configuration for builder's output.
type OutputConfig struct { type OutputConfig struct {
OutputDir string `mapstructure:"output_directory"` // This is the path to the directory where the
// resulting virtual machine will be created. This may be relative or absolute.
// If relative, the path is relative to the working directory when packer
// is executed. This directory must not exist or be empty prior to running
// the builder. By default this is "output-BUILDNAME" where "BUILDNAME" is the
// name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"`
} }
// Prepare configures the output directory or returns an error if it already exists. // Prepare configures the output directory or returns an error if it already exists.

12
builder/parallels/common/prlctl_config.go
View File

@ -7,7 +7,17 @@ import (
// PrlctlConfig contains the configuration for running "prlctl" commands // PrlctlConfig contains the configuration for running "prlctl" commands
// before the VM start. // before the VM start.
type PrlctlConfig struct { type PrlctlConfig struct {
Prlctl [][]string `mapstructure:"prlctl"` // Custom prlctl commands to execute
// in order to further customize the virtual machine being created. The value
// of this is an array of commands to execute. The commands are executed in the
// order defined in the template. For each command, the command is defined
// itself as an array of strings, where each string represents a single
// argument on the command-line to prlctl (but excluding prlctl itself).
// Each arg is treated as a configuration
// template, where the Name
// variable is replaced with the VM name. More details on how to use prlctl
// are below.
Prlctl [][]string `mapstructure:"prlctl" required:"false"`
} }
// Prepare sets the default value of "Prlctl" property. // Prepare sets the default value of "Prlctl" property.

5
builder/parallels/common/prlctl_post_config.go
View File

@ -7,7 +7,10 @@ import (
// PrlctlPostConfig contains the configuration for running "prlctl" commands // PrlctlPostConfig contains the configuration for running "prlctl" commands
// in the end of artifact build. // in the end of artifact build.
type PrlctlPostConfig struct { type PrlctlPostConfig struct {
PrlctlPost [][]string `mapstructure:"prlctl_post"` // Identical to prlctl, except
// that it is run after the virtual machine is shutdown, and before the virtual
// machine is exported.
PrlctlPost [][]string `mapstructure:"prlctl_post" required:"false"`
} }
// Prepare sets the default value of "PrlctlPost" property. // Prepare sets the default value of "PrlctlPost" property.

7
builder/parallels/common/prlctl_version_config.go
View File

@ -6,7 +6,12 @@ import (
// PrlctlVersionConfig contains the configuration for `prlctl` version. // PrlctlVersionConfig contains the configuration for `prlctl` version.
type PrlctlVersionConfig struct { type PrlctlVersionConfig struct {
PrlctlVersionFile string `mapstructure:"prlctl_version_file"` // The path within the virtual machine to
// upload a file that contains the prlctl version that was used to create
// the machine. This information can be useful for provisioning. By default
// this is ".prlctl_version", which will generally upload it into the
// home directory.
PrlctlVersionFile string `mapstructure:"prlctl_version_file" required:"false"`
} }
// Prepare sets the default value of "PrlctlVersionFile" property. // Prepare sets the default value of "PrlctlVersionFile" property.

11
builder/parallels/common/shutdown_config.go
View File

@ -9,8 +9,15 @@ import (
// ShutdownConfig contains the configuration for VM shutdown. // ShutdownConfig contains the configuration for VM shutdown.
type ShutdownConfig struct { type ShutdownConfig struct {
ShutdownCommand string `mapstructure:"shutdown_command"` // The command to use to gracefully shut down the
RawShutdownTimeout string `mapstructure:"shutdown_timeout"` // machine once all the provisioning is done. By default this is an empty
// string, which tells Packer to just forcefully shut down the machine.
ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
// The amount of time to wait after executing the
// shutdown_command for the virtual machine to actually shut down. If it
// doesn't shut down in this time, it is an error. By default, the timeout is
// "5m", or five minutes.
RawShutdownTimeout string `mapstructure:"shutdown_timeout" required:"false"`
ShutdownTimeout time.Duration `` ShutdownTimeout time.Duration ``
} }

23
builder/parallels/common/tools_config.go
View File

@ -17,9 +17,26 @@ const (
// ToolsConfig contains the builder configuration related to Parallels Tools. // ToolsConfig contains the builder configuration related to Parallels Tools.
type ToolsConfig struct { type ToolsConfig struct {
ParallelsToolsFlavor string `mapstructure:"parallels_tools_flavor"` // The flavor of the Parallels Tools ISO to
ParallelsToolsGuestPath string `mapstructure:"parallels_tools_guest_path"` // install into the VM. Valid values are "win", "lin", "mac", "os2"
ParallelsToolsMode string `mapstructure:"parallels_tools_mode"` // and "other". This can be omitted only if parallels_tools_mode
// is "disable".
ParallelsToolsFlavor string `mapstructure:"parallels_tools_flavor" required:"true"`
// The path in the virtual machine to
// upload Parallels Tools. This only takes effect if parallels_tools_mode
// is "upload". This is a configuration
// template that has a single
// valid variable: Flavor, which will be the value of
// parallels_tools_flavor. By default this is "prl-tools-{{.Flavor}}.iso"
// which should upload into the login directory of the user.
ParallelsToolsGuestPath string `mapstructure:"parallels_tools_guest_path" required:"false"`
// The method by which Parallels Tools are
// made available to the guest for installation. Valid options are "upload",
// "attach", or "disable". If the mode is "attach" the Parallels Tools ISO will
// be attached as a CD device to the virtual machine. If the mode is "upload"
// the Parallels Tools ISO will be uploaded to the path specified by
// parallels_tools_guest_path. The default value is "upload".
ParallelsToolsMode string `mapstructure:"parallels_tools_mode" required:"false"`
} }
// Prepare validates & sets up configuration options related to Parallels Tools. // Prepare validates & sets up configuration options related to Parallels Tools.

46
builder/parallels/iso/builder.go
View File

@ -36,14 +36,44 @@ type Config struct {
parallelscommon.ShutdownConfig `mapstructure:",squash"` parallelscommon.ShutdownConfig `mapstructure:",squash"`
parallelscommon.SSHConfig `mapstructure:",squash"` parallelscommon.SSHConfig `mapstructure:",squash"`
parallelscommon.ToolsConfig `mapstructure:",squash"` parallelscommon.ToolsConfig `mapstructure:",squash"`
// The size, in megabytes, of the hard disk to create
DiskSize uint `mapstructure:"disk_size"` // for the VM. By default, this is 40000 (about 40 GB).
DiskType string `mapstructure:"disk_type"` DiskSize uint `mapstructure:"disk_size" required:"false"`
GuestOSType string `mapstructure:"guest_os_type"` // The type for image file based virtual disk drives,
HardDriveInterface string `mapstructure:"hard_drive_interface"` // defaults to expand. Valid options are expand (expanding disk) that the
HostInterfaces []string `mapstructure:"host_interfaces"` // image file is small initially and grows in size as you add data to it, and
SkipCompaction bool `mapstructure:"skip_compaction"` // plain (plain disk) that the image file has a fixed size from the moment it
VMName string `mapstructure:"vm_name"` // is created (i.e the space is allocated for the full drive). Plain disks
// perform faster than expanding disks. skip_compaction will be set to true
// automatically for plain disks.
DiskType string `mapstructure:"disk_type" required:"false"`
// The guest OS type being installed. By default
// this is "other", but you can get dramatic performance improvements by
// setting this to the proper value. To view all available values for this run
// prlctl create x --distribution list. Setting the correct value hints to
// Parallels Desktop how to optimize the virtual hardware to work best with
// that operating system.
GuestOSType string `mapstructure:"guest_os_type" required:"false"`
// The type of controller that the hard
// drives are attached to, defaults to "sata". Valid options are "sata", "ide",
// and "scsi".
HardDriveInterface string `mapstructure:"hard_drive_interface" required:"false"`
// A list of which interfaces on the
// host should be searched for a IP address. The first IP address found on one
// of these will be used as {{ .HTTPIP }} in the boot_command. Defaults to
// ["en0", "en1", "en2", "en3", "en4", "en5", "en6", "en7", "en8", "en9",
// "ppp0", "ppp1", "ppp2"].
HostInterfaces []string `mapstructure:"host_interfaces" required:"false"`
// Virtual disk image is compacted at the end of
// the build process using prl_disk_tool utility (except for the case that
// disk_type is set to plain). In certain rare cases, this might corrupt
// the resulting disk image. If you find this to be the case, you can disable
// compaction using this configuration value.
SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
// This is the name of the PVM directory for the new
// virtual machine, without the file extension. By default this is
// "packer-BUILDNAME", where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

22
builder/parallels/pvm/config.go
View File

@ -24,11 +24,23 @@ type Config struct {
parallelscommon.ShutdownConfig `mapstructure:",squash"` parallelscommon.ShutdownConfig `mapstructure:",squash"`
bootcommand.BootConfig `mapstructure:",squash"` bootcommand.BootConfig `mapstructure:",squash"`
parallelscommon.ToolsConfig `mapstructure:",squash"` parallelscommon.ToolsConfig `mapstructure:",squash"`
// The path to a PVM directory that acts as the source
SourcePath string `mapstructure:"source_path"` // of this build.
SkipCompaction bool `mapstructure:"skip_compaction"` SourcePath string `mapstructure:"source_path" required:"true"`
VMName string `mapstructure:"vm_name"` // Virtual disk image is compacted at the end of
ReassignMAC bool `mapstructure:"reassign_mac"` // the build process using prl_disk_tool utility (except for the case that
// disk_type is set to plain). In certain rare cases, this might corrupt
// the resulting disk image. If you find this to be the case, you can disable
// compaction using this configuration value.
SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
// This is the name of the PVM directory for the new
// virtual machine, without the file extension. By default this is
// "packer-BUILDNAME", where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
// If this is "false" the MAC address of the first
// NIC will reused when imported else a new MAC address will be generated
// by Parallels. Defaults to "false".
ReassignMAC bool `mapstructure:"reassign_mac" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

160
builder/qemu/builder.go
View File

@ -95,35 +95,134 @@ type Config struct {
bootcommand.VNCConfig `mapstructure:",squash"` bootcommand.VNCConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
common.FloppyConfig `mapstructure:",squash"` common.FloppyConfig `mapstructure:",squash"`
// Use iso from provided url. Qemu must support
ISOSkipCache bool `mapstructure:"iso_skip_cache"` // curl block device. This defaults to false.
Accelerator string `mapstructure:"accelerator"` ISOSkipCache bool `mapstructure:"iso_skip_cache" required:"false"`
CpuCount int `mapstructure:"cpus"` // The accelerator type to use when running the VM.
DiskInterface string `mapstructure:"disk_interface"` // This may be none, kvm, tcg, hax, hvf, whpx, or xen. The appropriate
DiskSize uint `mapstructure:"disk_size"` // software must have already been installed on your build machine to use the
DiskCache string `mapstructure:"disk_cache"` // accelerator you specified. When no accelerator is specified, Packer will try
DiskDiscard string `mapstructure:"disk_discard"` // to use kvm if it is available but will default to tcg otherwise.
DetectZeroes string `mapstructure:"disk_detect_zeroes"` Accelerator string `mapstructure:"accelerator" required:"false"`
SkipCompaction bool `mapstructure:"skip_compaction"` // The number of cpus to use when building the VM.
DiskCompression bool `mapstructure:"disk_compression"` // The default is 1 CPU.
Format string `mapstructure:"format"` CpuCount int `mapstructure:"cpus" required:"false"`
Headless bool `mapstructure:"headless"` // The interface to use for the disk. Allowed
DiskImage bool `mapstructure:"disk_image"` // values include any of ide, scsi, virtio or virtio-scsi*. Note
UseBackingFile bool `mapstructure:"use_backing_file"` // also that any boot commands or kickstart type scripts must have proper
MachineType string `mapstructure:"machine_type"` // adjustments for resulting device names. The Qemu builder uses virtio by
MemorySize int `mapstructure:"memory"` // default.
NetDevice string `mapstructure:"net_device"` DiskInterface string `mapstructure:"disk_interface" required:"false"`
OutputDir string `mapstructure:"output_directory"` // The size, in megabytes, of the hard disk to create
QemuArgs [][]string `mapstructure:"qemuargs"` // for the VM. By default, this is 40960 (40 GB).
QemuBinary string `mapstructure:"qemu_binary"` DiskSize uint `mapstructure:"disk_size" required:"false"`
ShutdownCommand string `mapstructure:"shutdown_command"` // The cache mode to use for disk. Allowed values
SSHHostPortMin int `mapstructure:"ssh_host_port_min"` // include any of writethrough, writeback, none, unsafe
// or directsync. By default, this is set to writeback.
DiskCache string `mapstructure:"disk_cache" required:"false"`
// The discard mode to use for disk. Allowed values
// include any of unmap or ignore. By default, this is set to ignore.
DiskDiscard string `mapstructure:"disk_discard" required:"false"`
// The detect-zeroes mode to use for disk.
// Allowed values include any of unmap, on or off. Defaults to off.
// When the value is "off" we don't set the flag in the qemu command, so that
// Packer still works with old versions of QEMU that don't have this option.
DetectZeroes string `mapstructure:"disk_detect_zeroes" required:"false"`
// Packer compacts the QCOW2 image using
// qemu-img convert. Set this option to true to disable compacting.
// Defaults to false.
SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
// Apply compression to the QCOW2 disk file
// using qemu-img convert. Defaults to false.
DiskCompression bool `mapstructure:"disk_compression" required:"false"`
// Either qcow2 or raw, this specifies the output
// format of the virtual machine image. This defaults to qcow2.
Format string `mapstructure:"format" required:"false"`
// Packer defaults to building QEMU virtual machines by
// launching a GUI that shows the console of the machine being built. When this
// value is set to true, the machine will start without a console.
Headless bool `mapstructure:"headless" required:"false"`
// Packer defaults to building from an ISO file, this
// parameter controls whether the ISO URL supplied is actually a bootable
// QEMU image. When this value is set to true, the machine will either clone
// the source or use it as a backing file (if use_backing_file is true);
// then, it will resize the image according to disk_size and boot it.
DiskImage bool `mapstructure:"disk_image" required:"false"`
// Only applicable when disk_image is true
// and format is qcow2, set this option to true to create a new QCOW2
// file that uses the file located at iso_url as a backing file. The new file
// will only contain blocks that have changed compared to the backing file, so
// enabling this option can significantly reduce disk usage.
UseBackingFile bool `mapstructure:"use_backing_file" required:"false"`
// The type of machine emulation to use. Run your
// qemu binary with the flags -machine help to list available types for
// your system. This defaults to pc.
MachineType string `mapstructure:"machine_type" required:"false"`
// The amount of memory to use when building the VM
// in megabytes. This defaults to 512 megabytes.
MemorySize int `mapstructure:"memory" required:"false"`
// The driver to use for the network interface. Allowed
// values ne2k_pci, i82551, i82557b, i82559er, rtl8139, e1000,
// pcnet, virtio, virtio-net, virtio-net-pci, usb-net, i82559a,
// i82559b, i82559c, i82550, i82562, i82557a, i82557c, i82801,
// vmxnet3, i82558a or i82558b. The Qemu builder uses virtio-net by
// default.
NetDevice string `mapstructure:"net_device" required:"false"`
// This is the path to the directory where the
// resulting virtual machine will be created. This may be relative or absolute.
// If relative, the path is relative to the working directory when packer
// is executed. This directory must not exist or be empty prior to running
// the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
// name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"`
// Allows complete control over the
// qemu command line (though not, at this time, qemu-img). Each array of
// strings makes up a command line switch that overrides matching default
// switch/value pairs. Any value specified as an empty string is ignored. All
// values after the switch are concatenated with no separator.
QemuArgs [][]string `mapstructure:"qemuargs" required:"false"`
// The name of the Qemu binary to look for. This
// defaults to qemu-system-x86_64, but may need to be changed for
// some platforms. For example qemu-kvm, or qemu-system-i386 may be a
// better choice for some systems.
QemuBinary string `mapstructure:"qemu_binary" required:"false"`
// The command to use to gracefully shut down the
// machine once all the provisioning is done. By default this is an empty
// string, which tells Packer to just forcefully shut down the machine unless a
// shutdown command takes place inside script so this may safely be omitted. It
// is important to add a shutdown_command. By default Packer halts the virtual
// machine and the file system may not be sync'd. Thus, changes made in a
// provisioner might not be saved. If one or more scripts require a reboot it is
// suggested to leave this blank since reboots may fail and specify the final
// shutdown command in your last script.
ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
// The minimum and
// maximum port to use for the SSH port on the host machine which is forwarded
// to the SSH port on the guest machine. Because Packer often runs in parallel,
// Packer will choose a randomly available port in this range to use as the
// host port. By default this is 2222 to 4444.
SSHHostPortMin int `mapstructure:"ssh_host_port_min" required:"false"`
SSHHostPortMax int `mapstructure:"ssh_host_port_max"` SSHHostPortMax int `mapstructure:"ssh_host_port_max"`
UseDefaultDisplay bool `mapstructure:"use_default_display"` // If true, do not pass a -display option
VNCBindAddress string `mapstructure:"vnc_bind_address"` // to qemu, allowing it to choose the default. This may be needed when running
VNCPortMin int `mapstructure:"vnc_port_min"` // under macOS, and getting errors about sdl not being available.
UseDefaultDisplay bool `mapstructure:"use_default_display" required:"false"`
// The IP address that should be
// binded to for VNC. By default packer will use 127.0.0.1 for this. If you
// wish to bind to all interfaces use 0.0.0.0.
VNCBindAddress string `mapstructure:"vnc_bind_address" required:"false"`
// The minimum and maximum port
// to use for VNC access to the virtual machine. The builder uses VNC to type
// the initial boot_command. Because Packer generally runs in parallel,
// Packer uses a randomly chosen port in this range that appears available. By
// default this is 5900 to 6000. The minimum and maximum ports are inclusive.
VNCPortMin int `mapstructure:"vnc_port_min" required:"false"`
VNCPortMax int `mapstructure:"vnc_port_max"` VNCPortMax int `mapstructure:"vnc_port_max"`
VMName string `mapstructure:"vm_name"` // This is the name of the image (QCOW2 or IMG) file for
// the new virtual machine. By default this is packer-BUILDNAME, where
// "BUILDNAME" is the name of the build. Currently, no file extension will be
// used unless it is specified in this option.
VMName string `mapstructure:"vm_name" required:"false"`
// These are deprecated, but we keep them around for BC // These are deprecated, but we keep them around for BC
// TODO(@mitchellh): remove // TODO(@mitchellh): remove
@ -131,8 +230,11 @@ type Config struct {
// TODO(mitchellh): deprecate // TODO(mitchellh): deprecate
RunOnce bool `mapstructure:"run_once"` RunOnce bool `mapstructure:"run_once"`
// The amount of time to wait after executing the
RawShutdownTimeout string `mapstructure:"shutdown_timeout"` // shutdown_command for the virtual machine to actually shut down. If it
// doesn't shut down in this time, it is an error. By default, the timeout is
// 5m or five minutes.
RawShutdownTimeout string `mapstructure:"shutdown_timeout" required:"false"`
shutdownTimeout time.Duration `` shutdownTimeout time.Duration ``
ctx interpolate.Context ctx interpolate.Context

55
builder/scaleway/config.go
View File

@ -19,19 +19,48 @@ import (
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The token to use to authenticate with your account.
Token string `mapstructure:"api_token"` // It can also be specified via environment variable SCALEWAY_API_TOKEN. You
Organization string `mapstructure:"organization_id"` // can see and generate tokens in the "Credentials"
// section of the control panel.
Region string `mapstructure:"region"` Token string `mapstructure:"api_token" required:"true"`
Image string `mapstructure:"image"` // The organization id to use to identify your
CommercialType string `mapstructure:"commercial_type"` // organization. It can also be specified via environment variable
// SCALEWAY_ORGANIZATION. Your organization id is available in the
SnapshotName string `mapstructure:"snapshot_name"` // "Account" section of the
ImageName string `mapstructure:"image_name"` // control panel.
ServerName string `mapstructure:"server_name"` // Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY
Bootscript string `mapstructure:"bootscript"` Organization string `mapstructure:"organization_id" required:"true"`
BootType string `mapstructure:"boottype"` // The name of the region to launch the server in (par1
// or ams1). Consequently, this is the region where the snapshot will be
// available.
Region string `mapstructure:"region" required:"true"`
// The UUID of the base image to use. This is the image
// that will be used to launch a new server and provision it. See
// the images list
// get the complete list of the accepted image UUID.
Image string `mapstructure:"image" required:"true"`
// The name of the server commercial type:
// ARM64-128GB, ARM64-16GB, ARM64-2GB, ARM64-32GB, ARM64-4GB,
// ARM64-64GB, ARM64-8GB, C1, C2L, C2M, C2S, START1-L,
// START1-M, START1-S, START1-XS, X64-120GB, X64-15GB, X64-30GB,
// X64-60GB
CommercialType string `mapstructure:"commercial_type" required:"true"`
// The name of the resulting snapshot that will
// appear in your account. Default packer-TIMESTAMP
SnapshotName string `mapstructure:"snapshot_name" required:"false"`
// The name of the resulting image that will appear in
// your account. Default packer-TIMESTAMP
ImageName string `mapstructure:"image_name" required:"false"`
// The name assigned to the server. Default
// packer-UUID
ServerName string `mapstructure:"server_name" required:"false"`
// The id of an existing bootscript to use when
// booting the server.
Bootscript string `mapstructure:"bootscript" required:"false"`
// The type of boot, can be either local or
// bootscript, Default bootscript
BootType string `mapstructure:"boottype" required:"false"`
UserAgent string UserAgent string
ctx interpolate.Context ctx interpolate.Context

21
builder/tencentcloud/cvm/access_config.go
View File

@ -44,11 +44,22 @@ var ValidRegions = []Region{
} }
type TencentCloudAccessConfig struct { type TencentCloudAccessConfig struct {
SecretId string `mapstructure:"secret_id"` // Tencentcloud secret id. You should set it directly,
SecretKey string `mapstructure:"secret_key"` // or set the TENCENTCLOUD_ACCESS_KEY environment variable.
Region string `mapstructure:"region"` SecretId string `mapstructure:"secret_id" required:"true"`
Zone string `mapstructure:"zone"` // Tencentcloud secret key. You should set it directly,
SkipValidation bool `mapstructure:"skip_region_validation"` // or set the TENCENTCLOUD_SECRET_KEY environment variable.
SecretKey string `mapstructure:"secret_key" required:"true"`
// The region where your cvm will be launch. You should
// reference Region and Zone
// for parameter taking.
Region string `mapstructure:"region" required:"true"`
// The zone where your cvm will be launch. You should
// reference Region and Zone
// for parameter taking.
Zone string `mapstructure:"zone" required:"true"`
// Do not check region and zone when validate.
SkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
} }
func (cf *TencentCloudAccessConfig) Client() (*cvm.Client, *vpc.Client, error) { func (cf *TencentCloudAccessConfig) Client() (*cvm.Client, *vpc.Client, error) {

30
builder/tencentcloud/cvm/image_config.go
View File

@ -8,15 +8,29 @@ import (
) )
type TencentCloudImageConfig struct { type TencentCloudImageConfig struct {
ImageName string `mapstructure:"image_name"` // The name you want to create your customize image,
ImageDescription string `mapstructure:"image_description"` // it should be composed of no more than 20 characters, of letters, numbers
Reboot bool `mapstructure:"reboot"` // or minus sign.
ForcePoweroff bool `mapstructure:"force_poweroff"` ImageName string `mapstructure:"image_name" required:"true"`
Sysprep bool `mapstructure:"sysprep"` // Image description.
ImageDescription string `mapstructure:"image_description" required:"false"`
// Whether shutdown cvm to create Image. Default value is
// false.
Reboot bool `mapstructure:"reboot" required:"false"`
// Whether to force power off cvm when create image.
// Default value is false.
ForcePoweroff bool `mapstructure:"force_poweroff" required:"false"`
// Whether enable Sysprep during creating windows image.
Sysprep bool `mapstructure:"sysprep" required:"false"`
ImageForceDelete bool `mapstructure:"image_force_delete"` ImageForceDelete bool `mapstructure:"image_force_delete"`
ImageCopyRegions []string `mapstructure:"image_copy_regions"` // regions that will be copied to after
ImageShareAccounts []string `mapstructure:"image_share_accounts"` // your image created.
SkipValidation bool `mapstructure:"skip_region_validation"` ImageCopyRegions []string `mapstructure:"image_copy_regions" required:"false"`
// accounts that will be shared to
// after your image created.
ImageShareAccounts []string `mapstructure:"image_share_accounts" required:"false"`
// Do not check region and zone when validate.
SkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
} }
func (cf *TencentCloudImageConfig) Prepare(ctx *interpolate.Context) []error { func (cf *TencentCloudImageConfig) Prepare(ctx *interpolate.Context) []error {

64
builder/tencentcloud/cvm/run_config.go
View File

@ -11,26 +11,54 @@ import (
) )
type TencentCloudRunConfig struct { type TencentCloudRunConfig struct {
AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address"` // Whether allocate public ip to your cvm.
SourceImageId string `mapstructure:"source_image_id"` // Default value is false.
InstanceType string `mapstructure:"instance_type"` AssociatePublicIpAddress bool `mapstructure:"associate_public_ip_address" required:"false"`
InstanceName string `mapstructure:"instance_name"` // The base image id of Image you want to create
DiskType string `mapstructure:"disk_type"` // your customized image from.
DiskSize int64 `mapstructure:"disk_size"` SourceImageId string `mapstructure:"source_image_id" required:"true"`
VpcId string `mapstructure:"vpc_id"` // The instance type your cvm will be launched by.
VpcName string `mapstructure:"vpc_name"` // You should reference Instace Type
// for parameter taking.
InstanceType string `mapstructure:"instance_type" required:"true"`
// Instance name.
InstanceName string `mapstructure:"instance_name" required:"false"`
// Root disk type your cvm will be launched by. you could
// reference Disk Type
// for parameter taking.
DiskType string `mapstructure:"disk_type" required:"false"`
// Root disk size your cvm will be launched by. values range(in GB):
DiskSize int64 `mapstructure:"disk_size" required:"false"`
// Specify vpc your cvm will be launched by.
VpcId string `mapstructure:"vpc_id" required:"false"`
// Specify vpc name you will create. if vpc_id is not set, packer will
// create a vpc for you named this parameter.
VpcName string `mapstructure:"vpc_name" required:"false"`
VpcIp string `mapstructure:"vpc_ip"` VpcIp string `mapstructure:"vpc_ip"`
SubnetId string `mapstructure:"subnet_id"` // Specify subnet your cvm will be launched by.
SubnetName string `mapstructure:"subnet_name"` SubnetId string `mapstructure:"subnet_id" required:"false"`
CidrBlock string `mapstructure:"cidr_block"` // 10.0.0.0/16(default), 172.16.0.0/12, 192.168.0.0/16 // Specify subnet name you will create. if subnet_id is not set, packer will
SubnectCidrBlock string `mapstructure:"subnect_cidr_block"` // create a subnet for you named this parameter.
SubnetName string `mapstructure:"subnet_name" required:"false"`
// Specify cider block of the vpc you will create if vpc_id not set
CidrBlock string `mapstructure:"cidr_block" required:"false"` // 10.0.0.0/16(default), 172.16.0.0/12, 192.168.0.0/16
// Specify cider block of the subnet you will create if
// subnet_id not set
SubnectCidrBlock string `mapstructure:"subnect_cidr_block" required:"false"`
InternetChargeType string `mapstructure:"internet_charge_type"` InternetChargeType string `mapstructure:"internet_charge_type"`
InternetMaxBandwidthOut int64 `mapstructure:"internet_max_bandwidth_out"` // Max bandwidth out your cvm will be launched by(in MB).
SecurityGroupId string `mapstructure:"security_group_id"` // values can be set between 1 ~ 100.
SecurityGroupName string `mapstructure:"security_group_name"` InternetMaxBandwidthOut int64 `mapstructure:"internet_max_bandwidth_out" required:"false"`
UserData string `mapstructure:"user_data"` // Specify security group your cvm will be launched by.
UserDataFile string `mapstructure:"user_data_file"` SecurityGroupId string `mapstructure:"security_group_id" required:"false"`
HostName string `mapstructure:"host_name"` // Specify security name you will create if security_group_id not set.
SecurityGroupName string `mapstructure:"security_group_name" required:"false"`
// userdata.
UserData string `mapstructure:"user_data" required:"false"`
// userdata file.
UserDataFile string `mapstructure:"user_data_file" required:"false"`
// host name.
HostName string `mapstructure:"host_name" required:"false"`
// Communicator settings // Communicator settings
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`

32
builder/triton/access_config.go
View File

@ -17,12 +17,32 @@ import (
// AccessConfig is for common configuration related to Triton access // AccessConfig is for common configuration related to Triton access
type AccessConfig struct { type AccessConfig struct {
Endpoint string `mapstructure:"triton_url"` // The URL of the Triton cloud API to use. If omitted
Account string `mapstructure:"triton_account"` // it will default to the us-sw-1 region of the Joyent Public cloud. If you
Username string `mapstructure:"triton_user"` // are using your own private Triton installation you will have to supply the
KeyID string `mapstructure:"triton_key_id"` // URL of the cloud API of your own Triton installation.
KeyMaterial string `mapstructure:"triton_key_material"` Endpoint string `mapstructure:"triton_url" required:"false"`
InsecureSkipTLSVerify bool `mapstructure:"insecure_skip_tls_verify"` // The username of the Triton account to use when
// using the Triton Cloud API.
Account string `mapstructure:"triton_account" required:"true"`
// The username of a user who has access to your
// Triton account.
Username string `mapstructure:"triton_user" required:"false"`
// The fingerprint of the public key of the SSH key
// pair to use for authentication with the Triton Cloud API. If
// triton_key_material is not set, it is assumed that the SSH agent has the
// private key corresponding to this key ID loaded.
KeyID string `mapstructure:"triton_key_id" required:"true"`
// Path to the file in which the private key
// of triton_key_id is stored. For example /home/soandso/.ssh/id_rsa. If
// this is not specified, the SSH agent is used to sign requests with the
// triton_key_id specified.
KeyMaterial string `mapstructure:"triton_key_material" required:"false"`
//secure_skip_tls_verify - (bool) This allows skipping TLS verification
// of the Triton endpoint. It is useful when connecting to a temporary Triton
// installation such as Cloud-On-A-Laptop which does not generally use a
// certificate signed by a trusted root CA. The default is false.
InsecureSkipTLSVerify bool `mapstructure:"insecure_skip_tls_verify" required:"false"`
signer authentication.Signer signer authentication.Signer
} }

62
builder/triton/source_machine_config.go
View File

@ -9,14 +9,60 @@ import (
// SourceMachineConfig represents the configuration to run a machine using // SourceMachineConfig represents the configuration to run a machine using
// the SDC API in order for provisioning to take place. // the SDC API in order for provisioning to take place.
type SourceMachineConfig struct { type SourceMachineConfig struct {
MachineName string `mapstructure:"source_machine_name"` // Name of the VM used for building the
MachinePackage string `mapstructure:"source_machine_package"` // image. Does not affect (and does not have to be the same) as the name for a
MachineImage string `mapstructure:"source_machine_image"` // VM instance running this image. Maximum 512 characters but should in
MachineNetworks []string `mapstructure:"source_machine_networks"` // practice be much shorter (think between 5 and 20 characters). For example
MachineMetadata map[string]string `mapstructure:"source_machine_metadata"` // mysql-64-server-image-builder. When omitted defaults to
MachineTags map[string]string `mapstructure:"source_machine_tags"` // packer-builder-[image_name].
MachineFirewallEnabled bool `mapstructure:"source_machine_firewall_enabled"` MachineName string `mapstructure:"source_machine_name" required:"false"`
MachineImageFilters MachineImageFilter `mapstructure:"source_machine_image_filter"` // The Triton package to use while
// building the image. Does not affect (and does not have to be the same) as
// the package which will be used for a VM instance running this image. On the
// Joyent public cloud this could for example be g3-standard-0.5-smartos.
MachinePackage string `mapstructure:"source_machine_package" required:"true"`
// The UUID of the image to base the new
// image on. Triton supports multiple types of images, called 'brands' in
// Triton / Joyent lingo, for contains and VM's. See the chapter Containers
// and virtual machines in
// the Joyent Triton documentation for detailed information. The following
// brands are currently supported by this builder:joyent andkvm. The
// choice of base image automatically decides the brand. On the Joyent public
// cloud a valid source_machine_image could for example be
// 70e3ae72-96b6-11e6-9056-9737fd4d0764 for version 16.3.1 of the 64bit
// SmartOS base image (a 'joyent' brand image). source_machine_image_filter
// can be used to populate this UUID.
MachineImage string `mapstructure:"source_machine_image" required:"true"`
// The UUID's of Triton
// networks added to the source machine used for creating the image. For
// example if any of the provisioners which are run need Internet access you
// will need to add the UUID's of the appropriate networks here. If this is
// not specified, instances will be placed into the default Triton public and
// internal networks.
MachineNetworks []string `mapstructure:"source_machine_networks" required:"false"`
// Triton metadata
// applied to the VM used to create the image. Metadata can be used to pass
// configuration information to the VM without the need for networking. See
// Using the metadata
// API in the
// Joyent documentation for more information. This can for example be used to
// set the user-script metadata key to have Triton start a user supplied
// script after the VM has booted.
MachineMetadata map[string]string `mapstructure:"source_machine_metadata" required:"false"`
// Tags applied to the
// VM used to create the image.
MachineTags map[string]string `mapstructure:"source_machine_tags" required:"false"`
// Whether or not the firewall
// of the VM used to create an image of is enabled. The Triton firewall only
// filters inbound traffic to the VM. All outbound traffic is always allowed.
// Currently this builder does not provide an interface to add specific
// firewall rules. Unless you have a global rule defined in Triton which
// allows SSH traffic enabling the firewall will interfere with the SSH
// provisioner. The default is false.
MachineFirewallEnabled bool `mapstructure:"source_machine_firewall_enabled" required:"false"`
// Filters used to populate the
// source_machine_image field. Example:
MachineImageFilters MachineImageFilter `mapstructure:"source_machine_image_filter" required:"false"`
} }
type MachineImageFilter struct { type MachineImageFilter struct {

32
builder/triton/target_image_config.go
View File

@ -9,13 +9,31 @@ import (
// TargetImageConfig represents the configuration for the image to be created // TargetImageConfig represents the configuration for the image to be created
// from the source machine. // from the source machine.
type TargetImageConfig struct { type TargetImageConfig struct {
ImageName string `mapstructure:"image_name"` // The name the finished image in Triton will be
ImageVersion string `mapstructure:"image_version"` // assigned. Maximum 512 characters but should in practice be much shorter
ImageDescription string `mapstructure:"image_description"` // (think between 5 and 20 characters). For example postgresql-95-server for
ImageHomepage string `mapstructure:"image_homepage"` // an image used as a PostgreSQL 9.5 server.
ImageEULA string `mapstructure:"image_eula_url"` ImageName string `mapstructure:"image_name" required:"true"`
ImageACL []string `mapstructure:"image_acls"` // The version string for this image. Maximum 128
ImageTags map[string]string `mapstructure:"image_tags"` // characters. Any string will do but a format of Major.Minor.Patch is
// strongly advised by Joyent. See Semantic Versioning
// for more information on the Major.Minor.Patch versioning format.
ImageVersion string `mapstructure:"image_version" required:"true"`
// Description of the image. Maximum 512
// characters.
ImageDescription string `mapstructure:"image_description" required:"false"`
// URL of the homepage where users can find
// information about the image. Maximum 128 characters.
ImageHomepage string `mapstructure:"image_homepage" required:"false"`
// URL of the End User License Agreement (EULA)
// for the image. Maximum 128 characters.
ImageEULA string `mapstructure:"image_eula_url" required:"false"`
// The UUID's of the users which will have
// access to this image. When omitted only the owner (the Triton user whose
// credentials are used) will have access to the image.
ImageACL []string `mapstructure:"image_acls" required:"false"`
// Tag applied to the image.
ImageTags map[string]string `mapstructure:"image_tags" required:"false"`
} }
// Prepare performs basic validation on a TargetImageConfig struct. // Prepare performs basic validation on a TargetImageConfig struct.

111
builder/vagrant/builder.go
View File

@ -36,39 +36,94 @@ type Config struct {
common.FloppyConfig `mapstructure:",squash"` common.FloppyConfig `mapstructure:",squash"`
bootcommand.BootConfig `mapstructure:",squash"` bootcommand.BootConfig `mapstructure:",squash"`
SSHConfig `mapstructure:",squash"` SSHConfig `mapstructure:",squash"`
// The directory to create that will contain
// This is the name of the new virtual machine. // your output box. We always create this directory and run from inside of it to
// By default this is "packer-BUILDNAME", where "BUILDNAME" is the name of the build. // prevent Vagrant init collisions. If unset, it will be set to packer- plus
OutputDir string `mapstructure:"output_dir"` // your buildname.
SourceBox string `mapstructure:"source_path"` OutputDir string `mapstructure:"output_dir" required:"false"`
GlobalID string `mapstructure:"global_id"` // URL of the vagrant box to use, or the name of the
Checksum string `mapstructure:"checksum"` // vagrant box. hashicorp/precise64, ./mylocalbox.box and
ChecksumType string `mapstructure:"checksum_type"` // https://example.com/my-box.box are all valid source boxes. If your
BoxName string `mapstructure:"box_name"` // source is a .box file, whether locally or from a URL like the latter example
// above, you will also need to provide a box_name. This option is required,
Provider string `mapstructure:"provider"` // unless you set global_id. You may only set one or the other, not both.
SourceBox string `mapstructure:"source_path" required:"true"`
// the global id of a Vagrant box already added to Vagrant
// on your system. You can find the global id of your Vagrant boxes using the
// command vagrant global-status; your global_id will be a 7-digit number and
// letter comination that you'll find in the leftmost column of the
// global-status output. If you choose to use global_id instead of
// source_box, Packer will skip the Vagrant initialize and add steps, and
// simply launch the box directly using the global id.
GlobalID string `mapstructure:"global_id" required:"true"`
// The checksum for the .box file. The type of the
// checksum is specified with checksum_type, documented below.
Checksum string `mapstructure:"checksum" required:"false"`
// The type of the checksum specified in checksum.
// Valid values are none, md5, sha1, sha256, or sha512. Although the
// checksum will not be verified when checksum_type is set to "none", this is
// not recommended since OVA files can be very large and corruption does happen
// from time to time.
ChecksumType string `mapstructure:"checksum_type" required:"false"`
// if your source_box is a boxfile that we need to add
// to Vagrant, this is the name to give it. If left blank, will default to
// "packer_" plus your buildname.
BoxName string `mapstructure:"box_name" required:"false"`
// The vagrant provider.
// This parameter is required when source_path have more than one provider,
// or when using vagrant-cloud post-processor. Defaults to unset.
Provider string `mapstructure:"provider" required:"false"`
Communicator string `mapstructure:"communicator"` Communicator string `mapstructure:"communicator"`
// Whether to Halt, Suspend, or Destroy the box
TeardownMethod string `mapstructure:"teardown_method"`
// Options for the "vagrant init" command // Options for the "vagrant init" command
BoxVersion string `mapstructure:"box_version"`
Template string `mapstructure:"template"` // What vagrantfile to use
VagrantfileTpl string `mapstructure:"vagrantfile_template"`
// Whether to halt, suspend, or destroy the box when
// the build has completed. Defaults to "halt"
TeardownMethod string `mapstructure:"teardown_method" required:"false"`
// What box version to use when initializing Vagrant.
BoxVersion string `mapstructure:"box_version" required:"false"`
// a path to a golang template for a
// vagrantfile. Our default template can be found
// here. So far the only template variables available to you are {{ .BoxName }} and
// {{ .SyncedFolder }}, which correspond to the Packer options box_name and
// synced_folder.
Template string `mapstructure:"template" required:"false"`
SyncedFolder string `mapstructure:"synced_folder"` SyncedFolder string `mapstructure:"synced_folder"`
// Don't call "vagrant add" to add the box to your local
// Options for the "vagrant box add" command // environment; this is necessary if you want to launch a box that is already
SkipAdd bool `mapstructure:"skip_add"` // added to your vagrant environment.
AddCACert string `mapstructure:"add_cacert"` SkipAdd bool `mapstructure:"skip_add" required:"false"`
AddCAPath string `mapstructure:"add_capath"` // Equivalent to setting the
AddCert string `mapstructure:"add_cert"` // --cacert
AddClean bool `mapstructure:"add_clean"` // option in vagrant add; defaults to unset.
AddForce bool `mapstructure:"add_force"` AddCACert string `mapstructure:"add_cacert" required:"false"`
AddInsecure bool `mapstructure:"add_insecure"` // Equivalent to setting the
// --capath option
// Don't package the Vagrant box after build. // in vagrant add; defaults to unset.
SkipPackage bool `mapstructure:"skip_package"` AddCAPath string `mapstructure:"add_capath" required:"false"`
// Equivalent to setting the
// --cert option in
// vagrant add; defaults to unset.
AddCert string `mapstructure:"add_cert" required:"false"`
// Equivalent to setting the
// --clean flag in
// vagrant add; defaults to unset.
AddClean bool `mapstructure:"add_clean" required:"false"`
// Equivalent to setting the
// --force flag in
// vagrant add; defaults to unset.
AddForce bool `mapstructure:"add_force" required:"false"`
// Equivalent to setting the
// --insecure flag in
// vagrant add; defaults to unset.
AddInsecure bool `mapstructure:"add_insecure" required:"false"`
// if true, Packer will not call vagrant package to
// package your base box into its own standalone .box file.
SkipPackage bool `mapstructure:"skip_package" required:"false"`
OutputVagrantfile string `mapstructure:"output_vagrantfile"` OutputVagrantfile string `mapstructure:"output_vagrantfile"`
PackageInclude []string `mapstructure:"package_include"` PackageInclude []string `mapstructure:"package_include"`

4
builder/virtualbox/common/export_config.go
View File

@ -7,7 +7,9 @@ import (
) )
type ExportConfig struct { type ExportConfig struct {
Format string `mapstructure:"format"` // Either ovf or ova, this specifies the output format
// of the exported virtual machine. This defaults to ovf.
Format string `mapstructure:"format" required:"false"`
} }
func (c *ExportConfig) Prepare(ctx *interpolate.Context) []error { func (c *ExportConfig) Prepare(ctx *interpolate.Context) []error {

7
builder/virtualbox/common/export_opts.go
View File

@ -5,7 +5,12 @@ import (
) )
type ExportOpts struct { type ExportOpts struct {
ExportOpts []string `mapstructure:"export_opts"` // Additional options to pass to the
// VBoxManage
// export. This
// can be useful for passing product information to include in the resulting
// appliance file. Packer JSON configuration file example:
ExportOpts []string `mapstructure:"export_opts" required:"false"`
} }
func (c *ExportOpts) Prepare(ctx *interpolate.Context) []error { func (c *ExportOpts) Prepare(ctx *interpolate.Context) []error {

9
builder/virtualbox/common/guest_additions_config.go
View File

@ -16,7 +16,14 @@ const (
type GuestAdditionsConfig struct { type GuestAdditionsConfig struct {
Communicator string `mapstructure:"communicator"` Communicator string `mapstructure:"communicator"`
GuestAdditionsMode string `mapstructure:"guest_additions_mode"` // The method by which guest additions are
// made available to the guest for installation. Valid options are upload,
// attach, or disable. If the mode is attach the guest additions ISO will
// be attached as a CD device to the virtual machine. If the mode is upload
// the guest additions ISO will be uploaded to the path specified by
// guest_additions_path. The default value is upload. If disable is used,
// guest additions won't be downloaded, either.
GuestAdditionsMode string `mapstructure:"guest_additions_mode" required:"false"`
} }
func (c *GuestAdditionsConfig) Prepare(ctx *interpolate.Context) []error { func (c *GuestAdditionsConfig) Prepare(ctx *interpolate.Context) []error {

21
builder/virtualbox/common/hw_config.go
View File

@ -7,14 +7,19 @@ import (
) )
type HWConfig struct { type HWConfig struct {
// The number of cpus to use for building the VM.
// cpu information // Defaults to 1.
CpuCount int `mapstructure:"cpus"` CpuCount int `mapstructure:"cpus" required:"false"`
MemorySize int `mapstructure:"memory"` // The amount of memory to use for building the VM
// in megabytes. Defaults to 512 megabytes.
// device presence MemorySize int `mapstructure:"memory" required:"false"`
Sound string `mapstructure:"sound"` // Defaults to none. The type of audio device to use for
USB bool `mapstructure:"usb"` // sound when building the VM. Some of the options that are available are
// dsound, oss, alsa, pulse, coreaudio, null.
Sound string `mapstructure:"sound" required:"false"`
// Specifies whether or not to enable the USB bus when
// building the VM. Defaults to false.
USB bool `mapstructure:"usb" required:"false"`
} }
func (c *HWConfig) Prepare(ctx *interpolate.Context) []error { func (c *HWConfig) Prepare(ctx *interpolate.Context) []error {

8
builder/virtualbox/common/output_config.go
View File

@ -8,7 +8,13 @@ import (
) )
type OutputConfig struct { type OutputConfig struct {
OutputDir string `mapstructure:"output_directory"` // This is the path to the directory where the
// resulting virtual machine will be created. This may be relative or absolute.
// If relative, the path is relative to the working directory when packer
// is executed. This directory must not exist or be empty prior to running
// the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
// name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"`
} }
func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error { func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error {

18
builder/virtualbox/common/run_config.go
View File

@ -7,10 +7,20 @@ import (
) )
type RunConfig struct { type RunConfig struct {
Headless bool `mapstructure:"headless"` // Packer defaults to building VirtualBox virtual
// machines by launching a GUI that shows the console of the machine
VRDPBindAddress string `mapstructure:"vrdp_bind_address"` // being built. When this value is set to true, the machine will start
VRDPPortMin int `mapstructure:"vrdp_port_min"` // without a console.
Headless bool `mapstructure:"headless" required:"false"`
// The IP address that should be
// binded to for VRDP. By default packer will use 127.0.0.1 for this. If you
// wish to bind to all interfaces use 0.0.0.0.
VRDPBindAddress string `mapstructure:"vrdp_bind_address" required:"false"`
// The minimum and maximum port
// to use for VRDP access to the virtual machine. Packer uses a randomly chosen
// port in this range that appears available. By default this is 5900 to
// 6000. The minimum and maximum ports are inclusive.
VRDPPortMin int `mapstructure:"vrdp_port_min" required:"false"`
VRDPPortMax int `mapstructure:"vrdp_port_max"` VRDPPortMax int `mapstructure:"vrdp_port_max"`
} }

21
builder/virtualbox/common/shutdown_config.go
View File

@ -8,9 +8,24 @@ import (
) )
type ShutdownConfig struct { type ShutdownConfig struct {
ShutdownCommand string `mapstructure:"shutdown_command"` // The command to use to gracefully shut down the
RawShutdownTimeout string `mapstructure:"shutdown_timeout"` // machine once all the provisioning is done. By default this is an empty
RawPostShutdownDelay string `mapstructure:"post_shutdown_delay"` // string, which tells Packer to just forcefully shut down the machine unless a
// shutdown command takes place inside script so this may safely be omitted. If
// one or more scripts require a reboot it is suggested to leave this blank
// since reboots may fail and specify the final shutdown command in your
// last script.
ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
// The amount of time to wait after executing the
// shutdown_command for the virtual machine to actually shut down. If it
// doesn't shut down in this time, it is an error. By default, the timeout is
// 5m or five minutes.
RawShutdownTimeout string `mapstructure:"shutdown_timeout" required:"false"`
// The amount of time to wait after shutting
// down the virtual machine. If you get the error
// Error removing floppy controller, you might need to set this to 5m
// or so. By default, the delay is 0s or disabled.
RawPostShutdownDelay string `mapstructure:"post_shutdown_delay" required:"false"`
ShutdownTimeout time.Duration `` ShutdownTimeout time.Duration ``
PostShutdownDelay time.Duration `` PostShutdownDelay time.Duration ``

13
builder/virtualbox/common/ssh_config.go
View File

@ -10,10 +10,17 @@ import (
type SSHConfig struct { type SSHConfig struct {
Comm communicator.Config `mapstructure:",squash"` Comm communicator.Config `mapstructure:",squash"`
// The minimum and
SSHHostPortMin int `mapstructure:"ssh_host_port_min"` // maximum port to use for the SSH port on the host machine which is forwarded
// to the SSH port on the guest machine. Because Packer often runs in parallel,
// Packer will choose a randomly available port in this range to use as the
// host port. By default this is 2222 to 4444.
SSHHostPortMin int `mapstructure:"ssh_host_port_min" required:"false"`
SSHHostPortMax int `mapstructure:"ssh_host_port_max"` SSHHostPortMax int `mapstructure:"ssh_host_port_max"`
SSHSkipNatMapping bool `mapstructure:"ssh_skip_nat_mapping"` // Defaults to false. When enabled, Packer
// does not setup forwarded port mapping for SSH requests and uses ssh_port
// on the host to communicate to the virtual machine.
SSHSkipNatMapping bool `mapstructure:"ssh_skip_nat_mapping" required:"false"`
// These are deprecated, but we keep them around for BC // These are deprecated, but we keep them around for BC
// TODO(@mitchellh): remove // TODO(@mitchellh): remove

8
builder/virtualbox/common/vbox_version_config.go
View File

@ -8,7 +8,13 @@ import (
type VBoxVersionConfig struct { type VBoxVersionConfig struct {
Communicator string `mapstructure:"communicator"` Communicator string `mapstructure:"communicator"`
VBoxVersionFile *string `mapstructure:"virtualbox_version_file"` // The path within the virtual machine to
// upload a file that contains the VirtualBox version that was used to create
// the machine. This information can be useful for provisioning. By default
// this is .vbox_version, which will generally be upload it into the
// home directory. Set to an empty string to skip uploading this file, which
// can be useful when using the none communicator.
VBoxVersionFile *string `mapstructure:"virtualbox_version_file" required:"false"`
} }
func (c *VBoxVersionConfig) Prepare(ctx *interpolate.Context) []error { func (c *VBoxVersionConfig) Prepare(ctx *interpolate.Context) []error {

6
builder/virtualbox/common/vboxbundle_config.go
View File

@ -5,7 +5,11 @@ import (
) )
type VBoxBundleConfig struct { type VBoxBundleConfig struct {
BundleISO bool `mapstructure:"bundle_iso"` // Defaults to false. When enabled, Packer includes
// any attached ISO disc devices into the final virtual machine. Useful for
// some live distributions that require installation media to continue to be
// attached after installation.
BundleISO bool `mapstructure:"bundle_iso" required:"false"`
} }
func (c *VBoxBundleConfig) Prepare(ctx *interpolate.Context) []error { func (c *VBoxBundleConfig) Prepare(ctx *interpolate.Context) []error {

12
builder/virtualbox/common/vboxmanage_config.go
View File

@ -5,7 +5,17 @@ import (
) )
type VBoxManageConfig struct { type VBoxManageConfig struct {
VBoxManage [][]string `mapstructure:"vboxmanage"` // Custom VBoxManage commands to
// execute in order to further customize the virtual machine being created. The
// value of this is an array of commands to execute. The commands are executed
// in the order defined in the template. For each command, the command is
// defined itself as an array of strings, where each string represents a single
// argument on the command-line to VBoxManage (but excluding
// VBoxManage itself). Each arg is treated as a configuration
// template, where the Name
// variable is replaced with the VM name. More details on how to use
// VBoxManage are below.
VBoxManage [][]string `mapstructure:"vboxmanage" required:"false"`
} }
func (c *VBoxManageConfig) Prepare(ctx *interpolate.Context) []error { func (c *VBoxManageConfig) Prepare(ctx *interpolate.Context) []error {

5
builder/virtualbox/common/vboxmanage_post_config.go
View File

@ -5,7 +5,10 @@ import (
) )
type VBoxManagePostConfig struct { type VBoxManagePostConfig struct {
VBoxManagePost [][]string `mapstructure:"vboxmanage_post"` // Identical to vboxmanage,
// except that it is run after the virtual machine is shutdown, and before the
// virtual machine is exported.
VBoxManagePost [][]string `mapstructure:"vboxmanage_post" required:"false"`
} }
func (c *VBoxManagePostConfig) Prepare(ctx *interpolate.Context) []error { func (c *VBoxManagePostConfig) Prepare(ctx *interpolate.Context) []error {

91
builder/virtualbox/iso/builder.go
View File

@ -41,22 +41,81 @@ type Config struct {
vboxcommon.VBoxVersionConfig `mapstructure:",squash"` vboxcommon.VBoxVersionConfig `mapstructure:",squash"`
vboxcommon.VBoxBundleConfig `mapstructure:",squash"` vboxcommon.VBoxBundleConfig `mapstructure:",squash"`
vboxcommon.GuestAdditionsConfig `mapstructure:",squash"` vboxcommon.GuestAdditionsConfig `mapstructure:",squash"`
// The size, in megabytes, of the hard disk to create
DiskSize uint `mapstructure:"disk_size"` // for the VM. By default, this is 40000 (about 40 GB).
GuestAdditionsMode string `mapstructure:"guest_additions_mode"` DiskSize uint `mapstructure:"disk_size" required:"false"`
GuestAdditionsPath string `mapstructure:"guest_additions_path"` // The method by which guest additions are
GuestAdditionsSHA256 string `mapstructure:"guest_additions_sha256"` // made available to the guest for installation. Valid options are upload,
GuestAdditionsURL string `mapstructure:"guest_additions_url"` // attach, or disable. If the mode is attach the guest additions ISO will
GuestAdditionsInterface string `mapstructure:"guest_additions_interface"` // be attached as a CD device to the virtual machine. If the mode is upload
GuestOSType string `mapstructure:"guest_os_type"` // the guest additions ISO will be uploaded to the path specified by
HardDriveDiscard bool `mapstructure:"hard_drive_discard"` // guest_additions_path. The default value is upload. If disable is used,
HardDriveInterface string `mapstructure:"hard_drive_interface"` // guest additions won't be downloaded, either.
SATAPortCount int `mapstructure:"sata_port_count"` GuestAdditionsMode string `mapstructure:"guest_additions_mode" required:"false"`
HardDriveNonrotational bool `mapstructure:"hard_drive_nonrotational"` // The path on the guest virtual machine
ISOInterface string `mapstructure:"iso_interface"` // where the VirtualBox guest additions ISO will be uploaded. By default this
KeepRegistered bool `mapstructure:"keep_registered"` // is VBoxGuestAdditions.iso which should upload into the login directory of
SkipExport bool `mapstructure:"skip_export"` // the user. This is a configuration
VMName string `mapstructure:"vm_name"` // template where the Version
// variable is replaced with the VirtualBox version.
GuestAdditionsPath string `mapstructure:"guest_additions_path" required:"false"`
// The SHA256 checksum of the guest
// additions ISO that will be uploaded to the guest VM. By default the
// checksums will be downloaded from the VirtualBox website, so this only needs
// to be set if you want to be explicit about the checksum.
GuestAdditionsSHA256 string `mapstructure:"guest_additions_sha256" required:"false"`
// The URL to the guest additions ISO
// to upload. This can also be a file URL if the ISO is at a local path. By
// default, the VirtualBox builder will attempt to find the guest additions ISO
// on the local file system. If it is not available locally, the builder will
// download the proper guest additions ISO from the internet.
GuestAdditionsURL string `mapstructure:"guest_additions_url" required:"false"`
// The interface type to use to mount
// guest additions when guest_additions_mode is set to attach. Will
// default to the value set in iso_interface, if iso_interface is set.
// Will default to "ide", if iso_interface is not set. Options are "ide" and
// "sata".
GuestAdditionsInterface string `mapstructure:"guest_additions_interface" required:"false"`
// The guest OS type being installed. By default
// this is other, but you can get dramatic performance improvements by
// setting this to the proper value. To view all available values for this run
// VBoxManage list ostypes. Setting the correct value hints to VirtualBox how
// to optimize the virtual hardware to work best with that operating system.
GuestOSType string `mapstructure:"guest_os_type" required:"false"`
// When this value is set to true, a VDI
// image will be shrunk in response to the trim command from the guest OS.
// The size of the cleared area must be at least 1MB. Also set
// hard_drive_nonrotational to true to enable TRIM support.
HardDriveDiscard bool `mapstructure:"hard_drive_discard" required:"false"`
// The type of controller that the primary
// hard drive is attached to, defaults to ide. When set to sata, the drive
// is attached to an AHCI SATA controller. When set to scsi, the drive is
// attached to an LsiLogic SCSI controller.
HardDriveInterface string `mapstructure:"hard_drive_interface" required:"false"`
// The number of ports available on any SATA
// controller created, defaults to 1. VirtualBox supports up to 30 ports on a
// maximum of 1 SATA controller. Increasing this value can be useful if you
// want to attach additional drives.
SATAPortCount int `mapstructure:"sata_port_count" required:"false"`
// Forces some guests (i.e. Windows 7+)
// to treat disks as SSDs and stops them from performing disk fragmentation.
// Also set hard_drive_discard to true to enable TRIM support.
HardDriveNonrotational bool `mapstructure:"hard_drive_nonrotational" required:"false"`
// The type of controller that the ISO is attached
// to, defaults to ide. When set to sata, the drive is attached to an AHCI
// SATA controller.
ISOInterface string `mapstructure:"iso_interface" required:"false"`
// Set this to true if you would like to keep
// the VM registered with virtualbox. Defaults to false.
KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
// Defaults to false. When enabled, Packer will
// not export the VM. Useful if the build output is not the resultant image,
// but created inside the VM.
SkipExport bool `mapstructure:"skip_export" required:"false"`
// This is the name of the OVF file for the new virtual
// machine, without the file extension. By default this is packer-BUILDNAME,
// where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

86
builder/virtualbox/ovf/config.go
View File

@ -29,21 +29,77 @@ type Config struct {
vboxcommon.VBoxManagePostConfig `mapstructure:",squash"` vboxcommon.VBoxManagePostConfig `mapstructure:",squash"`
vboxcommon.VBoxVersionConfig `mapstructure:",squash"` vboxcommon.VBoxVersionConfig `mapstructure:",squash"`
vboxcommon.GuestAdditionsConfig `mapstructure:",squash"` vboxcommon.GuestAdditionsConfig `mapstructure:",squash"`
// The checksum for the source_path file. The
Checksum string `mapstructure:"checksum"` // algorithm to use when computing the checksum can be optionally specified
ChecksumType string `mapstructure:"checksum_type"` // with checksum_type. When checksum_type is not set packer will guess the
GuestAdditionsMode string `mapstructure:"guest_additions_mode"` // checksumming type based on checksum length. checksum can be also be a
GuestAdditionsPath string `mapstructure:"guest_additions_path"` // file or an URL, in which case checksum_type must be set to file; the
GuestAdditionsInterface string `mapstructure:"guest_additions_interface"` // go-getter will download it and use the first hash found.
GuestAdditionsSHA256 string `mapstructure:"guest_additions_sha256"` Checksum string `mapstructure:"checksum" required:"true"`
GuestAdditionsURL string `mapstructure:"guest_additions_url"` // The type of the checksum specified in checksum.
ImportFlags []string `mapstructure:"import_flags"` // Valid values are none, md5, sha1, sha256, or sha512. Although the
ImportOpts string `mapstructure:"import_opts"` // checksum will not be verified when checksum_type is set to "none", this is
SourcePath string `mapstructure:"source_path"` // not recommended since OVA files can be very large and corruption does happen
TargetPath string `mapstructure:"target_path"` // from time to time.
VMName string `mapstructure:"vm_name"` ChecksumType string `mapstructure:"checksum_type" required:"false"`
KeepRegistered bool `mapstructure:"keep_registered"` // The method by which guest additions are
SkipExport bool `mapstructure:"skip_export"` // made available to the guest for installation. Valid options are upload,
// attach, or disable. If the mode is attach the guest additions ISO will
// be attached as a CD device to the virtual machine. If the mode is upload
// the guest additions ISO will be uploaded to the path specified by
// guest_additions_path. The default value is upload. If disable is used,
// guest additions won't be downloaded, either.
GuestAdditionsMode string `mapstructure:"guest_additions_mode" required:"false"`
// The path on the guest virtual machine
// where the VirtualBox guest additions ISO will be uploaded. By default this
// is VBoxGuestAdditions.iso which should upload into the login directory of
// the user. This is a configuration
// template where the Version
// variable is replaced with the VirtualBox version.
GuestAdditionsPath string `mapstructure:"guest_additions_path" required:"false"`
// The interface type to use to mount
// guest additions when guest_additions_mode is set to attach. Will
// default to the value set in iso_interface, if iso_interface is set.
// Will default to "ide", if iso_interface is not set. Options are "ide" and
// "sata".
GuestAdditionsInterface string `mapstructure:"guest_additions_interface" required:"false"`
// The SHA256 checksum of the guest
// additions ISO that will be uploaded to the guest VM. By default the
// checksums will be downloaded from the VirtualBox website, so this only needs
// to be set if you want to be explicit about the checksum.
GuestAdditionsSHA256 string `mapstructure:"guest_additions_sha256" required:"false"`
// The URL to the guest additions ISO
// to upload. This can also be a file URL if the ISO is at a local path. By
// default, the VirtualBox builder will attempt to find the guest additions ISO
// on the local file system. If it is not available locally, the builder will
// download the proper guest additions ISO from the internet.
GuestAdditionsURL string `mapstructure:"guest_additions_url" required:"false"`
// Additional flags to pass to
// VBoxManage import. This can be used to add additional command-line flags
// such as --eula-accept to accept a EULA in the OVF.
ImportFlags []string `mapstructure:"import_flags" required:"false"`
// Additional options to pass to the
// VBoxManage import. This can be useful for passing keepallmacs or
// keepnatmacs options for existing ovf images.
ImportOpts string `mapstructure:"import_opts" required:"false"`
// The path to an OVF or OVA file that acts as the
// source of this build. This currently must be a local file.
SourcePath string `mapstructure:"source_path" required:"true"`
// The path where the OVA should be saved
// after download. By default, it will go in the packer cache, with a hash of
// the original filename as its name.
TargetPath string `mapstructure:"target_path" required:"false"`
// This is the name of the OVF file for the new virtual
// machine, without the file extension. By default this is packer-BUILDNAME,
// where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
// Set this to true if you would like to keep
// the VM registered with virtualbox. Defaults to false.
KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
// Defaults to false. When enabled, Packer will
// not export the VM. Useful if the build output is not the resultant image,
// but created inside the VM.
SkipExport bool `mapstructure:"skip_export" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

47
builder/vmware/common/driver_config.go
View File

@ -14,17 +14,42 @@ import (
) )
type DriverConfig struct { type DriverConfig struct {
FusionAppPath string `mapstructure:"fusion_app_path"` // Path to "VMware Fusion.app". By default this is
RemoteType string `mapstructure:"remote_type"` // /Applications/VMware Fusion.app but this setting allows you to
RemoteDatastore string `mapstructure:"remote_datastore"` // customize this.
RemoteCacheDatastore string `mapstructure:"remote_cache_datastore"` FusionAppPath string `mapstructure:"fusion_app_path" required:"false"`
RemoteCacheDirectory string `mapstructure:"remote_cache_directory"` // The type of remote machine that will be used to
RemoteHost string `mapstructure:"remote_host"` // build this VM rather than a local desktop product. The only value accepted
RemotePort int `mapstructure:"remote_port"` // for this currently is esx5. If this is not set, a desktop product will
RemoteUser string `mapstructure:"remote_username"` // be used. By default, this is not set.
RemotePassword string `mapstructure:"remote_password"` RemoteType string `mapstructure:"remote_type" required:"false"`
RemotePrivateKey string `mapstructure:"remote_private_key_file"` // The path to the datastore where the VM will be stored
SkipValidateCredentials bool `mapstructure:"skip_validate_credentials"` // on the ESXi machine.
RemoteDatastore string `mapstructure:"remote_datastore" required:"false"`
// The path to the datastore where supporting files
// will be stored during the build on the remote machine.
RemoteCacheDatastore string `mapstructure:"remote_cache_datastore" required:"false"`
// The path where the ISO and/or floppy files will
// be stored during the build on the remote machine. The path is relative to
// the remote_cache_datastore on the remote machine.
RemoteCacheDirectory string `mapstructure:"remote_cache_directory" required:"false"`
// The host of the remote machine used for access.
// This is only required if remote_type is enabled.
RemoteHost string `mapstructure:"remote_host" required:"false"`
// The SSH port of the remote machine
RemotePort int `mapstructure:"remote_port" required:"false"`
// The SSH username used to access the remote machine.
RemoteUser string `mapstructure:"remote_username" required:"false"`
// The SSH password for access to the remote machine.
RemotePassword string `mapstructure:"remote_password" required:"false"`
// The SSH key for access to the remote machine.
RemotePrivateKey string `mapstructure:"remote_private_key_file" required:"false"`
// When Packer is preparing to run a
// remote esxi build, and export is not disable, by default it runs a no-op
// ovftool command to make sure that the remote_username and remote_password
// given are valid. If you set this flag to true, Packer will skip this
// validation. Default: false.
SkipValidateCredentials bool `mapstructure:"skip_validate_credentials" required:"false"`
} }
func (c *DriverConfig) Prepare(ctx *interpolate.Context) []error { func (c *DriverConfig) Prepare(ctx *interpolate.Context) []error {

44
builder/vmware/common/export_config.go
View File

@ -7,11 +7,45 @@ import (
) )
type ExportConfig struct { type ExportConfig struct {
Format string `mapstructure:"format"` // Either "ovf", "ova" or "vmx", this specifies the output
OVFToolOptions []string `mapstructure:"ovftool_options"` // format of the exported virtual machine. This defaults to "ovf".
SkipExport bool `mapstructure:"skip_export"` // Before using this option, you need to install ovftool. This option
KeepRegistered bool `mapstructure:"keep_registered"` // currently only works when option remote_type is set to "esx5".
SkipCompaction bool `mapstructure:"skip_compaction"` // Since ovftool is only capable of password based authentication
// remote_password must be set when exporting the VM.
Format string `mapstructure:"format" required:"false"`
// Extra options to pass to ovftool
// during export. Each item in the array is a new argument. The options
// --noSSLVerify, --skipManifestCheck, and --targetType are reserved,
// and should not be passed to this argument.
// Currently, exporting the build VM (with ovftool) is only supported when
// building on ESXi e.g. when remote_type is set to esx5. See the
// Building on a Remote vSphere
// Hypervisor
// section below for more info.
OVFToolOptions []string `mapstructure:"ovftool_options" required:"false"`
// Defaults to false. When enabled, Packer will
// not export the VM. Useful if the build output is not the resultant
// image, but created inside the VM.
// Currently, exporting the build VM is only supported when building on
// ESXi e.g. when remote_type is set to esx5. See the Building on a
// Remote vSphere
// Hypervisor
// section below for more info.
SkipExport bool `mapstructure:"skip_export" required:"false"`
// Set this to true if you would like to keep
// the VM registered with the remote ESXi server. If you do not need to export
// the vm, then also set skip_export: true in order to avoid an unnecessary
// step of using ovftool to export the vm. Defaults to false.
KeepRegistered bool `mapstructure:"keep_registered" required:"false"`
// VMware-created disks are defragmented and
// compacted at the end of the build process using vmware-vdiskmanager or
// vmkfstools in ESXi. In certain rare cases, this might actually end up
// making the resulting disks slightly larger. If you find this to be the case,
// you can disable compaction using this configuration value. Defaults to
// false. Default to true for ESXi when disk_type_id is not explicitly
// defined and false otherwise.
SkipCompaction bool `mapstructure:"skip_compaction" required:"false"`
} }
func (c *ExportConfig) Prepare(ctx *interpolate.Context) []error { func (c *ExportConfig) Prepare(ctx *interpolate.Context) []error {

53
builder/vmware/common/hw_config.go
View File

@ -10,23 +10,42 @@ import (
) )
type HWConfig struct { type HWConfig struct {
// The number of cpus to use when building the VM.
// cpu information CpuCount int `mapstructure:"cpus" required:"false"`
CpuCount int `mapstructure:"cpus"` // The amount of memory to use when building the VM
MemorySize int `mapstructure:"memory"` // in megabytes.
CoreCount int `mapstructure:"cores"` MemorySize int `mapstructure:"memory" required:"false"`
// The number of cores per socket to use when building the VM.
// network type and adapter // This corresponds to the cpuid.coresPerSocket option in the .vmx file.
Network string `mapstructure:"network"` CoreCount int `mapstructure:"cores" required:"false"`
NetworkAdapterType string `mapstructure:"network_adapter_type"` // This is the network type that the virtual machine will
// be created with. This can be one of the generic values that map to a device
// device presence // such as hostonly, nat, or bridged. If the network is not one of these
Sound bool `mapstructure:"sound"` // values, then it is assumed to be a VMware network device. (VMnet0..x)
USB bool `mapstructure:"usb"` Network string `mapstructure:"network" required:"false"`
// This is the ethernet adapter type the the
// communication ports // virtual machine will be created with. By default the e1000 network adapter
Serial string `mapstructure:"serial"` // type will be used by Packer. For more information, please consult the
Parallel string `mapstructure:"parallel"` //
// Choosing a network adapter for your virtual machine for desktop VMware
// clients. For ESXi, refer to the proper ESXi documentation.
NetworkAdapterType string `mapstructure:"network_adapter_type" required:"false"`
// Specify whether to enable VMware's virtual soundcard
// device when building the VM. Defaults to false.
Sound bool `mapstructure:"sound" required:"false"`
// Enable VMware's USB bus when building the guest VM.
// Defaults to false. To enable usage of the XHCI bus for USB 3 (5 Gbit/s),
// one can use the vmx_data option to enable it by specifying true for
// the usb_xhci.present property.
USB bool `mapstructure:"usb" required:"false"`
// This specifies a serial port to add to the VM.
// It has a format of Type:option1,option2,.... The field Type can be one
// of the following values: FILE, DEVICE, PIPE, AUTO, or NONE.
Serial string `mapstructure:"serial" required:"false"`
// This specifies a parallel port to add to the VM. It
// has the format of Type:option1,option2,.... Type can be one of the
// following values: FILE, DEVICE, AUTO, or NONE.
Parallel string `mapstructure:"parallel" required:"false"`
} }
func (c *HWConfig) Prepare(ctx *interpolate.Context) []error { func (c *HWConfig) Prepare(ctx *interpolate.Context) []error {

8
builder/vmware/common/output_config.go
View File

@ -8,7 +8,13 @@ import (
) )
type OutputConfig struct { type OutputConfig struct {
OutputDir string `mapstructure:"output_directory"` // This is the path to the directory where the
// resulting virtual machine will be created. This may be relative or absolute.
// If relative, the path is relative to the working directory when packer
// is executed. This directory must not exist or be empty prior to running
// the builder. By default this is output-BUILDNAME where "BUILDNAME" is the
// name of the build.
OutputDir string `mapstructure:"output_directory" required:"false"`
} }
func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error { func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error {

27
builder/vmware/common/run_config.go
View File

@ -7,12 +7,29 @@ import (
) )
type RunConfig struct { type RunConfig struct {
Headless bool `mapstructure:"headless"` // Packer defaults to building VMware virtual machines
// by launching a GUI that shows the console of the machine being built. When
VNCBindAddress string `mapstructure:"vnc_bind_address"` // this value is set to true, the machine will start without a console. For
VNCPortMin int `mapstructure:"vnc_port_min"` // VMware machines, Packer will output VNC connection information in case you
// need to connect to the console to debug the build process.
Headless bool `mapstructure:"headless" required:"false"`
// The IP address that should be
// binded to for VNC. By default packer will use 127.0.0.1 for this. If you
// wish to bind to all interfaces use 0.0.0.0.
VNCBindAddress string `mapstructure:"vnc_bind_address" required:"false"`
// The minimum and maximum port
// to use for VNC access to the virtual machine. The builder uses VNC to type
// the initial boot_command. Because Packer generally runs in parallel,
// Packer uses a randomly chosen port in this range that appears available. By
// default this is 5900 to 6000. The minimum and maximum ports are
// inclusive.
VNCPortMin int `mapstructure:"vnc_port_min" required:"false"`
VNCPortMax int `mapstructure:"vnc_port_max"` VNCPortMax int `mapstructure:"vnc_port_max"`
VNCDisablePassword bool `mapstructure:"vnc_disable_password"` // Don't auto-generate a VNC password that
// is used to secure the VNC communication with the VM. This must be set to
// true if building on ESXi 6.5 and 6.7 with VNC enabled. Defaults to
// false.
VNCDisablePassword bool `mapstructure:"vnc_disable_password" required:"false"`
} }
func (c *RunConfig) Prepare(ctx *interpolate.Context) (errs []error) { func (c *RunConfig) Prepare(ctx *interpolate.Context) (errs []error) {

11
builder/vmware/common/shutdown_config.go
View File

@ -8,8 +8,15 @@ import (
) )
type ShutdownConfig struct { type ShutdownConfig struct {
ShutdownCommand string `mapstructure:"shutdown_command"` // The command to use to gracefully shut down the
RawShutdownTimeout string `mapstructure:"shutdown_timeout"` // machine once all the provisioning is done. By default this is an empty
// string, which tells Packer to just forcefully shut down the machine.
ShutdownCommand string `mapstructure:"shutdown_command" required:"false"`
// The amount of time to wait after executing the
// shutdown_command for the virtual machine to actually shut down. If it
// doesn't shut down in this time, it is an error. By default, the timeout is
// 5m or five minutes.
RawShutdownTimeout string `mapstructure:"shutdown_timeout" required:"false"`
ShutdownTimeout time.Duration `` ShutdownTimeout time.Duration ``
} }

14
builder/vmware/common/tools_config.go
View File

@ -5,8 +5,18 @@ import (
) )
type ToolsConfig struct { type ToolsConfig struct {
ToolsUploadFlavor string `mapstructure:"tools_upload_flavor"` // The flavor of the VMware Tools ISO to
ToolsUploadPath string `mapstructure:"tools_upload_path"` // upload into the VM. Valid values are darwin, linux, and windows. By
// default, this is empty, which means VMware tools won't be uploaded.
ToolsUploadFlavor string `mapstructure:"tools_upload_flavor" required:"false"`
// The path in the VM to upload the
// VMware tools. This only takes effect if tools_upload_flavor is non-empty.
// This is a configuration
// template that has a single
// valid variable: Flavor, which will be the value of tools_upload_flavor.
// By default the upload path is set to {{.Flavor}}.iso. This setting is not
// used when remote_type is esx5.
ToolsUploadPath string `mapstructure:"tools_upload_path" required:"false"`
} }
func (c *ToolsConfig) Prepare(ctx *interpolate.Context) []error { func (c *ToolsConfig) Prepare(ctx *interpolate.Context) []error {

25
builder/vmware/common/vmx_config.go
View File

@ -5,10 +5,27 @@ import (
) )
type VMXConfig struct { type VMXConfig struct {
VMXData map[string]string `mapstructure:"vmx_data"` // Arbitrary key/values to enter
VMXDataPost map[string]string `mapstructure:"vmx_data_post"` // into the virtual machine VMX file. This is for advanced users who want to
VMXRemoveEthernet bool `mapstructure:"vmx_remove_ethernet_interfaces"` // set properties that aren't yet supported by the builder.
VMXDisplayName string `mapstructure:"display_name"` VMXData map[string]string `mapstructure:"vmx_data" required:"false"`
// Identical to vmx_data,
// except that it is run after the virtual machine is shutdown, and before the
// virtual machine is exported.
VMXDataPost map[string]string `mapstructure:"vmx_data_post" required:"false"`
// Remove all ethernet interfaces
// from the VMX file after building. This is for advanced users who understand
// the ramifications, but is useful for building Vagrant boxes since Vagrant
// will create ethernet interfaces when provisioning a box. Defaults to
// false.
VMXRemoveEthernet bool `mapstructure:"vmx_remove_ethernet_interfaces" required:"false"`
// The name that will appear in your vSphere client,
// and will be used for the vmx basename. This will override the "displayname"
// value in your vmx file. It will also override the "displayname" if you have
// set it in the "vmx_data" Packer option. This option is useful if you are
// chaining vmx builds and want to make sure that the display name of each step
// in the chain is unique.
VMXDisplayName string `mapstructure:"display_name" required:"false"`
} }
func (c *VMXConfig) Prepare(ctx *interpolate.Context) []error { func (c *VMXConfig) Prepare(ctx *interpolate.Context) []error {

79
builder/vmware/iso/config.go
View File

@ -29,25 +29,70 @@ type Config struct {
vmwcommon.ToolsConfig `mapstructure:",squash"` vmwcommon.ToolsConfig `mapstructure:",squash"`
vmwcommon.VMXConfig `mapstructure:",squash"` vmwcommon.VMXConfig `mapstructure:",squash"`
vmwcommon.ExportConfig `mapstructure:",squash"` vmwcommon.ExportConfig `mapstructure:",squash"`
// The size(s) of any additional
// disk drives // hard disks for the VM in megabytes. If this is not specified then the VM
AdditionalDiskSize []uint `mapstructure:"disk_additional_size"` // will only contain a primary hard disk. The builder uses expandable, not
DiskAdapterType string `mapstructure:"disk_adapter_type"` // fixed-size virtual hard disks, so the actual file representing the disk will
DiskName string `mapstructure:"vmdk_name"` // not use the full size unless it is full.
DiskSize uint `mapstructure:"disk_size"` AdditionalDiskSize []uint `mapstructure:"disk_additional_size" required:"false"`
DiskTypeId string `mapstructure:"disk_type_id"` // The adapter type of the VMware virtual disk
Format string `mapstructure:"format"` // to create. This option is for advanced usage, modify only if you know what
// you're doing. Some of the options you can specify are ide, sata, nvme
// cdrom drive // or scsi (which uses the "lsilogic" scsi interface by default). If you
CdromAdapterType string `mapstructure:"cdrom_adapter_type"` // specify another option, Packer will assume that you're specifying a scsi
// interface of that specified type. For more information, please consult the
// platform information //
GuestOSType string `mapstructure:"guest_os_type"` // Virtual Disk Manager User's Guide for desktop VMware clients.
Version string `mapstructure:"version"` // For ESXi, refer to the proper ESXi documentation.
VMName string `mapstructure:"vm_name"` DiskAdapterType string `mapstructure:"disk_adapter_type" required:"false"`
// The filename of the virtual disk that'll be created,
// without the extension. This defaults to packer.
DiskName string `mapstructure:"vmdk_name" required:"false"`
// The size of the hard disk for the VM in megabytes.
// The builder uses expandable, not fixed-size virtual hard disks, so the
// actual file representing the disk will not use the full size unless it
// is full. By default this is set to 40000 (about 40 GB).
DiskSize uint `mapstructure:"disk_size" required:"false"`
// The type of VMware virtual disk to create. This
// option is for advanced usage.
DiskTypeId string `mapstructure:"disk_type_id" required:"false"`
// Either "ovf", "ova" or "vmx", this specifies the output
// format of the exported virtual machine. This defaults to "ovf".
// Before using this option, you need to install ovftool. This option
// currently only works when option remote_type is set to "esx5".
// Since ovftool is only capable of password based authentication
// remote_password must be set when exporting the VM.
Format string `mapstructure:"format" required:"false"`
// The adapter type (or bus) that will be used
// by the cdrom device. This is chosen by default based on the disk adapter
// type. VMware tends to lean towards ide for the cdrom device unless
// sata is chosen for the disk adapter and so Packer attempts to mirror
// this logic. This field can be specified as either ide, sata, or scsi.
CdromAdapterType string `mapstructure:"cdrom_adapter_type" required:"false"`
// The guest OS type being installed. This will be
// set in the VMware VMX. By default this is other. By specifying a more
// specific OS type, VMware may perform some optimizations or virtual hardware
// changes to better support the operating system running in the
// virtual machine.
GuestOSType string `mapstructure:"guest_os_type" required:"false"`
// The vmx hardware
// version
// for the new virtual machine. Only the default value has been tested, any
// other value is experimental. Default value is 9.
Version string `mapstructure:"version" required:"false"`
// This is the name of the VMX file for the new virtual
// machine, without the file extension. By default this is packer-BUILDNAME,
// where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"` VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"`
VMXTemplatePath string `mapstructure:"vmx_template_path"` // Path to a configuration
// template that defines the
// contents of the virtual machine VMX file for VMware. This is for advanced
// users only as this can render the virtual machine non-functional. See
// below for more information. For basic VMX modifications, try
// vmx_data first.
VMXTemplatePath string `mapstructure:"vmx_template_path" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

21
builder/vmware/vmx/config.go
View File

@ -26,11 +26,22 @@ type Config struct {
vmwcommon.ToolsConfig `mapstructure:",squash"` vmwcommon.ToolsConfig `mapstructure:",squash"`
vmwcommon.VMXConfig `mapstructure:",squash"` vmwcommon.VMXConfig `mapstructure:",squash"`
vmwcommon.ExportConfig `mapstructure:",squash"` vmwcommon.ExportConfig `mapstructure:",squash"`
// By default Packer creates a 'full' clone of
Linked bool `mapstructure:"linked"` // the virtual machine specified in source_path. The resultant virtual
RemoteType string `mapstructure:"remote_type"` // machine is fully independant from the parent it was cloned from.
SourcePath string `mapstructure:"source_path"` Linked bool `mapstructure:"linked" required:"false"`
VMName string `mapstructure:"vm_name"` // The type of remote machine that will be used to
// build this VM rather than a local desktop product. The only value accepted
// for this currently is esx5. If this is not set, a desktop product will
// be used. By default, this is not set.
RemoteType string `mapstructure:"remote_type" required:"false"`
// Path to the source VMX file to clone. If
// remote_type is enabled then this specifies a path on the remote_host.
SourcePath string `mapstructure:"source_path" required:"true"`
// This is the name of the VMX file for the new virtual
// machine, without the file extension. By default this is packer-BUILDNAME,
// where "BUILDNAME" is the name of the build.
VMName string `mapstructure:"vm_name" required:"false"`
ctx interpolate.Context ctx interpolate.Context
} }

105
builder/yandex/config.go
View File

@ -25,38 +25,83 @@ var reImageFamily = regexp.MustCompile(`^[a-z]([-a-z0-9]{0,61}[a-z0-9])?$`)
type Config struct { type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
Communicator communicator.Config `mapstructure:",squash"` Communicator communicator.Config `mapstructure:",squash"`
// Non standard api endpoint URL.
Endpoint string `mapstructure:"endpoint"` Endpoint string `mapstructure:"endpoint" required:"false"`
FolderID string `mapstructure:"folder_id"` // The folder ID that will be used to launch instances and store images.
ServiceAccountKeyFile string `mapstructure:"service_account_key_file"` // Alternatively you may set value by environment variable YC_FOLDER_ID.
Token string `mapstructure:"token"` FolderID string `mapstructure:"folder_id" required:"true"`
// Path to file with Service Account key in json format. This
DiskName string `mapstructure:"disk_name"` // is an alternative method to authenticate to Yandex.Cloud. Alternatively you may set environment variable
DiskSizeGb int `mapstructure:"disk_size_gb"` // YC_SERVICE_ACCOUNT_KEY_FILE.
DiskType string `mapstructure:"disk_type"` ServiceAccountKeyFile string `mapstructure:"service_account_key_file" required:"false"`
ImageDescription string `mapstructure:"image_description"` // OAuth token to use to authenticate to Yandex.Cloud. Alternatively you may set
ImageFamily string `mapstructure:"image_family"` // value by environment variable YC_TOKEN.
ImageLabels map[string]string `mapstructure:"image_labels"` Token string `mapstructure:"token" required:"true"`
ImageName string `mapstructure:"image_name"` // The name of the disk, if unset the instance name
ImageProductIDs []string `mapstructure:"image_product_ids"` // will be used.
InstanceCores int `mapstructure:"instance_cores"` DiskName string `mapstructure:"disk_name" required:"false"`
InstanceMemory int `mapstructure:"instance_mem_gb"` // The size of the disk in GB. This defaults to 10, which is 10GB.
InstanceName string `mapstructure:"instance_name"` DiskSizeGb int `mapstructure:"disk_size_gb" required:"false"`
Labels map[string]string `mapstructure:"labels"` // Specify disk type for the launched instance. Defaults to network-hdd.
PlatformID string `mapstructure:"platform_id"` DiskType string `mapstructure:"disk_type" required:"false"`
Metadata map[string]string `mapstructure:"metadata"` // The description of the resulting image.
SerialLogFile string `mapstructure:"serial_log_file"` ImageDescription string `mapstructure:"image_description" required:"false"`
SourceImageFamily string `mapstructure:"source_image_family"` // The family name of the resulting image.
SourceImageFolderID string `mapstructure:"source_image_folder_id"` ImageFamily string `mapstructure:"image_family" required:"false"`
SourceImageID string `mapstructure:"source_image_id"` // Key/value pair labels to
SubnetID string `mapstructure:"subnet_id"` // apply to the created image.
UseIPv4Nat bool `mapstructure:"use_ipv4_nat"` ImageLabels map[string]string `mapstructure:"image_labels" required:"false"`
UseIPv6 bool `mapstructure:"use_ipv6"` // The unique name of the resulting image. Defaults to
UseInternalIP bool `mapstructure:"use_internal_ip"` // packer-{{timestamp}}.
Zone string `mapstructure:"zone"` ImageName string `mapstructure:"image_name" required:"false"`
// License IDs that indicate which licenses are attached to resulting image.
ImageProductIDs []string `mapstructure:"image_product_ids" required:"false"`
// The number of cores available to the instance.
InstanceCores int `mapstructure:"instance_cores" required:"false"`
// The amount of memory available to the instance, specified in gigabytes.
InstanceMemory int `mapstructure:"instance_mem_gb" required:"false"`
// The name assigned to the instance.
InstanceName string `mapstructure:"instance_name" required:"false"`
// Key/value pair labels to apply to
// the launched instance.
Labels map[string]string `mapstructure:"labels" required:"false"`
// Identifier of the hardware platform configuration for the instance. This defaults to standard-v1.
PlatformID string `mapstructure:"platform_id" required:"false"`
// Metadata applied to the launched
// instance.
Metadata map[string]string `mapstructure:"metadata" required:"false"`
// File path to save serial port output of the launched instance.
SerialLogFile string `mapstructure:"serial_log_file" required:"false"`
// The source image family to create the new image
// from. You can also specify source_image_id instead. Just one of a source_image_id or
// source_image_family must be specified. Example: ubuntu-1804-lts
SourceImageFamily string `mapstructure:"source_image_family" required:"true"`
// The ID of the folder containing the source image.
SourceImageFolderID string `mapstructure:"source_image_folder_id" required:"false"`
// The source image ID to use to create the new image
// from.
SourceImageID string `mapstructure:"source_image_id" required:"false"`
// The Yandex VPC subnet id to use for
// the launched instance. Note, the zone of the subnet must match the
// zone in which the VM is launched.
SubnetID string `mapstructure:"subnet_id" required:"false"`
// If set to true, then launched instance will have external internet
// access.
UseIPv4Nat bool `mapstructure:"use_ipv4_nat" required:"false"`
// Set to true to enable IPv6 for the instance being
// created. This defaults to false, or not enabled.
// -> Note: ~> Usage of IPv6 will be available in the future.
UseIPv6 bool `mapstructure:"use_ipv6" required:"false"`
// If true, use the instance's internal IP address
// instead of its external IP during building.
UseInternalIP bool `mapstructure:"use_internal_ip" required:"false"`
// The name of the zone to launch the instance. This defaults to ru-central1-a.
Zone string `mapstructure:"zone" required:"false"`
ctx interpolate.Context ctx interpolate.Context
StateTimeout time.Duration `mapstructure:"state_timeout"` // The time to wait for instance state changes.
// Defaults to 5m.
StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`
} }
func NewConfig(raws ...interface{}) (*Config, []string, error) { func NewConfig(raws ...interface{}) (*Config, []string, error) {

63
cmd/doc-required-scraper/main.go
View File

@ -2,6 +2,10 @@ package main
import ( import (
"fmt" "fmt"
"io/ioutil"
"os"
"path/filepath"
"regexp"
"strings" "strings"
"github.com/gocolly/colly" "github.com/gocolly/colly"
@ -12,6 +16,12 @@ const (
CacheDir = "cache/" CacheDir = "cache/"
) )
func commentize(text string) string {
text = text[strings.Index(text, ") -")+len(") -"):]
text = strings.ReplaceAll(text, "\n", "\n // ")
return text
}
func main() { func main() {
c := colly.NewCollector() c := colly.NewCollector()
@ -23,18 +33,55 @@ func main() {
} }
e.Request.Visit(url) e.Request.Visit(url)
}) })
for _, required := range []bool{true, false} {
required := required
sel := "#required- + ul a[name]"
if !required {
sel = "#optional- + ul a[name]"
}
c.OnHTML(sel, func(e *colly.HTMLElement) {
c.OnHTML("#required- + ul a[name]", func(e *colly.HTMLElement) { name := e.Attr("name")
builder := e.Request.URL.Path[strings.Index(e.Request.URL.Path, "/builders/")+len("/builders/"):] builder := e.Request.URL.Path[strings.Index(e.Request.URL.Path, "/builders/")+len("/builders/"):]
builder = strings.TrimSuffix(builder, ".html") builder = strings.TrimSuffix(builder, ".html")
text := e.DOM.Parent().Text() fieldDoc := e.DOM.Parent()
text = strings.ReplaceAll(text, "\n", "") text := fieldDoc.Text()
text = strings.TrimSpace(text)
fmt.Printf("required: %25s builder: %20s text: %s\n", e.Attr("name"), builder, text) builderPath := strings.Split(builder, "-")[0]
}) if name == "vpc_filter" {
fmt.Printf("required: %25s builderPath: %20s text: %20s\n", name, builderPath, text)
}
err := filepath.Walk("./builder/"+builderPath, func(path string, info os.FileInfo, err error) error {
if err != nil || info.IsDir() || filepath.Ext(path) != ".go" {
return nil
}
body, err := ioutil.ReadFile(path)
if err != nil {
panic(err)
}
regex := regexp.MustCompile(fmt.Sprintf(`(\n\s+//.*)*\n+(\s*)([A-Z].*mapstructure:"%s")(\s+required:"%t")?(.*)`, name, required))
replaced := regex.ReplaceAll(body, []byte(fmt.Sprintf("\n$2//%s\n"+`$2$3 required:"%t"$5`, commentize(text), required)))
if string(replaced) == string(body) {
return nil
}
err = ioutil.WriteFile(path, replaced, 0)
if err != nil {
panic(err)
}
return nil
})
if err != nil {
panic(err)
}
})
}
c.CacheDir = CacheDir c.CacheDir = CacheDir