Resource Identity: Add identity data to RPCs needed to store/read from state #1112
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
|
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
| @@ -96,6 +98,17 @@ func (s *Server) DeleteResource(ctx context.Context, req *DeleteResourceRequest, | |||
| resp.Private = req.PlannedPrivate | |||
| } | |||
|
|
|||
| // 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. | |||
There was a problem hiding this comment.
should we / did you already mention this to core?
There was a problem hiding this comment.
I did in the RFC here -> https://docs.google.com/document/d/1jvNfineZgXaKFP5djLkMxXKf9s6Xq-FzBV3p2jHGbiI/edit?disco=AAABe6K13yk
It's unclear whether planned_identity will contain the prior_identity value, but I think it's generally agreed upon that the prior identity will be provided in some fashion 😆
SBGoods
previously approved these changes
Mar 17, 2025
|
LGTM as well 👍🏽 |
austinvalle
dismissed stale reviews from SBGoods and ansgarm
The base branch was changed.
bbasata
approved these changes
Mar 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR allows a framework provider to store/read identity data for a managed resource (along with
Terraform 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 stable
v1.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 of
plan/applyworkflow, these will be implemented in follow-up PRs:ImportResourceStateMoveResourceStateUpgradeResourceIdentity