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 basic Terraform provider, containing:
- A resource and a data source (
internal/provider/
), - Examples (
examples/
) and generated documentation (docs/
), - Miscellaneous meta files.
make
Then commit the changes to go.mod
and go.sum
.
TBD
To compile the provider, run
make install
This will build the provider and put the provider binary in the $GOPATH/bin
directory.
Terraform does not yet know about our local provider, so run the following in the root of the project to create and source a Terraform config file:
eval $(./setup.sh)
After that you may try one of the examples:
cd examples/provider
terraform plan
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.
But we will be running the acceptance tests against a local development deploy through docker compose
.
make start-api
make testacc
make stop-api