README.md

Core Networking Terraform Module

🏢 This directory contains the Terraform configuration for our core cloud infrastructure. It provides a ready-to-use Terraform module with essential services and security features.

Features

• ✨ Comprehensive Root Terraform module for quick deployment.
• 🗄️ Configured to use an external S3 bucket for Terraform state management with a DynamoDB table for state locking.
• 🌐 Highly available VPC setup with public and private subnets across multiple availability zones.
• 🔒 Configured security groups for bastion hosts and databases.
• 🔑 Bastion host setup for secure access to internal services.
• 🔒 Utilization of AWS Secrets Manager for secure storage of database credentials.
• 🔧 Use of SSM Parameter Store for managing network and service parameters.

Prerequisites

• Direnv for loading environment variables.
• Terraform for infrastructure provisioning.
• TFswitch to switch between Terraform versions easily.

Setup

1. Change Directory:

   Navigate to the directory containing the Terraform configuration:

   cd live/core-networking

2. Create .envrc file:

   Create a new .envrc file in this directory by copying the .envrc.example file:

   cp .envrc.example .envrc

   Then, update the .envrc file with the values for your environment!

3. Load Environment Variables:

   Load the environment variables using direnv:

   direnv allow

4. Set Terraform Version:

   Ensure you are using the correct Terraform version:

   tfswitch

5. Initialize Terraform:

   Initialize the working directory with the required providers and modules:

   terraform init -backend-config="./configs/${ENVIRONMENT}-backend.tfvars"

6. Workspace Management:

   Select or create a new workspace tailored to your deployment environment:

   # Select an existing workspace
   terraform workspace select "${TF_WORKSPACE}"
   
   # Create a new workspace if it doesn't exist and select it
   terraform workspace new "${TF_WORKSPACE}"

Deploy

🚀 Deployment Instructions:

1. Plan Your Deployment:

   Review and verify the deployment plan:

   terraform plan -var-file "./configs/${ENVIRONMENT}.tfvars" -out "${ENVIRONMENT}.tfplan"

2. Execute the Plan:

   Apply the planned configuration to provision the infrastructure:

   terraform apply "${ENVIRONMENT}.tfplan"

Post Deployment Steps

After successfully deploying the infrastructure, follow these steps to test the deployment and ensure everything is working as expected:

Accessing the Parameter Store

Retrieve stored values, such as the VPC ID, using the AWS Parameter Store:

# Retrieve the parameter value from the AWS Parameter Store
vpc_id_parameter_name=$(terraform output -json | jq -r '.ssm_parameter_vpc_id.value')
vpc_id=$(aws ssm get-parameter --name "$vpc_id_parameter_name" --query 'Parameter.Value' --output text)

# Print the value
echo "VPC ID: $vpc_id"

Connecting to the Bastion Host Using Session Manager

AWS Session Manager provides secure and auditable instance management without needing to open inbound ports, manage SSH keys, or use bastion hosts. To connect to the bastion host using Session Manager, follow these steps:

Gather Information

Get the Bastion Instance ID from the Terraform output. You can retrieve this value using Terraform:

bastion_instance_id=$(terraform output -json | jq -r '.bastion_instance_id.value')

echo "Bastion Instance ID: $bastion_instance_id"

Follow the Connection Steps

You can check the Bastion Host Module documentation for detailed steps on connecting to the bastion host using Session Manager: Connect to Bastion Host Using Session Manager.

Destroy

To destroy the infrastructure, run the following command:

terraform destroy -var-file "./configs/${ENVIRONMENT}.tfvars"

Module Documentation

The module documentation is generated with terraform-docs by running the following command from the module directory:

terraform-docs md . > ./docs/MODULE.md

You can also view the latest version of the module documentation here.