Skip to content

Commit d70dced

Browse files
authored
[docs] Add Azure Blob Storage documentation (#2507)
1 parent 96faf08 commit d70dced

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Azure Blob Storage
3+
sidebar_position: 5
4+
---
5+
6+
# Azure Blob Storage
7+
8+
[Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs) (Azure Blob Storage) is a massively scalable and secure object storage for cloud-native workloads, archives, data lakes, HPC, and machine learning.
9+
10+
## Install Azure FS Plugin Manually
11+
12+
Azure Blob Storage support is not included in the default Fluss distribution. To enable Azure Blob Storage support, you need to manually install the filesystem plugin into Fluss.
13+
14+
1. **Prepare the plugin JAR**:
15+
16+
- Download the `fluss-fs-azure-$FLUSS_VERSION$.jar` from the [Maven Repository](https://repo1.maven.org/maven2/org/apache/fluss/fluss-fs-azure/$FLUSS_VERSION$/fluss-fs-azure-$FLUSS_VERSION$.jar).
17+
18+
2. **Place the plugin**: Place the plugin JAR file in the `${FLUSS_HOME}/plugins/azure/` directory:
19+
```bash
20+
mkdir -p ${FLUSS_HOME}/plugins/azure/
21+
cp fluss-fs-azure-$FLUSS_VERSION$.jar ${FLUSS_HOME}/plugins/azure/
22+
```
23+
24+
3. Restart Fluss if the cluster is already running to ensure the new plugin is loaded.
25+
26+
## Configurations setup
27+
28+
To enabled Azure Blob Storage as remote storage, there are some required configurations that must be added to Fluss' `server.yaml`:
29+
30+
```yaml
31+
# The dir that used to be as the remote storage of Fluss, use the Azure Data Lake Storage URI
32+
remote.data.dir: abfs://[email protected]/path
33+
# the access key for the azure blob storage account
34+
fs.azure.account.key: 09a295d5-3da5-4435-a660-f438b331ade8
35+
# The oauth account provider type for Token-based Authentication
36+
fs.azure.account.oauth.provider.type: org.apache.fluss.fs.azure.token.DynamicTemporaryAzureCredentialsProvider
37+
# The oauth2 client id for Token-based Authentication
38+
fs.azure.account.oauth2.client.id: ed953f8a-d5e9-481c-b355-62794f178f66
39+
# The oauth2 client secret for Token-based Authentication
40+
fs.azure.account.oauth2.client.secret: ec29f904-64f6-4372-831a-dc28ec818683
41+
# The oauth2 endpoint to generate access tokens for Token-based Authentication
42+
fs.azure.account.oauth2.client.endpoint: https://login.microsoftonline.com/154b1d91-2d07-4e3a-beb6-9261ab4926ab/oauth2/token
43+
```

website/docs/maintenance/filesystems/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The Fluss project supports the following file systems:
3636

3737
- **[AWS S3](s3.md)** is supported by `fluss-fs-s3` and registered under the `s3://` URI scheme.
3838

39+
- **[Azure Blob Storage](azure.md)** is supported by `fluss-fs-azure` and registered under the `abfs://`,`abfss://`,`wasb://`,`wasbs://`, URI schemes.
40+
3941
- **[HuaweiCloud OBS](obs.md)** is supported by `fluss-fs-obs` and registered under the `obs://` URI scheme. Please make sure to [manually install the OBS plugin](obs.md#install-obs-plugin-manually).
4042

4143
The implementation is based on [Hadoop Project](https://hadoop.apache.org/) but is self-contained with no dependency footprint.

0 commit comments

Comments
 (0)