Terragrunt Variables

Folder Setup

Your environments folder at environments_dir must have three levels of scoping for the configuration-as-code:

• environment: A separation of your deployments according to your SDLC conventions (e.g., development, staging, production, etc.)

  • region: A separation of your deployments according to their physical location (e.g., us-west-2)

    • module: A separation of your deployments based on the specific infrastructures module being deployed

Accordingly, there are four levels of configuration for parameterizing the behavior of panfactum.hcl:

• global.yaml: Found at the root of environments_dir

• environment.yaml: Found at the root of each environment subdirectory

• region.yaml: Found at the root of each region subdirectory

• module.yaml: Found in each module subdirectory

A few rules about these files:

• These files are optional, but you will use them to configure your providers and other behavior.

• They can each contain any and every key found below.

• You should commit these files to version control.

• Conflicts are resolved via specificity (e.g., conflicting module.yaml values will override region.yaml values which in turn will override environment.yaml values, etc.).

• Each file has an optional, user-specific counterpart named *.user.yaml (e.g., region.user.yaml).

  • Values in these files override the values in their counterparts for local development purposes (e.g., region.user.yaml overrides values in region.yaml).

  • These files are not committed to version-control; each user will have their own set of values.

Ultimately your environments folder should look something like this:

- environments/
    - global.yaml
    - panfactum.hcl
    - providers/
      - aws.tftpl
      - kubernetes.tftpl
      ***
    - [environment_1]/
      - environment.yaml
      - environment.user.yaml
      - [region_1]/
        - region.yaml
        - region.user.yaml
        - [module_1]/
          - module.yaml
        - [module_2]/
          - module.yaml
      - [region_2]/
        ***
    - [environment_2]/
      - environment.yaml
      - [region_1]/
         ***
      - [region_2]/
        ***

Variables

These are variables that can be found in the global.yaml, environment.yaml, region.yaml or module.yaml files (or their *.user.yaml counterparts) inside the environments directory.

Metadata

Used for consistency across labels and tags.

Inputs

Used to pass extra inputs to all modules in the scope.

Module Source

Used to configure the terraform.source option when deploying a module.

State Backend Setup

Each environment will have its own, independent OpenTofu backend for storing information about the tracked infrastructure resources. We utilize the S3 backend and store the state for each environment inside of that environment's AWS account.

Providers

Some providers have additional configuration values that must be set.

aws Provider

Note: The aws provider is actually a set of two different aws provider configurations: a primary and secondary. The secondary is used in some Panfactum modules to configure things like backups in a secondary region.

kubernetes Provider

vault Provider

authentik Provider