Skip to content

[DOC] Document missing EBS arguments for clusters #5197

@zcking

Description

@zcking

Affected Resource(s)

  • databricks_cluster and any resources that use it (e.g., databricks_job).

Only documents some of the EBS volume settings, but does not document other settings that are available in the API as well as in our terraform provider.

EBS settings missing from the docs:

Image

Expected Details

For EBS gp3 volumes, these arguments are already available in the provider, but are not documented. Here is an example of passing these arguments:

# Create a classic all-purpose cluster
resource "databricks_cluster" "demo_cluster" {
  cluster_name            = "data-engineering-shared"
  node_type_id            = data.databricks_node_type.smallest.id
  spark_version           = data.databricks_spark_version.latest_lts.id
  autotermination_minutes = 30
  num_workers             = 1
  aws_attributes {
    availability = "SPOT"
    ebs_volume_type = "GENERAL_PURPOSE_HDD"
    ebs_volume_size = "100"
    ebs_volume_iops = 3000 # only if using gp3 volumes
    ebs_volume_throughput = 125 # only if using gp3 volumes
  }
}

List of things to potentially add/remove

This is a list of things to manipulate in the docs:

  • Add the two arguments to our docs for databricks_cluster

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsadd explicit documentation about corner case

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions