Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / 384c72f630b7e8623a5122991d7c6abe6e870b38 / . / docs / gettingstarted / installing / ubuntu.rst
blob: 2521b6d279086240cb843a67dbacf5bb9831263e [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]1.. _ubuntu:
2
3.. toctree::
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]4
Paul Vinciguerraac9a5852020-04-02 23:50:25 -0400[diff] [blame]5Ubuntu - Setup the FD.io Repository
6===================================
7
8Choose one of the following releases to install.
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]9
10Update the OS
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]11-----------------------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]12
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]13It is a good idea to first update and upgrade the OS before starting; run the
14following command to update the OS:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]15
16.. code-block:: console
17
18 apt-get update
19
20
21Point to the Repository
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]22-----------------------------------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]23
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]24Create a file **/etc/apt/sources.list.d/99fd.io.list** with contents that point to
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]25the version needed. The contents needed are shown below.
26
27.. _install_vpp:
28
29VPP latest Release
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]30^^^^^^^^^^^^^^^^^^^
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]31
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]32Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]33
34.. code-block:: console
35
jdenisco0da895d2019-05-01 16:30:36 -0400[diff] [blame]36 deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu bionic main
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]37
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]38Get the key:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]39
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]40.. code-block:: console
41
42 curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
43
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]44VPP master Branch
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]45^^^^^^^^^^^^^^^^^^^^
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]46
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]47Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]48
49.. code-block:: console
50
jdenisco0da895d2019-05-01 16:30:36 -0400[diff] [blame]51 deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu bionic main
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]52
53Get the key:
54
55.. code-block:: console
56
57 curl -L https://packagecloud.io/fdio/master/gpgkey | sudo apt-key add -
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]58
59
60Install the Mandatory Packages
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]61===============================
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]62
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]63Install the mandatory packages by running the following commands:
64
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]65.. code-block:: console
66
67 sudo apt-get update
jdenisco0da895d2019-05-01 16:30:36 -0400[diff] [blame]68 sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]69
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]70
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]71Install the Optional Packages
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]72==============================
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]73
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]74Install the optional packages by running the following command:
75
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]76.. code-block:: console
77
jdenisco0da895d2019-05-01 16:30:36 -0400[diff] [blame]78 sudo apt-get install vpp-api-python python3-vpp-api vpp-dbg vpp-dev
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]79
80
81Uninstall the Packages
82======================
83
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]84Uninstall the packages by running the following command:
85
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]86.. code-block:: console
87
Paul Vinciguerraac9a5852020-04-02 23:50:25 -0400[diff] [blame]88 sudo apt-get remove --purge "vpp*"