Back

DevOps

Terraform Module Cleanup: Retire Modules Nobody Should Use Again

Terraform module cleanup is library deprecation work. The waste is not only unused code; it is old infrastructure patterns that teams can still copy, pin, or instantiate because the module remains available and undocumented.

The useful output is a retirement plan: known consumers, latest safe replacement, migration notes, version freeze, and archive date. Keep the review concrete because breaking teams that still depend on old module versions is an avoidable platform failure.

Key takeaways

  • Treat each cleanup candidate as an owned system with dependencies, not anonymous clutter.
  • Find pinned module sources, registry downloads, examples, and generated stacks before marking a module unused.
  • Prefer reversible changes first when breaking teams that still depend on old module versions is still plausible.
  • Leave behind a module deprecation note with replacement, migration deadline, and blocked-use policy.
  • Measure the result as lower spend, lower risk, less operational drag, or clearer ownership.

Find Consumers Before Archiving

Start with one module registry or repository folder. Search for consumers, examples, scaffolds, and pinned versions before changing visibility or archive status.

FieldWhy it matters
OwnerCleanup needs a person or team that can accept the decision
Current purposeA short reason to keep the item, written in present tense
Last meaningful useRegistry downloads, pinned Git refs, Terragrunt includes, examples, and stack templates
Dependency evidenceRepository search, module registry metadata, platform docs, and owner review
Risk if wrongThe outage, data loss, access failure, or rollback gap the review must avoid
Next actionKeep, reduce, archive, disable, remove, or investigate

Do not make the inventory larger than the decision. A short list with owners and evidence beats a perfect spreadsheet that nobody is willing to act on.

Module Evidence Before Retirement

The useful question is not “how old is it?” It is “what would break, become harder to recover, or lose accountability if this disappeared?” For Terraform module cleanup, collect enough evidence to answer that without relying on naming conventions.

CheckWhat to look forCleanup signal
Source referencesGit URLs, registry addresses, version constraints, and local module pathsNo active stack points at the old module
Replacement qualityNew module parity, migration docs, examples, and tested plan outputTeams have a safe target to move to
Published examplesREADMEs, templates, scaffolds, and internal docsNew users cannot accidentally choose the retired module
Compatibility riskProvider versions, state moves, resource naming, and output changesMigration has known state and API impacts

Use several signals together. Activity can miss monthly jobs and incident-only paths. Ownership can be stale. Cost can distract from security or recovery risk. The strongest case combines runtime data, dependency checks, owner review, and a rollback plan.

If the evidence conflicts, label the item “investigate” with a named owner and review date. That is still progress because the next review starts with a narrower question.

Example Evidence Check

Search infrastructure repositories for active module sources and version pins before declaring the module unused.

rg -n 'source\\s*=\\s*".*(modules/|terraform-).*"' infra/ platform/ environments/
rg -n 'module\\s+"' infra/ platform/ environments/
terraform state list

Repository search finds consumers that still reference the module in code, while terraform state list shows resources already managed through module paths. Neither check proves migration safety; compare the replacement module and plan output before archiving anything.

Deprecate Before Deleting

Use the least permanent move that proves the decision. In Terraform module cleanup, removal is only one possible outcome; reducing size, narrowing permission, shortening retention, archiving, or disabling a trigger may produce the same benefit with less risk.

  • Mark the module deprecated in README and registry metadata before archiving.
  • Freeze releases and block new scaffolds while existing consumers migrate.
  • Keep old tags immutable so teams can reproduce current infrastructure during the transition.

Track the cleanup candidate with a simple priority score:

ScoreGood signBad sign
ImpactMeaningful spend, risk, toil, noise, or confusion disappearsThe item is cheap and low-risk but politically distracting
ConfidenceOwner, purpose, and dependency path are understoodThe team is guessing from age or name
ReversibilityRestore, recreate, re-enable, or rollback path existsDeletion would be the first real test
PreventionA rule can stop recurrenceThe same pattern will return next month

