docs/Chapter7/PNF-Plug-and-Play.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 PNF Plug and Play
  17 -----------------
  18
  19 PNF Plug and Play
  20 ^^^^^^^^^^^^^^^^^
  21
  22 The following are the requirements related to PNF Plug and Play.
  23
  24 .. req::
  25     :id: R-56718
  26     :target: PNF
  27     :keyword: MAY
  28     :introduced: casablanca
  29
  30     The PNF Vendor **MAY** provide software version(s) to be supported by PNF
  31     for SDC Design Studio PNF Model. This is set in the PNF Model property
  32     software_versions.
  33
  34 .. req::
  35     :id: R-106240
  36     :target: PNF
  37     :keyword: MUST
  38     :introduced: casablanca
  39     :updated: guilin
  40
  41     A PNF MUST support the pnfRegistration VES event which is required to integrate with ONAP’s PNF Plug and Play capabilities.
  42
  43 .. req::
  44     :id: R-258352
  45     :target: PNF
  46     :keyword: MUST
  47     :introduced: casablanca
  48
  49     The PNF **MUST** support & accept the provisioning of an ONAP contact IP
  50     address (in IPv4 or IPv6 format).
  51
  52     Note: For example, it a possibility is that an external EMS would configure
  53     & provision the ONAP contact IP address to the PNF (in either IPv4 or
  54     IPv6 format). For the PNF Plug and Play Use Case, this IP address is the
  55     service provider's "point of entry" to the DCAE VES Listener.
  56
  57     Note: different service provider's network architecture may also require
  58     special setup to allow an external PNF to contact the ONAP installation.
  59     For example, in the AT&T network, a maintenance tunnel is used to access
  60     ONAP.
  61
  62 .. req::
  63     :id: R-793716
  64     :target: PNF
  65     :keyword: MUST
  66     :introduced: casablanca
  67
  68     The PNF **MUST** have "ONAP Aware" software which is capable of performing
  69     PNF PnP registration with ONAP. The "ONAP Aware" software is capable of
  70     performing the PNF PnP Registration with ONAP MUST either be loaded
  71     separately or integrated into the PNF software upon physical delivery
  72     and installation of the PNF.
  73
  74     Note: It is up to the specific vendor to design the software management
  75     functions.
  76
  77 .. req::
  78     :id: R-952314
  79     :target: PNF
  80     :keyword: MUST
  81     :introduced: casablanca
  82
  83     If the PNF set up a TLS connection and mutual (two-way) authentication is
  84     being used, then the PNF **MUST** provide its own X.509v3 Certificate to
  85     the DCAE VES Collector for authentication.
  86
  87     Note: This allows TLS authentication by DCAE VES Collector.
  88
  89     Note: The PNF got its X.509 certificate through Enrollment with an
  90     operator certificate authority or a X.509 vendor certificate from the
  91     vendor factory CA.
  92
  93     Note: In R3 three authentication options are supported:
  94
  95     (1) HTTP with Username & Password and no TLS.
  96
  97     (2) HTTP with Username & Password & TLS with two-way certificate
  98         authentication.
  99
 100     (3) HTTP with Username & Password & TLS with server-side
 101         certificate authentication.
 102
 103 .. req::
 104     :id: R-809261
 105     :target: PNF
 106     :keyword: MUST
 107     :introduced: casablanca
 108
 109     The PNF **MUST** use a IP address to contact ONAP.
 110
 111     Note: it is expected that an ONAP operator can ascertain the ONAP IP
 112     address or the security gateway to reach ONAP on the VID or ONAP portal
 113     GUI.
 114
 115     Note: The ONAP contact IP address has been previously configured and
 116     provisioned prior to this step.
 117
 118     Note: The ONAP IP address could be provisioned or resolved through
 119     FQDN & DNS.
 120
 121 .. req::
 122     :id: R-763774
 123     :target: VNF or PNF
 124     :keyword: MUST
 125     :introduced: casablanca
 126     :updated: el alto
 127
 128     The VNF or PNF **MUST** support a HTTPS connection to the DCAE
 129     VES Event Listener.
 130
 131 .. req::
 132     :id: R-686466
 133     :target: PNF
 134     :keyword: MUST
 135     :introduced: casablanca
 136
 137     The PNF **MUST** support sending a pnfRegistration VES event.
 138
 139 .. req::
 140     :id: R-980039
 141     :target: PNF
 142     :keyword: MUST
 143     :introduced: casablanca
 144
 145     The PNF **MUST** send the pnfRegistration VES event periodically.
 146
 147 .. req::
 148     :id: R-981585
 149     :target: PNF
 150     :keyword: MUST
 151     :introduced: casablanca
 152
 153     The pnfRegistration VES event periodicity **MUST** be configurable.
 154
 155     Note: The PNF uses the service configuration request as a semaphore to
 156     stop sending the pnfRegistration sent. See the requirement PNP-5360
 157     requirement.
 158
 159 .. req::
 160     :id: R-284934
 161     :target: PNF
 162     :keyword: MAY
 163     :introduced: casablanca
 164
 165     If the PNF encounters an error authenticating, reaching the ONAP DCAE VES
 166     Event listener or recieves an error response from sending the pnfRegistration
 167     VES Event, it **MAY** log the error, and notify the operator.
 168
 169     Note: the design of how errors are logged, retrieved and reported
 170     will be a vendor-specific architecture. Reporting faults and errors
 171     is also a vendor specific design. It is expected that the PNF shall
 172     have a means to log an error and notify a user when a fault condition
 173     occurs in trying to contact ONAP, authenticate or send a pnfRegistration
 174     event.
 175
 176 .. req::
 177     :id: R-256347
 178     :target: PNF
 179     :keyword: MUST
 180     :introduced: casablanca
 181     :updated: dublin
 182
 183     The PNF **MUST** support one of the protocols for a Service Configuration
 184     message exchange between the PNF and PNF Controller (in ONAP):
 185     a) Netconf/YANG, b) Chef, or c) Ansible.
 186
 187     Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the
 188     PNF and PNF domain.
 189
 190 .. req::
 191     :id: R-707977
 192     :target: PNF
 193     :keyword: MUST
 194     :introduced: casablanca
 195
 196     When the PNF receives a Service configuration from ONAP, the PNF **MUST**
 197     cease sending the pnfRegistration VES Event.
 198
 199 .. req::
 200     :id: R-17624
 201     :target: PNF
 202     :keyword: MAY
 203     :introduced: casablanca
 204
 205     The PNF **MAY** support the optional parameters for Service
 206     Configuration Parameters.
 207
 208     Note: These are detailed in the Stage 5 PnP
 209
 210     Note: These parameters are optional, and not all PNFs will support any
 211     or all of these parameters, it is up to the vendor and service provider
 212     to ascertain which ones are supported up to an including all of the ones
 213     that have been defined. Note: It is expected that there will be a growing
 214     list of supported configuration parameters in future releases of ONAP.
 215
 216 .. req::
 217     :id: R-378131
 218     :target: PNF
 219     :keyword: MAY
 220     :introduced: casablanca
 221
 222     (Error Case) - If an error is encountered by the PNF during a
 223     Service Configuration exchange with ONAP, the PNF **MAY** log the
 224     error and notify an operator.
 225
 226 .. req::
 227     :id: R-638216
 228     :target: PNF
 229     :keyword: MUST
 230     :introduced: casablanca
 231
 232     (Error Case) - The PNF **MUST** support a configurable timer to stop the
 233     periodicity sending of the pnfRegistration VES event. If this timer expires
 234     during a Service Configuration exchange between the PNF and ONAP, it
 235     MAY log a time-out error and notify an operator.
 236
 237     Note: It is expected that each vendor will enforce and define a PNF
 238     service configuration timeout period. This is because the PNF cannot
 239     wait indefinitely as there may also be a technician on-site trying to
 240     complete installation & commissioning. The management of the VES event
 241     exchange is also a requirement on the PNF to be developed by the PNF
 242     vendor.
 243