tfaction-root.yaml

Type: object

tfaction-root.yaml

root target_groups
Type: array of object

the list of target group configuration

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root target_groups target_groups items
Type: object

target group configuration

root target_groups target_groups items working_directory
Type: string

the prefix of the working directory path

root target_groups target_groups items target
Type: string

the prefix of the target

root target_groups target_groups items aws_assume_role_arn
Type: string

AWS Assume Role ARN

root target_groups target_groups items aws_region
Type: string

AWS Region. This is used for AWS OIDC Authentication, Getting Secrets from AWS Secrets Manager, and so on

root target_groups target_groups items aws_secrets_manager
Type: array of object

list of AWS Secrets Manager's secret and exported environment variables

 No Additional Items

Each item of this array must be:

root target_groups target_groups items aws_secrets_manager aws_secrets_manager items
Type: object

target group configuration

root target_groups target_groups items aws_secrets_manager aws_secrets_manager items envs
Type: array of object

exported environment variables

 No Additional Items

Each item of this array must be:

root target_groups target_groups items aws_secrets_manager aws_secrets_manager items envs envs items
Type: object

exported environment variable

root target_groups target_groups items drift_detection
Type: object

root target_groups target_groups items drift_detection enabled
Type: boolean Default: "false"

If true, drift detection is enabled in the target group

root target_groups target_groups items envs
Type: object

environment variables

root target_groups target_groups items gcp_service_account
Type: string

GCP Service Account

root target_groups target_groups items gcp_workload_identity_provider
Type: string

GCP Workload Identity Provider

root target_groups target_groups items gcp_access_token_scopes
Type: string

List of OAuth 2.0 access scopes to be included in the generated token for authenticating to Google Cloud

root target_groups target_groups items gcs_bucket_name_tfmigrate_history
Type: string

GCS Bucket name to store tfmigrate History files

root target_groups target_groups items providers_lock_opts
Type: string Default: "-platform=windows_amd64 -platform=linux_amd64 -platform=darwin_amd64"

terraform providers lock command's option

root target_groups target_groups items runs_on
Type: object

The type of runner that the job will run on

root target_groups target_groups items runs_on anyOf item 0
Type: string
root target_groups target_groups items runs_on anyOf item 1
Type: array of string
No Additional Items

Each item of this array must be:

root target_groups target_groups items runs_on anyOf item 1 item 1 items
Type: string

root target_groups target_groups items s3_bucket_name_tfmigrate_history
Type: string

S3 Bucket name to store tfmigrate History files

root target_groups target_groups items secrets
Type: array of object

list of exported GitHub Secrets

 No Additional Items

Each item of this array must be:

root target_groups target_groups items secrets secrets items
Type: object

exported GitHub Secret

root target_groups target_groups items secrets secrets items env_name
Type: string Default: "the value of 'secret_name'"

exported environment variable

root target_groups target_groups items secrets secrets items secret_name
Type: string Default: "the value of 'env_name'"

exported GitHub Secret name

root target_groups target_groups items template_dir
Type: string

the template directory path to scaffold a working directory

root target_groups target_groups items terraform_plan_config
Type: object

configuration which is used in the job for 'terraform plan'

root target_groups target_groups items terraform_plan_config aws_region
Type: string

AWS Region. This is used for AWS OIDC Authentication, Getting Secrets from AWS Secrets Manager, and so on

Same definition as aws_region

root target_groups target_groups items terraform_plan_config gcp_access_token_scopes
Type: string

List of OAuth 2.0 access scopes to be included in the generated token for authenticating to Google Cloud

Same definition as gcp_access_token_scopes

root target_groups target_groups items terraform_plan_config secrets
Type: array of object

list of exported GitHub Secrets

Same definition as secrets

root target_groups target_groups items terraform_plan_config aws_secrets_manager
Type: array of object

list of AWS Secrets Manager's secret and exported environment variables

Same definition as aws_secrets_manager

