Skip to content

Commit cfee417

Browse files
pkonopelkopkonopelko
committed
Updated README.md
1 parent 635a68d commit cfee417

File tree

1 file changed

+26
-29
lines changed

1 file changed

+26
-29
lines changed

‎README.md‎

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# MooseFS Docker Cluster
22

3-
This is a basic configuration of a multiple nodes MooseFS cluster based on the Debian Buster Docker image. It consists of a master server, a CGI server, 4 chunk servers, and one client. After a successful installation, you will have a fully working MooseFS cluster to play with its amazing features.
3+
This is a basic configuration of a multiple-node MooseFS cluster based on the Debian Buster Docker image. It consists of a Master Server, a CGI Monitoring Interface Server, 4 Chunkservers, and one Client. After a successful installation, you will have a fully working MooseFS cluster to play with its amazing features.
44

55
# Updates
66

7-
- All moosefs processes are now correctly handling signals.
7+
- All MooseFS processes are now correctly handling signals.
88
- Metadata and data are now persistent and mounted as volumes.
9-
- TEST and PROD moosefs master metadata behavior defined by MFS_ENV variable.
10-
- Specify storage size per chunk server (env: **SIZE**) default not defined. Depends on your local storage free space.
11-
- Specify label per chunk server (env: **LABEL**, default: *empty*).
9+
- TEST and PROD moosefs master metadata behavior defined by `MFS_ENV` variable.
10+
- Specify storage size per chunk server (env: `SIZE`) default not defined. Depends on your local storage free space.
11+
- Specify label per chunk server (env: `LABEL`, default: *empty*).
1212
- Switched to *debian:buster* as a base image.
1313
- Example with 4 chunk servers (labels: M, MB, MB, B).
1414

1515
# Cluster configurations
1616

1717
**File docker-compose.yml**
1818

