https://github.com/trussworks/terraform-module-template
Template repo with Terraform module basics
https://github.com/trussworks/terraform-module-template
template terraform terraform-module
Last synced: 15 days ago
JSON representation
Template repo with Terraform module basics
- Host: GitHub
- URL: https://github.com/trussworks/terraform-module-template
- Owner: trussworks
- License: apache-2.0
- Created: 2019-09-11T00:35:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T14:38:22.000Z (about 1 month ago)
- Last Synced: 2025-03-28T07:23:07.714Z (17 days ago)
- Topics: template, terraform, terraform-module
- Language: HCL
- Homepage:
- Size: 1.35 MB
- Stars: 22
- Watchers: 8
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - trussworks/terraform-module-template - Template repo with Terraform module basics (Makefile)
README
# Truss Terraform Module template
This repository is meant to be a template repo we can just spin up new module
repos from with our general format.
## Creating a new Terraform Module
1. Clone this repo, renaming appropriately.
1. Write your terraform code in the root dir.
## Actual readme below - Delete above here
Please put a description of what this module does here
## Usage
### Put an example usage of the module here
```hcl
module "example" {
source = "terraform/registry/path"
}
```
## Requirements
| Name | Version |
|------|---------|
| terraform | 1.5.7 |
| aws | ~> 5.0 |
## Providers
No providers.
## Modules
No modules.
## Resources
No resources.
## Inputs
No inputs.
## Outputs
No outputs.
## Developer Setup
- [Pre-Commit](https://pre-commit.com/)
- [TFenv](https://github.com/tfutils/tfenv)
- [Terraform-Docs](https://terraform-docs.io/)
- [TFLint](https://github.com/terraform-linters/tflint)
- [Trivy](https://trivy.dev/)
Install dependencies (macOS)
```shell
brew install pre-commit tfenv terraform-docs tflint trivy
tfenv install
pre-commit install --install-hooks
```