Skip to content

an embedded object storage based filesystem library

License

Notifications You must be signed in to change notification settings

neuyilan/Gopherwood

 
 

Repository files navigation

Gopherwood

Gopherwood is an embedded persistent caching library with infinite space by leveraging object storage. It provides unified filesystem APIs for local caching files and supports offloading data to Object Store Service transparently when caching size exceeded the local disk volume. A block-based metadata system is designed to support infinite caching space, multi-process accessing, data persistent and caching recovery.

The project is created to help on-premise system easily transform to cloud-oriented system. Using object
store service will help solve the data high availability issues and lower the disk cost by configuring a minimum local disk quota.

See the github wiki for detailed documentations, developer guides and FAQs.

Installation

Requirement

To build Gopherwood, the following libraries are needed.

cmake (2.8+)                    http://www.cmake.org/
boost (tested on 1.53+)         http://www.boost.org/
liboss                          binary integrated in project, will open source later

To run tests, the following libraries are needed.

gtest (tested on 1.7.0)         already integrated in the source code
gmock (tested on 1.7.0)         already integrated in the source code

To run code coverage test, the following tools are needed.

gcov (included in gcc distribution)
lcov (tested on 1.9)            http://ltp.sourceforge.net/coverage/lcov.php

Configuration, Build and Install

cd GOPHERWOOD_HOME
mkdir build
cd build
../bootstrap

Run command "../bootstrap --help" for more configuration.

make 
make install 

Configurations of Object Storage Service

modify $GOPHERWOOD_HOME/config.properties 
export GOPHERWOOD_CONF=$GOPHERWOOD_HOME/config.properties

Test

To test all test cases, run command

make testAll

To do function test, run command

make functiontest

To show code coverage result, run command. Code coverage result can be found at BUILD_DIR/CodeCoverageReport/index.html

make ShowCoverage

About

an embedded object storage based filesystem library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 95.4%
  • CMake 3.5%
  • Other 1.1%