e00f0804ef
For a while now we've had information equivalent to this in various internal documents that we've referred to when designing features such as config-driven refactoring, the "replace" planning option, and so forth. However, so far we've not put that information in any sort of durable public place that we can easily find and refer to when having design discussions on GitHub and similar. This is therefore an attempt to capture a summary of the three main design patterns we've identified for planning-related behaviors, with a few motivating examples of each one, in the hope that this will be a good reference and some helpful inspiration for future design work. It's intentionally not totally comprehensive of all planning behaviors both because that would duplicate the end-user-oriented documentation and because it would be burdensome to keep updating this document each time we add anything new which might fit into these categories. However, we might add a later feature to this document if it illustrates a new take or different perspective on one of these patterns. |
||
|---|---|---|
| .. | ||
| 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.