Skip to content

Commit 5f1c2e0

Browse files
committed
docs: update readme
Signed-off-by: zmrlft <[email protected]>
1 parent 5d2f4fc commit 5f1c2e0

File tree

8 files changed

+114
-0
lines changed

8 files changed

+114
-0
lines changed

docs/en/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[English](/docs/en/index.md) | [中文](/docs/zh/index.md)
2+
3+
## Introduction
4+
5+
Fluid is an open-source, Kubernetes-native distributed dataset orchestrator and accelerator, designed for data-intensive applications such as big data and artificial intelligence. It is hosted as a sandbox project by the Cloud Native Computing Foundation (CNCF). Fluid enables the transformation of distributed caching systems (such as Alluxio and JuiceFS) into observable cache services with self-management, elastic scaling, and self-healing capabilities by supporting dataset operations. Additionally, by providing data cache location information, Fluid offers data affinity scheduling for applications using datasets.
6+
7+
The Fluid plugin is a KubeSphere extension based on Fluid, providing a visual interface for dataset management, data loading, runtime management, and more. It aims to offer a better user experience for managing Fluid core resources, lowering the barrier of CLI operations, and improving the management efficiency of data-intensive applications.
8+
9+
### Main Features
10+
11+
- **Dataset Management**: Supports creation, viewing, editing, and deletion of datasets.
12+
![datasetlist.png](/docs/images/datasetlist.png)
13+
- **Data Load Tasks**: Visual management of data loading tasks with support for multiple loading strategies.
14+
![dataloadconfig.png](/docs/images/dataloadconfig.png)
15+
- **Runtime Management**: Monitors the status and events of various runtimes (such as Alluxio, JuiceFS, GooseFS, etc.).Click on replicas to scale up or down, and click on worker or master to jump to the corresponding workload.
16+
![rumtime.png](/docs/images/rumtime.png)
17+
- **Multi-Cluster and Namespace Support**: Allows switching between different clusters and namespaces, suitable for multi-tenant scenarios.
18+
19+
### Installation
20+
21+
- Find the Fluid extension component on the Extension Marketplace page, click Install, select the latest version, and click the Next button.
22+
![extensioncentor.png](/docs/images/extensioncentor.png)
23+
- On the Extension Installation tab page, click and modify the extension configuration as needed. After configuration, click the Start Installation button to begin installation.
24+
![fluidinstallconfig.png](/docs/images/fluidinstallconfig.png)
25+
- After installation is complete, click the Next button to enter the cluster selection page. Select the clusters to install, click Next, and proceed to the Differential Configuration page.
26+
- Update the differential configuration as needed. After updating, start the installation and wait for it to complete.
27+
28+
### Configuration
29+
30+
Click on the extension component configuration, and control whether to install the frontend by setting enabled.
31+
```yaml
32+
frontend:
33+
enabled: true
34+
```
35+
36+
### Contact and Support
37+
38+
If you have any questions or suggestions, feel free to submit an issue or participate in community discussions.

docs/images/dataloadconfig.png

85.8 KB
Loading

docs/images/datasetlist.png

66.3 KB
Loading

docs/images/extensioncentor.png

50.1 KB
Loading

docs/images/fluidinstallconfig.png

61.3 KB
Loading

docs/images/rumtime.png

93.9 KB
Loading

