README.md

Terraform modules

pihole

• add Project IAM Admin role in Google Cloud Console (GCP) to the Terraform service account
• create new key for the service account in GCP
• add credentials for Terraform

Development

Required software:

• Terraform
• pre-commit
• tflint
• terraform-docs
• Checkov

pre-commit

This repository uses pre-commit hooks. Please install it during development and install hooks after every git clone:

pre-commit install --install-hooks
pre-commit run --all-files

It is also used in the Pre-commit run GitHub workflow, which serves as a Required status check to validate the contents of the entire repository. If any changes are made during the workflow run, it automatically creates a pull request.

Run

Enter module directory, initialize, plan and apply the module:

cd modules/$MODULE_NAME

terraform init
terraform plan
terraform apply

Test

Execute unit tests in module's tests directory:

cd modules/$MODULE_NAME

terraform test

Dependencies

Dependencies are maintained by Dependabot. Its configuration can be found in dependabot.yml.

NOTE: Make sure it is enabled in the repository Settings.

Releases

Module is versioned and released as a "GitHub Release" by release-please. Its configuration can be found in:

• release-please.yml
• release-please-config.json

NOTE: New versions should not be created manually.