README
¶
Terraform Plugin SDK
This SDK enables building Terraform plugin which allows Terraform's users to manage existing and popular service providers as well as custom in-house solutions.
Terraform itself is a tool for building, changing, and versioning infrastructure safely and efficiently. You can find more about Terraform on its website and its GitHub repository.
Terraform CLI Compatibility
Terraform 0.12.0 or later is needed for version 2.0.0 and later of the Plugin SDK.
When running provider tests, Terraform 0.12.26 or later is needed for version 2.0.0 and later of the Plugin SDK. Users can still use any version after 0.12.0.
Go Compatibility
The Terraform Plugin SDK is built in Go, and uses the support policy of Go as its support policy. The two latest major releases of Go are supported by the SDK.
Currently, that means Go 1.16 or later must be used when building a provider with the SDK.
Getting Started
See the Call APIs with Terraform Providers guide on learn.hashicorp.com for a guided tour of provider development.
Documentation
See Extending Terraform section on the website.
Scope (Providers VS Core)
Terraform Core
- acts as gRPC client
- interacts with the user
- parses (HCL/JSON) configuration
- manages state as whole, asks Provider(s) to mutate provider-specific parts of state
- handles backends & provisioners
- handles inputs, outputs, modules, and functions
- discovers Provider(s) and their versions per configuration
- manages Provider(s) lifecycle (i.e. spins up & tears down provider process)
- passes relevant parts of parsed (valid JSON/HCL) and interpolated configuration to Provider(s)
- decides ordering of (Create, Read, Update, Delete) operations on resources and data sources
- ...
Terraform Provider (via this SDK)
- acts as gRPC server
- executes any domain-specific logic based on received parsed configuration
- (Create, Read, Update, Delete, Import, Validate) a Resource
- Read a Data Source
- tests domain-specific logic via provided acceptance test framework
- provides Core updated state of a resource or data source and/or appropriate feedback in the form of validation or other errors
Migrating to SDK v1 from built-in SDK
Migrating to the standalone SDK v1 is covered on the Plugin SDK section of the website.
Migrating to SDK v2 from SDK v1
Migrating to the v2 release of the SDK is covered in the v2 Upgrade Guide of the website.
Versioning
The Terraform Plugin SDK is a Go module versioned using semantic versioning. See SUPPORT.md for information on our support policies.
Contributing
License
Directories
¶
| Path | Synopsis |
|---|---|
|
helper
|
|
|
customdiff
Package customdiff provides a set of reusable and composable functions to enable more "declarative" use of the CustomizeDiff mechanism available for resources in package helper/schema.
|
Package customdiff provides a set of reusable and composable functions to enable more "declarative" use of the CustomizeDiff mechanism available for resources in package helper/schema. |
|
schema
schema is a high-level framework for easily writing new providers for Terraform.
|
schema is a high-level framework for easily writing new providers for Terraform. |
|
internal
|
|
|
addrs
Package addrs contains types that represent "addresses", which are references to specific objects within a Terraform configuration or state.
|
Package addrs contains types that represent "addresses", which are references to specific objects within a Terraform configuration or state. |
|
configs/configschema
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime.
|
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime. |
|
plugintest
Package plugintest contains utilities to help with writing tests for Terraform plugins.
|
Package plugintest contains utilities to help with writing tests for Terraform plugins. |
|
tfdiags
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user.
|
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user. |
|
The meta package provides a location to set the release version and any other relevant metadata for the SDK.
|
The meta package provides a location to set the release version and any other relevant metadata for the SDK. |