|
1 | 1 | ---
|
2 |
| -title: How to configure Blobfuse2 (preview) | Microsoft Docs |
| 2 | +title: Configure settings for BlobFuse2 Preview |
3 | 3 | 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. |
5 | 5 | author: jimmart-dev
|
| 6 | +ms.author: jammart |
| 7 | +ms.reviewer: tamram |
6 | 8 | ms.service: storage
|
7 | 9 | ms.subservice: blobs
|
8 | 10 | ms.topic: how-to
|
9 | 11 | ms.date: 09/29/2022
|
10 |
| -ms.author: jammart |
11 |
| -ms.reviewer: tamram |
12 | 12 | ---
|
13 | 13 |
|
14 |
| -# How to configure Blobfuse2 (preview) |
| 14 | +# Configure settings for BlobFuse2 Preview |
15 | 15 |
|
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: |
27 | 17 |
|
28 | 18 | - Access to a storage blob
|
29 | 19 | - Logging
|
30 | 20 | - Pipeline engagement
|
31 | 21 | - Caching behavior
|
32 | 22 | - Permissions
|
33 | 23 |
|
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). |
35 | 25 |
|
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) |
37 | 38 |
|
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) |
41 | 40 |
|
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. |
43 | 42 |
|
44 | 43 | ## Configuration file
|
45 | 44 |
|
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: |
47 | 48 |
|
48 | 49 | ````bash
|
49 | 50 | blobfuse2 mount ./mount --config-file=./config.yaml
|
50 | 51 | ````
|
51 | 52 |
|
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. |
53 | 54 |
|
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. |
55 | 56 |
|
56 | 57 | ## Environment variables
|
57 | 58 |
|
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. |
61 | 60 |
|
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). |
63 | 62 |
|
64 |
| -## CLI Parameters |
| 63 | +## CLI parameters |
65 | 64 |
|
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: |
67 | 66 |
|
68 | 67 | ```bash
|
69 | 68 | blobfuse2 mount ./mount_dir --config-file=./config.yaml --container-name=blobfuse2b --log-level=log_debug --log-file-path=./bobfuse2b.log
|
70 | 69 | ```
|
71 | 70 |
|
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). |
73 | 72 |
|
74 | 73 | ## See also
|
75 | 74 |
|
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) |
0 commit comments