diff options
| -rw-r--r-- | docs/release/installation.introduction.rst | 26 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 35 |
2 files changed, 31 insertions, 30 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index ab043c4a2..3cf0963f8 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -1,5 +1,5 @@ .. 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) Sofia Wallin Ericsson AB ==================== @@ -12,7 +12,7 @@ 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 +The Colorado release can be installed using a tool from the following 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. @@ -24,9 +24,10 @@ 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, + +The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and it is important to understand your required target platform capabilities before installing and -configuring your target scenario. +configuring your scenarios. An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`. @@ -37,9 +38,10 @@ 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... +architectures and locations. Each scenario provides specific capabilities and/or components aimed at +solving 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 @@ -75,11 +77,11 @@ 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. +The basic deployment validation only addresses a small part of capabilities provided in +the platform and you may want to execute more exhaustive tests. Some investigation will be required to +select the right test suites to run on your platform. -Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below: +Many of the OPNFV test project provide user-guide documentation and installation instructions as listed below: - :ref:`Functest user guide <functest-userguide>` - :ref:`Yardstick user guide <yardstick-userguidde>` @@ -93,7 +95,7 @@ Security Notes ============== The following patches were applied to fix security issues discovered in opnfv -projects, during the c-release cycle. +projects, during the Colorado release cycle. - :ref:`Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>` - :ref:`Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index b4ebab25a..0408099db 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -1,5 +1,5 @@ .. 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) Sofia Wallin (sofia.wallin@ericssion.com) ====================================== @@ -11,27 +11,27 @@ 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 +industries. 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 +upstream open source projects such as KVM, OpenDaylight, or OpenStack, but to highlight the features and capabilities delivered through the OPNFV project. Introduction ============ -OPNFV provides a suite of scenarios, infrastructure depoyment options, which +OPNFV provides a suite of scenarios, infrastructure deployment 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. +This Guide intends to help users of the platform leverage the features and +capabilities delivered by the OPNFV project. -OPNFV Continuous Integration builds, deploys and tests combinations of virtual +OPNFVs' 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 +include components such as KVM, OpenDaylight, OpenStack, OVS, 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. @@ -39,20 +39,19 @@ can be leveraged by the OPNFV User community. Feature Overview ================ -The following links outline the feature deliveries from the participant OPNFV +The following links outline the feature deliverables from participating 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. +detailed descriptions about the delivered features including use cases, +implementation and configuration specifics. -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. +The following Configuration Guides and User Guides assume that the reader already has some +information about a given project's specifics and deliverables. These Guides +are intended to be used following the installation with an OPNFV installer +to allow users 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. +OPNFV wiki page at http://wiki.opnfv.org, for more details. -You can find project specific usage and Configuration information below: Feature Configuration Guides ============================ |