d0d35d2dcd
This commit adds the definitions of provider protocol 5.6, 5.7, 6.6, and
6.7 to our archive of the historical protocol versions and then adopts
5.7 as the current version of major version 5 and 6.7 as the current
version of major version 6.
These MPL-licensed schema definitions are from the plugin protocol server
implementation in this repository, copyright HashiCorp:
https://github.com/hashicorp/terraform-plugin-go
The only modifications made are to change the "option go_package" directive
to match where the stubs need to be generated for OpenTofu, and to claim
copyright for that change and thus make the copyright header consistent
with what our pre-commit rules require.
The regeneration of the Go API stubs for the two major protocol versions
introduces some new fields and messages that OpenTofu does not yet support
but will happily ignore. Future work might make some use of these new
additions, but that's out of scope of this change that is intended only
to synchronize our protocol definition with what new plugin server releases
are likely to be linked against.
This commit continues the existing precedent of having the stubs for the
newly-added interface methods in package grpcwrap being just a panicking
stub, which is how they will remain until a future project begins using
those methods in a way which requires them to be implemented, since
implementing the wrappers would require a deeper understanding of the
desired behavior of those methods.
It appears that we previously accepted a pull request to correct a typo
that originated in the older versions of the upstream protocol definitions,
but I have intentionally not forward-ported that here because it seems
clearer to keep these definitions as close as possible to their source
of truth from upstream, given that our current intention is to follow the
protocol as documented and not to change it.
Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
|
||
|---|---|---|
| .. | ||
| images | ||
| plugin-protocol | ||
| architecture.md | ||
| destroying.md | ||
| planning-behaviors.md | ||
| provider-references.md | ||
| README.md | ||
| resource-instance-change-lifecycle.md | ||
| state_encryption.md | ||
| unicode.md | ||
OpenTofu Core Codebase Documentation
This directory contains some documentation about the OpenTofu Core codebase, aimed at readers who are interested in making code contributions.
If you're looking for information on using OpenTofu, please instead refer to the main OpenTofu CLI documentation.
OpenTofu Core Architecture Documents
-
OpenTofu Core Architecture Summary: an overview of the main components of OpenTofu 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 OpenTofu enforces about provider behavior, either if you intend to make changes to those behaviors or if you are implementing a new OpenTofu 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 OpenTofu Uses Unicode: an overview of the various features of OpenTofu that rely on Unicode and how to change those features to adopt new versions of Unicode.
Contribution Guides
- Contributing to OpenTofu: a complete guideline for those who want to contribute to this project.