Terraform AWS ARC Network Module Usage Guide¶

Introduction¶

Purpose of the Document¶

This document provides guidelines and instructions for users looking to implement the Terraform AWS ARC Network module for managing VPC and other network resources on AWS.

Module Overview¶

The Terraform AWS ARC Network module provides a secure and modular foundation for building robust and secure VPC and network resources on AWS.

arc_network_hla

Prerequisites¶

Before using this module, ensure you have the following:

AWS credentials configured.
Terraform installed.
A working knowledge of AWS VPC, Networking and Terraform concepts.

Getting Started¶

Module Source¶

To incorporate the module into your main Terraform configuration file (e.g., main.tf), declare the module and define its source along with the desired version. For instance, you can specify the module source and version as follows:

module "network" {
  source  = "sourcefuse/arc-network/aws"
  version = "2.6.10"
  # insert the required variables here
}

Refer to the Terraform Registry for the latest version.

Integration with Existing Terraform Configurations¶

Integrate the module with your existing Terraform mono repo configuration, follow the steps below:

Create a new folder in terraform/ named network.

Create the required files, see the examples to base off of.

network/
|-- main.tf
|-- variables.tf
|-- outputs.tf

Configure with your backend
- Create the environment backend configuration file: config.<environment>.hcl
  - region: Where the backend resides
  - key: <working_directory>/terraform.tfstate
  - bucket: Bucket name where the terraform state will reside
  - dynamodb_table: Lock table so there are not duplicate tfplans in the mix
  - encrypt: Encrypt all traffic to and from the backend
Execute Terraform Commands
- After defining your main configuration, navigate to the directory containing your Terraform files and run the following commands:
1 2
terraform init terraform apply
5. Review and Confirm - Terraform will display a plan showing the changes it intends to make. Review the plan and confirm by typing 'yes' when prompted.

Required AWS Permissions¶

Ensure that the AWS credentials used to execute Terraform have the necessary permissions to create and modify VPC and network resources (like site to site vpn, client vpn, vpc endpoints etc. as per your need) for the account.

Module Configuration¶

Input Variables¶

For a list of input variables, see the README Inputs section.

Output Values¶

For a list of outputs, see the README Outputs section.

Module Usage¶

Basic Usage¶

For basic usage, see the example folder.

This example will create:

A VPC with CIDR block 10.9.0.0/16
Two subnets in availability zones : "us-east-1a", "us-east-1b"
Route tables, internet gateway, NAT Gateways
vpc endpoints for the services: s3, kms, cloudwatch, elb, dynamodb, ec2, sns, sqs, ecs, rds

Tips and Recommendations¶

If you want to create custom subnet ranges, check example
When creating custom subnet ranges with this module, if you set custom_nat_gateway_enabled to false then make sure that you either a) set the variable custom_az_ngw_ids with an appropriate map of availability zone to nat gateway id OR b) set your own default route using aws_route resource

Troubleshooting¶

Reporting Issues¶

If you encounter a bug or issue, please report it on the GitHub repository.

Security Considerations¶

AWS VPC¶

Understand the security considerations related to Network Security on AWS when using this module.

Best Practices for AWS Network¶

Follow best practices to ensure secure Network configurations:

Network security on AWS

Contributing and Community Support¶

Contributing Guidelines¶

Contribute to the module by following the guidelines outlined in the CONTRIBUTING.md file.

Reporting Bugs and Issues¶

If you find a bug or issue, report it on the GitHub repository.

License¶

License Information¶

This module is licensed under the Apache 2.0 license. Refer to the LICENSE file for more details.

Open Source Contribution¶

Contribute to open source by using and enhancing this module. Your contributions are welcome!