docs: Incororate Scott's overall review
[vpp.git] / docs / gettingstarted / users / installing / packages.rst
1 .. _packages:
2
3 Packages
4 ==========
5
6 This section identifies the different VPP packages and describes their contents.
7
8 .. toctree::
9
10 vpp
11 ---
12
13 Vector Packet Processing executables. This is the primary package that must be
14 installed to use VPP. This package contains:
15
16 * vpp - the vector packet engine
17 * vpp_api_test - vector packet engine API test tool
18 * vpp_json_test - vector packet engine JSON test tool
19
20 vpp-lib
21 -------
22
23 Vector Packet Processing runtime libraries. The *'vpp'* package depends on this
24 package, so it will always be installed. This package contains the VPP shared
25 libraries, including:
26
27 * vppinfra - Foundation library supporting vectors, hashes, bitmaps, pools, and string formatting.
28 * svm - vm library
29 * vlib - vector processing library
30 * vlib-api - binary API library
31 * vnet -  network stack library
32
33 vpp-plugins
34 -----------
35
36 Vector Packet Processing plugin modules.
37
38 * acl
39 * dpdk
40 * flowprobe
41 * gtpu
42 * ixge
43 * kubeproxy
44 * l2e
45 * lb
46 * memif
47 * nat
48 * pppoe
49 * sixrd
50 * stn
51
52 vpp-dbg
53 -------
54
55 Vector Packet Processing debug symbols.
56
57 vpp-dev
58 -------
59
60 Vector Packet Processing development support. This package contains
61 development support files for the VPP libraries.
62
63 vpp-api-java
64 ------------
65
66 JAVA binding for the VPP Binary API.
67
68 vpp-api-python 
69 --------------
70
71 Python binding for the VPP Binary API.
72
73 vpp-api-lua
74 -----------
75
76 Lua binding for the VPP Binary API.
77
78 vpp-selinux-policy
79 ------------------
80
81 This package contains the VPP Custom SELinux Policy. It is only generated for
82 Fedora and CentOS distros. For those distros, the *'vpp'* package depends on
83 this package, so it will always be installed. It will not enable SELinux on
84 the system. It will install a Custom VPP SELinux policy that will be used if
85 SELinux is enabled at any time.