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 General Availability phase and follows semantic 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 to Plugin Framework Benefits for more information about benefits over terraform-plugin-sdk.
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.21 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. |
|
schema
Package schema contains all available schema functionality for data sources.
|
Package schema contains all available schema functionality for data sources. |
|
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. |
|
Package function contains all interfaces, request types, and response types for a Terraform Provider function implementation.
|
Package function contains all interfaces, request types, and response types for a Terraform Provider function implementation. |
|
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. |
|
fwfunction
Package fwfunction contains shared interfaces and structures for implementing behaviors in Terraform Provider function implementations.
|
Package fwfunction contains shared interfaces and structures for implementing behaviors in Terraform Provider function implementations. |
|
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. |
|
fwtype
Package fwtype implements shared logic for interacting with the framework type system.
|
Package fwtype implements shared logic for interacting with the framework type system. |
|
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/testdefaults
Package testdefaults contains declarative resource/schema/defaults implementations for unit testing.
|
Package testdefaults contains declarative resource/schema/defaults implementations for unit testing. |
|
testing/testplanmodifier
Package testplanmodifier contains declarative resource/schema/planmodifier implementations for unit testing.
|
Package testplanmodifier contains declarative resource/schema/planmodifier implementations for unit testing. |
|
testing/testprovider
Package testprovider contains a fully declarative provider for testing.
|
Package testprovider contains a fully declarative provider for testing. |
|
testing/testschema
Package testschema contains declarative schema types for unit testing.
|
Package testschema contains declarative schema types for unit testing. |
|
testing/testtypes
types contains shared attr.Type implementations for unit testing.
|
types contains shared attr.Type implementations for unit testing. |
|
testing/testvalidator
Package testvalidator contains declarative schema/validator implementations for unit testing.
|
Package testvalidator contains declarative schema/validator 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. |
|
metaschema
Package metaschema contains all available meta schema functionality for providers.
|
Package metaschema contains all available meta schema functionality for providers. |
|
schema
Package schema contains all available schema functionality for data sources.
|
Package schema contains all available schema functionality for data sources. |
|
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. |
|
schema
Package schema contains all available schema functionality for resources.
|
Package schema contains all available schema functionality for resources. |
|
schema/booldefault
Package booldefault provides default values for types.Bool attributes.
|
Package booldefault provides default values for types.Bool attributes. |
|
schema/boolplanmodifier
Package boolplanmodifier provides plan modifiers for types.Bool attributes.
|
Package boolplanmodifier provides plan modifiers for types.Bool attributes. |
|
schema/defaults
Package defaults contains schema default value interfaces and request/response implementations.
|
Package defaults contains schema default value interfaces and request/response implementations. |
|
schema/dynamicdefault
Package dynamicdefault provides default values for types.Dynamic attributes.
|
Package dynamicdefault provides default values for types.Dynamic attributes. |
|
schema/dynamicplanmodifier
Package dynamicplanmodifier provides plan modifiers for types.Dynamic attributes.
|
Package dynamicplanmodifier provides plan modifiers for types.Dynamic attributes. |
|
schema/float64default
Package float64default provides default values for types.Float64 attributes.
|
Package float64default provides default values for types.Float64 attributes. |
|
schema/float64planmodifier
Package float64planmodifier provides plan modifiers for types.Float64 attributes.
|
Package float64planmodifier provides plan modifiers for types.Float64 attributes. |
|
schema/int64default
Package int64default provides default values for types.Int64 attributes.
|
Package int64default provides default values for types.Int64 attributes. |
|
schema/int64planmodifier
Package int64planmodifier provides plan modifiers for types.Int64 attributes.
|
Package int64planmodifier provides plan modifiers for types.Int64 attributes. |
|
schema/listdefault
Package listdefault provides default values for types.List attributes.
|
Package listdefault provides default values for types.List attributes. |
|
schema/listplanmodifier
Package listplanmodifier provides plan modifiers for types.List attributes.
|
Package listplanmodifier provides plan modifiers for types.List attributes. |
|
schema/mapdefault
Package mapdefault provides default values for types.Map attributes.
|
Package mapdefault provides default values for types.Map attributes. |
|
schema/mapplanmodifier
Package mapplanmodifier provides plan modifiers for types.Map attributes.
|
Package mapplanmodifier provides plan modifiers for types.Map attributes. |
|
schema/numberdefault
Package numberdefault provides default values for types.Number attributes.
|
Package numberdefault provides default values for types.Number attributes. |
|
schema/numberplanmodifier
Package numberplanmodifier provides plan modifiers for types.Number attributes.
|
Package numberplanmodifier provides plan modifiers for types.Number attributes. |
|
schema/objectdefault
Package objectdefault provides default values for types.Object attributes.
|
Package objectdefault provides default values for types.Object attributes. |
|
schema/objectplanmodifier
Package objectplanmodifier provides plan modifiers for types.Object attributes.
|
Package objectplanmodifier provides plan modifiers for types.Object attributes. |
|
schema/planmodifier
Package planmodifier contains schema plan modifier interfaces and request/response implementations.
|
Package planmodifier contains schema plan modifier interfaces and request/response implementations. |
|
schema/setdefault
Package setdefault provides default values for types.Set attributes.
|
Package setdefault provides default values for types.Set attributes. |
|
schema/setplanmodifier
Package setplanmodifier provides plan modifiers for types.Set attributes.
|
Package setplanmodifier provides plan modifiers for types.Set attributes. |
|
schema/stringdefault
Package stringdefault provides default values for types.String attributes.
|
Package stringdefault provides default values for types.String attributes. |
|
schema/stringplanmodifier
Package stringplanmodifier provides plan modifiers for types.String attributes.
|
Package stringplanmodifier provides plan modifiers for types.String attributes. |
|
Package schema contains functionality common to all schemas.
|
Package schema contains functionality common to all schemas. |
|
validator
Package validator contains common schema validator interfaces and implementations.
|
Package validator contains common schema validator interfaces and implementations. |
|
Package tfsdk contains core framework functionality for schema data.
|
Package tfsdk contains core framework functionality for 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. |
|
basetypes
Package basetypes contains the implementations for framework-defined data types and values, such as boolean, floating point, integer, list, map, object, set, and string.
|
Package basetypes contains the implementations for framework-defined data types and values, such as boolean, floating point, integer, list, map, object, set, and string. |
Click to show internal directories.
Click to hide internal directories.