X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Foverview.rst;h=7e1d136c9a55c0d10f1448dda119591e4fc1fec6;hb=2b1ea676636aa0e30fb7c6c77c79dd05944cab26;hp=83ffe4deb38ac828e12c5a196c2a0a9b0482dd3c;hpb=e025c0337b0483ff608347d43caa1b0414d97be2;p=opnfvdocs.git diff --git a/docs/release/overview.rst b/docs/release/overview.rst index 83ffe4deb..7e1d136c9 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -1,10 +1,12 @@ +.. _opnfv-overview: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier: CC-BY-4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -=============== -OPNFV Overview -=============== +================ +Platform overview +================ Introduction ============ @@ -30,9 +32,9 @@ OPNFV initially focused on building NFV Infrastructure (NFVI) and Virtualised In 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, -is able to run on both Intel and ARM commercial and white-box hardware, and includes -Management and Network Orchestration MANO components primarily for application composition -and management in the Colorado release. +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. These capabilities, along with application programmable interfaces (APIs) to other NFV elements, form the basic infrastructure required for Virtualized Network Functions (VNF) @@ -71,7 +73,8 @@ OPNFV Lab Infrastructure The infrastructure working group oversees such topics as lab management, workflow, definitions, metrics and tools for OPNFV infrastructure. -Fundamental to the WG is the `Pharos Project `_ +Fundamental to the WG is the +`Pharos Specification `_ which provides a set of defined lab infrastructures over a geographically and technically diverse federated global OPNFV lab. @@ -111,8 +114,7 @@ an NFV domain, the OPNFV community consumes a sub-set of OpenStack projects wher 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 OPNFV installation instruction: -http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html +refer to the :ref:`OPNFV User Guide & Configuration Guide ` ----------------- Operating Systems @@ -168,7 +170,7 @@ A typical OPNFV deployment starts with three controller nodes running in a high configuration including control plane components from OpenStack, SDN, 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: http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html +can be found in pharos specification: `Pharos Project `_ In addition to the deployment on a highly available physical infrastructure, OPNFV can be deployed for development and lab purposes in a virtual environment. In this case each of the hosts @@ -177,7 +179,7 @@ is provided by a virtual machine and allows control and workload placement using The initial deployment is done using a staging server, referred to as the "jumphost". This server-either physical or virtual-is first installed with the installation program that then installs OpenStack and other components on the controller nodes and compute nodes. -See the `OPNFV User Guide`_ for more details. +See the :ref:`OPNFV User Guide & Configuration Guide ` for more details. The OPNFV Testing Ecosystem @@ -193,8 +195,8 @@ platform validation. This required the integration of a variety of testing frame systems, real time and automated analysis of results, storage and publication of key facts for each run as shown in the following diagram. -.. image:: ../images/OPNFV_testing_group.png - :alt: Overview infographic of the Colorado OPNFV testing Ecosystem +.. image:: ../images/OPNFV_testing_working_group.png + :alt: Overview infographic of the OPNFV testing Ecosystem Release Verification ==================== @@ -215,7 +217,7 @@ derived from the functional testing project ‘functest,’ a set of test cases 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 fulfill the release criteria. +the infrastructure iteratively (no less that 4 times) in order to fulfil the release criteria. -------- Functest @@ -223,8 +225,7 @@ Functest Functest provides a functional testing framework incorporating a number of test suites and test cases that test and verify OPNFV platform functionality. -The scope of Functest and relevant test cases can be found in its -`user guide `_. +The scope of Functest and relevant test cases can be found in the :ref:`Functest User Guide ` Functest provides both feature project and component test suite integration, leveraging OpenStack and SDN controllers testing frameworks to verify the key components of the OPNFV @@ -258,7 +259,7 @@ OPNFV ecosystem. The Dovetail project will provide a test framework and methodology able to be used on any NFV platform, including an agreed set of test cases establishing an evaluation criteria for exercising an OPNFV compatible system. The Dovetail project has begun establishing the test framework -and will provide a preliminary methodology for the Colorado release. Work will continue to +and will provide a preliminary methodology for the Danube release. Work will continue to develop these test cases to establish a stand alone compliance evaluation solution in future releases. @@ -277,8 +278,10 @@ Some of the projects focused on these testing areas include: VSPERF ------ -VSPERF provides a generic and architecture agnostic vSwitch testing framework and associated tests. -This serves as a basis for validating the suitability of different vSwitch implementations and deployments. +VSPERF provides an automated test-framework and comprehensive test suite for measuring data-plane +performance of the NFVI including switching technology, physical and virtual network interfaces. +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 @@ -288,6 +291,6 @@ Bottlenecks provides a framework to find system limitations and bottlenecks, pro root cause isolation capabilities to facilitate system evaluation. -.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/configguide -.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide -.. _Dovetail project: https://wiki.opnfv.org/display/dovetail +.. _`OPNFV Configuration Guide`: `OPNFV User Guide & Configuration Guide` +.. _`OPNFV User Guide`: `OPNFV User Guide & Configuration Guide` +.. _`Dovetail project`: https://wiki.opnfv.org/display/dovetail