docs/zh/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[English](/docs/en/index.md) | [中文](/docs/zh/index.md)
2+
3+
## 介绍
4+
5+
Fluid是一个开源的、原生Kubernetes的分布式数据集编排器和加速器,适用于大数据和人工智能等数据密集型应用。它由云原生计算基金会(CNCF)作为沙盒项目托管。Fluid能够通过支持数据集操作,将分布式缓存系统(如Alluxio和JuiceFS)转换为具有自我管理、弹性伸缩和自我修复能力的可观测缓存服务。同时,通过数据缓存位置信息,Fluid可以为使用数据集的应用程序提供数据亲和性调度。
6+
7+
Fluid插件则是基于Fluid的kubesphere扩展插件,提供数据集管理、数据加载、运行时管理等功能的可视化。旨在以更好的用户体验管理Fluid核心资源,解决CLI操作门槛高的问题,提升数据密集型应用的管理效率。
8+
9+
### 主要功能
10+
11+
- **数据集管理**:支持数据集(Dataset)的创建、查看、编辑和删除。
12+
![datasetlist.png](/docs/images/datasetlist.png)
13+
- **数据加载任务**:可视化管理数据加载(Dataload)任务,支持多种加载策略。
14+
![dataloadconfig.png](/docs/images/dataloadconfig.png)
15+
- **运行时管理**:支持多种运行时(如 Alluxio、JuiceFS、GooseFS 等)的状态监控与事件查看,通过点击replicas来扩缩容,点击worker或者master跳转对应的工作负载。
16+
![rumtime.png](/docs/images/rumtime.png)
17+
- **多集群与命名空间支持**:可切换不同集群和命名空间,适配多租户场景。
18+
19+
### 安装
20+
21+
- 通过 扩展市场 页面找到 fluid 扩展组件,点击 安装,选择最新版本,点击 下一步 按钮;
22+
![extensioncentor.png](/docs/images/extensioncentor.png)
23+
- 在 扩展组件安装 标签页面中,根据需求点击并修改 扩展组件配置,通过设置enabled来控制是否安装前端,配置完成后,点击 开始安装 按钮,开始安装;
24+
![fluidinstallconfig.png](/docs/images/fluidinstallconfig.png)
25+
- 安装完成后,点击 下一步 按钮,进入集群选择页面,勾选需要安装的集群,点击 下一步 按钮,进入 差异化配置 页面;
26+
- 根据需求更新 差异化配置,更新完成,开始安装,静待安装完成。
27+
28+
### 配置
29+
30+
点击扩展组件配置,通过设置enabled来控制是否安装前端
31+
```yaml
32+
frontend:
33+
enabled: true
34+
```
35+
36+
### 联系与支持
37+
38+
如有问题或建议,欢迎通过 Issue 反馈或参与社区讨论。

readme.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[English](/docs/en/index.md) | [中文](/docs/zh/index.md)
2+
3+
## Introduction
4+
5+
Fluid is an open-source, Kubernetes-native distributed dataset orchestrator and accelerator, designed for data-intensive applications such as big data and artificial intelligence. It is hosted as a sandbox project by the Cloud Native Computing Foundation (CNCF). Fluid enables the transformation of distributed caching systems (such as Alluxio and JuiceFS) into observable cache services with self-management, elastic scaling, and self-healing capabilities by supporting dataset operations. Additionally, by providing data cache location information, Fluid offers data affinity scheduling for applications using datasets.
6+
7+
The Fluid plugin is a KubeSphere extension based on Fluid, providing a visual interface for dataset management, data loading, runtime management, and more. It aims to offer a better user experience for managing Fluid core resources, lowering the barrier of CLI operations, and improving the management efficiency of data-intensive applications.
8+
9+
### Main Features
10+
11+
- **Dataset Management**: Supports creation, viewing, editing, and deletion of datasets.
12+
![datasetlist.png](/docs/images/datasetlist.png)
13+
- **Data Load Tasks**: Visual management of data loading tasks with support for multiple loading strategies.
14+
![dataloadconfig.png](/docs/images/dataloadconfig.png)
15+
- **Runtime Management**: Monitors the status and events of various runtimes (such as Alluxio, JuiceFS, GooseFS, etc.).Click on replicas to scale up or down, and click on worker or master to jump to the corresponding workload.
16+
![rumtime.png](/docs/images/rumtime.png)
17+
- **Multi-Cluster and Namespace Support**: Allows switching between different clusters and namespaces, suitable for multi-tenant scenarios.
18+
19+
### Installation
20+
21+
- Find the Fluid extension component on the Extension Marketplace page, click Install, select the latest version, and click the Next button.
22+
![extensioncentor.png](/docs/images/extensioncentor.png)
23+
- On the Extension Installation tab page, click and modify the extension configuration as needed. After configuration, click the Start Installation button to begin installation.
24+
![fluidinstallconfig.png](/docs/images/fluidinstallconfig.png)
25+
- After installation is complete, click the Next button to enter the cluster selection page. Select the clusters to install, click Next, and proceed to the Differential Configuration page.
26+
- Update the differential configuration as needed. After updating, start the installation and wait for it to complete.
27+
28+
### Configuration
29+
30+
Click on the extension component configuration, and control whether to install the frontend by setting enabled.
31+
```yaml
32+
frontend:
33+
enabled: true
34+
```
35+
36+
### Contact and Support
37+
38+
If you have any questions or suggestions, feel free to submit an issue or participate in community discussions.

0 commit comments

Comments
 (0)