Skip to content

Commit a69c015

Browse files
authored
Merge pull request #3 from Intellection/update_readme
[SRE-2199] Update README with Redis Sentinel details
2 parents b858923 + eea81ac commit a69c015

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
# RedisGraph
1+
# Docker Redis Graph
22

3-
RedisGraph is the first queryable [Property Graph](https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc) database to use [sparse matrices](https://en.wikipedia.org/wiki/Sparse_matrix) to represent the [adjacency matrix](https://en.wikipedia.org/wiki/Adjacency_matrix) in graphs and [linear algebra](http://faculty.cse.tamu.edu/davis/GraphBLAS.html) to query the graph.
3+
## Introduction
44

5-
Primary features:
6-
7-
* Adopting the [Property Graph Model](https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc)
8-
* Nodes (vertices) and Relationships (edges) that may have attributes
9-
* Nodes that can be labeled
10-
* Relationships have a relationship type
11-
* Graphs represented as sparse adjacency matrices
12-
* [Cypher](http://www.opencypher.org/) as query language
13-
* Cypher queries translated into linear algebra expressions
14-
15-
To see RedisGraph in action, visit [Demos](https://github.com/RedisGraph/RedisGraph/tree/master/demo).
5+
RedisGraph is the first queryable [Property Graph](https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc) database to use [sparse matrices](https://en.wikipedia.org/wiki/Sparse_matrix) to represent the [adjacency matrix](https://en.wikipedia.org/wiki/Adjacency_matrix) in graphs and [linear algebra](http://faculty.cse.tamu.edu/davis/GraphBLAS.html) to query the graph. To see RedisGraph in action, visit [Demos](https://github.com/RedisGraph/RedisGraph/tree/master/demo).
166
To read the docs, visit [redisgraph.io](http://redisgraph.io).
177

18-
See upstream project at [github.com/RedisGraph/RedisGraph](https://github.com/RedisGraph/RedisGraph) for more details.
8+
## Features
199

20-
## Docker
10+
* Based off latest version of Redis Graph.
11+
* Included bash scripts to run Redis Sentinel easily in Kubernetes.
2112

22-
To run the service in Docker use:
13+
## Usage
14+
15+
To run a simple setup of a single Redis Graph container in Docker use:
2316

2417
```bash
2518
docker run -p 6379:6379 zappi/redis-graph:<tag>
2619
```
20+
21+
And to run a more complex setup using Redis Sentinel in Kubernetes use the
22+
reference [example manifests here][1]. Replace `zappi/redis:<tag>` with
23+
`zappi/redis-graph:<tag>` and run:
24+
25+
```bash
26+
kubectl apply -f examples/kubernetes/
27+
```
28+
29+
[1]: https://github.com/Intellection/docker-redis/tree/main/examples/kubernetes

0 commit comments

Comments
 (0)