summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/images/diagram_euphrates.pngbin0 -> 234411 bytes
-rw-r--r--docs/release/installation.introduction.rst4
-rw-r--r--docs/release/overview.rst118
-rw-r--r--docs/release/release-notes.rst4
-rw-r--r--docs/release/userguide.introduction.rst3
m---------docs/submodules/apex0
m---------docs/submodules/armband0
m---------docs/submodules/barometer0
m---------docs/submodules/bottlenecks0
m---------docs/submodules/compass4nfv0
m---------docs/submodules/daisy0
m---------docs/submodules/fuel0
m---------docs/submodules/functest0
m---------docs/submodules/moon0
m---------docs/submodules/nfvbench0
m---------docs/submodules/onosfw0
m---------docs/submodules/releng0
m---------docs/submodules/snaps0
m---------docs/submodules/storperf0
m---------docs/submodules/yardstick0
-rw-r--r--docs/testing/testing-user.rst7
21 files changed, 85 insertions, 51 deletions
diff --git a/docs/images/diagram_euphrates.png b/docs/images/diagram_euphrates.png
new file mode 100644
index 000000000..2673a5297
--- /dev/null
+++ b/docs/images/diagram_euphrates.png
Binary files differ
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst
index cdf1479b2..853b768c6 100644
--- a/docs/release/installation.introduction.rst
+++ b/docs/release/installation.introduction.rst
@@ -49,7 +49,6 @@ To learn more about the scenarios supported in the Euphrates release refer to th
description documents provided:
- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>`
-- :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>`
- :ref:`os-odl-fdio-ha <os-odl-fdio-ha>`
- :ref:`os-odl-fdio-noha <os-odl-fdio-noha>`
- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
@@ -70,10 +69,7 @@ description documents provided:
- :ref:`os-odl-ovs_dpdk-noha <os-odl-ovs_dpdk-noha>`
- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>`
- :ref:`os-odl-fdio-dvr-ha <os-odl-fdio-dvr-ha>`
-- :ref:`os-odl-fdio-ipv6-noha <os-odl-fdio-ipv6-noha>`
-- :ref:`os-odl-fdio-ipv6-ha <os-odl-fdio-ipv6-ha>`
- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>`
-- :ref:`os-k8s-fdio <os-k8s-fdio>`
- :ref:`os-odl-k8s_coe-noha <os-odl-k8s_coe-noha>`
- :ref:`os-odl-k8s_coe-ha <os-odl-k8s_coe-ha>`
- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>`
diff --git a/docs/release/overview.rst b/docs/release/overview.rst
index 7e1d136c9..ad230f01d 100644
--- a/docs/release/overview.rst
+++ b/docs/release/overview.rst
@@ -4,9 +4,9 @@
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors
-================
+=================
Platform overview
-================
+=================
Introduction
============
@@ -28,10 +28,10 @@ NFV use cases. OPNFV also works upstream with other open source communities to b
and learnings from its work directly to those communities in the form of blueprints, patches, bugs,
and new code.
-OPNFV initially focused on building NFV Infrastructure (NFVI) and Virtualised Infrastructure
-Management (VIM) by integrating components from upstream projects such as OpenDaylight,
-OpenStack, Ceph Storage, KVM, Open vSwitch, and Linux.
-More recently, OPNFV has extended its portfolio of forwarding solutions to include fd.io and ODP,
+OPNFV focuses on building NFV Infrastructure (NFVI) and Virtualised Infrastructure
+Management (VIM) by integrating components from upstream projects such as OpenDaylight, ONOS, OpenContrail,
+OVN, OpenStack, Kubernetes, Ceph Storage, KVM, Open vSwitch, and Linux.
+More recently, OPNFV has extended its portfolio of forwarding solutions to include DPDK, fd.io and ODP,
is able to run on both Intel and ARM commercial and white-box hardware, support VM, Container and
BareMetal workloads, and includes Management and Network Orchestration MANO components primarily
for application composition and management in the Danube release.
@@ -55,17 +55,18 @@ platform including common hardware requirements, software architecture, MANO and
OPNFV Platform Overview Diagram
-.. image:: ../images/opnfvplatformgraphic.png
+.. image:: ../images/diagram_euphrates.png
:alt: Overview infographic of the opnfv platform and projects.
To address these areas effectively, the OPNFV platform architecture can be decomposed
into the following basic building blocks:
-* Hardware: with the Infra working group, Pharos project and associated activities
-* Software Platform: through the platform integration and deployment projects
-* MANO: through the MANO working group and associated projects
-* Applications: which affect all other areas and drive requirements for OPNFV
+* Hardware: Infrastructure working group, Pharos project and associated activities
+* Software Platform: Platform integration and deployment projects
+* MANO: MANO working group and associated projects
+* Tooling and testing: Testing working group and test projects
+* Applications: All other areas and drive requirements for OPNFV
OPNFV Lab Infrastructure
========================
@@ -96,12 +97,8 @@ OPNFV Software Platform Architecture
The OPNFV software platform is comprised exclusively of open source implementations of
platform component pieces. OPNFV is able to draw from the rich ecosystem of NFV related
-technologies available in open-source then integrate, test, measure and improve these
-components in conjunction with our source communities.
-
-While the composition of the OPNFV software platform is highly complex and constituted of many
-projects and components, a subset of these projects gain the most attention from the OPNFV community
-to drive the development of new technologies and capabilities.
+technologies available in open source communities, and then integrate, test, measure and improve these
+components in conjunction with our upstream communities.
---------------------------------
Virtual Infrastructure Management
@@ -110,17 +107,19 @@ Virtual Infrastructure Management
OPNFV derives it's virtual infrastructure management from one of our largest upstream ecosystems
OpenStack. OpenStack provides a complete reference cloud management system and associated technologies.
While the OpenStack community sustains a broad set of projects, not all technologies are relevant in
-an NFV domain, the OPNFV community consumes a sub-set of OpenStack projects where the usage and
+the NFV domain, the OPNFV community consumes a sub-set of OpenStack projects and the usage and
composition may vary depending on the installer and scenario.
For details on the scenarios available in OPNFV and the specific composition of components
-refer to the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>`
+refer to the :ref:`OPNFV User Guide & Configuration Guide <opnfv-user-config>`.
+
+OPNFV now also has initial support for containerized VNFs.
-----------------
Operating Systems
-----------------
-OPNFV currently uses Linux on all target machines, this can include Ubuntu, Centos or SUSE linux. The
+OPNFV currently uses Linux on all target machines, this can include Ubuntu, Centos or SUSE Linux. The
specific version of Linux used for any deployment is documented in the installation guide.
-----------------------
@@ -140,34 +139,46 @@ where the OPNFV community supports and contributes to a number of these. The co
being worked on by the community during this release of OPNFV include:
* Neutron: an OpenStack project to provide “network connectivity as a service” between
- interface devices (e.g., vNICs) managed by other OpenStack services (e.g., nova).
+ interface devices (e.g., vNICs) managed by other OpenStack services (e.g. Nova).
* OpenDaylight: addresses multivendor, traditional and greenfield networks, establishing the
industry’s de facto SDN platform and providing the foundation for networks of the future.
-* ONOS: a carrier-grade SDN network operating system designed for high availability,
- performance, scale-out.
+* OpenContrail: An open source SDN controller designed for cloud and NFV use cases. It has an
+ analytics engine, well defined northbound REST APIs to configure and gather ops/analytics data.
+* OVN: A virtual networking solution developed by the same team that created OVS. OVN stands for
+ Open Virtual Networking and is dissimilar from the above projects in that it focuses only on overlay networks.
-.. OpenContrail SDN controller is planned to be supported in the next release.
Data Plane
----------
OPNFV extends Linux virtual networking capabilities by using virtual switching
-and routing components. The OPNFV community proactively engages with these source
+and routing components. The OPNFV community proactively engages with the following open source
communities to address performance, scale and resiliency needs apparent in carrier
networks.
-* FD.io (Fast data - Input/Output): a collection of several projects and libraries to
- amplify the transformation that began with Data Plane Development Kit (DPDK) to support
- flexible, programmable and composable services on a generic hardware platform.
-* Open vSwitch: a production quality, multilayer virtual switch designed to enable
- massive network automation through programmatic extension, while still supporting standard
- management interfaces and protocols.
+* OVS (Open vSwitch): a production quality, multilayer virtual switch designed to enable massive
+ network automation through programmatic extension, while still supporting standard management interfaces and protocols.
+* FD.io (Fast data - Input/Output): a high performance alternative to Open vSwitch, the core engine of
+ FD.io is a vector processing engine (VPP). VPP processes a number of packets in parallel instead of one at
+ a time thus significantly improving packet throughput.
+* DPDK: a set of libraries that bypass the kernel and provide polling mechanisms, instead of interrupt based operations,
+ to speed up packet processing. DPDK works with both OVS and FD.io.
+
+MANO
+----
+
+OPNFV integrates open source MANO projects for NFV orchestration and VNF management.
+New MANO projects are constantly being added, currently OPNFV integrates:
+* OpenBaton: Open Baton is a ETSI NFV compliant Management and Orchestration (MANO) Framework.
+ It enables virtual Network Services deployments on top of heterogeneous NFV Infrastructures.
+ OpenBaton is also used to deploy vIMS (clearwater and openIMS).
+
Deployment Architecture
=======================
A typical OPNFV deployment starts with three controller nodes running in a high availability
-configuration including control plane components from OpenStack, SDN, etc. and a minimum
+configuration including control plane components from OpenStack, SDN controllers, etc. and a minimum
of two compute nodes for deployment of workloads (VNFs).
A detailed description of the hardware requirements required to support the 5 node configuration
can be found in pharos specification: `Pharos Project <https://www.opnfv.org/developers/pharos>`_
@@ -202,22 +213,16 @@ Release Verification
====================
The OPNFV community relies on its testing community to establish release criteria for each OPNFV
-release. Each release cycle the testing criteria become more stringent and better representative
-of our feature and resiliency requirements.
-
-
-As each OPNFV release establishes a set of deployment scenarios to validate, the testing
-infrastructure and test suites need to accommodate these features and capabilities. It’s not
-only in the validation of the scenarios themselves where complexity increases, there are test
-cases that require multiple datacenters to execute when evaluating features, including multisite
-and distributed datacenter solutions.
+release. With each release cycle the testing criteria become more stringent and better representative
+of our feature and resiliency requirements. Each release establishes a set of deployment scenarios to validate,
+the testing infrastructure and test suites need to accommodate these features and capabilities.
The release criteria as established by the testing teams include passing a set of test cases
derived from the functional testing project ‘functest,’ a set of test cases derived from our
platform system and performance test project ‘yardstick,’ and a selection of test cases for
feature capabilities derived from other test projects such as bottlenecks, vsperf, cperf and
storperf. The scenario needs to be able to be deployed, pass these tests, and be removed from
-the infrastructure iteratively (no less that 4 times) in order to fulfil the release criteria.
+the infrastructure iteratively in order to fulfill the release criteria.
--------
Functest
@@ -274,6 +279,30 @@ additional testing stimuli, or tests simulating environmental disturbances or fa
These additional testing activities provide a more complete evaluation of the OPNFV platform.
Some of the projects focused on these testing areas include:
+-----------
+Bottlenecks
+-----------
+
+Bottlenecks provides a framework to find system limitations and bottlenecks, providing
+root cause isolation capabilities to facilitate system evaluation.
+
+NFVBench
+--------
+
+NFVbench is a lightweight end-to-end dataplane benchmarking framework project.
+It includes traffic generator(s) and measures a number of packet performance related metrics.
+
+QTIP
+----
+QTIP boils down NFVI compute and storage performance into one single metric for easy comparison.
+QTIP crunches these numbers based on five different categories of compute metrics and relies on
+Storperf for storage metrics.
+
+Storperf
+--------
+Storperf measures the performance of external block storage. The goal of this project is
+to provide a report based on SNIA’s (Storage Networking Industry Association) Performance Test Specification.
+
------
VSPERF
------
@@ -283,12 +312,7 @@ performance of the NFVI including switching technology, physical and virtual net
The provided test cases with network topologies can be customized while also allowing individual
versions of Operating System, vSwitch and hypervisor to be specified.
------------
-Bottlenecks
------------
-Bottlenecks provides a framework to find system limitations and bottlenecks, providing
-root cause isolation capabilities to facilitate system evaluation.
.. _`OPNFV Configuration Guide`: `OPNFV User Guide & Configuration Guide`
diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 9e6e5c301..442089233 100644
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -40,6 +40,10 @@ Project release notes:
:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>`
+:ref:`Moon Release Notes <moon-releasenotes>`
+
+:ref:`Netready Release Notes <netready-releasenotes>`
+
:ref:`NFVBench Release Notes <nfvbench-releasenotes>`
:ref:`Orchestra Release Notes <orchestra-releasenotes>`
diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index ef48e590c..02267ea80 100644
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -63,6 +63,9 @@ Feature Configuration Guides
- :ref:`Domino Configuration Guide <domino-configguide>`
- :ref:`IPv6 Configuration Guide <ipv6-configguide>`
- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>`
+- :ref:`Moon Configuration Guide <moon-configguide>`
+- :ref:`Netready Configuration Guide <netready-configguide>`
+- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
- :ref:`Orchestra Configuration Guide <orchestra-configguide>`
- :ref:`Parser Configuration Guide <parser-configguide>`
- :ref:`Promise Configuration Guide <promise-configguide>`
diff --git a/docs/submodules/apex b/docs/submodules/apex
-Subproject 75afddf0e4032e4af389c5d85b529704102a77a
+Subproject d158a48f4f10e9abb1403b1178b8c2f31b36e99
diff --git a/docs/submodules/armband b/docs/submodules/armband
-Subproject 8ac5a461c90545aa06538f5376cc929b2297f19
+Subproject e7260544c63bfd1e52a52839ad6527b0bc2ce75
diff --git a/docs/submodules/barometer b/docs/submodules/barometer
-Subproject 22ee912239c28bda8131e43b38c07b8b4502b08
+Subproject 22e77f28022ce0e7026e11d356227a120379c92
diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
-Subproject 011a217f71c27f9b908b20f9145f461ddc12084
+Subproject 1ddcbed821e841c032aa2f1a4dfc3714716e83b
diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
-Subproject c5127c4efb723f080611b28307c713dd21d17d8
+Subproject 2962812740c0507cefdc7d76aba320be15df14c
diff --git a/docs/submodules/daisy b/docs/submodules/daisy
-Subproject 7fb4a641b9fd176dcad36d881bf5e1103539202
+Subproject 164ffc1780a6ffd2634533849f67ed640fb0745
diff --git a/docs/submodules/fuel b/docs/submodules/fuel
-Subproject 8401f25a520843d884abb84806873baca0452ec
+Subproject c11eb920a3570ed22b252bbb8eecfb5231f5db1
diff --git a/docs/submodules/functest b/docs/submodules/functest
-Subproject b020adb0c47f5d85b5cc1b3b3927e689698499f
+Subproject e12d4f14b65ba08904a65e188db17992478d67a
diff --git a/docs/submodules/moon b/docs/submodules/moon
new file mode 160000
+Subproject b6bdaab8fe5cd06252331a0c59fb4f3d90aaac9
diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
-Subproject 5511522fce8d3d394f2d9b73fbd910032f75f53
+Subproject 1d69718eebb49bd402246775b0eb4524386948a
diff --git a/docs/submodules/onosfw b/docs/submodules/onosfw
-Subproject 9140456d7ae8256a9cbb5f0289216d26a102ca2
+Subproject 2507e130fd41d86f6c7116b6664fe9c28aea647
diff --git a/docs/submodules/releng b/docs/submodules/releng
-Subproject 4639c8a63b0f89e552dd574bc27973be8fb8b54
+Subproject e086052c0550e65c5049b89f75d85eed65ed9e5
diff --git a/docs/submodules/snaps b/docs/submodules/snaps
-Subproject 440acd77fbda4cf944cc915bef4183935527f65
+Subproject cef5b452099579a3f69a5c233b7ba25bd0d80f5
diff --git a/docs/submodules/storperf b/docs/submodules/storperf
-Subproject eb138c529c3cb1a7223bd970685db874f5a6269
+Subproject 477957139b2b782b899c9cb5603389ff0802b74
diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
-Subproject 07644db4910643d6f6705c6a12c5ec612a99a33
+Subproject f4680c872fbb34816d809c41852740f5cb960fd
diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst
index 6b533a26d..c7c4709c6 100644
--- a/docs/testing/testing-user.rst
+++ b/docs/testing/testing-user.rst
@@ -27,6 +27,13 @@ Functest
../submodules/functest/docs/testing/user/configguide/index
../submodules/functest/docs/testing/user/userguide/index
+NFVbench
+-----
+.. toctree::
+ :maxdepth: 1
+
+ ../submodules/nfvbench/docs/testing/user/userguide/index
+
QTIP
-----