Skip to content

Commit 93faa31

Browse files
committed
Hints for installing on Ubuntu 18.04
1 parent 9e11927 commit 93faa31

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

docs/userguide.rst

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Installation
2929

3030
.. REQUIREMENTS {{{3
3131
32-
Requirements
32+
Requirements: Installing Mininet
3333
------------
3434

3535
You need to start MiniCPS installation by `installing
@@ -39,26 +39,40 @@ Notice that Mininet can be installed either inside a Virtual Machine (VM)
3939
or on your physical machine.
4040
The official Mininet VM comes without an X-server that is an *optional*
4141
requirements for MiniCPS (e.g., it can be used to display a pop-up window
42-
with sensor data visualization).
42+
with sensor data visualization). If you decide to install Mininet on your own, the following hints can be helpful.
4343

44-
The `Install MiniCPS`_ section provides instructions to install ``minicps``
45-
for a user or a developer, and it assumes that you *already* have installed
46-
``mininet``.
44+
Mininet relies on openvswitch-controller as basic SDN controller (unless you install POX or other controllers yourself). Since Open vSwitch 2.1, the openvswitch-controller was renamed to openvswitch-testcontroller. This means you will have to a) ensure that you have the corresponding package installed, e.g. via (on Ubuntu 16.04 or later)
45+
46+
.. code-block:: console
4747
48-
.. UPGRADE TO UBUNTU-16.04 {{{3
48+
sudo apt install openvswitch-testcontroller
4949
50-
Upgrade to Ubuntu-16.04
51-
-----------------------
50+
Then, you need to patch the minicps source (e.g., /usr/lib/python2.7/dist-packages/mininet/clean.py and /usr/lib/python2.7/dist-packages/mininet/node.py) to use the updated binary name (change occurances of openvswitch-controller to openvswitch-testcontroller).
5251

53-
Some MiniCPS libraries like cryptography now require Ubuntu16.04. To upgrade do:
5452
.. code-block:: console
55-
sudo apt-get update
56-
sudo apt-get dist-upgrade
57-
sudo do-release-upgrade
53+
54+
find /usr/lib/python2.7/dist-packages/mininet/ -type f -exec sudo sed -i 's/ovs-controller/ovs-testcontroller/' {} \;
55+
56+
Ensure the corresponding service is running, e.g., by using
57+
58+
.. code-block:: console
59+
60+
sudo service openvswitch-switch start
61+
62+
You should now be able to start a simple topology without error messages by using
63+
64+
.. code-block:: console
65+
66+
sudo mn
67+
68+
69+
The `Installing MiniCPS`_ section provides instructions to install ``minicps``
70+
for a user or a developer, and it assumes that you *already* have installed
71+
``mininet``.
5872

5973
.. INSTALL MINICPS {{{3
6074
61-
Install MiniCPS
75+
Installing MiniCPS
6276
---------------
6377

6478
MiniCPS is can be installed using ``pip``:

0 commit comments

Comments
 (0)