root target_groups target_groups items terraform_plan_config runs_on
Type: object

The type of runner that the job will run on

Same definition as runs_on

root target_groups target_groups items terraform_apply_config
Type: object

configuration which is used in the job for 'terraform apply'

Same definition as terraform_plan_config

root target_groups target_groups items tfmigrate_plan_config
Type: object

configuration which is used in the job for 'tfmigrate plan'

Same definition as terraform_plan_config

root target_groups target_groups items tfmigrate_apply_config
Type: object

configuration which is used in the job for 'tfmigrate apply'

Same definition as terraform_plan_config

root aqua
Type: object

configuration about aqua

root aqua update_checksum
Type: object

root aqua update_checksum enabled
Type: boolean Default: "false"

If true, update-checksum is enabled.

root aqua update_checksum prune
Type: boolean Default: "false"

update-checksum-action's prune

root aqua update_checksum skip_push
Type: boolean Default: "false"

update-checksum-action's skip_push

root base_working_directory
Type: string Default: "current directory"

tfaction searches working directories in this directory

root conftest_policy_directory
Type: string Default: "policy"

Conftest policy directory

root draft_pr
Type: boolean Default: false

If this is true, tfaction creates pull requests as draft

root drift_detection
Type: object

Drift Detection

root drift_detection enabled
Type: boolean Default: "true"

If true, drift detection is enabled in all working directories

root drift_detection issue_repo_name
Type: string Default: "Repository where GitHub Actions is run"

Repository name of GitHub Issues

root drift_detection issue_repo_owner
Type: string Default: "Repository where GitHub Actions is run"

Repository owner of GitHub Issues

root drift_detection minimum_detection_interval
Type: integer Default: 168

The scheduled workflow picks out working directories whose issues were updated before minimum_detection_interval hours

root drift_detection num_of_issues
Type: integer Default: 1

The number of issues that scheduled job handles

root envs
Type: object

environment variables

Same definition as envs

root label_prefixes
Type: object

Pull Request label prefixes

root label_prefixes target
Type: string Default: "target:"

Pull Request label prefix to specify the target

root label_prefixes tfmigrate
Type: string Default: "tfmigrate:"

Pull Request label prefix to specify the tfmigrate target

root label_prefixes skip
Type: string Default: "skip:"

Pull Request label prefix to skip terraform plan and apply. This is used to migrate states across states with tfmigrate

root providers_lock_opts
Type: string Default: "-platform=windows_amd64 -platform=linux_amd64 -platform=darwin_amd64"

terraform providers lock command's option

Same definition as providers_lock_opts

root renovate_login
Type: string Default: "renovate[bot]"

Renovate App login

root renovate_terraform_labels
Type: array of string

This attribute is ignored if skip_terraform_by_renovate is false. If any one of labels in renovate_terraform_labels is set to the pull request, tfaction would run terraform plan and terraform apply. Detail

 No Additional Items

Each item of this array must be:

root renovate_terraform_labels renovate_terraform_labels items
Type: string

Pull Request label name

root scaffold_working_directory
Type: object

configuration about scaffold-working-directory

root scaffold_working_directory skip_adding_aqua_packages
Type: boolean Default: "false"

If true, creating aqua.yaml and adding packages is skipped

root skip_create_pr
Type: boolean Default: false

If this is true, tfaction skips creating pull requests. Detail

root skip_terraform_by_renovate
Type: boolean Default: false

If this is true, terraform plan and terraform apply are skipped in case of pull request by Renovate. Detail

root tflint
Type: object

root tflint enabled
Type: boolean Default: "true"

If true, test action runs tflint

root tfsec
Type: object

root tfsec enabled
Type: boolean Default: "true"

If true, test action runs tfsec

root trivy
Type: object

root trivy enabled
Type: boolean Default: "false"

If true, test action runs Trivy

root working_directory_file
Type: string Default: "tfaction.yaml"

working directory configuration file name