docs: what is vpp and features and performance 94/14694/2
authorScott Keeler <skeeler@cisco.com>
Thu, 6 Sep 2018 11:52:59 +0000 (07:52 -0400)
committerDamjan Marion <dmarion@me.com>
Fri, 7 Sep 2018 07:29:27 +0000 (07:29 +0000)
Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46
Signed-off-by: Scott Keeler <skeeler@cisco.com>
docs/overview/features/controlplane.rst
docs/overview/features/index.rst
docs/overview/features/l2.rst
docs/overview/features/l3.rst
docs/overview/features/l4.rst
docs/overview/features/plugins.rst
docs/overview/features/trafficmanagement.rst
docs/overview/features/tunnels.rst
docs/overview/performance/index.rst
docs/overview/supported.rst

index ddf0d34..849617a 100644 (file)
@@ -4,6 +4,8 @@
 Control Plane
 =============
 
+This section identifies the features associated with Control Plane:
+
 * DHCP client/proxy
 
 * DHCPv6 Proxy
index 43d0503..dc825c4 100644 (file)
@@ -4,6 +4,8 @@
 Features
 ========
 
+The table below identifies different features that are associated to VPP. To see more details about a specific feature, just click the hyperlink associated to the feature noted in the table below.
+
 .. rst-class:: center-align-table
 
 +-------------------------+-----------+-----------+
index a567356..56c1205 100644 (file)
@@ -4,6 +4,8 @@
 Layer 2
 =======
 
+This section identifies the features associated with Layer 2:
+
 MAC Layer
 ---------
 * Ethernet
index fd90b13..57ae10f 100644 (file)
@@ -4,6 +4,8 @@
 Layer 3
 =======
 
+This section identifies the features associated with Layer 3:
+
 IP Layer
 --------
 * ICMP
index 052c6b1..28e1df5 100644 (file)
@@ -3,3 +3,12 @@
 =======
 Layer 4
 =======
+
+This section identifies the features associated with Layer 4:
+
+* Session: 
+   - connectionless transports
+   - datagram reception and transmission
+* TCP: congestion control 
+* UDP: datagram mode
+* TLS async support
index 9943113..0394a81 100644 (file)
@@ -4,4 +4,6 @@
 Plugins
 =======
 
+This section identifies the features associated with Plugins:
+
 * iOAM
index 9320165..e56af50 100644 (file)
@@ -4,6 +4,8 @@
 Traffic Management
 ==================
 
+This section identifies the features associated with Traffic Management:
+
 IP Layer Input Checks
 ---------------------
 * Source Reverse Path Forwarding
@@ -51,5 +53,5 @@ COP
 
 MAC/IP Pairing
 --------------
-(security feature).
+Security feature
 
index 352c439..0f2b2d2 100644 (file)
@@ -4,6 +4,8 @@
 Tunnels
 =======
 
+This section identifies the features associated with Tunnels:
+
 Layer 2
 -------
 * L2TP
index 2c80771..1c25020 100644 (file)
@@ -6,34 +6,34 @@ Performance
 Overview
 ^^^^^^^^
 
-One of the benefits of FD.io VPP, is high performance on relatively low-power computing, this performance is based on the following features:
+One of the benefits of FD.io VPP is high performance on relatively low-power computing, this performance is based on the following features:
 
-* A high-performance user-space network stack designed for commodity hardware.
+* A high-performance user-space network stack designed for commodity hardware:
 
   - L2, L3 and L4 features and encapsulations.
 
-* Optimized packet interfaces supporting a multitude of use cases.
+* Optimized packet interfaces supporting a multitude of use cases:
 
-  - An integrated vhost-user backend for high speed VM-to-VM connectivity.
-  - An integrated memif container backend for high speed Container-to-Container connectivity
-  - An integrated vhost based interface to punt packets to the Linux Kernel
+  - An integrated vhost-user backend for high speed VM-to-VM connectivity
+  - An integrated memif container backend for high speed Container-to-Container connectivity
+  - An integrated vhost based interface to punt packets to the Linux Kernel
 
