ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: enhance install vpp docs

Browse Source 
Type: docs

Change-Id: Ic1439ce658d9d53208b29d85440a6cc225ed5b74
Signed-off-by: fatelei <fatelei@gmail.com>
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
This commit is contained in:
fatelei
2022-06-08 12:28:23 +08:00
committed by Dave Wallace
parent c119e796f5
commit 320272a7eb
3 changed files with 51 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/gettingstarted/installing/index.rst
View File

@ -10,16 +10,16 @@ Downloading and Installing VPP
If you want to use VPP it can be convenient to install the binaries from
existing packages. This guide describes how to pull, install and run the VPP packages.
This section provides directions on how to Install VPP binaries on
Ubuntu, and Centos platforms.
FD.io VPP is installed using Package Cloud. For a complete set of
instructions on how to install VPP with package cloud please refer
to `Package Cloud <https://packagecloud.io/fdio/release>`_.
FD.io VPP packages are stored in Packagecloud.io package repositories. There is
a package repository for the latest VPP release packages as well as a package
repository associated with each branch in the VPP git repository. The VPP merge
jobs which run on Jenkins (https://jenkins.fd.io) for each actively supported
git branch uploads packages to packagecloud that are built from the vpp code in
the branch.
Installing on Ubuntu
---------------------------------
Installing on Ubuntu / Debian OS Distros
----------------------------------------
The following are instructions on how to install VPP on Ubuntu.

68
docs/gettingstarted/installing/ubuntu.rst
View File

@ -8,53 +8,58 @@ 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:
following commands to upgrade the OS and install the curl package to download
the setup script from packagecloud.io:
.. code-block:: console
apt-get update
sudo apt-get update
sudo apt-get dist-upgrade -y
sudo apt-get install curl
Configure Apt Using the Packagecloud Setup Script
-------------------------------------------------
Point to the Repository
-----------------------------------
FD.io Packagecloud Repositories provides pop-up menu that provides the
ability to copy a one-line bash command to fetch the packagecloud setup script.
In general, start at the FD.io packagecloud URL:
https://packagecloud.io/fdio
Then choose the desired repository link (e.g. 'release') and select the "Debian"
package icon in the section named "Quick install instructions". When the pop-up
dialog appears, select the "Copy" button to copy the command to run the setup
script and paste it into a terminal on your server.
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
VPP Release Repo
^^^^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
The URL to install the latest VPP release is
.. code-block:: console
https://packagecloud.io/fdio/release
deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu bionic main
Get the key:
VPP master Branch Repo
^^^^^^^^^^^^^^^^^^^^^^
The URL to install the latest VPP release is
.. code-block:: console
https://packagecloud.io/fdio/release
curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
VPP master Branch
^^^^^^^^^^^^^^^^^^^^
VPP stable release Branch Repo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
Stable release branches are named "stable/YYMM" (e.g. stable/2206) and the associated
packagecloud repositories are named "YYMM" (e.g 2206). For example, the URL to
the VPP 22.06 stable release branch package repository is:
.. 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 -
https://packagecloud.io/fdio/2206
Install the Mandatory Packages
@ -86,3 +91,14 @@ Uninstall the packages by running the following command:
.. code-block:: console
sudo apt-get remove --purge "vpp*"
Remove FD.io Apt source lists
=============================
Remove FD.io Apt source list files created by the packagecloud apt setup script
by running the following command:
.. code-block:: console
sudo rm /etc/apt/sources.list.d/fdio*.list

1
docs/spelling_wordlist.txt
View File

@ -1334,6 +1334,7 @@ XXX
xyz
yaml
Yaml
YYMM
yyy
zeroize
zfs