Warning
This provider is in progress and is not yet ready for use.
- We are using the Terraform Plugin Framework.
- Main tutorial Hashicups.
- 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 Developer 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.
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
install
command:
go install
Fill this in for each 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.
You need to override some terraform configuration by adding to your ~/.terraformrc
configuration:
provider_installation {
dev_overrides {
"hashicorp.com/antmordel/pinot" = "/Users/helios/go/bin"
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
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