Merge pull request #4258 from ksatirli/patch-1
highlights possible values instead of quoting them
This commit is contained in:
Matthew Hooker
GitHub
commit
0a3b7e1b53
|
|
@ -11,15 +11,15 @@ page_title: 'Amazon EBS Volume Builder'
|
|||
Type: `amazon-ebsvolume`
|
||||
|
||||
The `amazon-ebsvolume` Packer builder is able to create Amazon Elastic Block
|
||||
Store volumes which are prepopulated with filesystems or data.
|
||||
Store volumes which are prepopulated with filesystems or data.
|
||||
|
||||
This builder builds EBS volumes by launching an EC2 instance from a source AMI,
|
||||
provisioning that running machine, and then destroying the source machine, keeping
|
||||
the volumes intact.
|
||||
|
||||
This is all done in your own AWS account. The builder will create temporary
|
||||
keypairs, security group rules, etc. that provide it temporary access to the
|
||||
instance while the image is being created.
|
||||
key pairs, security group rules, etc. that provide it temporary access to the
|
||||
instance while the image is being created.
|
||||
|
||||
The builder does *not* manage EBS Volumes. Once it creates volumes and stores
|
||||
it in your account, it is up to you to use, delete, etc. the volumes.
|
||||
|
|
@ -40,9 +40,9 @@ builder.
|
|||
how to set this.](/docs/builders/amazon.html#specifying-amazon-credentials)
|
||||
|
||||
- `instance_type` (string) - The EC2 instance type to use while building the
|
||||
AMI, such as "m1.small".
|
||||
AMI, such as `m1.small`.
|
||||
|
||||
- `region` (string) - The name of the region, such as "us-east-1", in which to
|
||||
- `region` (string) - The name of the region, such as `us-east-1`, in which to
|
||||
launch the EC2 instance to create the AMI.
|
||||
|
||||
- `secret_key` (string) - The secret key used to communicate with AWS. [Learn
|
||||
|
|
@ -58,7 +58,7 @@ builder.
|
|||
device mappings to the AMI. The block device mappings allow for keys:
|
||||
|
||||
- `device_name` (string) - The device name exposed to the instance (for
|
||||
example, "/dev/sdh" or "xvdh"). Required when specifying `volume_size`.
|
||||
example, `/dev/sdh` or `xvdh`). Required when specifying `volume_size`.
|
||||
- `delete_on_termination` (boolean) - Indicates whether the EBS volume is
|
||||
deleted on instance termination
|
||||
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not
|
||||
|
|
@ -75,8 +75,8 @@ builder.
|
|||
for more information
|
||||
- `volume_size` (integer) - The size of the volume, in GiB. Required if not
|
||||
specifying a `snapshot_id`
|
||||
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD)
|
||||
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic
|
||||
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD)
|
||||
volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic
|
||||
volumes
|
||||
- `tags` (map) - Tags to apply to the volume. These are retained after the
|
||||
builder completes.
|
||||
|
|
@ -115,11 +115,11 @@ builder.
|
|||
`security_group_id`.
|
||||
|
||||
- `shutdown_behaviour` (string) - Automatically terminate instances on shutdown
|
||||
incase packer exits ungracefully. Possible values are "stop" and "terminate",
|
||||
default is stop.
|
||||
incase packer exits ungracefully. Possible values are `stop` and `terminate`.
|
||||
Defaults to `stop`.
|
||||
|
||||
- `skip_region_validation` (boolean) - Set to true if you want to skip
|
||||
validation of the region configuration option. Defaults to false.
|
||||
- `skip_region_validation` (boolean) - Set to `true` if you want to skip
|
||||
validation of the region configuration option. Defaults to `false`.
|
||||
|
||||
- `snapshot_groups` (array of strings) - A list of groups that have access to
|
||||
create volumes from the snapshot(s). By default no groups have permission to create
|
||||
|
|
@ -164,30 +164,30 @@ builder.
|
|||
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).
|
||||
`auto` for Packer to automatically discover the best spot price or to `0`
|
||||
to use an on-demand instance (default).
|
||||
|
||||
- `spot_price_auto_product` (string) - Required if `spot_price` is set
|
||||
to "auto". This tells Packer what sort of AMI you're launching to find the
|
||||
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)`
|
||||
`Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)` or `Windows (Amazon VPC)`
|
||||
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be
|
||||
used for SSH with the machine. By default, this is blank, and Packer will
|
||||
generate a temporary keypair unless
|
||||
generate a temporary key pair unless
|
||||
[`ssh_password`](/docs/templates/communicator.html#ssh_password) is used.
|
||||
[`ssh_private_key_file`](/docs/templates/communicator.html#ssh_private_key_file)
|
||||
must be specified with this.
|
||||
|
||||
- `ssh_private_ip` (boolean) - If true, then SSH will always use the private
|
||||
- `ssh_private_ip` (boolean) - If `true`, then SSH will always use the private
|
||||
IP if available.
|
||||
|
||||
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
||||
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
||||
`subnet-12345def`, where Packer will launch the EC2 instance. This field is
|
||||
required if you are using an non-default VPC.
|
||||
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary keypair
|
||||
to generate. By default, Packer generates a name with a UUID.
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary key pair
|
||||
to generate. By default, Packer generates a name with an UUID.
|
||||
|
||||
- `token` (string) - 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
|
||||
|
|
@ -206,7 +206,7 @@ builder.
|
|||
to be set.
|
||||
|
||||
- `windows_password_timeout` (string) - The timeout for waiting for a Windows
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: "10m"
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: `10m`
|
||||
|
||||
## Basic Example
|
||||
|
||||
|
|
@ -258,9 +258,9 @@ builder.
|
|||
environmental variables. See the configuration reference in the section above
|
||||
for more information on what environmental variables Packer will look for.
|
||||
|
||||
Further information on locating AMI IDs and their relationship to instance
|
||||
types and regions can be found in the AWS EC2 Documentation
|
||||
[for Linux](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
|
||||
Further information on locating AMI IDs and their relationship to instance
|
||||
types and regions can be found in the AWS EC2 Documentation
|
||||
[for Linux](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
|
||||
or [for Windows](http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/finding-an-ami.html).
|
||||
|
||||
## Accessing the Instance to Debug
|
||||
|
|
|
|||
|
|
@ -49,9 +49,9 @@ builder.
|
|||
templates](/docs/templates/configuration-templates.html) for more info)
|
||||
|
||||
- `instance_type` (string) - The EC2 instance type to use while building the
|
||||
AMI, such as "m1.small".
|
||||
AMI, such as `m1.small`.
|
||||
|
||||
- `region` (string) - The name of the region, such as "us-east-1", in which to
|
||||
- `region` (string) - The name of the region, such as `us-east-1`, in which to
|
||||
launch the EC2 instance to create the AMI.
|
||||
|
||||
- `secret_key` (string) - The secret key used to communicate with AWS. [Learn
|
||||
|
|
@ -73,7 +73,7 @@ builder.
|
|||
every build.
|
||||
|
||||
- `device_name` (string) - The device name exposed to the instance (for
|
||||
example, "/dev/sdh" or "xvdh"). Required when specifying `volume_size`.
|
||||
example, `/dev/sdh` or `xvdh`). Required when specifying `volume_size`.
|
||||
|
||||
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not
|
||||
|
||||
|
|
@ -95,8 +95,8 @@ builder.
|
|||
- `volume_size` (integer) - The size of the volume, in GiB. Required if not
|
||||
specifying a `snapshot_id`
|
||||
|
||||
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD)
|
||||
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic
|
||||
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD)
|
||||
volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic
|
||||
volumes
|
||||
|
||||
- `ami_description` (string) - The description to set for the
|
||||
|
|
@ -105,7 +105,7 @@ builder.
|
|||
- `ami_groups` (array of strings) - 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. AWS currently doesn't
|
||||
accept any value other than "all".
|
||||
accept any value other than `all`.
|
||||
|
||||
- `ami_product_codes` (array of strings) - A list of product codes to
|
||||
associate with the AMI. By default no product codes are associated with
|
||||
|
|
@ -121,7 +121,7 @@ builder.
|
|||
|
||||
- `ami_virtualization_type` (string) - The type of virtualization for the AMI
|
||||
you are building. This option must match the supported virtualization
|
||||
type of `source_ami`. Can be "paravirtual" or "hvm".
|
||||
type of `source_ami`. Can be `paravirtual` or `hvm`.
|
||||
|
||||
- `associate_public_ip_address` (boolean) - If using a non-default VPC, public
|
||||
IP addresses are not provided by default. If this is toggled, your new
|
||||
|
|
@ -194,7 +194,7 @@ builder.
|
|||
|
||||
- `shutdown_behaviour` (string) - Automatically terminate instances on shutdown
|
||||
incase packer exits ungracefully. Possible values are "stop" and "terminate",
|
||||
default is stop.
|
||||
default is `stop`.
|
||||
|
||||
- `skip_region_validation` (boolean) - Set to true if you want to skip
|
||||
validation of the region configuration option. Default `false`.
|
||||
|
|
@ -245,11 +245,11 @@ builder.
|
|||
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"
|
||||
`auto` for Packer to automatically discover the best spot price or to "0"
|
||||
to use an on demand instance (default).
|
||||
|
||||
- `spot_price_auto_product` (string) - Required if `spot_price` is set
|
||||
to "auto". This tells Packer what sort of AMI you're launching to find the
|
||||
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)`
|
||||
|
||||
|
|
@ -273,7 +273,7 @@ builder.
|
|||
IP if available.
|
||||
|
||||
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
||||
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
||||
`subnet-12345def`, where Packer will launch the EC2 instance. This field is
|
||||
required if you are using an non-default VPC.
|
||||
|
||||
- `tags` (object of key/value strings) - Tags applied to the AMI and
|
||||
|
|
@ -299,7 +299,11 @@ builder.
|
|||
to be set.
|
||||
|
||||
- `windows_password_timeout` (string) - The timeout for waiting for a Windows
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: "10m"
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: `10m`
|
||||
|
||||
- `shutdown_behaviour` (string) - Automatically terminate instances on shutdown
|
||||
incase packer exits ungracefully. Possible values are `stop` and `terminate`,
|
||||
|
||||
|
||||
## Basic Example
|
||||
|
||||
|
|
@ -388,4 +392,3 @@ up all residual volumes that are not designated by the user to remain after
|
|||
termination. If you need to preserve those source volumes, you can overwrite the
|
||||
termination setting by specifying `delete_on_termination=false` in the
|
||||
`launch_block_device_mappings` block for the device.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMI
|
|||
This builder builds an AMI by launching an EC2 instance from an existing
|
||||
instance-storage backed AMI, provisioning that running machine, and then
|
||||
bundling and creating a new AMI from that machine. This is all done in your own
|
||||
AWS account. The builder will create temporary keypairs, security group rules,
|
||||
AWS account. The builder will create temporary key pairs, security group rules,
|
||||
etc. that provide it temporary access to the instance while the image is being
|
||||
created. This simplifies configuration quite a bit.
|
||||
|
||||
|
|
@ -60,9 +60,9 @@ builder.
|
|||
templates](/docs/templates/configuration-templates.html) for more info)
|
||||
|
||||
- `instance_type` (string) - The EC2 instance type to use while building the
|
||||
AMI, such as "m1.small".
|
||||
AMI, such as `m1.small`.
|
||||
|
||||
- `region` (string) - The name of the region, such as "us-east-1", in which to
|
||||
- `region` (string) - The name of the region, such as `us-east-1`, in which to
|
||||
launch the EC2 instance to create the AMI.
|
||||
|
||||
- `s3_bucket` (string) - The name of the S3 bucket to upload the AMI. This
|
||||
|
|
@ -95,7 +95,7 @@ builder.
|
|||
every build.
|
||||
|
||||
- `device_name` (string) - The device name exposed to the instance (for
|
||||
example, "/dev/sdh" or "xvdh"). Required when specifying `volume_size`.
|
||||
example, `/dev/sdh` or `xvdh`). Required when specifying `volume_size`.
|
||||
|
||||
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not
|
||||
|
||||
|
|
@ -117,8 +117,8 @@ builder.
|
|||
- `volume_size` (integer) - The size of the volume, in GiB. Required if not
|
||||
specifying a `snapshot_id`
|
||||
|
||||
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD)
|
||||
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic
|
||||
- `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD)
|
||||
volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic
|
||||
volumes
|
||||
|
||||
- `ami_description` (string) - The description to set for the
|
||||
|
|
@ -127,7 +127,7 @@ builder.
|
|||
- `ami_groups` (array of strings) - 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. AWS currently doesn't
|
||||
accept any value other than "all".
|
||||
accept any value other than `all`.
|
||||
|
||||
- `ami_product_codes` (array of strings) - A list of product codes to
|
||||
associate with the AMI. By default no product codes are associated with
|
||||
|
|
@ -143,7 +143,7 @@ builder.
|
|||
|
||||
- `ami_virtualization_type` (string) - The type of virtualization for the AMI
|
||||
you are building. This option is required to register HVM images. Can be
|
||||
"paravirtual" (default) or "hvm".
|
||||
`paravirtual` (default) or `hvm`.
|
||||
|
||||
- `associate_public_ip_address` (boolean) - If using a non-default VPC, public
|
||||
IP addresses are not provided by default. If this is toggled, your new
|
||||
|
|
@ -153,11 +153,11 @@ builder.
|
|||
instance in. Leave this empty to allow Amazon to auto-assign.
|
||||
|
||||
- `bundle_destination` (string) - The directory on the running instance where
|
||||
the bundled AMI will be saved prior to uploading. By default this is "/tmp".
|
||||
the bundled AMI will be saved prior to uploading. By default this is `/tmp`.
|
||||
This directory must exist and be writable.
|
||||
|
||||
- `bundle_prefix` (string) - The prefix for files created from bundling the
|
||||
root volume. By default this is "image-{{timestamp}}". The `timestamp`
|
||||
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.
|
||||
|
||||
|
|
@ -177,10 +177,10 @@ builder.
|
|||
`ec2:ModifyInstanceAttribute` to your AWS IAM policy.
|
||||
|
||||
- `force_deregister` (boolean) - Force Packer to first deregister an existing
|
||||
AMI if one with the same name already exists. Default `false`.
|
||||
AMI if one with the same name already exists. Defaults to `false`.
|
||||
|
||||
- `force_delete_snapshot` (boolean) - Force Packer to delete snapshots associated with
|
||||
AMIs, which have been deregistered by `force_deregister`. Default `false`.
|
||||
AMIs, which have been deregistered by `force_deregister`. Defaults to `false`.
|
||||
|
||||
- `iam_instance_profile` (string) - The name of an [IAM instance
|
||||
profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html)
|
||||
|
|
@ -205,7 +205,7 @@ builder.
|
|||
`security_group_id`.
|
||||
|
||||
- `skip_region_validation` (boolean) - Set to true if you want to skip
|
||||
validation of the region configuration option. Default `false`.
|
||||
validation of the region configuration option. Defaults to `false`.
|
||||
|
||||
- `snapshot_groups` (array of strings) - A list of groups that have access to
|
||||
create volumes from the snapshot(s). By default no groups have permission to create
|
||||
|
|
@ -252,25 +252,25 @@ builder.
|
|||
to create the AMI. It is a type of instances that EC2 starts when the
|
||||
maximum price that you specify exceeds the current spot price. 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).
|
||||
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).
|
||||
|
||||
- `spot_price_auto_product` (string) - Required if `spot_price` is set
|
||||
to "auto". This tells Packer what sort of AMI you're launching to find the
|
||||
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)`
|
||||
|
||||
- `ssh_keypair_name` (string) - If specified, this is the key that will be
|
||||
used for SSH with the machine. The key must match a key pair name loaded
|
||||
up into Amazon EC2. By default, this is blank, and Packer will
|
||||
generate a temporary keypair unless
|
||||
generate a temporary key pair unless
|
||||
[`ssh_password`](/docs/templates/communicator.html#ssh_password) is used.
|
||||
[`ssh_private_key_file`](/docs/templates/communicator.html#ssh_private_key_file)
|
||||
or `ssh_agent_auth` must be specified when `ssh_keypair_name` is utilized.
|
||||
|
||||
- `ssh_agent_auth` (boolean) - If true, the local SSH agent will be used to
|
||||
authenticate connections to the source instance. No temporary keypair will
|
||||
authenticate connections to the source instance. No temporary key pair will
|
||||
be created, and the values of `ssh_password` and `ssh_private_key_file` will
|
||||
be ignored. To use this option with a key pair already configured in the source
|
||||
AMI, leave the `ssh_keypair_name` blank. To associate an existing key pair
|
||||
|
|
@ -281,13 +281,13 @@ builder.
|
|||
IP if available.
|
||||
|
||||
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as
|
||||
"subnet-12345def", where Packer will launch the EC2 instance. This field is
|
||||
`subnet-12345def`, where Packer will launch the EC2 instance. This field is
|
||||
required if you are using an non-default VPC.
|
||||
|
||||
- `tags` (object of key/value strings) - Tags applied to the AMI.
|
||||
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary keypair
|
||||
to generate. By default, Packer generates a name with a UUID.
|
||||
- `temporary_key_pair_name` (string) - The name of the temporary key pair
|
||||
to generate. By default, Packer generates a name with an UUID.
|
||||
|
||||
- `user_data` (string) - User data to apply when launching the instance. Note
|
||||
that you need to be careful about escaping characters due to the templates
|
||||
|
|
@ -306,7 +306,7 @@ builder.
|
|||
`/tmp`.
|
||||
|
||||
- `windows_password_timeout` (string) - The timeout for waiting for a Windows
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: "10m"
|
||||
password for Windows instances. Defaults to 20 minutes. Example value: `10m`
|
||||
|
||||
## Basic Example
|
||||
|
||||
|
|
@ -386,7 +386,7 @@ parameters they're used to satisfy the `ec2-bundle-vol` command.
|
|||
\~> **Warning!** Some versions of ec2-bundle-vol silently ignore all .pem and
|
||||
.gpg files during the bundling of the AMI, which can cause problems on some
|
||||
systems, such as Ubuntu. You may want to customize the bundle volume command to
|
||||
include those files (see the `--no-filter` option of ec2-bundle-vol).
|
||||
include those files (see the `--no-filter` option of `ec2-bundle-vol`).
|
||||
|
||||
### Bundle Upload Command
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ page_title: 'Amazon Import Post-Processor'
|
|||
|
||||
Type: `amazon-import`
|
||||
|
||||
The Packer Amazon Import post-processor takes an OVA artifact from various builder and imports it to an AMI available to Amazon Web Services EC2.
|
||||
The Packer Amazon Import post-processor takes an OVA artifact from various builders and imports it to an AMI available to Amazon Web Services EC2.
|
||||
|
||||
\~> This post-processor is for advanced users. It depends on specific IAM roles inside AWS and is best used with images that operate with the EC2 configuration model (eg, cloud-init for Linux systems). Please ensure you read the [prerequisites for import](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html) before using this post-processor.
|
||||
|
||||
|
|
@ -18,14 +18,14 @@ The Packer Amazon Import post-processor takes an OVA artifact from various build
|
|||
|
||||
The import process operates making a temporary copy of the OVA to an S3 bucket, and calling an import task in EC2 on the OVA file. Once completed, an AMI is returned containing the converted virtual machine. The temporary OVA copy in S3 can be discarded after the import is complete.
|
||||
|
||||
The import process itself run by AWS includes modifications to the image uploaded, to allow it to boot and operate in the AWS EC2 environment. However, not all modifications required to make the machine run well in EC2 are performed. Take care around console output from the machine, as debugging can be very difficult without it. You may also want to include tools suitable for instances in EC2 such as cloud-init for Linux.
|
||||
The import process itself run by AWS includes modifications to the image uploaded, to allow it to boot and operate in the AWS EC2 environment. However, not all modifications required to make the machine run well in EC2 are performed. Take care around console output from the machine, as debugging can be very difficult without it. You may also want to include tools suitable for instances in EC2 such as `cloud-init` for Linux.
|
||||
|
||||
Further information about the import process can be found in AWS's [EC2 Import/Export Instance documentation](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instances_of_your_vm.html).
|
||||
|
||||
## Configuration
|
||||
|
||||
There are some configuration options available for the post-processor. They are
|
||||
segmented below into three categories: required and optional parameters.
|
||||
segmented below into three categories: required and optional parameters.
|
||||
Within each category, the available configuration keys are alphabetized.
|
||||
|
||||
Required:
|
||||
|
|
@ -33,7 +33,7 @@ Required:
|
|||
- `access_key` (string) - The access key used to communicate with AWS. [Learn
|
||||
how to set this.](/docs/builders/amazon.html#specifying-amazon-credentials)
|
||||
|
||||
- `region` (string) - The name of the region, such as "us-east-1" in which to upload the OVA file to S3 and create the AMI. A list of valid regions can be obtained with AWS CLI tools or by consulting the AWS website.
|
||||
- `region` (string) - The name of the region, such as `us-east-1` in which to upload the OVA file to S3 and create the AMI. A list of valid regions can be obtained with AWS CLI tools or by consulting the AWS website.
|
||||
|
||||
- `s3_bucket_name` (string) - The name of the S3 bucket where the OVA file will be copied to for import. This bucket must exist when the post-processor is run.
|
||||
|
||||
|
|
@ -42,9 +42,9 @@ Required:
|
|||
|
||||
Optional:
|
||||
|
||||
- `s3_key_name` (string) - The name of the key in `s3_bucket_name` where the OVA file will be copied to for import. If not specified, this will default to "packer-import-{{timestamp}}.ova". This key (ie, the uploaded OVA) will be removed after import, unless `skip_clean` is true.
|
||||
- `s3_key_name` (string) - The name of the key in `s3_bucket_name` where the OVA file will be copied to for import. If not specified, this will default to "packer-import-{{timestamp}}.ova". This key (ie, the uploaded OVA) will be removed after import, unless `skip_clean` is `true`.
|
||||
|
||||
- `skip_clean` (boolean) - Whether we should skip removing the OVA file uploaded to S3 after the import process has completed. "true" means that we should leave it in the S3 bucket, "false" means to clean it out. Defaults to "false".
|
||||
- `skip_clean` (boolean) - Whether we should skip removing the OVA file uploaded to S3 after the import process has completed. "true" means that we should leave it in the S3 bucket, "false" means to clean it out. Defaults to `false`.
|
||||
|
||||
- `ami_name` (string) - The name of the ami within the console. If not specified, this will default to something like `ami-import-sfwerwf`. Please note, specifying this option will result in a slightly longer execution time.
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ Here is a basic example. This assumes that the builder has produced an OVA artif
|
|||
environmental variables. See the configuration reference in the section above
|
||||
for more information on what environmental variables Packer will look for.
|
||||
|
||||
This will take the OVA generated by a builder and upload it to S3. In this case, an existing bucket called "importbucket" in the "us-east-1" region will be where the copy is placed. The key name of the copy will be a default name generated by packer.
|
||||
This will take the OVA generated by a builder and upload it to S3. In this case, an existing bucket called `importbucket` in the `us-east-1` region will be where the copy is placed. The key name of the copy will be a default name generated by packer.
|
||||
|
||||
Once uploaded, the import process will start, creating an AMI in the "us-east-1" region with a "Description" tag applied to both the AMI and the snapshots associated with it. Note: the import process does not allow you to name the AMI, the name is automatically generated by AWS.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue