cockroachdb · fantapop · Sep 19, 2024 · Sep 18, 2024 · Jul 21, 2024 · Feb 14, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.8.0] - 2024-09-18
+
+### 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.
+
+### Changed
+
+- Renamed `SERVERLESS` plan type to `BASIC`.
+- Renamed `DEDICATED` plan type to `ADVANCED`.
+
+### Fixed
+
+- Fixed error when the primary attribute was specified in multiple regions,
+  even when false in all but one region.
+
+### Deprecated
+
+- Deprecated support for `spend_limit` attribute in `serverless` config. Users
+  can instead enforce resource limits with `usage_limits`.
+
 ## Fixed
 
 - Updated to version 2.0.1 of cockroach-cloud-sdk-go

diff --git a/Makefile b/Makefile
@@ -4,7 +4,9 @@ NAMESPACE=cockroachdb
 NAME=cockroach
 BINARY=terraform-provider-${NAME}
 VERSION=1.6.0
-OS_ARCH=darwin_amd64
+OS := $(shell uname | tr A-Z a-z)
+ARCH := $(shell uname -m | sed 's/x86_64/amd64/')
+OS_ARCH := $(OS)_$(ARCH)
 
 default: install
 
@@ -16,7 +18,7 @@ generate:
 	go generate
 
 update-sdk:
-	go get github.com/cockroachdb/cockroach-cloud-sdk-go/v2
+	go get github.com/cockroachdb/cockroach-cloud-sdk-go/v3
 	go generate ./mock
 
 release:
@@ -33,10 +35,17 @@ release:
 	GOOS=windows GOARCH=386 go build -o ./bin/${BINARY}_${VERSION}_windows_386
 	GOOS=windows GOARCH=amd64 go build -o ./bin/${BINARY}_${VERSION}_windows_amd64
 
+# Use this to install a development binary to your local machine, in the TF
+# provider cache. Note that if this directory is present, using an "official"
+# version of the provider is disabled. Use "make clean" to reset.
 install: build
 	mkdir -p ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}
 	mv ${BINARY} ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}
 
+clean:
+	rm -rf ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/
+	go clean -testcache -i -x
+
 test:
 	go test ./... -v $(TESTARGS) -timeout 5m
 

diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md
@@ -40,7 +40,7 @@ data "cockroach_cluster" "cockroach" {
 - `name` (String) Name of the cluster.
 - `operation_status` (String) Describes the current long-running operation, if any.
 - `parent_id` (String) The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
-- `plan` (String) Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
+- `plan` (String) Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
 - `regions` (Attributes List) (see [below for nested schema](#nestedatt--regions))
 - `serverless` (Attributes) (see [below for nested schema](#nestedatt--serverless))
 - `state` (String) Describes whether the cluster is being created, updated, deleted, etc.
@@ -78,13 +78,15 @@ Read-Only:
 Read-Only:
 
 - `routing_id` (String) Cluster identifier in a connection string.
-- `spend_limit` (Number) Spend limit in US cents.
+- `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>
 ### Nested Schema for `serverless.usage_limits`
 
 Read-Only:
 
+- `provisioned_virtual_cpus` (Number) Maximum number of vCPUs that the cluster can use.
 - `request_unit_limit` (Number) Maximum number of Request Units that the cluster can consume during the month.
 - `storage_mib_limit` (Number) Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -3,22 +3,23 @@
 page_title: "cockroach_cluster Resource - terraform-provider-cockroach"
 subcategory: ""
 description: |-
-  CockroachDB Cloud cluster. Can be Dedicated or Serverless.
+  CockroachDB Cloud cluster.
 ---
 
 # cockroach_cluster (Resource)
 
-CockroachDB Cloud cluster. Can be Dedicated or Serverless.
+CockroachDB Cloud cluster.
 
 ## Example Usage
 
 ```terraform
-resource "cockroach_cluster" "dedicated" {
-  name           = "cockroach-dedicated"
+resource "cockroach_cluster" "advanced" {
+  name           = "cockroach-advanced"
   cloud_provider = "GCP"
+  plan           = "ADVANCED"
   dedicated = {
     storage_gib  = 15
-    machine_type = "n1-standard-4"
+    machine_type = "n2-standard-4"
   }
   regions = [
     {
@@ -29,11 +30,15 @@ resource "cockroach_cluster" "dedicated" {
   delete_protection = true
 }
 
-resource "cockroach_cluster" "serverless" {
-  name           = "cockroach-serverless"
+resource "cockroach_cluster" "standard" {
+  name           = "cockroach-standard"
   cloud_provider = "GCP"
+  plan           = "STANDARD"
   serverless = {
-    spend_limit = 1
+    usage_limits = {
+      provisioned_virtual_cpus = 2
+    }
+    upgrade_type = "AUTOMATIC"
   }
   regions = [
     {
@@ -42,6 +47,19 @@ resource "cockroach_cluster" "serverless" {
   ]
   delete_protection = false
 }
+
+resource "cockroach_cluster" "basic" {
+  name           = "cockroach-basic"
+  cloud_provider = "GCP"
+  plan           = "BASIC"
+  serverless     = {}
+  regions = [
+    {
+      name = "us-east1"
+    }
+  ]
+  delete_protection = false
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -62,6 +80,7 @@ resource "cockroach_cluster" "serverless" {
 - `dedicated` (Attributes) (see [below for nested schema](#nestedatt--dedicated))
 - `delete_protection` (Boolean) 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.
 - `parent_id` (String) The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
+- `plan` (String) Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
 - `serverless` (Attributes) (see [below for nested schema](#nestedatt--serverless))
 
 ### Read-Only
@@ -70,7 +89,6 @@ resource "cockroach_cluster" "serverless" {
 - `creator_id` (String) ID of the user who created the cluster.
 - `id` (String) The ID of this resource.
 - `operation_status` (String) Describes the current long-running operation, if any.
-- `plan` (String) Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
 - `state` (String) Describes whether the cluster is being created, updated, deleted, etc.
 - `upgrade_status` (String) Describes the status of any in-progress CockroachDB upgrade or rollback.
 
@@ -84,7 +102,7 @@ Required:
 Optional:
 
 - `node_count` (Number) Number of nodes in the region. Will always be 0 for serverless clusters.
-- `primary` (Boolean) Set to true to mark this region as the primary for a Serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
+- `primary` (Boolean) Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
 
 Read-Only:
 
@@ -114,7 +132,10 @@ Read-Only:
 
 Optional:
 
-- `spend_limit` (Number) Spend limit in US cents.
+- `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:
@@ -124,7 +145,8 @@ Read-Only:
 <a id="nestedatt--serverless--usage_limits"></a>
 ### Nested Schema for `serverless.usage_limits`
 
-Required:
+Optional:
 
+- `provisioned_virtual_cpus` (Number) Maximum number of vCPUs that the cluster can use.
 - `request_unit_limit` (Number) Maximum number of Request Units that the cluster can consume during the month.
 - `storage_mib_limit` (Number) Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
diff --git a/docs/resources/cmek.md b/docs/resources/cmek.md
@@ -82,7 +82,7 @@ Required:
 Optional:
 
 - `node_count` (Number) Number of nodes in the region. Will always be 0 for serverless clusters.
-- `primary` (Boolean) Set to true to mark this region as the primary for a Serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
+- `primary` (Boolean) Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
 
 Read-Only:
 

diff --git a/examples/resources/cockroach_cluster/resource.tf b/examples/resources/cockroach_cluster/resource.tf
@@ -1,9 +1,10 @@
-resource "cockroach_cluster" "dedicated" {
-  name           = "cockroach-dedicated"
+resource "cockroach_cluster" "advanced" {
+  name           = "cockroach-advanced"
   cloud_provider = "GCP"
+  plan           = "ADVANCED"
   dedicated = {
     storage_gib  = 15
-    machine_type = "n1-standard-4"
+    machine_type = "n2-standard-4"
   }
   regions = [
     {
@@ -14,11 +15,15 @@ resource "cockroach_cluster" "dedicated" {
   delete_protection = true
 }
 
-resource "cockroach_cluster" "serverless" {
-  name           = "cockroach-serverless"
+resource "cockroach_cluster" "standard" {
+  name           = "cockroach-standard"
   cloud_provider = "GCP"
+  plan           = "STANDARD"
   serverless = {
-    spend_limit = 1
+    usage_limits = {
+      provisioned_virtual_cpus = 2
+    }
+    upgrade_type = "AUTOMATIC"
   }
   regions = [
     {
@@ -27,3 +32,16 @@ resource "cockroach_cluster" "serverless" {
   ]
   delete_protection = false
 }
+
+resource "cockroach_cluster" "basic" {
+  name           = "cockroach-basic"
+  cloud_provider = "GCP"
+  plan           = "BASIC"
+  serverless     = {}
+  regions = [
+    {
+      name = "us-east1"
+    }
+  ]
+  delete_protection = false
+}
diff --git a/...flows/cockroach_dedicated_cluster/main.tf → ...kflows/cockroach_advanced_cluster/main.tf b/...flows/cockroach_dedicated_cluster/main.tf → ...kflows/cockroach_advanced_cluster/main.tf
@@ -93,6 +93,7 @@ provider "cockroach" {
 resource "cockroach_cluster" "example" {
   name           = var.cluster_name
   cloud_provider = var.cloud_provider
+  plan           = "ADVANCED"
   dedicated = {
     storage_gib      = var.storage_gib
     num_virtual_cpus = var.num_virtual_cpus

diff --git a/...lows/cockroach_serverless_cluster/main.tf → ...workflows/cockroach_basic_cluster/main.tf b/...lows/cockroach_serverless_cluster/main.tf → ...workflows/cockroach_basic_cluster/main.tf
@@ -19,12 +19,6 @@ variable "sql_user_password" {
   sensitive = true
 }
 
-variable "serverless_spend_limit" {
-  type     = number
-  nullable = false
-  default  = 0
-}
-
 variable "cloud_provider" {
   type     = string
   nullable = false
@@ -51,10 +45,9 @@ provider "cockroach" {
 resource "cockroach_cluster" "example" {
   name           = var.cluster_name
   cloud_provider = var.cloud_provider
-  serverless = {
-    spend_limit = var.serverless_spend_limit
-  }
-  regions = [for r in var.cloud_provider_regions : { name = r }]
+  plan           = "BASIC"
+  serverless     = {}
+  regions        = [for r in var.cloud_provider_regions : { name = r }]
 }
 
 resource "cockroach_sql_user" "example" {

diff --git a/examples/workflows/cockroach_client_ca_cert/main.tf b/examples/workflows/cockroach_client_ca_cert/main.tf
@@ -30,7 +30,7 @@ variable "storage_gib" {
 variable "machine_type" {
   type     = string
   nullable = false
-  default  = "n1-standard-2"
+  default  = "n2-standard-2"
 }
 
 terraform {

diff --git a/examples/workflows/cockroach_folder/main.tf b/examples/workflows/cockroach_folder/main.tf
@@ -13,10 +13,10 @@ variable "cluster_name" {
   nullable = false
 }
 
-variable "serverless_spend_limit" {
+variable "provisioned_virtual_cpus" {
   type     = number
   nullable = false
-  default  = 0
+  default  = 2
 }
 
 variable "cloud_provider" {
@@ -73,8 +73,11 @@ resource "cockroach_user_role_grant" "cluster_creator_grant" {
 resource "cockroach_cluster" "example" {
   name           = var.cluster_name
   cloud_provider = var.cloud_provider
+  plan           = "STANDARD"
   serverless = {
-    spend_limit = var.serverless_spend_limit
+    usage_limits = {
+      provisioned_virtual_cpus = var.provisioned_virtual_cpus
+    }
   }
   regions   = [for r in var.cloud_provider_regions : { name = r }]
   parent_id = cockroach_folder.example_folder_parent.id

diff --git a/examples/workflows/cockroach_log_export_config/gcp_cockroach_log_export_config/main.tf b/examples/workflows/cockroach_log_export_config/gcp_cockroach_log_export_config/main.tf
@@ -29,7 +29,7 @@ variable "storage_gib" {
 variable "machine_type" {
   type     = string
   nullable = false
-  default  = "n1-standard-2"
+  default  = "n2-standard-2"
 }
 
 variable "iam_role_id" {

diff --git a/examples/workflows/cockroach_metric_export/gcp/main.tf b/examples/workflows/cockroach_metric_export/gcp/main.tf
@@ -18,7 +18,7 @@ variable "storage_gib" {
 variable "machine_type" {
   type     = string
   nullable = false
-  default  = "n1-standard-2"
+  default  = "n2-standard-2"
 }
 
 variable "gcp_region" {