This PR allows a framework provider to store/read identity data for a managed resource (along withTerraform v1.12.0-alpha20250312). The RPCs implemented for this areReadResource (Read),PlanResourceChange, andApplyResourceChange (split in framework toCreate/Update/Delete).

I left some intentional TODOs for pieces of work I wasn't 100% sure of that should be resolved before we release stablev1.15.0.

Generally, the flow of data through the packages (using protocol v5 as an example, it's the same for v6):

proto5server (implements the RPC in plugin-go) =>fromproto5 (maps request from plugin-go types to fwserver types)
proto5server =>fwserver (this is where any framework-specific logic is implemented for the RPC)
- fwserver =>resource (the actual provider code for the resource, like aws or azurerm)
proto5server =>toproto5 (maps response from fwserver types to plugin-go types)

The other RPCs that are not needed to successfully test the happy path ofplan/apply workflow, these will be implemented in follow-up PRs:

ImportResourceState
MoveResourceState
UpgradeResourceIdentity

austinvalle added21 commits

February 24, 2025 09:42

new attribute additions (breaks build for existing internal schema at…

28f4719

…tributes)

update internal testing/testschema

c4ad0c5

implement in datasource/schema

2950f20

implement in ephemeral/schema

f2243ba

implement in provider/metaschema

057093a

implement in provider/schema

2fed091

implement in resource/schema

3c759ec

add to final internal/testing/testschema

167b824

get resource identity schema implementation

77ef579

Merge branch 'main' into feat/resource-identity

0f63086

protov6 + tests

63dc825

fix up package docs + build specific TODO comments

f97d278

spellcheck!

5578a7d

Merge branch 'main' into feat/resource-identity

dd0bcbc

add tfsdk object

7eba2e7

ReadResource RPC implementation for v5

d07f756

ReadResource RPC implementation for v6

e3dd2b6

protov5 + fwserver implementation for PlanResourceChange

8873227

protov6 implementation of PlanResourceChange

774af73

implement ApplyResourceChange fwserver + protov5

8a90ecb

protov6 implementation of apply resource

bb07ce6

austinvalle added the enhancementNew feature or request label

Mar 14, 2025

austinvalle added this to thev1.15.0 milestone

Mar 14, 2025

austinvalle requested a review froma team as acode owner

March 14, 2025 13:02

update go dep

df3e558

Copy link

MemberAuthor

austinvalle commentedMar 14, 2025•
edited
Loading

Using the core alpha, storing identity via Read/Create/Update looks like the following:

No validation yet on the immutability of identity, but more to come there!

ansgarm previously approved these changes

Mar 17, 2025

View reviewed changes

Copy link

Member

ansgarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

internal/fwserver/server_deleteresource.go

		}

		// If the resource supports identity pre-populate a null value.
		// TODO:ResourceIdentity: This should probably be prior identity, but we don't currently have that in the protocol.

Copy link

Member

ansgarmMar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

should we / did you already mention this to core?

Copy link

MemberAuthor

austinvalleMar 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I did in the RFC here ->https://docs.google.com/document/d/1jvNfineZgXaKFP5djLkMxXKf9s6Xq-FzBV3p2jHGbiI/edit?disco=AAABe6K13yk

It's unclear whetherplanned_identity will contain theprior_identity value, but I think it's generally agreed upon that the prior identity will be provided in some fashion 😆