docs/Chapter7/VNF-On-boarding-and-package-management.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 VNF On-boarding and package management
  17 --------------------------------------
  18
  19 Design Definition
  20 ^^^^^^^^^^^^^^^^^^
  21
  22 The ONAP Design Time Framework provides the ability to design NFV
  23 resources including VNFs, Services, and products. The VNF provider must
  24 provide VNF packages that include a rich set of recipes, management and
  25 functional interfaces, policies, configuration parameters, and
  26 infrastructure requirements that can be utilized by the ONAP Design
  27 module to onboard and catalog these resources. Initially this
  28 information may be provided in documents, but in the near future a
  29 method will be developed to automate as much of the transfer of data as
  30 possible to satisfy its long term requirements.
  31
  32 The current VNF Package Requirement is based on a subset of the
  33 Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
  34 and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
  35 (NFV), Management and Orchestration, VNF Packaging Specification.
  36
  37 Resource Description
  38 ^^^^^^^^^^^^^^^^^^^^^^
  39
  40
  41 .. req::
  42     :id: R-77707
  43     :target: XNF
  44     :keyword: MUST
  45
  46     The xNF provider **MUST** include a Manifest File that
  47     contains a list of all the components in the xNF package.
  48
  49 .. req::
  50     :id: R-66070
  51     :target: XNF
  52     :keyword: MUST
  53
  54     The xNF Package **MUST** include xNF Identification Data to
  55     uniquely identify the resource for a given xNF provider. The identification
  56     data must include: an identifier for the xNF, the name of the xNF as was
  57     given by the xNF provider, xNF description, xNF provider, and version.
  58
  59 .. req::
  60     :id: R-69565
  61     :target: XNF
  62     :keyword: MUST
  63
  64     The xNF Package **MUST** include documentation describing xNF
  65     Management APIs, which must include information and tools for ONAP to
  66     deploy and configure (initially and ongoing) the xNF application(s)
  67     (e.g., NETCONF APIs) which includes a description of configurable
  68     parameters for the xNF and whether the parameters can be configured
  69     after xNF instantiation.
  70
  71 .. req::
  72     :id: R-00156
  73     :target: XNF
  74     :keyword: MUST
  75
  76     The xNF Package **MUST** include documentation describing xNF
  77     Management APIs, which must include information and tools for
  78     ONAP to monitor the health of the xNF (conditions that require
  79     healing and/or scaling responses).
  80
  81 .. req::
  82     :id: R-00068
  83     :target: XNF
  84     :keyword: MUST
  85
  86     The xNF Package **MUST** include documentation which includes
  87     a description of parameters that can be monitored for the xNF
  88     and event records (status, fault, flow, session, call, control
  89     plane, etc.) generated by the xNF after instantiation.
  90
  91 .. req::
  92     :id: R-12678
  93     :target: XNF
  94     :keyword: MUST
  95
  96     The xNF Package **MUST** include documentation which includes a
  97     description of runtime lifecycle events and related actions (e.g.,
  98     control responses, tests) which can be performed for the xNF.
  99
 100 .. req::
 101     :id: R-84366
 102     :target: XNF
 103     :keyword: MUST
 104
 105     The xNF Package **MUST** include documentation describing
 106     xNF Functional APIs that are utilized to build network and
 107     application services. This document describes the externally exposed
 108     functional inputs and outputs for the xNF, including interface
 109     format and protocols supported.
 110
 111 .. req::
 112     :id: R-36280
 113     :target: XNF
 114     :keyword: MUST
 115
 116     The xNF provider **MUST** provide documentation describing
 117     xNF Functional Capabilities that are utilized to operationalize the
 118     xNF and compose complex services.
 119
 120 .. req::
 121     :id: R-98617
 122     :target: XNF
 123     :keyword: MUST
 124
 125     The xNF provider **MUST** provide information regarding any
 126     dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
 127
 128 .. req::
 129     :id: R-22346
 130     :target: VNF PACKAGE
 131     :keyword: MUST
 132     :introduced: casablanca
 133     :validation_mode: static
 134
 135     The VNF package MUST provide `VES Event Registration <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventRegistration.html>`_ for all VES events provided by that xNF.
 136
 137
 138 Resource Configuration
 139 ^^^^^^^^^^^^^^^^^^^^^^^
 140
 141
 142 .. req::
 143     :id: R-89571
 144     :target: XNF
 145     :keyword: MUST
 146
 147     The xNF **MUST** support and provide artifacts for configuration
 148     management using at least one of the following technologies;
 149     a) Netconf/YANG, b) Chef, or c) Ansible.
 150
 151     Note: The requirements for Netconf/YANG, Chef, and Ansible protocols
 152     are provided separately and must be supported only if the corresponding
 153     protocol option is provided by the xNF providor.
 154
 155
 156 Configuration Management via NETCONF/YANG
 157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 .. req::
 160     :id: R-30278
 161     :target: XNF
 162     :keyword: MUST
 163
 164     The xNF provider **MUST** provide a Resource/Device YANG model
 165     as a foundation for creating the YANG model for configuration. This will
 166     include xNF attributes/parameters and valid values/attributes configurable
 167     by policy.
 168
 169 Configuration Management via Chef
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172
 173 .. req::
 174     :id: R-13390
 175     :target: XNF
 176     :keyword: MUST
 177
 178     The xNF provider **MUST** provide cookbooks to be loaded
 179     on the appropriate Chef Server.
 180
 181 .. req::
 182     :id: R-18525
 183     :target: XNF
 184     :keyword: MUST
 185
 186     The xNF provider **MUST** provide a JSON file for each
 187     supported action for the xNF. The JSON file must contain key value
 188     pairs with all relevant values populated with sample data that illustrates
 189     its usage. The fields and their description are defined in Tables A1
 190     and A2 in the Appendix.
 191
 192     Note: Chef support in ONAP is not currently available and planned for 4Q 2017.
 193
 194
 195 Configuration Management via Ansible
 196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 197
 198
 199 .. req::
 200     :id: R-75608
 201     :target: XNF
 202     :keyword: MUST
 203
 204     The xNF provider **MUST** provide playbooks to be loaded
 205     on the appropriate Ansible Server.
 206
 207 .. req::
 208     :id: R-16777
 209     :target: XNF
 210     :keyword: MUST
 211
 212     The xNF provider **MUST** provide a JSON file for each
 213     supported action for the xNF. The JSON file must contain key value
 214     pairs with all relevant values populated with sample data that illustrates
 215     its usage. The fields and their description are defined in Table B1
 216     in the Appendix.
 217
 218 .. req::
 219     :id: R-46567
 220     :target: XNF
 221     :keyword: MUST
 222
 223     The xNF Package **MUST** include configuration scripts
 224     for boot sequence and configuration.
 225
 226 .. req::
 227     :id: R-16065
 228     :target: XNF
 229     :keyword: MUST
 230
 231     The xNF provider **MUST** provide configurable parameters
 232     (if unable to conform to YANG model) including xNF attributes/parameters
 233     and valid values, dynamic attributes and cross parameter dependencies
 234     (e.g., customer provisioning data).
 235
 236 Resource Control Loop
 237 ^^^^^^^^^^^^^^^^^^^^^^^
 238
 239
 240 .. req::
 241     :id: R-22888
 242     :target: XNF
 243     :keyword: MUST
 244
 245     The xNF provider **MUST** provide documentation for the xNF
 246     Policy Description to manage the xNF runtime lifecycle. The document
 247     must include a description of how the policies (conditions and actions)
 248     are implemented in the xNF.
 249
 250 .. req::
 251     :id: R-01556
 252     :target: XNF
 253     :keyword: MUST
 254
 255     The xNF Package **MUST** include documentation describing the
 256     fault, performance, capacity events/alarms and other event records
 257     that are made available by the xNF.
 258
 259 .. req::
 260     :id: R-16875
 261     :target: XNF
 262     :keyword: MUST
 263
 264     The xNF Package **MUST** include documentation which must include
 265     a unique identification string for the specific xNF, a description of
 266     the problem that caused the error, and steps or procedures to perform
 267     Root Cause Analysis and resolve the issue.
 268
 269 .. req::
 270     :id: R-35960
 271     :target: XNF
 272     :keyword: MUST
 273
 274     The xNF Package **MUST** include documentation which must include
 275     all events, severity level (e.g., informational, warning, error) and
 276     descriptions including causes/fixes if applicable for the event.
 277
 278 .. req::
 279     :id: R-42018
 280     :target: XNF
 281     :keyword: MUST
 282
 283     The xNF Package **MUST** include documentation which must include
 284     all events (fault, measurement for xNF Scaling, Syslogs, State Change
 285     and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html>`__ ) and for the overall xNF.
 286
 287 .. req::
 288     :id: R-27711
 289     :target: XNF
 290     :keyword: MUST
 291
 292     The xNF provider **MUST** provide an XML file that contains a
 293     list of xNF error codes, descriptions of the error, and possible
 294     causes/corrective action.
 295
 296 .. req::
 297     :id: R-01478
 298     :target: XNF
 299     :keyword: MUST
 300
 301     The xNF Package **MUST** include documentation describing all
 302     parameters that are available to monitor the xNF after instantiation
 303     (includes all counters, OIDs, PM data, KPIs, etc.) that must be
 304     collected for reporting purposes.
 305
 306 .. req::
 307     :id: R-73560
 308     :target: XNF
 309     :keyword: MUST
 310
 311     The xNF Package **MUST** include documentation about monitoring
 312     parameters/counters exposed for virtual resource management and xNF
 313     application management.
 314
 315 .. req::
 316     :id: R-90632
 317     :target: XNF
 318     :keyword: MUST
 319
 320     The xNF Package **MUST** include documentation about KPIs and
 321     metrics that need to be collected at each VM for capacity planning
 322     and performance management purposes.
 323
 324 .. req::
 325     :id: R-86235
 326     :target: XNF
 327     :keyword: MUST
 328
 329     The xNF Package **MUST** include documentation about the monitoring
 330     parameters that must include latencies, success rates, retry rates, load
 331     and quality (e.g., DPM) for the key transactions/functions supported by
 332     the xNF and those that must be exercised by the xNF in order to perform
 333     its function.
 334
 335 .. req::
 336     :id: R-33904
 337     :target: XNF
 338     :keyword: MUST
 339
 340     The xNF Package **MUST** include documentation for each KPI, provide
 341     lower and upper limits.
 342
 343 .. req::
 344     :id: R-53598
 345     :target: XNF
 346     :keyword: MUST
 347
 348     The xNF Package **MUST** include documentation to, when relevant,
 349     provide a threshold crossing alert point for each KPI and describe the
 350     significance of the threshold crossing.
 351
 352 .. req::
 353     :id: R-69877
 354     :target: XNF
 355     :keyword: MUST
 356
 357     The xNF Package **MUST** include documentation for each KPI,
 358     identify the suggested actions that need to be performed when a
 359     threshold crossing alert event is recorded.
 360
 361 .. req::
 362     :id: R-22680
 363     :target: XNF
 364     :keyword: MUST
 365
 366     The xNF Package **MUST** include documentation that describes
 367     any requirements for the monitoring component of tools for Network
 368     Cloud automation and management to provide these records to components
 369     of the xNF.
 370
 371 .. req::
 372     :id: R-33694
 373     :target: XNF
 374     :keyword: MUST
 375
 376     The xNF Package **MUST** include documentation to when applicable,
 377     provide calculators needed to convert raw data into appropriate reporting
 378     artifacts.
 379
 380 .. req::
 381     :id: R-56815
 382     :target: XNF
 383     :keyword: MUST
 384
 385     The xNF Package **MUST** include documentation describing
 386     supported xNF scaling capabilities and capacity limits (e.g., number
 387     of users, bandwidth, throughput, concurrent calls).
 388
 389 .. req::
 390     :id: R-48596
 391     :target: XNF
 392     :keyword: MUST
 393
 394     The xNF Package **MUST** include documentation describing
 395     the characteristics for the xNF reliability and high availability.
 396
 397 .. req::
 398     :id: R-74763
 399     :target: XNF
 400     :keyword: MUST
 401
 402     The xNF provider **MUST** provide an artifact per xNF that contains
 403     all of the xNF Event Records supported. The artifact should include
 404     reference to the specific release of the xNF Event Stream Common Event
 405     Data Model document it is based on. (e.g.,
 406     `VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)
 407
 408 Compute, Network, and Storage Requirements
 409 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 410
 411
 412 .. req::
 413     :id: R-35851
 414     :target: XNF
 415     :keyword: MUST
 416
 417     The xNF Package **MUST** include xNF topology that describes
 418     basic network and application connectivity internal and external to the
 419     xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if
 420     applicable) for each interface.
 421
 422 .. req::
 423     :id: R-97102
 424     :target: VNF
 425     :keyword: MUST
 426
 427     The VNF Package **MUST** include VM requirements via a Heat
 428     template that provides the necessary data for VM specifications
 429     for all VNF components - for hypervisor, CPU, memory, storage.
 430
 431 .. req::
 432     :id: R-20204
 433     :target: VNF
 434     :keyword: MUST
 435
 436     The VNF Package **MUST** include VM requirements via a Heat
 437     template that provides the necessary data for network connections,
 438     interface connections, internal and external to VNF.
 439
 440 .. req::
 441     :id: R-44896
 442     :target: VNF
 443     :keyword: MUST
 444
 445     The VNF Package **MUST** include VM requirements via a Heat
 446     template that provides the necessary data for high availability
 447     redundancy model.
 448
 449 .. req::
 450     :id: R-55802
 451     :target: VNF
 452     :keyword: MUST
 453
 454     The VNF Package **MUST** include VM requirements via a Heat
 455     template that provides the necessary data for scaling/growth VM
 456     specifications.
 457
 458     Note: Must comply with the *Heat requirements in 5.b*.
 459
 460 .. req::
 461     :id: R-26881
 462     :target: XNF
 463     :keyword: MUST
 464
 465     The xNF provider **MUST** provide the binaries and images
 466     needed to instantiate the xNF (xNF and VNFC images).
 467
 468 .. req::
 469     :id: R-96634
 470     :target: XNF
 471     :keyword: MUST
 472
 473     The xNF provider **MUST** describe scaling capabilities
 474     to manage scaling characteristics of the xNF.
 475
 476 Testing
 477 ^^^^^^^^^^
 478
 479
 480 .. req::
 481     :id: R-43958
 482     :target: XNF
 483     :keyword: MUST
 484     :updated: casablanca
 485
 486     The xNF Package **MUST** include documentation describing
 487     the tests that were conducted by the xNF provider and the test results.
 488
 489 .. req::
 490     :id: R-04298
 491     :target: XNF
 492     :keyword: MUST
 493
 494     The xNF provider **MUST** provide their testing scripts to
 495     support testing.
 496
 497 .. req::
 498     :id: R-58775
 499     :target: XNF
 500     :keyword: MUST
 501
 502     The xNF provider **MUST** provide software components that
 503     can be packaged with/near the xNF, if needed, to simulate any functions
 504     or systems that connect to the xNF system under test. This component is
 505     necessary only if the existing testing environment does not have the
 506     necessary simulators.
 507
 508 Licensing Requirements
 509 ^^^^^^^^^^^^^^^^^^^^^^^
 510
 511
 512 .. req::
 513     :id: R-85653
 514     :target: XNF
 515     :keyword: MUST
 516
 517     The xNF **MUST** provide metrics (e.g., number of sessions,
 518     number of subscribers, number of seats, etc.) to ONAP for tracking
 519     every license.
 520
 521 .. req::
 522     :id: R-44125
 523     :target: XNF
 524     :keyword: MUST
 525
 526     The xNF provider **MUST** agree to the process that can
 527     be met by Service Provider reporting infrastructure. The Contract
 528     shall define the reporting process and the available reporting tools.
 529
 530 .. req::
 531     :id: R-40827
 532     :target: XNF
 533     :keyword: MUST
 534
 535     The xNF provider **MUST** enumerate all of the open
 536     source licenses their xNF(s) incorporate.
 537
 538 .. req::
 539     :id: R-97293
 540     :target: XNF
 541     :keyword: MUST NOT
 542
 543     The xNF provider **MUST NOT** require audits
 544     of Service Provider's business.
 545
 546 .. req::
 547     :id: R-44569
 548     :target: XNF
 549     :keyword: MUST NOT
 550
 551     The xNF provider **MUST NOT** require additional
 552     infrastructure such as a xNF provider license server for xNF provider
 553     functions and metrics.
 554
 555 .. req::
 556     :id: R-13613
 557     :target: VNF
 558     :keyword: MUST
 559
 560     The VNF **MUST** provide clear measurements for licensing
 561     purposes to allow automated scale up/down by the management system.
 562
 563 .. req::
 564     :id: R-27511
 565     :target: VNF
 566     :keyword: MUST
 567
 568     The VNF provider **MUST** provide the ability to scale
 569     up a VNF provider supplied product during growth and scale down a
 570     VNF provider supplied product during decline without "real-time"
 571     restrictions based upon VNF provider permissions.
 572
 573 .. req::
 574     :id: R-85991
 575     :target: XNF
 576     :keyword: MUST
 577
 578     The xNF provider **MUST** provide a universal license key
 579     per xNF to be used as needed by services (i.e., not tied to a VM
 580     instance) as the recommended solution. The xNF provider may provide
 581     pools of Unique xNF License Keys, where there is a unique key for
 582     each xNF instance as an alternate solution. Licensing issues should
 583     be resolved without interrupting in-service xNFs.
 584
 585 .. req::
 586     :id: R-47849
 587     :target: XNF
 588     :keyword: MUST
 589
 590     The xNF provider **MUST** support the metadata about
 591     licenses (and their applicable entitlements) as defined in this
 592     document for xNF software, and any license keys required to authorize
 593     use of the xNF software.  This metadata will be used to facilitate
 594     onboarding the xNF into the ONAP environment and automating processes
 595     for putting the licenses into use and managing the full lifecycle of
 596     the licenses. The details of this license model are described in
 597     Tables C1 to C8 in the Appendix.
 598
 599     Note: License metadata support in ONAP is not currently available
 600     and planned for 1Q 2018.
 601