From 4f1dff5dd1e48d91d463f6a6845351c518f402f8 Mon Sep 17 00:00:00 2001 From: Simon Walker Date: Thu, 3 Aug 2023 12:08:20 +0100 Subject: [PATCH] Add note about scenarios --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 856fc55..8c7587d 100644 --- a/README.md +++ b/README.md @@ -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.