Demonstration of Module

Auto Module Generation

Module: projectA

locals projectA:locals

Project Locals

Definition of locals projectA:locals from file locals.tf

locals {
  full_bucket_name = "${var.environment}-${var.bucket_name}"

  common_tags = merge(
    {
      Environment = var.environment
      Owner       = var.owner
      ManagedBy   = "terraform"
    },
    var.tags
  )
}

variable bucket_name

Definition of variable bucket_name from file main.tf

variable "bucket_name" {
  type        = string
  description = "The base name for the S3 bucket. A suffix will be appended to ensure global uniqueness."
}

variable environment

Definition of variable environment from file main.tf

variable "environment" {
  type        = string
  description = "Deployment environment (e.g. dev, staging, production)."
  default     = "dev"
}

variable owner

Definition of variable owner from file main.tf

variable "owner" {
  type        = string
  description = "Team or individual responsible for this bucket."
  default     = "unset"
}

variable tags

Definition of variable tags from file main.tf

variable "tags" {
  type        = map(string)
  description = "Additional tags to apply to all resources."
  default     = {}
}

variable versioning_enabled

Definition of variable versioning_enabled from file main.tf

variable "versioning_enabled" {
  type        = bool
  description = "Enable S3 object versioning on the bucket."
  default     = false
}

terraform projectA:terraform

Definition of terraform projectA:terraform from file main.tf

terraform {
  required_version = ">= 1.3.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = ">= 4.0"
    }
  }
}

resource aws_s3_bucket main

Primary storage bucket for project assets.

Definition of resource aws_s3_bucket main from file s3.tf

resource "aws_s3_bucket" "main" {
  bucket = local.full_bucket_name
  tags   = local.common_tags
}

resource aws_s3_bucket_public_access_block main

Block all public access by default.

Definition of resource aws_s3_bucket_public_access_block main from file s3.tf

resource "aws_s3_bucket_public_access_block" "main" {
  bucket = aws_s3_bucket.main.id

  block_public_acls       = true
  block_public_policy     = true
  ignore_public_acls      = true
  restrict_public_buckets = true
}

resource aws_s3_bucket_server_side_encryption_configuration main

Definition of resource aws_s3_bucket_server_side_encryption_configuration main from file s3.tf

resource "aws_s3_bucket_server_side_encryption_configuration" "main" {
  bucket = aws_s3_bucket.main.id

  rule {
    apply_server_side_encryption_by_default {
      sse_algorithm = "AES256"
    }
  }
}

resource aws_s3_bucket_versioning main

Another Pre Comment

Definition of resource aws_s3_bucket_versioning main from file s3.tf

resource "aws_s3_bucket_versioning" "main" {
  bucket = aws_s3_bucket.main.id

  versioning_configuration {
    status = var.versioning_enabled ? "Enabled" : "Suspended"
  }
}

Module: projectB

resource foo_resource baz

Here is a resource.

… code-block:: shell

rm -rf /somepath

look out :tf:data:foo_data.qux

Definition of resource foo_resource baz from file main.tf

resource "foo_resource" "baz" {
}

resource foo_resource markdown

Here is documentation in Markdown (MyST).

Use it like so:

Also, an hyperlink.

Definition of resource foo_resource markdown from file main.tf

resource "foo_resource" "markdown" {
}

data foo_data qux

Documentation for this data.

Might be somewhat related to :tf:resource:foo_resource.baz.

Definition of data foo_data qux from file main.tf

data "foo_data" "qux" {
}

terraform projectB:terraform

Documentation for terraform/main.tf

• list item 1

• list item 2

Even inline formatting in here is possible. and some link inline link , Internal Link.

Definition of terraform projectB:terraform from file main.tf

terraform {
  required_version = ">= 0.12"
  required_providers {
    foo = {
      source  = "https://registry.acme.com/foo"
      version = ">= 1.0"
    }
  }
}

module foobar

Definition of module foobar from file main.tf

module "foobar" {
  source = "git@github.com:module/path?ref=v7.8.9"
}

module sub

Definition of module sub from file main.tf

module "sub" {

}

variable submodule-input

A very nice input variable in submodule

Definition of variable submodule-input from file sub/variables.tf

variable "submodule-input" {
}

variable some-variable

A very nice input variable

Definition of variable some-variable from file variables.tf

variable "some-variable" {
}

CLI Tools

TFReport

Generate a Terraform documentation report for a module path.

usage: tfreport [-h] [--level LEVEL] [-v] path

Positional Arguments

path

Path to the Terraform module directory.

Named Arguments

--level

Heading level for the generated report (default: 1).

Default: 1

-v, --verbose

Verbosity Controls

Default: []

TFMap

Expand the Terraform Map

usage: tfmapexpand [-h] [-v] map

Positional Arguments

map

Map of Terraform Modules yaml file

Named Arguments

-v, --verbose

Verbosity Controls

Default: []