Add public providers and modules to the HCP Terraform private registry
You can add providers and modules from the public Terraform Registry to your HCP Terraform private registry. The private registry stores a pointer to these public providers and modules so that you can view their data from within HCP Terraform. 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: Your Terraform Enterprise 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.
To add a public provider or module:
Click Registry. The organization's private registry appears with a list of available providers and modules.
Click Search public registry. The Public Registry Search page appears.
Enter any combination of namespaces (such as 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.
Do one of the following to add a provider or module to your private registry:
- Hover over the provider or module and click + Add.
- Click the provider or module to view its details and then click Add to HCP Terraform.
Click Add to organization in the dialog box. Members of your organization can now begin using it from the private registry.
Enabling and Disabling No-Code Provisioning
Note: No-code provisioning is available in HCP Terraform Plus Edition. Refer to HCP Terraform pricing for details.
You can enable no-code provisioning for public modules after adding them to your registry.
To support the auto-apply workflow, ensure that downstream users can automatically load provider credentials into their new no-code workspaces. You can enable access by either creating a global or project-scoped variable set with the credentials for the module's provider, or by accessing outputs with credentials from other workspaces. Refer to Provider Credentials for more details.
To enable no-code provisioning:
- Verify that the module meets the requirements for no-code provisioning.
- Click the module to view its details.
- Select Enable no-code provisioning from the Manage Module for Organization dropdown.
Your module’s details page now has a No-Code Ready badge to indicate that it supports no-code provisioning.
To disable no-code provisioning, select Disable no-code provisioning from the Manage Module for Organization dropdown. Disabling also removes the No-Code Ready badge from the module’s details page.
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 can still use the removed provider or module without changing their configurations.
To remove a public provider or module from an organization's private registry:
Click Registry. The organization's private registry appears with a list of available providers and modules.
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).
Enter the provider or module name in the dialog box to confirm and then click Remove (providers) or Delete (modules). The provider or module no longer appears in the organization's private registry.