Follow the steps of the Terraform plugin framework tutorial.

Austin Valle 9b24243a86 [COMPLIANCE] Add copyright and license headers (#146) 1 year ago
.github d29beb059c Bump golangci/golangci-lint-action from 3.4.0 to 3.5.0 (#145) 1 year ago
docs be04f08750 resource/example: Add defaulted attribute (#136) 2 years ago
examples a64a312802 Initial commit 3 years ago
internal 9b24243a86 [COMPLIANCE] Add copyright and license headers (#146) 1 year ago
tools 9b24243a86 [COMPLIANCE] Add copyright and license headers (#146) 1 year ago
.copywrite.hcl 9b24243a86 [COMPLIANCE] Add copyright and license headers (#146) 1 year ago
.gitignore a64a312802 Initial commit 3 years ago
.golangci.yml fa8056ce94 ci: add `golangci-lint` + fix lints (#120) 2 years ago
.goreleaser.yml a64a312802 Initial commit 3 years ago
CHANGELOG.md a64a312802 Initial commit 3 years ago
GNUmakefile a64a312802 Initial commit 3 years ago
LICENSE b2ba5a3d22 [COMPLIANCE] Update MPL 2.0 LICENSE (#93) 2 years ago
README.md 9e6b608eb9 Updating to Go 1.19 (#129) (#130) 2 years ago
go.mod c92760accd Bump github.com/hashicorp/terraform-plugin-log from 0.8.0 to 0.9.0 (#144) 1 year ago
go.sum c92760accd Bump github.com/hashicorp/terraform-plugin-log from 0.8.0 to 0.9.0 (#144) 1 year ago
main.go 9b24243a86 [COMPLIANCE] Add copyright and license headers (#146) 1 year ago
terraform-registry-manifest.json a64a312802 Initial commit 3 years ago

README.md

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 (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 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.

Requirements

Building The Provider

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

    go install
    

Adding Dependencies

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 go.mod and go.sum.

Using the provider

Fill this in for each provider

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

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

To generate or update documentation, run go generate.

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

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

make testacc