Introduce Protocol Server Capability for Optional GetProviderSchema RPC #310
Comments
bflad
added a commit
that referenced
this issue
Jul 7, 2023
bflad
added a commit
that referenced
this issue
Aug 23, 2023
This was referenced Aug 25, 2023
bflad
added a commit
that referenced
this issue
Sep 6, 2023
…data RPC and GetProviderSchemaOptional server capability (#311) Reference: #310 Protocol upgrades that impose new RPCs will either require: - The `tfprotov5.ProviderServer`/`tfprotov6.ProviderServer` interface to require a new method - Or, new "optional" interfaces be implemented (let's make up `ProviderServerWithGetMetadata` in this case) terraform-plugin-go is a low level abstraction which is designed to _directly implement_ the protocol rather than introduce its own abstractions. Most provider developers will directly interface with higher level Go modules, such as terraform-plugin-sdk and terraform-plugin-framework. Except for advanced provider development using this Go module directly, this type of low level "breaking" change will be hidden by also upgrading those Go modules at the same time: - hashicorp/terraform-plugin-sdk#1235 - hashicorp/terraform-plugin-framework#829 - hashicorp/terraform-plugin-mux#186 Therefore the change is implemented on the existing interface.
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
terraform-plugin-go version
Use cases
Terraform core is working on optimizing their overall memory utilization by supporting the ability to cache provider schemas per-type, rather than per-instance. This should cause a statistically significant drop in maximum resident size in Terraform environments running configurations with multiple provider aliases for larger providers, such as
hashicorp/aws. The challenge is that not all provider implementations support all RPC operations without the historically upfrontGetProviderSchemaRPC, such as older versions of terraform-plugin-framework, which used theGetProviderSchemaRPC to cache supported resource types for other RPCs.Proposal
Update the plugin protocol to 5.4 and 6.4 with a new server capability to signal that the
GetProviderSchemaRPC is optional/skippable. Initial testing shows that terraform-plugin-sdk/[email protected] and [email protected] should be able to enable this capability once its exposed by this Go module. In terraform-plugin-mux, it should be able to front each existing RPC with a logic to callGetProviderSchemafirst if necessary for the underlying provider server.References
get_provider_schema_optionalserver capability terraform#33486The text was updated successfully, but these errors were encountered: