code/network-topology-parser/README.md

   1 # Network Topology Parser
   2
   3 This golang project generates a docker-compose.yaml file to be used for simulating the network topology, by parsing the topology JSON file created by the [Network Topology Instance Generator](../network-topology-instance-generator/README.md) tool.
   4
   5 ## Prerequisites
   6
   7 The GO runtime should be installed on the machine. Instructions [here](https://go.dev/doc/install).
   8
   9 ## Usage
  10
  11 These commands should be run from the folder where this README is located.
  12
  13 ``` bash
  14 go build
  15 ```
  16
  17 This creates the executable *topology-parser*.
  18
  19 ``` bash
  20 ./topology-parser <network-topology.json>
  21 ```
  22
  23 ## Output
  24
  25 The result of running this tool is a **docker-compose.yaml** file that can be then used in the *solution/integration/network* folder, **along with the .env file defined there**, for starting a simulated topology as described in the network-topology.json input file.