diff options
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..7bbea39 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,57 @@ +==================================== +Welcome to the Rumba documentation! +==================================== + +Rumba is a Python framework that allows users to write Python scripts +to define recursive internet networks and run scripted +experiments. First, Rumba creates a physical network on one of the +selected testbed plugins. If needed, Rumba can do an installation of +the selected prototype plugin on the testbed machines. The network is +then bootstrapped on the available nodes. Users can then run a +Storyboard which emulates real network traffic. Finally, the +experiment can be swapped out of the testbed. + +This site covers Rumba's usage and API documentation. The repository +holding the code can be found `here +<https://gitlab.com/arcfire/rumba>`_. Example scripts can be found in +the examples/ folder. + +Please report any bugs or issues `here +<https://gitlab.com/arcfire/rumba/issues>`_. + +Rumba is developed as part of the ARCFIRE project, funded by the +European commission under the H2020 framework. + +General usage +------------------------- + +.. toctree:: + workflow + installation + +Rumba core +------------------------- + +.. toctree:: + model + log + storyboard + utils + +Testbed plugins +------------------------- + +.. toctree:: + docker + emulab + jfed + local + qemu + +Prototype plugins +------------------------- + +.. toctree:: + irati + rlite + ouroboros |