Terraform: Allow deprecation of a module

Created on 31 Mar 2016  路  2Comments  路  Source: hashicorp/terraform

Since modules can become a critical part of an application/infrastructure and there can be more users using them than is the other capable of tracking it would be useful to have a mechanisms of deprecating a module.

Essentially I'm thinking of something like this:

deprecated {
  message = "This module is deprecated, see alternative at github.com/.../..."
}

which could cause terraform get (and possibly apply) to display predefined message in the terminal

WARN: This module is deprecated, see alternative at github.com/.../...
config enhancement

Most helpful comment

Any ideas on when / if this is going to be deployed? This would be superbly helpful for correctly implimented modules that use Git for their references.

We're currently trying to deprecate some old modules, and allow people to move to new ones without implimenting breaking changes to force them to. This would be 馃憣

All 2 comments

With terraform configuration blocks being used to drive versions required to use a module would this make more sense to live inside that block?

I was thinking something like:

terraform {
  required_version = ">= 0.9"
  deprecated {
    message = "This module is deprecated, see alternative at github.com/.../..."
  }
}

Any ideas on when / if this is going to be deployed? This would be superbly helpful for correctly implimented modules that use Git for their references.

We're currently trying to deprecate some old modules, and allow people to move to new ones without implimenting breaking changes to force them to. This would be 馃憣

Was this page helpful?
0 / 5 - 0 ratings