From a5db42f366798034e464442c92a90529fc947f08 Mon Sep 17 00:00:00 2001 From: John DeNisco Date: Fri, 17 Aug 2018 14:25:15 -0400 Subject: docs: Moved installing up a level, removed guides. Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco --- docs/gettingstarted/installing/packages.rst | 85 +++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 docs/gettingstarted/installing/packages.rst (limited to 'docs/gettingstarted/installing/packages.rst') diff --git a/docs/gettingstarted/installing/packages.rst b/docs/gettingstarted/installing/packages.rst new file mode 100644 index 00000000000..55ddf05fdad --- /dev/null +++ b/docs/gettingstarted/installing/packages.rst @@ -0,0 +1,85 @@ +.. _packages: + +Packages +========== + +This section identifies the different VPP packages and describes their contents. + +.. toctree:: + +vpp +--- + +Vector Packet Processing executables. This is the primary package that must be +installed to use VPP. This package contains: + +* 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 +------- + +Vector Packet Processing runtime libraries. The *'vpp'* package depends on this +package, so it will always be installed. 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 +----------- + +Vector Packet Processing plugin modules. + +* acl +* dpdk +* flowprobe +* gtpu +* ixge +* kubeproxy +* l2e +* lb +* memif +* nat +* pppoe +* sixrd +* stn + +vpp-dbg +------- + +Vector Packet Processing debug symbols. + +vpp-dev +------- + +Vector Packet Processing development support. This package contains +development support files for the VPP libraries. + +vpp-api-java +------------ + +JAVA binding for the VPP Binary API. + +vpp-api-python +-------------- + +Python binding for the VPP Binary API. + +vpp-api-lua +----------- + +Lua binding for the VPP Binary API. + +vpp-selinux-policy +------------------ + +This package contains the VPP Custom SELinux Policy. It is only generated for +Fedora and CentOS distros. For those distros, the *'vpp'* package depends on +this package, so it will always be installed. It will not enable SELinux on +the system. It will install a Custom VPP SELinux policy that will be used if +SELinux is enabled at any time. -- cgit 1.2.3-korg