Skip to content

Commit f3f1d99

Browse files
committed
docs: update documentation for plan modifier fix and remove obsolete fgam_serialization
Updates documentation to reflect the plan modifier fix that resolves "Provider produced inconsistent result after apply" errors introduced with FGAM field additions in v0.4.0. Changes: - CHANGELOG.md: Add v0.5.0 entry documenting plan modifier fix, mark v0.4.1 as [YANKED] - docs/guides/troubleshooting.md: Add section for "Provider produced inconsistent result" error with upgrade instructions - docs/index.md: Remove obsolete fgam_serialization provider
1 parent b377441 commit f3f1d99

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

CHANGELOG.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10-
## [0.4.1] - 2025-01-08
10+
### Fixed
11+
- Resolved plan modifier inconsistencies introduced with FGAM field additions in v0.4.0
12+
- Fixed "Provider produced inconsistent result after apply" errors by correctly configuring UseStateForUnknown() plan modifiers for immutable vs mutable computed fields
13+
- Immutable fields (id, created_at, creator) now use UseStateForUnknown() to prevent "(known after apply)" noise
14+
- Mutable FGAM fields (updated_at, updater) correctly omit UseStateForUnknown() to display actual API values
15+
16+
## [0.4.1] - 2025-01-08 [YANKED]
1117

1218
### Fixed
1319
- Ensures consistent behavior across all resources and eliminates plan inconsistencies for policy updates
1420

21+
**Note:** This version has been yanked due to incomplete plan modifier configuration. Use v0.5.0+ instead.
22+
1523
## [0.4.0] - 2025-01-08
1624

1725
### Added

docs/guides/troubleshooting.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,24 @@ provider "authzed" {
111111
}
112112
```
113113

114+
## Resource Management Issues
115+
116+
### "Provider produced inconsistent result after apply"
117+
118+
If you encounter errors like:
119+
120+
```
121+
Error: Provider produced inconsistent result after apply
122+
123+
When applying changes to authzed_policy.example, provider
124+
"registry.terraform.io/authzed/authzed" produced an unexpected new value:
125+
.created_at: was "2025-01-08T10:00:00Z", but now cty.StringVal("").
126+
```
127+
128+
**Root Cause:**
129+
This error was caused by incorrect plan modifier configuration for computed fields in provider versions prior to v0.5.0.
130+
131+
114132
## Getting Help
115133

116134
If you continue to experience issues:

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ provider "authzed" {
2828
# Uncomment to specify a different API version
2929
# api_version = "25r1"
3030
31-
# Uncomment to enable serialization for high-concurrency scenarios
32-
# fgam_serialization = true
31+
3332
}
3433
```
3534

@@ -49,7 +48,7 @@ To obtain a token, contact your AuthZed account team. They will provide you with
4948
* `endpoint` - (Required) The host address of the AuthZed Cloud API. Default is `https://api.admin.stage.aws.authzed.net`.
5049
* `token` - (Required) The bearer token for authentication with AuthZed.
5150
* `api_version` - (Optional) The version of the API to use. Default is "25r1".
52-
* `fgam_serialization` - (Optional) Enable serialization of operations to prevent conflicts. When enabled, resources within the same permission system will be created/updated sequentially instead of in parallel. Default is `false`.
51+
5352

5453
## Important Notes
5554

0 commit comments

Comments
 (0)