README
¶
Terraform Plugin Framework
terraform-plugin-framework is a module for building Terraform providers. It is built on terraform-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.
Getting Started
- Try the Terraform Plugin Framework collection on HashiCorp Learn.
- Clone the terraform-provider-scaffolding-framework template repository on GitHub for new providers.
- Follow the Terraform Plugin Framework migration guide for converting existing terraform-plugin-sdk providers.
- Read the Terraform Plugin Framework website for full documentation.
- Browse the terraform-plugin-framework module on the Go package documentation website.
- Ask questions in the Terraform Plugin Development section on HashiCorp Discuss.
Status
terraform-plugin-framework has reached Public Beta phase. We are committed to moving forward with the module, but cannot guarantee any of its interfaces will not change as long as it is in version 0. We're waiting for additional feedback, usage, and maturity before we're comfortable committing to APIs with the same years-long support timelines that terraform-plugin-sdk brings. We do not expect practitioner experiences to break or change as a result of these changes, only the abstractions surfaced to provider developers.
Refer to Which SDK Should I Use? for more information.
We believe terraform-plugin-framework is a suitable and reliable module to build Terraform providers on, and encourage community members that can afford occasional breaking changes to build with it. terraform-plugin-framework will eventually become generally available with a new major version release, at which point its interfaces will be stable, but we need real-world use and feedback before we can be comfortable making those commitments.
We recommend only using tagged releases of this module, and examining the CHANGELOG when upgrading to a new release. Breaking changes will only be made in minor versions; patch releases will always maintain backwards compatibility.
We welcome and appreciate issues and PRs discussing both the design and implementation of this module.
Terraform CLI Compatibility
Providers built with this framework are compatible with Terraform version v0.12 and above.
Go Compatibility
This project follows the support policy of Go as its support policy. The two latest major releases of Go are supported by the project.
Currently, that means Go 1.18 or later must be used when including this project as a dependency.
Contributing
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package attr contains type and value interfaces for core framework and provider-defined data types.
|
Package attr contains type and value interfaces for core framework and provider-defined data types. |
|
xattr
Package xattr contains additional interfaces for attr types.
|
Package xattr contains additional interfaces for attr types. |
|
Package datasource contains all interfaces, request types, and response types for a data source implementation.
|
Package datasource contains all interfaces, request types, and response types for a data source implementation. |
|
Package diag implements diagnostic functionality, which is a practitioner feedback mechanism for providers.
|
Package diag implements diagnostic functionality, which is a practitioner feedback mechanism for providers. |
|
internal
|
|
|
fromproto5
Package fromproto5 contains functions to convert from protocol version 5 (tfprotov5) types to framework types.
|
Package fromproto5 contains functions to convert from protocol version 5 (tfprotov5) types to framework types. |
|
fromproto6
Package fromproto6 contains functions to convert from protocol version 6 (tfprotov6) types to framework types.
|
Package fromproto6 contains functions to convert from protocol version 6 (tfprotov6) types to framework types. |
|
fromtftypes
Package fromtftypes contains functions to convert from terraform-plugin-go tftypes types to framework types.
|
Package fromtftypes contains functions to convert from terraform-plugin-go tftypes types to framework types. |
|
fwschema
Package fwschema implements shared logic for describing the structure, data types, and behaviors of framework data for data sources, providers, and resources.
|
Package fwschema implements shared logic for describing the structure, data types, and behaviors of framework data for data sources, providers, and resources. |
|
fwschema/fwxschema
Package fwxschema implements extra framework-based schema functionality on top of base Terraform attribute functionality.
|
Package fwxschema implements extra framework-based schema functionality on top of base Terraform attribute functionality. |
|
fwschemadata
Package fwschemadata implements the shared schema-based data implementation for configuration, plan, and state values.
|
Package fwschemadata implements the shared schema-based data implementation for configuration, plan, and state values. |
|
fwserver
Package fwserver contains the framework provider server implementation.
|
Package fwserver contains the framework provider server implementation. |
|
logging
Package logging contains framework internal helpers for consistent logger and log entry handling.
|
Package logging contains framework internal helpers for consistent logger and log entry handling. |
|
privatestate
Package privatestate contains the type used for handling private resource state data.
|
Package privatestate contains the type used for handling private resource state data. |
|
proto5server
Package proto5server contains the provider server implementation compatible with protocol version 5 (tfprotov5.ProviderServer).
|
Package proto5server contains the provider server implementation compatible with protocol version 5 (tfprotov5.ProviderServer). |
|
proto6server
Package proto6server contains the provider server implementation compatible with protocol version 6 (tfprotov6.ProviderServer).
|
Package proto6server contains the provider server implementation compatible with protocol version 6 (tfprotov6.ProviderServer). |
|
reflect
Package reflect contains the implementation for converting framework-defined data into and from provider-defined Go types.
|
Package reflect contains the implementation for converting framework-defined data into and from provider-defined Go types. |
|
testing
Package testing contains internal framework helpers for unit testing.
|
Package testing contains internal framework helpers for unit testing. |
|
testing/planmodifiers
Package planmodifiers contains plan modifiers for testing.
|
Package planmodifiers contains plan modifiers for testing. |
|
testing/testprovider
Package testprovider contains a fully declarative provider for testing.
|
Package testprovider contains a fully declarative provider for testing. |
|
testing/types
types contains shared attr.Type implementations for unit testing.
|
types contains shared attr.Type implementations for unit testing. |
|
toproto5
Package toproto5 contains functions to convert from framework types to protocol version 5 (tfprotov5) types.
|
Package toproto5 contains functions to convert from framework types to protocol version 5 (tfprotov5) types. |
|
toproto6
Package toproto6 contains functions to convert from framework types to protocol version 6 (tfprotov6) types.
|
Package toproto6 contains functions to convert from framework types to protocol version 6 (tfprotov6) types. |
|
totftypes
Package totftypes contains functions to convert from framework types to terraform-plugin-go tftypes types.
|
Package totftypes contains functions to convert from framework types to terraform-plugin-go tftypes types. |
|
Package path implements attribute path functionality, which defines transversals into schema-based data.
|
Package path implements attribute path functionality, which defines transversals into schema-based data. |
|
Package provider contains all interfaces, request types, and response types for a provider implementation.
|
Package provider contains all interfaces, request types, and response types for a provider implementation. |
|
Package providerserver implements functionality for serving a provider, such as directly starting a server in a production binary and conversion functions for testing.
|
Package providerserver implements functionality for serving a provider, such as directly starting a server in a production binary and conversion functions for testing. |
|
Package resource contains all interfaces, request types, and response types for a managed resource implementation.
|
Package resource contains all interfaces, request types, and response types for a managed resource implementation. |
|
Package tfsdk contains core framework functionality for schemas and schema data.
|
Package tfsdk contains core framework functionality for schemas and schema data. |
|
Package types contains the framework-defined data types and values, such as boolean, floating point, integer, list, map, object, set, and string.
|
Package types contains the framework-defined data types and values, such as boolean, floating point, integer, list, map, object, set, and string. |