Skip to content

Commit 0453160

Browse files
Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-asg/releases/tag/v0.21.8) from the [email protected] source branch. (#970)
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent 6e11ec7 commit 0453160

File tree

3 files changed

+69
-41
lines changed

3 files changed

+69
-41
lines changed

docs/reference/modules/terraform-aws-asg/asg-instance-refresh/asg-instance-refresh.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.7" lastModifiedVersion="0.21.7"/>
12+
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.8" lastModifiedVersion="0.21.7"/>
1313

1414
# Auto Scaling Group Module with Instance Refresh
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-instance-refresh" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-instance-refresh" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-asg/releases/tag/v0.21.7" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -89,7 +89,7 @@ The Terraform [instance_refresh](https://registry.terraform.io/providers/hashico
8989
9090
module "asg_instance_refresh" {
9191
92-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-instance-refresh?ref=v0.21.7"
92+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-instance-refresh?ref=v0.21.8"
9393
9494
# ----------------------------------------------------------------------------------------------------
9595
# REQUIRED VARIABLES
@@ -220,7 +220,7 @@ module "asg_instance_refresh" {
220220
# ------------------------------------------------------------------------------------------------------
221221
222222
terraform {
223-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-instance-refresh?ref=v0.21.7"
223+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-instance-refresh?ref=v0.21.8"
224224
}
225225
226226
inputs = {
@@ -652,11 +652,11 @@ A maximum duration that Terraform should wait for the EC2 Instances to be health
652652
<!-- ##DOCS-SOURCER-START
653653
{
654654
"originalSources": [
655-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-instance-refresh/readme.md",
656-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-instance-refresh/variables.tf",
657-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-instance-refresh/outputs.tf"
655+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-instance-refresh/readme.md",
656+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-instance-refresh/variables.tf",
657+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-instance-refresh/outputs.tf"
658658
],
659659
"sourcePlugin": "module-catalog-api",
660-
"hash": "cb8c6fc214612cad2f1ba678c95a4e51"
660+
"hash": "0185985a4b4bfcc06458ff2f01a2955d"
661661
}
662662
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-asg/asg-rolling-deploy/asg-rolling-deploy.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.7" lastModifiedVersion="0.21.7"/>
12+
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.8" lastModifiedVersion="0.21.7"/>
1313

1414
# Auto Scaling Group with Rolling Deployment Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-asg/releases/tag/v0.21.7" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -56,7 +56,7 @@ update your launch templates (e.g. by specifying a new AMI to deploy), Terraform
5656
Note that if all we did was use `create_before_destroy`, on each redeploy, our ASG would reset to its hard-coded
5757
`desired_capacity`, losing the capacity changes from auto scaling policies. We solve this problem by using an
5858
[external data source](https://www.terraform.io/docs/providers/external/data_source.html) that runs the Python script
59-
[get-desired-capacity.py](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy/describe-autoscaling-group/get-desired-capacity.py) to fetch the latest value of the
59+
[get-desired-capacity.py](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy/describe-autoscaling-group/get-desired-capacity.py) to fetch the latest value of the
6060
`desired_capacity` parameter:
6161

6262
* If the script finds a value from an already-existing ASG, we use it, to ensure that the changes form auto scaling
@@ -77,7 +77,7 @@ Note that if all we did was use `create_before_destroy`, on each redeploy, our A
7777
7878
module "asg_rolling_deploy" {
7979
80-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-rolling-deploy?ref=v0.21.7"
80+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-rolling-deploy?ref=v0.21.8"
8181
8282
# ----------------------------------------------------------------------------------------------------
8383
# REQUIRED VARIABLES
@@ -188,7 +188,7 @@ module "asg_rolling_deploy" {
188188
# ------------------------------------------------------------------------------------------------------
189189
190190
terraform {
191-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-rolling-deploy?ref=v0.21.7"
191+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/asg-rolling-deploy?ref=v0.21.8"
192192
}
193193
194194
inputs = {
@@ -549,11 +549,11 @@ A maximum duration that Terraform should wait for the EC2 Instances to be health
549549
<!-- ##DOCS-SOURCER-START
550550
{
551551
"originalSources": [
552-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy/readme.md",
553-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy/variables.tf",
554-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy/outputs.tf"
552+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy/readme.md",
553+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy/variables.tf",
554+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy/outputs.tf"
555555
],
556556
"sourcePlugin": "module-catalog-api",
557-
"hash": "5d37a387fd50416ea53fd8ddfd1dfb33"
557+
"hash": "f1541568e906accbcf8ba133e88488c0"
558558
}
559559
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-asg/server-group/server-group.md

Lines changed: 52 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.7" lastModifiedVersion="0.21.7"/>
12+
<VersionBadge repoTitle="Auto Scaling Group Modules" version="0.21.8" lastModifiedVersion="0.21.8"/>
1313

1414
# Server Group Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/server-group" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/server-group" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-asg/releases/tag/v0.21.7" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-asg/releases/tag/v0.21.8" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module allows you to run a fixed-size cluster of servers that can:
2121

@@ -37,7 +37,7 @@ Scaling Group (ASG).
3737

3838
## Quick start
3939

40-
Check out the [server-group examples](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/examples/server-group) for sample code that demonstrates how to use this module.
40+
Check out the [server-group examples](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/examples/server-group) for sample code that demonstrates how to use this module.
4141

4242
## Background
4343

@@ -50,7 +50,7 @@ Check out the [server-group examples](https://github.com/gruntwork-io/terraform-
5050
The first question you may ask is, how is this different than an [Auto Scaling Group
5151
(ASG)](http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html)? While an ASG does allow you to
5252
run a cluster of servers, automaticaly replace failed servers, and do zero-downtime deployment (see the
53-
[asg-rolling-deploy module](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/asg-rolling-deploy)), attaching ENIs and EBS Volumes to servers in an ASG is very
53+
[asg-rolling-deploy module](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/asg-rolling-deploy)), attaching ENIs and EBS Volumes to servers in an ASG is very
5454
tricky:
5555

5656
1. Using ENIs and EBS Volumes with ASGs is not natively supported by Terraform. The
@@ -87,7 +87,7 @@ The solution used in this module is to:
8787

8888
The server-group module will perform a zero-downtime, rolling deployment every time you make a change to the code and
8989
run `terraform apply`. This deployment process is implemented in a Python script called
90-
[rolling_deployment.py](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/server-group/rolling-deploy/rolling_deployment.py) which runs in a [local-exec
90+
[rolling_deployment.py](https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/server-group/rolling-deploy/rolling_deployment.py) which runs in a [local-exec
9191
provisioner](https://www.terraform.io/docs/provisioners/local-exec.html).
9292

9393
Here is how it works:
@@ -147,7 +147,7 @@ module in your Terraform code:
147147
148148
module "server_group" {
149149
150-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/server-group?ref=v0.21.7"
150+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/server-group?ref=v0.21.8"
151151
152152
# ----------------------------------------------------------------------------------------------------
153153
# REQUIRED VARIABLES
@@ -336,17 +336,31 @@ module "server_group" {
336336
role_prefix = "server-group-"
337337
338338
# Whether the root volume of each server should be deleted when the server is
339-
# terminated.
339+
# terminated. Please note that when using EBS optimized AMIs, the root volume
340+
# name name is determined by the AMI, and if var.block_device_name does not
341+
# match the AMI's device name, AWS will create another volume instead of
342+
# applying this configuration to the root volume.
340343
root_block_device_delete_on_termination = true
341344
342-
# Whether the root volume of each server should be encrypted.
345+
# Whether the root volume of each server should be encrypted. Please note that
346+
# when using EBS optimized AMIs, the root volume name name is determined by
347+
# the AMI, and if var.block_device_name does not match the AMI's device name,
348+
# AWS will create another volume instead of applying this configuration to the
349+
# root volume.
343350
root_block_device_encrypted = true
344351
345-
# The size, in GB, of the root volume of each server.
352+
# The size, in GB, of the root volume of each server. Please note that when
353+
# using EBS optimized AMIs, the root volume name name is determined by the
354+
# AMI, and if var.block_device_name does not match the AMI's device name, AWS
355+
# will create another volume instead of applying this configuration to the
356+
# root volume.
346357
root_block_device_volume_size = 20
347358
348359
# The type of the root volume of each server. Must be one of: standard, gp2,
349-
# or io1.
360+
# gp3, io1, io2, sc1, or st1. Please note that when using EBS optimized AMIs,
361+
# the root volume name name is determined by the AMI, and if
362+
# var.block_device_name does not match the AMI's device name, AWS will create
363+
# another volume instead of applying this configuration to the root volume.
350364
root_block_device_volume_type = "standard"
351365
352366
# The ID of the Route53 Hosted Zone in which we will create the DNS records
@@ -429,7 +443,7 @@ module "server_group" {
429443
# ------------------------------------------------------------------------------------------------------
430444
431445
terraform {
432-
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/server-group?ref=v0.21.7"
446+
source = "git::[email protected]:gruntwork-io/terraform-aws-asg.git//modules/server-group?ref=v0.21.8"
433447
}
434448
435449
inputs = {
@@ -621,17 +635,31 @@ inputs = {
621635
role_prefix = "server-group-"
622636
623637
# Whether the root volume of each server should be deleted when the server is
624-
# terminated.
638+
# terminated. Please note that when using EBS optimized AMIs, the root volume
639+
# name name is determined by the AMI, and if var.block_device_name does not
640+
# match the AMI's device name, AWS will create another volume instead of
641+
# applying this configuration to the root volume.
625642
root_block_device_delete_on_termination = true
626643
627-
# Whether the root volume of each server should be encrypted.
644+
# Whether the root volume of each server should be encrypted. Please note that
645+
# when using EBS optimized AMIs, the root volume name name is determined by
646+
# the AMI, and if var.block_device_name does not match the AMI's device name,
647+
# AWS will create another volume instead of applying this configuration to the
648+
# root volume.
628649
root_block_device_encrypted = true
629650
630-
# The size, in GB, of the root volume of each server.
651+
# The size, in GB, of the root volume of each server. Please note that when
652+
# using EBS optimized AMIs, the root volume name name is determined by the
653+
# AMI, and if var.block_device_name does not match the AMI's device name, AWS
654+
# will create another volume instead of applying this configuration to the
655+
# root volume.
631656
root_block_device_volume_size = 20
632657
633658
# The type of the root volume of each server. Must be one of: standard, gp2,
634-
# or io1.
659+
# gp3, io1, io2, sc1, or st1. Please note that when using EBS optimized AMIs,
660+
# the root volume name name is determined by the AMI, and if
661+
# var.block_device_name does not match the AMI's device name, AWS will create
662+
# another volume instead of applying this configuration to the root volume.
635663
root_block_device_volume_type = "standard"
636664
637665
# The ID of the Route53 Hosted Zone in which we will create the DNS records
@@ -1123,7 +1151,7 @@ The name prefix that is used for the server group role.
11231151
<HclListItem name="root_block_device_delete_on_termination" requirement="optional" type="bool">
11241152
<HclListItemDescription>
11251153

1126-
Whether the root volume of each server should be deleted when the server is terminated.
1154+
Whether the root volume of each server should be deleted when the server is terminated. Please note that when using EBS optimized AMIs, the root volume name name is determined by the AMI, and if <a href="#block_device_name"><code>block_device_name</code></a> does not match the AMI's device name, AWS will create another volume instead of applying this configuration to the root volume.
11271155

11281156
</HclListItemDescription>
11291157
<HclListItemDefaultValue defaultValue="true"/>
@@ -1132,7 +1160,7 @@ Whether the root volume of each server should be deleted when the server is term
11321160
<HclListItem name="root_block_device_encrypted" requirement="optional" type="bool">
11331161
<HclListItemDescription>
11341162

1135-
Whether the root volume of each server should be encrypted.
1163+
Whether the root volume of each server should be encrypted. Please note that when using EBS optimized AMIs, the root volume name name is determined by the AMI, and if <a href="#block_device_name"><code>block_device_name</code></a> does not match the AMI's device name, AWS will create another volume instead of applying this configuration to the root volume.
11361164

11371165
</HclListItemDescription>
11381166
<HclListItemDefaultValue defaultValue="true"/>
@@ -1141,7 +1169,7 @@ Whether the root volume of each server should be encrypted.
11411169
<HclListItem name="root_block_device_volume_size" requirement="optional" type="number">
11421170
<HclListItemDescription>
11431171

1144-
The size, in GB, of the root volume of each server.
1172+
The size, in GB, of the root volume of each server. Please note that when using EBS optimized AMIs, the root volume name name is determined by the AMI, and if <a href="#block_device_name"><code>block_device_name</code></a> does not match the AMI's device name, AWS will create another volume instead of applying this configuration to the root volume.
11451173

11461174
</HclListItemDescription>
11471175
<HclListItemDefaultValue defaultValue="20"/>
@@ -1150,7 +1178,7 @@ The size, in GB, of the root volume of each server.
11501178
<HclListItem name="root_block_device_volume_type" requirement="optional" type="string">
11511179
<HclListItemDescription>
11521180

1153-
The type of the root volume of each server. Must be one of: standard, gp2, or io1.
1181+
The type of the root volume of each server. Must be one of: standard, gp2, gp3, io1, io2, sc1, or st1. Please note that when using EBS optimized AMIs, the root volume name name is determined by the AMI, and if <a href="#block_device_name"><code>block_device_name</code></a> does not match the AMI's device name, AWS will create another volume instead of applying this configuration to the root volume.
11541182

11551183
</HclListItemDescription>
11561184
<HclListItemDefaultValue defaultValue="&quot;standard&quot;"/>
@@ -1318,11 +1346,11 @@ Other modules can depend on this variable to ensure those modules only deploy af
13181346
<!-- ##DOCS-SOURCER-START
13191347
{
13201348
"originalSources": [
1321-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/server-group/readme.md",
1322-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/server-group/variables.tf",
1323-
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.7/modules/server-group/outputs.tf"
1349+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/server-group/readme.md",
1350+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/server-group/variables.tf",
1351+
"https://github.com/gruntwork-io/terraform-aws-asg/tree/v0.21.8/modules/server-group/outputs.tf"
13241352
],
13251353
"sourcePlugin": "module-catalog-api",
1326-
"hash": "ba73f5673d92b76e03e6044ed12a99aa"
1354+
"hash": "ed3e873f097ab76a2a389a95941ed854"
13271355
}
13281356
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)