Terraform Provider Scaffolding (Terraform Plugin Framework)
This template repository is built on the Terraform Plugin Framework. The template repository built on the Terraform Plugin SDK can be found at terraform-provider-scaffolding. See Which SDK Should I Use? in the Terraform documentation for additional information.
This repository is a template for a Terraform provider. It is intended as a starting point for creating Terraform providers, containing:
- A resource and a data source (
- Examples (
examples/) and generated documentation (
- Miscellaneous meta files.
These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the HashiCorp Learn platform. Terraform Plugin Framework specific guides are titled accordingly.
Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.
Once you’ve written your provider, you’ll want to publish it on the Terraform Registry so that others can use it.
Building The Provider
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.
To add a new dependency
github.com/author/dependency to your Terraform provider:
go get github.com/author/dependency go mod tidy
Then commit the changes to
Using the provider
Fill this in for each provider
Developing the Provider
To compile the provider, run
go install. This will build the provider and put the provider binary in the
To generate or update documentation, run
In order to run the full suite of Acceptance tests, run
Note: Acceptance tests create real resources, and often cost money to run.