docs/platformoverview/introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) OPNFV, Huawei
   4
   5 .. ==> All actions still to be resolved during the review are marked "==>" in comments.
   6
   7 ============
   8 Introduction
   9 ============
  10
  11 .. ==> take some more inputs from the marketing message
  12
  13 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.
  14
  15 The primary goal of the OPNFV project is the target software platform, which is a integrated solution
  16 of a set of components/building blocks of the ETSI ISG NFV reference architecture.
  17 In the Brahmaputra release, this is limited to the NFVI and VIM blocks.
  18 OPNFV users will be able to deploy their VNFs there using some MANO solution.
  19 The target software platform is integrated from a set of other open source components,
  20 of which the biggest ones are OpenStack and SDN controllers. There are multiple combinations
  21 possible and a subset is provided and tested by the Brahmaputra release. These subsets
  22 are called here scenarios.
  23
  24 Besides the target software platform, OPNFV provides a set of tools that helps the user
  25 deploy this target software platform on a set of servers. These tools are installers.
  26 Brahmaputra provides multiple options here. Naturally the different installers
  27 have different capabilities, that is they support deployment of different scenarios.
  28
  29 The installers allow users to deploy OPNFV target software platform on a bare metal environment
  30 or a set of virtual machines. In both cases, some hosts (bare metal or virtual) will act
  31 as controller nodes, while other hosts will be the compute nodes hosting the VNFs.
  32 The installers use a separate server to control the deployment process. This server is called
  33 "jump server" and is installed with the installer's software at the beginning of a deployment.
  34 The jump server also can be bare metal or virtual.
  35
  36 This configuration - jump servers and a set of typically 5 nodes to run the target software platform -
  37 is also described as part of an OPNFV release. This allows the users to build their own labs
  38 accordingly and deploy OPNFV easily. A lab compliant to this description sometimes is called
  39 "Pharos-compliant" after the OPNFV project providing the lab description.
  40
  41 Another major part of the OPNFV release is a testing framework and test cases.
  42 This test framework allows users to verify their deployment of the OPNFV target software platform.
  43 It will execute and test major functions of the platform relevant to NFV applications (VNFs) so
  44 the user can be confident that VNFs can successfully run.
  45
  46 OPNFV releases come with the necessary documentation describing
  47 target software platform, deployment tools, test cases, etc. in their architecture, configuration and usage.
  48 The most important documents here are configuration guides and user guides that help to set up
  49 a OPNFV deployment and use it.
  50
  51 The OPNFV project takes major effort to provide lab environments to the community.
  52 The OPNFV community labs of course need to be Pharos-compliant. They are used for OPNFV development
  53 tasks and release creation, but should also provide users with the opportunity to run their own
  54 OPNFV tests. OPNFV community labs are not part of a OPNFV release.
  55 Please find more information on the labs in the
  56 `Pharos project documentation <http://artifacts.opnfv.org/pharos/brahmaputra/docs/index.html>`_.
  57
  58 We should also mention that OPNFV works on requirements of open source projects used in OPNFV to
  59 make these projects better suitable for NFV telco carrier use cases.
  60 These requirements are described in requirement documents and also forwarded
  61 to the "upstream" projects in the format required by these projects.
  62 These requirement documents are not bound to OPNFV releases.
  63
  64 OPNFV bundles the target software, installers, documentation, test cases and lab
  65 description to releases.
  66
  67 This overview document introduces these components and scenarios on a high level and
  68 points you to more detailed documentation.
  69
  70