Skip to content

Multiple issues with Azure ephemeral_disk documentation #876

@MartinZAnynines

Description

@MartinZAnynines

Hi BOSH team,

I'd like to report three issues in the Azure Cloud Provider documentation regarding the ephemeral_disk configuration section.


1. Misleading Explanation of MiB vs. GiB

The documentation currently states:

"Please always use N * 1024 as the size because Azure always uses GiB not MiB."

This sentence is confusing and technically incorrect:

  • The size parameter is defined in MiB:

    size [Integer, optional]: Specifies the disk size in MiB.

  • Suggesting to use N * 1024 makes sense (to align with GiB boundaries), but the justification is misleading.
  • Azure uses GiB-based units for disk allocation, but the configuration input is in MiB. Therefore, it would be more accurate to write:

"Specify the disk size in MiB. To match Azure's GiB-based disk allocation, use a multiple of 1024 (e.g., 30 GiB = 30 * 1024 MiB).”


2. Inconsistent and Confusing Use of "Default Size"

In the same section, the term "default size" is used in multiple contexts:

"If the Azure temporary disk size for the instance type is less than 301024 MiB, the default size is 301024 MiB..."
"If the Azure temporary disk size ... is larger than 10001024 MiB, the default size is 10001024 MiB..."

This is confusing because the term "default size" is used for both the lower and upper limit of temporary disk size.

3. Broken Link

The Azure temporary disk size link on the same page is broken

Thanks for all your work on BOSH and the Azure CPI — addressing these points would improve the clarity of the documentation for users and contributors alike.

Best regards,

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Waiting for Changes | Open for Contribution

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions