Private Registry

Note

Private registry publishing and curation are configured and managed by platform operators — see the Administration Guide: Private registry management.

Discovering Terraform Modules and Providers

Whether novice or expert, your Terraform practitioners benefit from an easy-to-use interface to the private registry instance. The discovery of Terraform modules and providers is done from the TFC interface by selecting the Registry entry in the left panel.

The web interface is designed to speed discovery. It features tabs to select either the “Modules” or the “Providers” view.

The “Modules” view features a flexible filter that allows users to select modules by provider, source (from the public or private registry), and publishing mode (tags-based or branch-based). The list can also be restricted to show only “no-code ready” modules.

The web interface allows quick access to a number of useful information about a module, such as:

The module’s README documentation
Input variables
Output variables
Dependencies
Resource types created
Configuration snippet (which can be copied into the clipboard in a single click)
Module download statistics
The Terraform Configuration Designer

The “Providers” view is simpler and provides a paginated list of available providers.

The web interface allows quick access to a number of useful information about a module, such as:

Module documentation
Provider download statistics
Source VCS repository
Configuration snippet (which can be copied into the clipboard in a single click)

Consuming Terraform Modules or Providers

Consuming Terraform modules or providers is relatively simple:

Find the relevant module or providers in the private registry.
Use them in your Terraform configuration

As a user of Terraform modules and providers, you should use version constraints because they are an easy way to avoid breaking changes that could happen if you always use the latest version. But you should also:

Monitor the modules and providers you are using for deprecation notices.
Set aside time to upgrade to a newer version of the module or provider before its deprecation is effective.
Volunteer applicable feedback and lessons learned to the module or provider author(s) so that they can be improved for your use cases.