Skip to content

Commit efe36e6

Browse files
authored
Merge pull request #213792 from ktoliver/blobfuse2
edit pass: BlobFuse2 articles (1986763)
2 parents 52c1a28 + 5a34ec6 commit efe36e6

7 files changed

+239
-226
lines changed

articles/storage/blobs/TOC.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -540,15 +540,15 @@ items:
540540
href: ../common/storage-use-azcopy-troubleshoot.md?toc=/azure/storage/blobs/toc.json
541541
- name: BlobFuse
542542
items:
543-
- name: What is BlobFuse2?
543+
- name: What is BlobFuse2 Preview?
544544
href: blobfuse2-what-is.md
545545
- name: Deploy BlobFuse2 on Linux
546546
href: blobfuse2-how-to-deploy.md
547547
- name: Deploy BlobFuse v1 on Linux
548548
href: storage-how-to-mount-container-linux.md
549-
- name: Health Monitor
549+
- name: Health Monitor for BlobFuse2
550550
href: blobfuse2-health-monitor.md
551-
- name: Troubleshooting
551+
- name: Troubleshoot BlobFuse2
552552
href: blobfuse2-troubleshooting.md
553553
- name: Azure Data Factory
554554
href: ../../data-factory/connector-azure-blob-storage.md?toc=/azure/storage/blobs/toc.json
@@ -752,7 +752,7 @@ items:
752752
href: ../common/storage-ref-azcopy-set-properties.md?toc=/azure/storage/blobs/toc.json
753753
- name: BlobFuse2
754754
items:
755-
- name: Configuration settings
755+
- name: Configure settings
756756
href: blobfuse2-configuration.md?toc=/azure/storage/blobs/toc.json
757757
- name: Commands
758758
items:
Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,82 @@
11
---
2-
title: How to configure Blobfuse2 (preview) | Microsoft Docs
2+
title: Configure settings for BlobFuse2 Preview
33
titleSuffix: Azure Blob Storage
4-
description: How to configure Blobfuse2 (preview).
4+
description: Learn about your options for setting and changing configuration settings for BlobFuse2 Preview.
55
author: jimmart-dev
6+
ms.author: jammart
7+
ms.reviewer: tamram
68
ms.service: storage
79
ms.subservice: blobs
810
ms.topic: how-to
911
ms.date: 09/29/2022
10-
ms.author: jammart
11-
ms.reviewer: tamram
1212
---
1313

14-
# How to configure Blobfuse2 (preview)
14+
# Configure settings for BlobFuse2 Preview
1515

16-
> [!IMPORTANT]
17-
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
18-
> This preview version is provided without a service level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
19-
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
20-
>
21-
> If you need to use BlobFuse in a production environment, BlobFuse v1 is generally available (GA). For information about the GA version, see:
22-
>
23-
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
24-
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
25-
26-
BlobFuse2 uses a variety of configuration settings to control its behaviors, including:
16+
You can use configuration settings to manage BlobFuse2 Preview in your deployment. Through configuration settings, you can set these aspects of how BlobFuse2 works in your environment:
2717

2818
- Access to a storage blob
2919
- Logging
3020
- Pipeline engagement
3121
- Caching behavior
3222
- Permissions
3323

