Code Review for Terraform Module Structure - Seeking Best Practices
I'm attempting to set up I tried several approaches but none seem to work... Currently developing a multi-environment Terraform setup for our microservices architecture using version 1.4.3. While reviewing the code, it's evident that our module organization could use some improvement for maintainability and clarity. We've structured our modules to encapsulate resources by service, but some of the team members suggest breaking them down further by resource type to enhance reusability. For example, we have a module like this: ```hcl module "app_service" { source = "./modules/app_service" image = var.image region = var.region } ``` In this module, we're deploying containers on ECS, but dependency management between modules has become a bit cumbersome. To optimize this, I proposed creating a separate module for IAM roles and another for networking resources. However, this change would require adjusting the current references throughout the codebase, which raised concerns during our review about potential breaking changes. I've also noticed that some of our variables are hard-coded in various places, leading to inconsistent configurations across environments. For instance: ```hcl variable "region" { default = "us-east-1" } ``` It’s set in multiple modules but not consistently referenced, which could lead to issues if we need to change the region frequently. As a team, we're debating between the pros and cons of creating a centralized variable file versus keeping them localized within each module. Additionally, are there any recommended practices for naming conventions and file structures that would minimize confusion and enhance collaboration among developers? I've read several articles suggesting different patterns, but I’d love to hear your thoughts on how to best refactor our existing setup while maintaining clarity and reducing potential errors in deployment. Any insights on how to manage module dependencies effectively or examples of successful module structures would be greatly appreciated. For context: I'm using Hcl on macOS. I recently upgraded to Hcl latest. I'd be grateful for any help.