Skip to content

Commit

Permalink
doc: Corrects default value of auto_scaling_disk_gb_enabled (#2683)
Browse files Browse the repository at this point in the history
  • Loading branch information
EspenAlbert authored Oct 15, 2024
1 parent 943ca68 commit 54ca323
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/resources/advanced_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ If you are upgrading a replica set to a sharded cluster, you cannot increase the

### auto_scaling

* `disk_gb_enabled` - (Optional) Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.
* `disk_gb_enabled` - (Optional) Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- Set to `true` to enable disk auto-scaling.
- Set to `false` to disable disk auto-scaling.

Expand Down Expand Up @@ -633,7 +633,7 @@ After adding the `lifecycle` block to explicitly change `instance_size` comment

### analytics_auto_scaling

* `disk_gb_enabled` - (Optional) Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.
* `disk_gb_enabled` - (Optional) Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
* `compute_enabled` - (Optional) Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

~> **IMPORTANT:** If `compute_enabled` is true, then Atlas will automatically scale up to the maximum provided and down to the minimum, if provided.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ Refer to the following for full privatelink endpoint connection string examples:
* `name` - (Required) Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. **WARNING** Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
* `provider_instance_size_name` - (Required) Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See [Create a Cluster](https://docs.atlas.mongodb.com/reference/api/clusters-create-one/) `providerSettings.instanceSizeName` for valid values and default resources.

* `auto_scaling_disk_gb_enabled` - (Optional) Specifies whether disk auto-scaling is enabled. The default is true.
* `auto_scaling_disk_gb_enabled` - (Optional) Specifies whether disk auto-scaling is enabled. The default is false.
- Set to `true` to enable disk auto-scaling.
- Set to `false` to disable disk auto-scaling.

Expand Down

0 comments on commit 54ca323

Please sign in to comment.