View source for VPP/Installing VPP binaries from packages

== Intro ==

If you are simply using vpp, it can be convenient to simply install the packages.  The instructions below
will pull the latest freshest package build from the master branch (updated on every merge).

== Package Descriptions ==

* '''vpp''' - Description: Vector Packet Processing--executables. This package provides VPP executables: vpp, vpp_api_test, vpp_json_test
** vpp - the vector packet engine
** vpp_api_test - vector packet engine API test tool
** vpp_json_test - vector packet engine JSON test tool
* '''vpp-lib''' - Description: Vector Packet Processing--runtime libraries. This package contains the VPP shared libraries, including:
** vppinfra - foundation library supporting vectors, hashes, bitmaps, pools, and string formatting.
** svm - vm library
** vlib - vector processing library
** vlib-api - binary API library
** vnet -  network stack library
* '''vpp-plugins''' - Description: Vector Packet Processing--plugin modules
** acl
** dpdk
** flowprobe
** gtpu
** ixge
** kubeproxy
** l2e
** lb
** memif
** nat
** pppoe
** sixrd
** stn
* '''vpp-dbg''' - Description: Vector Packet Processing--debug symbols
* '''vpp-dev''' - Description: Vector Packet Processing--development support. This package contains development support files for the VPP libraries
* '''vpp-api-java''' - Description: JAVA binding for the VPP Binary API.
* '''vpp-api-python''' - Description: Python binding for the VPP Binary API.
* '''vpp-api-lua''' - Description: Lua binding for the VPP Binary API.

== Ubuntu/Debian ==

=== Add fd.io repo ===

1. Pick Ubuntu version:
* Ubuntu 16.04 - Xenial
  export UBUNTU="xenial"

2. Pick VPP version:
* Released (VPP 18.01)
  export RELEASE=".stable.1801"
* Released (VPP 17.10)
  export RELEASE=".stable.1710"
* Released (VPP 17.07)
  export RELEASE=".stable.1707"
* MASTER (in development)
  export RELEASE=".master"

3. Then run:
  sudo rm /etc/apt/sources.list.d/99fd.io.list
  echo "deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io$RELEASE.ubuntu.$UBUNTU.main/ ./" | sudo tee -a /etc/apt/sources.list.d/99fd.io.list
  sudo apt-get update
  sudo apt-get install vpp vpp-lib 

Optional packages:
  sudo apt-get install vpp-plugins vpp-dbg vpp-dev vpp-api-java vpp-api-python vpp-api-lua

=== Uninstalling ===

  sudo apt-get remove --purge vpp vpp-lib

Optional packages:
  sudo apt-get remove --purge vpp-plugins vpp-dbg vpp-dev vpp-api-java vpp-api-python vpp-api-lua

== Centos ==

=== Add fd.io repo ===

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">

==== CentOS 7.3 - VPP Release RPMs (Latest) ====
<div class="mw-collapsible-content">

Create a file /etc/yum.repos.d/fdio-release.repo with contents:

<pre>
[fdio-release]
name=fd.io release branch latest merge
baseurl=https://nexus.fd.io/content/repositories/fd.io.centos7/
enabled=1
gpgcheck=0
</pre>
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">

==== CentOS 7.3 - VPP stable/1801 branch RPMs ====
<div class="mw-collapsible-content">

Create a file /etc/yum.repos.d/fdio-stable-1801.repo with contents:

<pre>
[fdio-stable-1801]
name=fd.io stable/1801 branch latest merge
baseurl=https://nexus.fd.io/content/repositories/fd.io.stable.1801.centos7/
enabled=1
gpgcheck=0
</pre>
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">

==== CentOS 7.3 - VPP stable/1710 branch RPMs ====
<div class="mw-collapsible-content">

Create a file /etc/yum.repos.d/fdio-stable-1710.repo with contents:

<pre>
[fdio-stable-1710]
name=fd.io stable/1710 branch latest merge
baseurl=https://nexus.fd.io/content/repositories/fd.io.stable.1710.centos7/
enabled=1
gpgcheck=0
</pre>
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">

==== CentOS 7.3 - VPP stable/1707 branch RPMs ====
<div class="mw-collapsible-content">

Create a file /etc/yum.repos.d/fdio-stable-1707.repo with contents:

<pre>
[fdio-stable-1707]
name=fd.io stable/1707 branch latest merge
baseurl=https://nexus.fd.io/content/repositories/fd.io.stable.1707.centos7/
enabled=1
gpgcheck=0
</pre>
</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">

==== CentOS 7.3 - VPP master branch RPMs (in development) ====
<div class="mw-collapsible-content">

Create a file /etc/yum.repos.d/fdio-master.repo with contents:

<pre>
[fdio-master]
name=fd.io master branch latest merge
baseurl=https://nexus.fd.io/content/repositories/fd.io.master.centos7/
enabled=1
gpgcheck=0
</pre>
</div>
</div>

=== Install vpp packages ===

<code>
sudo yum install vpp
</code>

== openSUSE ==
Blog-post: https://www.suse.com/communities/blog/vector-packet-processing-vpp-opensuse/
=== Install ===
==== openSUSE Tumbleweed (rolling release) ====
<pre>
sudo zypper install vpp vpp-plugins
</pre>

==== openSUSE Leap 42.3 ====
<pre>
sudo zypper addrepo --name network https://download.opensuse.org/repositories/network/openSUSE_Leap_42.3/network.repo
sudo zypper install vpp vpp-plugins
</pre>

=== Uninstall ===
==== openSUSE Tumbleweed (rolling release) ====
<pre>
sudo zypper remove -u vpp vpp-plugins
</pre>

==== openSUSE Leap 42.3 ====
<pre>
sudo zypper remove -u vpp vpp-plugins
sudo zypper removerepo network
</pre>

= Getting jvpp jar = 

== Directly downloading jvpp.jar ==
vpp provides java bindings which can be [https://nexus.fd.io/content/repositories/fd.io.release/io/fd/vpp/jvpp-core/17.10/jvpp-core-17.10.jar downloaded]

== Getting jvpp via maven ==

Add the following to the repositories section in your ~/.m2/settings.xml to pick up the fd.io maven repo:

<code>
<repository>
  <id>fd.io-release</id>
  <name>fd.io-release</name>
  <url>https://nexus.fd.io/content/repositories/fd.io.release/</url>
  <releases>
    <enabled>false</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>
</code>

[https://maven.apache.org/guides/mini/guide-multiple-repositories.html More information on setting up maven repositories in settings.xml].

Then you can get jvpp by putting in the dependencies section of your pom.xml file:

<code>
<dependency>
  <groupId>io.fd.vpp</groupId>
  <artifactId>jvpp-core</artifactId>
  <version>17.10</version>
</dependency>
<dependency>
  <groupId>io.fd.vpp</groupId>
  <artifactId>jvpp-registry</artifactId>
  <version>17.10</version>
</dependency>
</code>

[https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html More information on maven dependency managment]