diff options
| -rw-r--r-- | docs/gettingstarted/installing/index.rst | 16 | ||||
| -rw-r--r-- | docs/gettingstarted/installing/ubuntu.rst | 68 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
3 files changed, 51 insertions, 34 deletions
diff --git a/docs/gettingstarted/installing/index.rst b/docs/gettingstarted/installing/index.rst index ba67375f8c7..86ffec07d73 100644 --- a/docs/gettingstarted/installing/index.rst +++ b/docs/gettingstarted/installing/index.rst @@ -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 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. -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>`_. - -Installing on Ubuntu ---------------------------------- +Installing on Ubuntu / Debian OS Distros +---------------------------------------- The following are instructions on how to install VPP on Ubuntu. diff --git a/docs/gettingstarted/installing/ubuntu.rst b/docs/gettingstarted/installing/ubuntu.rst index f1bdb3eecd0..1022e0c3ff1 100644 --- a/docs/gettingstarted/installing/ubuntu.rst +++ b/docs/gettingstarted/installing/ubuntu.rst @@ -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: -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. +https://packagecloud.io/fdio -.. _install_vpp: - -VPP latest Release -^^^^^^^^^^^^^^^^^^^ - -Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents: +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. -.. code-block:: console - deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu bionic main +.. _install_vpp: -Get the key: +VPP Release Repo +^^^^^^^^^^^^^^^^^^^ -.. code-block:: console +The URL to install the latest VPP release is - curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add - +https://packagecloud.io/fdio/release -VPP master Branch -^^^^^^^^^^^^^^^^^^^^ -Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents: +VPP master Branch Repo +^^^^^^^^^^^^^^^^^^^^^^ +The URL to install the latest VPP release is -.. code-block:: console +https://packagecloud.io/fdio/release - deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu bionic main -Get the key: +VPP stable release Branch Repo +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code-block:: console +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: - 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 diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index b64644b5e8b..97bd0b573e1 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -1334,6 +1334,7 @@ XXX xyz yaml Yaml +YYMM yyy zeroize zfs |