v0.2.0: Refactor cluster resources (#38)

* v0.2.0: Refactor cluster resources - Consolidated create specs and update specs into configs - Added some basic validation to Create and Update - Updated and pruned examples - Reran `go generate` to format examples and update docs - Bumped version to 0.2.0 - Removed problematic wait_for_cluster_ready flag - Simplified the schema for the cluster data source * fixed cluster region sort Regions in the cluster response are now sorted according to the order they show up in the plan. If a cluster doesn't show up in the plan, its ordinal defaults to 0 and it shows up first in the output, where Terraform will rightfully complain. * Fixed namespace for local provider resolution * test cluster name updates * bug fixes * updated doc generator and reran
cockroachdb · Oct 26, 2022 · 167d18e · 167d18e
1 parent 3f75d67
commit 167d18e
Show file tree

Hide file tree

Showing 26 changed files with 610 additions and 821 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,5 +1 @@
 _Add a description of the problem this PR addresses and an overview of how this PR works_.
-
-**Checklist**
-
-* [ ] I have added these changes to the changelog (or it's not applicable).
diff --git a/Makefile b/Makefile
@@ -1,9 +1,9 @@
 TEST?=$$(go list ./... | grep -v 'vendor')
 HOSTNAME=registry.terraform.io
-NAMESPACE=hashicorp
+NAMESPACE=cockroachdb
 NAME=cockroach
 BINARY=terraform-provider-${NAME}
-VERSION=0.1.1
+VERSION=0.2.0
 OS_ARCH=darwin_amd64
 
 default: install

diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md
@@ -15,38 +15,25 @@ clusterSourceType Data Source
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
-
-- `cloud_provider` (String)
-- `id` (String) The ID of this resource.
-
-### Optional
-
-- `config` (Attributes) (see [below for nested schema](#nestedatt--config))
-
 ### Read-Only
 
 - `account_id` (String)
+- `cloud_provider` (String)
 - `cockroach_version` (String)
 - `creator_id` (String)
+- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--dedicated))
+- `id` (String) The ID of this resource.
 - `name` (String) Name of cluster
 - `operation_status` (String)
 - `plan` (String)
 - `regions` (Attributes List) (see [below for nested schema](#nestedatt--regions))
+- `serverless` (Attributes) (see [below for nested schema](#nestedatt--serverless))
 - `state` (String)
 
-<a id="nestedatt--config"></a>
-### Nested Schema for `config`
-
-Optional:
-
-- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--config--dedicated))
-- `serverless` (Attributes) (see [below for nested schema](#nestedatt--config--serverless))
+<a id="nestedatt--dedicated"></a>
+### Nested Schema for `dedicated`
 
-<a id="nestedatt--config--dedicated"></a>
-### Nested Schema for `config.dedicated`
-
-Optional:
+Read-Only:
 
 - `disk_iops` (Number)
 - `machine_type` (String)
@@ -55,16 +42,6 @@ Optional:
 - `storage_gib` (Number)
 
 
-<a id="nestedatt--config--serverless"></a>
-### Nested Schema for `config.serverless`
-
-Optional:
-
-- `routing_id` (String)
-- `spend_limit` (Number)
-
-
-
 <a id="nestedatt--regions"></a>
 ### Nested Schema for `regions`
 
@@ -76,3 +53,12 @@ Read-Only:
 - `ui_dns` (String)
 
 
+<a id="nestedatt--serverless"></a>
+### Nested Schema for `serverless`
+
+Read-Only:
+
+- `routing_id` (String)
+- `spend_limit` (Number)
+
+
diff --git a/docs/index.md b/docs/index.md
@@ -14,14 +14,14 @@ description: |-
 
 ```terraform
 provider "cockroach" {
-    # Instructions for using the CockroachDB Cloud API
-    # https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api.html
-    #
-    # Instructions for getting an API Key
-    # https://www.cockroachlabs.com/docs/cockroachcloud/console-access-management#api-access
-    #
-    # The Terraform provider requires an environment variable COCKROACH_API_KEY
-    # export COCKROACH_API_KEY="the API Key value here"
+  # Instructions for using the CockroachDB Cloud API
+  # https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api.html
+  #
+  # Instructions for getting an API Key
+  # https://www.cockroachlabs.com/docs/cockroachcloud/console-access-management#api-access
+  #
+  # The Terraform provider requires an environment variable COCKROACH_API_KEY
+  # export COCKROACH_API_KEY="the API Key value here"
 }
 ```
 

diff --git a/docs/resources/allow_list.md b/docs/resources/allow_list.md
@@ -19,12 +19,15 @@ Allow list of IP range
 
 - `cidr_ip` (String)
 - `cidr_mask` (Number)
-- `id` (String) The ID of this resource.
 - `sql` (Boolean)
 - `ui` (Boolean)
 
 ### Optional
 
 - `name` (String)
 
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
 
diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -19,155 +19,64 @@ Cluster Resource
 
 - `cloud_provider` (String)
 - `name` (String) Name of cluster
+- `regions` (Attributes List) (see [below for nested schema](#nestedatt--regions))
 
 ### Optional
 
 - `cockroach_version` (String)
-- `create_spec` (Attributes) (see [below for nested schema](#nestedatt--create_spec))
-- `update_spec` (Attributes) (see [below for nested schema](#nestedatt--update_spec))
-- `wait_for_cluster_ready` (Boolean)
+- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--dedicated))
+- `serverless` (Attributes) (see [below for nested schema](#nestedatt--serverless))
 
 ### Read-Only
 
 - `account_id` (String)
-- `config` (Attributes) (see [below for nested schema](#nestedatt--config))
 - `creator_id` (String)
 - `id` (String) The ID of this resource.
 - `operation_status` (String)
 - `plan` (String)
-- `regions` (Attributes List) (see [below for nested schema](#nestedatt--regions))
 - `state` (String)
 
-<a id="nestedatt--create_spec"></a>
-### Nested Schema for `create_spec`
-
-Optional:
-
-- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--create_spec--dedicated))
-- `serverless` (Attributes) (see [below for nested schema](#nestedatt--create_spec--serverless))
-
-<a id="nestedatt--create_spec--dedicated"></a>
-### Nested Schema for `create_spec.dedicated`
-
-Optional:
-
-- `cockroach_version` (String)
-- `hardware` (Attributes) (see [below for nested schema](#nestedatt--create_spec--dedicated--hardware))
-- `region_nodes` (Map of Number)
-
-<a id="nestedatt--create_spec--dedicated--hardware"></a>
-### Nested Schema for `create_spec.dedicated.hardware`
-
-Optional:
-
-- `disk_iops` (Number)
-- `machine_spec` (Attributes) (see [below for nested schema](#nestedatt--create_spec--dedicated--hardware--machine_spec))
-- `storage_gib` (Number)
-
-<a id="nestedatt--create_spec--dedicated--hardware--machine_spec"></a>
-### Nested Schema for `create_spec.dedicated.hardware.storage_gib`
-
-Optional:
-
-- `machine_type` (String)
-- `num_virtual_cpus` (Number)
-
-
-
-
-<a id="nestedatt--create_spec--serverless"></a>
-### Nested Schema for `create_spec.serverless`
-
-Optional:
-
-- `regions` (List of String)
-- `spend_limit` (Number)
-
+<a id="nestedatt--regions"></a>
+### Nested Schema for `regions`
 
+Required:
 
-<a id="nestedatt--update_spec"></a>
-### Nested Schema for `update_spec`
+- `name` (String)
 
 Optional:
 
-- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--update_spec--dedicated))
-- `serverless` (Attributes) (see [below for nested schema](#nestedatt--update_spec--serverless))
+- `node_count` (Number)
 
-<a id="nestedatt--update_spec--dedicated"></a>
-### Nested Schema for `update_spec.dedicated`
+Read-Only:
 
-Optional:
+- `sql_dns` (String)
+- `ui_dns` (String)
 
-- `hardware` (Attributes) (see [below for nested schema](#nestedatt--update_spec--dedicated--hardware))
-- `region_nodes` (Map of Number)
 
-<a id="nestedatt--update_spec--dedicated--hardware"></a>
-### Nested Schema for `update_spec.dedicated.hardware`
+<a id="nestedatt--dedicated"></a>
+### Nested Schema for `dedicated`
 
 Optional:
 
 - `disk_iops` (Number)
-- `machine_spec` (Attributes) (see [below for nested schema](#nestedatt--update_spec--dedicated--hardware--machine_spec))
-- `storage_gib` (Number)
-
-<a id="nestedatt--update_spec--dedicated--hardware--machine_spec"></a>
-### Nested Schema for `update_spec.dedicated.hardware.storage_gib`
-
-Optional:
-
 - `machine_type` (String)
 - `num_virtual_cpus` (Number)
-
-
-
-
-<a id="nestedatt--update_spec--serverless"></a>
-### Nested Schema for `update_spec.serverless`
-
-Optional:
-
-- `spend_limit` (Number)
-
-
-
-<a id="nestedatt--config"></a>
-### Nested Schema for `config`
-
-Read-Only:
-
-- `dedicated` (Attributes) (see [below for nested schema](#nestedatt--config--dedicated))
-- `serverless` (Attributes) (see [below for nested schema](#nestedatt--config--serverless))
-
-<a id="nestedatt--config--dedicated"></a>
-### Nested Schema for `config.dedicated`
+- `storage_gib` (Number)
 
 Read-Only:
 
-- `disk_iops` (Number)
-- `machine_type` (String)
 - `memory_gib` (Number)
-- `num_virtual_cpus` (Number)
-- `storage_gib` (Number)
 
 
-<a id="nestedatt--config--serverless"></a>
-### Nested Schema for `config.serverless`
+<a id="nestedatt--serverless"></a>
+### Nested Schema for `serverless`
 
-Read-Only:
+Optional:
 
-- `routing_id` (String)
 - `spend_limit` (Number)
 
-
-
-<a id="nestedatt--regions"></a>
-### Nested Schema for `regions`
-
 Read-Only:
 
-- `name` (String)
-- `node_count` (Number)
-- `sql_dns` (String)
-- `ui_dns` (String)
+- `routing_id` (String)
 
 
diff --git a/docs/resources/sql_user.md b/docs/resources/sql_user.md
@@ -17,8 +17,11 @@ SQL user and password
 
 ### Required
 
-- `id` (String) The ID of this resource.
 - `name` (String)
 - `password` (String, Sensitive)
 
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
 
diff --git a/examples/data-sources/cockroach_cluster/cockroach_cluster.tf b/examples/data-sources/cockroach_cluster/cockroach_cluster.tf
@@ -1,13 +1,7 @@
-variable cluster_id {
-  type = string
-}
-
-variable cloud_provider {
+variable "cluster_id" {
   type = string
 }
 
 data "cockroach_cluster" "cockroach" {
   id = var.cluster_id
-  cloud_provider = var.cloud_provider
 }
-
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,10 +1,10 @@
 provider "cockroach" {
-    # Instructions for using the CockroachDB Cloud API
-    # https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api.html
-    #
-    # Instructions for getting an API Key
-    # https://www.cockroachlabs.com/docs/cockroachcloud/console-access-management#api-access
-    #
-    # The Terraform provider requires an environment variable COCKROACH_API_KEY
-    # export COCKROACH_API_KEY="the API Key value here"
+  # Instructions for using the CockroachDB Cloud API
+  # https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api.html
+  #
+  # Instructions for getting an API Key
+  # https://www.cockroachlabs.com/docs/cockroachcloud/console-access-management#api-access
+  #
+  # The Terraform provider requires an environment variable COCKROACH_API_KEY
+  # export COCKROACH_API_KEY="the API Key value here"
 }
diff --git a/examples/resources/cockroach_dedicated_cluster/cockroach_dedicated_cluster.tf b/examples/resources/cockroach_dedicated_cluster/cockroach_dedicated_cluster.tf
@@ -1,17 +1,14 @@
 resource "cockroach_cluster" "cockroach" {
-    name           = "cockroach-dedicated"
-    cloud_provider = "GCP"
-    create_spec = {
-    dedicated: {
-        region_nodes = {
-          "us-central1": 1
-        }
-        hardware = {
-          storage_gib = 15
-          machine_spec = {
-            machine_type = "n1-standard-4"
-          }
-        }
+  name           = "cockroach-dedicated"
+  cloud_provider = "GCP"
+  dedicated = {
+    storage_gib  = 15
+    machine_type = "n1-standard-4"
+  }
+  regions = [
+    {
+      name       = "us-central1"
+      node_count = 1
     }
-   }
+  ]
 }