19-
- master **172.20.0.2**
20-
- CGI [http://localhost:9425](http://localhost:9425) on Linux also [http://172.20.0.3:9425](http://172.20.0.3:9425)
21-
- metalogger **172.20.0.4**
22-
- chunkserver1 **172.20.0.11**, label: **M**
23-
- chunkserver2 **172.20.0.12**, label: **M**,**B**
24-
- chunkserver3 **172.20.0.13**, label: **M**,**B**
25-
- chunkserver4 **172.20.0.14**, label: **B**
26-
- client **172.168.20.0.100**
19+
- Master Server: `172.20.0.2`
20+
- CGI Monitoring Interface: [http://localhost:9425](http://localhost:9425), on Linux also [http://172.20.0.3:9425](http://172.20.0.3:9425)
21+
- Metalogger: `172.20.0.4`
22+
- Chunkserver 1: `172.20.0.11`, labels: `M`
23+
- Chunkserver 2: `172.20.0.12`, labels: `M, B`
24+
- Chunkserver 3: `172.20.0.13`, labels: `M, B`
25+
- Chunkserver 4: `172.20.0.14`, labels: `B`
26+
- Client: `172.168.20.0.100`
2727

2828
# Setup
2929

30-
Install Docker with Docker Composer from [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
30+
Install Docker with Docker Composer from [https://docs.docker.com/compose/install](https://docs.docker.com/compose/install)
3131

3232
Clone MooseFS docker config files:
3333

@@ -43,14 +43,14 @@ docker-compose build
4343
docker-compose up
4444
```
4545

46-
On Linux OS run docker-compose as root:
46+
On Linux OS run `docker-compose` as root:
4747

4848
```
4949
sudo -E docker-compose build
5050
sudo -E docker-compose up
5151
```
5252

53-
You can also run docker-compose in detached mode. All running Docker nodes will run in the background, so Docker console output will be invisible.
53+
You can also run `docker-compose` in detached mode. All running Docker nodes will run in the background, so Docker console output will be invisible.
5454

5555
```
5656
sudo -E docker-compose build
@@ -63,7 +63,7 @@ You can check if instances are running:
6363
docker ps
6464
```
6565

66-
You should have 1 master, 1 metalogger, 4 chunk servers and 1 client running (first configuration). The expected output should be similar to this:
66+
You should have 1 Master Server, 1 Metalogger, 4 Chunkservers and 1 Client running (first configuration). The expected output should be similar to the following:
6767

6868
```
6969
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
@@ -77,17 +77,17 @@ b8c2cd770187 moosefsdockercluster_mfschunkserver2 "chunkserver.sh"
7777
e83a1fb062a1 moosefsdockercluster_mfsmaster "master.sh" 7 minutes ago Up 7 minutes 9419-9421/tcp mfsmaster
7878
```
7979

80-
# Attach/detach to/from container
80+
# Attach / detach to / from container
8181

8282
For example, if you like to **attach** to the client node execute this command:
8383

8484
```
8585
docker exec -it mfsclient bash
8686
```
8787

88-
To **detach** from container just press `Ctrl + d` keys.
88+
To **detach** from container, just press `Ctrl + D` keys combination.
8989

90-
# MooseFS client
90+
# MooseFS Client
9191

9292
MooseFS filesystem is mounted at `/mnt/moosefs`. If everything is ok you should see this ASCII art:
9393

@@ -104,16 +104,17 @@ cat /mnt/moosefs/.mooseart
104104
"" ""
105105
```
106106

107-
# CGI
107+
# MooseFS CGI Monitoring Interface
108108

109-
The CGI is available here: [http://localhost:9425](http://localhost:9425)
110-
Also on Linux OS CGI container is available at IP address [http://172.20.0.3:9425](http://172.20.0.3:9425) (be aware of a local 172.20.0.* network).
109+
The MooseFS CGI Monitoring Interface is available here: [http://localhost:9425](http://localhost:9425).
110+
111+
Also on Linux, CGI Server container is available at the IP address: [http://172.20.0.3:9425](http://172.20.0.3:9425) (be aware of a local `172.20.0.x` network).
111112

112113
![MooseFS CGI](https://github.com/moosefs/moosefs-docker-cluster/raw/master/images/cgi.png)
113114

114115
# Persistence
115116

116-
Your MooseFS Docker cluster is persistent. It means all files you created in the /mnt/moosefs folder will remain there even after turning containers off.
117+
Your MooseFS Docker cluster is persistent. It means all files you created in the `/mnt/moosefs` folder will remain there even after turning containers off.
117118
All data and metadata files are stored in the host `./data` directory.
118119
# Docker Hub
119120

@@ -123,8 +124,4 @@ All data and metadata files are stored in the host `./data` directory.
123124
| [moosefs/chunkserver](https://hub.docker.com/r/moosefs/chunkserver/) | ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/moosefs/chunkserver?sort=date) | [![chunkserver](https://img.shields.io/docker/pulls/moosefs/chunkserver)](https://hub.docker.com/r/moosefs/chunkserver/) | ![chunkserver](https://img.shields.io/docker/stars/moosefs/chunkserver) | ![chunkserver](https://img.shields.io/docker/build/moosefs/chunkserver) |
124125
| [moosefs/client](https://hub.docker.com/r/moosefs/client/) | ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/moosefs/client?sort=date) | [![client](https://img.shields.io/docker/pulls/moosefs/client)](https://hub.docker.com/r/moosefs/client/) | ![client](https://img.shields.io/docker/stars/moosefs/client) | ![client](https://img.shields.io/docker/build/moosefs/client) |
125126
| [moosefs/metalogger](https://hub.docker.com/r/moosefs/metalogger/) | ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/moosefs/metalogger?sort=date) | [![metalogger](https://img.shields.io/docker/pulls/moosefs/metalogger)](https://hub.docker.com/r/moosefs/cgi/) | ![metalogger](https://img.shields.io/docker/stars/moosefs/metalogger) | ![metalogger](https://img.shields.io/docker/build/moosefs/metalogger) |
126-
| [moosefs/cgi](https://hub.docker.com/r/moosefs/cgi/) | ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/moosefs/cgi?sort=date) | [![cgi](https://img.shields.io/docker/pulls/moosefs/cgi)](https://hub.docker.com/r/moosefs/cgi/) | ![cgi](https://img.shields.io/docker/stars/moosefs/cgi) | ![cgi](https://img.shields.io/docker/build/moosefs/cgi) |
127-
128-
129-
130-
Scripts are based on [Kai Sasaki's *Lewuathe/docker-hadoop-cluster*](https://github.com/Lewuathe/docker-hadoop-cluster). Thank you, Kai!
127+
| [moosefs/cgi](https://hub.docker.com/r/moosefs/cgi/) | ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/moosefs/cgi?sort=date) | [![cgi](https://img.shields.io/docker/pulls/moosefs/cgi)](https://hub.docker.com/r/moosefs/cgi/) | ![cgi](https://img.shields.io/docker/stars/moosefs/cgi) | ![cgi](https://img.shields.io/docker/build/moosefs/cgi) |

0 commit comments

Comments
 (0)