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

updates quoting for `amazon-instance.html.md`

This commit is contained in:
Kerim Satirli 2016-12-07 09:29:45 +01:00
parent a31da3fb07
commit 73a50ff91f
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
website/source/docs/builders/amazon-instance.html.md
View File

@ -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 This builder builds an AMI by launching an EC2 instance from an existing
instance-storage backed AMI, provisioning that running machine, and then 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 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 etc. that provide it temporary access to the instance while the image is being
created. This simplifies configuration quite a bit. created. This simplifies configuration quite a bit.
@ -60,9 +60,9 @@ builder.
templates](/docs/templates/configuration-templates.html) for more info) templates](/docs/templates/configuration-templates.html) for more info)
- `instance_type` (string) - The EC2 instance type to use while building the - `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. launch the EC2 instance to create the AMI.
- `s3_bucket` (string) - The name of the S3 bucket to upload the AMI. This - `s3_bucket` (string) - The name of the S3 bucket to upload the AMI. This
@ -95,7 +95,7 @@ builder.
every build. every build.
- `device_name` (string) - The device name exposed to the instance (for - `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 - `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 - `volume_size` (integer) - The size of the volume, in GiB. Required if not
specifying a `snapshot_id` specifying a `snapshot_id`
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD) - `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD)
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic
volumes volumes
- `ami_description` (string) - The description to set for the - `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 - `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 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 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 - `ami_product_codes` (array of strings) - A list of product codes to
associate with the AMI. By default no product codes are associated with 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 - `ami_virtualization_type` (string) - The type of virtualization for the AMI
you are building. This option is required to register HVM images. Can be 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 - `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 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. instance in. Leave this empty to allow Amazon to auto-assign.
- `bundle_destination` (string) - The directory on the running instance where - `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. This directory must exist and be writable.
- `bundle_prefix` (string) - The prefix for files created from bundling the - `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 variable should be used to make sure this is unique, otherwise it can
collide with other created AMIs by Packer in your account. collide with other created AMIs by Packer in your account.
@ -177,10 +177,10 @@ builder.
`ec2:ModifyInstanceAttribute` to your AWS IAM policy. `ec2:ModifyInstanceAttribute` to your AWS IAM policy.
- `force_deregister` (boolean) - Force Packer to first deregister an existing - `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 - `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 - `iam_instance_profile` (string) - The name of an [IAM instance
profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html)
@ -205,7 +205,7 @@ builder.
`security_group_id`. `security_group_id`.
- `skip_region_validation` (boolean) - Set to true if you want to skip - `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 - `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 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 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 maximum price that you specify exceeds the current spot price. Spot price
will be updated based on available spot instance capacity and current spot 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" 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 for Packer to automatically discover the best spot price or to `0` to use
an on demand instance (default). an on-demand instance (default).
- `spot_price_auto_product` (string) - Required if `spot_price` is set - `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`, 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)`, `Windows (Amazon VPC)`
- `ssh_keypair_name` (string) - If specified, this is the key that will be - `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 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 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_password`](/docs/templates/communicator.html#ssh_password) is used.
[`ssh_private_key_file`](/docs/templates/communicator.html#ssh_private_key_file) [`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. 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 - `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 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 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 AMI, leave the `ssh_keypair_name` blank. To associate an existing key pair
@ -281,13 +281,13 @@ builder.
IP if available. IP if available.
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as - `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. required if you are using an non-default VPC.
- `tags` (object of key/value strings) - Tags applied to the AMI. - `tags` (object of key/value strings) - Tags applied to the AMI.
- `temporary_key_pair_name` (string) - The name of the temporary keypair - `temporary_key_pair_name` (string) - The name of the temporary key pair
to generate. By default, Packer generates a name with a UUID. to generate. By default, Packer generates a name with an UUID.
- `user_data` (string) - User data to apply when launching the instance. Note - `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 that you need to be careful about escaping characters due to the templates
@ -306,7 +306,7 @@ builder.
`/tmp`. `/tmp`.
- `windows_password_timeout` (string) - The timeout for waiting for a Windows - `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 ## 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 \~> **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 .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 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 ### Bundle Upload Command