Blog Details

All about terraform Modules – how to Create & Publish your own modules – 100 days of Cloud: Day 21


DAY 21 – All about terraform Modules – Create & Publish your own modules – Day Twenty One

Image tweet
Image description

100 days of Cloud on GitHub – Read On – Read on

Using modules

Public Modules

  • Terraform registry
  • Syntax NameSpace/Name/Provider
  • initiate via terraform init

Private Modules

  • terraform cloud
  • Syntax Hostname/NameSpace/Name/Provider
  • initiate via terraform login

Publishing Modules

Image apply

Public Modules

Modules are published on to github. It have to be named with a specific name pattern as well.
ex:- lets say you are creating a modules for AWS VPC then module have to be named terraform-aws-vpc. You publish you module to terraform registry via GitHub account.

Some Features

  • Supports versioning
  • Generate document
  • version history
  • Show example
  • available

Verified Modules

Verified modules are reviewed by HashiCorp and actively maintained by contributors to stay up-to-date and compatible with both Terraform and their respective providers.

The verified badge appears next to modules that are published by a verified source.

Image badge

Standard Module Structure

Lets get an idea of the structure

  • – This must exists on the root directory. In other words this file is the entry point for your module.
  • ,– All variables and outputs should have one or two sentence descriptions that explain their purpose. (Variables that can be passed, outputs are output values)
  • – description in a readme file.
  • LICENSE – The license under which this module is available
  • Nested Module – Optional, must be inside the modules/ directory

Structure example

$ tree complete-module/
├── ...
├── modules/
│   ├── nestedA/
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──
│   ├── nestedB/
│   ├── .../
├── examples/
│   ├── exampleA/
│   │   ├──
│   ├── exampleB/
│   ├── .../

Building your own Modueles

Image terraform modules

Lets use VSCode (Visual Studio Code) for this project

Make sure you have Terraform Visual Studio Code Extension is installed.

File Structure

  • Lets create a new directory and Name it as terraform-aws-ec2
  • Building the file structure.
    • Lets create file
  • Now create a sub folder named terraform-aws-ec2module-tutorial and create these files also,,, LICENSE
Image terraform folder structure

Here we are going to build a module to create EC2 preloaded with APACHE and publish it to the terraform registry with GitHub.

Lets Build a Module

Once you created and copy pasted all the codes as above, we will create an terraform module to create an EC2 instance.

An EC2 APACHE server

Goal of the module is to create a EC2 instance with Apache installed in that.

Create a Public GitHub repo

  • Name the repo as terraform-aws-ec2module-tutorial.
  • On your project folder cd in to terraform-aws-ec2module-tutorial.
  • Initialise, add all, commit and push the code.
  • Add a version tag.
git tag v1.0.0
git push --tags

Connecting to Terraform Registry

  • Go to Terraform Registry
  • click on to sign-in, then click to Sign in with GitHubImage GitHub sign in terraform registry
  • Authorize hashicrop Sign in.Image Authorize hashicrop
  • Go and select publish moduleImage Publish module
  • Select our module, agree to terms of use and click Publish Module .Image publish module
  • 🎉Congratulations🎉 you have successfully published your module to terraform registryImage publish

✅Connect with me on Twitter
🤝🏽Connect with me on Linkedin
🧑🏼‍🤝‍🧑🏻 Read more post on or
💻 Connect with me on GitHub