Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Clarify Storage mounting details #1365

Merged
merged 3 commits into from
Nov 3, 2022
Merged

[Docs] Clarify Storage mounting details #1365

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8edf59a
fix incorrect statements
romilbhardwaj Nov 2, 2022
42a88f8
fix incorrect statements
romilbhardwaj Nov 3, 2022
dc8cecd
fix incorrect statements
romilbhardwaj Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/reference/storage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ When specifying a storage object, you can specify either of two modes:
they are accessed by applications. This mode also allows applications to
write to the mount path. All writes are replicated to remote bucket (and
any other VMs mounting the same bucket). Please note that this mode
uses a close-to-open consistency model, which means a file write is
committed to the backing store only after :code:`close()` is called on it.
uses a close-to-open consistency model. This means calling :code:`close()`
on a file will guarantee that any subsequent reads will see the latest data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“close-to-open” can be unfamiliar. Maybe we can add a sentence using the user’s own words, along the lines of “every close will trigger an re-upload of the entire file (true?) to the backing bucket”.

Copy link
Collaborator Author

@romilbhardwaj romilbhardwaj Nov 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I added this but it was making the bullet point too long, so I moved these details to two notes after the example. PTAL.

Tested:

  • docs rendered locally


- :code:`mode: COPY`
This mode pre-fetches your files from remote storage and caches them on the
Expand Down
6 changes: 3 additions & 3 deletions examples/perf/results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ We copy a 1 GB file from S3 to EBS using `aws s3 cp` command.
* SkyPilot Storage offers higher **read** performance than EBS because it can directly
stream files from S3 to memory.
* SkyPilot Storage **write** performance is significantly higher than EBS because it
writes to memory and then asynchronously uploads to S3. SkyPilot Storage offers
only eventual consistency, so a write operation to SkyPilot Storage may not reflect
immediately on the S3 storage.
writes directly to S3 over network instead of disk.
* SkyPilot Storage offers close-to-open consistency, so it is guaranteed that when a file is closed,
subsequent opens will see the latest changes.
* These benchmarks are run on single large files. The performance of SkyPilot Storage
degrades when using many small files.