providerserver: Implement native protocol version 5 support #368
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reference: #158 This enables provider developers to natively create and serve framework providers on protocol version 5, which is compatible with Terraform CLI 0.12 and later. For provider developers that are using terraform-plugin-mux to migrate from terraform-plugin-sdk to this framework, they can now omit the usage of the `tf6to5server` package by setting the `ServeOpts` type `ProtocolVersion` field to `5`. Any protocol layer restrictions with the older protocol version 5 are raised as errors from the framework. For example, if `Attributes` is defined in a `tfsdk.Attribute` ("nested attributes"), the `GetProviderSchema` RPC response will include an error diagnostic. This implementation is essentially a duplication of the `internal/fromproto6`, `internal/proto6server`, and `internal/toproto6` packages with renaming of 6 to 5 and any minor RPC naming differences to match the protocol (e.g. `ValidateDataResourceConfig` -> `ValidateDataSourceConfig`, `ValidateProviderConfig` -> `PrepareProviderConfig`, `ValidateResourceConfig` -> `ValidateResourceTypeConfig`).
bendbennett
approved these changes
Jun 10, 2022
detro
approved these changes
Jun 10, 2022
Co-authored-by: Ivan De Marino <ivan.demarino@hashicorp.com>
bflad
commented
Jun 13, 2022
bflad
added a commit
to hashicorp/terraform-docs-common
that referenced
this pull request
Jun 14, 2022
…ementations Reference: hashicorp/terraform-plugin-framework#368 terraform-plugin-framework v0.9.0 will natively support Terraform Plugin Protocol version 5, which simplifies implementations which must support Terraform CLI 0.12 or later, or those migrating from terraform-plugin-sdk/v2 to the framework and using terraform-plugin-mux. Other plugin documentation is being separately updated.
14 tasks
bflad
added a commit
to hashicorp/terraform-docs-common
that referenced
this pull request
Jun 15, 2022
…ementations (#42) Reference: hashicorp/terraform-plugin-framework#368 terraform-plugin-framework v0.9.0 will natively support Terraform Plugin Protocol version 5, which simplifies implementations which must support Terraform CLI 0.12 or later, or those migrating from terraform-plugin-sdk/v2 to the framework and using terraform-plugin-mux. Other plugin documentation is being separately updated.
bflad
added a commit
to hashicorp/terraform-plugin-sdk
that referenced
this pull request
Jun 15, 2022
… version 5 Reference: hashicorp/terraform-plugin-framework#368 Provider developers no longer need to use the terraform-plugin-mux `tf6to5server` package when combining sdk/v2 and framework providers with Terraform 0.12 and later compatibility.
bflad
added a commit
to hashicorp/terraform-plugin-sdk
that referenced
this pull request
Jun 16, 2022
… version 5 (#984) Reference: hashicorp/terraform-plugin-framework#368 Provider developers no longer need to use the terraform-plugin-mux `tf6to5server` package when combining sdk/v2 and framework providers with Terraform 0.12 and later compatibility.
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference: #158
This enables provider developers to natively create and serve framework providers on protocol version 5, which is compatible with Terraform CLI 0.12 and later. For provider developers that are using terraform-plugin-mux to migrate from terraform-plugin-sdk to this framework, they can now omit the usage of the
tf6to5serverpackage by setting theServeOptstypeProtocolVersionfield to5.Any protocol layer restrictions with the older protocol version 5 are raised as errors from the framework. For example, if
Attributesis defined in atfsdk.Attribute("nested attributes"), theGetProviderSchemaRPC response will include an error diagnostic.This implementation is essentially a duplication of the
internal/fromproto6,internal/proto6server, andinternal/toproto6packages with renaming of 6 to 5 and any minor RPC naming differences to match the protocol (e.g.ValidateDataResourceConfig->ValidateDataSourceConfig,ValidateProviderConfig->PrepareProviderConfig,ValidateResourceConfig->ValidateResourceTypeConfig).