Skip to content

Commit

Permalink
docs: adding some preliminary docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gambol99 committed Apr 1, 2024
1 parent 3372a96 commit cc73b17
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
![Github Actions](../../actions/workflows/terraform.yml/badge.svg)

# Terraform <NAME>
# Terraform AWS Connectivity Module

## Description

Add a description of the module here
The purpose of this module is to provision the necessary resources to establish connectivity between a transit gateway and other VPCs, accounts, and on-premises networks, as well as provision a baseline for network topology and security. Currently this module can setup the requirement for

- Inspection VPC: provision the necessary resources and routing to inspect traffic between the transit gateway and spoke VPCs.
- Trusted Layout: here the routing is broken into two routing domains, trusted and untrusted. All traffic within the environment have the ability to route to the trusted domain attachments and back, but traffic between those networks located in the untrusted domain is forbidden.
- Egress VPC: using either one of the above, this module can setup the requirements for an egress VPC to route traffic to the internet.
- Ingress VPC: using either one of the above, this module can setup the requirements for an ingress VPC to route traffic from the internet, to the tenant VPCs.

## Usage

Expand Down

0 comments on commit cc73b17

Please sign in to comment.