docs/Chapter3/index.rst

   1 .. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
   2
   3 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   4    (the "License"); you may not use this documentation except in compliance
   5    with the License. You may obtain a copy of the License at
   6
   7 .. https://creativecommons.org/licenses/by/4.0/
   8
   9 .. Unless required by applicable law or agreed to in writing, software
  10    distributed under the License is distributed on an "AS IS" BASIS,
  11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    See the License for the specific language governing permissions and
  13    limitations under the License.
  14
  15
  16 Introduction
  17 ============
  18
  19 - Requirements are identified as either MUST, MUST NOT, SHOULD, SHOULD NOT,
  20   or MAY as defined in RFC 2119.
  21 - Requirements should be targeted to a restricted set of nouns related
  22   to VNFs and within the control of the VNF provider. The current list
  23   of VNF Requirement targets is:
  24
  25     - The VNF
  26     - The VNFC
  27     - The VNF Provider
  28     - The VNF Heat Orchestration Template
  29     - The VNF Package
  30 - Chapter 4 contains the xNF requirements involving the design and
  31   development of xNFs. These requirements help VNFs/PNFs operate
  32   efficiently within a cloud environment. Requirements cover design,
  33   resiliency, security, modularity and DevOps.
  34 - Chapter 5 describes the different data models the xNF provider
  35   needs to understand.  There are currently 2 models described in this
  36   document:
  37
  38     - The first model is the onboarding package data model. This is a TOSCA
  39       model that will describe how all the elements passed from the VNF/PNF
  40       Provider to the Service provider should be formatted and packaged.
  41     - The second model is HEAT template used for orchestrating and
  42       instantiating virtual resources in an OpenStack environment.  At this
  43       time the HEAT files will be passed to the Service provider as a data
  44       element within the TOSCA onboarding package.
  45 - Chapter 6 details the requirements specific to an implementation.
  46   The current implementations documented are OpenStack and Azure.
  47 - Chapter 7 provides the comprehensive set of requirements for xNFs to
  48   be on-boarded, configured and managed by ONAP.
  49 - Chapter 8 is the appendix that provide a number of detailed data record
  50   formats. It also contains a list of the requirements that are listed
  51   in the other chapters as well as examples and models that are referenced
  52   throughout the rest of the chapters.