Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Updates mongodbatlas_global_cluster_config doc about self-managed sharding clusters #2372

Merged
merged 2 commits into from
Jun 27, 2024
Merged

doc: Updates mongodbatlas_global_cluster_config doc about self-managed sharding clusters #2372

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adfa644
update doc
lantoli Jun 27, 2024
2956b05
add link
lantoli Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 2 additions & 45 deletions website/docs/r/global_cluster_config.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ description: |-

-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.

-> **NOTE:** This resource can only be used with Atlas-managed clusters. See doc for `global_cluster_self_managed_sharding` attribute in [`mongodbatlas_advanced_cluster` resource](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/advanced_cluster) for more info.

~> **IMPORTANT:** A Global Cluster Configuration, once created, can only be deleted. You can recreate the Global Cluster with the same data only in the Atlas UI. This is because the configuration and its related collection with shard key and indexes are managed separately and they would end up in an inconsistent state. [Read more about Global Cluster Configuration](https://www.mongodb.com/docs/atlas/global-clusters/)

## Examples Usage
Expand Down Expand Up @@ -72,51 +74,6 @@ description: |-
}
```

### Example Global cluster config
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this example must be a leftover, it's using a replicaset cluster and doesn't add any value or info over the previous example


```terraform
resource "mongodbatlas_cluster" "cluster-test" {
project_id = "<YOUR-PROJECT-ID>"
name = "cluster-test"

cluster_type = "REPLICASET"
replication_specs {
num_shards = 1
regions_config {
region_name = "US_EAST_1"
electable_nodes = 3
priority = 7
read_only_nodes = 0
}
}

backup_enabled = true
auto_scaling_disk_gb_enabled = true
mongo_db_major_version = "7.0"

//Provider Settings "block"
provider_name = "AWS"
provider_instance_size_name = "M40"
}

resource "mongodbatlas_global_cluster_config" "config" {
project_id = mongodbatlas_cluster.test.project_id
cluster_name = mongodbatlas_cluster.test.name

managed_namespaces {
db = "mydata"
collection = "publishers"
custom_shard_key = "city"
}

custom_zone_mappings {
location = "CA"
zone = "Zone 1"
}
}
```


## Argument Reference

* `project_id` - (Required) The unique ID for the project to create the database user.
Expand Down