From d438301ca7244e66d5082312e3e84fcfb219f11b Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Wed, 23 Nov 2016 14:49:15 +0100 Subject: Adjusted the docs repo structure for D release work Change-Id: I9befe06c424c726e17d754bc480413b2430549ba Signed-off-by: Sofia Wallin --- docs/release/index.rst | 208 +++++++++++++++++++++ docs/release/installation.introduction.rst | 104 +++++++++++ docs/release/overview.rst | 290 +++++++++++++++++++++++++++++ docs/release/userguide.introduction.rst | 85 +++++++++ 4 files changed, 687 insertions(+) create mode 100644 docs/release/index.rst create mode 100644 docs/release/installation.introduction.rst create mode 100644 docs/release/overview.rst create mode 100644 docs/release/userguide.introduction.rst (limited to 'docs/release') diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 000000000..6f3ee54b8 --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,208 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +******************* +OPNFV Documentation +******************* + +============================== +Colorado Release Documentation +============================== + +OPNFV release documentation is structured with brief platform-level documents referencing +more detailed installation instructions and descriptive documentation. + +Platform documentation +====================== + +* `OPNFV platform overview document `_ +* `OPNFV Installation instruction `_ +* `OPNFV user guide `_ + +Installation instructions +========================= + +* `Apex installation instruction `_ +* `Apex release notes `_ +* `Compass installation instruction `_ +* `Compass release notes `_ +* `Fuel installation instruction `_ +* `Fuel release notes `_ +* `Joid installation instruction `_ +* `Joid release notes `_ + +Feature project documentation +============================= + +--------------- +ARMband project +--------------- + +* `Installation instruction `_ +* `Release notes `_ + +---------------------------------------------- +Copper release documentation +---------------------------------------------- + +* `Design documentation `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +----------------------------------------------------- +Doctor features and capabilities +----------------------------------------------------- + +* `Project overview `_ +* `User guide `_ +* `Release notes `_ + +---------------------------------------------------------------- +Domino features and capabilities +---------------------------------------------------------------- + +* `User guide `_ + +------------------------------------------------- +FastDataStacks feature and scenario documentation +------------------------------------------------- + +* `OpenDaylight integrated fd.io scenario description `_ + +------------------------------------ +IPv6 platform support and capability +------------------------------------ + +* `Configuration guide `_ +* `User guide `_ + +----------- +KVM for NFV +----------- + +* `Installation instruction `_ +* `Configuration guide `_ +* `User guide `_ +* `Release notes `_ + +-------------------------------- +MOON security management for NFV +-------------------------------- + +* `Project and Scenario overview `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +---------------------------- +Multisite datacenter project +---------------------------- + +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +------------------------- +Network readiness project +------------------------- + +* `Requirements document `_ + +---------------------- +ONOS framework project +---------------------- + +* `Installation instruction `_ +* `User guide `_ + +---------------------------- +OVSNFV release documentation +---------------------------- + +* `OVS for NFV scenario description `_ +* `Configuration guide `_ +* `User guide `_ + +-------------- +Parser project +-------------- + +* `Parser release documentation `_ +* `Installation instruction `_ +* `User guide `_ + +------ +Pharos +------ + +* `Pharos specification `_ +* `Configuration guide `_ + +------- +Promise +------- + +* `Requirement specification `_ +* `Installation and configuration guide `_ +* `User guide `_ + +------ +SDNVPN +------ + +* `BGPVPN scenario description `_ +* `User guide `_ +* `Release notes `_ + +--- +SFC +--- + +* `Design documentation `_ +* `SFC scenario description `_ +* `High availability SFC scenario description `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +------------------------------------------------ +Software fast-path quality metrics documentation +------------------------------------------------ + +* `Release and development documentation `_ + + +Test Project documentation +========================== + +------------------------- +Bottlenecks documentation +------------------------- + +* `Installation instruction `_ +* `Release notes `_ + +---------------------- +Functest documentation +---------------------- + +* `Configuration guide `_ +* `User guide `_ +* `Developer guide `_ +* `Release notes `_ + +------------------------- +vSwitchPerf documentation +------------------------- + +* `Release and development documentation `_ + +----------------------- +Yardstick documentation +----------------------- + +* `User guide `_ +* `Release notes `_ + diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst new file mode 100644 index 000000000..201112cad --- /dev/null +++ b/docs/release/installation.introduction.rst @@ -0,0 +1,104 @@ +.. 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 `_ +- 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 `_ +- Accelerated KVM hypervisor `os-nosdn-kvm-ha `_ +- LXD container hypervisor `os-nosdn-lxd-noha `_ +- High Availability LXD container hypervisor `os-nosdn-lxd-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 `_ +- `Storage Performance Benchmarking for NFVI (StorPerf) user guide `_ + +============== +Security Notes +============== + +The following patches were applied to fix security issues discovered in opnfv +projects, during the c-release cycle. + +- `Removal of private keys `_ +- `Fix security issues of eval-s in testapi `_ +- `Implements use of yaml.safe_load `_ +- `Fix security issues reported by the security audit `_ +- `Fix issues found in security review `_ +- `Removing OpenSteak Project `_ +- `Remove unsed files in open-contrail role `_ +- `Get rid of private key in repo `_ +- `Handling file loads and tmp dirs differently `_ +- `Remove `Debug = True when run Flask and add logger `_ diff --git a/docs/release/overview.rst b/docs/release/overview.rst new file mode 100644 index 000000000..cd1b5d0f9 --- /dev/null +++ b/docs/release/overview.rst @@ -0,0 +1,290 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +============ +Introduction +============ + +Network Functions Virtualization (NFV) is transforming the networking industry via +software-defined infrastructures and open source is the proven method for developing +software quickly for commercial products and services that can move markets. +Open Platform for NFV (OPNFV) facilitates the development and evolution of NFV +components across various open source ecosystems. Through system level integration, +deployment and testing, OPNFV constructs a reference NFV platform to accelerate the +transformation of enterprise and service provider networks. +As an open source project, OPNFV is uniquely positioned to bring together the work +of standards bodies, open source communities, and commercial suppliers to deliver a +de facto NFV platform for the industry. + +By integrating components from upstream projects, the community is able to conduct performance +and use case-based testing on a variety of solutions to ensure the platform’s suitability for +NFV use cases. OPNFV also works upstream with other open source communities to bring both contributions +and learnings from its work directly to those communities in the form of blueprints, patches, +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, +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. + +These capabilities, along with application programmable interfaces (APIs) to other NFV +elements, form the basic infrastructure required for Virtualized Network Functions (VNF) +and MANO components. + +Concentrating on these components while also considering proposed projects on additional +topics (such as the MANO components and applications themselves), OPNFV aims to enhance +NFV services by increasing performance and power efficiency improving reliability, +availability and serviceability, and delivering comprehensive platform instrumentation. + +=========================== +OPNFV Platform Architecture +=========================== + +The OPNFV project addresses a number of aspects in the development of a consistent virtualisation +platform including common hardware requirements, software architecture, MANO and applications. + + +OPNFV Platform Overview Diagram + +.. image:: ../images/opnfvplatformgraphic.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 + +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 `_ +which provides a set of defined lab infrastructures over a geographically and technically +diverse federated global OPNFV lab. + +Labs may instantiate bare-metal and virtual environments that are accessed remotely by the +community and used for OPNFV platform and feature development, build, deploy and testing. +No two labs are the same and the heterogeneity of the Pharos environment provides the ideal +platform for establishing hardware and software abstractions providing well understood +performance characteristics. + +Community labs are hosted by OPNFV member companies on a voluntary basis. +The Linux Foundation also hosts an OPNFV lab that provides centralized CI +and other production resources which are linked to community labs. +Future lab capabilities will include the ability easily automate deploy and test of any +OPNFV install scenario in any lab environment as well as on a nested "lab as a service" +virtual infrastructure. + +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. + +--------------------------------- +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 +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 + +----------------- +Operating Systems +----------------- + +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. + +----------------------- +Networking Technologies +----------------------- + +SDN Controllers +--------------- + +OPNFV, as an NFV focused project, has a significant investment on networking technologies +and provides a broad variety of integrated open source reference solutions. The diversity +of controllers able to be used in OPNFV is supported by a similarly diverse set of +forwarding technologies. + +There are many SDN controllers available today relevant to virtual environments +where the OPNFV community supports and contributes to a number of these. The controllers +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). +* 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 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 +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. + +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 +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 + +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 +is provided by a virtual machine and allows control and workload placement using nested virtualization. + +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. + +=========================== +The OPNFV Testing Ecosystem +=========================== + +The OPNFV community has set out to address the needs of virtualization in the carrier +network and as such platform validation and measurements are a cornerstone to the +iterative releases and objectives. + +To simplify the complex task of feature, component and platform validation and characterization +the testing community has established a fully automated method for addressing all key areas of +platform validation. This required the integration of a variety of testing frameworks in our CI +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 + +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. + +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 fulfill the release criteria. + +-------- +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 `_. + +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 +platform are running successfully. + +--------- +Yardstick +--------- + +Yardstick is a testing project for verifying the infrastructure compliance when running VNF applications. +Yardstick benchmarks a number of characteristics and performance vectors on the infrastructure making it +a valuable pre-deployment NFVI testing tools. + +Yardstick provides a flexible testing framework for launching other OPNFV testing projects. + +There are two types of test cases in Yardstick: + +* Yardstick generic test cases and OPNFV feature test cases; + including basic characteristics benchmarking in compute/storage/network area. +* OPNFV feature test cases include basic telecom feature testing from OPNFV projects; + for example nfv-kvm, sfc, ipv6, Parser, Availability and SDN VPN + +System Evaluation and compliance testing +======================================== + +The OPNFV community is developing a set of test suites intended to evaluate a set of reference +behaviors and capabilities for NFV systems developed externally from the OPNFV ecosystem to +evaluate and measure their ability to provide the features and capabilities developed in the +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 +develop these test cases to establish a stand alone compliance evaluation solution +in future releases. + +Additional Testing +================== + +Besides the test suites and cases for release verification, additional testing is performed to validate +specific features or characteristics of the OPNFV platform. +These testing framework and test cases may include some specific needs; such as extended measurements, +additional testing stimuli, or tests simulating environmental disturbances or failures. + +These additional testing activities provide a more complete evaluation of the OPNFV platform. +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. + +----------- +Bottlenecks +----------- + +Bottlenecks provides a framework to find system limitations and bottlenecks, providing +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 diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst new file mode 100644 index 000000000..48112e78e --- /dev/null +++ b/docs/release/userguide.introduction.rst @@ -0,0 +1,85 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Sofia Wallin (sofia.wallin@ericssion.com) + +======== +Abstract +======== + +OPNFV is a collaborative project aimed at providing a variety of virtualization +deployments intended to host applications serving the networking and carrier +industry. This document provides guidance and instructions for using platform +features designed to support these applications, made available in the OPNFV +Colorado release. + +This document is not intended to replace or replicate documentation from other +open source projects such as OpenStack or OpenDaylight, rather highlight the +features and capabilities delivered through the OPNFV project. + +============ +Introduction +============ + +OPNFV provides a suite of scenarios, infrastructure depoyment options, which +are able to be installed to host virtualized network functions (VNFs). +This guide intends to help users of the platform leverage the features and +capabilities delivered by the OPNFV project in support of these applications. + +OPNFV Continuous Integration builds, deploys and tests combinations of virtual +infrastructure components in what are defined as scenarios. A scenario may +include components such as OpenStack, OpenDaylight, OVS, KVM etc. where each +scenario will include different source components or configurations. Scenarios +are designed to enable specific features and capabilities in the platform that +can be leveraged by the OPNFV user community. + +================ +Feature Overview +================ + +The following links outline the feature deliveries from the participant OPNFV +projects in the Colorado release. Each of the participating projects provides +detailed descriptions about the delivered features. Including use cases, +implementation and configuration specifics on a per OPNFV project basis. + +The following are Configuration Guides and User Guides and assume that the reader has already some +information about a given projects specifics and deliverables. These guides +are intended to be used following the installation of a given OPNFV installer +to allow a user to deploy and implement feature delivered by OPNFV. + +If you are unsure about the specifics of a given project, please refer to the +OPNFV projects home page, found on http://wiki.opnfv.org, for specific details. + +You can find project specific usage and configuration information below: + +Feature Configuration Guides +============================ + +- `Armband configuration guide `_ +- `Copper configuration guide `_ +- `Doctor configuration guide `_ +- `IPv6 configuration guide `_ +- `KVMforNFV configuration guide `_ +- `Moon configuration guide `_ +- `Multisite configuration guide `_ +- `ONOSFW configuration guide `_ +- `OVSNFV configuration guide `_ +- `Promise configuration guide `_ +- `SFC configuration guide `_ + + +Feature User Guides +=================== + +- `Copper user guide `_ +- `Doctor user guide `_ +- `Domino user guide `_ +- `IPv6 user guide `_ +- `KVMforNFV user guide `_ +- `Moon user guide `_ +- `Multisite user guide `_ +- `ONOSFW user guide `_ +- `OVSNFV user guide `_ +- `Parser user guide `_ +- `Promise user guide `_ +- `SDNVPN user guide `_ +- `SFC user guide `_ -- cgit 1.2.3-korg