Skip to content

Commit

Permalink
minor updates - examples documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pablo19sc committed Mar 9, 2023
1 parent 60387bd commit 3188371
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 10 deletions.
11 changes: 5 additions & 6 deletions examples/cloud_wan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,27 @@ This example shows how you can use this module with `core_network` subnets, and
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.27.0 |
| <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | >= 0.36.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.27.0 |
| <a name="provider_awscc.awsccnvirginia"></a> [awscc.awsccnvirginia](#provider\_awscc.awsccnvirginia) | >= 0.36.0 |
| <a name="provider_aws.awsnvirginia"></a> [aws.awsnvirginia](#provider\_aws.awsnvirginia) | >= 4.27.0 |

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_ireland_vpc"></a> [ireland\_vpc](#module\_ireland\_vpc) | aws-ia/vpc/aws | >= 3.0.2 |
| <a name="module_nvirginia_vpc"></a> [nvirginia\_vpc](#module\_nvirginia\_vpc) | aws-ia/vpc/aws | >= 3.0.2 |
| <a name="module_ireland_vpc"></a> [ireland\_vpc](#module\_ireland\_vpc) | aws-ia/vpc/aws | >= 4.0.0 |
| <a name="module_nvirginia_vpc"></a> [nvirginia\_vpc](#module\_nvirginia\_vpc) | aws-ia/vpc/aws | >= 4.0.0 |

## Resources

| Name | Type |
|------|------|
| [awscc_networkmanager_core_network.core_network](https://registry.terraform.io/providers/hashicorp/awscc/latest/docs/resources/networkmanager_core_network) | resource |
| [awscc_networkmanager_global_network.global_network](https://registry.terraform.io/providers/hashicorp/awscc/latest/docs/resources/networkmanager_global_network) | resource |
| [aws_networkmanager_core_network.core_network](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_core_network) | resource |
| [aws_networkmanager_global_network.global_network](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_global_network) | resource |
| [aws_networkmanager_core_network_policy_document.policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/networkmanager_core_network_policy_document) | data source |

## Inputs
Expand Down
2 changes: 1 addition & 1 deletion examples/public_private_flow_logs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ At this point, only cloud-watch logs are support, pending: https://github.com/aw

| Name | Source | Version |
|------|--------|---------|
| <a name="module_vpc"></a> [vpc](#module\_vpc) | aws-ia/vpc/aws | >= 3.0.2 |
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ../.. | n/a |

## Resources

Expand Down
9 changes: 9 additions & 0 deletions examples/transit_gateway/.header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Creating AWS Transit Gateway VPC attachment

This example shows how you can use this module with `transit_gateway` subnets, and AWS Transit Gateway VPC attachment. This examples creates the following:

* AWS Transit Gateway.
* The VPC module creates the following:
* Four sets of subnets (*public*, *private_with_egress*, *truly_private*, and *transit_gateway*)
* Transit Gateway VPC attachment.
* Routing to Transit Gateway attachment from *public* and *private_with_egress* subnets.
21 changes: 21 additions & 0 deletions examples/transit_gateway/.terraform-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
formatter: markdown
header-from: .header.md
settings:
anchor: true
color: true
default: true
escape: true
html: true
indent: 2
required: true
sensitive: true
type: true
lockfile: false

sort:
enabled: true
by: required

output:
file: README.md
mode: replace
45 changes: 45 additions & 0 deletions examples/transit_gateway/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!-- BEGIN_TF_DOCS -->
# Creating AWS Transit Gateway VPC attachment

This example shows how you can use this module with `transit_gateway` subnets, and AWS Transit Gateway VPC attachment. This examples creates the following:

* AWS Transit Gateway.
* The VPC module creates the following:
* Four sets of subnets (*public*, *private\_with\_egress*, *truly\_private*, and *transit\_gateway*)
* Transit Gateway VPC attachment.
* Routing to Transit Gateway attachment from *public* and *private\_with\_egress* subnets.

## Requirements

No requirements.

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_tgw_base_for_example_only"></a> [tgw\_base\_for\_example\_only](#module\_tgw\_base\_for\_example\_only) | ../../test/hcl_fixtures/transit_gateway_base | n/a |
| <a name="module_vpc"></a> [vpc](#module\_vpc) | aws-ia/vpc/aws | >= 4.0.0 |

## Resources

| Name | Type |
|------|------|
| [aws_availability_zones.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |

## Inputs

No inputs.

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_private_subnets_tags_length"></a> [private\_subnets\_tags\_length](#output\_private\_subnets\_tags\_length) | Count of private subnet tags for a single az. |
| <a name="output_tgw_subnets_tags_length"></a> [tgw\_subnets\_tags\_length](#output\_tgw\_subnets\_tags\_length) | Count of tgw subnet tags for a single az. |
<!-- END_TF_DOCS -->
5 changes: 2 additions & 3 deletions examples/transit_gateway/main.tf
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
data "aws_availability_zones" "current" {}

module "vpc" {
# source = "aws-ia/vpc/aws"
# version = ">= 3.0.2"
source = "../.."
source = "aws-ia/vpc/aws"
version = ">= 4.0.0"

name = "tgw"
cidr_block = "10.0.0.0/16"
Expand Down

0 comments on commit 3188371

Please sign in to comment.