Repository files navigation

terraform-plugin-framework is a module for buildingTerraform providers. It is built onterraform-plugin-go. It aims to provide as much of the power, predictability, and versatility of terraform-plugin-go as it can while abstracting away implementation details and repetitive, verbose tasks.

• Try theTerraform Plugin Framework collection on HashiCorp Learn.
• Clone theterraform-provider-scaffolding-framework template repository on GitHub for new providers.
• Follow theTerraform Plugin Framework migration guide for converting existing terraform-plugin-sdk providers.
• Read theTerraform Plugin Framework website for full documentation.
• Browse theterraform-plugin-framework module on the Go package documentation website.
• Ask questions in theTerraform Plugin Development section on HashiCorp Discuss.

terraform-plugin-framework has reachedGeneral Availability phase and followssemantic versioning for Go and Terraform compatibility promises. We recommend only using tagged releases of this Go module and examining the CHANGELOG when upgrading to a new release. Major version releases contain breaking changes to existing provider code. Minor version releases introduce new functionality. Patch version releases contain bug fixes or documentation updates.

Refer toPlugin Framework Benefits for more information about benefits overterraform-plugin-sdk.

Providers built with this framework are compatible with Terraform version v0.12 and above.

This project follows thesupport policy of Go as its support policy. The two latest major releases of Go are supported by the project.

Currently, that means Go1.24 or later must be used when including this project as a dependency.

See.github/CONTRIBUTING.md

Mozilla Public License v2.0