github.com/aspring/packer@v0.8.1-0.20150629211158-9db281ac0f89/website/source/docs/builders/amazon-instance.html.markdown (about) 1 --- 2 layout: "docs" 3 page_title: "Amazon AMI Builder (instance-store)" 4 description: |- 5 The `amazon-instance` Packer builder is able to create Amazon AMIs backed by instance storage as the root device. For more information on the difference between instance storage and EBS-backed instances, see the storage for the root device section in the EC2 documentation. 6 --- 7 8 # AMI Builder (instance-store) 9 10 Type: `amazon-instance` 11 12 The `amazon-instance` Packer builder is able to create Amazon AMIs backed by 13 instance storage as the root device. For more information on the difference 14 between instance storage and EBS-backed instances, see the 15 ["storage for the root device" section in the EC2 documentation](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device). 16 17 This builder builds an AMI by launching an EC2 instance from an existing 18 instance-storage backed AMI, provisioning that running machine, and then 19 bundling and creating a new AMI from that machine. 20 This is all done in your own AWS account. The builder will create temporary 21 keypairs, security group rules, etc. that provide it temporary access to 22 the instance while the image is being created. This simplifies configuration 23 quite a bit. 24 25 The builder does _not_ manage AMIs. Once it creates an AMI and stores it 26 in your account, it is up to you to use, delete, etc. the AMI. 27 28 -> **Note** This builder requires that the 29 [Amazon EC2 AMI Tools](http://aws.amazon.com/developertools/368) 30 are installed onto the machine. This can be done within a provisioner, but 31 must be done before the builder finishes running. 32 33 ## Configuration Reference 34 35 There are many configuration options available for the builder. They are 36 segmented below into two categories: required and optional parameters. Within 37 each category, the available configuration keys are alphabetized. 38 39 In addition to the options listed here, a 40 [communicator](/docs/templates/communicator.html) 41 can be configured for this builder. 42 43 ### Required: 44 45 * `access_key` (string) - The access key used to communicate with AWS. 46 If not specified, Packer will use the key from any [credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) file 47 or fall back to environment variables `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` (in that order), if set. 48 49 * `account_id` (string) - Your AWS account ID. This is required for bundling 50 the AMI. This is _not the same_ as the access key. You can find your 51 account ID in the security credentials page of your AWS account. 52 53 * `ami_name` (string) - The name of the resulting AMI that will appear 54 when managing AMIs in the AWS console or via APIs. This must be unique. 55 To help make this unique, use a function like `timestamp` (see 56 [configuration templates](/docs/templates/configuration-templates.html) for more info) 57 58 * `instance_type` (string) - The EC2 instance type to use while building 59 the AMI, such as "m1.small". 60 61 * `region` (string) - The name of the region, such as "us-east-1", in which 62 to launch the EC2 instance to create the AMI. 63 64 * `s3_bucket` (string) - The name of the S3 bucket to upload the AMI. 65 This bucket will be created if it doesn't exist. 66 67 * `secret_key` (string) - The secret key used to communicate with AWS. 68 If not specified, Packer will use the secret from any [credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) file 69 or fall back to environment variables `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` (in that order), if set. 70 71 * `source_ami` (string) - The initial AMI used as a base for the newly 72 created machine. 73 74 * `ssh_username` (string) - The username to use in order to communicate 75 over SSH to the running machine. 76 77 * `x509_cert_path` (string) - The local path to a valid X509 certificate for 78 your AWS account. This is used for bundling the AMI. This X509 certificate 79 must be registered with your account from the security credentials page 80 in the AWS console. 81 82 * `x509_key_path` (string) - The local path to the private key for the X509 83 certificate specified by `x509_cert_path`. This is used for bundling the AMI. 84 85 ### Optional: 86 87 * `ami_block_device_mappings` (array of block device mappings) - Add the block 88 device mappings to the AMI. The block device mappings allow for keys: 89 90 - `device_name` (string) - The device name exposed to the instance (for 91 example, "/dev/sdh" or "xvdh") 92 - `virtual_name` (string) - The virtual device name. See the documentation on 93 [Block Device Mapping][1] for more information 94 - `snapshot_id` (string) - The ID of the snapshot 95 - `volume_type` (string) - The volume type. gp2 for General Purpose (SSD) 96 volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic 97 volumes 98 - `volume_size` (integer) - The size of the volume, in GiB. Required if not 99 specifying a `snapshot_id` 100 - `delete_on_termination` (boolean) - Indicates whether the EBS volume is 101 deleted on instance termination 102 - `encrypted` (boolean) - Indicates whether to encrypt the volume or not 103 - `no_device` (boolean) - Suppresses the specified device included in the 104 block device mapping of the AMI 105 - `iops` (integer) - The number of I/O operations per second (IOPS) that the 106 volume supports. See the documentation on [IOPs][2] for more information 107 108 * `ami_description` (string) - The description to set for the resulting 109 AMI(s). By default this description is empty. 110 111 * `ami_groups` (array of strings) - A list of groups that have access 112 to launch the resulting AMI(s). By default no groups have permission 113 to launch the AMI. `all` will make the AMI publicly accessible. 114 AWS currently doesn't accept any value other than "all". 115 116 * `ami_product_codes` (array of strings) - A list of product codes to 117 associate with the AMI. By default no product codes are associated with 118 the AMI. 119 120 * `ami_regions` (array of strings) - A list of regions to copy the AMI to. 121 Tags and attributes are copied along with the AMI. AMI copying takes time 122 depending on the size of the AMI, but will generally take many minutes. 123 124 * `ami_users` (array of strings) - A list of account IDs that have access 125 to launch the resulting AMI(s). By default no additional users other than the user 126 creating the AMI has permissions to launch it. 127 128 * `ami_virtualization_type` (string) - The type of virtualization for the AMI 129 you are building. This option is required to register HVM images. Can be 130 "paravirtual" (default) or "hvm". 131 132 * `associate_public_ip_address` (boolean) - If using a non-default VPC, public 133 IP addresses are not provided by default. If this is toggled, your new 134 instance will get a Public IP. 135 136 * `availability_zone` (string) - Destination availability zone to launch instance in. 137 Leave this empty to allow Amazon to auto-assign. 138 139 * `bundle_destination` (string) - The directory on the running instance 140 where the bundled AMI will be saved prior to uploading. By default this is 141 "/tmp". This directory must exist and be writable. 142 143 * `bundle_prefix` (string) - The prefix for files created from bundling 144 the root volume. By default this is "image-{{timestamp}}". The `timestamp` 145 variable should be used to make sure this is unique, otherwise it can 146 collide with other created AMIs by Packer in your account. 147 148 * `bundle_upload_command` (string) - The command to use to upload the 149 bundled volume. See the "custom bundle commands" section below for more 150 information. 151 152 * `bundle_vol_command` (string) - The command to use to bundle the volume. 153 See the "custom bundle commands" section below for more information. 154 155 * `enhanced_networking` (boolean) - Enable enhanced networking (SriovNetSupport) on 156 HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your AWS IAM policy. 157 158 * `force_deregister` (boolean) - Force Packer to first deregister an existing 159 AMI if one with the same name already exists. Default `false`. 160 161 * `iam_instance_profile` (string) - The name of an 162 [IAM instance profile](http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) 163 to launch the EC2 instance with. 164 165 * `launch_block_device_mappings` (array of block device mappings) - Add the 166 block device mappings to the launch instance. The block device mappings are 167 the same as `ami_block_device_mappings` above. 168 169 * `run_tags` (object of key/value strings) - Tags to apply to the instance 170 that is _launched_ to create the AMI. These tags are _not_ applied to 171 the resulting AMI unless they're duplicated in `tags`. 172 173 * `security_group_id` (string) - The ID (_not_ the name) of the security 174 group to assign to the instance. By default this is not set and Packer 175 will automatically create a new temporary security group to allow SSH 176 access. Note that if this is specified, you must be sure the security 177 group allows access to the `ssh_port` given below. 178 179 * `security_group_ids` (array of strings) - A list of security groups as 180 described above. Note that if this is specified, you must omit the 181 `security_group_id`. 182 183 * `spot_price` (string) - The maximum hourly price to launch a spot instance 184 to create the AMI. It is a type of instances that EC2 starts when the maximum 185 price that you specify exceeds the current spot price. Spot price will be 186 updated based on available spot instance capacity and current spot Instance 187 requests. It may save you some costs. You can set this to "auto" for 188 Packer to automatically discover the best spot price. 189 190 * `spot_price_auto_product` (string) - Required if `spot_price` is set to 191 "auto". This tells Packer what sort of AMI you're launching to find the best 192 spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, 193 `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` 194 195 * `ssh_keypair_name` (string) - If specified, this is the key that will be 196 used for SSH with the machine. By default, this is blank, and Packer will 197 generate a temporary keypair. `ssh_private_key_file` must be specified 198 with this. 199 200 * `ssh_private_ip` (bool) - If true, then SSH will always use the private 201 IP if available. 202 203 * `subnet_id` (string) - If using VPC, the ID of the subnet, such as 204 "subnet-12345def", where Packer will launch the EC2 instance. This field is 205 required if you are using an non-default VPC. 206 207 * `tags` (object of key/value strings) - Tags applied to the AMI. 208 209 * `temporary_key_pair_name` (string) - The name of the temporary keypair 210 to generate. By default, Packer generates a name with a UUID. 211 212 * `user_data` (string) - User data to apply when launching the instance. 213 Note that you need to be careful about escaping characters due to the 214 templates being JSON. It is often more convenient to use `user_data_file`, 215 instead. 216 217 * `user_data_file` (string) - Path to a file that will be used for the 218 user data when launching the instance. 219 220 * `vpc_id` (string) - If launching into a VPC subnet, Packer needs the 221 VPC ID in order to create a temporary security group within the VPC. 222 223 * `x509_upload_path` (string) - The path on the remote machine where the 224 X509 certificate will be uploaded. This path must already exist and be 225 writable. X509 certificates are uploaded after provisioning is run, so 226 it is perfectly okay to create this directory as part of the provisioning 227 process. 228 229 * `windows_password_timeout` (string) - The timeout for waiting for 230 a Windows password for Windows instances. Defaults to 20 minutes. 231 Example value: "10m" 232 233 ## Basic Example 234 235 Here is a basic example. It is completely valid except for the access keys: 236 237 ```javascript 238 { 239 "type": "amazon-instance", 240 "access_key": "YOUR KEY HERE", 241 "secret_key": "YOUR SECRET KEY HERE", 242 "region": "us-east-1", 243 "source_ami": "ami-d9d6a6b0", 244 "instance_type": "m1.small", 245 "ssh_username": "ubuntu", 246 247 "account_id": "0123-4567-0890", 248 "s3_bucket": "packer-images", 249 "x509_cert_path": "x509.cert", 250 "x509_key_path": "x509.key", 251 "x509_upload_path": "/tmp", 252 253 "ami_name": "packer-quick-start {{timestamp}}" 254 } 255 ``` 256 257 -> **Note:** Packer can also read the access key and secret 258 access key from environmental variables. See the configuration reference in 259 the section above for more information on what environmental variables Packer 260 will look for. 261 262 ## Accessing the Instance to Debug 263 264 If you need to access the instance to debug for some reason, run the builder 265 with the `-debug` flag. In debug mode, the Amazon builder will save the 266 private key in the current directory and will output the DNS or IP information 267 as well. You can use this information to access the instance as it is 268 running. 269 270 ## Custom Bundle Commands 271 272 A lot of the process required for creating an instance-store backed AMI 273 involves commands being run on the actual source instance. Specifically, the 274 `ec2-bundle-vol` and `ec2-upload-bundle` commands must be used to bundle 275 the root filesystem and upload it, respectively. 276 277 Each of these commands have a lot of available flags. Instead of exposing each 278 possible flag as a template configuration option, the instance-store AMI 279 builder for Packer lets you customize the entire command used to bundle 280 and upload the AMI. 281 282 These are configured with `bundle_vol_command` and `bundle_upload_command`. 283 Both of these configurations are 284 [configuration templates](/docs/templates/configuration-templates.html) 285 and have support for their own set of template variables. 286 287 ### Bundle Volume Command 288 289 The default value for `bundle_vol_command` is shown below. It is split 290 across multiple lines for convenience of reading. The bundle volume command 291 is responsible for executing `ec2-bundle-vol` in order to store and image 292 of the root filesystem to use to create the AMI. 293 294 ```text 295 sudo -i -n ec2-bundle-vol \ 296 -k {{.KeyPath}} \ 297 -u {{.AccountId}} \ 298 -c {{.CertPath}} \ 299 -r {{.Architecture}} \ 300 -e {{.PrivatePath}}/* \ 301 -d {{.Destination}} \ 302 -p {{.Prefix}} \ 303 --batch \ 304 --no-filter 305 ``` 306 307 The available template variables should be self-explanatory based on the 308 parameters they're used to satisfy the `ec2-bundle-vol` command. 309 310 ~> **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem and 311 .gpg files during the bundling of the AMI, which can cause problems on some 312 systems, such as Ubuntu. You may want to customize the bundle volume command 313 to include those files (see the `--no-filter` option of ec2-bundle-vol). 314 315 ### Bundle Upload Command 316 317 The default value for `bundle_upload_command` is shown below. It is split 318 across multiple lines for convenience of reading. The bundle upload command 319 is responsible for taking the bundled volume and uploading it to S3. 320 321 ```text 322 sudo -i -n ec2-upload-bundle \ 323 -b {{.BucketName}} \ 324 -m {{.ManifestPath}} \ 325 -a {{.AccessKey}} \ 326 -s {{.SecretKey}} \ 327 -d {{.BundleDirectory}} \ 328 --batch \ 329 --region {{.Region}} \ 330 --retry 331 ``` 332 333 The available template variables should be self-explanatory based on the 334 parameters they're used to satisfy the `ec2-upload-bundle` command. 335 336 [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html 337 [2]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html