Adds add'l docs regarding delete_on_termination
This PR adds documentation pointing out that volumes are not by default deleted on termination of any AWS EC2 instance during a packer build.
This commit is contained in:
parent
541a209f93
commit
5499c37080
|
@ -13,5 +13,5 @@ format:
|
||||||
bundle exec htmlbeautifier -t 2 source/*.erb
|
bundle exec htmlbeautifier -t 2 source/*.erb
|
||||||
bundle exec htmlbeautifier -t 2 source/layouts/*.erb
|
bundle exec htmlbeautifier -t 2 source/layouts/*.erb
|
||||||
@pandoc -v > /dev/null || echo "pandoc must be installed in order to format markdown content"
|
@pandoc -v > /dev/null || echo "pandoc must be installed in order to format markdown content"
|
||||||
pandoc -v > /dev/null && find . -iname "*.html.md" | xargs -I{} bash -c "pandoc -r markdown -w markdown --tab-stop=4 --atx-headers -s --columns=80 {} > {}.new"\; || true
|
pandoc -v > /dev/null && find . -iname "*.html.md*" | xargs -I{} bash -c "pandoc -r markdown -w markdown --tab-stop=4 --atx-headers -s --columns=80 {} > {}.new"\; || true
|
||||||
pandoc -v > /dev/null && find . -iname "*.html.md" | xargs -I{} bash -c "mv {}.new {}"\; || true
|
pandoc -v > /dev/null && find . -iname "*.html.md*" | xargs -I{} bash -c "mv {}.new {}"\; || true
|
||||||
|
|
|
@ -122,18 +122,19 @@ each category, the available configuration keys are alphabetized.
|
||||||
`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. Default `false`.
|
||||||
|
|
||||||
- `from_scratch` (boolean) - Build a new volume instead of starting from an
|
- `from_scratch` (boolean) - Build a new volume instead of starting from an
|
||||||
existing AMI root volume snapshot. Default false. If true, `source_ami` is
|
existing AMI root volume snapshot. Default `false`. If true, `source_ami` is
|
||||||
no longer used and the following options become required:
|
no longer used and the following options become required:
|
||||||
`ami_virtualization_type`, `pre_mount_commands` and `root_volume_size`. The
|
`ami_virtualization_type`, `pre_mount_commands` and `root_volume_size`. The
|
||||||
below options are also required in this mode only:
|
below options are also required in this mode only:
|
||||||
|
|
||||||
- `ami_block_device_mappings` (array of block device mappings) An entry
|
- `ami_block_device_mappings` (array of block device mappings) - Add the block
|
||||||
matching `root_device_name` should be set. See the
|
device mappings to the AMI. A `device_name` entry matching `root_device_name`
|
||||||
[amazon-ebs](/docs/builders/amazon-ebs.html) documentation for more
|
should be set. The block device mappings allow for keys:
|
||||||
details on this parameter.
|
|
||||||
|
<%= partial "partials/builders/ami-block-device-mappings" %>
|
||||||
|
|
||||||
- `root_device_name` (string) - The root device name. For example, `xvda`.
|
- `root_device_name` (string) - The root device name. For example, `xvda`.
|
||||||
|
|
||||||
|
@ -170,7 +171,7 @@ each category, the available configuration keys are alphabetized.
|
||||||
this field must be defined.
|
this field must be defined.
|
||||||
|
|
||||||
- `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 `ami_regions` configuration option. Defaults to false.
|
validation of the `ami_regions` configuration option. Default `false`.
|
||||||
|
|
||||||
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
||||||
Example:
|
Example:
|
|
@ -174,7 +174,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. Defaults to false.
|
validation of the region configuration option. Default `false`.
|
||||||
|
|
||||||
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
||||||
Example:
|
Example:
|
||||||
|
@ -359,3 +359,4 @@ 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. If you need to preserve those source volumes, you can overwrite the
|
||||||
termination setting by specifying `delete_on_termination=false` in the
|
termination setting by specifying `delete_on_termination=false` in the
|
||||||
`launch_block_device_mappings` block for the device.
|
`launch_block_device_mappings` block for the device.
|
||||||
|
|
|
@ -189,7 +189,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. Defaults to false.
|
validation of the region configuration option. Default `false`.
|
||||||
|
|
||||||
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
- `source_ami_filter` (object) - Filters used to populate the `source_ami` field.
|
||||||
Example:
|
Example:
|
|
@ -0,0 +1,33 @@
|
||||||
|
- `delete_on_termination` (boolean) - 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.
|
||||||
|
|
||||||
|
- `device_name` (string) - The device name exposed to the instance (for
|
||||||
|
example, "/dev/sdh" or "xvdh"). Required when specifying `volume_size`.
|
||||||
|
|
||||||
|
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not
|
||||||
|
|
||||||
|
- `iops` (integer) - The number of I/O operations per second (IOPS) that the
|
||||||
|
volume supports. See the documentation on
|
||||||
|
[IOPs](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html)
|
||||||
|
for more information
|
||||||
|
|
||||||
|
- `no_device` (boolean) - Suppresses the specified device included in the
|
||||||
|
block device mapping of the AMI
|
||||||
|
|
||||||
|
- `snapshot_id` (string) - The ID of the snapshot
|
||||||
|
|
||||||
|
- `virtual_name` (string) - The virtual device name. See the documentation on
|
||||||
|
[Block Device
|
||||||
|
Mapping](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html)
|
||||||
|
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
|
||||||
|
volumes
|
||||||
|
|
Loading…
Reference in New Issue