docs: support Gluster as the object storage (#3876)

juicedata · Jul 5, 2023 · aac86fb · aac86fb
1 parent 7a035a0
commit aac86fb
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 0 deletions.
diff --git a/docs/en/guide/how_to_set_up_object_storage.md b/docs/en/guide/how_to_set_up_object_storage.md
@@ -171,6 +171,7 @@ If you wish to use a storage system that is not listed, feel free to submit a re
 | [UCloud US3](#ucloud-us3)                                   | `ufile`    |
 | [Ceph RADOS](#ceph-rados)                                   | `ceph`     |
 | [Ceph RGW](#ceph-rgw)                                       | `s3`       |
+| [Gluster](#gluster)                                         | `gluster`  |
 | [Swift](#swift)                                             | `swift`    |
 | [MinIO](#minio)                                             | `minio`    |
 | [WebDAV](#webdav)                                           | `webdav`   |
@@ -799,6 +800,47 @@ juicefs format \
     myjfs
 ```
 
+## Gluster
+
+[Gluster](https://github.com/gluster/glusterfs) is a software defined distributed storage that can scale to several petabytes. JuiceFS communicates with Gluster via the `libgfapi` library, so it needs to be built separately before used.
+
+First, install `libgfapi` (version 6.0+):
+
+<Tabs>
+  <TabItem value="debian" label="Debian and derivatives">
+
+```bash
+sudo apt-get install libglusterfs-dev
+```
+
+  </TabItem>
+  <TabItem value="centos" label="RHEL and derivatives">
+
+```bash
+sudo yum install glusterfs-api-devel
+```
+
+  </TabItem>
+</Tabs>
+
+Then compile JuiceFS supporting Gluster:
+
+```bash
+make juicefs.gluster
+```
+
+Now we can create a JuiceFS volume on Gluster:
+
+```bash
+juicefs format \
+    --storage gluster \
+    --bucket host1,host2,host3/gv0 \
+    ... \
+    myjfs
+```
+
+The format of `--bucket` option is `<host[,host...]>/<volume_name>`. Please note the `volume_name` here is the name of Gluster volume, and has nothing to do with the name of JuiceFS volume.
+
 ## Swift
 
 [OpenStack Swift](https://github.com/openstack/swift) is a distributed object storage system designed to scale from a single machine to thousands of servers. Swift is optimized for multi-tenancy and high concurrency. Swift is ideal for backups, web and mobile content, and any other unstructured data that can grow without bound.

diff --git a/docs/zh_cn/guide/how_to_set_up_object_storage.md b/docs/zh_cn/guide/how_to_set_up_object_storage.md
@@ -171,6 +171,7 @@ juicefs format \
 | [优刻得 US3](#优刻得-us3)                   | `ufile`    |
 | [Ceph RADOS](#ceph-rados)                   | `ceph`     |
 | [Ceph RGW](#ceph-rgw)                       | `s3`       |
+| [Gluster](#gluster)                         | `gluster`  |
 | [Swift](#swift)                             | `swift`    |
 | [MinIO](#minio)                             | `minio`    |
 | [WebDAV](#webdav)                           | `webdav`   |
@@ -799,6 +800,47 @@ juicefs format \
     myjfs
 ```
 
+## Gluster
+
+[Gluster](https://github.com/gluster/glusterfs) 是一款开源的软件定义分布式存储，单集群能支持 PiB 级别的数据。JuiceFS 通过 `libgfapi` 库与 Gluster 集群交互，使用前需要单独编译。
+
+首先安装 `libgfapi`（6.0 或以上版本）：
+
+<Tabs>
+  <TabItem value="debian" label="Debian 及衍生版本">
+
+```bash
+sudo apt-get install libglusterfs-dev
+```
+
+  </TabItem>
+  <TabItem value="centos" label="RHEL 及衍生版本">
+
+```bash
+sudo yum install glusterfs-api-devel
+```
+
+  </TabItem>
+</Tabs>
+
+然后编译支持 Gluster 的 JuiceFS：
+
+```bash
+make juicefs.gluster
+```
+
+现在我们可以创建出基于 Gluster 的 JuiceFS volume：
+
+```bash
+juicefs format \
+    --storage gluster \
+    --bucket host1,host2,host3/gv0 \
+    ... \
+    myjfs
+```
+
+其中 `--bucket` 选项格式为 `<host[,host...]>/<volume_name>`。注意这里的 `volume_name` 为 Gluster 中的卷名称，与 JuiceFS volume 自身的名字没有直接关系。
+
 ## Swift
 
 [OpenStack Swift](https://github.com/openstack/swift) 是一种分布式对象存储系统，旨在从一台计算机扩展到数千台服务器。Swift 已针对多租户和高并发进行了优化。Swift 广泛适用于备份、Web 和移动内容的理想选择，可以无限量存储任何非结构化数据。