Terraform Pipelines with GitHub Actions¶
Overview¶
Design a GitHub Actions pipeline that runs init → validate → plan on pull requests (with a plan artefact) and a protected apply on main — with remote state outside the runner workspace and clear notes on destroy.
Terraform in Actions automates Infrastructure as Code (IaC): every change is planned in review, then applied under gates. Store remote state with locking (for example Amazon Simple Storage Service (S3) + DynamoDB, Azure Storage, or Google Cloud Storage). Upload the binary plan as a workflow artefact so apply executes what reviewers saw. Never leave state only on the runner disk. Prefer OpenID Connect (OIDC) cloud roles (Modules 5 and 10) over static access keys.
This is a core tutorial in Module 9 · Terraform Pipelines of the REBASH Academy GitHub Actions for Cloud & DevOps Engineers series — written for Cloud, DevOps, Platform, and SRE engineers.
Prerequisites¶
Learning Objectives¶
By the end of this tutorial, you will be able to:
- Sequence init, validate, plan, apply, and optional destroy
- Store plan output as a GitHub Actions artefact for PR review
- Gate apply with a protected environment
- Explain remote state + locking in CI
- Use
TF_IN_AUTOMATIONand non-interactive flags
Architecture¶
This topic’s control points and relationships are shown below.
Theory¶
What it is¶
A Terraform pipeline maps CLI phases onto workflow jobs: fmt/validate and plan -out= on every pull request (read-only / plan privilege); reviewed apply of the saved plan on the default branch behind a protected environment; rare, heavily gated destroy. State lives in a remote backend with locking. Set TF_IN_AUTOMATION=true and -input=false so jobs never prompt. Pin the Terraform CLI version (hashicorp/setup-terraform) so plan and apply use the same binary.
| Concern | Good practice | Risk |
|---|---|---|
| State | Remote + lock | Local state on runner |
| Plan | Artefact tied to commit SHA | Fresh plan at apply with drift |
| Apply | Protected environment + reviewers | Auto-apply on every push |
| Secrets | OIDC / environment secrets | Static admin keys in repository secrets |
Why it matters¶
Laptop apply bypasses review and uses personal cloud keys. Pull-request plans give reviewers a concrete diff; protected apply prevents unreviewed infrastructure changes. Plan artefacts stop “plan on Tuesday, apply Thursday’s different config.” State locking prevents two workflows from corrupting the same workspace. Destroy without dual control can erase production in minutes.
How it works¶
- On pull request: pin Terraform →
init→validate→plan -out=tfplan→ upload artefact (short retention). - Post a human-readable summary (
terraform showor a plan comment action) for reviewers. - On merge to
main(after environment approval): download the same artefact →apply -input=false tfplan. - Destroy jobs are
workflow_dispatchonly, environment-protected, and ideally dual-controlled. - Backend config comes from OIDC cloud roles or environment variables — no secrets in Git.
Prefer apply-of-saved-plan for production. If you must re-plan at apply time, document why and still gate on the new plan.
Key concepts and comparisons¶
| Phase | Trigger | Privilege |
|---|---|---|
| validate / plan | Pull request + main | Read / plan role |
| apply | main + environment | Write role, scoped |
| destroy | Manual dispatch | Break-glass, dual control |
Common pitfalls¶
- Committing
.terraform/orterraform.tfstateto Git. - Applying without the reviewed plan artefact.
- Logging plans that include secret attribute values.
- One shared state key for all environments.
- Fork pull requests with write-level cloud roles (use
pull_request_targetcarefully — prefer OIDC subject conditions that exclude forks).
Hands-on Lab¶
Create a workspace for this tutorial.
mkdir -p ~/rebash-github-actions/module-09/.github/workflows && cd ~/rebash-github-actions/module-09/.github/workflows
Focus: plan/apply workflow with artifact plan and manual apply environment
Step 1 – Terraform null provider + workflow¶
mkdir -p .github/workflows
cat > versions.tf << 'EOF'
terraform {
required_version = ">= 1.5.0"
required_providers {
null = { source = "hashicorp/null", version = "~> 3.2" }
}
}
EOF
cat > main.tf << 'EOF'
resource "null_resource" "lab" {
triggers = { note = "gha-tf-lab" }
}
EOF
cat > .github/workflows/terraform.yml << 'EOF'
name: Terraform
on: [push, workflow_dispatch]
permissions:
contents: read
id-token: write
jobs:
plan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: hashicorp/setup-terraform@v3
- run: terraform init -backend=false
- run: terraform plan -out=plan.cache
- uses: actions/upload-artifact@v4
with:
name: plan
path: plan.cache
apply:
needs: plan
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v4
- uses: hashicorp/setup-terraform@v3
- uses: actions/download-artifact@v4
with:
name: plan
- run: |
terraform init -backend=false
terraform apply -auto-approve plan.cache
EOF
Step 2 – Local plan/destroy if terraform installed¶
if command -v terraform >/dev/null; then
terraform init -backend=false
terraform plan -out=plan.cache
terraform apply -auto-approve plan.cache
terraform destroy -auto-approve
fi
grep -E 'plan.cache|environment: production' .github/workflows/terraform.yml
Final step – Cleanup note¶
terraform destroy -auto-approve 2>/dev/null || true
# Keep ~/rebash-github-actions/ for later tutorials
Validation¶
- Lab commands run under
~/rebash-github-actions/module-09/.github/workflows/ - You can explain each Theory section in your own words
- You used modern tooling where it applies to this topic
- You can describe one production failure mode for this topic
Code Walkthrough¶
Production practice for Terraform Pipelines with GitHub Actions always combines:
- Inspect before you change (status, plan, logs, dry-run)
- Prefer reversible, documented changes (Git, IaC, drop-ins, version pins)
- Capture evidence (command output, pipeline logs) for handovers
- Prefer current tools and APIs over legacy shortcuts
- Least privilege — escalate credentials only when required
Keep runbooks short enough to follow under pressure. Automate checks; keep humans for judgement.
Security Considerations¶
- Treat credentials and tokens for github-actions as privileged — never commit them
- Prefer short-lived auth (OIDC, roles, SSO) over long-lived keys
- Validate blast radius before apply/deploy/delete operations
- Restrict who can approve production changes
- Collect audit logs; limit who can read sensitive traces
Common Mistakes¶
Committing .terraform/ or terraform.tfstate to Git.
Validate assumptions against the Theory section and official docs before changing production.
Applying without the reviewed plan artefact.
Lab shortcuts (open security groups, admin roles, skip approvals) must not ship unchanged.
Changing production without a rollback path
Always know how to revert (previous artefact, prior release, state rollback, DNS failback).
Best Practices¶
- Encode Terraform Pipelines with GitHub Actions changes as code and review them in pull requests
- Pin versions (images, modules, actions, provider plugins)
- Separate environments with clear promotion gates
- Alert on symptoms with runbooks attached
- Destroy lab resources; tag everything with owner and expiry where possible
Troubleshooting¶
| Symptom | Likely cause | Fix |
|---|---|---|
| Auth / permission denied | Wrong identity, policy, or scope | Check caller identity, roles, and least-privilege policies |
| Timeout / no route | Network, DNS, security group, or endpoint | Trace path, DNS, and allow-lists before retrying |
| Drift / unexpected plan | Manual change or wrong state/workspace | Reconcile desired vs actual; avoid click-ops on managed resources |
| Pipeline/job red | Flaky step, cache, or missing secret | Read failing step logs; bisect recent workflow/config changes |
| Cost spike | Idle load balancer, NAT, oversized compute | Inventory billable resources; stop/delete labs promptly |
Summary¶
Terraform Pipelines with GitHub Actions is essential for Cloud and DevOps engineers working with github-actions. Practise the lab until the inspection and change path is muscle memory, then continue the track.
Interview Questions¶
- Why apply the exact plan artifact from the same workflow run?
- What state backend considerations matter in CI?
- When should apply require a GitHub environment approval?
- How do you pass cloud credentials to Terraform in Actions?
- How do you destroy experimental stacks created in labs?
Sample answer — question 2
Confirm init backend, matching variables between plan/apply, and that the plan artifact downloaded correctly.
Sample answer — question 4
Use OIDC-mapped least-privilege roles, protect state, and never commit tfstate. Destroy lab resources in the same session.