Скачать или смотреть Organizing Terraform Modules for Multiple Environments

Discover how to effectively organize your Terraform modules for multiple environments, using a directory-per-environment approach, without workspaces or wrappers.
---
This video is based on the question https://stackoverflow.com/q/66024950/ asked by the user 'deltakroneker' ( https://stackoverflow.com/u/12238373/ ) and on the answer https://stackoverflow.com/a/66047985/ provided by the user 'deltakroneker' ( https://stackoverflow.com/u/12238373/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How to organize terraform modules for multiple environments?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Organizing Terraform Modules for Multiple Environments: A Practical Guide

When working with Terraform, one of the common challenges developers face is organizing their modules efficiently, especially when dealing with multiple environments (like development and staging). Many guides provide fragmented solutions that failed to deliver a comprehensive view of how to structure Terraform projects for real-world applications. In this guide, we will explore an effective strategy to organize your Terraform modules, specifically when using a directory-per-environment approach, while avoiding workspaces and wrappers like Terragrunt.

Understanding the Problem

As outlined, the main requirements for managing a multi-environment Terraform project include:

Multiple Environments: Creating structures that differentiate between development and staging environments.

Remote Backend: Using S3 as a remote state backend, retaining separate state files for each environment.

Modular Design: Leveraging modules to maintain clean and reusable infrastructure code.

Directory-per-Environment Structure: Organizing resources by directory rather than using workspaces, ensuring clarity and simplicity.

Proposed Solution

To achieve the desired folder structure, we need to set up a hierarchical organization that divides resources and configuration files based on the environment. Here's a breakdown of how you can structure your project:

Project Structure

The proposed layout for a simple development and staging simulation of a single S3 bucket resource would look like this:

[[See Video to Reveal this Text or Code Snippet]]

Key Components

Environment-Specific Directories: Each environment (dev and stage) has its own folder, allowing you to keep separate configurations and resources for each environment.

S3 Module Reference: Within each environment folder, a separate main.tf file can reference the S3 module, allowing you to use environment-specific input variables defined in the respective dev.tfvars or stage.tfvars files.

Global Configuration Files:

provider.tf: This file sets up the AWS provider and any required backend configurations. You can define the provider settings and any relevant configurations needed for both environments here.

backend.tf: Here, you can specify the remote backend settings, ensuring that both dev.tfstate and stage.tfstate are stored in the same S3 bucket. This setup helps maintain state integrity across different environments.

Running Terraform Commands

When executing Terraform commands, you will need to specify the configuration file for the environment you're working with. For instance, to execute a plan for the development environment, run:

[[See Video to Reveal this Text or Code Snippet]]

This command directs Terraform to utilize the variables defined in the development configuration file.

Answering Common Questions

Where to Place Backend Configuration?

The backend.tf file can be placed at the root level of your infra/ directory. This way, both environment folders can still reference the same backend configuration while maintaining separate state files.

Running Terraform Plan in Subdirectories

If you have subdirectories for other resources like ec2 or ecr, you would typically execute the terraform plan command in the specific environment folder that you’re interested in. Terraform does not automatically traverse subdirectories; therefore, you will be managing each environment and resource independently.

Conclusion

Organizing your Terraform modules effectively for multiple environments sets a solid foundation for managing your infrastructure as code. By adopting a directory-per-environment approach and leveraging modules, you