34-
For a complete list of settings and their descriptions, see [the base configuration file on GitHub](https://github.com/Azure/azure-storage-fuse/blob/main/setup/baseConfig.yaml).
24+
For a list of all BlobFuse2 settings and their descriptions, see the [base configuration file on GitHub](https://github.com/Azure/azure-storage-fuse/blob/main/setup/baseConfig.yaml).
3525

36-
There are 3 ways of managing configuration settings for BlobFuse2 (in order of precedence):
26+
> [!IMPORTANT]
27+
> BlobFuse2 is the next generation of BlobFuse and currently is in preview. The preview version is provided without a service-level agreement. We recommend that you don't use the preview version for production workloads. In BlobFuse2 Preview, some features might not be supported or might have constrained capabilities. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
28+
>
29+
> To use BlobFuse in a production environment, use the BlobFuse v1 general availability (GA) version. For information about the GA version, see:
30+
>
31+
> - [Mount Azure Blob Storage as a file system by using BlobFuse v1](storage-how-to-mount-container-linux.md)
32+
> - [BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
33+
To manage configuration settings for BlobFuse2, you have three options (in order of precedence):
34+
35+
(1) [Configuration file](#configuration-file)
36+
37+
(2) [Environment variables](#environment-variables)
3738

38-
1. [CLI parameters](#cli-parameters)
39-
1. [Environment variables](#environment-variables)
40-
1. [A configuration file](#configuration-file)
39+
(3) [CLI parameters](#cli-parameters)
4140

42-
Using a configuration file is the preferred method, but the other methods can be useful in some circumstances.
41+
Using a configuration file is the preferred method, but the other methods might be useful in some circumstances.
4342

4443
## Configuration file
4544

46-
Creating a configuration file is the preferred method of establishing settings for BlobFuse2. Once you have specified the desired settings in the file, reference the configuration file when using the `blobfuse2 mount` or other commands. Example:
45+
Creating a configuration file is the preferred method to establish settings for BlobFuse2. When you've specified the settings you want in the configuration file, reference the configuration file when you use `blobfuse2 mount` or other commands.
46+
47+
Here's an example:
4748

4849
````bash
4950
blobfuse2 mount ./mount --config-file=./config.yaml
5051
````
5152

52-
The [Base BlobFuse2 configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/setup/baseConfig.yaml) contains a complete list of all settings and a brief explanation of each.
53+
The [BlobFuse2 base configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/setup/baseConfig.yaml) contains a list of all settings and a brief explanation of each setting.
5354

54-
Use the [Sample file cache configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/sampleFileCacheConfig.yaml) or [the sample streaming configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/sampleStreamingConfig.yaml) to get started quickly using some basic settings for each of those scenarios.
55+
Use the [sample file cache configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/sampleFileCacheConfig.yaml) or the [sample streaming configuration file](https://github.com/Azure/azure-storage-fuse/blob/main/sampleStreamingConfig.yaml) to get started quickly by using some basic settings for each of those scenarios.
5556

5657
## Environment variables
5758

58-
Setting environment variables is another way to configure some BlobFuse2 settings. The supported environment variables are useful for specifying the blob storage container to be accessed and the authorization method.
59-
60-
For more details on using environment variables, see [The environment variables documentation](https://github.com/Azure/azure-storage-fuse/tree/main#environment-variables)
59+
Setting environment variables is another way to configure some BlobFuse2 settings. The supported environment variables are useful for specifying the Azure Blob Storage container to access and the authorization method to use.
6160

62-
See [the BlobFuse2 README](https://github.com/Azure/azure-storage-fuse/tree/main#environment-variables) for a complete list of variables that can be used.
61+
For more information about using environment variables and a list of all variables you can use, see the [BlobFuse2 README](https://github.com/Azure/azure-storage-fuse/tree/main#environment-variables).
6362

64-
## CLI Parameters
63+
## CLI parameters
6564

66-
Configuration settings can be set when passed as parameters of the BlobFuse2 command set, such as the `blobfuse2 mount` command. The mount command typically references a configuration file that contains all of the settings, but individual settings in the configuration file can be overridden by CLI parameters. In this example, the config.yaml configuration file is referenced, but the container to be mounted and the logging options are overridden:
65+
You also can set configuration settings when you pass them as parameters of the BlobFuse2 command set, such as by using the `blobfuse2 mount` command. The mount command typically references a configuration file that contains all the settings. But you can use CLI parameters to override individual settings in the configuration file. In this example, the *config.yaml* configuration file is referenced, but the container to be mounted and the logging options are overridden:
6766

6867
```bash
6968
blobfuse2 mount ./mount_dir --config-file=./config.yaml --container-name=blobfuse2b --log-level=log_debug --log-file-path=./bobfuse2b.log
7069
```
7170

72-
For more information about the complete BlobFuse2 command set, including the `blobfuse2 mount` command, see [The BlobFuse2 command set reference (preview)](blobfuse2-commands.md) and [The BlobFuse2 mount command reference (preview)](blobfuse2-commands-mount.md).
71+
For more information about the entire BlobFuse2 command set, including the `blobfuse2 mount` command, see [BlobFuse2 commands](blobfuse2-commands.md) and [BlobFuse2 mount commands](blobfuse2-commands-mount.md).
7372

7473
## See also
7574

76-
- [What is BlobFuse2? (preview)](blobfuse2-what-is.md)
77-
- [How to mount an Azure blob storage container on Linux with BlobFuse2 (preview)](blobfuse2-how-to-deploy.md)
75+
- [Migrate to BlobFuse2 from BlobFuse v1](https://github.com/Azure/azure-storage-fuse/blob/main/MIGRATION.md)
76+
- [BlobFuse2 commands](blobfuse2-commands.md)
77+
- [Troubleshoot BlobFuse2 issues](blobfuse2-troubleshooting.md)
78+
79+
## Next steps
80+
81+
- [Mount an Azure Blob Storage container on Linux by using BlobFuse2](blobfuse2-how-to-deploy.md)
82+
- [Use Health Monitor to gain insights into BlobFuse2 mount activities and resource usage](blobfuse2-health-monitor.md)
Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,35 @@
11
---
2-
title: How to use BlobFuse2 Health Monitor to gain insights into BlobFuse2 mount activities and resource usage (preview) | Microsoft Docs
2+
title: Use BlobFuse2 Preview Health Monitor to monitor mount activities and resource usage
33
titleSuffix: Azure Blob Storage
4-
description: How to use BlobFuse2 Health Monitor to gain insights into BlobFuse2 mount activities and resource usage (preview).
5-
author: jammart
4+
description: Learn how to use BlobFuse2 Health Monitor to gain insights into BlobFuse2 Preview mount activities and resource usage.
5+
author: jimmart-dev
6+
ms.author: jammart
7+
ms.reviewer: tamram
68
ms.service: storage
79
ms.subservice: blobs
810
ms.topic: how-to
911
ms.date: 09/26/2022
10-
ms.author: jammart
11-
ms.reviewer: tamram
1212
---
1313

14-
# Use Health Monitor to gain insights into BlobFuse2 mounts (preview)
14+
# Use Health Monitor to gain insights into BlobFuse2 Preview mounts
1515

16-
This article provides references to assist in deploying and using BlobFuse2 Health Monitor to gain insights into BlobFuse2 mount activities and resource usage.
16+
This article provides references to help you deploy and use BlobFuse2 Preview Health Monitor to gain insights into BlobFuse2 mount activities and resource usage.
1717

1818
> [!IMPORTANT]
19-
> BlobFuse2 is the next generation of BlobFuse and is currently in preview.
20-
> This preview version is provided without a service level agreement, and might not suitable for production workloads. Certain features might not be supported or might have constrained capabilities.
21-
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
19+
> BlobFuse2 is the next generation of BlobFuse and currently is in preview. The preview version is provided without a service-level agreement. We recommend that you don't use the preview version for production workloads. In BlobFuse2 Preview, some features might not be supported or might have constrained capabilities. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2220
>
23-
> If you need to use BlobFuse in a production environment, BlobFuse v1 is generally available (GA). For information about the GA version, see:
21+
> To use BlobFuse in a production environment, use the BlobFuse v1 general availability (GA) version. For information about the GA version, see:
2422
>
25-
> - [The BlobFuse v1 setup documentation](storage-how-to-mount-container-linux.md)
26-
> - [The BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
23+
> - [Mount Azure Blob Storage as a file system by using BlobFuse v1](storage-how-to-mount-container-linux.md)
24+
> - [BlobFuse v1 project on GitHub](https://github.com/Azure/azure-storage-fuse/tree/master)
2725
2826
You can use BlobFuse2 Health Monitor to:
2927

3028
- Get statistics about internal activities related to BlobFuse2 mounts
3129
- Monitor CPU, memory, and network usage by BlobFuse2 mount processes
3230
- Track file cache usage and events
3331

34-
## BlobFuse2 Health Monitor Resources
32+
## BlobFuse2 Health Monitor resources
3533

3634
During the preview of BlobFuse2, refer to [the BlobFuse2 Health Monitor README on GitHub](https://github.com/Azure/azure-storage-fuse/blob/main/tools/health-monitor/README.md) for full details on how to deploy and use Health Monitor. The README file describes:
3735

@@ -41,6 +39,11 @@ During the preview of BlobFuse2, refer to [the BlobFuse2 Health Monitor README o
4139

4240
## See also
4341

44-
- [What is BlobFuse2? (preview)](blobfuse2-what-is.md)
45-
- [BlobFuse2 configuration reference (preview)](blobfuse2-configuration.md)
46-
- [How to mount an Azure blob storage container on Linux with BlobFuse2 (preview)](blobfuse2-how-to-deploy.md)
42+
- [Migrate to BlobFuse2 from BlobFuse v1](https://github.com/Azure/azure-storage-fuse/blob/main/MIGRATION.md)
43+
- [BlobFuse2 commands](blobfuse2-commands.md)
44+
- [Troubleshoot BlobFuse2 issues](blobfuse2-troubleshooting.md)
45+
46+
## Next steps
47+
48+
- [Configure settings for BlobFuse2](blobfuse2-configuration.md)
49+
- [Use Health Monitor to gain insights into BlobFuse2 mount activities and resource usage](blobfuse2-health-monitor.md)

0 commit comments

Comments
 (0)