diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/overview/features/controlplane.rst | 2 | ||||
| -rw-r--r-- | docs/overview/features/index.rst | 2 | ||||
| -rw-r--r-- | docs/overview/features/l2.rst | 2 | ||||
| -rw-r--r-- | docs/overview/features/l3.rst | 2 | ||||
| -rw-r--r-- | docs/overview/features/l4.rst | 9 | ||||
| -rw-r--r-- | docs/overview/features/plugins.rst | 2 | ||||
| -rw-r--r-- | docs/overview/features/trafficmanagement.rst | 4 | ||||
| -rw-r--r-- | docs/overview/features/tunnels.rst | 2 | ||||
| -rw-r--r-- | docs/overview/performance/index.rst | 40 | ||||
| -rw-r--r-- | docs/overview/supported.rst | 18 |
10 files changed, 54 insertions, 29 deletions
diff --git a/docs/overview/features/controlplane.rst b/docs/overview/features/controlplane.rst index ddf0d34c69f..849617ae4e6 100644 --- a/docs/overview/features/controlplane.rst +++ b/docs/overview/features/controlplane.rst @@ -4,6 +4,8 @@ Control Plane ============= +This section identifies the features associated with Control Plane: + * DHCP client/proxy * DHCPv6 Proxy diff --git a/docs/overview/features/index.rst b/docs/overview/features/index.rst index 43d0503d999..dc825c4c2a9 100644 --- a/docs/overview/features/index.rst +++ b/docs/overview/features/index.rst @@ -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 +-------------------------+-----------+-----------+ diff --git a/docs/overview/features/l2.rst b/docs/overview/features/l2.rst index a567356209b..56c12053ab8 100644 --- a/docs/overview/features/l2.rst +++ b/docs/overview/features/l2.rst @@ -4,6 +4,8 @@ Layer 2 ======= +This section identifies the features associated with Layer 2: + MAC Layer --------- * Ethernet diff --git a/docs/overview/features/l3.rst b/docs/overview/features/l3.rst index fd90b13efd9..57ae10ff208 100644 --- a/docs/overview/features/l3.rst +++ b/docs/overview/features/l3.rst @@ -4,6 +4,8 @@ Layer 3 ======= +This section identifies the features associated with Layer 3: + IP Layer -------- * ICMP diff --git a/docs/overview/features/l4.rst b/docs/overview/features/l4.rst index 052c6b1b45a..28e1df5f65d 100644 --- a/docs/overview/features/l4.rst +++ b/docs/overview/features/l4.rst @@ -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 diff --git a/docs/overview/features/plugins.rst b/docs/overview/features/plugins.rst index 99431134f7f..0394a816cdb 100644 --- a/docs/overview/features/plugins.rst +++ b/docs/overview/features/plugins.rst @@ -4,4 +4,6 @@ Plugins ======= +This section identifies the features associated with Plugins: + * iOAM diff --git a/docs/overview/features/trafficmanagement.rst b/docs/overview/features/trafficmanagement.rst index 9320165ec09..e56af50a90e 100644 --- a/docs/overview/features/trafficmanagement.rst +++ b/docs/overview/features/trafficmanagement.rst @@ -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 diff --git a/docs/overview/features/tunnels.rst b/docs/overview/features/tunnels.rst index 352c4393099..0f2b2d23db0 100644 --- a/docs/overview/features/tunnels.rst +++ b/docs/overview/features/tunnels.rst @@ -4,6 +4,8 @@ Tunnels ======= +This section identifies the features associated with Tunnels: + Layer 2 ------- * L2TP diff --git a/docs/overview/performance/index.rst b/docs/overview/performance/index.rst index 2c8077119cf..1c250206fcf 100644 --- a/docs/overview/performance/index.rst +++ b/docs/overview/performance/index.rst @@ -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>`_ diff --git a/docs/overview/supported.rst b/docs/overview/supported.rst index c843514e05a..959d4483407 100644 --- a/docs/overview/supported.rst +++ b/docs/overview/supported.rst @@ -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 |