Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leo-project/leofs
The LeoFS Storage System
https://github.com/leo-project/leofs
datalake distributed-file-system distributed-storage erlang leofs nfs nfs-server s3 s3-storage
Last synced: 7 days ago
JSON representation
The LeoFS Storage System
- Host: GitHub
- URL: https://github.com/leo-project/leofs
- Owner: leo-project
- License: apache-2.0
- Created: 2012-06-06T15:29:16.000Z (over 12 years ago)
- Default Branch: v1
- Last Pushed: 2020-06-02T10:33:51.000Z (over 4 years ago)
- Last Synced: 2024-12-28T22:05:56.261Z (14 days ago)
- Topics: datalake, distributed-file-system, distributed-storage, erlang, leofs, nfs, nfs-server, s3, s3-storage
- Language: Erlang
- Homepage: https://leo-project.net/leofs/
- Size: 30 MB
- Stars: 1,556
- Watchers: 85
- Forks: 155
- Open Issues: 255
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-repositories - leo-project/leofs - The LeoFS Storage System (Erlang)
README
# LeoFS - A Storage System for a Data Lake and the Web
[](https://gitter.im/leo-project/leofs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://github.com/leo-project/leofs/releases/tag/1.4.4) [](http://travis-ci.org/leo-project/leofs)
## Overview
LeoFS is an **Enterprise Open Source Storage**, and it is a highly available, distributed, eventually consistent object/blob store. If you are seeking a storage system that can store huge amount and various kind of files such as photo, movie, log data and so on, LeoFS is suitable for that.
LeoFS is supporting the following features:
* **Multi Protocol**
* **S3-API Support**
* LeoFS is an Amazon S3 compatible storage system.
* Switch to LeoFS to decrease your cost from more expensive public-cloud solutions.
* **REST-API Support**
* To easily access LeoFS with [REST-API](https://leo-project.net/leofs/docs/admin/protocols/rest/)
* **NFS Support**
* NFS support was provided from LeoFS v1.1, the current status of which is beta.
* **Large Object Support**
* LeoFS covers handling large size objects.
* **Multi Data Center Replication**
* LeoFS is a highly scalable, fault-tolerant distributed file system without SPOF.
* LeoFS's cluster can be viewed as a huge capacity storage. It consists of a set of loosely connected nodes.
* We can build a global scale storage system with easy operations
## Architecture
LeoFS consists of three core components - [LeoStorage](https://leo-project.net/leofs/docs/architecture/leo_storage/), [LeoGateway](https://leo-project.net/leofs/docs/architecture/leo_gateway/) and [LeoManager](https://leo-project.net/leofs/docs/architecture/leo_manager/) which depend on Erlang.
[LeoGateway](https://leo-project.net/leofs/docs/architecture/leo_gateway/) handles http-request and http-response from any clients when using REST-API OR S3-API. Also, it is already built in the object-cache mechanism (memory and disk cache).
[LeoStorage](https://leo-project.net/leofs/docs/architecture/leo_storage/) handles GET, PUT and DELETE objects as well as metadata. Also, it has replicator, recoverer and queueing mechanism in order to keep running a storage node and realise eventual consistency.
[LeoManager](https://leo-project.net/leofs/docs/architecture/leo_manager/) always monitors LeoGateway and LeoStorage nodes. The main monitoring status are Node status and RING’s checksum in order to realise to keep high availability and keep data consistency.
You can access a LeoFS system using Amazon S3 clients and the SDK.
## Slide
The presentation - Scaling and High Performance Storage System: LeoFS was given at Erlang User Conference 2014 in Stockholm on June 2014
## GOALs
* LeoFS has been aiming to provide **high reliability**, **high scalability**, and **high cost performance ratio**:
* HIGH Reliability
* Nine nines - Operating ratios is 99.9999999%
* High Scalability
* Build huge-cluster at low cost
* HIGH Cost Performance
* Fast - Over 10Gbps
* A lower cost than other storage
* Provide easy management and easy operation
## Further Reference
## Build LeoFS with LeoFS Packages
LeoFS packages have been already provided on the Web. You're able to easily install LeoFS on your environments.
* LeoProject
* CentOS 6.x, 7.x
* Ubuntu 14.04, 16.04
* Community
* FreeBSD
Here is the installation manual.
## Build LeoFS From Source (For Developers)
Here, we explain how to build LeoFS from source code.
First, you have to install the following packages to build Erlang and LeoFS.
### Build Dependencies
```bash
## [CentOS]
$ sudo yum install cmake check-devel gcc gcc-c++ make
## [Ubuntu]
$ sudo apt-get install gcc g++ cmake make check libtool
### For Docker
$ apt-get install lsb-release
```
### Install Erlang
You can install Erlang with [kerl](https://github.com/kerl/kerl).
* Install [kerl](https://github.com/kerl/kerl)
```bash
$ curl -O https://raw.githubusercontent.com/kerl/kerl/master/kerl
$ chmod a+x kerl
$ mkdir -p ~/bin
$ mv kerl ~/bin/
$ echo "export PATH=$PATH:~/bin" >> ~/.bashrc
$ source ~/.bashrc
```
* Install Erlang (Erlang/OTP 19.3)
```bash
$ kerl build 19.3 19.3
$ kerl list builds
19.3,19.3
$ kerl install 19.3 /path/to/19.3
$ kerl list installations
19.3 /path/to/19.3
$ source /path/to/19.3/activate
$ kerl active
The current active installation is:
/path/to/19.3
```
### Install LeoFS
Then, clone source of LeoFS and libraries from GitHub.
```bash
$ git clone https://github.com/leo-project/leofs.git
$ cd leofs
$ git checkout -b develop remotes/origin/develop
$ ./rebar get-deps
$ ./git_checkout.sh develop
```
Then, build LeoFS with the following commands.
```bash
$ make && make release_for_test
```
Now, you can find the LeoFS package as follow.
```bash
$ ls package/
leo_gateway/ leo_manager_0/ leo_manager_1/ leo_storage/ README.md
```
Then, we can start and access LeoFS with the following commands. Also, you're able to easily operate LeoFS with [leofs-adm](https://github.com/leo-project/leofs/blob/master/leofs-adm) script.
```bash
$ package/leo_manager_0/bin/leo_manager start
$ package/leo_manager_1/bin/leo_manager start
$ package/leo_storage/bin/leo_storage start
$ package/leo_gateway/bin/leo_gateway start
$ ./leofs-adm status
[System Confiuration]
-----------------------------------+----------
Item | Value
-----------------------------------+----------
Basic/Consistency level
-----------------------------------+----------
system version | 1.3.4
cluster Id | leofs_1
DC Id | dc_1
Total replicas | 1
number of successes of R | 1
number of successes of W | 1
number of successes of D | 1
number of rack-awareness replicas | 0
ring size | 2^128
-----------------------------------+----------
Multi DC replication settings
-----------------------------------+----------
[mdcr] max number of joinable DCs | 2
[mdcr] total replicas per a DC | 1
[mdcr] number of successes of R | 1
[mdcr] number of successes of W | 1
[mdcr] number of successes of D | 1
-----------------------------------+----------
Manager RING hash
-----------------------------------+----------
current ring-hash |
previous ring-hash |
-----------------------------------+----------
[State of Node(s)]
-------+--------------------------+--------------+----------------+----------------+----------------------------
type | node | state | current ring | prev ring | updated at
-------+--------------------------+--------------+----------------+----------------+----------------------------
S | [email protected] | attached | | | 2017-06-02 14:59:20 +0900
-------+--------------------------+--------------+----------------+----------------+----------------------------
$ ./leofs-adm start
OK
$ ./leofs-adm status
[System Confiuration]
-----------------------------------+----------
Item | Value
-----------------------------------+----------
Basic/Consistency level
-----------------------------------+----------
system version | 1.3.4
cluster Id | leofs_1
DC Id | dc_1
Total replicas | 1
number of successes of R | 1
number of successes of W | 1
number of successes of D | 1
number of rack-awareness replicas | 0
ring size | 2^128
-----------------------------------+----------
Multi DC replication settings
-----------------------------------+----------
[mdcr] max number of joinable DCs | 2
[mdcr] total replicas per a DC | 1
[mdcr] number of successes of R | 1
[mdcr] number of successes of W | 1
[mdcr] number of successes of D | 1
-----------------------------------+----------
Manager RING hash
-----------------------------------+----------
current ring-hash | 433fe365
previous ring-hash | 433fe365
-----------------------------------+----------
[State of Node(s)]
-------+--------------------------+--------------+----------------+----------------+----------------------------
type | node | state | current ring | prev ring | updated at
-------+--------------------------+--------------+----------------+----------------+----------------------------
S | [email protected] | running | 433fe365 | 433fe365 | 2017-06-02 15:00:10 +0900
G | [email protected] | running | 433fe365 | 433fe365 | 2017-06-02 15:00:12 +0900
-------+--------------------------+--------------+----------------+----------------+----------------------------
```
## Build a LeoFS Cluster
You can easily build a LeoFS cluster. See here.
## Configure LeoFS
About the configuration of LeoFS, See here.
## Benchmarking
You can benchmark LeoFS with Basho Bench, and here is a documentation to benchmark LeoFS.
## Integration Test
You can test LeoFS with leofs_test whether LeoFS has issues or not before getting installed LeoFS in your dev/staging/production environment(s).
## Milestones
### Version 1
* *DONE* - [v1.0](https://github.com/leo-project/leofs/releases/tag/1.0.2)
* Multi Data Center Replication
* Increase compatibility S3-APIs#5
* Other bucket operations
* *DONE* - [v1.1](https://github.com/leo-project/leofs/releases/tag/1.1.5)
* NFS v3 Support *(alpha)*
* Improve Web GUI Console (Option)
* *DONE* - [v1.2](https://github.com/leo-project/leofs/releases/tag/1.2.22)
* NFS v3 Support *(beta)*
* Watchdog
* Automated data-compaction
* *DONE* - v1.3
* NFS v3 Support *(stable)*
* Improve compatibility S3-APIs#6
* [AWS Signature v4](http://docs.aws.amazon.com/general/latest/gr/sigv4_changes.html) support (v1.3.0)
* Custom Metadata Support (v1.3.1)
* *DONE* - v1.4
* Improvement of the core features
* Integration with distributed computing frameworks#1
* Hadoop integration
* Spark integration
### Version 2
* *WIP* - v2.0
* Erasure Code
* Improve Data Security for [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) and Enterprise Storages
* Improve compatibility S3-APIs#7
* [Server Side Object Encryption](http://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
* NFS v3 Support *(stable)*
* Improve performance of the list objects, `the ls command`
* Improvement of the Multi Data Center Replication
* Searching objects by a custom-metadata
* v2.1
* Hinted Hand-off
* Improve compatibility S3-APIs#8
* Objects Expiration into a Bucket
* Object Versioning
* [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) Support
* Integration with distributed computing frameworks#2
* Hadoop integration
* Spark integration
* Improve Web GUI console, LeoFS Center *(option)*
* v2.2
* Data Deduplication
* Improve compatibility S3-APIs#9
## Versioning Policy
LeoFS adheres to [the versioning policy](http://semver.org/) from v1.3.3.
## Licensing
LeoFS is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
## Sponsors
* January, 2019 - : [Lions Data, Ltd.](https://lions-data.com)
* Februay, 2010 - December, 2018: [Rakuten, Inc.](http://global.rakuten.com/corp/)