docs/Chapter3/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5
   6 Introduction
   7 ============
   8
   9 - These requirements are specific to the current release of ONAP.
  10   It is the initial release of requirements based on a merge of the Open-O
  11   and OpenECOMP requirements.
  12 - Requirements are identified as either MUST, MUST NOT, SHOULD, SHOULD NOT,
  13   or MAY as defined in RFC 2119.
  14 - Requirements should be targeted to a restricted set of nouns related
  15   to VNFs and within the control of the VNF provider. The current list
  16   of VNF Requirement targets is:
  17
  18     - The VNF
  19     - The VNFC
  20     - The VNF Provider
  21     - The VNF Heat Orchestration Template
  22     - The VNF Package
  23 - Chapter 4 contains the xNF requirements involving the design and
  24   development of xNFs. These requirements help VNFs/PNFs operate
  25   efficiently within a cloud environment. Requirements cover design,
  26   resiliency, security, modularity and DevOps.
  27 - Chapter 5 describes the different data models the xNF provider
  28   needs to understand.  There are currently 2 models described in this
  29   document:
  30
  31     - The first model is the onboarding package data model. This is a TOSCA
  32       model that will describe how all the elements passed from the VNF/PNF
  33       Provider to the Service provider should be formatted and packaged.
  34     - The second model is HEAT template used for orchestrating and
  35       instantiating virtual resources in an OpenStack environment.  At this
  36       time the HEAT files will be passed to the Service provider as a data
  37       element within the TOSCA onboarding package.
  38 - Chapter 6 details the requirements specific to an implementation.
  39   The current implementations documented are OpenStack and Azure.
  40 - Chapter 7 provides the comprehensive set of requirements for xNFs to
  41   be on-boarded, configured and managed by ONAP.
  42 - Chapter 8 is the appendix that provide a number of detailed data record
  43   formats. It also contains a list of the requirements that are listed
  44   in the other chapters as well as examples and models that are referenced
  45   throughout the rest of the chapters.