Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.
TerraformArtifactsRegistry Types

Terraform

Create a Terraform registry, generate an identity token, then publish and install private Terraform modules and providers with Terraform or OpenTofu.

Use a Terraform registry to host private Terraform modules and providers. The registry works with both the Terraform CLI and OpenTofu.

What you will learn from this topic

By the end of this quickstart guide, you will be able to:

  • Create a registry in Harness Artifacts.

  • Publish a package to the registry.

  • Install the package from the registry, and confirm the working.

Before you begin

  • Install the Terraform CLI (terraform) or OpenTofu (tofu) on your local machine.

  • Install the Harness CLI (hc). You use it to publish packages to your registry.

  • Make sure you have access to a Harness account with permission to create registries and connectors.

Create a Terraform Registry

To create a Terraform Registry, perform the following steps:

  1. In Artifact Registry, select Registries.

  2. Click + Create Registry.

  3. Specify the Registry name.

Registry name criteria

The registry name must start with a letter, can only contain lowercase alphanumerics, _, ., and -, and must be unique to your Harness account.

  1. Optionally, add a Description.

  2. Choose visibility between Public and Private. The default is Private.

  3. Select Terraform as the Registry type.

  4. Click Save.

  5. Select Create to finalize.

Configure an upstream proxy (optional)

An upstream proxy allows your registry to fetch Terraform modules and providers from external Terraform-protocol registries when they are not available locally. The default upstream is registry.terraform.io.

Create upstream proxy

To create an upstream proxy, perform the following steps:

  1. In Artifact Registry, select Registries.

  2. Click the drop-down next to + Create Registry and select Upstream Proxy.

  3. Specify the Registry name.

  4. Optionally, add a Description.

  5. Choose visibility between Public and Private. The default is Private.

  6. Select Terraform as the Registry type.

  7. Select the Source: Terraform Registry or Custom.

    • If you select Custom, specify the Remote registry URL (for example, https://registry.terraform.io).

  8. Select the Authentication method.

    • Username and password: Specify the username and password. Use an existing secret, or create a new secret by specifying the Name and entering the Secret text.

    • Anonymous: No credentials required. This works for public Terraform registries.

  9. Select Create to finalize.

Configure the upstream proxy in your registry

To configure the upstream proxy in your registry, perform the following steps:

  1. In Artifact Registry, select an existing Terraform artifact registry.

  2. Navigate to the Configuration tab.

  3. Select Edit in the Upstream proxy section.

  4. Click + Add upstream proxy.

  5. Select the required proxy from the list.

  6. Select Apply.

  7. Click Update to finalize.

Upstream proxy caching

If a module or provider is not found in your Harness registry, the upstream proxy fetches it from the remote registry and caches it.

Terraform client setup

In your Harness Terraform Artifact, select the required Terraform registry, and then click Set Up Client. The dialog gives you an identity token, then setup instructions for a module or a provider, using either the Terraform CLI or OpenTofu.

Generate an identity token

An identity token serves as the password for authenticating with the registry.

  1. In your Terraform Artifact Registry, select Set Up Client.

  2. Select Generate Token.

  3. Select an Expiration for the token:

    • 30 Days

    • 90 Days

    • 180 Days

    • Custom

  4. Copy the token. You use it in the following steps in place of <IDENTITY_TOKEN>.

Token expiration

The identity token stops working after the expiration you select. Generate a new token and update your client configuration before the current token expires.

Configure the client

Select Module or Provider for what you want to publish or use, then select Terraform CLI or OpenTofu for your client. In the code samples, replace the values in angle brackets with your own values.

1. Configure ~/.terraformrc

Add the following to ~/.terraformrc:

2. Publish the module

Upload the module directory to the registry:

3. Use the module

Reference the module in your .tf file:

Then initialize your configuration:

1. Configure ~/.tofurc

Add the following to ~/.tofurc:

2. Publish the module

Upload the module directory to the registry:

3. Use the module

Reference the module in your .tf file:

Initialize your configuration:

1. Configure ~/.terraformrc

Add the following to ~/.terraformrc:

2. Publish the provider

Upload a provider binary to the registry:

3. Use the provider

Reference the provider in your .tf file:

Initialize your configuration:

1. Configure ~/.tofurc

Add the following to ~/.tofurc:

2. Publish the provider

Upload a provider binary to the registry:

3. Use the provider

Reference the provider in your .tf file:

Initialize your configuration:

Setup verification

Confirm that your registry serves the package you published. To verify your setup, perform the following steps:

  1. In a new directory with no cached modules, providers, or local Terraform state, use your package client to install or resolve the package you published.

  2. Confirm that the client downloaded the package from your Harness registry address, which is shown in Set Up Client.

  3. In Harness, open your registry and confirm that the package and version appear in the package list.

If a step fails, go to Troubleshooting to resolve common authentication and resolution issues before you retry.

Pipeline automation (optional)

Publishing from a pipeline gives you a repeatable release process. Run the publish step when you create a version tag, so each release maps to one version in the registry.

The following Run step shows the shape of a publish step. Replace <PUBLISH_COMMAND> with the publish command from the steps above. Store the identity token as a Harness secret, and do not write it into the pipeline YAML.

Troubleshooting

A publish to a Terraform registry returns 409 Conflict

Module and provider versions are immutable after publish. Choose a new SemVer version, or delete the existing version only if your registry retention and lifecycle policies allow it.

Package client cannot authenticate to the registry

Check that the registry address in your client configuration matches the one shown in Set Up Client, and that the identity token is the one you generated there. If the token has expired or was revoked, generate a new one and update your client configuration.

Package client cannot find the package

Check that the package name and version match the values you used when you published the package. Also, check that the registry name and account ID in your client configuration are correct.

Client still uses an old version after publishing a new one

Refresh or clear the cache of your package client, and update the version you pinned in your project.

Next steps

Last updated

Was this helpful?