diff --git a/README.md b/README.md index 79bdbb2f..60c140ee 100644 --- a/README.md +++ b/README.md @@ -56,12 +56,14 @@ For more information, see the [wiki](https://github.com/Azure/azure-storage-fuse - When blobfuse receives an 'open' request for a file, it will block and download the entire content of the blob down to the cache location specified in ```--tmp-path``` - All read and writes will go to the cache location when the file is open - When blobfuse receives a 'close' request for the file, it will block and upload the entire content to Blob storage, and return success/failure to the 'close' call. -- If blobfuse receives another open request within ```--file-cache-timeout-in-seconds```, it will simply use the existing file in the local cache rather than downloading the file again from Blob storage +- If blobfuse receives another open request within ```--file-cache-timeout-in-seconds```, it will simply use the existing file in the local cache rather than downloading the file again from Blob storage. +- Files in the cache will be deleted after ```--file-cache-timeout-in-seconds```. Make sure to configure your cache space ```--tmp-path``` with enough space to accomodate this behavior, or set ```--file-cache-timeout-in-seconds``` to 0 to accelerate deletion of cached files. ### Performance and caching Please take careful note of the following points, before using blobfuse: - In order to achieve reasonable performance, blobfuse requires a temporary directory to use as a local cache. This directory will contain the full contents of any file (blob) read to or written from through blobfuse. Cached files will be purged as they age (--file-cache-timeout-in-seconds) if there are no longer open file handles to them. - Putting the cache directory on a ramdisk, or on an SSD (ephemeral disk on Azure) will greatly enhance performance. + - Blobfuse currently does not manage available disk space in the tmp path. Make sure to have enough space for the cache, or reduce ```--file-cache-timeout-in-seconds``` value to accelerating purging cached files. - In order to delete the cache, un-mount and re-mount blobfuse. - Do not use the same cache directory for multiple instances of blobfuse, or for any other purpose while blobfuse is running.