Skip to content

Commit 26b488a

Browse files
bfladbendbennett
andauthored
website: Add links for SDKv2 resource data consistency errors page to migration guide (#819)
Reference: hashicorp/terraform-plugin-sdk#1229 Co-authored-by: Benjamin Bennett <ben.bennett@hashicorp.com>
1 parent b5ccd8f commit 26b488a

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

website/docs/plugin/framework/migrating/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ As you complete the migration, we recommend that you follow Test Driven Developm
3636
Take the following steps when you migrate a provider from SDKv2 to the Framework:
3737

3838
- Ensure all [tests](/terraform/plugin/framework/migrating/testing#testing-migration) pass.
39+
- Consider [finding SDKv2 resource data consistency errors](/terraform/plugin/sdkv2/resources/data-consistency-errors), which might affect migrating to the Framework. Some errors can be resolved and verified with SDKv2 code before migration, if desired, otherwise resolving these errors must be part of the migration.
3940
- [Serve the provider](/terraform/plugin/framework/migrating/providers#serving-the-provider) via the Framework.
4041
- Implement [muxing](/terraform/plugin/framework/migrating/mux), if you plan to migrate the provider iteratively.
4142
- Update the [provider definition](/terraform/plugin/framework/migrating/providers#provider-definition) to use the Framework.

website/docs/plugin/framework/migrating/resources/crud.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ function. In the Framework, you must implement each of the CRUD lifecycle functi
7373
`schema.ResourceData`. In the Framework, you get attribute values from the configuration and plan by accessing
7474
`Config` and `Plan` on `resource.CreateRequest`. You set attribute values in Terraform's state by mutating `State`
7575
on `resource.CreateResponse`.
76+
- In SDKv2, certain resource schema definition and data consistency errors are only visible as Terraform warning logs by default. After migration, these errors will always be visible to practitioners and prevent further Terraform operations. The [SDKv2 resource data consistency errors documentation](/terraform/plugin/sdkv2/resources/data-consistency-errors) discusses how to find and potentially resolve these.
7677
7778
## Example
7879

website/docs/plugin/framework/migrating/resources/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ the `resource.Resource` interface, which includes a `Schema` method that returns
141141
- SDKv2 implements a resource's CRUD operations as functions on the `schema.Resource`. In the Framework, you define a
142142
type that implements the `resource.Resource` interface. The resource interface contains the functions that define your resource's
143143
CRUD operations.
144+
- SDKv2 by default demotes certain resource schema definition and data consistency errors to only be visible as Terraform warning logs. After migration, these errors will always be visible to practitioners and prevent further Terraform operations. The [SDKv2 resource data consistency errors documentation](/terraform/plugin/sdkv2/resources/data-consistency-errors) discusses how to find and potentially resolve these.
144145

145146
## Example
146147

0 commit comments

Comments
 (0)