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

Readme updates for 2.4.0 release #1583

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Readme updates for 2.4.0 release #1583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
338881a
Update as per PM commetns
vibhansa-msft Dec 3, 2024
1f82a56
Updated
vibhansa-msft Dec 3, 2024
af3fd2c
Updated
vibhansa-msft Dec 3, 2024
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
8 changes: 4 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## 2.4.0 (Unreleased)
**Features**
- 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.
- Added 'gen-config' command to auto generate blobfuse2 config file.
- 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`.
- 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.

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

**Other Changes**
- Stream config will be converted to block-cache config implicitly and 'stream' component is no longer used from this release onwards.
- MSI login with object-id will not rely on azcli anymore, rather it will be supported by 'azidentity' SDK.
- `Stream` option automatically replaced with "Stream with Block-cache" internally for optimized performance.
- 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..
- Version check is now moved to a static website hosted on a public container.

## 2.3.2 (2024-09-03)
Expand Down
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Please submit an issue [here](https://github.com/azure/azure-storage-fuse/issues

## NOTICE
- 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).
- 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.
- `streaming` mode is deprecated. Blobfuse2 will implicitly convert your streaming config to block-cache.
- 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.
- `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.

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

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

## Usage
- Mount with blobfuse2
* blobfuse2 mount <mount path> --config-file=<config file>
* blobfuse2 mount \<mount path\> --config-file=\<config file\>
- Mount blobfuse2 using legacy blobfuse config and cli parameters
* blobfuse2 mountv1 <blobfuse mount cli with options>
* blobfuse2 mountv1 \<blobfuse mount cli with options\>
- Mount all containers in your storage account
* blobfuse2 mount all <mount path> --config-file=<config file>
* blobfuse2 mount all \<mount path\> --config-file=\<config file\>
- List all mount instances of blobfuse2
* blobfuse2 mount list
- Unmount blobfuse2
* sudo fusermount3 -u <mount path>
* sudo fusermount3 -u \<mount path\>
- Unmount all blobfuse2 instances
* blobfuse2 unmount all
- Auto generate config file
* blobfuse2 gen-config --tmp-path=\<local cache path\> --o \<path to save generated config\>

<!---TODO Add Usage for mount, unmount, etc--->
## CLI parameters
Expand Down
Loading