Type '/' to Search

»Adding Public Providers and Modules to the Private Registry

You can add providers and modules from the public Terraform Registry to your Terraform Cloud private registry. The private registry stores a pointer to these public providers and modules so that you can view their data from within Terraform Cloud. This lets you clearly designate which public providers and modules are recommended for the organization and makes their supporting documentation and examples centrally accessible.

Note: Public providers and modules are available in Terraform Enterprise v202012-1 and later. Your instance must allow access to registry.terraform.io and https://yy0ffni7mf-dsn.algolia.net/.

You can add providers and modules through the UI as detailed below or through the Registry Providers API and the Registry Modules API.

»Permissions

All members of an organization can view and use public providers and modules. Members of the owners team and teams with Manage Private Registry permissions can add and delete them from the private registry.

»Adding a Public Provider or Module

Hands-on: Try the Add Public Providers and Modules to your Private Registry tutorial and Share Modules in the Private Registry tutorials on HashiCorp Learn.

To add a public provider or module:

  1. Click Registry in the main navigation bar. The organization's private registry appears with a list of available providers and modules.

    Terraform Cloud screenshot: The "registry" button

  2. Click Search public registry. The Public Registry Search page appears.

    Terraform Cloud screenshot: the Search Public Modules page

  3. Enter any combination of namespaces (e.g. hashicorp), and module or provider names into the search field. You can click Providers and Modules to toggle between lists of providers and modules that meet the search criteria.

  4. Do one of the following to add a provider or module to your private registry:

    • Hover over the provider or module and click + Add. Terraform Cloud screenshot: the "+ Add" button
    • Click the provider or module to view its details and then click Add to Terraform Cloud. Terraform Cloud screenshot: the "+ Add" button

  5. Click Add to organization in the dialog box. Members of your organization can now begin using it from the private registry.

»Removing a Public Provider or Module

Removing a public provider or module from a private registry does not remove it from the public Terraform Registry. Users in the organization will still be able to use the removed provider or module without changing their configurations.

To remove a public provider or module from an organization's private registry:

  1. Click Registry in the main navigation bar. The organization's private registry appears with a list of available providers and modules.

  2. Select the provider or module to view its details, open the Manage for Organization menu, and click Remove from organization (providers) or Delete module (modules). Terraform Cloud screenshot: the delete module button

  3. Enter the provider or module name in the dialog box to confirm and then click Remove (providers) or Delete (modules). The provider or module is removed from the organization's private registry.