search

DataBiosphere / dsub

Open-source command-line tool to run batch computing tasks and workflows on backend services such as Google Cloud.
Apache License 2.0
265 stars 44 forks source link

Typo in README for mounting an existing disk #245

Closed wnojopra closed 1 year ago

wnojopra commented 2 years ago

In the README there are instructions for Mounting an existing peristent disk. The instructions say to specify the url of the source disk. However, the code example includes the number "50":

- --mount RESOURCES="https://www.googleapis.com/compute/v1/projects/your-project/global/images/your-image 50"

The above example is incorrect. It should not have the 50 there, and the url is for an image, not a disk. It should be:

+ --mount RESOURCES="https://www.googleapis.com/compute/v1/projects/your-project/zones/your_disk_zone/disks/your-disk"

This typo has been fixed internally and will be displayed correctly in the next release.

slagelwa commented 2 years ago

Wondering if the URL should be containing 'images'? According to the tests that isn't exactly the format for mounting an existing disk:

https://github.com/DataBiosphere/dsub/blob/2d3ac9e70590d72833c801352d0984a55cf534a7/test/integration/io_setup.sh#L46

wnojopra commented 2 years ago

Thank you @slagelwa ! You're right.

What I had in the original comment was:

+ --mount RESOURCES="https://www.googleapis.com/compute/v1/projects/your-project/global/images/your-image"

I have updated it to correctly say:

+ --mount RESOURCES="https://www.googleapis.com/compute/v1/projects/your-project/zones/your_disk_zone/disks/your-disk"

Very much appreciate you pointing this out.

wnojopra commented 1 year ago

Typos fixed in https://github.com/DataBiosphere/dsub/releases/tag/v0.4.8