# FastCFS

**Repository Path**: micoder/FastCFS

## Basic Information

- **Project Name**: FastCFS
- **Description**: 基于块存储的高性能通用分布式文件系统 FastCFS，可以作为数据库（MySQL、PostgresSQL、Oracle等）以及k8s和虚拟机（KVM等）的后端存储。
- **Primary Language**: C
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 153
- **Created**: 2021-11-19
- **Last Updated**: 2022-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastCFS -- a high performance distributed file system for databases, K8s and VM etc.

English | [简体中文](./README-zh_CN.md)

## 1. About

FastCFS is a block based standard distributed file system which can be used as the back-end storage of databases (MySQL, PostgresSQL, Oracle etc.), K8s and virtual machines such as KVM.

## 2. Current Version

V2.3.0

## 3. Supported Platforms

* Linux: Kernel version >= 3.10  (Full support)
* MacOS or FreeBSD (Only server side)

## 4. Dependencies

* [libfuse](https://github.com/libfuse/libfuse) (version 3.9.4 or newer)
    * [Python](https://python.org/) (version 3.5 or newer)
    * [Ninja](https://ninja-build.org/) (version 1.7 or newer)
    * [gcc](https://www.gnu.org/software/gcc/) (version 4.7.0 or newer)
* [libfastcommon](https://github.com/happyfish100/libfastcommon) (tag: V1.0.53)
* [libserverframe](https://github.com/happyfish100/libserverframe) (tag: V1.1.10)
* [fastDIR](https://github.com/happyfish100/fastDIR) (tag: V2.3.0)
* [faststore](https://github.com/happyfish100/faststore) (tag: V2.3.0)
* [FastCFS](https://github.com/happyfish100/FastCFS) (tag: V2.3.0)

## 5. Installation

### 5.1 DIY installation

you can use [Cluster Operation Tool](docs/fcfs-ops-tool.md) to deploy FastCFS

step by step please see [INSTALL](docs/INSTALL.md)

recommend to execute libfuse_setup.sh for compiling and installing libfuse

### 5.2 easy installation

libfastcommon, libserverframe, fastDIR, faststore and FastCFS can be compiled, installed and auto configurated by fastcfs.sh

fastcfs.sh can automatically pull or update above five projects codes from GitHub, compile and install according to dependency orders, and automatically generate cluster related configuration files according to the config templates.

```
git clone https://github.com/happyfish100/FastCFS.git; cd FastCFS/
```

fastcfs.sh usage:

```
* install: pull/update codes from gitee, then make and install
* config: copy config files and configure them with local ip
* start | stop | restart: for service processes control
```

one click to build (deploy and run) single node demo environment (MUST run by root):

```
./helloWorld.sh
```

or execute following commands (MUST run by root):

```
./fastcfs.sh install
./fastcfs.sh config --force
./fastcfs.sh restart
```

now you can see the mounted path of FastCFS by the command:

```
df -h /opt/fastcfs/fuse | grep fuse
```

## 6. Benchmark

FastCFS has huge better performance than Ceph: the IOPS ratio of sequential write is 6.x, sequential read is 2.x, random write is about 2.0.

* [FastCFS vs. Ceph benchmark](docs/benchmark.md)

## 7. K8s CSI Driver

[fastcfs-csi](https://github.com/happyfish100/fastcfs-csi)

## 8. Chinese Relative articles

<a href="https://blog.csdn.net/happy_fish100/" target="_blank">CSDN blog</a>

## 9. TODO List

*  [fdir] use cache + external storage to support massive files (Doing & Will be completed in October)
*  [fstore] hierarchical storage & slice merging: supporting two-level storage, such as SSD + HDD
*  [fstore] provide cluster tools for automatic expansion
*  [fdir & fstore] binlog deduplication (fdir binlog, fstore replica & slice binlog)
*  [fstore] after the machine recovery, the data masters should be rebalanced

## 10. Contact us

email: 384681(at)qq(dot)com

WeChat subscription: search "fastdfs" for the related articles (Chinese Only)