cloudfoundry / cloudfoundry/docs-bosh

Multiple issues with Azure ephemeral_disk documentation

Open
#876 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
37
Forks
271
Avg merge
5d 13m
Merged PRs (30d)
4

Description

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,

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Azure CPI documentation's resource-pools section and review the ephemeral_disk text and Azure temporary disk size link. Done means the MiB/GiB explanation is accurate, the default-size wording is unambiguous, and the broken link is replaced or removed; verify the rendered documentation afterward.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.