Skip to content

Commit 87b92af

Browse files
[Docs] Clarify Storage mounting details (skypilot-org#1365)
* fix incorrect statements * fix incorrect statements * fix incorrect statements
1 parent 2336d75 commit 87b92af

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

docs/source/reference/storage.rst

+13-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,8 @@ When specifying a storage object, you can specify either of two modes:
6262
In effect, files are streamed from the backing source bucket as and when
6363
they are accessed by applications. This mode also allows applications to
6464
write to the mount path. All writes are replicated to remote bucket (and
65-
any other VMs mounting the same bucket). Please note that this mode
66-
uses a close-to-open consistency model, which means a file write is
67-
committed to the backing store only after :code:`close()` is called on it.
65+
any other VMs mounting the same bucket).
66+
6867

6968
- :code:`mode: COPY`
7069
This mode pre-fetches your files from remote storage and caches them on the
@@ -176,6 +175,17 @@ and storage mounting:
176175
For mounts not using SkyPilot Storage (e.g., those using rsync) the symbolic links are directly copied, not their target data.
177176
The targets must be separately mounted or else the symlinks may break.
178177

178+
.. note::
179+
:code:`MOUNT` mode employs a close-to-open consistency model. This means calling
180+
:code:`close()` on a file will upload the entire file to the backing object store.
181+
Any subsequent reads, either using SkyPilot Storage or external utilities (such as
182+
aws/gsutil cli) will see the latest data.
183+
184+
.. note::
185+
:code:`MOUNT` mode does not support the full POSIX interface and some file
186+
operations may fail. Most notably, random writes and append operations are
187+
not supported.
188+
179189
.. note::
180190
Storage only supports uploading directories (i.e., :code:`source` cannot be a file).
181191
To upload a single file to a bucket, please put in a directory and specify the directory as the source.

examples/perf/results.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ We copy a 1 GB file from S3 to EBS using `aws s3 cp` command.
4141
* SkyPilot Storage offers higher **read** performance than EBS because it can directly
4242
stream files from S3 to memory.
4343
* SkyPilot Storage **write** performance is significantly higher than EBS because it
44-
writes to memory and then asynchronously uploads to S3. SkyPilot Storage offers
45-
only eventual consistency, so a write operation to SkyPilot Storage may not reflect
46-
immediately on the S3 storage.
44+
writes directly to S3 over network instead of disk.
45+
* SkyPilot Storage offers close-to-open consistency, so it is guaranteed that when a file is closed,
46+
subsequent opens will see the latest changes.
4747
* These benchmarks are run on single large files. The performance of SkyPilot Storage
4848
degrades when using many small files.

0 commit comments

Comments
 (0)