543e5f4971
The previous version of this document was produced in haste in order to support the development of the new provider framework, and so it focused only on the most important details and left some of the operations totally unmentioned. This new version aims to capture the full set of managed-resource-related provider operations, documenting when Terraform Core will call them and what the provider ought to do in order to meet Terraform Core's expectations for a valid response. This new version does still assume a certain amount of knowledge on the part of the reader about broadly what Terraform does from a user perspective and what role providers play in that process. Perhaps a future revision will include some additional background context as well, but this is a snapshot of what I had time to do today between other work and so for now I focused on presenting the remaining operations in a similar amount of detail to what was here before. |
||
|---|---|---|
| .. | ||
| images | ||
| plugin-protocol | ||
| architecture.md | ||
| destroying.md | ||
| maintainer-etiquette.md | ||
| planning-behaviors.md | ||
| README.md | ||
| resource-instance-change-lifecycle.md | ||
| unicode.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.