Writing a Terraform Module: Difference between revisions
Jump to navigation
Jump to search
Line 18: | Line 18: | ||
To define a module, create a new root directory for it and place one or more .tf files inside it. | To define a module, create a new root directory for it and place one or more .tf files inside it. | ||
==Standard Structure== | |||
Everything is optional, except for the [[#Root_Module|root module]]: | |||
* <span id='Root_Module'></font>'''Root module''' - this is the only required element for the standard module structure, and it consists in .tf files - which must exist - in the root directory of the module. | |||
* README or README.md. Should contain a description of the module. Examples can be included in an example directory. | |||
* LICENSE | |||
* Recommended file names: | |||
** <code>main.tf</code> | |||
** <code>variables.tf</code> | |||
** <code>outputs.tf</code> |
Revision as of 01:39, 14 November 2019
External
Internal
Reference Example
- https://registry.terraform.io/modules/hashicorp/consul/aws/0.7.3
- https://github.com/hashicorp/terraform-aws-consul
Playground
Procedure
To define a module, create a new root directory for it and place one or more .tf files inside it.
Standard Structure
Everything is optional, except for the root module:
- Root module - this is the only required element for the standard module structure, and it consists in .tf files - which must exist - in the root directory of the module.
- README or README.md. Should contain a description of the module. Examples can be included in an example directory.
- LICENSE
- Recommended file names:
main.tf
variables.tf
outputs.tf