Merge pull request #4061 from artburkart/closes_2549

Adds add'l docs regarding delete_on_termination
10 years ago · c281ba7709
parent 541a209f93 cd6b70a2b3
commit c281ba7709
3 changed files with 71 additions and 13 deletions
--- a/website/source/docs/builders/amazon-chroot.html.md
+++ b/website/source/docs/builders/amazon-chroot.html.md
@ -122,18 +122,50 @@ each category, the available configuration keys are alphabetized.
    `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. Default `false`.

 -   `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:
    `ami_virtualization_type`, `pre_mount_commands` and `root_volume_size`. The
    below options are also required in this mode only:

-    -   `ami_block_device_mappings` (array of block device mappings) An entry
-        matching `root_device_name` should be set. See the
-        [amazon-ebs](/docs/builders/amazon-ebs.html) documentation for more
-        details on this parameter.
+-   `ami_block_device_mappings` (array of block device mappings) - Add the block
+    device mappings to the AMI. A `device_name` entry matching `root_device_name`
+    should be set. The block device mappings allow for keys:
+
+    -   `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

    -   `root_device_name` (string) - The root device name. For example, `xvda`.

@ -170,7 +202,7 @@ each category, the available configuration keys are alphabetized.
    this field must be defined.

 -   `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.
    Example:
--- a/website/source/docs/builders/amazon-ebs.html.md
+++ b/website/source/docs/builders/amazon-ebs.html.md
@ -66,27 +66,39 @@ builder.
 -   `ami_block_device_mappings` (array of block device mappings) - Add the block
    device mappings to the AMI. The block device mappings allow for keys:

+    -   `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`.
-    -   `delete_on_termination` (boolean) - Indicates whether the EBS volume is
-        deleted on instance termination
+
    -   `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
+
 -   `ami_description` (string) - The description to set for the
    resulting AMI(s). By default this description is empty.

@ -174,7 +186,7 @@ builder.
    `security_group_id`.

 -   `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.
    Example:
@ -359,3 +371,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 setting by specifying `delete_on_termination=false` in the
 `launch_block_device_mappings` block for the device.
+
--- a/website/source/docs/builders/amazon-instance.html.md
+++ b/website/source/docs/builders/amazon-instance.html.md
@ -87,27 +87,40 @@ builder.

 -   `ami_block_device_mappings` (array of block device mappings) - Add the block
    device mappings to the AMI. The block device mappings allow for keys:
+
    -   `delete_on_termination` (boolean) - Indicates whether the EBS volume is
-        deleted on instance termination
+        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`.
+         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
+
 -   `ami_description` (string) - The description to set for the
    resulting AMI(s). By default this description is empty.

@ -189,7 +202,7 @@ builder.
    `security_group_id`.

 -   `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.
    Example: