Skip to content

Commit 0bc2bae

Browse files
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent c50e8db commit 0bc2bae

File tree

6 files changed

+75
-48
lines changed

6 files changed

+75
-48
lines changed

docs/reference/modules/terraform-aws-openvpn/backup-openvpn-pki/backup-openvpn-pki.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ 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="Open VPN Package Infrastructure Package" version="0.27.2" lastModifiedVersion="0.26.2"/>
12+
<VersionBadge repoTitle="Open VPN Package Infrastructure Package" version="0.27.3" lastModifiedVersion="0.26.2"/>
1313

1414
# Backup PKI Assets Module
1515

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

2020
This module is used to backup the OpenVPN Public Key Infrastructure (PKI) to S3 on a server that has been installed using
21-
the [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn) module.
21+
the [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn) module.
2222

2323
The PKI is the set of certificates used to verify the server and users' identities for VPN authentication purposes. This
2424
normally lives on the OpenVPN server in the `/etc/openvpn-ca` and `/etc/openvpn` directories. If we didn't back these files
@@ -28,11 +28,11 @@ up, we would have to reissue client certificates if the OpenVPN server ever need
2828
<!-- ##DOCS-SOURCER-START
2929
{
3030
"originalSources": [
31-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/backup-openvpn-pki/readme.md",
32-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/backup-openvpn-pki/variables.tf",
33-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/backup-openvpn-pki/outputs.tf"
31+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/backup-openvpn-pki/readme.md",
32+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/backup-openvpn-pki/variables.tf",
33+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/backup-openvpn-pki/outputs.tf"
3434
],
3535
"sourcePlugin": "module-catalog-api",
36-
"hash": "a999f27d0ff95c7082f0fc5d4df46a0c"
36+
"hash": "0fa33729e4ef85342017eeddb0216542"
3737
}
3838
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-openvpn/init-openvpn/init-openvpn.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ 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="Open VPN Package Infrastructure Package" version="0.27.2" lastModifiedVersion="0.18.0"/>
12+
<VersionBadge repoTitle="Open VPN Package Infrastructure Package" version="0.27.3" lastModifiedVersion="0.18.0"/>
1313

1414
# Init OpenVPN Module
1515

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

2020
This module is used to initialize the OpenVPN server, its Public Key Infrastructure (PKI), Certificate Authority
21-
(CA) and configuration on a server that has been installed using the [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn) module.
21+
(CA) and configuration on a server that has been installed using the [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn) module.
2222

2323

2424
<!-- ##DOCS-SOURCER-START
2525
{
2626
"originalSources": [
27-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/init-openvpn/readme.md",
28-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/init-openvpn/variables.tf",
29-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/init-openvpn/outputs.tf"
27+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/init-openvpn/readme.md",
28+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/init-openvpn/variables.tf",
29+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/init-openvpn/outputs.tf"
3030
],
3131
"sourcePlugin": "module-catalog-api",
32-
"hash": "c798f69243873a5fe6d63e49f752a08f"
32+
"hash": "5a12906b90129f9a993d4ce910d0c219"
3333
}
3434
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-openvpn/install-openvpn/install-openvpn.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ 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="Open VPN Package Infrastructure Package" version="0.27.2" lastModifiedVersion="0.19.0"/>
12+
<VersionBadge repoTitle="Open VPN Package Infrastructure Package" version="0.27.3" lastModifiedVersion="0.19.0"/>
1313

1414
# Install OpenVPN Module
1515

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

2020
This module is used to install the OpenVPN package and related template files onto a server. It is expected that
21-
the [init-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/init-openvpn) module will be run on the server during boot to configure the OpenVPN server installed by this
21+
the [init-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/init-openvpn) module will be run on the server during boot to configure the OpenVPN server installed by this
2222
package.
2323

2424

2525
<!-- ##DOCS-SOURCER-START
2626
{
2727
"originalSources": [
28-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn/readme.md",
29-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn/variables.tf",
30-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn/outputs.tf"
28+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn/readme.md",
29+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn/variables.tf",
30+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn/outputs.tf"
3131
],
3232
"sourcePlugin": "module-catalog-api",
33-
"hash": "fab689c4357f5fbbbfee8a0906c01fbd"
33+
"hash": "28d349751eafcb3fd7ddd3edaf75e735"
3434
}
3535
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-openvpn/openvpn-admin/openvpn-admin.md

Lines changed: 7 additions & 7 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="Open VPN Package Infrastructure Package" version="0.27.2" lastModifiedVersion="0.26.2"/>
12+
<VersionBadge repoTitle="Open VPN Package Infrastructure Package" version="0.27.3" lastModifiedVersion="0.27.3"/>
1313

1414
# openvpn-admin
1515

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

2020
This module contains a command-line utility that allows users to request new certificates, administrators to revoke
2121
certificates and the OpenVPN server to process those requests.
@@ -32,11 +32,11 @@ certificates and the OpenVPN server to process those requests.
3232
<!-- ##DOCS-SOURCER-START
3333
{
3434
"originalSources": [
35-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-admin/readme.md",
36-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-admin/variables.tf",
37-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-admin/outputs.tf"
35+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-admin/readme.md",
36+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-admin/variables.tf",
37+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-admin/outputs.tf"
3838
],
3939
"sourcePlugin": "module-catalog-api",
40-
"hash": "22201f32ae54e8d938ea13d64e9cb8bb"
40+
"hash": "f455883629bd3d914ccad53fcc9fdfab"
4141
}
4242
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-openvpn/openvpn-server/openvpn-server.md

Lines changed: 40 additions & 13 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="Open VPN Package Infrastructure Package" version="0.27.2" lastModifiedVersion="0.27.0"/>
12+
<VersionBadge repoTitle="Open VPN Package Infrastructure Package" version="0.27.3" lastModifiedVersion="0.27.0"/>
1313

1414
# OpenVPN Server Module
1515

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

@@ -83,7 +83,7 @@ resource "aws_iam_policy_attachment" "attachment" {
8383

8484
## What if I want to enable MFA?
8585

86-
The scripts [init-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/init-openvpn) and [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/install-openvpn) support setting up the
86+
The scripts [init-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/init-openvpn) and [install-openvpn](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/install-openvpn) support setting up the
8787
[duo_openvpn](https://github.com/duosecurity/duo_openvpn) plugin for 2FA authentication. To enable the duo plugin, you
8888
need to:
8989

@@ -96,7 +96,7 @@ need to:
9696
`--duo-skey`, and `--duo-host` to configure the integration key, secret key, and API hostname respectively. You can
9797
obtain these by following [the Duo setup instructions for OpenVPN](https://duo.com/docs/openvpn).
9898

99-
See the [packer-duo](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/examples/packer-duo) and [openvpn-host-duo](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/examples/openvpn-host-duo) examples for an
99+
See the [packer-duo](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/examples/packer-duo) and [openvpn-host-duo](https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/examples/openvpn-host-duo) examples for an
100100
example configuration to deploy the OpenVPN server with Duo enabled.
101101

102102
Once the plugin is setup, all authentication for the client will result in a password prompt. To authenticate, you pass
@@ -117,7 +117,7 @@ exactly match the duo username.
117117
118118
module "openvpn_server" {
119119
120-
source = "git::[email protected]:gruntwork-io/terraform-aws-openvpn.git//modules/openvpn-server?ref=v0.27.2"
120+
source = "git::[email protected]:gruntwork-io/terraform-aws-openvpn.git//modules/openvpn-server?ref=v0.27.3"
121121
122122
# ----------------------------------------------------------------------------------------------------
123123
# REQUIRED VARIABLES
@@ -147,6 +147,11 @@ module "openvpn_server" {
147147
# encrypt/decrypt backup files.
148148
kms_key_arn = <string>
149149
150+
# The name of the sqs queue that will be used to receive certification list
151+
# requests. Note that the queue name will be automatically prefixed with
152+
# 'openvpn-lists-'.
153+
list_queue_name = <string>
154+
150155
# The name of the server. This will be used to namespace all resources created
151156
# by this module.
152157
name = <string>
@@ -254,7 +259,7 @@ module "openvpn_server" {
254259
255260
# The ARNs of external AWS accounts where your IAM users are defined. If not
256261
# empty, this module will create IAM roles that users in those accounts will
257-
# be able to assume to get access to the request/revocation SQS queues.
262+
# be able to assume to get access to the request/revocation/list SQS queues.
258263
external_account_arns = []
259264
260265
# The length of time, in seconds, for which Amazon SQS can reuse a data key to
@@ -352,7 +357,7 @@ module "openvpn_server" {
352357
# ------------------------------------------------------------------------------------------------------
353358
354359
terraform {
355-
source = "git::[email protected]:gruntwork-io/terraform-aws-openvpn.git//modules/openvpn-server?ref=v0.27.2"
360+
source = "git::[email protected]:gruntwork-io/terraform-aws-openvpn.git//modules/openvpn-server?ref=v0.27.3"
356361
}
357362
358363
inputs = {
@@ -385,6 +390,11 @@ inputs = {
385390
# encrypt/decrypt backup files.
386391
kms_key_arn = <string>
387392
393+
# The name of the sqs queue that will be used to receive certification list
394+
# requests. Note that the queue name will be automatically prefixed with
395+
# 'openvpn-lists-'.
396+
list_queue_name = <string>
397+
388398
# The name of the server. This will be used to namespace all resources created
389399
# by this module.
390400
name = <string>
@@ -492,7 +502,7 @@ inputs = {
492502
493503
# The ARNs of external AWS accounts where your IAM users are defined. If not
494504
# empty, this module will create IAM roles that users in those accounts will
495-
# be able to assume to get access to the request/revocation SQS queues.
505+
# be able to assume to get access to the request/revocation/list SQS queues.
496506
external_account_arns = []
497507
498508
# The length of time, in seconds, for which Amazon SQS can reuse a data key to
@@ -649,6 +659,14 @@ The Amazon Resource Name (ARN) of the KMS Key that will be used to encrypt/decry
649659
</HclListItemDescription>
650660
</HclListItem>
651661

662+
<HclListItem name="list_queue_name" requirement="required" type="string">
663+
<HclListItemDescription>
664+
665+
The name of the sqs queue that will be used to receive certification list requests. Note that the queue name will be automatically prefixed with 'openvpn-lists-'.
666+
667+
</HclListItemDescription>
668+
</HclListItem>
669+
652670
<HclListItem name="name" requirement="required" type="string">
653671
<HclListItemDescription>
654672

@@ -840,7 +858,7 @@ Set this variable to true to enable the Instance Metadata Service (IMDS) endpoin
840858
<HclListItem name="external_account_arns" requirement="optional" type="list(string)">
841859
<HclListItemDescription>
842860

843-
The ARNs of external AWS accounts where your IAM users are defined. If not empty, this module will create IAM roles that users in those accounts will be able to assume to get access to the request/revocation SQS queues.
861+
The ARNs of external AWS accounts where your IAM users are defined. If not empty, this module will create IAM roles that users in those accounts will be able to assume to get access to the request/revocation/list SQS queues.
844862

845863
</HclListItemDescription>
846864
<HclListItemDefaultValue defaultValue="[]"/>
@@ -1011,6 +1029,12 @@ The base64-encoded User Data script to run on the server when it is booting. Thi
10111029
</TabItem>
10121030
<TabItem value="outputs" label="Outputs">
10131031

1032+
<HclListItem name="allow_certificate_lists_for_external_accounts_iam_role_arn">
1033+
</HclListItem>
1034+
1035+
<HclListItem name="allow_certificate_lists_for_external_accounts_iam_role_id">
1036+
</HclListItem>
1037+
10141038
<HclListItem name="allow_certificate_requests_for_external_accounts_iam_role_arn">
10151039
</HclListItem>
10161040

@@ -1029,6 +1053,9 @@ The base64-encoded User Data script to run on the server when it is booting. Thi
10291053
<HclListItem name="backup_bucket_name">
10301054
</HclListItem>
10311055

1056+
<HclListItem name="client_list_queue">
1057+
</HclListItem>
1058+
10321059
<HclListItem name="client_request_queue">
10331060
</HclListItem>
10341061

@@ -1063,11 +1090,11 @@ The base64-encoded User Data script to run on the server when it is booting. Thi
10631090
<!-- ##DOCS-SOURCER-START
10641091
{
10651092
"originalSources": [
1066-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-server/readme.md",
1067-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-server/variables.tf",
1068-
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.2/modules/openvpn-server/outputs.tf"
1093+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-server/readme.md",
1094+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-server/variables.tf",
1095+
"https://github.com/gruntwork-io/terraform-aws-openvpn/tree/v0.27.3/modules/openvpn-server/outputs.tf"
10691096
],
10701097
"sourcePlugin": "module-catalog-api",
1071-
"hash": "d5a2462a2e167e4d47e78a9ad3d94171"
1098+
"hash": "11b705886b75714ceab38acb7190219e"
10721099
}
10731100
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)