You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/r/advanced_cluster.html.markdown
+12-1Lines changed: 12 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -370,10 +370,21 @@ replication_specs {
370
370
### auto_scaling
371
371
372
372
*`disk_gb_enabled` - (Optional) Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.
373
+
- Set to `true` to enable disk auto-scaling.
374
+
- Set to `false` to disable disk auto-scaling.
375
+
376
+
~> **IMPORTANT:** If `disk_gb_enabled` is true, then Atlas will automatically scale disk size up and down.
377
+
This will cause the value of `disk_size_gb` returned to potentially be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster disk size back to the original `disk_size_gb` value.
378
+
To prevent this a lifecycle customization should be used, i.e.:
379
+
`lifecycle {
380
+
ignore_changes = [disk_size_gb]
381
+
}`
382
+
After adding the `lifecycle` block to explicitly change `disk_size_gb` comment out the `lifecycle` block and run `terraform apply`. Please be sure to uncomment the `lifecycle` block once done to prevent any accidental changes.
383
+
373
384
*`compute_enabled` - (Optional) Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.
374
385
375
386
~> **IMPORTANT:** If `compute_enabled` is true, then Atlas will automatically scale up to the maximum provided and down to the minimum, if provided.
376
-
This will cause the value of `instance_size` returned to potential be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster back down to the original `instance_size` value.
387
+
This will cause the value of `instance_size` returned to potentially be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster back to the original `instance_size` value.
377
388
To prevent this a lifecycle customization should be used, i.e.:
Copy file name to clipboardExpand all lines: website/docs/r/cluster.html.markdown
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,14 +287,22 @@ Refer to the following for full privatelink endpoint connection string examples:
287
287
- Set to `true` to enable disk auto-scaling.
288
288
- Set to `false` to disable disk auto-scaling.
289
289
290
+
~> **IMPORTANT:** If `disk_gb_enabled` is true, then Atlas will automatically scale disk size up and down.
291
+
This will cause the value of `disk_size_gb` returned to potentially be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster disk size back to the original `disk_size_gb` value.
292
+
To prevent this a lifecycle customization should be used, i.e.:
293
+
`lifecycle {
294
+
ignore_changes = [disk_size_gb]
295
+
}`
296
+
After adding the `lifecycle` block to explicitly change `disk_size_gb` comment out the `lifecycle` block and run `terraform apply`. Please be sure to uncomment the `lifecycle` block once done to prevent any accidental changes.
297
+
290
298
-> **NOTE:** If `provider_name` is set to `TENANT`, the parameter `auto_scaling_disk_gb_enabled` will be ignored.
291
299
292
300
*`auto_scaling_compute_enabled` - (Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.
293
301
- Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for `providerSettings.autoScaling.compute.maxInstanceSize`.
294
302
- Set to `false` to disable cluster tier auto-scaling.
295
303
296
304
~> **IMPORTANT:** If `auto_scaling_compute_enabled` is true, then Atlas will automatically scale up to the maximum provided and down to the minimum, if provided.
297
-
This will cause the value of `provider_instance_size_name` returned to potential be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster back down to the original instanceSizeName value.
305
+
This will cause the value of `provider_instance_size_name` returned to potentially be different than what is specified in the Terraform config and if one then applies a plan, not noting this, Terraform will scale the cluster back to the original instanceSizeName value.
298
306
To prevent this a lifecycle customization should be used, i.e.:
0 commit comments