Welcome to the Terraform AWS Starter Kit! This comprehensive and robust starter kit will empower you to quickly and confidently set up your AWS infrastructure. With secure state management, scalable VPC configuration, enhanced security features, database provisioning, secrets management, SSM parameter store integration, and GitHub Actions integration, this starter kit incorporates proven best practices for building reliable and maintainable AWS environments.
📖 CLICK OR TAP ❲☰❳ TO SHOW TABLE-OF-CONTENTS 📖
The Terraform AWS Starter Kit solves the most challenging aspect of AWS infrastructure building by providing a powerful solution for our clients. Our goal is to simplify the process of setting up a reliable and scalable AWS environment, allowing you to focus on developing and deploying your applications swiftly and confidently.
The Terraform AWS Starter Kit includes secure state management configurations. Your Terraform state is stored in an S3 bucket with a DynamoDB table for state locking. This ensures the security of your infrastructure's state and facilitates easy management and sharing among team members.
Our starter kit provisions a Virtual Private Cloud (VPC) with public and private subnets across three availability zones. This scalable VPC configuration enables the segregation of application and database resources, providing high availability for your infrastructure components.
The starter kit implements security groups for the bastion host and database instances, ensuring controlled access to your resources. The bastion host allows secure access to private resources within the VPC, providing an additional layer of security.
We have included configurations to provision an RDS PostgreSQL instance, RDS Aurora cluster, MSK cluster, MongoDB Atlas cluster, and more. These configurations enable you to set up and manage your databases with ease, ensuring optimal performance and reliability for your applications.
Our starter kit includes configurations to provision an Amazon Elastic Kubernetes Service (EKS) cluster. This enables you to deploy and manage containerized applications using Kubernetes, leveraging the scalability and flexibility of AWS for your workloads.
The Terraform AWS Starter Kit integrates with AWS Secrets Manager to securely store and manage your database credentials. This ensures that sensitive information, such as usernames and passwords, is not exposed in your Terraform code or version control system.
Our starter kit leverages AWS Systems Manager (SSM) Parameter Store to store and manage various parameters required for your infrastructure, such as VPC ID, subnet IDs, and other configuration details. This centralizes the management of configuration parameters, making it easier to update and maintain your infrastructure as it evolves.
We have preconfigured GitHub Actions workflows that provide linting, security checks, and more for your Terraform code. This integration enables automated checks and validation, ensuring adherence to coding standards and identifying potential security vulnerabilities early in the development process.
- Pull Request validation with Danger, markdown linting, and more! ✅
- Linter validation with Mega-Linter! 📝
- Terraform Format validation with Terraform Fmt. 🔄
- Terraform Security validation with Terraform Security. 🔒
- Terraform Docs update with terraform-docs. 📝
- TODOs to GitHub Issues with TODOs to Issues. 📌
By using the Terraform AWS Starter Kit, you can expedite the initial setup of your AWS infrastructure while incorporating proven best practices. It empowers you to focus on building and deploying your applications while providing a solid foundation for scalability, security, and maintainability.
We welcome contributions and feedback to improve this starter kit further, making it a valuable resource for the community.
- Direnv for loading environment variables.
- Terraform for infrastructure provisioning.
- TFswitch to switch between Terraform versions easily.
To get started, clone this repository and navigate to the desired directory:
git clone git@github.com:nanlabs/terraform-aws-starter.git
cd terraform-aws-starterThen set up the environment variables using direnv:
# Create a new .envrc file in the root directory
cp .envrc.example .envrc
# Update the .envrc file with your environment variables
# Load the environment variables
direnv allowAfter that, explore the available live modules and scripts, and follow the instructions provided in their respective README files. For a more hands-on introduction, you can start with the examples provided in the Live Infrastructure and Infra Tools sections.
The live directory houses our active infrastructure configurations. These configurations are organized by domain, allowing you to manage different parts of your infrastructure separately.
| Module | Description |
|---|---|
| Terraform Backend Configuration | Set up the Terraform backend with an S3 bucket and DynamoDB table for state management. |
| AWS IAM Management | Manage IAM roles and policies. |
| Core Networking | Manage core networking components such as VPCs, subnets, and security groups. |
| Services Platform | Manage services platform components, including EKS clusters. |
| Common Infrastructure | Manage common infrastructure components such as RDS instances and DocumentDB clusters. |
Our custom Terraform modules are located in the modules directory. These modules are reusable and help you bootstrap various parts of your infrastructure.
| Module | Description |
|---|---|
| Amplify App | Bootstrap an Amplify app. |
| Bastion | Bootstrap a bastion host. |
| DocumentDB Cluster | Bootstrap a DocumentDB cluster. |
| EKS | Bootstrap an EKS cluster. |
| AWS IAM Role | Bootstrap an AWS IAM role. |
| MongoDB Atlas Cluster | Bootstrap a MongoDB Atlas cluster. |
| MSK Cluster | Bootstrap an MSK cluster. |
| RDS Instance | Bootstrap an RDS Instance. |
| RDS Aurora Cluster | Bootstrap an RDS Aurora Cluster. |
| VPC | Bootstrap a VPC for shared infrastructure. |
| VPC Endpoint | Bootstrap VPC endpoints for S3, DynamoDB, and other services. |
In case you need to create a new module, you can use the Terraform Module Template as a starting point.
For reference, you can also check the Terraform Registry for additional modules.
In addition to infrastructure provisioning, we have included a few apps and services to help you get started. These are located in the apps directory and provide useful examples of how to use the infrastructure we have provisioned.
| Service | Description |
|---|---|
| Start and Stop EC2 Instance | A Serverless Framework-based project to start and stop EC2 instances based on a schedule. |
This section contains additional tools and scripts that complement our Terraform modules, helping you manage specific tasks.
What tools and scripts are available?
- Bastion Host Connection script: Connect to an AWS Bastion host securely.
- Generate
kubeconfigscript: Generate akubeconfigfile for an EKS Cluster. - Tunnel to EKS Cluster script: Create a tunnel to an EKS Cluster for
kubectlaccess. - and more!
Refer to the Infra Tools and Scripts README for more details and usage examples!
- We recommend using automated code scanning tools to improve security and quality of the code. This pattern was scanned using Checkov - a static code analysis tool for infrastructure-as-code. It scans cloud infrastructure code defined using Terraform, CloudFormation, Kubernetes, Helm, ARM Templates and Serverless framework platforms and detects security and compliance misconfigurations.
- Additionally, we recommend at minimum to perform basic validation and formatting checks using
terraform validateandterraform fmt -check -recursiveTerraform commands. - It’s a good practice to add automated tests for infrastructure code. You can refer to this Terraform Blog post to learn more about different approaches to testing Terraform code.
We appreciate contributions from the open-source community. Any contributions you make are truly appreciated. Please refer to our contribution guidelines for more information.
Made with contributors-img.