Terragrunt

“ignore” defines rules to exclude matching Terraform modules from the autodiscovery.

remark:

• a Terraform module is ignored when it matches at least one rule.

“modules” defines the Terraform modules to match, keyed by module source as written in the Terragrunt files.

remark:

• a Git source matches every module whose source starts with it.
• a “tfr://” registry source can omit its trailing parts to match a whole registry or namespace.
• an empty value matches any version.
• otherwise the value is a semantic version constraint, such as “>=1.0.0”.
• when the version or the constraint cannot be parsed, the value must equal the version.

example:

modules:
  # ignore every module from a registry
  tfr://registry.opentofu.org:
  # ignore a specific module
  tfr:///terraform-aws-modules/rdss/aws:
  # ignore the versions matching this constraint
  git@github.com:hashicorp/exampleLongNameForSorting.git: "1.x"

“path” defines a Terragrunt file path pattern.

remark:

• the pattern must match the whole path, not just a substring.
• the pattern follows the Go filepath.Match syntax, such as “*” or “?”.

“only” defines rules to restrict the autodiscovery to matching Terraform modules.

remark:

• a Terraform module is kept only when it matches at least one rule.

“modules” defines the Terraform modules to match, keyed by module source as written in the Terragrunt files.

remark:

• a Git source matches every module whose source starts with it.
• a “tfr://” registry source can omit its trailing parts to match a whole registry or namespace.
• an empty value matches any version.
• otherwise the value is a semantic version constraint, such as “>=1.0.0”.
• when the version or the constraint cannot be parsed, the value must equal the version.

example:

modules:
  # ignore every module from a registry
  tfr://registry.opentofu.org:
  # ignore a specific module
  tfr:///terraform-aws-modules/rdss/aws:
  # ignore the versions matching this constraint
  git@github.com:hashicorp/exampleLongNameForSorting.git: "1.x"

“path” defines a Terragrunt file path pattern.

remark:

• the pattern must match the whole path, not just a substring.
• the pattern follows the Go filepath.Match syntax, such as “*” or “?”.

“rootdir” defines the directory where the crawler starts searching for Terragrunt “.hcl” files.

default: the scm directory when “scmid” is set, otherwise the directory relative paths resolve from, by default the working directory.

remark:

• a relative path is resolved from the default directory.
• an absolute path is used as is, instead of the scm directory.

“token” defines the token used for Git authentication when accessing private module repositories.

default: empty, no authentication, which suits public repositories.

remark:

• it works with any Git provider, such as GitHub, GitLab, Bitbucket or Gitea.
• it must be set for private repositories.
• it is only used for modules whose source is a Git repository.
• use a template function to read it from the environment, such as {{ requiredEnv "GITLAB_TOKEN" }}.

example:

• token: “ghp_xxxxxxxxxxxx”
• token: “glpat-xxxxxxxxxxxx”
• token: “{{ requiredEnv "GITLAB_TOKEN" }}”

“username” defines the username used for Git authentication when accessing private module repositories.

default: “oauth2”, which matches the GitHub scm plugin and is required for go-git HTTP basic authentication.

remark:

• it works with any Git provider, such as GitHub, GitLab, Bitbucket or Gitea.
• it is only used when “token” is set.
• with a token, the username is usually a placeholder since the token identifies the user.
• common values are “oauth2”, “x-access-token”, “git”, or a real username.
• use a template function to read it from the environment, such as {{ requiredEnv "GIT_USERNAME" }}.

example:

• username: “git”
• username: “oauth2”
• username: “{{ requiredEnv "GIT_USERNAME" }}”

“versionfilter” defines the version filter used by the generated manifests.

default: kind “semver” with pattern “*”, any version greater than or equal to the current one.

remark:

• with kind “semver”, “pattern” accepts:
  • “prerelease”: the latest prerelease of the current version.
  • “patch”: patch updates only.
  • “minor”: patch and minor updates.
  • “minoronly”: minor updates only.
  • “major”: patch, minor and major updates.
  • “majoronly”: major updates only.
  • a version constraint, such as “>= 1.0.0”.
• with kind “regex”, “pattern” accepts a regular expression.
• more examples at https://www.updatecli.io/docs/core/versionfilter/

example:

versionfilter:
  kind: semver
  pattern: minor

“kind” defines the versioning scheme used to select a version.

default: latest

remark:

• accepted values are “latest”, “semver”, “regex”, “regex/semver”, “time”, “regex/time”, “lex” and “pep440”.
• “latest” returns the last version of the list.
• “lex” sorts the versions lexicographically and returns the last one.
• “pep440” follows https://peps.python.org/pep-0440/

example:

• kind: semver

“pattern” defines the version pattern, according to “kind”.

default:

• latest: “latest”
• semver and pep440: “*”
• regex: “.*”
• time and regex/time: “2006-01-02”

remark:

• for “latest”, “latest” returns the last version, any other value must match a version exactly.
• for “semver” and “regex/semver”, it is a semantic versioning constraint.
• for “pep440”, it is a pep440 version specifier.
• for “regex”, it is a regular expression.
• for “time” and “regex/time”, it is a Go date layout.
• ignored by “lex”.

example:

• pattern: ~1.2
• pattern: “>=1.0.0 <2.0.0”
• pattern: ^v\d+.\d+.\d+$

“regex” defines the regular expression extracting the version from each entry.

remark:

• only used by the kinds “regex/semver” and “regex/time”.
• the value of the first capture group is used as the version.

example:

• regex: ^v(\d+.\d+.\d+)$

“replaceall” applies a regular expression replacement to each version before filtering.

remark:

• only used by the kinds “regex”, “regex/semver” and “regex/time”.
• the replacement runs before “pattern” or “regex” is evaluated.

example:

replaceall:
  pattern: "_"
  replacement: "."

turns “curl-8_15_0” into “curl-8.15.0”.

“pattern” defines the regular expression matching the text to replace.

example:

• pattern: “_”

“replacement” defines the text replacing each match of “pattern”.

remark:

• capture groups can be referenced with $1, $2, and so on.

example:

• replacement: “.”

“strict” enforces strict semantic versioning rules when parsing versions.

default: false

remark:

• only used by the kinds “semver” and “regex/semver”.