9336c7fba3
As well as some general consolidation and reorganizing, this also includes some updated advice for making the best use of new Terraform v0.12 features to create infrastructure building-blocks. In particular, the "Module Usage" documentation is now consolidated into the configuration section in order to bring all of our general language documentation together, and the top-level "Modules" section is now primarily focused on module _authors_ as an audience, covering topics such as publishing modules and designing them for reuse.
1.5 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| docs | Publishing Modules | docs-modules-publish | A module is a container for multiple resources that are used together. |
Publishing Modules
If you've built a module that you intend to be reused, we recommend publishing the module on the Terraform Registry. This will version your module, generate documentation, and more.
Published modules can be easily consumed by Terraform, and users can constrain module versions for safe and predictable updates. The following example shows how a caller might use a module from the Terraform Registry:
module "consul" {
source = "hashicorp/consul/aws"
}
If you do not wish to publish your modules in the public registry, you can instead use a private registry to get the same benefits.
Distribution via other sources
Although the registry is the native mechanism for distributing re-usable modules, Terraform can also install modules from various other sources. The alternative sources do not support the first-class versioning mechanism, but some sources have their own mechanisms for selecting particular VCS commits, etc.
We recommend that modules distributed via other protocols still use the standard module structure so that it can be used in a similar way to a registry module, or even become a registry module at a later time.