resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
terraform/docs
History
Brian Flad a477d10bd1
Introduce Terraform Plugin Protocol 6.2 with legacy_type_system fields from Protocol 5 (#30375) 
Reference: https://github.com/hashicorp/terraform/issues/30373

This change forward ports the `legacy_type_system` boolean fields in the `ApplyResourceChange.Response` and `PlanResourceChange.Response` messages that existed in protocol version 5, so that existing terraform-plugin-sdk/v2 providers can be muxed with protocol version 6 providers (e.g. terraform-plugin-framework) while also taking advantage of the newer protocol features. This functionality should not be used by any providers or SDKs except those built with terraform-plugin-sdk.

Updated via:

```shell
cp docs/plugin-protocol/tfplugin6.1.proto docs/plugin-protocol/tfplugin6.2.proto
# Copy legacy_type_system fields from tfplugin5.2.proto into ApplyResourceChange.Response and PlanResourceChange
rm internal/tfplugin6/tfplugin6.proto
ln -s ../../docs/plugin-protocol/tfplugin6.2.proto internal/tfplugin6/tfplugin6.proto
go run tools/protobuf-compile/protobuf-compile.go `pwd`
# Updates to internal/plugin6/grpc_provider.go
```
 		2022-01-20 09:57:42 -05:00
..
images update destroying doc to show show more CBD detail 2021-03-23 11:21:43 -04:00
plugin-protocol Introduce Terraform Plugin Protocol 6.2 with legacy_type_system fields from Protocol 5 (#30375) 2022-01-20 09:57:42 -05:00
README.md docs: Some notes on adopting new Unicode versions 2021-06-03 08:34:58 -07:00
architecture.md Remove 'enhanced' backend type distinction 2021-12-07 16:29:51 -06:00
destroying.md update destroying doc to show show more CBD detail 2021-03-23 11:21:43 -04:00
maintainer-etiquette.md Fix spelling mistakes/typos in documentation 2020-07-22 18:24:32 +02:00
resource-instance-change-lifecycle.md Fix spelling mistakes/typos in documentation 2020-07-22 18:24:32 +02:00
unicode.md docs: Some notes on adopting new Unicode versions 2021-06-03 08:34:58 -07:00

README.md

Terraform Core Codebase Documentation

This directory contains some documentation about the Terraform Core codebase, aimed at readers who are interested in making code contributions.

If you're looking for information on using Terraform, please instead refer to the main Terraform CLI documentation.

Terraform Core Architecture Documents

  • Terraform Core Architecture Summary: an overview of the main components of Terraform Core and how they interact. This is the best starting point if you are diving in to this codebase for the first time.

  • Resource Instance Change Lifecycle: a description of the steps in validating, planning, and applying a change to a resource instance, from the perspective of the provider plugin RPC operations. This may be useful for understanding the various expectations Terraform enforces about provider behavior, either if you intend to make changes to those behaviors or if you are implementing a new Terraform plugin SDK and so wish to conform to them.

    (If you are planning to write a new provider using the official SDK then please refer to the Extend documentation instead; it presents similar information from the perspective of the SDK API, rather than the plugin wire protocol.)

  • Plugin Protocol: gRPC/protobuf definitions for the plugin wire protocol and information about its versioning strategy.

    This documentation is for SDK developers, and is not necessary reading for those implementing a provider using the official SDK.

  • How Terraform Uses Unicode: an overview of the various features of Terraform that rely on Unicode and how to change those features to adopt new versions of Unicode.

Contribution Guides

  • Maintainer Etiquette: guidelines and expectations for those who serve as Pull Request reviewers, issue triagers, etc.