From ce411a0d17ae40960ce2954b0fc0fe8680699f45 Mon Sep 17 00:00:00 2001 From: Rickard von Essen Date: Tue, 10 Jan 2017 14:47:53 +0100 Subject: [PATCH] Added docs for SourceAMI and BuildRegion template --- .../docs/builders/amazon-chroot.html.md | 19 +++++++++++--- .../source/docs/builders/amazon-ebs.html.md | 25 +++++++++++++++---- .../docs/builders/amazon-ebsvolume.html.md | 10 ++++++-- .../docs/builders/amazon-instance.html.md | 15 ++++++++--- 4 files changed, 56 insertions(+), 13 deletions(-) diff --git a/website/source/docs/builders/amazon-chroot.html.md b/website/source/docs/builders/amazon-chroot.html.md index a58e3ccea..97f575b2e 100644 --- a/website/source/docs/builders/amazon-chroot.html.md +++ b/website/source/docs/builders/amazon-chroot.html.md @@ -75,7 +75,11 @@ each category, the available configuration keys are alphabetized. ### Optional: - `ami_description` (string) - The description to set for the - resulting AMI(s). By default this description is empty. + resulting AMI(s). By default this description is empty. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with name of the region where this + is built. - `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 @@ -210,7 +214,11 @@ each category, the available configuration keys are alphabetized. validation of the `ami_regions` configuration option. Default `false`. - `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot. - They will override AMI tags if already applied to snapshot. + They will override AMI tags if already applied to snapshot. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with name of the region where this + is built. - `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 @@ -250,7 +258,12 @@ each category, the available configuration keys are alphabetized. - `most_recent` (bool) - Selects the newest created image when true. This is most useful for selecting a daily distro build. -- `tags` (object of key/value strings) - Tags applied to the AMI. +- `tags` (object of key/value strings) - Tags applied to the AMI. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with name of the region where this + is built. + ## Basic Example diff --git a/website/source/docs/builders/amazon-ebs.html.md b/website/source/docs/builders/amazon-ebs.html.md index 51dc0ca67..a055f6878 100644 --- a/website/source/docs/builders/amazon-ebs.html.md +++ b/website/source/docs/builders/amazon-ebs.html.md @@ -105,7 +105,10 @@ builder. volumes - `ami_description` (string) - The description to set for the - resulting AMI(s). By default this description is empty. + resulting AMI(s). By default this description is empty. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `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 @@ -182,11 +185,17 @@ builder. - `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`. + resulting AMI unless they're duplicated in `tags`. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `run_volume_tags` (object of key/value strings) - Tags to apply to the volumes that are *launched* to create the AMI. These tags are *not* applied to the - resulting AMI unless they're duplicated in `tags`. + resulting AMI unless they're duplicated in `tags`. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `security_group_id` (string) - The ID (*not* the name) of the security group to assign to the instance. By default this is not set and Packer will @@ -214,7 +223,10 @@ builder. user creating the AMI has permissions to create volumes from the backing snapshot(s). - `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot. - They will override AMI tags if already applied to snapshot. + They will override AMI tags if already applied to snapshot. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `source_ami_filter` (object) - Filters used to populate the `source_ami` field. Example: @@ -283,7 +295,10 @@ builder. required if you are using an non-default VPC. - `tags` (object of key/value strings) - Tags applied to the AMI and - relevant snapshots. + relevant snapshots. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `temporary_key_pair_name` (string) - The name of the temporary keypair to generate. By default, Packer generates a name with a UUID. diff --git a/website/source/docs/builders/amazon-ebsvolume.html.md b/website/source/docs/builders/amazon-ebsvolume.html.md index 8cd97c09c..436d38e38 100644 --- a/website/source/docs/builders/amazon-ebsvolume.html.md +++ b/website/source/docs/builders/amazon-ebsvolume.html.md @@ -79,7 +79,10 @@ builder. 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. + builder completes. This is a [configuration template] + (/docs/templates/configuration-templates.html) where the `SourceAMI` + variable is replaced with the source AMI ID and `BuildRegion` variable + is replaced with the value of `region`. - `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 @@ -102,7 +105,10 @@ builder. - `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`. + resulting AMI unless they're duplicated in `tags`. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `security_group_id` (string) - The ID (*not* the name) of the security group to assign to the instance. By default this is not set and Packer will diff --git a/website/source/docs/builders/amazon-instance.html.md b/website/source/docs/builders/amazon-instance.html.md index 5ce36610e..28c2e36fc 100644 --- a/website/source/docs/builders/amazon-instance.html.md +++ b/website/source/docs/builders/amazon-instance.html.md @@ -127,7 +127,10 @@ builder. volumes - `ami_description` (string) - The description to set for the - resulting AMI(s). By default this description is empty. + resulting AMI(s). By default this description is empty. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `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 @@ -198,7 +201,10 @@ builder. - `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`. + resulting AMI unless they're duplicated in `tags`. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `security_group_id` (string) - The ID (*not* the name) of the security group to assign to the instance. By default this is not set and Packer will @@ -290,7 +296,10 @@ builder. `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. +- `tags` (object of key/value strings) - Tags applied to the AMI. This is a + [configuration template](/docs/templates/configuration-templates.html) + where the `SourceAMI` variable is replaced with the source AMI ID and + `BuildRegion` variable is replaced with the value of `region`. - `temporary_key_pair_name` (string) - The name of the temporary key pair to generate. By default, Packer generates a name with an UUID.