9ad39c026c
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
89 lines
1.9 KiB
ReStructuredText
89 lines
1.9 KiB
ReStructuredText
.. _ubuntu:
|
|
|
|
.. toctree::
|
|
|
|
Ubuntu - Setup the FD.io Repository
|
|
===================================
|
|
|
|
Choose one of the following releases to install.
|
|
|
|
Update the OS
|
|
-----------------------
|
|
|
|
It is a good idea to first update and upgrade the OS before starting; run the
|
|
following command to update the OS:
|
|
|
|
.. code-block:: console
|
|
|
|
apt-get update
|
|
|
|
|
|
Point to the Repository
|
|
-----------------------------------
|
|
|
|
Create a file **/etc/apt/sources.list.d/99fd.io.list** with contents that point to
|
|
the version needed. The contents needed are shown below.
|
|
|
|
.. _install_vpp:
|
|
|
|
VPP latest Release
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
|
|
|
|
.. code-block:: console
|
|
|
|
deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu bionic main
|
|
|
|
Get the key:
|
|
|
|
.. code-block:: console
|
|
|
|
curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
|
|
|
|
VPP master Branch
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
|
|
|
|
.. code-block:: console
|
|
|
|
deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu bionic main
|
|
|
|
Get the key:
|
|
|
|
.. code-block:: console
|
|
|
|
curl -L https://packagecloud.io/fdio/master/gpgkey | sudo apt-key add -
|
|
|
|
|
|
Install the Mandatory Packages
|
|
===============================
|
|
|
|
Install the mandatory packages by running the following commands:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo apt-get update
|
|
sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
|
|
|
|
|
|
Install the Optional Packages
|
|
==============================
|
|
|
|
Install the optional packages by running the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo apt-get install vpp-api-python python3-vpp-api vpp-dbg vpp-dev
|
|
|
|
|
|
Uninstall the Packages
|
|
======================
|
|
|
|
Uninstall the packages by running the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
sudo apt-get remove --purge "vpp*"
|