Excoriate/terraform-registry-module-template

Batteries-included 🔋Terraform module template, based on real-world experience and managing IAC "at scale" 🚀

Terraform Module Golden Template 🏆

An easy to understand, opinionated terraform composable module with batteries included 🔋.

---

[//]: # (// FIXME: Remove, refactor or change. (Template)

About The Module

[//]: # (// FIXME: Remove, refactor or change. (Template) (put high level description here)

---

Module documentation

The documentation is automatically generated by terraform-docs, and it's available in the module's README.md file.

Capabilities

[//]: # (// FIXME: Remove, refactor or change. (Template)

(put description here)

Getting Started

[//]: # (// FIXME: Remove, refactor or change. (Template)

(put description here)

Roadmap

[//]: # (// FIXME: Remove, refactor or change. (Template)

(put description here)

Module standard structure

The module's relevant components, structure and "skeleton" is described below:

.
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── TaskFile.yml
├── default
│   └── unit
├── docs
│   └── contribution_guidelines.md
├── examples
│   ├── README.md
│   ├── TaskFile.yml
│   └── default
│       └── basic
│           ├── README.md
│           ├── config
│           │   └── fixtures.tfvars
│           ├── main.tf
│           ├── outputs.tf
│           ├── providers.tf
│           ├── variables.tf
│           └── versions.tf
├── modules
│   ├── TaskFile.yml
│   └── default
│       ├── README.md
│       ├── data.tf
│       ├── locals.tf
│       ├── main.tf
│       ├── outputs.tf
│       ├── variables.tf
│       └── versions.tf
├── release-please-config.json
├── scripts
│   ├── containers
│   │   └── build-and-run.sh
│   ├── golang
│   │   └── go_build.sh
│   └── hooks
│       └── pre-commit-init.sh
├── taskfiles
│   ├── Taskfile.common.yml
│   ├── Taskfile.devex.yml
│   ├── Taskfile.precommit.yml
│   ├── Taskfile.terraform.yml
│   └── Taskfile.terragrunt.yml
└── tests
    ├── README.md
    ├── TaskFile.yml
    └── default
        ├── integration
        │   ├── default_basic_integration_test.go
        │   ├── go.mod
        │   ├── go.sum
        │   └── target
        │       └── basic
        │           └── main.tf
        └── unit
            ├── default_basic_unit_test.go
            ├── go.mod
            ├── go.sum
            └── target
                └── basic
                    └── main.tf```

Where:

• ⚡️Modules: refers to the actual module's directory. Where the .tf files reside. Each subdirectory is a module.
• ⚡️Examples: refers to the examples directory, where the examples recipes lives. These are also used for testing the infrastructure using Terratest. For its specific documentation, query this link
• ⚡️Tests: refers to the tests directory, where the tests recipes lives. These are also used for testing the infrastructure using Terratest. For its specific documentation, query this link

Developer Experience

Some tools that this repo uses:

• 🧰 Terraform — strongly recommended the latest versions
• 🧰 Go — justified mostly for Terratest
• 🧰 TaskFile — for the automation of the tasks.
• 🧰 Make — for the automation of the tasks.

NOTE: For automation during the development process, I use precommit, which is a framework for managing and maintaining multi-language pre-commit hooks. It's a great tool, and I highly recommend it. All the hooks required are installed by this script. It's recommended though to run it through the TaskFile task pre-commit-init.

To initialize your pre-commit configuration, and ensure all the hooks are installed, run the following command:

# Using taskFiles
task pc-init
# Using make
make pc-init

To run these hooks against all the files, you can use the following Task command:

# Using taskFiles
task pc-run
# Using make
make pc-run

---

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Given a version number MAJOR.MINOR.PATCH, we increment the:

1. MAJOR version when we make incompatible changes,
2. MINOR version when we add functionality in a backwards compatible manner, and
3. PATCH version when we make backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• Backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• Backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

NOTE: The releases are automatically generated using release-please-action. For more information, please refer to the release-please-action documentation

Contributing

Contributions are always encouraged and welcome! ❤️. For the process of accepting changes, please refer to the CONTRIBUTING.md file, and for a more detailed explanation, please refer to this guideline here.

---

Roadmap 🗺

• Integrate Open Policy Agent for policy as code.
• Integrate Conftest for policy as code.
• Integrate (Go) TerraDagger for CI using Dagger.io.
• Add built-in CLI for boilerplate generation.

License

This module is licensed under the Apache License Version 2.0, January 2004. Please see LICENSE for full details.

Contact

• 📧 Email: Alex T.
• 🧳 Linkedin: Alex T.

made/with ❤️ 🤟