add upgrade_type to cluster resource

upgrade_type is now added for BASIC and STANDARD clusters.  It can be
used to dictate how the cluster handles major version upgrades.  Valid
values for upgrade_type are AUTOMATIC and MANUAL.  BASIC clusters
support only AUTOMATIC upgrades.

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `upgrade_type` was added as an attribute for serverless clusters.
 - New `STANDARD` clusters with provisioned serverless capacity.
 - Ability to upgrade from `BASIC` plan to `STANDARD` plan.
 

docs/data-sources/cluster.md

@@ -79,6 +79,7 @@ Read-Only:
 
 - `routing_id` (String) Cluster identifier in a connection string.
 - `spend_limit` (Number, Deprecated) Spend limit in US cents.
+- `upgrade_type` (String) Dictates the behavior of cockroach major version upgrades.
 - `usage_limits` (Attributes) (see [below for nested schema](#nestedatt--serverless--usage_limits))
 
 <a id="nestedatt--serverless--usage_limits"></a>

docs/resources/cluster.md

@@ -38,6 +38,7 @@ resource "cockroach_cluster" "standard" {
     usage_limits = {
       provisioned_virtual_cpus = 2
     }
+    upgrade_type = "AUTOMATIC"
   }
   regions = [
     {
@@ -132,6 +133,9 @@ Read-Only:
 Optional:
 
 - `spend_limit` (Number, Deprecated) Spend limit in US cents.
+- `upgrade_type` (String) Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are: 
+  * MANUAL
+  * AUTOMATIC
 - `usage_limits` (Attributes) (see [below for nested schema](#nestedatt--serverless--usage_limits))
 
 Read-Only:

examples/resources/cockroach_cluster/resource.tf

@@ -23,6 +23,7 @@ resource "cockroach_cluster" "standard" {
     usage_limits = {
       provisioned_virtual_cpus = 2
     }
+    upgrade_type = "AUTOMATIC"
   }
   regions = [
     {

examples/workflows/cockroach_standard_cluster/main.tf

@@ -37,6 +37,12 @@ variable "cloud_provider_regions" {
   default  = ["us-central1"]
 }
 
+variable "upgrade_type" {
+  type     = string
+  nullable = false
+  default  = "AUTOMATIC"
+}
+
 terraform {
   required_providers {
     cockroach = {
@@ -56,6 +62,7 @@ resource "cockroach_cluster" "example" {
     usage_limits = {
       provisioned_virtual_cpus = var.provisioned_virtual_cpus
     }
+    upgrade_type = var.upgrade_type
   }
   regions = [for r in var.cloud_provider_regions : { name = r }]
 }

internal/provider/allowlist_resource_test.go

@@ -161,6 +161,7 @@ func TestIntegrationAllowlistEntryResource(t *testing.T) {
 				Config: client.ClusterConfig{
 					Serverless: &client.ServerlessClusterConfig{
 						RoutingId: "routing-id",
+						UpgradeType: client.UPGRADETYPETYPE_AUTOMATIC,
 					},
 				},
 				Regions: []client.Region{

internal/provider/cluster_data_source.go

@@ -89,6 +89,10 @@ func (d *clusterDataSource) Schema(
 						Computed:    true,
 						Description: "Cluster identifier in a connection string.",
 					},
+					"upgrade_type": schema.StringAttribute{
+						Computed:    true,
+						Description: "Dictates the behavior of cockroach major version upgrades.",
+					},
 				},
 			},
 			"dedicated": schema.SingleNestedAttribute{

internal/provider/cluster_resource.go

@@ -56,6 +56,14 @@ type clusterResource struct {
 	provider *provider
 }
 
+var AllowedUpgradeTypeTypeEnumValueStrings = func() []string {
+	var strings []string
+	for i := range client.AllowedUpgradeTypeTypeEnumValues {
+		strings = append(strings, string(client.AllowedUpgradeTypeTypeEnumValues[i]))
+	}
+	return strings
+}()
+
 var regionSchema = schema.NestedAttributeObject{
 	Attributes: map[string]schema.Attribute{
 		"name": schema.StringAttribute{
@@ -179,6 +187,16 @@ func (r *clusterResource) Schema(
 						},
 						Description: "Cluster identifier in a connection string.",
 					},
+					"upgrade_type": schema.StringAttribute{
+						Computed: true,
+						Optional: true,
+						PlanModifiers: []planmodifier.String{
+							stringplanmodifier.UseStateForUnknown(),
+						},
+						Validators:  []validator.String{stringvalidator.OneOf(AllowedUpgradeTypeTypeEnumValueStrings...)},
+						MarkdownDescription: "Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are: " +
+							formatEnumMarkdownList(AllowedUpgradeTypeTypeEnumValueStrings),
+					},
 				},
 			},
 			"dedicated": schema.SingleNestedAttribute{
@@ -363,6 +381,16 @@ func (r *clusterResource) Create(
 			serverless.UsageLimits.ProvisionedVirtualCpus = usageLimits.ProvisionedVirtualCpus.ValueInt64Pointer()
 		}
 
+		upgradeTypeString := plan.ServerlessConfig.UpgradeType.ValueString()
+		if upgradeTypeString != "" {
+			upgradeType, err := client.NewUpgradeTypeTypeFromValue(upgradeTypeString)
+			if err != nil {
+				resp.Diagnostics.AddError("Invalid Upgrade Type", err.Error())
+			} else {
+				serverless.SetUpgradeType(*upgradeType)
+			}
+		}
+
 		clusterSpec.SetServerless(*serverless)
 	} else if plan.DedicatedConfig != nil {
 		dedicated := client.DedicatedClusterCreateSpecification{}
@@ -758,6 +786,30 @@ func (r *clusterResource) Update(
 			serverless.UsageLimits.StorageMibLimit = usageLimits.StorageMibLimit.ValueInt64Pointer()
 			serverless.UsageLimits.ProvisionedVirtualCpus = usageLimits.ProvisionedVirtualCpus.ValueInt64Pointer()
 		}
+
+		planUpgradeType := plan.ServerlessConfig.UpgradeType.ValueString()
+		stateUpgradeType := state.ServerlessConfig.UpgradeType.ValueString()
+
+		// Only add the upgrade_type if it changed.
+		if planUpgradeType != "" && planUpgradeType != stateUpgradeType {
+
+			upgradeTypePtr, err := client.NewUpgradeTypeTypeFromValue(plan.ServerlessConfig.UpgradeType.ValueString())
+			if err != nil {
+				resp.Diagnostics.AddError("Invalid value for upgrade_type", err.Error())
+				return
+			}
+			upgradeType := *upgradeTypePtr
+
+			// Check this combination explicitly to provide a better message
+			// than the ccapi is currently returning for this case.
+			if plan.Plan.ValueString() == string(client.PLANTYPE_BASIC) && upgradeType == client.UPGRADETYPETYPE_MANUAL {
+				resp.Diagnostics.AddError("Invalid value for upgrade_type", "plan type BASIC does not allow upgrade_type MANUAL")
+				return
+			}
+
+			serverless.SetUpgradeType(upgradeType)
+		}
+
 		clusterReq.SetServerless(*serverless)
 	} else if cfg := plan.DedicatedConfig; cfg != nil {
 		dedicated := client.NewDedicatedClusterUpdateSpecification()
@@ -823,7 +875,6 @@ func (r *clusterResource) Update(
 	}
 
 	traceAPICall("UpdateCluster")
-
 	clusterObj, _, err := r.provider.service.UpdateCluster(ctx, state.ID.ValueString(), clusterReq)
 	if err != nil {
 		resp.Diagnostics.AddError(
@@ -982,6 +1033,7 @@ func loadClusterToTerraformState(
 	if clusterObj.Config.Serverless != nil {
 		serverlessConfig := &ServerlessClusterConfig{
 			RoutingId: types.StringValue(clusterObj.Config.Serverless.RoutingId),
+			UpgradeType: types.StringValue(string(clusterObj.Config.Serverless.UpgradeType)),
 		}
 
 		if plan != nil && plan.ServerlessConfig != nil && IsKnown(plan.ServerlessConfig.SpendLimit) {