X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fplatformoverview%2Fintroduction.rst;h=eab30e9b1150a79ab765461e81387cad74f83ae2;hb=e042f556c6c25858f328cb6287c164b2514a2561;hp=6d7c4c2e7ba3acbe50a30d7d92ab971a9be52aac;hpb=9351f9aed9383b85173215cf892eef5b3fc44fc3;p=opnfvdocs.git diff --git a/docs/platformoverview/introduction.rst b/docs/platformoverview/introduction.rst index 6d7c4c2e7..eab30e9b1 100644 --- a/docs/platformoverview/introduction.rst +++ b/docs/platformoverview/introduction.rst @@ -1,64 +1,70 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Huawei + +.. ==> All actions still to be resolved during the review are marked "==>" in comments. + ============ Introduction ============ -The OPNFV project provides different kinds of output to its users: - -1. **Target Software Platform** - - This provides the software which will run as NFVI and VIM in an actual NFV deployment - It is an integrated solution of several other open source projects, e.g. OpenStack, - Linux, ODL. - -2. **Deployment Tools** - - So called installers help the user deploy target software on his hardware. - OPNFV provides multiple options to do this. - -3. **Test Cases and Framework** - - The target software platform can be verified and evaluated using these testcases. - Their goal is to show that the deployed platform is usable to run VNFs. - -4. **Documentation** - - OPNFV provides the necessary documents describing target software platform, deployment - tools, tests, etc. in their architecture and usage. - -5. **Requirements** - - OPNFV community works on requirements of open source projects used in OPNFV to - make these projects better suitable for NFV telco carrier use cases. - These requirements are described in requirement documents and also forwarded - to the "upstream" projects in the format required by these projects. - -6. **Community Labs** - - OPNFV creates lab environments not only for development of OPNFV, but also to help - build the NFV ecosystem. OPNFV labs follow a defined structure and configuration. - Some of the labs have their dedicated tasks in the development environment, some of - the labs will be provided for open use. - -**OPNFV Releases** +.. ==> take some more inputs from the marketing message + +OPNFV is an integration effort that takes outputs from several open source communities to build a NFV platform. This task of integration leads to providing different kinds of output to its users. + +The primary goal of the OPNFV project is the target software platform, which is a integrated solution +of a set of components/building blocks of the ETSI ISG NFV reference architecture. +In the Brahmaputra release, this is limited to the NFVI and VIM blocks. +OPNFV users will be able to deploy their VNFs there using some MANO solution. +The target software platform is integrated from a set of other open source components, +of which the biggest ones are OpenStack and SDN controllers. There are multiple combinations +possible and a subset is provided and tested by the Brahmaputra release. These subsets +are called here scenarios. + +Besides the target software platform, OPNFV provides a set of tools that helps the user +deploy this target software platform on a set of servers. These tools are installers. +Brahmaputra provides multiple options here. Naturally the different installers +have different capabilities, that is they support deployment of different scenarios. + +The installers allow users to deploy OPNFV target software platform on a bare metal environment +or a set of virtual machines. In both cases, some hosts (bare metal or virtual) will act +as controller nodes, while other hosts will be the compute nodes hosting the VNFs. +The installers use a separate server to control the deployment process. This server is called +"jump server" and is installed with the installer's software at the beginning of a deployment. +The jump server also can be bare metal or virtual. + +This configuration - jump servers and a set of typically 5 nodes to run the target software platform - +is also described as part of an OPNFV release. This allows the users to build their own labs +accordingly and deploy OPNFV easily. A lab compliant to this description sometimes is called +"Pharos-compliant" after the OPNFV project providing the lab description. + +Another major part of the OPNFV release is a testing framework and test cases. +This test framework allows users to verify their deployment of the OPNFV target software platform. +It will execute and test major functions of the platform relevant to NFV applications (VNFs) so +the user can be confident that VNFs can successfully run. + +OPNFV releases come with the necessary documentation describing +target software platform, deployment tools, test cases, etc. in their architecture, configuration and usage. +The most important documents here are configuration guides and user guides that help to set up +a OPNFV deployment and use it. + +The OPNFV project takes major effort to provide lab environments to the community. +The OPNFV community labs of course need to be Pharos-compliant. They are used for OPNFV development +tasks and release creation, but should also provide users with the opportunity to run their own +OPNFV tests. OPNFV community labs are not part of a OPNFV release. +Please find more information on the labs in the +`Pharos project documentation `_. + +We should also mention that OPNFV works on requirements of open source projects used in OPNFV to +make these projects better suitable for NFV telco carrier use cases. +These requirements are described in requirement documents and also forwarded +to the "upstream" projects in the format required by these projects. +These requirement documents are not bound to OPNFV releases. OPNFV bundles the target software, installers, documentation, test cases and lab -description to releases and provides documentation describing the scope and features -provided. - -Since OPNFV releases contain different options (e.g. for installers, SDN controllers, etc.) -We define a set of scenarios, that is a set of components, combinations -and associated configuration. -This set of scenarios shows which combinations of components and features are tested as -part of the OPNFV release. +description to releases. This overview document introduces these components and scenarios on a high level and -points you to more -detailed documentation. -It describes the OPNFV Brahmaputra release. +points you to more detailed documentation. -OPNFV Requirement documents typically describe requirements that will be implemented in -later releases of OPNFV. Thus they are not part of a release package. -Also community labs are independent of releases. Only the lab description is included in -the release and describes the requirements of a lab to successfully run Brahmaputra -deployments.