Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / a2aefef1fd3fc423430531d7e965c9da7d9ec0d5 / . / docs / gettingstarted / installing / ubuntu.rst
blob: c8a98939e627d5cdf85f189a4a2510b4f49f76fa [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]1.. _ubuntu:
2
3.. toctree::
4
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]5Ubuntu 18.04 - Setup the FD.io Repository
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]6==========================================
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]7
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]8FD.io VPP is installed using Package Cloud. For a complete set of
9instructuctions on how to install VPP with package cloud please refer
10to `Package Cloud <https://packagecloud.io/fdio/release>`_
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]11
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]12Choose one of the following releases to install.
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]13
14Update the OS
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]15-----------------------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]16
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]17It is a good idea to first update and upgrade the OS before starting; run the
18following command to update the OS:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]19
20.. code-block:: console
21
22 apt-get update
23
24
25Point to the Repository
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]26-----------------------------------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]27
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]28Create 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]29the version needed. The contents needed are shown below.
30
31.. _install_vpp:
32
33VPP latest Release
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]34^^^^^^^^^^^^^^^^^^^
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]35
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]36Create 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]37
38.. code-block:: console
39
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]40 deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu xenial main
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]41
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]42Get the key:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]43
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]44.. code-block:: console
45
46 curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
47
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]48VPP master Branch
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]49^^^^^^^^^^^^^^^^^^^^
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]50
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]51Create 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]52
53.. code-block:: console
54
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]55 deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu xenial main
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]56
57Get the key:
58
59.. code-block:: console
60
61 curl -L https://packagecloud.io/fdio/master/gpgkey | sudo apt-key add -
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]62
63
64Install the Mandatory Packages
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]65===============================
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]66
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]67Install the mandatory packages by running the following commands:
68
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]69.. code-block:: console
70
71 sudo apt-get update
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]72 sudo apt-get install vpp
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]73
jdenisco569a2782018-11-09 15:20:26 -0500[diff] [blame]74
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]75Install the Optional Packages
John DeNiscoc64ba6d2018-08-02 15:03:15 -0400[diff] [blame]76==============================
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]77
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]78Install the optional packages by running the following command:
79
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]80For the release packages:
81
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]82.. code-block:: console
83
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]84 sudo apt-get install vpp-plugins vpp-api-java vpp-api-lua vpp-api-python vpp-dbg vpp-dev
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]85
jdenisco2cefb062019-02-19 16:25:05 -0500[diff] [blame]86For the master packages:
87
88.. code-block:: console
89
90 sudo apt-get install vpp-plugin-core vpp-ext-deps vpp-api-python vpp-dbg vpp-dev vpp-plugin-dpdk
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]91
92Uninstall the Packages
93======================
94
John DeNiscoce96dda2018-08-14 16:04:09 -0400[diff] [blame]95Uninstall the packages by running the following command:
96
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]97.. code-block:: console
98
99 sudo apt-get remove --purge vpp*