From bdeaf3f6beb1be54c14ccfa46576959ee6d4067c Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Mon, 15 Aug 2016 15:20:50 +0200 Subject: WIP: Created 2 introduction documents for user guide and installation Work on the contant in both installation and user guide Started to add artifacts in the installation instruction and user guide This is a first draft of the installation.introduction.rst and userguide.introduction.rst. Some of the information has been reused from the Brahmaputra docs with modifications. Please comment and add as needed/wanted. Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e Signed-off-by: Sofia Wallin (cherry picked from commit e042f556c6c25858f328cb6287c164b2514a2561) --- .../installation.introduction.rst | 84 ++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 docs/installationprocedure/installation.introduction.rst (limited to 'docs/installationprocedure/installation.introduction.rst') diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst new file mode 100644 index 000000000..ae4a601ae --- /dev/null +++ b/docs/installationprocedure/installation.introduction.rst @@ -0,0 +1,84 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) Sofia Wallin Ericsson AB + +======== +Abstract +======== + +The following document provides an overview of the instructions required for the installation +of the Colorado release of OPNFV. + +The Colorado release can be installed using a variety of technologies provided by the +integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID. +Each installer provides the ability to install a common OPNFV platform as well as integrating +additional features delivered through a variety of scenarios by the OPNFV community. + +============ +Introduction +============ + +The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical +infrastructure. A composition of components, tools and configurations is identified in OPNFV as a +deployment scenario. +The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, +it is important to understand your required target platform capabilities before installing and +configuring your target scenario. + +An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined +in the `Pharos specification `_. +When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. + +========= +Scenarios +========= + +OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment +architectures and locations. Each scenario provides specific capabilities and/or components aimed to +solve specific problems for the deployment of VNF’s. +A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc... +where each scenario will include different source components or configurations. + +To learn more about the scenarios supported in the Colorado release refer to the scenario +description documents provided: + +- Accelerated OVS `os-nosdn-ovs `_ +- FD.io based forwarding `os-nosdn-fdio-noha `_ +- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn `_ +- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha `_ +- High availability service function chaining `os-odl-l2-sfc-ha `_ +- Service function chaining `os-odl-l2-sfc-noha `_ +- `os-odl-l2-moon-ha `_ + +====================== +Installation Procedure +====================== + +Detailed step by step instructions for working with an installation toolchain and installing +the required scenario are provided by each installation project. The four projects providing installation +support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid. + +The instructions for each toolchain can be found in these links: + +- `Apex installation instruction `_ +- `Compass4nfv installation instruction `_ +- `Fuel installation instruction `_ +- `Joid installation instruction `_ + +===================== +OPNFV Test Frameworks +===================== + +If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV +your system will have been validated once the installation is completed. +The basic deployment validation only addresses a small component of the capability provided in +the platform and you may desire to execute more exhaustive tests. Some investigation is required to +select the right test suites to run on your platform from the available projects and suites. + +Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below: + +- `Functest user guide `_ +- `Yardstick user guide `_ +- `vSwitchPerf user guide `_ +- `Software Fastpath Service Quality Metrics (SFQM) user guide `_ +- `Bottlenecks user guide `_ -- cgit 1.2.3-korg