Skip to content

Commit c3e11ba

Browse files
committed
Update readme
1 parent b0e1ffd commit c3e11ba

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,27 @@
22

33
Docker image with redis built and installed from source.
44

5+
The main usage for this container is to test redis cluster code. For example in https://github.com/Grokzen/redis-py-cluster repo.
6+
57
The cluster is 6 redis instances running with 3 master & 3 slaves, one slave for each master. They run on ports 7000 to 7005.
68

79
It also contains 2 standalone instances that is not part of the cluster. They are running on port 7006 & 7007
810

911
It will allways build the latest commit in the 3.0 branch `https://github.com/antirez/redis/tree/3.0`
1012

11-
12-
13-
# Setup Docker
14-
15-
How to setup docker and start the cluster image.
16-
17-
Install `docker` on your system. 1.0 or higher is recommended. Instructions can be found at http://docs.docker.com/en/latest/installation/. It is also reccomended to add the current user to `docker` system group to remove the need to add sudo to each docker call.
13+
This image requires `Docker` above version 1.0
1814

1915

2016

2117
# Usage
2218

2319
If you want to use `docker-compose (fig)` please read next section.
2420

25-
Download the latest build from docker hub with `docker pull grokzen/redis-cluster`
21+
Either download the latest build from docker hub with `docker pull grokzen/redis-cluster`
2622

27-
To build the image run either `make build` or `make rebuild`. It will be built to the image name `grokzen/redis-cluster`.
23+
Or to build the image, use either `make build` or `make rebuild`. It will be built to the image name `grokzen/redis-cluster`.
2824

29-
To start the image run `make run`. It will be started in the background. To gain access to the running image you can get a bash session by running `make bash`.
25+
To start the image use `make run`. It will be started in the background. To gain access to the running image you can get a bash session by running `make bash`.
3026

3127
Test to connect to the cluster with `redis-cli -p 7000`. If you do not want to install a redis server on your host to get access to `redis-cli` you can run a `exec` command to run it inside the docker container. It can be done with `docker exec -it <ContainerID> /redis/src/redis-cli -p 7000` where `<ContainerID>` can be found inside the CID file at `/tmp/grokzen-redis-cluster.cid` or via `docker ps`.
3228

0 commit comments

Comments
 (0)