Start with high-impact, high-confidence, reversible candidates. Defer confusing items only if they get an owner and a date; otherwise “defer” becomes another word for keeping waste permanently.

Module Cases That Need Patience

Some cleanup candidates are supposed to look quiet. Do not rush these cases:

  • Modules that create stateful resources such as databases, buckets, DNS zones, or IAM foundations.
  • Modules pinned by customer-specific or regulated environments with slow change windows.
  • Modules whose replacement changes resource addresses and needs moved blocks or import work.

For these cases, use a longer observation window, explicit owner approval, and a staged reduction. The point is not to avoid cleanup; it is to avoid making the first proof of dependency an outage.

Run the Cleanup Review

Run Terraform module cleanup as a decision review, not an open-ended hygiene project.

  1. Pick the narrow scope and export the candidate list.
  2. Add owner, current purpose, last-use evidence, dependency checks, and risk if wrong.
  3. Remove obvious false positives, then ask owners to choose keep, reduce, archive, disable, remove, or investigate.
  4. Apply the least permanent useful change first.
  5. Watch the signals that would reveal a bad decision.
  6. Complete the final removal only after the review window closes.
  7. Save the module deprecation note with consumers, replacement, migration deadline, and archive date.

For broader cleanup planning, use the cleanup library to pair this guide with related notes. If the cleanup has infrastructure impact, pair it with a visible owner, a rollback path, and a measurable business case. For infrastructure cleanup, the main cloud cost optimization checklist is a useful companion.

Prevent Module Sprawl

Prevention should change the creation path, not just the cleanup path. For Terraform module cleanup, the useful prevention fields are owner, reason to exist, removal trigger, and verification notes. Make those fields part of normal creation and review.

  • Require every new module to name a maintainer, supported use case, and deprecation policy.
  • Keep examples and scaffolds pointed at the preferred module so old patterns stop spreading.
  • Review registry modules quarterly for download activity, owner status, and replacement coverage.

The recurring review should be short: sort by impact, pick the unclear items, assign owners, and close the loop on anything nobody claims. If the review keeps producing the same class of candidate, fix the creation path instead of celebrating repeated cleanup.

Example Decision Record

Use a compact record so the cleanup can be reviewed later without reconstructing the whole investigation.

FieldExample entry for this cleanup
CandidateStale Terraform modules in infrastructure repositories
Why it looked staleLow recent activity, unclear owner, or no current consumer after the first review
Evidence checkedOwner trail, Runtime use, and owner confirmation
First reversible moveMark the module deprecated and block new scaffolds before archiving
Watch signalThe metric, alert, job, route, query, or owner complaint that would show the cleanup was wrong
Final actionKeep, reduce, archive, disable, or remove after a window long enough to include scheduled and low-frequency use, not just a quiet afternoon
Prevention ruleRequire owner and review-date metadata at creation time

This record is intentionally small. If the decision needs a long narrative, the candidate is probably not ready for removal yet. Keep investigating until the owner, evidence, reversible move, and prevention rule are clear.

FAQ

How often should teams do Terraform module cleanup?

Use a window long enough to include scheduled and low-frequency use, not just a quiet afternoon for the first decision, then set a recurring cadence based on change rate. Fast-moving non-production systems may need monthly review; slower systems can be quarterly if every unclear item has an owner and a review date.

What is the safest first action?

The safest first action is usually ownership repair plus evidence collection. After that, add or repair ownership metadata before changing anything ambiguous. That creates a visible test before permanent deletion.

What should not be removed quickly?

Do not rush anything connected to rare scheduled work that runs monthly, quarterly, or only during incidents. Also slow down when the cleanup affects recovery, compliance, customer-specific behavior, rare schedules, or security response.

How do you make the decision useful later?

Write the decision as a small operational record: candidate, owner, evidence, chosen action, watch signals, rollback path, final date, and prevention rule. That format helps future engineers, search engines, and AI assistants understand the cleanup without guessing.