Skip to content

doc: Merges CLOUDP-274025 docs & examples branch - DONT MERGE YET #3079

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.

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

Merged
merged 111 commits into from
Mar 11, 2025
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
111 commits
Select commit Hold shift + click to select a range
7458ec7
duplicate files (#3046)
lantoli Feb 10, 2025
6ada45d
doc: Adds initial structure for module examples cluster_to_advanced_c…
EspenAlbert Feb 11, 2025
c1f9a08
duplicate files (#3052)
lantoli Feb 11, 2025
c64b251
doc: Examples for advanced_cluster preview v2 (#3054)
lantoli Feb 12, 2025
2166635
doc: Create doc pages for `mongodb_advanced_cluster` schema v2 resour…
lantoli Feb 12, 2025
dd68c88
chore: Follow-up for PR 3054 (#3059)
lantoli Feb 12, 2025
1641a4b
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Feb 12, 2025
ac891f5
doc: Rename env. var. to `MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_…
lantoli Feb 13, 2025
d2f0b0f
doc: Implements v2 and v3 MongoDB Atlas cluster migration examples (#…
EspenAlbert Feb 13, 2025
b6c1843
doc: Adds migration example from `mongodbatlas_cluster` to `mongodbat…
EspenAlbert Feb 13, 2025
ced477c
doc: Updates guide cluster to advanced_cluster and creates guide adva…
lantoli Feb 14, 2025
fb99be0
doc: Adds remaining work to migrate_cluster_to_advanced_cluster examp…
EspenAlbert Feb 17, 2025
4101d35
doc: Applies some feedback for migration guides doc (#3075)
lantoli Feb 17, 2025
a2a82fc
doc: Updates table formatting and migration guides (#3076)
EspenAlbert Feb 17, 2025
f5841fa
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Feb 17, 2025
c377c92
fix mongodb_atlas typo
lantoli Feb 18, 2025
9d3c892
address PR comments
EspenAlbert Feb 18, 2025
43a8731
doc: Clarify purpose of migration example for Terraform module
EspenAlbert Feb 18, 2025
00cbe4c
clarify when to use alternative
lantoli Feb 18, 2025
1808f28
own section for env.var.
lantoli Feb 18, 2025
e12a19e
change option to use Import
lantoli Feb 18, 2025
5495866
adjust step
lantoli Feb 18, 2025
164ce0f
refactor: Improve formatting and consistency in preview provider v2 e…
EspenAlbert Feb 18, 2025
cef152b
typo dot in deprecated
lantoli Feb 19, 2025
62def04
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 19, 2025
3d61af7
style: add linebreaks to examples
EspenAlbert Feb 19, 2025
279cd02
chore: Adds Flex GA documentation changes (#3087)
oarbusi Feb 19, 2025
7b2d1d5
Update examples/migrate_cluster_to_advanced_cluster/basic/README.md
EspenAlbert Feb 19, 2025
072b153
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Feb 19, 2025
397438f
remove M0 info as it can be seen in Atlas doc
lantoli Feb 20, 2025
63d6017
plural ds description
lantoli Feb 20, 2025
8f229bd
change migration guide title
lantoli Feb 20, 2025
c088723
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 20, 2025
9c21306
move output example
lantoli Feb 20, 2025
705ef38
doc: Adds examples for flex clusters in mongodbatlas_advanced_cluster…
oarbusi Feb 20, 2025
7d6f28e
doc: Missing backported docs & followup (#3098)
oarbusi Feb 20, 2025
2d94ac7
missing changein v2
oarbusi Feb 20, 2025
721520b
Update examples/migrate_cluster_to_advanced_cluster/module_user/READM…
lantoli Feb 21, 2025
b3d5da7
rename Tags to tags
lantoli Feb 21, 2025
a69a01e
remove "l" leftover
lantoli Feb 21, 2025
b19ca55
typo add blank after dot
lantoli Feb 21, 2025
b6dfe61
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Feb 21, 2025
2636be4
typo
lantoli Feb 21, 2025
7d455ae
unify [#]
lantoli Feb 21, 2025
8446f15
uppercase Flex
lantoli Feb 21, 2025
709b335
adv cluster doc sync with v2
lantoli Feb 21, 2025
511f22d
align data sources
lantoli Feb 21, 2025
f2ae6df
Add docs suggestions
EspenAlbert Feb 21, 2025
149188d
apply feedback
lantoli Feb 21, 2025
e57eebd
fix incorrect database reference in project_id
lantoli Feb 21, 2025
a692366
add dot
lantoli Feb 21, 2025
848601c
more dots added
lantoli Feb 21, 2025
9703d76
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 21, 2025
5030a60
bi_connector
lantoli Feb 21, 2025
6502cba
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 21, 2025
2d8d149
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 21, 2025
6e05fce
Update docs/guides/advanced-cluster-preview-provider-v2.md
lantoli Feb 21, 2025
240bbba
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
00a3043
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
df7aa56
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
cfd26ec
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
6226246
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
1117783
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Feb 21, 2025
6b94148
remove "of a specs"
lantoli Feb 21, 2025
b7b3f93
order list
lantoli Feb 21, 2025
398f231
change doc and info
lantoli Feb 21, 2025
9eee224
typo
lantoli Feb 21, 2025
8f88416
plural ds link
lantoli Feb 21, 2025
c4f5564
update README in examples
lantoli Feb 21, 2025
5e44d13
plugin limitations
lantoli Feb 27, 2025
09f6dc0
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Mar 3, 2025
d7833ed
set old guides for 1.14.0 and 1.15.0 as they were published more than…
lantoli Mar 3, 2025
920804c
update examples provider version to 1.29
lantoli Mar 3, 2025
9cdc27d
v2 to 2.0.0
lantoli Mar 3, 2025
61ed444
move "main changes" section to resource doc page
lantoli Mar 3, 2025
74eed13
remove adv_cluster guide and move content to upgrade guide and resour…
lantoli Mar 3, 2025
049e35b
wip
lantoli Mar 4, 2025
ca26d51
updates documentation.
marcosuma Mar 4, 2025
b3763ed
Update README.md file for the basic example.
marcosuma Mar 5, 2025
9e642ca
Update README.md file for the module example.
marcosuma Mar 5, 2025
ae40a39
syntax changes.
marcosuma Mar 5, 2025
a6e6fa9
fix tflint
lantoli Mar 5, 2025
de4fd9f
rename filenames from v2 to 2.0.0
lantoli Mar 5, 2025
a632942
change links v2 to 2.0.0
lantoli Mar 5, 2025
c6f2e9b
fix tflint for migration examples
lantoli Mar 5, 2025
772155d
typo
lantoli Mar 5, 2025
6cb8e1c
fix order in import process
lantoli Mar 5, 2025
4077503
add reference update step
lantoli Mar 5, 2025
a8b9c00
update examples with todo and findings from demo branch `CLOUDP-29931…
EspenAlbert Mar 5, 2025
42b550f
Merge branch 'master' into CLOUDP-274025-dev-docs-examples
lantoli Mar 5, 2025
2f1a66e
update tf-validate
lantoli Mar 5, 2025
c2d5af1
id to cluster_id
lantoli Mar 5, 2025
f1f6abb
Apply suggestions from code review
marcosuma Mar 6, 2025
20f5c91
address initial comments.
marcosuma Mar 6, 2025
ac7cb3b
add a main README.md file for the examples folder.
marcosuma Mar 6, 2025
aecd45a
move Terraform Actions doc
lantoli Mar 7, 2025
6f8afa3
small typo
lantoli Mar 7, 2025
4be979f
use explicit numbering
lantoli Mar 7, 2025
d99d28d
change version requirement for v1 of the examples
lantoli Mar 7, 2025
bdb3454
Update examples/migrate_cluster_to_advanced_cluster/README.md
lantoli Mar 7, 2025
583d064
Update examples/migrate_cluster_to_advanced_cluster/basic/README.md
lantoli Mar 7, 2025
9faad2b
add coming soon for plugin
lantoli Mar 7, 2025
33c0cee
get plugin alternatives back
lantoli Mar 7, 2025
68e27e9
update plugin doc
lantoli Mar 7, 2025
85d39f5
change section
lantoli Mar 7, 2025
8ef671f
indent coming soon
lantoli Mar 7, 2025
241ba07
same line for coming soon
lantoli Mar 7, 2025
1b6d58c
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Mar 8, 2025
21ead60
Update docs/guides/cluster-to-advanced-cluster-migration-guide.md
lantoli Mar 8, 2025
11e4876
remove refs to cli plugin and fix text for the 'import+remove' approach.
marcosuma Mar 10, 2025
35678a9
make some titles shorter.
marcosuma Mar 10, 2025
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
254 changes: 254 additions & 0 deletions docs/data-sources/advanced_cluster (preview provider v2).md

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions docs/data-sources/advanced_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

`mongodbatlas_advanced_cluster` describes an Advanced Cluster. The data source requires your Project ID.

This doc is for the current version of `mongodbatlas_advanced_cluster`, doc for **Preview for MongoDB Atlas Provider v2** can be found [here](./advanced_cluster%2520%2528preview%2520provider%2520v2%2529).

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

~> **IMPORTANT:**
Expand Down Expand Up @@ -93,7 +95,7 @@ In addition to all arguments above, the following attributes are exported:
* `id` - The cluster ID.
* `bi_connector_config` - Configuration settings applied to BI Connector for Atlas on this cluster. See [below](#bi_connector_config). **NOTE** Prior version of provider had parameter as `bi_connector`
* `cluster_type` - Type of the cluster that you want to create.
* `disk_size_gb` - Capacity, in gigabytes, of the host's root volume. **(DEPRECATED)** Use `replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb` instead. To learn more, see the [Migration Guide](../guides/1.18.0-upgrade-guide.html.markdown).
* `disk_size_gb` - Capacity, in gigabytes, of the host's root volume. **(DEPRECATED)** Use `replication_specs.#.region_configs.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb` instead. To learn more, see the [Migration Guide](../guides/1.18.0-upgrade-guide.html.markdown).
* `encryption_at_rest_provider` - Possible values are AWS, GCP, AZURE or NONE.
* `tags` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#tags).
* `labels` - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#labels). **(DEPRECATED.)** Use `tags` instead.
Expand Down Expand Up @@ -203,7 +205,7 @@ Key-value pairs that categorize the cluster. Each key and value has a maximum le
* `sample_size_bi_connector` - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
* `sample_refresh_interval_bi_connector` - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
* `transaction_lifetime_limit_seconds` - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
* `default_max_time_ms` - Default time limit in milliseconds for individual read operations to complete. This option corresponds to the [defaultMaxTimeMS(https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/) cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
* `default_max_time_ms` - Default time limit in milliseconds for individual read operations to complete. This option corresponds to the [defaultMaxTimeMS](https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/) cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
* `change_stream_options_pre_and_post_images_expire_after_seconds` - (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to `-1`(off).
* `tls_cipher_config_mode` - The TLS cipher suite configuration mode. Valid values include `CUSTOM` or `DEFAULT`. The `DEFAULT` mode uses the default cipher suites. The `CUSTOM` mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
* `custom_openssl_cipher_config_tls12` - The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tls_cipher_config_mode` is set to `CUSTOM`.
Expand Down Expand Up @@ -242,7 +244,7 @@ In addition to all arguments above, the following attributes are exported:
- `connection_strings.private_endpoint` - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
- `connection_strings.private_endpoint.#.connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
- `connection_strings.private_endpoint.#.srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use `connection_strings.private_endpoint[n].connection_string`
- `connection_strings.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
- `connection_strings.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
- `connection_strings.private_endpoint.#.type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
- `connection_strings.private_endpoint.#.endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[n].connection_string` or `connection_strings.private_endpoint[n].srv_connection_string`
- `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
Expand Down
Loading