From 45360bb3aec792d826a21a132eaffbd8c7c3ab3a Mon Sep 17 00:00:00 2001 From: "docs-sourcer[bot]" <99042413+docs-sourcer[bot]@users.noreply.github.com> Date: Thu, 14 Aug 2025 01:37:21 +0000 Subject: [PATCH] Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-server/releases/tag/v1.0.2) from the `terraform-aws-server@v1.0.2` source branch. --- .../attach-eni/attach-eni.md | 16 ++++----- .../disable-instance-metadata.md | 16 ++++----- .../ec2-backup/ec2-backup.md | 16 ++++----- .../persistent-ebs-volume.md | 16 ++++----- ...quire-instance-metadata-service-version.md | 16 ++++----- .../route53-helpers/route53-helpers.md | 16 ++++----- .../single-server/single-server.md | 35 ++++++++++++++----- 7 files changed, 74 insertions(+), 57 deletions(-) diff --git a/docs/reference/modules/terraform-aws-server/attach-eni/attach-eni.md b/docs/reference/modules/terraform-aws-server/attach-eni/attach-eni.md index 420f17e09..833203964 100644 --- a/docs/reference/modules/terraform-aws-server/attach-eni/attach-eni.md +++ b/docs/reference/modules/terraform-aws-server/attach-eni/attach-eni.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Attach ENI Scripts -View Source +View Source Release Notes @@ -30,7 +30,7 @@ This folder contains scripts you can use to attach [Elastic Network Interfaces An ENI allows you to have IP addresses that remain static, even if the underlying EC2 Instances are changing. -Check out the [attach-eni example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/attach-eni) for how to use these scripts with Terraform. +Check out the [attach-eni example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/attach-eni) for how to use these scripts with Terraform. ## Installing the attach-eni script @@ -47,7 +47,7 @@ The `attach-eni` script has the following prerequisites: 1. It must be run as root 2. It must be run on an EC2 instance 3. The EC2 instance must have an IAM role with permissions to search ENIs and EC2 tags, as well as attach ENIs (see the - [attach-eni example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/attach-eni)) + [attach-eni example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/attach-eni)) 4. The EC2 instance must have the AWS CLI and jq installed Typically, you'll want to run the `attach-eni` script in the User Data of your EC2 instances so it attaches the ENI at @@ -70,11 +70,11 @@ This tells the script to try find and attach an ENI with the same `Name` tag as diff --git a/docs/reference/modules/terraform-aws-server/disable-instance-metadata/disable-instance-metadata.md b/docs/reference/modules/terraform-aws-server/disable-instance-metadata/disable-instance-metadata.md index 38831ee43..47d04cbab 100644 --- a/docs/reference/modules/terraform-aws-server/disable-instance-metadata/disable-instance-metadata.md +++ b/docs/reference/modules/terraform-aws-server/disable-instance-metadata/disable-instance-metadata.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Disable Instance Metadata Access script -View Source +View Source Release Notes @@ -26,7 +26,7 @@ Once that is done, you can call this script to further secure your instance by d `disable-instance-metadata`: This script can be run on an EC2 instance to disable further access to the Instance Metadata service from that instance. It uses the AWS API to disable access to the endpoint. -Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers) for how to use these scripts with Packer and Terraform. +Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers) for how to use these scripts with Packer and Terraform. ## Installing the scripts @@ -42,7 +42,7 @@ The `disable-instance-metadata` script has the following prerequisites: 1. It must be run on an EC2 instance 2. The EC2 instance must have an IAM role with permissions to modify the Instance Metadata service's options. See the - [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers)) for a reference implementation. + [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers)) for a reference implementation. 3. The EC2 instance must have the AWS CLI (version 2.2.37 or higher), unzip and jq installed. Run the `disable-instance-metadata` script in the User Data of your EC2 instances, after any required calls to the Instance Metadata service have been made. This way, your instances will still be able to access the Instance Metadata service when needed, but will also disable further access to the service upon boot. @@ -74,11 +74,11 @@ This will result in subsequent calls to the Instance Metadata service to fail. diff --git a/docs/reference/modules/terraform-aws-server/ec2-backup/ec2-backup.md b/docs/reference/modules/terraform-aws-server/ec2-backup/ec2-backup.md index e7b8e864b..90fbaf160 100644 --- a/docs/reference/modules/terraform-aws-server/ec2-backup/ec2-backup.md +++ b/docs/reference/modules/terraform-aws-server/ec2-backup/ec2-backup.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # EC2 Backup Module -View Source +View Source Release Notes @@ -32,7 +32,7 @@ This module makes it easy to deploy a [data lifecycle manager policy](https://do module "ec_2_backup" { - source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/ec2-backup?ref=v1.0.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/ec2-backup?ref=v1.0.2" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -98,7 +98,7 @@ module "ec_2_backup" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/ec2-backup?ref=v1.0.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/ec2-backup?ref=v1.0.2" } inputs = { @@ -304,11 +304,11 @@ The name of the IAM role associated with the data lifecycle manager diff --git a/docs/reference/modules/terraform-aws-server/persistent-ebs-volume/persistent-ebs-volume.md b/docs/reference/modules/terraform-aws-server/persistent-ebs-volume/persistent-ebs-volume.md index 3ab33daf4..9c4aca8b9 100644 --- a/docs/reference/modules/terraform-aws-server/persistent-ebs-volume/persistent-ebs-volume.md +++ b/docs/reference/modules/terraform-aws-server/persistent-ebs-volume/persistent-ebs-volume.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Persistent EBS Volume Scripts -View Source +View Source Release Notes @@ -40,7 +40,7 @@ volume can only be associated with a single EC2 Instance, so if you need the dat multiple servers, check out the [Amazon Elastic File System](https://aws.amazon.com/efs/), which provides a service built on top of NFS. -Check out the [persistent-ebs-volume example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/persistent-ebs-volume) for how to use these scripts with +Check out the [persistent-ebs-volume example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/persistent-ebs-volume) for how to use these scripts with Terraform. ## Installing the scripts @@ -58,7 +58,7 @@ The scripts have the following prerequisites: 1. They must be run as root 2. They must be run on an EC2 instance 3. The EC2 instance must have an IAM role with permissions to list, attach, and detach volumes (see the - [persistent-ebs-volume example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/persistent-ebs-volume)) + [persistent-ebs-volume example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/persistent-ebs-volume)) 4. The EC2 instance must have the AWS CLI and jq installed Run the `mount-ebs-volume` script in the User Data of your EC2 instances so it mounts the volume at boot. Run the @@ -219,11 +219,11 @@ detaching the device. diff --git a/docs/reference/modules/terraform-aws-server/require-instance-metadata-service-version/require-instance-metadata-service-version.md b/docs/reference/modules/terraform-aws-server/require-instance-metadata-service-version/require-instance-metadata-service-version.md index e74a1460e..45e10ce50 100644 --- a/docs/reference/modules/terraform-aws-server/require-instance-metadata-service-version/require-instance-metadata-service-version.md +++ b/docs/reference/modules/terraform-aws-server/require-instance-metadata-service-version/require-instance-metadata-service-version.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Require Instance Metadata Service version script -View Source +View Source Release Notes @@ -24,7 +24,7 @@ This folder contains a script (`require-instance-metadata-service-version`) you Learn more at [the official AWS EC2 Instance Metadata Service documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). -Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers) for how to use these scripts with Packer and Terraform. +Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers) for how to use these scripts with Packer and Terraform. ## Installing bash-commons @@ -49,7 +49,7 @@ The `require-instance-metadata-service-version` script has the following prerequ 1. It must be run on an EC2 instance 2. It requires that `bash-commons` version `v0.1.8` or newer is installed on the EC2 Instance. See instructions above. 3. The EC2 instance must have an IAM role with permissions to modify the Instance Metadata service's options. See the - [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers)) for a reference implementation. + [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers)) for a reference implementation. 4. The EC2 instance must have the AWS CLI (version 2.2.37 or higher), unzip and jq installed. Run the `require-instance-metadata-service-version` script in the User Data of your EC2 instances, prior to any calls to the Instance Metadata Service to configure if you want `2.0` credentials to be `required` or `optional`. @@ -97,11 +97,11 @@ Setting Instance Metadata Service version 2 state to optional diff --git a/docs/reference/modules/terraform-aws-server/route53-helpers/route53-helpers.md b/docs/reference/modules/terraform-aws-server/route53-helpers/route53-helpers.md index 4bdc76860..0217b2247 100644 --- a/docs/reference/modules/terraform-aws-server/route53-helpers/route53-helpers.md +++ b/docs/reference/modules/terraform-aws-server/route53-helpers/route53-helpers.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Route 53 Helpers -View Source +View Source Release Notes @@ -23,7 +23,7 @@ The helpers are: * `add-dns-a-record`: A script that can be run on an EC2 instance to add a DNS A record pointing to the instance's IP address. -Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers) for how to use these scripts with Terraform. +Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers) for how to use these scripts with Terraform. ## Installing the helpers @@ -69,16 +69,16 @@ Here is an example of an IAM policy your EC2 instance needs attached to its IAM } ``` -Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.1/examples/route53-helpers) to see what this looks like in action. +Check out the [route53-helpers example](https://github.com/gruntwork-io/terraform-aws-server/tree/v1.0.2/examples/route53-helpers) to see what this looks like in action. diff --git a/docs/reference/modules/terraform-aws-server/single-server/single-server.md b/docs/reference/modules/terraform-aws-server/single-server/single-server.md index 7ea3736b6..ce10c88d5 100644 --- a/docs/reference/modules/terraform-aws-server/single-server/single-server.md +++ b/docs/reference/modules/terraform-aws-server/single-server/single-server.md @@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Single Server Module -View Source +View Source -Release Notes +Release Notes This module makes it easy to deploy a single server--that is, a single EC2 instance (e.g. a bastion host, Jenkins server) rather than an Auto Scaling Group or ECS Cluster--along with the all the resources it typically needs: @@ -105,7 +105,7 @@ resource "aws_iam_policy_attachment" "attachment" { module "single_server" { - source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/single-server?ref=v1.0.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/single-server?ref=v1.0.2" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -324,6 +324,10 @@ module "single_server" { # The IOPS to allocate for the root volume. root_volume_iops = null + # Optional Amazon Resource Name (ARN) of the KMS Key to use when encrypting + # the volume + root_volume_kms_key_id = null + # The size of the root volume, in gigabytes. root_volume_size = 8 @@ -390,7 +394,7 @@ module "single_server" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/single-server?ref=v1.0.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-server.git//modules/single-server?ref=v1.0.2" } inputs = { @@ -612,6 +616,10 @@ inputs = { # The IOPS to allocate for the root volume. root_volume_iops = null + # Optional Amazon Resource Name (ARN) of the KMS Key to use when encrypting + # the volume + root_volume_kms_key_id = null + # The size of the root volume, in gigabytes. root_volume_size = 8 @@ -1142,6 +1150,15 @@ The IOPS to allocate for the root volume. + + + +Optional Amazon Resource Name (ARN) of the KMS Key to use when encrypting the volume + + + + + @@ -1301,11 +1318,11 @@ When used in combination with user_data or user_data_base64, a user_data change