Repository files navigation

This template is no longer being maintained and is now archived. We recommend using theterraform-provider-scaffolding-framework template repository built on theTerraform Plugin Framework for new provider development because it offers significant advantages compared to the SDKv2.

This template repository is built on theTerraform Plugin SDK. The template repository built on theTerraform Plugin Framework can be found atterraform-provider-scaffolding-framework.

This repository is atemplate for aTerraform provider. It is intended as a starting point for creating Terraform providers, containing:

• A resource, and a data source (internal/provider/),
• Examples (examples/) and generated documentation (docs/),
• 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 theHashiCorp Learn platform.

Please see theGitHub template repository documentation for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want topublish it on the Terraform Registry so that others can use it.

• Terraform >= 0.13.x
• Go >= 1.18

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Goinstall command:

$ go install

This provider usesGo modules.Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependencygithub.com/author/dependency to your Terraform provider:

go get github.com/author/dependencygo mod tidy

Then commit the changes togo.mod andgo.sum.

Fill this in for each provider

If you wish to work on the provider, you'll first needGo installed on your machine (seeRequirements above).

To compile the provider, rungo install. This will build the provider and put the provider binary in the$GOPATH/bin directory.

To generate or update documentation, rungo generate.

In order to run the full suite of Acceptance tests, runmake testacc.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc