remove plan modifier from state parameter in cluster resource

This commit removes the UseStateForUnknown plan modifier from the cluster resource's state attribute. This change resolves inconsistent results after apply caused by mismatched values between the state and plan.
cockroachdb · Feb 27, 2025 · 85083c4 · 85083c4
1 parent c67e8c2
commit 85083c4
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.11.3] - 2025-02-27
+
+### Fixed
+
+- Remove UseStateForUnknown plan modifier for state parameter in cluster resource.
+
 ## [1.11.2] - 2025-02-07
 
 ### Fixed

diff --git a/internal/provider/cluster_resource.go b/internal/provider/cluster_resource.go
@@ -217,9 +217,9 @@ func (r *clusterResource) Schema(
 						Description: "Storage amount per node in GiB.",
 					},
 					"disk_iops": schema.Int64Attribute{
-						Optional:    true,
-						Computed:    true,
-						Validators:  []validator.Int64{
+						Optional: true,
+						Computed: true,
+						Validators: []validator.Int64{
 							// If supplied this value must be non-zero. 0 is a
 							// valid api value indicating the default being
 							// returned but it causes a provider inconsistency.
@@ -232,8 +232,8 @@ func (r *clusterResource) Schema(
 						Description: "Memory per node in GiB.",
 					},
 					"machine_type": schema.StringAttribute{
-						Optional:    true,
-						Computed:    true,
+						Optional:            true,
+						Computed:            true,
 						MarkdownDescription: "Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4. This attribute requires a feature flag to be enabled. It is recommended to leave this empty and use `num_virtual_cpus` to control the machine type.",
 					},
 					"num_virtual_cpus": schema.Int64Attribute{
@@ -268,9 +268,6 @@ func (r *clusterResource) Schema(
 			},
 			"state": schema.StringAttribute{
 				Computed:    true,
-				PlanModifiers: []planmodifier.String{
-					stringplanmodifier.UseStateForUnknown(),
-				},
 				Description: "Describes whether the cluster is being created, updated, deleted, etc.",
 			},
 			"creator_id": schema.StringAttribute{
@@ -302,32 +299,32 @@ func (r *clusterResource) Schema(
 				Description: "Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.",
 			},
 			"backup_config": schema.SingleNestedAttribute{
-				Computed: true,
-				Optional: true,
+				Computed:            true,
+				Optional:            true,
 				MarkdownDescription: "The backup settings for a cluster.\n Each cluster has backup settings that determine if backups are enabled, how frequently they are taken, and how long they are retained for. Use this attribute to manage those settings.",
 				PlanModifiers: []planmodifier.Object{
 					objectplanmodifier.UseStateForUnknown(),
 				},
 				Attributes: map[string]schema.Attribute{
 					"enabled": schema.BoolAttribute{
-						Optional:    true,
-						Computed:    true,
+						Optional: true,
+						Computed: true,
 						PlanModifiers: []planmodifier.Bool{
 							boolplanmodifier.UseStateForUnknown(),
 						},
 						Description: "Indicates whether backups are enabled. If set to false, no backups will be created.",
 					},
 					"retention_days": schema.Int64Attribute{
-						Optional:   true,
-						Computed:   true,
+						Optional: true,
+						Computed: true,
 						PlanModifiers: []planmodifier.Int64{
 							int64planmodifier.UseStateForUnknown(),
 						},
 						MarkdownDescription: "The number of days to retain backups for.  Valid values are [2, 7, 30, 90, 365]. Can only be set once, further changes require opening a support ticket. See [Updating backup retention](../guides/updating-backup-retention) for more information.",
 					},
 					"frequency_minutes": schema.Int64Attribute{
-						Optional:   true,
-						Computed:   true,
+						Optional: true,
+						Computed: true,
 						PlanModifiers: []planmodifier.Int64{
 							int64planmodifier.UseStateForUnknown(),
 						},
@@ -632,7 +629,7 @@ func (r *clusterResource) Create(
 			backupUpdateRequest.FrequencyMinutes = ptr(int32(planBackupConfig.FrequencyMinutes.ValueInt64()))
 		}
 
-		if  backupUpdateRequest != (client.UpdateBackupConfigurationSpec{}) {
+		if backupUpdateRequest != (client.UpdateBackupConfigurationSpec{}) {
 			traceAPICall("UpdateBackupConfiguration")
 			remoteBackupConfig, _, err = r.provider.service.UpdateBackupConfiguration(ctx, clusterObj.Id, &backupUpdateRequest)
 			if err != nil {
@@ -1087,7 +1084,7 @@ func (r *clusterResource) Update(
 			backupUpdateRequest.FrequencyMinutes = ptr(int32(planBackupConfig.FrequencyMinutes.ValueInt64()))
 		}
 
-		if  backupUpdateRequest != (client.UpdateBackupConfigurationSpec{}) {
+		if backupUpdateRequest != (client.UpdateBackupConfigurationSpec{}) {
 			traceAPICall("UpdateBackupConfiguration")
 			remoteBackupConfig, _, err = r.provider.service.UpdateBackupConfiguration(ctx, clusterObj.Id, &backupUpdateRequest)
 			if err != nil {
@@ -1332,12 +1329,11 @@ var backupConfigElementTypes = map[string]attr.Type{
 	"retention_days":    types.Int64Type,
 }
 
-func unknownBackupConfig(
-) (basetypes.ObjectValue, diag.Diagnostics) {
+func unknownBackupConfig() (basetypes.ObjectValue, diag.Diagnostics) {
 	elements := map[string]attr.Value{
-		"enabled": types.BoolUnknown(),
+		"enabled":           types.BoolUnknown(),
 		"frequency_minutes": types.Int64Unknown(),
-		"retention_days": types.Int64Unknown(),
+		"retention_days":    types.Int64Unknown(),
 	}
 	objectValue, diags := types.ObjectValue(backupConfigElementTypes, elements)
 	return objectValue, diags
@@ -1347,9 +1343,9 @@ func clientBackupConfigToProviderBackupConfig(
 	apiBackupConfig *client.BackupConfiguration,
 ) (basetypes.ObjectValue, diag.Diagnostics) {
 	elements := map[string]attr.Value{
-		"enabled": types.BoolValue(apiBackupConfig.GetEnabled()),
+		"enabled":           types.BoolValue(apiBackupConfig.GetEnabled()),
 		"frequency_minutes": types.Int64Value(int64(apiBackupConfig.GetFrequencyMinutes())),
-		"retention_days": types.Int64Value(int64(apiBackupConfig.GetRetentionDays())),
+		"retention_days":    types.Int64Value(int64(apiBackupConfig.GetRetentionDays())),
 	}
 	objectValue, diags := types.ObjectValue(backupConfigElementTypes, elements)
 	return objectValue, diags
@@ -1363,8 +1359,8 @@ func providerBackupConfigToClientBackupConfig(ctx context.Context, providerBacku
 	}
 
 	backupUpdateRequest := &client.BackupConfiguration{
-		Enabled: planBackupConfig.Enabled.ValueBool(),
-		RetentionDays: int32(planBackupConfig.RetentionDays.ValueInt64()),
+		Enabled:          planBackupConfig.Enabled.ValueBool(),
+		RetentionDays:    int32(planBackupConfig.RetentionDays.ValueInt64()),
 		FrequencyMinutes: int32(planBackupConfig.FrequencyMinutes.ValueInt64()),
 	}
 	return backupUpdateRequest, diags