Commit 1fb8f0b7 authored by Simon Redman's avatar Simon Redman

Add documentation about orchestrator.py

parent 86cfd485
...@@ -17,6 +17,11 @@ These instructions will be updated as the code is actually written ...@@ -17,6 +17,11 @@ These instructions will be updated as the code is actually written
Before you will be able to run any commands, activate the virtual environment by running `source env/bin/activate` Before you will be able to run any commands, activate the virtual environment by running `source env/bin/activate`
`orchestrator.py` automatically does everything required, and can be run directly on an Emulab node to parse
the on-node net information or can be fed a NetJSON NetGraph to configure. Please refer to `orchestrator --help`
## Library Documentation
#### 1. topomap_parser.py #### 1. topomap_parser.py
This is both a program which can be run on its own, mostly for testing purposes, and a library which is used by the following programs to parse emulab's topology into [NetJSON](netjson.org) NetworkGraph for usage with the NetworkX network graph library. This is both a program which can be run on its own, mostly for testing purposes, and a library which is used by the following programs to parse emulab's topology into [NetJSON](netjson.org) NetworkGraph for usage with the NetworkX network graph library.
...@@ -71,7 +76,6 @@ The basic goal is to take all the scripts from <https://gitlab.flux.utah.edu/saf ...@@ -71,7 +76,6 @@ The basic goal is to take all the scripts from <https://gitlab.flux.utah.edu/saf
1. Replace `install_default_route_on_hosts.sh` 1. Replace `install_default_route_on_hosts.sh`
2. Replace `start_all_ovs.sh` 2. Replace `start_all_ovs.sh`
3. Replace `start_all_ospf_monitor.sh` 3. Replace `start_all_ospf_monitor.sh`
4. Write top-level script which runs all previous scripts in an easy-to-use way
## NetworkGraph ## NetworkGraph
For the most part, standard NetJSON NetworkGraph fields are used, and those are documented [here](http://netjson.org/rfc.html#rfc.section.4) For the most part, standard NetJSON NetworkGraph fields are used, and those are documented [here](http://netjson.org/rfc.html#rfc.section.4)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment