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

a-atri · 2024-11-21T09:49:31Z

Jira

AV-87721

Description

Release documentation of GSI for terraform version V1.4.0

Type of Change

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
This change requires a documentation update
Documentation fix/enhancement

Manual Testing Approach

How was this change tested and do you have evidence? (REQUIRED: Select at least 1)

Manually tested
Unit tested
Acceptance tested
Unable to test / will not test (Please provide comments in section below)

Testing

Required Checklist:

I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if required)
I have run make fmt and formatted my code
I have made sure that no schema field is marked with both requiresReplace and computed

Further comments

…ovider-couchbase-capella into AV-76498_gsi

simon-dew

A few comments

docs/guides/1.4.0-upgrade-guide.md

simon-dew · 2024-11-21T15:13:16Z

docs/guides/1.4.0-upgrade-guide.md

See also comments in #243

simon-dew · 2024-11-21T15:14:47Z

docs/index.md

See comments in #243 . The following comments apply here also:

The top few entries in this list have more description under the link. The later entries, including these two, just repeat the link title. Could expand the descriptions for later entries including these two. Little point in just repeating the link title text.

The top few entries in this list have a colon (:) after the link. For consistency, either remove the colon from the top few entries or add a colon to all subsequent entries, including these two.

simon-dew · 2024-11-21T15:23:19Z

examples/gsi/deferred/README.md

+
+This example shows how to create secondary indexes on a Capella cluster.
+
+This creates 5 deferred indexes in test.test.test.  Deferred indexes are best suited for large indexes, or when creating many indexes.


Maybe spell it out?

Suggested change

This creates 5 deferred indexes in test.test.test. Deferred indexes are best suited for large indexes, or when creating many indexes.

This creates 5 deferred indexes in a collection called `test`, which is located in a scope called `test` within a bucket also called `test`. Deferred indexes are best suited for large indexes, or when creating many indexes.

In addition to what Simon indicated - which is providing the clarify - I though we had discussed this previously and we we were going to use more meaningful names and not just test, test, test - at very laest "mybucket", "myscope" and "mycollection"

