Skip to main content
0 reactions

How to Find Provider Docs on the OpenTofu Registry

The hashicorp/local provider page on the OpenTofu Registry: the menu with Overview, Resources, Data Sources and Functions on the left, the owner, publish date, repository and MPL-2.0 licence in the middle, and the Versions list on the right with v2.9.1 marked Latest.
The provider page: its menu, its details and its versions.

Every provider documents its settings and resources on the OpenTofu® Registry, at search.opentofu.org (opens in a new tab). This guide finds the docs for one provider, opens a resource’s page, reads its arguments and switches to the docs for an older version.

The example is the hashicorp/local provider, which writes files. The steps are the same for every provider.

Prerequisites

  • A web browser. You don’t need an account.

Step 1: Search for the Provider

Open search.opentofu.org (opens in a new tab) and type the provider’s name in the search box, here hashicorp/local. Results appear as you type, grouped into providers, resources, data sources and modules:

The search box of the OpenTofu Registry with hashicorp/local typed in, and the Providers results listing hashicorp/aws and hashicorp/local.
Search for the provider on search.opentofu.org.

Step 2: Open the Provider’s Docs

Click hashicorp/local under Providers. A preview opens on the right. Click View Full Docs:

The OpenTofu Registry search with hashicorp/local selected in the results and its preview on the right, showing the title hashicorp/local, the label Provider, a View Full Docs button and the heading Local Provider.
Select the provider, then click View Full Docs.

The provider page shows the menu of its docs on the left, its owner, repository and licence in the middle, and its versions on the right:

The hashicorp/local provider page on the OpenTofu Registry: the menu with Overview, Resources, Data Sources and Functions on the left, the owner, publish date, repository and MPL-2.0 licence in the middle, and the Versions list on the right with v2.9.1 marked Latest.
The provider page: its menu, its details and its versions.

Under the versions, Use this provider gives the exact required_providers block to add to your project:

The Use this provider box on the OpenTofu Registry, which says Add this to your configuration and run tofu init, above a terraform block that requires hashicorp/local version 2.9.1 and an empty provider local block.
Use this provider shows the code to add the provider.

Step 3: Open a Resource’s Page

In the menu on the left, click Resources, then file. The menu lists resources without the provider’s name, so file is the local_file resource:

The local_file resource page on the OpenTofu Registry, opened from Resources then file in the menu on the left, with the heading local_file (Resource), the line Generates a local file with the given content, and notes about the resource.
Resources › file opens the local_file page.

Step 4: Read the Arguments

Scroll down, or click Schema under On this page. Required lists the arguments you must set, Optional the ones you may set, and Read-Only the values the provider reports back:

The Schema section of the local_file page, listing filename under Required and content, content_base64, directory_permission and file_permission under Optional, each with its type and a description.
Schema lists every argument, required first.

Step 5: Read the Docs for Your Version

The docs open at the latest version. If your project uses an older one, open its line under Older versions on the right, here v2.x, and click the version, such as v2.8.0. The page and the Use this provider box switch to that version:

The Versions panel on the OpenTofu Registry with v2.x opened and v2.8.0 selected, and below it the Use this provider box now showing version 2.8.0.
Pick a version to read the docs for that version.

Tip: Your project’s version is in its .terraform.lock.hcl file, on the version line of each provider.

FAQ

Some pages mention Terraform. Do they apply to OpenTofu?

Yes. Many providers were written for Terraform before OpenTofu existed, and their docs still say Terraform. OpenTofu runs the same providers, so the instructions apply to it too.

Do I need an account?

No. The registry is free to search and read.

Conclusion

The OpenTofu Registry has every provider’s docs in one place: search, open the provider, pick a resource, read its Schema, and match the version to your project.

Additional Resources

OpenTofu® is a registered trademark of LF Projects, LLC. Terraform and other names mentioned are trademarks of their respective owners. JD Bots isn’t affiliated with or endorsed by the OpenTofu project or HashiCorp.

0 comments