diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/irati.rst | 11 | ||||
| -rw-r--r-- | doc/model.rst | 16 | ||||
| -rw-r--r-- | doc/prototype.rst | 2 | ||||
| -rw-r--r-- | doc/qemu.rst | 15 | ||||
| -rw-r--r-- | doc/rlite.rst | 11 | ||||
| -rw-r--r-- | doc/testbed.rst | 1 | ||||
| -rw-r--r-- | doc/workflow.rst | 6 |
7 files changed, 15 insertions, 47 deletions
diff --git a/doc/irati.rst b/doc/irati.rst deleted file mode 100644 index 0ad496a..0000000 --- a/doc/irati.rst +++ /dev/null @@ -1,11 +0,0 @@ -IRATI -============= - -`IRATI <https://github.com/IRATI/stack>`_ is an open source -implementation of the RINA architecture targeted at the OS/Linux -system, initially developed by the FP7-IRATI project. - -.. automodule:: rumba.prototypes.irati - :member-order: bysource - :show-inheritance: - :inherited-members: diff --git a/doc/model.rst b/doc/model.rst index 1ced817..454de7e 100644 --- a/doc/model.rst +++ b/doc/model.rst @@ -6,13 +6,21 @@ blocks listed below. .. autoclass:: rumba.model.Node -.. autoclass:: rumba.model.DIF +.. autoclass:: rumba.model.Layer -.. autoclass:: rumba.model.NormalDIF +.. autoclass:: rumba.model.UnicastLayer -.. autoclass:: rumba.model.ShimUDPDIF +.. autoclass:: rumba.model.BroadcastLayer -.. autoclass:: rumba.model.ShimEthDIF +.. autoclass:: rumba.model.EthDixLayer + +.. autoclass:: rumba.model.EthLlcLayer + +.. autoclass:: rumba.model.Udp4Layer + +.. autoclass:: rumba.model.Udp6Layer + +.. autoclass:: rumba.model.LocalLayer .. autoclass:: rumba.model.Distribution diff --git a/doc/prototype.rst b/doc/prototype.rst index a827dcb..0a17719 100644 --- a/doc/prototype.rst +++ b/doc/prototype.rst @@ -10,6 +10,4 @@ provided by the base class. Specific implementations of the Testbed class: .. toctree:: - irati - rlite ouroboros diff --git a/doc/qemu.rst b/doc/qemu.rst deleted file mode 100644 index 375ab55..0000000 --- a/doc/qemu.rst +++ /dev/null @@ -1,15 +0,0 @@ -QEMU -============= - -`QEMU <http://wiki.qemu-project.org/Main_Page>`_ is a generic and open -source machine emulator and virtualizer. - -In order to use the qemu testbed, the user should install the qemu and -bridge-utils packages on which the testbed depends: :: - - $ sudo apt-get install bridge-utils qemu - -.. automodule:: rumba.testbeds.qemu - :member-order: bysource - :show-inheritance: - :inherited-members: diff --git a/doc/rlite.rst b/doc/rlite.rst deleted file mode 100644 index 171c4b8..0000000 --- a/doc/rlite.rst +++ /dev/null @@ -1,11 +0,0 @@ -rlite -============= - -`rlite <https://gitlab.com/arcfire/rlite>`_ is a lightweight Free -and Open Source implementation of the Recursive InterNetwork -Architecture (RINA) for GNU/Linux operating systems. - -.. automodule:: rumba.prototypes.rlite - :member-order: bysource - :show-inheritance: - :inherited-members: diff --git a/doc/testbed.rst b/doc/testbed.rst index 0158904..45ac2c8 100644 --- a/doc/testbed.rst +++ b/doc/testbed.rst @@ -14,4 +14,3 @@ Specific implementations of the Testbed class: emulab jfed local - qemu diff --git a/doc/workflow.rst b/doc/workflow.rst index d0e56a7..1c35b91 100644 --- a/doc/workflow.rst +++ b/doc/workflow.rst @@ -2,14 +2,14 @@ Workflow ************************ 1. Define the network graph, creating instances of model.Node and - model.DIF classes. Experiments can import rumba.model to obtain all + model.Layer classes. Experiments can import rumba.model to obtain all Rumba classes needed to run an experiment. -2. Create an instance of a specific model.Testbed class (QEMU, Docker, +2. Create an instance of a specific model.Testbed class (Docker, Local, Emulab or jFed). 3. Create an instance of the selected prototype.Experiment class - (Ouroboros, rlite, IRATI), passing the testbed instance and a list + (Ouroboros), passing the testbed instance and a list of Node instances. * At the end of the base Experiment constructor, the |