< This section can be removed >

Official doc for public modules hashicorp

Repo structure:

├── README.md
├── main.tf
├── variables.tf
├── outputs.tf
├── ...
├── modules/
│   ├── nestedA/
│   │   ├── README.md
│   │   ├── variables.tf
│   │   ├── main.tf
│   │   ├── outputs.tf
│   ├── nestedB/
│   ├── .../
├── examples/
│   ├── exampleA/
│   │   ├── main.tf
│   ├── exampleB/
│   ├── .../

My Terraform Module

< module description >

Usage

< describe the module minimal code required for a deployment >

module "my_module_example" {
}

Explanation and description of interesting use-cases

< create a h2 chapter for each section explaining special module concepts >

Examples

< if the folder examples/ exists, put here the link to the examples subfolders with their descriptions >

Contributing

< issues and contribution guidelines for public modules >

Pre-Commit

Installation: install pre-commit and execute pre-commit install. This will generate pre-commit hooks according to the config in .pre-commit-config.yaml

Before submitting a PR be sure to have used the pre-commit hooks or run: pre-commit run -a

The pre-commit command will run:

• Terraform fmt
• Terraform validate
• Terraform docs
• Terraform validate with tflint
• check for merge conflicts
• fix end of files

as described in the .pre-commit-config.yaml file

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.0

Providers

No providers.

Modules

No modules.

Resources

No resources.

Inputs

No inputs.

Outputs

No outputs.

Authors

Module is maintained by Alfredo Gottardo, David Beauvererd, Davide Cammarata, Demetrio Carrara and Roland Bapst

License

Apache 2 Licensed. See LICENSE for full details.