ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/docs/language/modules/develop/publish.mdx

42 lines
2.2 KiB
Plaintext
Raw Normal View History

website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
---
migrate docs to mdx
2021-12-15 03:41:17 +01:00
page_title: Publishing Modules
description: A module is a container for multiple resources that are used together.
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
---
Website: 0.13 docs edits, mostly around provider requirements (#25686) * Make sidebar nav in language docs more intuitive * Minor display fixes for registry docs * Explain providers in the registry in the providers index * Revise a bunch of language docs around provider reqs This is mostly an effort to smooth out some of the explanations, make sure things are presented in a helpful order, make sure terminology lines up, draw connections between related concepts, make default behavior more apparent, and the like. It shouldn't include very much new information, but there might be one or two things that came out of a conversation somewhere. Co-authored-by: Judith Malnick <judith@hashicorp.com>
2020-07-31 06:07:36 +02:00
# Publishing Modules
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
If you've built a module that you intend to be reused, we recommend
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[publishing the module](/registry/modules/publish) on the
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
[Terraform Registry](https://registry.terraform.io). This will version
your module, generate documentation, and more.
Published modules can be easily consumed by Terraform, and users can
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[constrain module versions](/language/modules/syntax#version)
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
for safe and predictable updates. The following example shows how a caller
might use a module from the Terraform Registry:
```hcl
module "consul" {
source = "hashicorp/consul/aws"
}
```
If you do not wish to publish your modules in the public registry, you can
migrate docs to mdx
2021-12-15 03:41:17 +01:00
instead use a [private registry](/registry/private) to get
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
the same benefits.
Update publish.html.md (#29671) Updated language around contributing modules with overlapping features in the Publishing Modules section: "We welcome..." (all contributions)
2021-09-29 22:42:54 +02:00
We welcome contributions of Terraform modules from our community members, partners, and customers. Our ecosystem is made richer by each new module created or an existing one updated, as they reflect the wide range of experience and technical requirements of the community that uses them. Our cloud provider partners often seek to develop specific modules for popular or challenging use cases on their platform and utilize them as valuable learning experiences to empathize with their users. Similarly, our community module developers incorporate a variety of opinions and use cases from the broader Terraform community. Both types of modules have their place in the Terraform registry, accessible to practitioners who can decide which modules best fit their requirements.
Website: 0.13 docs edits, mostly around provider requirements (#25686) * Make sidebar nav in language docs more intuitive * Minor display fixes for registry docs * Explain providers in the registry in the providers index * Revise a bunch of language docs around provider reqs This is mostly an effort to smooth out some of the explanations, make sure things are presented in a helpful order, make sure terminology lines up, draw connections between related concepts, make default behavior more apparent, and the like. It shouldn't include very much new information, but there might be one or two things that came out of a conversation somewhere. Co-authored-by: Judith Malnick <judith@hashicorp.com>
2020-07-31 06:07:36 +02:00
## Distribution via other sources
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
Although the registry is the native mechanism for distributing re-usable
modules, Terraform can also install modules from
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[various other sources](/language/modules/sources). The alternative sources
website: Revamped module-authoring docs for Terraform v0.12 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.
2019-03-05 21:18:40 +01:00
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
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[standard module structure](/language/modules/develop/structure) so that they can
website: Update all links to {expressions,modules,resources}.html ...as well as to the standard module structure section in module development.
2020-11-13 03:30:52 +01:00
be used in a similar way as a registry module or be published on the registry
at a later time.