Also many indexes to multiple indexes. (Essentially, since we can't give a number, we can leave it as plural)

examples/gsi/deferred/README.md

simon-dew · 2024-11-21T15:32:06Z

examples/gsi/non_deferred/README.md

+
+This example shows how to create secondary indexes on a Capella cluster.
+
+This creates 5 non-deferred indexes in test.test.test.  Non-deferred indexes are best suited when creating small indexes.


Again, maybe spell it out?

Suggested change

This creates 5 non-deferred indexes in test.test.test. Non-deferred indexes are best suited when creating small indexes.

This creates 5 non-deferred indexes in a collection called `test`, which is located in a scope called `test` within a bucket also called `test`. Non-deferred indexes are best suited when creating small indexes.

simon-dew · 2024-11-21T15:33:23Z

examples/gsi/non_deferred/README.md

+
+This creates 5 non-deferred indexes in test.test.test.  Non-deferred indexes are best suited when creating small indexes.
+
+To run configure your Couchbase Capella provider as described in README in the root of this project.


Suggested change

To run configure your Couchbase Capella provider as described in README in the root of this project.

To try this example, configure your Couchbase Capella provider as described in README in the root of this project.

simon-dew · 2024-11-21T15:34:04Z

examples/gsi/non_deferred/README.md

+3. DELETE: Delete the indexes.
+5. IMPORT: Import an index to the state file.
+
+If you check the `terraform.template.tfvars` file - Make sure you copy the file to `terraform.tfvars` and update the values of the variables as per the correct organization access.


Suggested change

If you check the `terraform.template.tfvars` file - Make sure you copy the file to `terraform.tfvars` and update the values of the variables as per the correct organization access.

Check the `terraform.template.tfvars` file. Make sure you copy the file to `terraform.tfvars` and update the values of the variables for your organization access.

simon-dew · 2024-11-21T15:36:31Z

examples/gsi/non_deferred/README.md

+### Ensure you create indexes.json which is a file with indexes
+### Place this file in the same directory as the terraform script.


As before, I don't like misusing the heading semantics just for emphasis.

Suggested change

### Ensure you create indexes.json which is a file with indexes

### Place this file in the same directory as the terraform script.

**Ensure you create `indexes.json`, which is a file with indexes.**

**Place this file in the same directory as the terraform script.**

rajagp · 2024-11-21T23:42:14Z

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


@l0n3star Tagging in reference to discussion on slack thread. Tagging here so we don't miss

rajagp · 2024-11-21T23:43:09Z

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.


What kind of index? GSI and deferred or non-deferred?

Co-authored-by: Simon Dew <[email protected]>

l0n3star added 30 commits September 11, 2024 21:06

api structs

1357aae

terraform structs

ff757ad

query index resource

5b9b6ad

implement ResourceWithValidateConfig

dd7fddd

refactor query index resource

7748ae0

query index datasource

1e32130

query index monitor datasource

3874e44

cleanup

db5f07e

fix list indexes

7b54667

fix import

b5239ff

documentation

5f43574

documentation

7d7a78a

add . to end of comments

6b32b38

handle build in progress

9589750

update example

b6ca35d

type assertion must be checked

582b6cc

update terraform.template.tfvars in example

ba0cd42

update variables in example

d9d93ec

use ValueString() for Where field

408546e

set state once

1292df8

remove resource from state file if externally deleted

26d86fa

imports

70a5e6d

poll index

e26e82e

refactor query_index_monitor

cff6e19

fix typo

605985c

fix index build validation

83f5524

watch indexes

158b509

remove listStringValues

a2673d0

do not poll on build in progress error

eb801d4

mark resource with buid in progress error as tainted

6a7597f

l0n3star and others added 22 commits November 1, 2024 12:02

refactor poll deferred indexes

3eaf05f

fix WatchIndexes

8e54e25

update examples

dcae6d3

don't save to state file on delete

218633a

in example don't list on destroy

9f65692

add comments

5c6efe5

make tffmt

1d1f308

golangci-lint run

155c53a

rate limiter

6620159

update comments

4d35b08

Merge branch 'main' of https://github.com/couchbasecloud/terraform-pr…

d3a728a

…ovider-couchbase-capella into AV-76498_gsi

go mod tidy

dbc7247

correct spelling

7e0c8e6

update EnsureIndexesAreCreated

e67bc4a

remove for_each for gsi monitor in example

62cc8b3

use WatchIndexes instead of EnsureIndexesAreCreated

9b7fc34

rate limit all gsi api calls

affbefc

update example

cf0fff7

adding gsi index acceptance test

c34b2ef

merge gsi

0801ce1

Release documentation for GSI Index

7ae6b22

Release documetation for GSI

52af5fe

a-atri requested review from a team as code owners November 21, 2024 09:49

a-atri requested review from rajagp and simon-dew November 21, 2024 14:07

simon-dew requested changes Nov 21, 2024

View reviewed changes

rajagp reviewed Nov 21, 2024

View reviewed changes

Updating docs based on the changes requested by the docs team

0375a68

Co-authored-by: Simon Dew <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

a-atri commented Nov 21, 2024 •

edited

Loading

simon-dew left a comment •

edited

Loading

simon-dew Nov 21, 2024

simon-dew Nov 21, 2024

simon-dew Nov 21, 2024

rajagp Nov 21, 2024 •

edited

Loading

rajagp Nov 21, 2024

simon-dew Nov 21, 2024

simon-dew Nov 21, 2024

simon-dew Nov 21, 2024

simon-dew Nov 21, 2024

rajagp Nov 21, 2024

rajagp Nov 21, 2024


		This example shows how to create secondary indexes on a Capella cluster.

		This creates 5 deferred indexes in test.test.test. Deferred indexes are best suited for large indexes, or when creating many indexes.

	This creates 5 deferred indexes in test.test.test. Deferred indexes are best suited for large indexes, or when creating many indexes.
	This creates 5 deferred indexes in a collection called `test`, which is located in a scope called `test` within a bucket also called `test`. Deferred indexes are best suited for large indexes, or when creating many indexes.


		This example shows how to create secondary indexes on a Capella cluster.

		This creates 5 non-deferred indexes in test.test.test. Non-deferred indexes are best suited when creating small indexes.

	This creates 5 non-deferred indexes in test.test.test. Non-deferred indexes are best suited when creating small indexes.
	This creates 5 non-deferred indexes in a collection called `test`, which is located in a scope called `test` within a bucket also called `test`. Non-deferred indexes are best suited when creating small indexes.


		This creates 5 non-deferred indexes in test.test.test. Non-deferred indexes are best suited when creating small indexes.

		To run configure your Couchbase Capella provider as described in README in the root of this project.

	To run configure your Couchbase Capella provider as described in README in the root of this project.
	To try this example, configure your Couchbase Capella provider as described in README in the root of this project.

	If you check the `terraform.template.tfvars` file - Make sure you copy the file to `terraform.tfvars` and update the values of the variables as per the correct organization access.
	Check the `terraform.template.tfvars` file. Make sure you copy the file to `terraform.tfvars` and update the values of the variables for your organization access.

		### Ensure you create indexes.json which is a file with indexes
		### Place this file in the same directory as the terraform script.

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

Are you sure you want to change the base?

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

Conversation

a-atri commented Nov 21, 2024 • edited Loading

Jira

Description

Type of Change

Manual Testing Approach

How was this change tested and do you have evidence? (REQUIRED: Select at least 1)

Testing

Required Checklist:

Further comments

simon-dew left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajagp Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

a-atri commented Nov 21, 2024 •

edited

Loading

simon-dew left a comment •

edited

Loading

rajagp Nov 21, 2024 •

edited

Loading