Skip to content

Commit

Permalink
updated install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edgar-costa committed Oct 4, 2023
1 parent e9122db commit 9791ba9
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions docsrc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Virtual Machine

P4-Utils can run in a virtual machine to keep its environment separated from the rest of the system.
Moreover, since P4-Utils is only available on Linux, other OS users can run it in a linux VM.
We provide two different solutions for the P4-Utils VM and both are supported by a wide range of
We provide two different solutions for the P4-Utils VM and both are supported by a wide range of
operating systems:

- VirtualBox_
Expand Down Expand Up @@ -100,9 +100,13 @@ To download our preconfiugred VMs, please click on the folllwing links:

`VirtualBox VM (unavailable)`__

- __ https://polybox.ethz.ch/index.php/s/QlrfHm7uYw6vISe

`QEMU VM (Ubuntu 20/compressed)`__

- __ https://polybox.ethz.ch/index.php/s/9orcmetpNxOAhlI

`QEMU VM`__
`QEMU VM (old ubuntu 18 vm)`__

Manual Installation
-------------------
Expand All @@ -127,13 +131,13 @@ P4-Utils depends on the following programs in the given order:

1. __ https://github.com/p4lang/PI

`PI LIBRARY REPOSITORY`__ provides an implementation framework
`PI LIBRARY REPOSITORY`__ provides an implementation framework
for a P4Runtime server. **It is required only for topologies with
P4Runtime switches.**
2. __ https://github.com/p4lang/behavioral-model

`BEHAVIORAL MODEL (bmv2)`__ contains the software implementation several
variations of the behavioral model (e.g. ``simple_switch`` and
variations of the behavioral model (e.g. ``simple_switch`` and
``simple_switch_grpc``).
3. __ https://github.com/p4lang/p4c

Expand All @@ -145,10 +149,10 @@ P4-Utils depends on the following programs in the given order:
kernel, switch and application code, on a single machine (VM, cloud or native).
5. __ https://github.com/FRRouting/FRR

`FRRouting`__ is a free and open source Internet routing protocol suite
for Linux and Unix platforms. It implements BGP, OSPF, RIP, IS-IS, PIM,
LDP, BFD, Babel, PBR, OpenFabric and VRRP, with alpha support for EIGRP
and NHRP. Router nodes in P4-Utils are based on FRRouting. **It is required
`FRRouting`__ is a free and open source Internet routing protocol suite
for Linux and Unix platforms. It implements BGP, OSPF, RIP, IS-IS, PIM,
LDP, BFD, Babel, PBR, OpenFabric and VRRP, with alpha support for EIGRP
and NHRP. Router nodes in P4-Utils are based on FRRouting. **It is required
only for topologies with routers.**

__ https://github.com/nsg-ethz/p4-utils/blob/master/install-tools/install-p4-dev.sh
Expand All @@ -158,18 +162,18 @@ dependencies that are needed by P4-Utils. For this reason, we provide a `Bash
script`__ that automatically goes through every step.

.. Warning::
The script has been tested with **Ubuntu 18.04.4** and the compiler
**GCC 7.5**. Errors have been reported with newer versions.
The script has been tested with **Ubuntu 20.04 and Ubuntu 22.04** and the compiler
**GCC 9.4**.

.. Important::
With the following installation methods, you will download and install *Mininet*
and the P4-Tools suite (P4-Utils, P4-Learning and their dependencies) in your
and the P4-Tools suite (P4-Utils, P4-Learning and their dependencies) in your
user's home directory.

One-Step Automated Install
__________________________

To get started quickly and conveniently, you may want to install the P4-Tools suite
To get started quickly and conveniently, you may want to install the P4-Tools suite
using the following command::

curl -sSL https://raw.githubusercontent.com/nsg-ethz/p4-utils/master/install-tools/install-p4-dev.sh | bash
Expand Down

0 comments on commit 9791ba9

Please sign in to comment.