From 06b049987babc4edc5e11ea6b6dd1aeb375b133b Mon Sep 17 00:00:00 2001 From: DanHam Date: Thu, 29 Aug 2019 16:44:36 +0100 Subject: [PATCH] Docs: Formatting, fixes, nits, and improvements to the ebsvolume builder doc * Fix or remove references to AMI creation copied in from other docs * Remove unsupported `snapshot_users` and `snapshot_groups` options --- .../builders/amazon-ebsvolume.html.md.erb | 64 ++++++++----------- 1 file changed, 28 insertions(+), 36 deletions(-) diff --git a/website/source/docs/builders/amazon-ebsvolume.html.md.erb b/website/source/docs/builders/amazon-ebsvolume.html.md.erb index c9e5d885c..e11321e4d 100644 --- a/website/source/docs/builders/amazon-ebsvolume.html.md.erb +++ b/website/source/docs/builders/amazon-ebsvolume.html.md.erb @@ -1,7 +1,7 @@ --- description: | - The amazon-ebsvolume Packer builder is like the EBS builder, but is intended to - create EBS volumes rather than a machine image. + The amazon-ebsvolume Packer builder is like the EBS builder, but is + intended to create EBS volumes rather than a machine image. layout: docs page_title: 'Amazon EBS Volume - Builders' sidebar_current: 'docs-builders-amazon-ebsvolume' @@ -14,9 +14,11 @@ Type: `amazon-ebsvolume` The `amazon-ebsvolume` Packer builder is able to create Amazon Elastic Block 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 builder creates EBS volumes by launching an EC2 instance from a source +AMI. One or more EBS volumes are attached to the running instance, allowing +them to be provisioned into from the running machine. Once provisioning is +complete the source machine is destroyed. The provisioned volumes are kept +intact. This is all done in your own AWS account. The builder will create temporary key pairs, security group rules, etc. that provide it temporary access to the @@ -44,11 +46,11 @@ builder. - `access_key` (string) - The access key used to communicate with AWS. [Learn 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`. +- `instance_type` (string) - The EC2 instance type to use while creating + the EBS volumes, such as `m1.small`. - `region` (string) - The name of the region, such as `us-east-1`, in which - to launch the EC2 instance to create the AMI. + to launch the EC2 instance to create the new EBS volumes. - `secret_key` (string) - The secret key used to communicate with AWS. [Learn how to set this.](/docs/builders/amazon.html#specifying-amazon-credentials) @@ -60,7 +62,7 @@ builder. ### Optional: - `ebs_volumes` (array of block device mappings) - Add the block device - mappings to the AMI. The block device mappings allow for keys: + mappings to the running instance. The block device mappings allow for keys: - `device_name` (string) - The device name exposed to the instance (for example, `/dev/sdh` or `xvdh`). Required for every device in the block @@ -82,24 +84,24 @@ builder. - `iops` (number) - 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 + for more information. - `no_device` (boolean) - Suppresses the specified device included in the - block device mapping of the AMI + block device mapping of the AMI. - - `snapshot_id` (string) - The ID of the snapshot + - `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 + for more information. - `volume_size` (number) - The size of the volume, in GiB. Required if - not specifying a `snapshot_id` + 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 + for Magnetic volumes. - `tags` (map) - Tags to apply to the volume. These are retained after the builder completes. This is a [template @@ -108,7 +110,7 @@ builder. - `associate_public_ip_address` (boolean) - If using a non-default VPC, public IP addresses are not provided by default. If this is `true`, your - new instance will get a Public IP. default: `false` + new instance will get a Public IP. Default: `false`. - `availability_zone` (string) - Destination availability zone to launch instance in. Leave this empty to allow Amazon to auto-assign. @@ -158,11 +160,9 @@ builder. - `ena_support` (boolean) - Enable enhanced networking (ENA but not SriovNetSupport) on HVM-compatible AMIs. If set, add - `ec2:ModifyInstanceAttribute` to your AWS IAM policy. If false, this will - disable enhanced networking in the final AMI as opposed to passing the - setting through unchanged from the source. Note: you must make sure - enhanced networking is enabled on your instance. See [Amazon's - documentation on enabling enhanced + `ec2:ModifyInstanceAttribute` to your AWS IAM policy. Note: you must + make sure enhanced networking is enabled on your instance. See + [Amazon's documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). - `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source @@ -206,8 +206,7 @@ builder. for more details. - `run_tags` (object of key/value strings) - Tags to apply to the instance - that is *launched* to create the AMI. These tags are *not* applied to the - resulting AMI unless they're duplicated in `tags`. This is a [template + that is *launched* to create the EBS volumes. This is a [template engine](/docs/templates/engine.html), see [Build template data](#build-template-data) for more information. @@ -250,16 +249,6 @@ builder. - `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 volumes from the snapshot(s). `all` will make the snapshot - publicly accessible. - -- `snapshot_users` (array of strings) - A list of account IDs that have - access to create volumes from the snapshot(s). By default no additional - users other than the user creating the AMI has permissions to create - volumes from the backing snapshot(s). - - `source_ami_filter` (object) - Filters used to populate the `source_ami` field. Example: @@ -376,9 +365,12 @@ builder. `packer_`, where <UUID> is a 36 character unique identifier. - `temporary_security_group_source_cidrs` (list of string) - A list of IPv4 - CIDR blocks to be authorized access to the instance, when packer is creating a temporary security group. + CIDR blocks to be authorized access to the instance, when packer is + creating a temporary security group. - The default is [`0.0.0.0/0`] (i.e., allow any IPv4 source). This is only used when `security_group_id` or `security_group_ids` is not specified. + The default is [`0.0.0.0/0`] (i.e., allow any IPv4 source). This is + only used when `security_group_id` or `security_group_ids` is not + specified. - `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 @@ -551,4 +543,4 @@ volumes created by this builder, any volumes inn the source AMI which are not marked for deletion on termination will remain in your account. -<%= partial "partials/builders/aws-ssh-differentiation-table" %> \ No newline at end of file +<%= partial "partials/builders/aws-ssh-differentiation-table" %>