|
| 1 | +# Terraform Provider Scaffolding (Terraform Plugin Framework) |
| 2 | + |
| 3 | +_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._ |
| 4 | + |
| 5 | +This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing: |
| 6 | + |
| 7 | +- A resource and a data source (`internal/provider/`), |
| 8 | +- Examples (`examples/`) and generated documentation (`docs/`), |
| 9 | +- Miscellaneous meta files. |
| 10 | + |
| 11 | +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 Developer](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework) platform. _Terraform Plugin Framework specific guides are titled accordingly._ |
| 12 | + |
| 13 | +Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub. |
| 14 | + |
| 15 | +Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://developer.hashicorp.com/terraform/registry/providers/publishing) so that others can use it. |
| 16 | + |
| 17 | +## Requirements |
| 18 | + |
| 19 | +- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0 |
| 20 | +- [Go](https://golang.org/doc/install) >= 1.24 |
| 21 | + |
| 22 | +## Building The Provider |
| 23 | + |
| 24 | +1. Clone the repository |
| 25 | +1. Enter the repository directory |
| 26 | +1. Build the provider using the Go `install` command: |
| 27 | + |
| 28 | +```shell |
| 29 | +go install |
| 30 | +``` |
| 31 | + |
| 32 | +## Adding Dependencies |
| 33 | + |
| 34 | +This provider uses [Go modules](https://github.com/golang/go/wiki/Modules). |
| 35 | +Please see the Go documentation for the most up to date information about using Go modules. |
| 36 | + |
| 37 | +To add a new dependency `github.com/author/dependency` to your Terraform provider: |
| 38 | + |
| 39 | +```shell |
| 40 | +go get github.com/author/dependency |
| 41 | +go mod tidy |
| 42 | +``` |
| 43 | + |
| 44 | +Then commit the changes to `go.mod` and `go.sum`. |
| 45 | + |
| 46 | +## Using the provider |
| 47 | + |
| 48 | +Fill this in for each provider |
| 49 | + |
| 50 | +## Developing the Provider |
| 51 | + |
| 52 | +If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above). |
| 53 | + |
| 54 | +To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. |
| 55 | + |
| 56 | +To generate or update documentation, run `make generate`. |
| 57 | + |
| 58 | +In order to run the full suite of Acceptance tests, run `make testacc`. |
| 59 | + |
| 60 | +*Note:* Acceptance tests create real resources, and often cost money to run. |
| 61 | + |
| 62 | +```shell |
| 63 | +make testacc |
| 64 | +``` |
0 commit comments