Skip to content

Commit

Permalink
update docs: add make build in readme and docs
Browse files Browse the repository at this point in the history
Signed-off-by: zhuzhengyi1 <zhuzhengyi@jd.com>
  • Loading branch information
zhuzhengyi1 authored and awzhgw committed Jul 4, 2019
1 parent 602c2bd commit 3c6ccae
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 10 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgit.luolix.top%2Fchubaofs%2Fcfs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgit.luolix.top%2Fchubaofs%2Fcfs?ref=badge_shield)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2761/badge)](https://bestpractices.coreinfrastructure.org/projects/2761)


<img src="https://user-images.githubusercontent.com/47099843/55525970-bf53d880-56c5-11e9-8c28-55d208859824.png" width="400" height="293" />

## Overview

## Overview

ChubaoFS (储宝文件系统) is a distributed file system for cloud native applications. It has the following features:

Expand All @@ -30,15 +29,31 @@ For more details, please refer to our SIGMOD 2019 paper "ChubaoFS: A Distributed


## Document

https://chubaofs.readthedocs.io/en/latest/

https://chubaofs.readthedocs.io/zh_CN/latest/


## Build

Build latest version of chubaofs is simply as following:

```
$ git clone http://github.com/chubaofs/chubaofs.git
$ cd chubaofs
$ make
```

If the build is successful, `cfs-server` and `cfs-client` will be found in directory `build/bin`


## Docker

Under the docker directory, a helper tool called run_docker.sh is provided to run ChubaoFS with docker-compose.

To start a minimal ChubaoFS cluster from scratch, note that **/data/disk** is arbitrary, and make sure there are at least 30G available space.

```
$ docker/run_docker.sh -r -d /data/disk
```
Expand All @@ -52,24 +67,24 @@ $ mount | grep chubaofs
Open http://127.0.0.1:3000 in browser, login with `admin/123456` to view grafana monitor metrics.

Or run server and client seperately by following commands:

```
$ docker/run_docker.sh -b
$ docker/run_docker.sh -s -d /data/disk
$ docker/run_docker.sh -c
$ docker/run_docker.sh -m
```

For more usage,
For more usage:

```
$ docker/run_docker.sh -h
```


## License


Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
For detail see [LICENSE](LICENSE) and [NOTICE](NOTICE).


[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgit.luolix.top%2Fchubaofs%2Fcfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgit.luolix.top%2Fchubaofs%2Fcfs?ref=badge_large)
18 changes: 13 additions & 5 deletions docs/source/quick-start-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Build Client
cd client; sh build.sh
Or use following command to build together:

.. code-block:: bash
make build
If the build is successful, `cfs-server` and `cfs-client` will be found in directory `build/bin`

Deployment
----------

Expand Down Expand Up @@ -58,7 +66,7 @@ Sample *master.json* is shown as follows,
"clusterName":"cfs"
}
For detailed explanations of *master.json*, please refer to :doc:`user-guide/master`.

Start Metanode
Expand Down Expand Up @@ -132,11 +140,11 @@ Start Datanode
2. Start datanode

.. code-block:: bash
nohup ./cfs-server -c datanode.json &
Sample *datanode.json* is shown as follows,

.. code-block:: json
{
Expand Down Expand Up @@ -186,9 +194,9 @@ Mount Client
3. Run ``cfs-client -c fuse.json`` to start a client daemon.

Sample *fuse.json* is shown as follows,

.. code-block:: json
{
"mountPoint": "/mnt/fuse",
"volName": "test",
Expand Down

0 comments on commit 3c6ccae

Please sign in to comment.