Skip to content

Commit 25ea91c

Browse files
MoonMoon1919MoonMoon1919
authored
Run docs-sourcer to pick up v0.29.0 of data storage module (#959)
1 parent 8a0e67e commit 25ea91c

File tree

12 files changed

+133
-133
lines changed

12 files changed

+133
-133
lines changed

‎docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md‎

Lines changed: 17 additions & 11 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="Data Storage Modules" version="0.28.1" lastModifiedVersion="0.28.1"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.29.0" lastModifiedVersion="0.29.0"/>
1313

1414
# Aurora Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/aurora" 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-data-storage/tree/v0.29.0/modules/aurora" 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-data-storage/releases/tag/v0.28.1" 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-data-storage/releases/tag/v0.29.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module creates an Amazon Aurora, a MySQL and PostgreSQL compatible relational database built for the cloud.
2121

@@ -59,7 +59,7 @@ Cluster](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.h
5959
## How do you configure this module?
6060

6161
This module allows you to configure a number of parameters, such as backup windows, maintenance window, port number,
62-
and encryption. For a list of all available variables and their descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/aurora/variables.tf).
62+
and encryption. For a list of all available variables and their descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/aurora/variables.tf).
6363

6464
## How do you create a cross-region read replica cluster?
6565

@@ -77,7 +77,7 @@ module "replica" {
7777
}
7878
```
7979

80-
See the example [here](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/examples/aurora-with-cross-region-replica) for more details.
80+
See the example [here](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/examples/aurora-with-cross-region-replica) for more details.
8181

8282
## How do you destroy a cross-region read replica?
8383

@@ -137,7 +137,7 @@ see [Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/lat
137137
138138
module "aurora" {
139139
140-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.28.1"
140+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.29.0"
141141
142142
# ----------------------------------------------------------------------------------------------------
143143
# REQUIRED VARIABLES
@@ -477,7 +477,7 @@ module "aurora" {
477477
# ------------------------------------------------------------------------------------------------------
478478
479479
terraform {
480-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.28.1"
480+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.29.0"
481481
}
482482
483483
inputs = {
@@ -1462,24 +1462,30 @@ Timeout for DB updating
14621462
<HclListItem name="port">
14631463
</HclListItem>
14641464

1465+
<HclListItem name="read_replica_instance_ids">
1466+
</HclListItem>
1467+
14651468
<HclListItem name="reader_endpoint">
14661469
</HclListItem>
14671470

14681471
<HclListItem name="security_group_id">
14691472
</HclListItem>
14701473

1474+
<HclListItem name="write_replica_instance_ids">
1475+
</HclListItem>
1476+
14711477
</TabItem>
14721478
</Tabs>
14731479

14741480

14751481
<!-- ##DOCS-SOURCER-START
14761482
{
14771483
"originalSources": [
1478-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/aurora/readme.md",
1479-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/aurora/variables.tf",
1480-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/aurora/outputs.tf"
1484+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/aurora/readme.md",
1485+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/aurora/variables.tf",
1486+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/aurora/outputs.tf"
14811487
],
14821488
"sourcePlugin": "module-catalog-api",
1483-
"hash": "5c313a5f98ce50cc6d52a4d2d8b47702"
1489+
"hash": "5d7eaa245a1a341346faa741126ed41d"
14841490
}
14851491
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md‎

Lines changed: 10 additions & 10 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="Data Storage Modules" version="0.28.1" lastModifiedVersion="0.27.2"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.29.0" lastModifiedVersion="0.27.2"/>
1313

1414
# Backup Plan Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-plan" 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-data-storage/tree/v0.29.0/modules/backup-plan" 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-data-storage/releases/tag/v0.27.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -22,7 +22,7 @@ This Terraform Module creates the following AWS Backup resources:
2222
1. Backup plans - specifying **how and when** to back things up
2323
2. Resource selections - specifying **which resources** to back up
2424

25-
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-vault).
25+
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-vault).
2626

2727
## What is a Backup Plan?
2828

@@ -91,7 +91,7 @@ module "backup_plan" {
9191

9292
## How do you troubleshoot Backup jobs?
9393

94-
See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/core-concepts.md#troubleshooting-aws-backup) in the core-concepts guide.
94+
See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/core-concepts.md#troubleshooting-aws-backup) in the core-concepts guide.
9595

9696
## Sample Usage
9797

@@ -106,7 +106,7 @@ See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-d
106106
107107
module "backup_plan" {
108108
109-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.28.1"
109+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.29.0"
110110
111111
# ----------------------------------------------------------------------------------------------------
112112
# REQUIRED VARIABLES
@@ -137,7 +137,7 @@ module "backup_plan" {
137137
# ------------------------------------------------------------------------------------------------------
138138
139139
terraform {
140-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.28.1"
140+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.29.0"
141141
}
142142
143143
inputs = {
@@ -245,11 +245,11 @@ The ARN of the IAM service role used by Backup plans
245245
<!-- ##DOCS-SOURCER-START
246246
{
247247
"originalSources": [
248-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-plan/readme.md",
249-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-plan/variables.tf",
250-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-plan/outputs.tf"
248+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-plan/readme.md",
249+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-plan/variables.tf",
250+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-plan/outputs.tf"
251251
],
252252
"sourcePlugin": "module-catalog-api",
253-
"hash": "955d0917db0cf04cd619bb9222b477a0"
253+
"hash": "cbafcc8a66cdbf7f4f882bbedfd1726a"
254254
}
255255
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.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="Data Storage Modules" version="0.28.1" lastModifiedVersion="0.27.2"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.29.0" lastModifiedVersion="0.27.2"/>
1313

1414
# Backup Vault Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-vault" 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-data-storage/tree/v0.29.0/modules/backup-vault" 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-data-storage/releases/tag/v0.27.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -96,7 +96,7 @@ then you will end up with many potentially large recovery points that you cannot
9696
9797
module "backup_vault" {
9898
99-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.28.1"
99+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.29.0"
100100
101101
# ----------------------------------------------------------------------------------------------------
102102
# REQUIRED VARIABLES
@@ -136,7 +136,7 @@ module "backup_vault" {
136136
# ------------------------------------------------------------------------------------------------------
137137
138138
terraform {
139-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.28.1"
139+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.29.0"
140140
}
141141
142142
inputs = {
@@ -287,11 +287,11 @@ A map of tags assigned to the vault resources, including those inherited from th
287287
<!-- ##DOCS-SOURCER-START
288288
{
289289
"originalSources": [
290-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-vault/readme.md",
291-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-vault/variables.tf",
292-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/backup-vault/outputs.tf"
290+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-vault/readme.md",
291+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-vault/variables.tf",
292+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/backup-vault/outputs.tf"
293293
],
294294
"sourcePlugin": "module-catalog-api",
295-
"hash": "87deea3913a05b7ee04da9c78311b7f1"
295+
"hash": "898df2cb5dba3f2289db21ddcf3d6bd6"
296296
}
297297
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/efs/efs.md‎

Lines changed: 10 additions & 10 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="Data Storage Modules" version="0.28.1" lastModifiedVersion="0.27.2"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.29.0" lastModifiedVersion="0.27.2"/>
1313

1414
# EFS Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/efs" 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-data-storage/tree/v0.29.0/modules/efs" 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-data-storage/releases/tag/v0.27.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -45,13 +45,13 @@ This repo is a part of [the Gruntwork Infrastructure as Code Library](https://gr
4545

4646
If you just want to try this repo out for experimenting and learning, check out the following resources:
4747

48-
* [examples folder](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).
48+
* [examples folder](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).
4949

5050
### Production deployment
5151

5252
If you want to deploy this repo in production, check out the following resources:
5353

54-
* [efs module variables](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/efs/variables.tf): Configuration variables available for the EFS module. At minimum, you should configure the `allow_connections_from_cidr_blocks` and `allow_connections_from_security_groups` values to only allow access from your private VPC(s). You may also want to enable `storage_encrypted` to encrypt data at-rest.
54+
* [efs module variables](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/efs/variables.tf): Configuration variables available for the EFS module. At minimum, you should configure the `allow_connections_from_cidr_blocks` and `allow_connections_from_security_groups` values to only allow access from your private VPC(s). You may also want to enable `storage_encrypted` to encrypt data at-rest.
5555

5656
## Manage
5757

@@ -74,7 +74,7 @@ If you want to deploy this repo in production, check out the following resources
7474
7575
module "efs" {
7676
77-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.28.1"
77+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.29.0"
7878
7979
# ----------------------------------------------------------------------------------------------------
8080
# REQUIRED VARIABLES
@@ -176,7 +176,7 @@ module "efs" {
176176
# ------------------------------------------------------------------------------------------------------
177177
178178
terraform {
179-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.28.1"
179+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.29.0"
180180
}
181181
182182
inputs = {
@@ -547,11 +547,11 @@ The IDs of the security groups created for the file system.
547547
<!-- ##DOCS-SOURCER-START
548548
{
549549
"originalSources": [
550-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/efs/readme.adoc",
551-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/efs/variables.tf",
552-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/efs/outputs.tf"
550+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/efs/readme.adoc",
551+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/efs/variables.tf",
552+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/efs/outputs.tf"
553553
],
554554
"sourcePlugin": "module-catalog-api",
555-
"hash": "b6efe8b96c9b8017074082a850764bd2"
555+
"hash": "5cb97ab61c4de067c4ae39e4d01f9dd8"
556556
}
557557
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/lambda-cleanup-snapshots/lambda-cleanup-snapshots.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="Data Storage Modules" version="0.28.1" lastModifiedVersion="0.27.2"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.29.0" lastModifiedVersion="0.27.2"/>
1313

1414
# Delete Snapshots Lambda Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/lambda-cleanup-snapshots" 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-data-storage/tree/v0.29.0/modules/lambda-cleanup-snapshots" 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-data-storage/releases/tag/v0.27.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -29,7 +29,7 @@ Note that to use this module, you must have access to the Gruntwork [Continuous
2929

3030
This module allows you to configure a number of parameters, such as which database to backup, how often to run the
3131
backups, what account to share the backups with, and more. For a list of all available variables and their
32-
descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/lambda-cleanup-snapshots/variables.tf).
32+
descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/lambda-cleanup-snapshots/variables.tf).
3333

3434
## Sample Usage
3535

@@ -44,7 +44,7 @@ descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-d
4444
4545
module "lambda_cleanup_snapshots" {
4646
47-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.28.1"
47+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.29.0"
4848
4949
# ----------------------------------------------------------------------------------------------------
5050
# REQUIRED VARIABLES
@@ -114,7 +114,7 @@ module "lambda_cleanup_snapshots" {
114114
# ------------------------------------------------------------------------------------------------------
115115
116116
terraform {
117-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.28.1"
117+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.29.0"
118118
}
119119
120120
inputs = {
@@ -293,11 +293,11 @@ Namespace of snapshots that will be cleaned up by this module. If specified then
293293
<!-- ##DOCS-SOURCER-START
294294
{
295295
"originalSources": [
296-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/lambda-cleanup-snapshots/readme.md",
297-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/lambda-cleanup-snapshots/variables.tf",
298-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.28.1/modules/lambda-cleanup-snapshots/outputs.tf"
296+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/lambda-cleanup-snapshots/readme.md",
297+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/lambda-cleanup-snapshots/variables.tf",
298+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.29.0/modules/lambda-cleanup-snapshots/outputs.tf"
299299
],
300300
"sourcePlugin": "module-catalog-api",
301-
"hash": "3faa1e451e28cb3cc61a7057a129de0b"
301+
"hash": "266d27fac0fc343412082e9cfa7bbb5a"
302302
}
303303
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)