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