-* The same optimized code-paths run execute on the host, and inside VMs and Linux containers.
-* Leverages best-of-breed open source driver technology: `DPDK <https://www.dpdk.org/>`_.
-* Tested at scale; linear core scaling, tested with millions of flows and mac addresses.  
+* The same optimized code-paths run execute on the host, and inside VMs and Linux containers
+* Leverages best-of-breed open source driver technology: `DPDK <https://www.dpdk.org/>`_
+* Tested at scale; linear core scaling, tested with millions of flows and mac addresses  
 
 These features have been designed to take full advantage of common micro-processor optimization techniques, such as: 
 
-* Reducing cache and TLS misses by processing packets in vectors
-* Realizing `IPC <https://en.wikipedia.org/wiki/Instructions_per_cycle>`_ gains with vector instructions such as: SSE, AVX and NEON.
-* Eliminating mode switching, context switches and blocking, to always be doing useful work.  
-* Cache-lined aliged buffers for cache and memory efficiency.
+* Reducing cache and TLS misses by processing packets in vectors
+* Realizing `IPC <https://en.wikipedia.org/wiki/Instructions_per_cycle>`_ gains with vector instructions such as: SSE, AVX and NEON
+* Eliminating mode switching, context switches and blocking, to always be doing useful work
+* Cache-lined aliged buffers for cache and memory efficiency
 
 
 Packet Throughput Graphs
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-These are some of the packet throughput graphs for FD.io VPP 18.04 from the CSIT `18.04 benchmarking report <https://docs.fd.io/csit/rls1804/report/>`_.   
+These are some of the packet throughput graphs for FD.io VPP 18.04 from the CSIT `18.04 benchmarking report <https://docs.fd.io/csit/rls1804/report/>`_:
 
 .. toctree::
 
@@ -45,7 +45,7 @@ These are some of the packet throughput graphs for FD.io VPP 18.04 from the CSIT
 Trending Throughput Graphs
 ^^^^^^^^^^^^^^^^^^^^^^^^^^ 
 
-These are some of the trending packet throughput graphs from the CSIT `trending dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_. **Please note that**, performance in the trending graphs will change on a nightly basis in line with the software development cycle.
+These are some of the trending packet throughput graphs from the CSIT `trending dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_. **Please note that**, performance in the trending graphs will change on a nightly basis in line with the software development cycle:
 
 .. toctree::
 
@@ -58,14 +58,14 @@ For More information on CSIT
 
 The FD.io CSIT is implemented with below platforms:
 
-* x86/64
-* ARM-AArch64
+* x86/64
+* ARM-AArch64
 
-   * Huawei TaiShan 2280
-   * Marvell MACCHIATObin
+   * Huawei TaiShan 2280
+   * Marvell MACCHIATObin
 
 
-These are FD.io Continuous System Integration and Testing (CSIT)'s documentation links.
+These are FD.io Continuous System Integration and Testing (CSIT)'s documentation links:
 
 * `CSIT Code Documentation <https://docs.fd.io/csit/master/doc/overview.html>`_
 * `CSIT Test Overview <https://docs.fd.io/csit/rls1804/report/introduction/overview.html>`_
index c843514..959d448 100644 (file)
@@ -5,13 +5,15 @@
 Architectures and Operating Systems
 ***********************************
 
+The following architectures and operating systems are supported in VPP:
+
 Architectures
 -----------------------
 
-* The FD.io VPP platform supports:
+* The FD.io VPP platform supports:
 
-   * x86/64
-   * ARM-AArch64
+   * x86/64
+   * ARM-AArch64
 
 Operating Systems and Packaging
 -------------------------------
@@ -19,9 +21,9 @@ Operating Systems and Packaging
 FD.io VPP supports package installation on the following 
 recent LTS operating systems releases:
 
-* Operating Systems:
+* Operating Systems:
 
-   * Debian
-   * Ubuntu 
-   * CentOS 
-   * OpenSUSE
+   * Debian
+   * Ubuntu 
+   * CentOS 
+   * OpenSUSE