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 Developer platform. Terraform Plugin Framework specific guides are titled accordingly.
- Environment variables
- Ansible Configuration
- Better validation for hosts and variables
- Change the API to feel more like HashiCorp's providers
- Improve SSH Options handling
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
install
command:
make build
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 make build
. This will build the provider and put the provider binary in the root of the repository.
To generate or update documentation, run make docs
.
In order to run the full suite of Acceptance tests, run make testacc
.
You can run the 3 commands together:
make