resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

website: finding and using registry modules

This commit is contained in:
Mitchell Hashimoto 2017-08-15 09:27:34 -07:00 committed by Paul Banks
parent 0718e9ce3f
commit 331b6f339a
2 changed files with 60 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
website/docs/registry/modules/use.html.md Normal file
View File

@ -0,0 +1,54 @@
---
layout: "registry"
page_title: "Finding and Using Modules from the Terraform Registry"
sidebar_current: "docs-registry-use"
description: |-
The Terraform Registry is a repository of modules written by the Terraform community.
---
# Finding and Using Modules
The [Terraform Registry](https://registry.terraform.io) makes it simple to
find and use modules.
## Finding Modules
Every page on the registry has a search field for finding
modules. Enter any type of module you're looking for (examples: "vault",
"vpc", "database") and resulting modules will be listed. The search query
will look at module name, provider, and description to match your search
terms. On the results page, filters can be used further refine search results.
By default, only [verified modules](/docs/registry/modules/verified.html)
are shown in search results. Verified modules are reviewed by HashiCorp to
ensure stability and compatibility. By using the filters, you may view unverified
modules as well.
## Using Modules
The Terraform Registry is integrated directly into Terraform. This makes
it easy to reference any module in the registry. The syntax for referencing
a registry module is `namespace/name/provider`. For example:
`hashicorp/consul/aws`.
When viewing a module on the registry on a tablet or desktop, usage instructions
are shown on the right side. The screenshot below shows where to find these.
You can copy and paste this to get started with any module. Some modules may
have required inputs you must set before being able to use the module.
```hcl
module "consul" {
source = "hashicorp/consul/aws"
}
```
## Module Versions
Each module in the registry is versioned. These versions syntactically must
follow [semantic versioning](http://semver.org/). In addition to pure syntax,
we encourge all modules to follow the full guidelines of semantic versioning.
Terraform currently only downloads the latest version of each module. The
next release of Terraform (0.11) will bring full support for constraining
module versions. The registry has required semantic versions since launch
to prepare for this transition shortly after.

8
website/layouts/registry.erb
View File

@ -18,8 +18,12 @@
<a href="/docs/registry/modules/use.html">Finding and Using Modules</a>
</li>
<li<%= sidebar_current("docs-registry-use") %>>
<a href="/docs/registry/modules/use.html">Publishing Modules</a>
<li<%= sidebar_current("docs-registry-publish") %>>
<a href="/docs/registry/modules/publish.html">Publishing Modules</a>
</li>
<li<%= sidebar_current("docs-registry-verified") %>>
<a href="/docs/registry/modules/verified.html">Verified Modules</a>
</li>
</ul>
</li>