From 4eecc7a58012fe96deea3ada48cd5035dbd95327 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Tue, 14 May 2019 12:29:28 +0200 Subject: [PATCH] document alias keys usage refactor kms_key_id doc into the same partial --- website/source/docs/builders/amazon-chroot.html.md.erb | 6 +----- website/source/docs/builders/amazon-ebs.html.md.erb | 6 +----- .../source/docs/builders/amazon-ebssurrogate.html.md.erb | 6 +----- .../partials/builders/_aws-common-opional-fields.html.md | 7 +++++++ 4 files changed, 10 insertions(+), 15 deletions(-) create mode 100644 website/source/partials/builders/_aws-common-opional-fields.html.md diff --git a/website/source/docs/builders/amazon-chroot.html.md.erb b/website/source/docs/builders/amazon-chroot.html.md.erb index 749fbcaeb..c1371c203 100644 --- a/website/source/docs/builders/amazon-chroot.html.md.erb +++ b/website/source/docs/builders/amazon-chroot.html.md.erb @@ -159,11 +159,7 @@ each category, the available configuration keys are alphabetized. - `insecure_skip_tls_verify` (boolean) - This allows skipping TLS verification of the AWS EC2 endpoint. The default is `false`. -- `kms_key_id` (string) - ID, alias or ARN of the KMS key to use for boot - volume encryption. This only applies to the main `region`, other regions - where the AMI will be copied will be encrypted by the default EBS KMS key. - For valid formats see *KmsKeyId* in the [AWS API docs - - CopyImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopyImage.html). +<%= partial "partials/builders/aws-common-opional-fields" %> - `from_scratch` (boolean) - Build a new volume instead of starting from an existing AMI root volume snapshot. Default `false`. If `true`, `source_ami` diff --git a/website/source/docs/builders/amazon-ebs.html.md.erb b/website/source/docs/builders/amazon-ebs.html.md.erb index 2c1494f06..9eb87f9cb 100644 --- a/website/source/docs/builders/amazon-ebs.html.md.erb +++ b/website/source/docs/builders/amazon-ebs.html.md.erb @@ -237,11 +237,7 @@ builder. - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. -- `kms_key_id` (string) - ID, alias or ARN of the KMS key to use for boot - volume encryption. This only applies to the main `region`, other regions - where the AMI will be copied will be encrypted by the default EBS KMS key. - For valid formats see *KmsKeyId* in the [AWS API docs - - CopyImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopyImage.html). +<%= partial "partials/builders/aws-common-opional-fields" %> - `iam_instance_profile` (string) - The name of an [IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) diff --git a/website/source/docs/builders/amazon-ebssurrogate.html.md.erb b/website/source/docs/builders/amazon-ebssurrogate.html.md.erb index 2d3ca3966..79843387e 100644 --- a/website/source/docs/builders/amazon-ebssurrogate.html.md.erb +++ b/website/source/docs/builders/amazon-ebssurrogate.html.md.erb @@ -230,11 +230,7 @@ builder. associated with AMIs, which have been deregistered by `force_deregister`. Default `false`. -- `kms_key_id` (string) - ID, alias or ARN of the KMS key to use for boot - volume encryption. This only applies to the main `region`, other regions - where the AMI will be copied will be encrypted by the default EBS KMS key. - For valid formats see *KmsKeyId* in the [AWS API docs - - CopyImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopyImage.html). +<%= partial "partials/builders/aws-common-opional-fields" %> - `iam_instance_profile` (string) - The name of an [IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) diff --git a/website/source/partials/builders/_aws-common-opional-fields.html.md b/website/source/partials/builders/_aws-common-opional-fields.html.md new file mode 100644 index 000000000..4dc5d12a5 --- /dev/null +++ b/website/source/partials/builders/_aws-common-opional-fields.html.md @@ -0,0 +1,7 @@ +- `kms_key_id` (string) - ID, alias or ARN of the KMS key to use for boot + volume encryption. This only applies to the main `region`, other regions + where the AMI will be copied will be encrypted by the default EBS KMS key. + For valid formats see *KmsKeyId* in the [AWS API docs - + CopyImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopyImage.html). + This field is validated by Packer, when using an alias, you will have to + prefix `kms_key_id` with `alias/`. \ No newline at end of file