Skip to content

Commit 4a57c1b

Browse files
Readme updates for 2.4.0 release (#1583)
* Readme Updated
1 parent 2c4ec6a commit 4a57c1b

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## 2.4.0 (Unreleased)
22
**Features**
3-
- Entry cache to hold directory listing results in cache for a given timeout. This will reduce REST calls going to storage while listing the blobs in parallel.
4-
- Added 'gen-config' command to auto generate blobfuse2 config file.
3+
- Added 'gen-config' command to auto generate the recommended blobfuse2 config file based on computing resources and memory available on the node. Command details can be found with `blobfuse2 gen-config --help`.
4+
- Added option to set Entry cache to hold directory listing results in cache for a given timeout. This will reduce REST calls going to storage and enables faster access across multiple applications that use Blobfuse on the same node.
55

66
**Bug Fixes**
77
- [#1426](https://github.com/Azure/azure-storage-fuse/issues/1426) Read panic in block-cache due to boundary conditions.
@@ -13,8 +13,8 @@
1313
- Updating a file via Blobfuse2 was resetting the ACLs and Permissions applied to file in Datalake.
1414

1515
**Other Changes**
16-
- Stream config will be converted to block-cache config implicitly and 'stream' component is no longer used from this release onwards.
17-
- MSI login with object-id will not rely on azcli anymore, rather it will be supported by 'azidentity' SDK.
16+
- `Stream` option automatically replaced with "Stream with Block-cache" internally for optimized performance.
17+
- Login via Managed Identify is supported with Object-ID for all versions of blobfuse except 2.3.0 and 2.3.2.To use Object-ID for these two versions, use AzCLI or utilize Application/Client-ID or Resource ID base authentication..
1818
- Version check is now moved to a static website hosted on a public container.
1919

2020
## 2.3.2 (2024-09-03)

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Please submit an issue [here](https://github.com/azure/azure-storage-fuse/issues
1212

1313
## NOTICE
1414
- Due to known data consistency issues when using Blobfuse2 in `block-cache` mode, it is strongly recommended that all Blobfuse2 installations be upgraded to version 2.3.2. For more information, see [this](https://github.com/Azure/azure-storage-fuse/wiki/Blobfuse2-Known-issues).
15-
- As of version 2.3.0, blobfuse has updated its authentication methods. For Managed Identity, Object-ID based OAuth is solely accessible via CLI-based login, requiring Azure CLI on the system. For a dependency-free option, users may utilize Application/Client-ID or Resource ID based authentication.
16-
- `streaming` mode is deprecated. Blobfuse2 will implicitly convert your streaming config to block-cache.
15+
- Login via Managed Identify is supported with Object-ID for all versions of Blobfuse except 2.3.0 and 2.3.2.To use Object-ID for these two versions, use Azure CLI or utilize Application/Client-ID or Resource ID based authentication.
16+
- `streaming` mode is being deprecated. This is the older option and is replaced by streaming with `block-cache` mode which is the more performant streaming option.
1717

1818
## Limitations in Block Cache
1919
- Concurrent write operations on the same file using multiple handles is not checked for data consistency and may lead to incorrect data being written.
@@ -101,24 +101,27 @@ The general format of the Blobfuse2 commands is `blobfuse2 [command] [arguments]
101101
* `secure set` - Updates value of a config parameter.
102102
* `unmount` - Unmounts the Blobfuse2 filesystem.
103103
* `unmount all` - Unmounts all Blobfuse2 filesystems.
104+
* `gen-config` - Auto generate recommended blobfuse2 config file.
104105

105106
## Find help from your command prompt
106107
To see a list of commands, type `blobfuse2 -h` and then press the ENTER key.
107108
To learn about a specific command, just include the name of the command (For example: `blobfuse2 mount -h`).
108109

109110
## Usage
110111
- Mount with blobfuse2
111-
* blobfuse2 mount <mount path> --config-file=<config file>
112+
* blobfuse2 mount \<mount path\> --config-file=\<config file\>
112113
- Mount blobfuse2 using legacy blobfuse config and cli parameters
113-
* blobfuse2 mountv1 <blobfuse mount cli with options>
114+
* blobfuse2 mountv1 \<blobfuse mount cli with options\>
114115
- Mount all containers in your storage account
115-
* blobfuse2 mount all <mount path> --config-file=<config file>
116+
* blobfuse2 mount all \<mount path\> --config-file=\<config file\>
116117
- List all mount instances of blobfuse2
117118
* blobfuse2 mount list
118119
- Unmount blobfuse2
119-
* sudo fusermount3 -u <mount path>
120+
* sudo fusermount3 -u \<mount path\>
120121
- Unmount all blobfuse2 instances
121122
* blobfuse2 unmount all
123+
- Auto generate config file
124+
* blobfuse2 gen-config --tmp-path=\<local cache path\> --o \<path to save generated config\>
122125

123126
<!---TODO Add Usage for mount, unmount, etc--->
124127
## CLI parameters

0 commit comments

Comments
 (0)