docs/gettingstarted/installing/ubuntu.rst

   1 .. _ubuntu:
   2
   3 .. toctree::
   4
   5 Ubuntu - Setup the FD.io Repository
   6 ===================================
   7
   8 Choose one of the following releases to install.
   9
  10 Update the OS
  11 -------------
  12
  13 It is a good idea to first update and upgrade the OS before starting; run the
  14 following commands to upgrade the OS and install the curl package to download
  15 the setup script from packagecloud.io:
  16
  17 .. code-block:: console
  18
  19     sudo apt-get update
  20     sudo apt-get dist-upgrade -y
  21     sudo apt-get install curl
  22
  23 Configure Apt Using the Packagecloud Setup Script
  24 -------------------------------------------------
  25
  26 FD.io Packagecloud Repositories provides pop-up menu that provides the
  27 ability to copy a one-line bash command to fetch the packagecloud setup script.
  28 In general, start at the FD.io packagecloud URL:
  29
  30 https://packagecloud.io/fdio
  31
  32 Then choose the desired repository link (e.g. 'release') and select the "Debian"
  33 package icon in the section named "Quick install instructions".  When the pop-up
  34 dialog appears, select the "Copy" button to copy the command to run the setup
  35 script and paste it into a terminal on your server.
  36
  37
  38 .. _install_vpp:
  39
  40 VPP Release Repo
  41 ^^^^^^^^^^^^^^^^^^^
  42
  43 The URL to install the latest VPP release is
  44
  45 https://packagecloud.io/fdio/release
  46
  47
  48 VPP master Branch Repo
  49 ^^^^^^^^^^^^^^^^^^^^^^
  50 The URL to install the latest VPP release is
  51
  52 https://packagecloud.io/fdio/release
  53
  54
  55 VPP stable release Branch Repo
  56 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  57
  58 Stable release branches are named "stable/YYMM" (e.g. stable/2206) and the associated
  59 packagecloud repositories are named "YYMM" (e.g 2206).  For example, the URL to
  60 the VPP 22.06 stable release branch package repository is:
  61
  62 https://packagecloud.io/fdio/2206
  63
  64
  65 Install the Mandatory Packages
  66 ===============================
  67
  68 Install the mandatory packages by running the following commands:
  69
  70 .. code-block:: console
  71
  72   sudo apt-get update
  73   sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
  74
  75
  76 Install the Optional Packages
  77 ==============================
  78
  79 Install the optional packages by running the following command:
  80
  81 .. code-block:: console
  82
  83   sudo apt-get install vpp-api-python python3-vpp-api vpp-dbg vpp-dev
  84
  85
  86 Uninstall the Packages
  87 ======================
  88
  89 Uninstall the  packages by running the following command:
  90
  91 .. code-block:: console
  92
  93   sudo apt-get remove --purge "vpp*"
  94
  95
  96 Remove FD.io Apt source lists
  97 =============================
  98
  99 Remove FD.io Apt source list files created by the packagecloud apt setup script
 100 by running the following command:
 101
 102 .. code-block:: console
 103
 104   sudo rm /etc/apt/sources.list.d/fdio*.list