mirror of https://github.com/opentffoundation/opentf.git synced 2026-02-16 07:01:11 -05:00

Files

Nick Fagerlund 209541aaf0 website: Break up main Modules and Module Development pages

This one is a lot like the previous two commits, but slightly more complex:

- Only adding one new meta-argument page, for `providers`; otherwise, it just
  re-uses the dual-purpose pages I made in the resources commit.

- About that `providers` argument: The stuff that was relevant to consumers of a
  module went in that meta-argument page, but there was also a huge deep dive on
  how the _author_ of a re-usable module should handle provider configurations
  in cases where inheriting the default providers isn't sufficient. THAT, I
  moved into a new page in the module development section. (For the consumer of
  a module, this should all be an implementation detail; the module README
  should tell you which aliased providers you need to configure and pass, and
  then you just do it, without worrying about proxy configuration blocks etc.)

- The "standard module structure" recommendations in the main module development
  page gets a page of its own, to make it more prominent and discoverable.

- Same deal with using the old URL as a landing page, at least for the main
  module calls page. It didn't seem necessary for the module development page.

2020-11-17 16:30:51 -08:00

2.8 KiB

Raw Blame History

layout, page_title

layout	page_title
language	Modules Overview - Configuration Language

Modules

Hands-on: Try the Reuse Configuration with Modules collection on HashiCorp Learn.

Modules are containers for multiple resources that are used together. A module consists of a collection of .tf and/or .tf.json files kept together in a directory.

Modules are the main way to package and reuse resource configurations with Terraform.

The Root Module

Every Terraform configuration has at least one module, known as its root module, which consists of the resources defined in the .tf files in the main working directory.

Child Modules

A Terraform module (usually the root module of a configuration) can call other modules to include their resources into the configuration. A module that has been called by another module is often referred to as a child module.

Child modules can be called multiple times within the same configuration, and multiple configurations can use the same child module.

Published Modules

In addition to modules from the local filesystem, Terraform can load modules from a public or private registry. This makes it possible to publish modules for others to use, and to use modules that others have published.

The Terraform Registry hosts a broad collection of publicly available Terraform modules for configuring many kinds of common infrastructure. These modules are free to use, and Terraform can download them automatically if you specify the appropriate source and version in a module call block.

Also, members of your organization might produce modules specifically crafted for your own infrastructure needs. Terraform Cloud and Terraform Enterprise both include a private module registry for sharing modules internally within your organization.

Using Modules

Module Blocks documents the syntax for calling a child module from a parent module, including meta-arguments like for_each.
Module Sources documents what kinds of paths, addresses, and URIs can be used in the source argument of a module block.
The Meta-Arguments section documents special arguments that can be used with every module, including providers, depends_on, count, and for_each.

Developing Modules

For information about developing reusable modules, see Module Development.

2.8 KiB Raw Blame History