replica
/
firesim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

basic topology specification docs

This commit is contained in:
Sagar Karandikar 2018-05-20 19:40:25 +00:00
parent 1004476c71
commit 739473864f
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/Advanced-Usage/Manager/Manager-Topology-Definitions.rst
View File

@ -1,4 +1,22 @@
Manager Network Topology Definitions (``user_topology.py``)
==================================================================
TODO
Custom network topologies are specified as Python snippets that construct a
tree. You can see examples of these in ``firesim/deploy/runtools/user_topology.py``,
shown below. Better documentation of this API will be available once it stabilizes.
Fundamentally, you create a list of roots, which consists of switch or server
nodes, then construct a tree by adding downlinks to these roots. Since links
are bi-directional, adding a downlink from node A to node B implicitly adds
an uplink from B to A.
You can add additional topology generation methods here, then use them in
``config_runtime.ini``.
``user_topology.py`` contents:
--------------------------------
.. include:: /../deploy/runtools/user_topology.py
:code: python