{"id":8123,"date":"2025-03-04T07:47:23","date_gmt":"2025-03-04T07:47:23","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=8123"},"modified":"2025-03-04T07:47:23","modified_gmt":"2025-03-04T07:47:23","slug":"terraform-modules-explained","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/terraform-modules-explained\/","title":{"rendered":"Terraform Tutorials: Module Complete Guide"},"content":{"rendered":"\n

A Terraform module<\/strong> is a collection of configuration files that encapsulate resources used together to achieve a specific outcome. Modules promote reusability, organization, and maintainability in infrastructure as code by allowing you to group related resources and manage them as a single unit.<\/p>\n\n\n\n

Understanding the Module Block<\/strong><\/p>\n\n\n\n

In Terraform, you define a module block to incorporate the contents of another module into your configuration. This allows you to reuse existing configurations and standardize resource provisioning across your infrastructure.<\/p>\n\n\n\n

Syntax of a Module Block<\/strong><\/p>\n\n\n\n

A typical module block has the following structure:<\/p>\n\n\n

module \"<MODULE_NAME>\"<\/span> {\n  source  = \"<SOURCE>\"<\/span>\n  version = \"<VERSION>\"<\/span>\n  # Additional arguments corresponding to the module's input variables<\/span>\n}\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
\ue206<\/p>\n\n\n\n
    \n
  • <MODULE_NAME><\/code>: A unique identifier for the module instance within your configuration.<\/li>\n\n\n\n
  • <SOURCE><\/code>: Specifies the location of the module’s source code. This can be a local path, a Git repository, or a Terraform Registry address.<\/li>\n\n\n\n
  • <VERSION><\/code>: Defines the version of the module to use, applicable when sourcing modules from registries.<\/li>\n<\/ul>\n\n\n\n
    Example: Using a Module from the Terraform Registry<\/strong><\/p>\n\n\n\n
    Suppose you want to deploy an AWS Virtual Private Cloud (VPC) using a community-maintained module from the Terraform Registry. You can define the module block as follows:<\/p>\n\n\n
    module<\/span> \"vpc\"<\/span> {\n  source  = \"terraform-aws-modules\/vpc\/aws\"<\/span>\n  version = \"3.19.0\"<\/span>\n\n  name = \"my-vpc\"<\/span>\n  cidr = \"10.0.0.0\/16\"<\/span>\n\n  azs             = [\"us-west-1a\"<\/span>, \"us-west-1b\"<\/span>, \"us-west-1c\"<\/span>]\n  private_subnets = [\"10.0.1.0\/24\"<\/span>, \"10.0.2.0\/24\"<\/span>, \"10.0.3.0\/24\"<\/span>]\n  public_subnets  = [\"10.0.101.0\/24\"<\/span>, \"10.0.102.0\/24\"<\/span>, \"10.0.103.0\/24\"<\/span>]\n\n  enable_nat_gateway = true<\/span>\n  tags = {\n    Terraform   = \"true\"<\/span>\n    Environment = \"dev\"<\/span>\n  }\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    <\/p>\n\n\n\n
    In this example:<\/p>\n\n\n\n
      \n
    • source<\/code>: Specifies the module’s location in the Terraform Registry.<\/li>\n\n\n\n
    • version<\/code>: Ensures that Terraform uses version 3.19.0 of the module, maintaining consistency across deployments.<\/li>\n\n\n\n
    • The subsequent arguments (name<\/code>, cidr<\/code>, azs<\/code>, etc.) correspond to the input variables defined by the module, allowing customization of the VPC’s configuration.<\/li>\n<\/ul>\n\n\n\n
      Example: Using a Local Module<\/strong><\/p>\n\n\n\n
      You can also create and reference local modules within your project directory. Assume you have a module that sets up an AWS EC2 instance, located in the modules\/ec2-instance<\/code> directory:<\/p>\n\n\n
      module<\/span> \"web_server\"<\/span> {\n  source = \".\/modules\/ec2-instance\"<\/span>\n\n  instance_type = \"t2.micro\"<\/span>\n  ami_id        = \"ami-0c55b159cbfafe1f0\"<\/span>\n  subnet_id     = \"subnet-abc12345\"<\/span>\n}\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      \ue206<\/p>\n\n\n\n
      Here:<\/p>\n\n\n\n
        \n
      • source<\/code>: Points to the relative path of the local module.<\/li>\n\n\n\n
      • The arguments (instance_type<\/code>, ami_id<\/code>, subnet_id<\/code>) are input variables defined within the ec2-instance<\/code> module, allowing you to customize the EC2 instance’s properties.\ue206<\/li>\n<\/ul>\n\n\n\n
        Key Components of a Module<\/strong><\/p>\n\n\n\n
        A well-structured Terraform module typically includes the following files:\ue206<\/p>\n\n\n\n
          \n
        • main.tf<\/code>: Contains the primary resource definitions.\ue206<\/li>\n\n\n\n
        • variables.tf<\/code>: Declares input variables to parameterize the module.\ue206<\/li>\n\n\n\n
        • outputs.tf<\/code>: Defines output values to expose information about the resources.\ue206<\/li>\n\n\n\n
        • versions.tf<\/code>: Specifies the required Terraform version and provider constraints.\ue206<\/li>\n\n\n\n
        • README.md<\/code>: Provides documentation on the module’s purpose and usage.\ue206<\/li>\n<\/ul>\n\n\n\n
          Best Practices for Using Modules<\/strong><\/p>\n\n\n\n
            \n
          • Encapsulation<\/strong>: Modules should encapsulate their resources, exposing only necessary inputs and outputs.\ue206<\/li>\n\n\n\n
          • Reusability<\/strong>: Design modules to be reusable across different configurations and environments.\ue206<\/li>\n\n\n\n
          • Versioning<\/strong>: Implement version control for modules to manage changes and ensure stability.\ue206<\/li>\n\n\n\n
          • Documentation<\/strong>: Provide clear documentation within the module directory to explain its purpose and usage.\ue206<\/li>\n\n\n\n
          • Consistency<\/strong>: Use consistent naming conventions and file structures across modules.\ue206<\/li>\n<\/ul>\n\n\n\n
            By effectively utilizing module blocks, you can create modular, reusable, and maintainable infrastructure configurations, enhancing the scalability and manageability of your Terraform projects.<\/p>\n\n\n\n
            $ tree minimal-module\/
             .
             \u251c\u2500\u2500 README.md
             \u251c\u2500\u2500 main.tf
             \u251c\u2500\u2500 variables.tf
             \u251c\u2500\u2500 outputs.tf<\/p>\n\n\n\n