Terraform v1.12+ returns a `GetResourceIdentitySchemas Not Implemented` error

[austinvalle]

Module version

github.com/hashicorp/terraform-plugin-framework v1.15.0

Background

Opening this issue retroactively if anyone else runs into this

For providers that are using v1.15.0 with terraform-plugin-go@v0.27.0 and terraform-plugin-mux@v0.19.0, if the dependencies are not all updated to the latest version, practitioners will receive an error when running the provider:

│ Error: Failed to load plugin schemas
│ 
│ Error while loading schemas for plugin components: Failed to obtain
│ provider schema: Could not load the schema for provider
│ registry.terraform.io/<provider-name>: failed to retrieve schema from
│ provider "registry.terraform.io/registry.terraform.io/<provider-name>": 
│ 
│ - GetResourceIdentitySchemas Not Implemented: A GetResourceIdentitySchemas
│ call was received by the provider, however the provider does not implement
│ GetResourceIdentitySchemas. Either upgrade the provider to a version that
│ implements GetResourceIdentitySchemas or this is a bug in Terraform that
│ should be reported to the Terraform maintainers.

This error is displayed by Terraform 1.12.1 and later.

Solution

The reason for this error is because one of the provider servers that is being muxed does not support resource identity (GetResourceIdentitySchemas) and must be upgraded. This has now been adjusted to be an error at compile time with the release of terraform-plugin-go@v0.28.0 and terraform-plugin-mux@v0.20.0.

To resolve these errors, providers should upgrade to the following Go module versions if they are being used:

github.com/hashicorp/terraform-plugin-go@v0.28.0
github.com/hashicorp/terraform-plugin-mux@v0.20.0
github.com/hashicorp/terraform-plugin-framework@v1.15.0
github.com/hashicorp/terraform-plugin-sdk/v2@v2.37.0
github.com/hashicorp/terraform-plugin-testing@v1.13.1

References

• Terraform 1.12.1 unable to validate terraform#37149
• GetResourceIdentitySchemas Not Implemented (terraform terraform 1.12.1 x64) terraform-provider-kubernetes#2732
• all: Remove temporary ProviderServerWithResourceIdentity interface terraform-plugin-go#516
• Update terraform-plugin-go and add changelogs for v0.20.0 release terraform-plugin-mux#307
• echoprovider: Fix bug where Terraform v1.12.1 would return an error indicating GetResourceIdentitySchemas was not implemented terraform-plugin-testing#512

[austinvalle]

This issue is actually more related to terraform-plugin-go, but just using this repo as it's likely one of the first places folks would go to 👍🏻