aboutsummaryrefslogtreecommitdiff
path: root/templates/infrastructure/terraform-module-doc.org
blob: 016819aec6f9e6956c23c62724fe4f3fe4c59ac8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#+TITLE: Terraform Module Documentation - [Module Name]
#+FILETAGS: :infra:terraform:

* Description

* Input Variables
| Name      | Type   | Default | Description            |
|-----------+--------+---------+------------------------|
| region    | string | us-east-1 | AWS region             |
| instance_type | string | t3.micro | EC2 instance type |

* Outputs
| Name     | Description         |
|----------+---------------------|
| instance_id | ID of the EC2 instance |

* Example Usage
#+BEGIN_SRC terraform
module "example" {
  source         = "./modules/example"
  region         = "us-west-1"
  instance_type  = "t3.micro"
}
#+END_SRC