Overview

This directory contains reference documentation for all the Panfactum OpenTofu (Terraform) modules which can be found here.

Module Types

We categorize each module into one of the following types:

• Live: Intended to be deployed directly into your system via Terragrunt.
• Submodule: Intended to be used as child module in your own OpenTofu modules.
• Utility: Intended for internal use by other Panfactum modules. Unstable API and not intended for external use.

Injected Variables

All Panfactum modules comes with the following common variables. These are automatically injected if you are using our Terragrunt scaffolding.

These are not documented on each module's individual reference pages as they are simply used for tagging.

environment

Description: The name of the environment the infrastructure is being deployed into

Type: string

region

Description: The region the infrastructure is being deployed into.

Type: string

extra_tags

Description: Extra tags or labels to add to the created resources.

Type: map(string)

pf_root_module

Description: The name of the root Panfactum module in the module tree.

Type: string

pf_module

Description: The name of the Panfactum module where the containing resources are directly defined.

Type: string

pf_stack_version

Description: Which version of the Panfactum stack is being used (git ref).

Type: string

pf_stack_commit

Description: The commit hash for the version of the Panfactum stack being used.

Type: string

is_local

Description: Whether this module is a part of a local development deployment.

Type: bool