[AV-87721] GSI release documentation for Terraform V1.4.0

docs/data-sources/query_index_monitor.md

@@ -0,0 +1,29 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "couchbase-capella_query_index_monitor Data Source - terraform-provider-couchbase-capella"
+subcategory: ""
+description: |-
+
+---
+
+# couchbase-capella_query_index_monitor (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `bucket_name` (String)
+- `cluster_id` (String)
+- `indexes` (Set of String)
+- `organization_id` (String)
+- `project_id` (String)
+
+### Optional
+
+- `collection_name` (String)
+- `scope_name` (String)

docs/data-sources/query_indexes.md

@@ -0,0 +1,40 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "couchbase-capella_query_indexes Data Source - terraform-provider-couchbase-capella"
+subcategory: ""
+description: |-
+
+---
+
+# couchbase-capella_query_indexes (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `bucket_name` (String)
+- `cluster_id` (String)
+- `organization_id` (String)
+- `project_id` (String)
+
+### Optional
+
+- `collection_name` (String)
+- `scope_name` (String)
+
+### Read-Only
+
+- `data` (Attributes Set) (see [below for nested schema](#nestedatt--data))
+
+<a id="nestedatt--data"></a>
+### Nested Schema for `data`
+
+Read-Only:
+
+- `definition` (String)
+- `index_name` (String)

docs/guides/1.4.0-upgrade-guide.md

@@ -15,6 +15,7 @@ New features in 1.4.0
 ## New Features
 * Enable Flush Bucket [`couchbase-capella_flush`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/flush)
 * Enable Azure Network Peer [`couchbase-capella_network_peer`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/network_peer)
+* GSI [`couchbase-capella_query_indexes`](https://registry.terraform.io/providers/couchbasecloud/couchbase-capella/latest/docs/resources/query_indexes)
 
 
 ## Flush Bucket
@@ -112,8 +113,96 @@ resource "couchbase-capella_network_peer" "new_network_peer" {
 ```
 For more information, see the [network peer examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/network_peer).
 
+## GSI
+To create a deferred index, use the `query_indexes` resource as follows:
+```
+locals {
+  index_template = templatefile("${path.module}/indexes3.json", {
+    organization_id = var.organization_id
+    project_id      = var.project_id
+    cluster_id      = var.cluster_id
+  })
+
+  decoded_template = jsondecode(local.index_template)
+  index_names      = [for idx, details in local.decoded_template.resource["couchbase-capella_indexes"] : details.index_name]
+}
+```
+```
+resource "couchbase-capella_query_indexes" "new_indexes" {
+  for_each        = jsondecode(local.index_template).resource["couchbase-capella_indexes"]
+  organization_id = each.value.organization_id
+  project_id      = each.value.project_id
+  cluster_id      = each.value.cluster_id
+  bucket_name     = each.value.bucket_name
+  scope_name      = each.value.scope_name
+  collection_name = each.value.collection_name
+  index_name      = each.value.index_name
+  index_keys      = each.value.index_keys
+  with = {
+    defer_build = each.value.with.defer_build
+  }
+}
+```
+```
+resource "couchbase-capella_query_indexes" "build_idx" {
+  organization_id = var.organization_id
+  project_id      = var.project_id
+  cluster_id      = var.cluster_id
+
+  bucket_name     = var.bucket_name
+  scope_name      = var.scope_name
+  collection_name = var.collection_name
+
+  build_indexes = local.index_names
+}
+```
+```
+output "mon_idx1" {
+  value = data.couchbase-capella_query_index_monitor.mon
+}
+```
+```
+data "couchbase-capella_query_index_monitor" "mon" {
+  organization_id = var.organization_id
+  project_id      = var.project_id
+  cluster_id      = var.cluster_id
+  bucket_name     = var.bucket_name
+  scope_name      = var.scope_name
+  collection_name = var.collection_name
+  indexes         = local.index_names
+
+  depends_on = [couchbase-capella_query_indexes.build_idx]
+}
+```
+For more information, see the [query_indexes](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/gsi/deferred).
+
+To create a non-deferred index, use the `query_indexs` resource as follows:
+```
+locals {
+  index_template = templatefile("${path.module}/indexes.json", {
+    organization_id = var.organization_id
+    project_id      = var.project_id
+    cluster_id      = var.cluster_id
+  })
+}
+```
+```
+resource "couchbase-capella_query_indexes" "new_indexes" {
+  for_each        = jsondecode(local.index_template).resource["couchbase-capella_indexes"]
+  organization_id = each.value.organization_id
+  project_id      = each.value.project_id
+  cluster_id      = each.value.cluster_id
+  bucket_name     = each.value.bucket_name
+  scope_name      = each.value.scope_name
+  collection_name = each.value.collection_name
+  index_name      = each.value.index_name
+  index_keys      = each.value.index_keys
+}
+```
+For more information, see the [query_indexes](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/gsi/non_deferred).
+
 ### Helpful Links
 
 - [Getting Started with the Terraform Provider](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples/getting_started)
-- [Capella V4 Management APIs](https://docs.couchbase.com/cloud/management-api-reference/index.html)
-- [Specific Examples in the examples folder](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples)
+- [Capella Management API v4.0](https://docs.couchbase.com/cloud/management-api-reference/index.html)
+- [See Specific Examples](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/blob/master/examples)

docs/index.md

@@ -306,3 +306,7 @@ To get started, see the [Provider Example Configs](https://github.com/couchbasec
 
   Manage Flush Bucket
 
+* [Manage GSI](https://github.com/couchbasecloud/terraform-provider-couchbase-capella/tree/main/examples/gsi)
+
+  Manage GSI
+

docs/resources/query_indexes.md

@@ -0,0 +1,44 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "couchbase-capella_query_indexes Resource - terraform-provider-couchbase-capella"
+subcategory: ""
+description: |-
+
+---
+
+# couchbase-capella_query_indexes (Resource)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `bucket_name` (String)
+- `cluster_id` (String)
+- `organization_id` (String)
+- `project_id` (String)
+
+### Optional
+
+- `build_indexes` (Set of String)
+- `collection_name` (String)
+- `index_keys` (List of String)
+- `index_name` (String)
+- `is_primary` (Boolean)
+- `partition_by` (List of String)
+- `scope_name` (String)
+- `where` (String)
+- `with` (Attributes) (see [below for nested schema](#nestedatt--with))
+
+<a id="nestedatt--with"></a>
+### Nested Schema for `with`
+
+Optional:
+
+- `defer_build` (Boolean)
+- `num_partition` (Number)
+- `num_replica` (Number)

examples/getting_started/README.md

@@ -19,6 +19,7 @@ In this demo, we will perform the following operations:
 15. Create a new audit log settings.
 16. Enable private endpoint service on the cluster.
 17. Create a new network peer.
+18. Create an index.
 
 ## Pre-Requisites:
 

examples/getting_started/gsi.tf

@@ -0,0 +1,19 @@
+resource "couchbase-capella_query_indexes" "idx" {
+  organization_id = var.organization_id
+  project_id      = couchbase-capella_project.new_project.id
+  cluster_id      = couchbase-capella_cluster.new_cluster.id
+
+  bucket_name     = couchbase-capella_bucket.new_bucket.name
+  scope_name      = couchbase-capella_scope.new_scope.scope_name
+  collection_name = couchbase-capella_collection.new_collection.collection_name
+
+  index_name   = var.index_name
+  index_keys   = var.index_keys
+  partition_by = var.partition_by
+
+  with = {
+    defer_build   = var.with.defer_build
+    num_replica   = var.with.num_replica
+    num_partition = var.with.num_partition
+  }
+}

examples/getting_started/terraform.template.tfvars

@@ -192,4 +192,18 @@ aws_config = {
   vpc_id     = "vpc-141f0fffff141aa00"
   region     = "us-east-1"
   cidr       = "10.0.0.0/16"
+}
+
+bucket_name     = "test"
+scope_name      = "test"
+collection_name = "test"
+
+index_name   = "idx_pe9"
+index_keys   = ["sourceairport", "destinationairport", "stops", "airline", "id", "ARRAY_COUNT(schedule)"]
+partition_by = ["sourceairport", "destinationairport"]
+
+with = {
+  defer_build   = false
+  num_replica   = 1
+  num_partition = 8
 }

examples/getting_started/variables.tf

@@ -241,3 +241,25 @@ variable "aws_config" {
     region     = optional(string)
   })
 }
+
+variable "index_name" {
+  description = "index Name"
+}
+
+variable "index_keys" {
+  description = "index keys"
+}
+
+variable "partition_by" {
+  description = "partition_by"
+}
+
+variable "with" {
+  description = "WITH clause"
+
+  type = object({
+    defer_build   = bool
+    num_replica   = number
+    num_partition = number
+  })
+}