Skip to content

Commit 913d682

Browse files
committed
Updated README with visuals
1 parent ce2c0aa commit 913d682

File tree

3 files changed

+4
-57
lines changed

3 files changed

+4
-57
lines changed

Readme.md

+4-57
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
![SPEC logo](./spec-logo.png)
2+
13

24
[![codecov](https://codecov.io/gh/redis/redis-benchmarks-specification/branch/main/graph/badge.svg?token=GS64MV1H4W)](https://codecov.io/gh/redis/redis-benchmarks-specification)
35
[![CI tests](https://github.com/redis/redis-benchmarks-specification/actions/workflows/tox.yml/badge.svg)](https://github.com/redis/redis-benchmarks-specification/actions/workflows/tox.yml)
46
[![PyPI version](https://badge.fury.io/py/redis-benchmarks-specification.svg)](https://pypi.org/project/redis-benchmarks-specification)
57

8+
69
## Installation
710

811
To have access to the latest SPEC and Tooling impletamtion you only need to install one python package.
@@ -58,63 +61,7 @@ python3 -m pip install redis-benchmarks-specification
5861

5962
## Architecture diagram
6063

61-
```
62-
63-
64-
┌──────────────────────────────────────┐
65-
│1) gh.com/redis/redis update │
66-
│ - git_repo: github.com/redis/redis │
67-
│ - git_hash: 459c3a │
68-
│ - git_branch: unstable │
69-
└─────────────────┬────────────────────┘
70-
71-
│ ┌───────────────────────────────────┐
72-
│ │HTTP POST │
73-
└──────┤<domain>/api/gh/redis/redis/commit │──┐
74-
└───────────────────────────────────┘ │
75-
76-
77-
┌──────────────────────────────────────────┐
78-
│2) api │
79-
│ - Converts the HTTP info into an stream │
80-
│entry │
81-
│ - XADD stream:redis:redis:commit <...> │
82-
│ │
83-
└─────────────────────┬────────────────────┘
84-
85-
86-
87-
│ ┌────┐
88-
.─────────────────────────────────────. │ │push│
89-
┌─────┐ ┌ ▶( 2.1 ) stream of build events )◀───┘ └────┘
90-
│pull │ `─────────────────────────────────────'
91-
└─────┘ │
92-
93-
│ ┌────────────────────────────────────────────┐
94-
─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│2.2) build_agent │
95-
│ - based on setup platforms │
96-
│ - build different required redis │
97-
│artifacts │
98-
└───────────────────────┬────────────────────┘
99-
100-
101-
│ ┌────┐
102-
.─────────────────────────────────────. │ │push│
103-
┌─────┐ ─▶( 2.3 ) stream of artifact benchmarks )◀────┘ └────┘
104-
│pull ││ `─────────────────────────────────────'
105-
└─────┘
106-
107-
┌────────────────────────────────────────────┐
108-
│ │ │
109-
│3) benchmark_coordinator │
110-
│ │ - based on test-suites and setups: │
111-
│ - Trigger env setup │
112-
└ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─│ - 3.1 ) Trigger topology setup │
113-
│ - 3.2 ) Run benchmarks │
114-
│ - Record results into datasinks │
115-
│ │
116-
└────────────────────────────────────────────┘
117-
```
64+
![Architecture diagram](./arch-diagram.png)
11865

11966
In a very brief description, github.com/redis/redis upstream changes trigger an HTTP API call containing the
12067
relevant git information.

arch-diagram.png

333 KB
Loading

spec-logo.png

344 KB
Loading

0 commit comments

Comments
 (0)