Administration: Registry Sharing
Site administrators can share modules and providers from an organization's private registry with other organizations in the same Terraform Enterprise instance. This allows other organizations to use these modules and providers in their Terraform configuration without needing to ingress or maintain the modules or providers themselves.
There are two ways to share between organizations:
- Global sharing: modules and providers from an organization are available to all other organizations in that Terraform Enterprise instance
- Partnership sharing: modules and providers from an organization are available to a specific set of organizations in that Terraform Enterprise instance
Note: The two sharing options are mutually exclusive, so turning one on will turn the other one off. This means that if you have configured a set of partnerships for an organization, they will be lost if you switch that organization to use global sharing.
API: Refer to the Admin Organizations API.
To access the list of shared registries in the Terraform Enterprise instance, click Registry.
Click on Select organization to choose the organization that contains the modules or providers to share. Type the name of the sharing organization or select it from the drop-down.
Once you select the sharing organization, you can configure the sharing type.
To share the organization's modules or providers with all other organizations in the Terraform Enterprise instance, click the toggle switch next to Share modules with all organizations or Share providers with all organizations.
Click Share registry to save the sharing settings. You will be redirected to the initial registry sharing page, which now shows the organization sharing its registry with "All organizations".
To share the organization's modules or providers with a limited group of organizations, the corresponding toggle should be turned off. Add a list of consuming organizations by clicking on the dropdown below and selecting the name(s) of the organizations who will be able to access modules or providers from the sharing organization. If you have many organizations in the dropdown, you can start typing the name to filter the list.
Once you have selected a list of organizations to share with, click Share registry to save the sharing settings. You will be redirected to the initial registry sharing page, which now shows how many organizations the organization is sharing its registry with.
Important: Removing or changing existing sharing settings can break Terraform workspaces for organizations that are using shared modules or providers. Proceed with caution!
To stop sharing modules or providers from the Registry page, click on the three dots next to any organization that's currently sharing modules or sharing providers.
Click Stop sharing. You will be prompted to confirm the action by typing in the name of the organization.
If you wish to change sharing settings for an organization, from the Registry page, click on the three dots next to any organization that's currently sharing modules or providers. Click Edit sharing and you will be able to modify the sharing settings for that organization. For example, you may wish to:
- Share with an additional organization (add a consumer)
- Stop sharing with an organization (remove a consumer)
- Change an organization from partnership sharing to global sharing