Skip to content

Commit 8a5422f

Browse files
committed
feat(readme): add local mrt library and webapp documentation
1 parent 677879f commit 8a5422f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,28 @@ process zettabgp {
3636
}
3737
```
3838

39+
### Local MRT Library
40+
For the WebApp you can provide a local MRT Library.\
41+
This library contains several MRT Scenarios which define a predefined scenario for simulating MRT files with specific configurations.\
42+
This library is managed via `scenario.json` files in the `mrt_library` directory.\
43+
The syntax for the `scenario.json` files is the following.
44+
```json
45+
{
46+
"name": "Test Scenario 1",
47+
"description": "This is a test scenario.",
48+
"no_rabbitmq_direct": false,
49+
"rabbitmq_grouped": 5,
50+
"no_mongodb_log": true,
51+
"no_mongodb_state": true,
52+
"no_mongodb_statistics": true,
53+
"clear_mongodb": false,
54+
"playback_speed": null,
55+
"mrt_files": [
56+
"20241005_0130_1728091800_bgp_lw_ixp_decix_update.bz2"
57+
]
58+
}
59+
```
60+
3961
### Database and Message Queue
4062
A sample setup for MongoDB and RabbitMQ is provided in the `db` directory.\
4163
To run the docker compose setup run the following command in that directory.\
@@ -139,6 +161,12 @@ zettabgp mrt-simulation <mrt-file> -o 10
139161
```
140162
Please keep in mind that most of the mrt files only contain a timeslot of 15 minutes.
141163

164+
#### `zettabgp webapp`
165+
This command launches the debugging WebApp with MRT Library, Anomaly Explorer and the RabbitMQ interface.\
166+
The WebApp will be exposed on port `8000` by default.\
167+
You can access the ui using this link: http://127.0.0.1:8000/\
168+
For the management of the MRT Library refer to this section above. [Local MRT Library](#local-mrt-library)
169+
142170
## Debugging
143171
Some sample json messages for debugging purposes from ExaBGP can be found in the `samples` directory.
144172

0 commit comments

Comments
 (0)