Follow the steps of the Terraform plugin framework tutorial.

Frédéric G. MARAND 3b3656a1b4 Tutorial 11: Generate documentation. 22 ore fa
.github 539ee450aa Result of tsccr-helper -log-level=info gha update -latest .github/ (#258) 2 settimane fa
.run 2b90f4c9df Tutorial 4: logging. Use TF_LOG=<level> and TF_LOG_PATH and TF_LOG_PROVIDER to filter. 5 giorni fa
docker_compose 761c115db4 Generate docs, update docker compose, add copyright headers. 5 giorni fa
examples 3b3656a1b4 Tutorial 11: Generate documentation. 22 ore fa
internal 3b3656a1b4 Tutorial 11: Generate documentation. 22 ore fa
tools c9d88ea239 After Tutorial 1: introduction. 6 giorni fa
.copywrite.hcl 3b3656a1b4 Tutorial 11: Generate documentation. 22 ore fa
.gitignore 3b3656a1b4 Tutorial 11: Generate documentation. 22 ore fa
.golangci.yml 1db52140d3 chore: replace with copyloopvar (#253) 1 mese fa
.goreleaser.yml 18ad4fcb5b Update GoReleaser configuration for version 2 (#228) 5 mesi fa
CHANGELOG.md a64a312802 Initial commit 3 anni fa
GNUmakefile 45a650b070 offload go generate to `tools/` to prevent bloating the root Go module (#239) 2 mesi fa
LICENSE b2ba5a3d22 [COMPLIANCE] Update MPL 2.0 LICENSE (#93) 2 anni fa
README.md a056b2fcbf workflows: Add setup-terraform before doc generation step (#248) 2 mesi fa
go.mod f930b2814a Tutorial 2: Configure client. 6 giorni fa
go.sum f930b2814a Tutorial 2: Configure client. 6 giorni fa
main.go c9d88ea239 After Tutorial 1: introduction. 6 giorni fa
terraform-registry-manifest.json a64a312802 Initial commit 3 anni fa

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

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 make 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