Terrateam config

Terrateam configuration file

Type version-1
File match **/.terrateam/config.yaml **/.terrateam/config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/terrateam-config/latest.json
Source https://raw.githubusercontent.com/terrateamio/terrateam/refs/heads/main/api_schemas/terrat/config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: version-1

Definitions

access-control object
apply_require_all_dirspace_access boolean
Default: true
ci_config_update string[]
enabled boolean
Default: true
files Record<string, string[]>
plan_require_all_dirspace_access boolean
Default: false
policies access-control-policy[]
terrateam_config_update string[]
unlock string[]
access-control-match-list string[]
access-control-policy object
tag_query string required
apply string[]
apply_autoapprove string[]
apply_force string[]
apply_with_superapproval string[]
plan string[]
superapproval string[]
apply-requirements object
checks apply-requirements-checks-1 | apply-requirements-checks-2
create_completed_apply_check_on_noop boolean
Default: false
create_pending_apply_check boolean
Default: true
apply-requirements-checks apply-requirements-checks-1 | apply-requirements-checks-2
apply-requirements-checks-1 object
approved apply-requirements-checks-approved-1 | apply-requirements-checks-approved-2
merge_conflicts object
1 nested properties
enabled boolean
Default: true
status_checks object
2 nested properties
enabled boolean
Default: true
ignore_matching string[]
apply-requirements-checks-2 object[]
apply-requirements-checks-apply-after-merge object
enabled boolean
Default: false
apply-requirements-checks-approved apply-requirements-checks-approved-1 | apply-requirements-checks-approved-2
apply-requirements-checks-approved-1 object
count integer
Default: 1
enabled boolean
Default: false
apply-requirements-checks-approved-2 object
all_of string[]
any_of string[]
any_of_count integer
Default: 1
enabled boolean
Default: false
require_completed_reviews boolean
Default: false
apply-requirements-checks-merge-conflicts object
enabled boolean
Default: true
apply-requirements-checks-status-checks object
enabled boolean
Default: true
ignore_matching string[]
automerge object
delete_branch boolean
Default: false
enabled boolean
Default: false
merge_strategy string
Default: "auto"
Values: "auto" "merge" "rebase" "squash"
require_explicit_apply boolean
Default: false
batch-runs object
enabled boolean
Default: false
max_workspaces_per_batch integer
Default: 1
config-builder object
enabled boolean
Default: false
script string
custom-tags object
branch Record<string, string>
dest_branch Record<string, string>
custom-tags-branch Record<string, string>
default-branch-overrides string[]
destination-branch-name string
destination-branch-object object
branch string required
source_branches string[]
dir object
create_and_select_workspace boolean
Default: true
create_if_missing boolean
Default: false
lock_branch_target string
Values: "all" "dest_branch"
stacks Record<string, object>
tags string[]
when_modified object
5 nested properties
autoapply boolean
autoplan boolean
autoplan_draft_pr boolean
depends_on string
file_patterns string[]
workspaces Record<string, object>
drift-1 object
schedule string required
Values: "hourly" "daily" "weekly" "monthly"
enabled boolean
Default: false
reconcile boolean
Default: false
tag_query string
drift-2 object
schedules Record<string, object> required
enabled boolean
Default: false
drift-schedule object
schedule string required
Values: "hourly" "daily" "weekly" "monthly"
tag_query string required
reconcile boolean
Default: false
window object
2 nested properties
end string required
start string required
engine engine-cdktf | engine-opentofu | engine-terraform | engine-terragrunt | engine-pulumi | engine-fly | engine-custom | engine-other
engine-cdktf object
name string required
Constant: "cdktf"
outputs object
1 nested properties
collect boolean
override_tf_cmd string
tf_cmd string
tf_version string
engine-custom object
name string required
Constant: "custom"
apply string[]
diff string[]
init string[]
outputs string[]
plan string[]
unsafe_apply string[]
engine-fly object
config_file string required
name string required
Constant: "fly"
engine-opentofu object
name string required
Constant: "tofu"
outputs object
1 nested properties
collect boolean
override_tf_cmd string
version string
engine-other Record<string, string | string[]>
engine-pulumi object
name string required
Constant: "pulumi"
engine-terraform object
name string required
Constant: "terraform"
outputs object
1 nested properties
collect boolean
override_tf_cmd string
version string
engine-terragrunt object
name string required
Constant: "terragrunt"
outputs object
1 nested properties
collect boolean
override_tf_cmd string
tf_cmd string
tf_version string
version string
engine-tf-outputs object
collect boolean
gate object
all_of string[]
any_of string[]
any_of_count integer
name string
token string
hook object
post hook-op[]
pre hook-op[]
hook-list hook-op[]
hook-op hook-op-drift-create-issue | hook-op-env-exec | hook-op-env-source | hook-op-oidc | hook-op-run | hook-op-slack | hook-op-gates
hook-op-drift-create-issue object
type string
Constant: "drift_create_issue"
hook-op-env-exec object
cmd string[] required
name string required
type string required
Constant: "env"
method string
Constant: "exec"
sensitive boolean
Default: false
trim_trailing_newlines boolean
Default: true
hook-op-env-source object
cmd string[] required
method string required
Constant: "source"
type string required
Constant: "env"
sensitive boolean
Default: false
hook-op-gates object
cmd string[] required
type string required
Constant: "gates"
env Record<string, string>
run_on string
Values: "failure" "always" "success"
hook-op-oidc hook-op-oidc-aws | hook-op-oidc-gcp
hook-op-oidc-aws object
role_arn string required
type string required
Constant: "oidc"
assume_role_arn string
assume_role_enabled boolean
Default: true
audience string
duration integer
Default: 3600
provider string
Constant: "aws"
region string
Default: "us-east-1"
session_name string
Default: "terrateam"
hook-op-oidc-gcp object
provider string required
Constant: "gcp"
service_account string required
type string required
Constant: "oidc"
workload_identity_provider string required
access_token_lifetime integer
Default: 3600
access_token_subject string
audience string
project_id string
hook-op-run object
cmd string[] required
type string required
Constant: "run"
capture_output boolean
Default: false
env Record<string, string>
ignore_errors boolean
Default: false
on_error array
run_on string
Values: "failure" "always" "success"
visible_on string
Values: "always" "failure" "success"
hook-op-slack object
msg string required
type string required
Constant: "slack"
run_on string
Values: "failure" "always" "success"
integrations object
resourcely object
2 nested properties
enabled boolean required
Default: false
extra_args string[]
notification-policy object
tag_query string required
comment_strategy string
Default: "minimize"
Values: "append" "delete" "minimize"
notifications object
policies notification-policy[]
permission object[]
retry object
backoff number
Default: 1.5
enabled boolean
Default: false
initial_sleep integer
Default: 5
tries integer
Default: 3
run-on string
runs-on
stack-config object
tag_query string required
rules object
4 nested properties
apply_after string[]
auto_apply boolean
modified_by string[]
plan_after string[]
variables Record<string, string>
stack-nested-config object
stacks string[] required
rules object
4 nested properties
apply_after string[]
auto_apply boolean
modified_by string[]
plan_after string[]
variables Record<string, string>
stack-rules object
apply_after string[]
auto_apply boolean
modified_by string[]
plan_after string[]
stack-variables Record<string, string>
stacks object
names Record<string, stack-config | stack-nested-config>
storage-plan-cmd object
fetch string[] required
method string required
Constant: "cmd"
store string[] required
delete string[]
storage-plan-s3 object
bucket string required
method string required
Constant: "s3"
region string required
access_key_id string
delete_extra_args string[]
delete_used_plans boolean
Default: true
fetch_extra_args string[]
path string
secret_access_key string
store_extra_args string[]
storage-plan-terrateam object
method string required
Constant: "terrateam"
tags string[]
terraform-version string
tree-builder object
enabled boolean
Default: false
script string
version-1 object
access_control object
8 nested properties
apply_require_all_dirspace_access boolean
Default: true
ci_config_update string[]
enabled boolean
Default: true
files Record<string, string[]>
plan_require_all_dirspace_access boolean
Default: false
policies access-control-policy[]
terrateam_config_update string[]
unlock string[]
apply_requirements object
3 nested properties
checks apply-requirements-checks-1 | apply-requirements-checks-2
create_completed_apply_check_on_noop boolean
Default: false
create_pending_apply_check boolean
Default: true
automerge object
4 nested properties
delete_branch boolean
Default: false
enabled boolean
Default: false
merge_strategy string
Default: "auto"
Values: "auto" "merge" "rebase" "squash"
require_explicit_apply boolean
Default: false
batch_runs object
2 nested properties
enabled boolean
Default: false
max_workspaces_per_batch integer
Default: 1
checkout_strategy string
Default: "merge"
Values: "merge" "checkout"
config_builder object
2 nested properties
enabled boolean
Default: false
script string
cost_estimation object
3 nested properties
currency string
Default: "USD"
enabled boolean
Default: true
provider string
Default: "infracost"
Values: "infracost"
create_and_select_workspace boolean
Default: true
default_branch_overrides string[]
default_tf_version string
definitions
destination_branches destination-branch-name | destination-branch-object[]
dirs Record<string, object>
drift drift-1 | drift-2
enabled boolean
Default: true
engine engine-cdktf | engine-opentofu | engine-terraform | engine-terragrunt | engine-pulumi | engine-fly | engine-custom | engine-other
hooks object
3 nested properties
all object
2 nested properties
post hook-op[]
pre hook-op[]
apply object
2 nested properties
post hook-op[]
pre hook-op[]
plan object
2 nested properties
post hook-op[]
pre hook-op[]
indexer object
2 nested properties
build_tag string
enabled boolean
Default: false
integrations object
1 nested properties
resourcely object
2 nested properties
enabled boolean required
Default: false
extra_args string[]
notifications object
1 nested properties
policies notification-policy[]
parallel_runs integer
Default: 3
stacks object
1 nested properties
names Record<string, stack-config | stack-nested-config>
storage object
1 nested properties
plans storage-plan-terrateam | storage-plan-cmd | storage-plan-s3
tags object
2 nested properties
branch Record<string, string>
dest_branch Record<string, string>
tree_builder object
2 nested properties
enabled boolean
Default: false
script string
version string
Default: "1"
Constant: "1"
when_modified object
5 nested properties
autoapply boolean
Default: false
autoplan boolean
Default: true
autoplan_draft_pr boolean
Default: true
depends_on string
file_patterns string[]
Default:
[
  "**/*.tf",
  "**/*.tfvars"
]
workflows workflow-entry[]
visible-on string
when-modified object
autoapply boolean
Default: false
autoplan boolean
Default: true
autoplan_draft_pr boolean
Default: true
depends_on string
file_patterns string[]
Default:
[
  "**/*.tf",
  "**/*.tfvars"
]
when-modified-nullable object
autoapply boolean
autoplan boolean
autoplan_draft_pr boolean
depends_on string
file_patterns string[]
workflow-entry object
tag_query string required
apply workflow-op-init | workflow-op-plan | workflow-op-checkov | workflow-op-conftest | workflow-op-apply | workflow-op-opa | hook-op-run | hook-op-slack | hook-op-env-exec | hook-op-env-source | hook-op-oidc | hook-op-gates[]
cdktf boolean
Default: false
engine engine-cdktf | engine-opentofu | engine-terraform | engine-terragrunt | engine-pulumi | engine-fly | engine-custom | engine-other
environment string
integrations object
1 nested properties
resourcely object
2 nested properties
enabled boolean required
Default: false
extra_args string[]
lock_policy string
Default: "strict"
Values: "apply" "merge" "none" "strict"
plan workflow-op-init | workflow-op-plan | workflow-op-checkov | workflow-op-conftest | workflow-op-apply | workflow-op-opa | hook-op-run | hook-op-slack | hook-op-env-exec | hook-op-env-source | hook-op-oidc | hook-op-gates[]
runs_on
terraform_version string
terragrunt boolean
Default: false
workflow-op-apply object
type string required
Constant: "apply"
env Record<string, string>
extra_args string[]
retry object
4 nested properties
backoff number
Default: 1.5
enabled boolean
Default: false
initial_sleep integer
Default: 5
tries integer
Default: 3
workflow-op-checkov object
type string required
Constant: "checkov"
env Record<string, string>
extra_args string[]
gate object
5 nested properties
all_of string[]
any_of string[]
any_of_count integer
name string
token string
ignore_errors boolean
Default: false
run_on string
Values: "failure" "always" "success"
visible_on string
Values: "always" "failure" "success"
workflow-op-conftest object
type string required
Constant: "conftest"
env Record<string, string>
extra_args string[]
gate object
5 nested properties
all_of string[]
any_of string[]
any_of_count integer
name string
token string
ignore_errors boolean
Default: false
run_on string
Values: "failure" "always" "success"
visible_on string
Values: "always" "failure" "success"
workflow-op-init object
type string required
Constant: "init"
env Record<string, string>
extra_args string[]
workflow-op-list workflow-op-init | workflow-op-plan | workflow-op-checkov | workflow-op-conftest | workflow-op-apply | workflow-op-opa | hook-op-run | hook-op-slack | hook-op-env-exec | hook-op-env-source | hook-op-oidc | hook-op-gates[]
workflow-op-opa object
type string required
Constant: "opa"
env Record<string, string>
extra_args string[]
fail_on string
Default: "undefined"
Values: "defined" "undefined"
gate object
5 nested properties
all_of string[]
any_of string[]
any_of_count integer
name string
token string
ignore_errors boolean
Default: false
run_on string
Values: "failure" "always" "success"
visible_on string
Values: "always" "failure" "success"
workflow-op-plan object
type string required
Constant: "plan"
env Record<string, string>
extra_args string[]
mode string
Default: "strict"
Values: "fast-and-loose" "strict"
workspaces Record<string, object>