Skip to content

Commit

Permalink
Add note about scenarios
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrw committed Aug 3, 2023
1 parent 969b18c commit 4f1dff5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@ open output.png
1. Install `dot` (graphviz)
2. `pip install -e .`

### Scenarios

This repository contains scenarios that help explore how this tool works.
Under the `scenarios` subdirectory, there are a number of samples, each that set up docker containers.
Each sample contains the following scripts:

* `setup.sh`: set up the scenario
* `test.sh`: demonstrate the connectivity issue
* `teardown.sh`: remove resources created by the `setup.sh` script


## Security

We mount the docker socket because we have to be able to run docker commands.
Expand Down

0 comments on commit 4f1dff5

Please sign in to comment.