mirror of
https://github.com/hashicorp/terraform.git
synced 2026-03-21 10:00:09 -04:00
371e625ea9
* Update URLs from www.terraform.io to developer.hashicorp.com * More updates to URLs linking to documentation in documentation and user-facing warnings/errors * More updates to URLs linking to documentation, in docs, code, test fixtures * Replace www.terraform.io/community with link to Community Forum * Apply suggestions from code review Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com> --------- Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
56 lines
2.8 KiB
Markdown
56 lines
2.8 KiB
Markdown
# 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](https://developer.hashicorp.com/terraform/cli).
|
|
|
|
## Terraform Core Architecture Documents
|
|
|
|
* [Modules Runtime Architecture Summary](./architecture.md): an overview of the
|
|
main components of Terraform Core related to planning and applying modules.
|
|
This is the best starting point if you are diving in to this codebase for the
|
|
first time.
|
|
|
|
* [Stacks Runtime Architecture Summary](../internal/stacks/README.md): an
|
|
overview of the main components of Terraform Core related to planning and
|
|
applying stack configurations.
|
|
|
|
* [Resource Instance Change Lifecycle](./resource-instance-change-lifecycle.md):
|
|
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 Plugin development documentation](https://developer.hashicorp.com/terraform/plugin)
|
|
instead; it presents similar information from the perspective of the SDK
|
|
API, rather than the plugin wire protocol.)
|
|
|
|
* [Plugin 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.
|
|
|
|
* [Terraform Core RPC API](../internal/rpcapi/README.md): an integration point
|
|
for external software that needs to integrate Terraform Core functionality.
|
|
|
|
* [Upgrading Terraform's Dependencies](./dependency-upgrades.md): guidance on
|
|
some special details that arise when we upgrade Go Module dependencies, due
|
|
to this codebase containing Terraform CLI, Terraform Core, and the various
|
|
remote state backends which all have some overlapping dependencies.
|
|
|
|
* [How Terraform Uses Unicode](./unicode.md): an overview of the various
|
|
features of Terraform that rely on Unicode and how to change those features
|
|
to adopt new versions of Unicode.
|
|
|
|
* [Deadlock-free Promises](../internal/promising/README.md): a utility package
|
|
used by the Terraform Stacks runtime to coordinate its concurrent work.
|
|
|
|
## Contribution Guides
|
|
|
|
* [Contributing to Terraform](../.github/CONTRIBUTING.md): a complete guideline for those who want to contribute to this project.
|