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.
6 **ONAP Management Requirements**
7 =====================================
9 The ONAP platform is the part of the larger Network Function
10 Virtualization/Software Defined Network (NFV/SDN) ecosystem that
11 is responsible for the efficient control, operation and management
12 of Virtual Network Function (VNF) capabilities and functions. It
13 specifies standardized abstractions and interfaces that enable
14 efficient interoperation of the NVF/SDN ecosystem components. It
15 enables product/service independent capabilities for design, creation
16 and runtime lifecycle management (includes all aspects of installation,
17 change management, assurance, and retirement) of resources in NFV/SDN
18 environment (see ECOMP white paper ). These capabilities are provided
19 using two major architectural frameworks: (1) a Design Time Framework
20 to design, define and program the platform (uniform onboarding), and
21 (2) a Runtime Execution Framework to execute the logic programmed in
22 the design environment (uniform delivery and runtime lifecycle
23 management). The platform delivers an integrated information model
24 based on the VNF package to express the characteristics and behavior
25 of these resources in the Design Time Framework. The information model
26 is utilized by Runtime Execution Framework to manage the runtime
27 lifecycle of the VNFs. The management processes are orchestrated
28 across various modules of ONAP to instantiate, configure, scale,
29 monitor, and reconfigure the VNFs using a set of standard APIs
30 provided by the VNF developers.
32 Although the guidelines and requirements specified in this document
33 were originally driven by the need to standardize and automate the
34 management of the virtualized environments (with VNFs) operated by
35 Service Providers, we believe that most of the requirements are equally
36 applicable to the operation of the physical network functions (PNFs),
37 those network functions provided by traditional physical network
38 elements (e.g. whitebox switches) or customized peripherals (e.g. a
39 video rendering engine for augmented reality). The primary area of
40 difference will be in how the network function is orchestrated into
41 place – VNFs can be much more dynamically created & placed by ONAP
42 to support varying geographic, availability and scalability needs,
43 whereas the PNFs have to be deployed a priori in specific locations
44 based on planning and engineering – their availability and scalability
45 will be determined by the capabilities offered by the PNFs.
47 **PNF** is a vendor-provided Network Function(s) implemented using a
48 bundled set of hardware and software while VNFs utilize cloud resources
49 to provide Network Functions through virtualized software modules. PNF
50 can be supplied by a vendor as a Black BOX (provides no knowledge of its
51 internal characteristics, logic, and software design/architecture) or as
52 a White Box (provides detailed knowledge and access of its internal
53 components and logic) or as a Grey Box (provides limited knowledge and
54 access to its internal components).
56 * Requirements that equally apply to both VNFs and PNFs are defined as
57 "The xNF MUST/SHOULD/..."
58 * Requirements that only apply to VNFs are defined as "The VNF MUST/SHOULD/..."
59 * Requirements that only apply to PNFs are defined as "The PNF MUST/SHOULD/..."
63 ------------------------------------
65 This section, Service Design, has been left intentionally blank. It
66 is out-of-scope for the VNF Requirements project for the Amsterdam
67 release and no numbered requirements are expected. Content may be
68 added in future updates of this document.
70 VNF On-boarding and package management
71 -----------------------------------------------------------------------------
76 The ONAP Design Time Framework provides the ability to design NFV
77 resources including VNFs, Services, and products. The VNF provider must
78 provide VNF packages that include a rich set of recipes, management and
79 functional interfaces, policies, configuration parameters, and
80 infrastructure requirements that can be utilized by the ONAP Design
81 module to onboard and catalog these resources. Initially this
82 information may be provided in documents, but in the near future a
83 method will be developed to automate as much of the transfer of data as
84 possible to satisfy its long term requirements.
86 The current VNF Package Requirement is based on a subset of the
87 Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
88 and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
89 (NFV), Management and Orchestration, VNF Packaging Specification.
92 ^^^^^^^^^^^^^^^^^^^^^^
94 * R-77707 The xNF provider **MUST** include a Manifest File that
95 contains a list of all the components in the xNF package.
96 * R-66070 The xNF Package **MUST** include xNF Identification Data to
97 uniquely identify the resource for a given xNF provider. The identification
98 data must include: an identifier for the xNF, the name of the xNF as was
99 given by the xNF provider, xNF description, xNF provider, and version.
100 * R-69565 The xNF Package **MUST** include documentation describing
101 xNF Management APIs. The document must include information and
104 - ONAP to deploy and configure (initially and ongoing) the xNF
105 application(s) (e.g., NETCONF APIs). Includes description of
106 configurable parameters for the xNF and whether the parameters
107 can be configured after xNF instantiation.
108 - ONAP to monitor the health of the xNF (conditions that require
109 healing and/or scaling responses). Includes a description of:
111 - Parameters that can be monitored for the xNF and event records
112 (status, fault, flow, session, call, control plane, etc.) generated
113 by the xNF after instantiation.
114 - Runtime lifecycle events and related actions (e.g., control
115 responses, tests) which can be performed for the xNF.
117 * R-84366 The xNF Package **MUST** include documentation describing
118 xNF Functional APIs that are utilized to build network and
119 application services. This document describes the externally exposed
120 functional inputs and outputs for the xNF, including interface
121 format and protocols supported.
122 * R-36280 The xNF provider **MUST** provide documentation describing
123 xNF Functional Capabilities that are utilized to operationalize the
124 xNF and compose complex services.
125 * R-98617 The xNF provider **MUST** provide information regarding any
126 dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
128 Resource Configuration
129 ^^^^^^^^^^^^^^^^^^^^^^^
131 * R-89571 The xNF **MUST** support and provide artifacts for
132 configuration management using at least one of the following
139 Note: The requirements for NETCONF/YANG, Chef, and Ansible protocols
140 are provided separately and must be supported only if the corresponding
141 protocol option is provided by the xNF providor.
143 Configuration Management via NETCONF/YANG
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146 * R-30278 The xNF provider **MUST** provide a Resource/Device YANG model
147 as a foundation for creating the YANG model for configuration. This will
148 include xNF attributes/parameters and valid values/attributes configurable
151 Configuration Management via Chef
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154 * R-13390 The xNF provider **MUST** provide cookbooks to be loaded
155 on the appropriate Chef Server.
156 * R-18525 The xNF provider **MUST** provide a JSON file for each
157 supported action for the xNF. The JSON file must contain key value
158 pairs with all relevant values populated with sample data that illustrates
159 its usage. The fields and their description are defined in Appendix A.
161 Note: Chef support in ONAP is not currently available and planned for 4Q 2017.
163 Configuration Management via Ansible
164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166 * R-75608 The xNF provider **MUST** provide playbooks to be loaded
167 on the appropriate Ansible Server.
168 * R-16777 The xNF provider **MUST** provide a JSON file for each
169 supported action for the xNF. The JSON file must contain key value
170 pairs with all relevant values populated with sample data that illustrates
171 its usage. The fields and their description are defined in Appendix B.
173 * R-46567 The xNF Package **MUST** include configuration scripts
174 for boot sequence and configuration.
175 * R-16065 The xNF provider **MUST** provide configurable parameters
176 (if unable to conform to YANG model) including xNF attributes/parameters
177 and valid values, dynamic attributes and cross parameter dependencies
178 (e.g., customer provisioning data).
180 Resource Control Loop
181 ^^^^^^^^^^^^^^^^^^^^^^^
183 * R-22888 The xNF provider **MUST** provide documentation for the xNF
184 Policy Description to manage the xNF runtime lifecycle. The document
185 must include a description of how the policies (conditions and actions)
186 are implemented in the xNF.
187 * R-01556 The xNF Package **MUST** include documentation describing the
188 fault, performance, capacity events/alarms and other event records that
189 are made available by the xNF. The document must include:
191 - A unique identification string for the specific xNF, a description
192 of the problem that caused the error, and steps or procedures to
193 perform Root Cause Analysis and resolve the issue.
194 - All events, severity level (e.g., informational, warning, error)
195 and descriptions including causes/fixes if applicable for the event.
196 - All events (fault, measurement for xNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF.
198 * R-27711 The xNF provider **MUST** provide an XML file that contains a
199 list of xNF error codes, descriptions of the error, and possible
200 causes/corrective action.
201 * R-01478 The xNF Package **MUST** include documentation describing all
202 parameters that are available to monitor the xNF after instantiation
203 (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected
204 for reporting purposes. The documentation must include a list of:
206 - Monitoring parameters/counters exposed for virtual resource
207 management and xNF application management.
208 - KPIs and metrics that need to be collected at each VM for capacity
209 planning and performance management purposes.
210 - The monitoring parameters must include latencies, success rates,
211 retry rates, load and quality (e.g., DPM) for the key
212 transactions/functions supported by the xNF and those that must
213 be exercised by the xNF in order to perform its function.
214 - For each KPI, provide lower and upper limits.
215 - When relevant, provide a threshold crossing alert point for
216 each KPI and describe the significance of the threshold crossing.
217 - For each KPI, identify the suggested actions that need to be
218 performed when a threshold crossing alert event is recorded.
219 - Describe any requirements for the monitoring component of tools
220 for Network Cloud automation and management to provide these records
221 to components of the xNF.
222 - When applicable, provide calculators needed to convert raw data
223 into appropriate reporting artifacts.
225 * R-56815 The xNF Package **MUST** include documentation describing
226 supported xNF scaling capabilities and capacity limits (e.g., number
227 of users, bandwidth, throughput, concurrent calls).
228 * R-48596 The xNF Package **MUST** include documentation describing
229 the characteristics for the xNF reliability and high availability.
230 * R-74763 The xNF provider **MUST** provide an artifact per xNF that contains
231 all of the xNF Event Records supported. The artifact should include
232 reference to the specific release of the xNF Event Stream Common Event
233 Data Model document it is based on. (e.g.,
234 `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
236 Compute, Network, and Storage Requirements
237 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239 * R-35851 The xNF Package **MUST** include xNF topology that describes
240 basic network and application connectivity internal and external to the
241 xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if
242 applicable) for each interface.
243 * R-97102 The VNF Package **MUST** include VM requirements via a Heat
244 template that provides the necessary data for:
246 - VM specifications for all VNF components - for hypervisor, CPU,
248 - Network connections, interface connections, internal and external to VNF.
249 - High availability redundancy model.
250 - Scaling/growth VM specifications.
252 Note: Must comply with the *Heat requirements in 5.b*.
254 * R-26881 The xNF provider **MUST** provide the binaries and images
255 needed to instantiate the xNF (xNF and VNFC images).
256 * R-96634 The xNF provider **MUST** describe scaling capabilities
257 to manage scaling characteristics of the xNF.
263 * R-43958 The xNF Package **MUST** include documentation describing
264 the tests that were conducted by the xNF providor and the test results.
265 * R-04298 The xNF provider **MUST** provide their testing scripts to
267 * R-58775 The xNF provider **MUST** provide software components that
268 can be packaged with/near the xNF, if needed, to simulate any functions
269 or systems that connect to the xNF system under test. This component is
270 necessary only if the existing testing environment does not have the
271 necessary simulators.
273 Licensing Requirements
274 ^^^^^^^^^^^^^^^^^^^^^^^
276 * R-85653 The xNF **MUST** provide metrics (e.g., number of sessions,
277 number of subscribers, number of seats, etc.) to ONAP for tracking
279 * R-44125 The xNF provider **MUST** agree to the process that can
280 be met by Service Provider reporting infrastructure. The Contract
281 shall define the reporting process and the available reporting tools.
282 * R-40827 The xNF provider **MUST** enumerate all of the open
283 source licenses their xNF(s) incorporate.
284 * R-97293 The xNF provider **MUST NOT** require audits of
285 Service Provider’s business.
286 * R-44569 The xNF provider **MUST NOT** require additional
287 infrastructure such as a xNF provider license server for xNF provider
288 functions and metrics.
289 * R-13613 The VNF **MUST** provide clear measurements for licensing
290 purposes to allow automated scale up/down by the management system.
291 * R-27511 The VNF provider **MUST** provide the ability to scale
292 up a VNF provider supplied product during growth and scale down a
293 VNF provider supplied product during decline without “real-time”
294 restrictions based upon VNF provider permissions.
295 * R-85991 The xNF provider **MUST** provide a universal license key
296 per xNF to be used as needed by services (i.e., not tied to a VM
297 instance) as the recommended solution. The xNF provider may provide
298 pools of Unique xNF License Keys, where there is a unique key for
299 each xNF instance as an alternate solution. Licensing issues should
300 be resolved without interrupting in-service xNFs.
301 * R-47849 The xNF provider **MUST** support the metadata about
302 licenses (and their applicable entitlements) as defined in this
303 document for xNF software, and any license keys required to authorize
304 use of the xNF software. This metadata will be used to facilitate
305 onboarding the xNF into the ONAP environment and automating processes
306 for putting the licenses into use and managing the full lifecycle of
307 the licenses. The details of this license model are described in
308 Appendix C. Note: License metadata support in ONAP is not currently
309 available and planned for 1Q 2018.
311 Configuration Management
312 ---------------------------------------------------
314 Controller Interactions With VNF
315 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
317 ONAP Controllers (such as APPC) expose a northbound API to clients
318 (such as SO) in order for the clients to initiate an activity
319 (aka command) on a VNF. ONAP controllers interact with VNFs through
320 Network and Application Adapters to perform configuration and other
321 lifecycle management activities within NFV environment.
322 The standardized models, protocols and mechanisms by which network
323 functions are configured are equally applicable to VNFs and PNFs.
325 This section describes the list of commands that should be supported
326 by the VNF. The following sections describe the standard protocols
327 that are supported (NETCONF, Chef, Ansible, and REST).
329 The commands below are expected to be supported on all VNF’s, unless
330 noted otherwise, either directly (via the NETCONF or REST interface)
331 or indirectly (via a Chef Cookbook or Ansible server). Note that there
332 are additional commands offered to northbound clients that are not shown
333 below, as these commands either act internally on the Controller itself
334 or depend upon network cloud components for implementation (thus, these
335 actions do not put any special requirement on the VNF provider).
337 The commands allow for parametric data to be passed from the controller
338 to the VNF or Ansible/Chef server in the request. The format of the
339 parameter data can be either xml (for NETCONF) or JSON (for Ansible,
342 Configuration Commands
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345 **Configure**: The Controller client is requesting that a post-instantiation
346 configuration be applied to the target VNF instance. After the Configure
347 action is completed, the VNF instance should be ready for service.
348 Note that customer specific configurations may need to be applied using
349 the ConfigModify action.
351 **ConfigModify**: The Controller client is requesting a configuration
352 update to a subset of the total configuration parameters of a VNF or to
353 apply customer specific configurations. The configuration update is
354 typically done while the VNF is in service and should not disrupt traffic.
356 **ConfigBackup**: The Controller client is requesting a backup of the
357 configuration parameters where the parameters are stored on the VNF.
358 This command is typically requested as part of an orchestration flow
359 for scenarios such as a software upgrade. The ConfigBackup is typically
360 done while the VNF is not in service (i.e., in a maintenance state).
361 When the ConfigBackup command is executed, the current VNF configuration
362 parameters are saved in storage that is preserved (if there is an existing
363 set of backed up parameters, they are overwritten).
365 **ConfigRestore**: The Controller client is requesting a restore action of
366 the configuration parameters to the VNF that were saved by ConfigBackup
367 command. This command is typically requested as part of an orchestration
368 flow for scenarios such as a software upgrade where the software upgrade
369 may have failed and the VNF needs to be rolled back to the prior configuration.
370 When the ConfigRestore command is executed, the VNF configuration parameters
371 which were backed to persistent preserved storage are applied to the VNF
372 (replacing existing parameters). The ConfigRestore is typically done while
373 the VNF is not in service (i.e., in a maintenance state).
375 **ConfigScaleOut**: The Controller client is requesting that a configuration
376 be applied after the VNF instance has been scaled out (i.e., one or more
377 additional VM’s instantiated to increase capacity). For some VNF’s,
378 ConfigScaleOut is not needed because the VNF is auto-configured after
379 scale-out. This command is being introduced in the Beijing release.
381 **Audit**: The Controller client is requesting that the current (last known
382 configuration update) is audited against the running configuration on the VNF.
384 * R-20741 The xNF **MUST** support ONAP Controller’s **Configure** command.
385 * R-19366 The xNF **MUST** support ONAP Controller’s **ConfigModify** command.
386 * R-32981 The xNF **MUST** support ONAP Controller’s **ConfigBackup** command.
387 * R-48247 The xNF **MUST** support ONAP Controller’s **ConfigRestore** command.
388 * R-94084 The xNF **MUST** support ONAP Controller’s **ConfigScaleOut**
390 * R-56385 The xNF **MUST** support ONAP Controller’s **Audit** command.
392 LifeCycle Management Related Commands
393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395 **The following commands are needed to support various lifecycle management
396 flows where the VNF may need to be removed for service.**
398 **QuiesceTraffic**: The Controller client is requesting the VNF gracefully
399 stop traffic (aka block and drain traffic). The method for quiescing traffic
400 is specific to the VNF architecture. The action is completed when all
401 (in-flight transactions) traffic has stopped. The VNF remains in an active
402 state where the VNF is able to process traffic (initiated using the
403 StartTraffic action).
405 **ResumeTraffic**: The Controller client is requesting the VNF resume
406 processing traffic. The method to resume traffic is specific to the VNF
409 **StopApplication**: The Controller client is requesting that the application
410 running on the VNF is stopped gracefully (i.e., without traffic loss).
411 This is equivalent to quiescing the traffic and then stopping the application
412 processes. The processes can be restarted using the StartApplication command.
414 **StartApplication**: The Controller client is requesting that the application
415 running on the VNF is started. Get ready to process traffic.
417 **The following commands are needed to support software upgrades, in-place or
418 other type of software upgrade. The VNF instance may be removed from service
421 **UpgradePrecheck**: The Controller client is requesting a confirmation that
422 the VNF can (and needs to) be upgraded to a specific software version
423 (specified in the request).
425 **UpgradeSoftware**: The Controller client is requesting that a (in-place)
426 software upgrade be performed on the VNF. The software to be applied is
427 pre-loaded to a specified location.
429 **UpgradePostCheck**: The Controller client is requesting a confirmation that
430 the VNF software upgrade has been completed successfully (VNF upgraded to
431 the new software version).
433 **UpgradeBackup**: The Controller client is requesting that the VNF is backed
434 up prior to the UpgradeSoftware.
436 **UpgradeBackOut**: The Controller client is requesting that the VNF upgrade
437 is backed out (in the event that the SoftwareUpgrade or UpgradePostCheck
440 * R-12706 The xNF **MUST** support ONAP Controller’s **QuiesceTraffic**
442 * R-07251 The xNF **MUST** support ONAP Controller’s **ResumeTraffic**
444 * R-83146 The xNF **MUST** support ONAP Controller’s **StopApplication**
446 * R-82811 The xNF **MUST** support ONAP Controller’s **StartApplication**
448 * R-19922 The xNF **MUST** support ONAP Controller’s **UpgradePrecheck**
450 * R-49466 The xNF **MUST** support ONAP Controller’s **UpgradeSoftware**
452 * R-45856 The xNF **MUST** support ONAP Controller’s **UpgradePostCheck**
454 * R-97343 The xNF **MUST** support ONAP Controller’s **UpgradeBackup**
456 * R-65641 The xNF **MUST** support ONAP Controller’s **UpgradeBackOut**
459 HealthCheck and Failure Related Commands
460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
462 **HealthCheck**: The Controller client is requesting a health check over the
463 entire scope of the VNF. The VNF must be 100% healthy, ready to take requests
464 and provide services, with all VNF required capabilities ready to provide
465 services and with all active and standby resources fully ready with no open
466 MINOR, MAJOR or CRITICAL alarms.
468 Note: In addition to the commands above, the Controller supports a set of
469 Openstack failure recovery related commands that are executed on-demand or via
470 Control Loop at the VM level. The VNF must support these commands in a fully
473 * R-41430 The xNF **MUST** support ONAP Controller’s **HealthCheck**
476 Notes On Command Support Using Controller Southbound Protocols
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
479 The ONAP Controllers are designed to support a standard set of protocols in
480 order to communicate with the VNF instance. The supported protocols are
481 NETCONF, Ansible, Chef, and REST.
483 NETCONF and REST require the VNF to implement a server which supports the RPC
486 Ansible and Chef require the use of a Ansible or Chef server which communicates
487 with the Controller (northbound) and the VNF VM’s (southbound).
489 The vendor must select which protocol to support for the commands listed above.
492 * NETCONF is most suitable for configuration related commands
494 * Ansible and Chef are suitable for any command.
495 Ansible has the advantage that it is agentless.
497 * REST is specified as an option only for the HealthCheck.
500 Additional details can be found in the `ONAP Application Controller (APPC) API Guide <http://onap.readthedocs.io/en/latest/submodules/appc.git/docs/APPC%20API%20Guide/APPC%20API%20Guide.html>`_, `ONAP VF-C project <http://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/index.html>`_ and the `ONAP SDNC project <http://onap.readthedocs.io/en/latest/submodules/sdnc/northbound.git/docs/index.html>`_.
502 NETCONF Standards and Capabilities
503 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
505 ONAP Controllers and their Adapters utilize device YANG model and
506 NETCONF APIs to make the required changes in the VNF state and
507 configuration. The VNF providers must provide the Device YANG model and
508 NETCONF server supporting NETCONF APIs to comply with target ONAP and
511 VNF Configuration via NETCONF Requirements
512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
514 Configuration Management
515 +++++++++++++++++++++++++++
517 * R-88026 The xNF **MUST** include a NETCONF server enabling
518 runtime configuration and lifecycle management capabilities.
519 * R-95950 The xNF **MUST** provide a NETCONF interface fully defined
520 by supplied YANG models for the embedded NETCONF server.
522 NETCONF Server Requirements
523 ++++++++++++++++++++++++++++++
525 * R-73468 The xNF **MUST** allow the NETCONF server connection
526 parameters to be configurable during virtual machine instantiation
527 through Heat templates where SSH keys, usernames, passwords, SSH
528 service and SSH port numbers are Heat template parameters.
529 * R-90007 The xNF **MUST** implement the protocol operation:
530 **close-session()**- Gracefully close the current session.
531 * R-70496 The xNF **MUST** implement the protocol operation:
532 **commit(confirmed, confirm-timeout)** - Commit candidate
533 configuration datastore to the running configuration.
534 * R-18733 The xNF **MUST** implement the protocol operation:
535 **discard-changes()** - Revert the candidate configuration
536 datastore to the running configuration.
537 * R-44281 The xNF **MUST** implement the protocol operation:
538 **edit-config(target, default-operation, test-option, error-option,
539 config)** - Edit the target configuration datastore by merging,
540 replacing, creating, or deleting new config elements.
541 * R-60106 The xNF **MUST** implement the protocol operation:
542 **get(filter)** - Retrieve (a filtered subset of) the running
543 configuration and device state information. This should include
544 the list of xNF supported schemas.
545 * R-29488 The xNF **MUST** implement the protocol operation:
546 **get-config(source, filter)** - Retrieve a (filtered subset of
547 a) configuration from the configuration datastore source.
548 * R-11235 The xNF **MUST** implement the protocol operation:
549 **kill-session(session)** - Force the termination of **session**.
550 * R-02597 The xNF **MUST** implement the protocol operation:
551 **lock(target)** - Lock the configuration datastore target.
552 * R-96554 The xNF **MUST** implement the protocol operation:
553 **unlock(target)** - Unlock the configuration datastore target.
554 * R-29324 The xNF **SHOULD** implement the protocol operation:
555 **copy-config(target, source) -** Copy the content of the
556 configuration datastore source to the configuration datastore target.
557 * R-88031 The xNF **SHOULD** implement the protocol operation:
558 **delete-config(target) -** Delete the named configuration
560 * R-97529 The xNF **SHOULD** implement the protocol operation:
561 **get-schema(identifier, version, format) -** Retrieve the YANG schema.
562 * R-62468 The xNF **MUST** allow all configuration data to be
563 edited through a NETCONF <edit-config> operation. Proprietary
564 NETCONF RPCs that make configuration changes are not sufficient.
565 * R-01382 The xNF **MUST** allow the entire configuration of the
566 xNF to be retrieved via NETCONF's <get-config> and <edit-config>,
567 independently of whether it was configured via NETCONF or other
569 * R-28756 The xNF **MUST** support **:partial-lock** and
570 **:partial-unlock** capabilities, defined in RFC 5717. This
571 allows multiple independent clients to each write to a different
572 part of the <running> configuration at the same time.
573 * R-83873 The xNF **MUST** support **:rollback-on-error** value for
574 the <error-option> parameter to the <edit-config> operation. If any
575 error occurs during the requested edit operation, then the target
576 database (usually the running configuration) will be left unaffected.
577 This provides an 'all-or-nothing' edit mode for a single <edit-config>
579 * R-68990 The xNF **MUST** support the **:startup** capability. It
580 will allow the running configuration to be copied to this special
581 database. It can also be locked and unlocked.
582 * R-68200 The xNF **MUST** support the **:url** value to specify
583 protocol operation source and target parameters. The capability URI
584 for this feature will indicate which schemes (e.g., file, https, sftp)
585 that the server supports within a particular URL value. The 'file'
586 scheme allows for editable local configuration databases. The other
587 schemes allow for remote storage of configuration databases.
588 * R-20353 The xNF **MUST** implement both **:candidate** and
589 **:writable-running** capabilities. When both **:candidate** and
590 **:writable-running** are provided then two locks should be supported.
591 * R-11499 The xNF **MUST** fully support the XPath 1.0 specification
592 for filtered retrieval of configuration and other database contents.
593 The 'type' attribute within the <filter> parameter for <get> and
594 <get-config> operations may be set to 'xpath'. The 'select' attribute
595 (which contains the XPath expression) will also be supported by the
596 server. A server may support partial XPath retrieval filtering, but
597 it cannot advertise the **:xpath** capability unless the entire XPath
598 1.0 specification is supported.
599 * R-83790 The xNF **MUST** implement the **:validate** capability
600 * R-49145 The xNF **MUST** implement **:confirmed-commit** If
601 **:candidate** is supported.
602 * R-58358 The xNF **MUST** implement the **:with-defaults** capability
604 * R-59610 The xNF **MUST** implement the data model discovery and
605 download as defined in [RFC6022].
606 * R-87662 The xNF **SHOULD** implement the NETCONF Event Notifications
608 * R-93443 The xNF **MUST** define all data models in YANG [RFC6020],
609 and the mapping to NETCONF shall follow the rules defined in this RFC.
610 * R-26115 The xNF **MUST** follow the data model upgrade rules defined
611 in [RFC6020] section 10. All deviations from section 10 rules shall
612 be handled by a built-in automatic upgrade mechanism.
613 * R-10716 The xNF **MUST** support parallel and simultaneous
614 configuration of separate objects within itself.
615 * R-29495 The xNF **MUST** support locking if a common object is
616 being manipulated by two simultaneous NETCONF configuration operations
617 on the same xNF within the context of the same writable running data
618 store (e.g., if an interface parameter is being configured then it
619 should be locked out for configuration by a simultaneous configuration
620 operation on that same interface parameter).
621 * R-53015 The xNF **MUST** apply locking based on the sequence of
622 NETCONF operations, with the first configuration operation locking
623 out all others until completed.
624 * R-02616 The xNF **MUST** permit locking at the finest granularity
625 if a xNF needs to lock an object for configuration to avoid blocking
626 simultaneous configuration operations on unrelated objects (e.g., BGP
627 configuration should not be locked out if an interface is being
628 configured or entire Interface configuration should not be locked out
629 if a non-overlapping parameter on the interface is being configured).
630 * R-41829 The xNF **MUST** be able to specify the granularity of the
631 lock via a restricted or full XPath expression.
632 * R-66793 The xNF **MUST** guarantee the xNF configuration integrity
633 for all simultaneous configuration operations (e.g., if a change is
634 attempted to the BUM filter rate from multiple interfaces on the same
635 EVC, then they need to be sequenced in the xNF without locking either
636 configuration method out).
637 * R-54190 The xNF **MUST** release locks to prevent permanent lock-outs
638 when/if a session applying the lock is terminated (e.g., SSH session
640 * R-03465 The xNF **MUST** release locks to prevent permanent lock-outs
641 when the corresponding <partial-unlock> operation succeeds.
642 * R-63935 The xNF **MUST** release locks to prevent permanent lock-outs
643 when a user configured timer has expired forcing the NETCONF SSH Session
644 termination (i.e., product must expose a configuration knob for a user
645 setting of a lock expiration timer)
646 * R-10173 The xNF **MUST** allow another NETCONF session to be able to
647 initiate the release of the lock by killing the session owning the lock,
648 using the <kill-session> operation to guard against hung NETCONF sessions.
649 * R-88899 The xNF **MUST** support simultaneous <commit> operations
650 within the context of this locking requirements framework.
651 * R-07545 The xNF **MUST** support all operations, administration and
652 management (OAM) functions available from the supplier for xNFs using
653 the supplied YANG code and associated NETCONF servers.
654 * R-60656 The xNF **MUST** support sub tree filtering.
655 * R-80898 The xNF **MUST** support heartbeat via a <get> with null filter.
656 * R-06617 The xNF **MUST** support get-schema (ietf-netconf-monitoring)
657 to pull YANG model over session.
658 * R-25238 The xNF PACKAGE **MUST** validated YANG code using the open
659 source pyang [1]_ program using the following commands:
661 .. code-block:: python
663 $ pyang --verbose --strict <YANG-file-name(s)>
666 * R-63953 The xNF **MUST** have the echo command return a zero value
667 otherwise the validation has failed
668 * R-26508 The xNF **MUST** support NETCONF server that can be
669 mounted on OpenDaylight (client) and perform the following operations:
671 - Modify, update, change, rollback configurations using each
672 configuration data element.
673 - Query each state (non-configuration) data element.
674 - Execute each YANG RPC.
675 - Receive data through each notification statement.
679 The following requirements provides the Yang models that suppliers must
680 conform, and those where applicable, that suppliers need to use.
682 * R-28545 The xNF **MUST** conform its YANG model to RFC 6060,
683 “YANG - A Data Modeling Language for the Network Configuration
685 * R-29967 The xNF **MUST** conform its YANG model to RFC 6022,
686 “YANG module for NETCONF monitoring”.
687 * R-22700 The xNF **MUST** conform its YANG model to RFC 6470,
688 “NETCONF Base Notifications”.
689 * R-10353 The xNF **MUST** conform its YANG model to RFC 6244,
690 “An Architecture for Network Management Using NETCONF and YANG”.
691 * R-53317 The xNF **MUST** conform its YANG model to RFC 6087,
692 “Guidelines for Authors and Reviewers of YANG Data Model Documents”.
693 * R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991,
694 “Common YANG Data Types”.
695 * R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536,
696 “NETCONF Access Control Model”.
697 * R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223,
698 “A YANG Data Model for Interface Management”.
699 * R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223,
700 “IANA Interface Type YANG Module”.
701 * R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277,
702 “A YANG Data Model for IP Management”.
703 * R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317,
704 “A YANG Data Model for System Management”.
705 * R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407,
706 “A YANG Data Model for SNMP Configuration”.
708 The NETCONF server interface shall fully conform to the following
711 * R-33946 The xNF **MUST** conform to the NETCONF RFC 4741,
712 “NETCONF Configuration Protocol”.
713 * R-04158 The xNF **MUST** conform to the NETCONF RFC 4742,
714 “Using the NETCONF Configuration Protocol over Secure Shell (SSH)”.
715 * R-13800 The xNF **MUST** conform to the NETCONF RFC 5277,
716 “NETCONF Event Notification”.
717 * R-01334 The xNF **MUST** conform to the NETCONF RFC 5717,
718 “Partial Lock Remote Procedure Call”.
719 * R-08134 The xNF **MUST** conform to the NETCONF RFC 6241,
720 “NETCONF Configuration Protocol”.
721 * R-78282 The xNF **MUST** conform to the NETCONF RFC 6242,
722 “Using the Network Configuration Protocol over Secure Shell”.
727 HealthCheck is a command for which no NETCONF support exists.
728 Therefore, this must be supported using a RESTful interface
729 (defined in this section) or with a Chef cookbook/Ansible playbook
730 (defined in sections `Chef Standards and Capabilities`_ and
731 `Ansible Standards and Capabilities`_).
733 HealthCheck Definition: The VNF level HealthCheck is a check over
734 the entire scope of the VNF. The VNF must be 100% healthy, ready
735 to take requests and provide services, with all VNF required
736 capabilities ready to provide services and with all active and
737 standby resources fully ready with no open MINOR, MAJOR or CRITICAL
738 alarms. NOTE: A switch may need to be turned on, but the VNF should
739 be ready to take service requests or be already processing service
740 requests successfully.
742 The VNF must provide a REST formatted GET RPCs to support HealthCheck
743 queries via the GET method over HTTP(s).
745 The port number, url, and other authentication information is provided
751 * R-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck
752 RPC executes a xNF Provider-defined xNF HealthCheck over the scope of
753 the entire xNF (e.g., if there are multiple VNFCs, then run a health check,
754 as appropriate, for all VNFCs). It returns a 200 OK if the test completes.
755 A JSON object is returned indicating state (healthy, unhealthy), scope
756 identifier, time-stamp and one or more blocks containing info and fault
757 information. If the xNF is unable to run the HealthCheck, return a
758 standard http error code and message.
760 Examples of responses when HealthCheck runs and is able to provide a healthy
761 or unhealthy response:
766 "identifier": "scope represented",
768 "time": "01-01-1000:0000"
772 "identifier": "scope represented",
773 "state": "unhealthy",
775 "info": "System threshold exceeded details",
782 "time": "01-01-1000:0000"
786 Chef Standards and Capabilities
787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
789 ONAP will support configuration of VNFs via Chef subject to the
790 requirements and guidelines defined in this section.
792 The Chef configuration management mechanism follows a client-server
793 model. It requires the presence of a Chef-Client on the VNF that will be
794 directly managed by a Chef Server. The Chef-client will register with
795 the appropriate Chef Server and are managed via ‘cookbooks’ and
796 configuration attributes loaded on the Chef Server which contain all
797 necessary information to execute the appropriate actions on the VNF via
800 ONAP will utilize the open source Chef Server, invoke the documented
801 Chef REST APIs to manage the VNF and requires the use of open source
802 Chef-Client and Push Jobs Client on the VNF
803 (https://downloads.chef.io/).
805 VNF Configuration via Chef Requirements
806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
808 Chef Client Requirements
809 +++++++++++++++++++++++++
811 * R-79224 The xNF **MUST** have the chef-client be preloaded with
812 validator keys and configuration to register with the designated
813 Chef Server as part of the installation process.
814 * R-72184 The xNF **MUST** have routable FQDNs for all the endpoints
815 (VMs) of a xNF that contain chef-clients which are used to register
816 with the Chef Server. As part of invoking xNF actions, ONAP will
817 trigger push jobs against FQDNs of endpoints for a xNF, if required.
818 * R-47068 The xNF **MAY** expose a single endpoint that is
819 responsible for all functionality.
820 * R-67114 The xNF **MUST** be installed with:
822 - Chef-Client >= 12.0
823 - Chef push jobs client >= 2.0
825 Chef Roles/Requirements
826 ++++++++++++++++++++++++++
828 * R-27310 The xNF Package **MUST** include all relevant Chef artifacts
829 (roles/cookbooks/recipes) required to execute xNF actions requested by
830 ONAP for loading on appropriate Chef Server.
831 * R-26567 The xNF Package **MUST** include a run list of
832 roles/cookbooks/recipes, for each supported xNF action, that will
833 perform the desired xNF action in its entirety as specified by ONAP
834 (see Section 7.c, ONAP Controller APIs and Behavior, for list of xNF
835 actions and requirements), when triggered by a chef-client run list
837 * R-98911 The xNF **MUST NOT** use any instance specific parameters
838 for the xNF in roles/cookbooks/recipes invoked for a xNF action.
839 * R-37929 The xNF **MUST** accept all necessary instance specific
840 data from the environment or node object attributes for the xNF
841 in roles/cookbooks/recipes invoked for a xNF action.
842 * R-62170 The xNF **MUST** over-ride any default values for
843 configurable parameters that can be set by ONAP in the roles,
844 cookbooks and recipes.
845 * R-78116 The xNF **MUST** update status on the Chef Server
846 appropriately (e.g., via a fail or raise an exception) if the
847 chef-client run encounters any critical errors/failures when
848 executing a xNF action.
849 * R-44013 The xNF **MUST** populate an attribute, defined as node
850 [‘PushJobOutput’] with the desired output on all nodes in the push job
851 that execute chef-client run if the xNF action requires the output of a
852 chef-client run be made available (e.g., get running configuration).
853 * R-30654 The xNF Package **MUST** have appropriate cookbooks that are
854 designed to automatically ‘rollback’ to the original state in case of
855 any errors for actions that change state of the xNF (e.g., configure).
856 * R-65755 The xNF **SHOULD** support callback URLs to return information
857 to ONAP upon completion of the chef-client run for any chef-client run
858 associated with a xNF action.
860 - As part of the push job, ONAP will provide two parameters in the
861 environment of the push job JSON object:
863 - ‘RequestId’ a unique Id to be used to identify the request,
864 - ‘CallbackUrl’, the URL to post response back.
866 - If the CallbackUrl field is empty or missing in the push job, then
867 the chef-client run need not post the results back via callback.
869 * R-15885 The xNF **MUST** Upon completion of the chef-client run,
870 POST back on the callback URL, a JSON object as described in Table
871 A2 if the chef-client run list includes a cookbook/recipe that is
872 callback capable. Failure to POST on the Callback Url should not be
873 considered a critical error. That is, if the chef-client successfully
874 completes the xNF action, it should reflect this status on the Chef
875 Server regardless of whether the Callback succeeded or not.
880 This section outlines the workflow that ONAP invokes when it receives an
881 action request against a Chef managed VNF.
883 1. When ONAP receives a request for an action for a Chef Managed VNF, it
884 retrieves the corresponding template (based on **action** and
885 **VNF)** from its database and sets necessary values in the
886 “Environment”, “Node” and “NodeList” keys (if present) from either
887 the payload of the received action or internal data.
889 2. If “Environment” key is present in the updated template, it posts the
890 corresponding JSON dictionary to the appropriate Environment object
891 REST endpoint on the Chef Server thus updating the Environment
892 attributes on the Chef Server.
894 3. Next, it creates a Node Object from the “Node” JSON dictionary for
895 all elements listed in the NodeList (using the FQDN to construct the
896 endpoint) by replicating it [2]_. As part of this process, it will
897 set the name field in each Node Object to the corresponding FQDN.
898 These node objects are then posted on the Chef Server to
899 corresponding Node Object REST endpoints to update the corresponding
902 4. If PushJobFlag is set to “True” in the template, ONAP requests a push
903 job against all the nodes in the NodeList to trigger
904 chef-client\ **.** It will not invoke any other command via the push
905 job. ONAP will include a callback URL in the push job request and a
906 unique Request Id. An example push job posted by ONAP is listed
912 "command": "chef-client",
914 "nodes”: [“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
916 “RequestId”:”8279-abcd-aksdj-19231”,
917 “CallbackUrl”:”<callback>”
921 5. If CallbackCapable field in the template is not present or set to
922 “False” ONAP will poll the Chef Server to check completion status of
925 6. If “GetOutputFlag” is set to “True” in the template and
926 CallbackCapable is not set to “True”, ONAP will retrieve any output
927 from each node where the push job has finished by accessing the Node
928 Object attribute node[‘PushJobOutput’].
930 Ansible Standards and Capabilities
931 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
933 ONAP will support configuration of VNFs via Ansible subject to the
934 requirements and guidelines defined in this section.
936 Ansible allows agentless management of VNFs/VMs/VNFCs via execution
937 of ‘playbooks’ over ssh. The ‘playbooks’ are a structured set of
938 tasks which contain all the necessary resources and execution capabilities
939 to take the necessary action on one or more target VMs (and/or VNFCs)
940 of the VNF. ONAP will utilize the framework of an Ansible Server that
941 will host all Ansible artifacts and run playbooks to manage VNFs that support
944 VNF Configuration via Ansible Requirements
945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
947 Ansible Client Requirements
948 +++++++++++++++++++++++++++++
950 * R-32217 The xNF **MUST** have routable FQDNs that are reachable via
951 the Ansible Server for the endpoints (VMs) of a xNF on which playbooks
952 will be executed. ONAP will initiate requests to the Ansible Server
953 for invocation of playbooks against these end points [3]_.
954 * R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)
955 of a xNF on which an Ansible playbook will be executed.
956 * R-35401 The xNF **MUST** support SSH and allow SSH access by the
957 Ansible server for the endpoint VM(s) and comply with the Network
958 Cloud Service Provider guidelines for authentication and access.
959 * R-82018 The xNF **MUST** load the Ansible Server SSH public key onto xNF
961 of instantiation. This will allow the Ansible Server to authenticate
962 to perform post-instantiation configuration without manual intervention
963 and without requiring specific xNF login IDs and passwords.
965 CAUTION: For VNFs configured using Ansible, to eliminate the need
966 for manual steps, post-instantiation and pre-configuration, to upload
967 of SSH public keys, SSH public keys loaded during (heat) instantiation shall
968 be preserved and not removed by (heat) embedded (userdata) scripts.
970 * R-92866 The xNF **MUST** include as part of post-instantiation configuration
971 done by Ansible Playbooks the removal/update of the SSH public key from
972 /root/.ssh/authorized_keys, and update of SSH keys loaded through
973 instantiation to support Ansible. This may include download and install of
974 new SSH keys and new mechanized IDs.
975 * R-91745 The xNF **MUST** update the Ansible Server and other entities
976 storing and using the SSH keys for authentication when the SSH keys used
977 by Ansible are regenerated/updated.
979 NOTE: Ansible Server itself may be used to upload new SSH public keys
982 Ansible Playbook Requirements
983 +++++++++++++++++++++++++++++++
985 An Ansible playbook is a collection of tasks that is executed on the
986 Ansible server (local host) and/or the target VM (s) in order to
987 complete the desired action.
989 * R-40293 The xNF **MUST** make available playbooks that conform
990 to the ONAP requirement.
991 * R-49396 The xNF **MUST** support each ONAP (APPC) xNF action
992 by invocation of **one** playbook [4]_. The playbook will be responsible
994 all necessary tasks (as well as calling other playbooks) to complete
996 * R-33280 The xNF **MUST NOT** use any instance specific parameters
998 * R-48698 The xNF **MUST** utilize information from key value pairs
999 that will be provided by the Ansible Server as "extra-vars" during
1000 invocation to execute the desired xNF action. If the playbook requires
1001 files, they must also be supplied using the methodology detailed in
1002 the Ansible Server API, unless they are bundled with playbooks, example,
1005 The Ansible Server will determine if a playbook invoked to execute a
1006 xNF action finished successfully or not using the “PLAY_RECAP” summary
1007 in Ansible log. The playbook will be considered to successfully finish
1008 only if the “PLAY RECAP” section at the end of playbook execution output
1009 has no unreachable hosts and no failed tasks. Otherwise, the playbook
1010 will be considered to have failed.
1012 * R-43253 The xNF **MUST** use playbooks designed to allow Ansible
1013 Server to infer failure or success based on the “PLAY_RECAP” capability.
1014 NOTE: There are cases where playbooks need to interpret results of a task
1015 and then determine success or failure and return result accordingly
1016 (failure for failed tasks).
1017 * R-50252 The xNF **MUST** write to a specific one text files that
1018 will be retrieved and made available by the Ansible Server if, as part
1019 of a xNF action (e.g., audit), a playbook is required to return any
1020 xNF information. The text files must be written in the same directory as
1021 the one from which the playbook is being executed. A text file must be
1022 created for the xNF playbook run targets/affects, with the name
1023 ‘<VNFname>_results.txt’ into which any desired output from each
1024 respective VM/xNF must be written.
1025 * R-51442 The xNF **SHOULD** use playbooks that are designed to
1026 automatically ‘rollback’ to the original state in case of any errors
1027 for actions that change state of the xNF (e.g., configure).
1029 NOTE: In case rollback at the playbook level is not supported or possible,
1030 the xNF provider shall provide alternative locking mechanism (e.g., for a
1031 small xNF the rollback mechanism may rely on workflow to terminate and
1032 re-instantiate VNF VMs and then re-run playbook(s)). Backing up updated
1033 files also recommended to support rollback when soft rollback is feasible.
1035 * R-58301 The xNF **SHOULD NOT** use playbooks that make requests to
1036 Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);
1037 therefore, there is no use for Cloud specific variables like Openstack
1038 UUIDs in Ansible Playbooks.
1040 Rationale: Flows that require interactions with Cloud services
1041 e.g. Openstack shall rely on workflows run by an Orchestrator
1042 (Change Management) or
1043 other capability (such as a control loop or Operations GUI) outside
1044 Ansible Server which can be executed by a Controller such as APPC.
1045 There are policies, as part of Control Loop models, that send remediation
1046 action requests to APPC; these are triggered as a response to an event
1047 or correlated events published to Event Bus.
1049 * R-02651 The xNF **SHOULD** use the Ansible backup feature to save a
1050 copy of configuration files before implementing changes to support
1051 operations such as backing out of software upgrades, configuration
1052 changes or other work as this will help backing out of configuration
1053 changes when needed.
1054 * R-43353 The xNF **MUST** return control from Ansible Playbooks only
1055 after tasks are fully complete, signaling that the playbook completed
1056 all tasks. When starting services, return control only after all services
1057 are up. This is critical for workflows where the next steps are dependent
1058 on prior tasks being fully completed.
1062 StopApplication Playbook – StopApplication Playbook shall return control
1063 and a completion status only after VNF application is fully stopped, all
1064 processes/services stopped.
1065 StartApplication Playbook – StartApplication Playbook shall return control
1066 and a completion status only after all VNF application services are fully up,
1067 all processes/services started and ready to provide services. NOTE: Start
1068 Playbook should not be declared complete/done after starting one or several
1069 processes that start the other processes.
1071 HealthCheck Playbook:
1073 SUCCESS – HealthCheck success shall be returned (return code 0) by a
1074 Playbook or Cookbook only when VNF is 100% healthy, ready to take requests
1075 and provide services, with all VNF required capabilities ready to provide
1076 services and with all active and standby resources fully ready with no
1077 open MINOR, MAJOR or CRITICAL alarms.
1079 NOTE: In some cases, a switch may need to be turned on, but a VNF
1080 reported as healthy, should be ready to take service requests or be
1081 already processing service requests successfully.
1083 A successful execution of a health-check playbook shall also create one
1084 file per VNF VM, named after the VNF instance name followed by
1085 “_results.txt (<vnf_instance>_results.txt) to indicate health-check was
1086 executed and completed successfully, example: vfdb9904v_results.txt,
1087 with the following contents:
1089 .. code-block:: java
1092 "identifier": "VNF",
1094 "time": "2018-03-16:1139"
1099 .. code-block:: java
1101 $ cat vfdb9904v_results.txt
1103 "identifier": "VNF",
1105 "time": "2018-03-16:1139"
1109 FAILURE – A health check playbook shall return a non-zero return code in
1110 case VNF is not 100% healthy because one or more VNF application processes
1111 are stopped or not ready to take service requests or because critical or
1112 non-critical resources are not ready or because there are open MINOR, MAJOR
1113 or CRITICAL traps/alarms or because there are issues with the VNF that
1114 need attention even if they do not impact services provided by the VNF.
1116 A failed health-check playbook shall also create one file per VNF,
1117 named after the VNF instance name, followed by
1118 “_results.txt to indicate health-check was executed and found issues
1119 in the health of the VNF. This is to differentiate from failure to
1120 run health-check playbook or playbook tasks to verify the health of the VNF,
1121 example: vfdb9904v_results.txt, with the following contents:
1123 .. code-block:: java
1126 "identifier": "VNF",
1127 "state": "unhealthy",
1128 "info": "Error in following VM(s). Check hcstatus files under /tmp/ccfx9901v for details",
1133 "time": "2018-03-16:4044"
1139 .. code-block:: java
1141 $ cat vfdb9904v_results.txt
1143 "identifier": "VNF",
1144 "state": "unhealthy",
1145 "info": "Error in following VM(s). Check hcstatus files under /tmp/ccfx9901v for details",
1150 "time": "2018-03-16:4044"
1154 See `VNF REST APIs`_ for additional details on HealthCheck.
1156 ONAP Controller / Ansible API Usage
1157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1159 This section outlines the workflow that ONAP Controller invokes when
1160 it receives an action request against an Ansible managed VNF.
1162 #. When ONAP Controller receives a request for an action for an
1163 AnsibleManaged VNF, it retrieves the corresponding template (based
1164 on **action** and **VNF**) from its database and sets necessary
1165 values (such as an Id, NodeList, and EnvParameters) from either
1166 information in the request or data obtained from other sources.
1167 This is referred to as the payload that is sent as a JSON object
1168 to the Ansible server.
1169 #. The ONAP Controller sends a request to the Ansible server to
1171 #. The ONAP Controller polls the Ansible Server for result (success
1172 or failure). The ONAP Controllers has a timeout value which is
1173 contained in the template. If the result is not available when the
1174 timeout is reached, the ONAP Controller stops polling and returns a
1175 timeout error to the requester. The Ansible Server continues to
1176 process the request.
1179 Support of Controller Commands And Southbound Protocols
1180 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1182 The following table summarizes the commands and possible protocols selected.
1183 Note that the HealthCheck can also be supported via REST.
1185 Table 8. ONAP Controller APIs and NETCONF Commands
1187 +-------------+--------------------+--------------------+--------------------+
1188 |**Command** |**NETCONF Support** |**Chef Support** |**Ansible** |
1189 +=============+====================+====================+====================+
1190 |General |For each RPC, the |VNF Vendor must |VNF Vendor must |
1191 |Comments |appropriate RPC |provide any |provide an Ansible |
1192 | |operation is listed.|necessary roles, |playbook to retrieve|
1193 | | |cookbooks, recipes |the running |
1194 | | |to retrieve the |configuration from a|
1195 | | |running |VNF and place the |
1196 | | |configuration from |output on the |
1197 | | |a VNF and place it |Ansible server in |
1198 | | |in the respective |a manner aligned |
1199 | | |Node Objects |with playbook |
1200 | | |‘PushJobOutput’ |requirements listed |
1201 | | |attribute of all |in this document. |
1202 | | |nodes in NodeList | |
1203 | | |when triggered |The PlaybookName |
1204 | | |by a chef-client |must be provided |
1205 | | |run. |in the JSON file. |
1207 | | |The JSON file for |NodeList must list |
1208 | | |this VNF action is |IP addresses or DNS |
1209 | | |required to set |supported FQDNs of |
1210 | | |“PushJobFlag” to |an example VNF |
1211 | | |“True” and |on which to |
1212 | | |“GetOutputFlag” to |execute playbook. |
1213 | | |“True”. The “Node” | |
1214 | | |JSON dictionary | |
1215 | | |must have the run | |
1216 | | |list populated | |
1217 | | |with the necessary | |
1218 | | |sequence of roles, | |
1219 | | |cookbooks, recipes. | |
1221 | | |The Environment | |
1222 | | |and Node values | |
1223 | | |should contain all | |
1224 | | |appropriate | |
1225 | | |configuration | |
1226 | | |attributes. | |
1228 | | |NodeList must | |
1229 | | |list sample FQDNs | |
1230 | | |that are required to| |
1232 | | |chef-client run for | |
1233 | | |this VNF Action. | |
1234 +-------------+--------------------+--------------------+--------------------+
1235 |Audit |The <get-config> is |Supported via a |Supported via a |
1236 | |used to return the |cookbook that |playbook that |
1237 | |running |returns the running |returns the running |
1238 | |configuration. |configuration. |configuration. |
1239 +-------------+--------------------+--------------------+--------------------+
1240 |Configure, |The <edit-config> |Supported via a |Supported via a |
1241 |ModifyConfig |operation loads all |cookbook that |playbook that |
1242 | |or part of a |updates the VNF |updates the VNF |
1243 | |specified data set |configuration. |configuration. |
1244 | |to the specified | | |
1245 | |target database. If | | |
1246 | |there is no | | |
1247 | |<candidate/> | | |
1248 | |database, then the | | |
1249 | |target is the | | |
1250 | |<running/> database.| | |
1251 | |A <commit> follows. | | |
1252 +-------------+--------------------+--------------------+--------------------+
1253 |Other |This command has no |Supported via a |Supported via a |
1254 |Configuration|existing NETCONF RPC|cookbook that |playbook that |
1255 |Commands |action. |performs |performs |
1256 | | |the action. |the action. |
1257 +-------------+--------------------+--------------------+--------------------+
1258 |Lifecycle |This command has no |Supported via a |Supported via a |
1259 |Management |existing NETCONF RPC|cookbook that |playbook that |
1260 |Commands |action. |performs |performs |
1261 | | |the action. |the action. |
1262 +-------------+--------------------+--------------------+--------------------+
1263 |Health Check |This command has no |Supported via a |Supported |
1264 | |existing NETCONF RPC|cookbook |via a |
1265 | |action. |that |playbook |
1266 | | |performs |that |
1267 | | |a HealthCheck and |performs |
1268 | | |returns the results.|the |
1269 | | | |HealthCheck |
1270 | | | |and returns |
1273 +-------------+--------------------+--------------------+--------------------+
1275 Monitoring & Management
1276 --------------------------------------------------
1278 This section addresses data collection and event processing
1279 functionality that is directly dependent on the interfaces
1280 provided by the VNFs’ APIs. These can be in the form of asynchronous
1281 interfaces for event, fault notifications, and autonomous data streams.
1282 They can also be synchronous interfaces for on-demand requests to
1283 retrieve various performance, usage, and other event information.
1285 The target direction for VNF interfaces is to employ APIs that are
1286 implemented utilizing standardized messaging and modeling protocols
1287 over standardized transports. Migrating to a virtualized environment
1288 presents a tremendous opportunity to eliminate the need for proprietary
1289 interfaces for VNF provider equipment while removing the traditional
1290 boundaries between Network Management Systems and Element Management
1291 Systems. Additionally, VNFs provide the ability to instrument the
1292 networking applications by creating event records to test and monitor
1293 end-to-end data flow through the network, similar to what physical or
1294 virtual probes provide without the need to insert probes at various
1295 points in the network. The VNF providers must be able to provide the
1296 aforementioned set of required data directly to the ONAP collection
1297 layer using standardized interfaces.
1299 Data Model for Event Records
1300 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1302 This section describes the data model for the collection of telemetry
1303 data from VNFs by Service Providers (SPs) to manage VNF health and
1304 runtime lifecycle. This data model is referred to as the VNF Event
1305 Streaming (VES) specifications. While this document is focused on
1306 specifying some of the records from the ONAP perspective, there may
1307 be other external bodies using the same framework to specify additional
1308 records. For example, OPNFV has a VES project that is looking to specify
1309 records for OpenStack’s internal telemetry to manage Application (VNFs),
1310 physical and virtual infrastructure (compute, storage, network devices),
1311 and virtual infrastructure managers (cloud controllers, SDN controllers).
1312 Note that any configurable parameters for these data records (e.g.,
1313 frequency, granularity, policy-based configuration) will be managed
1314 using the “Configuration” framework described in the prior sections
1317 The Data Model consists of:
1319 - Common Header Record: This data structure precedes each of the
1320 Technology Independent and Technology Specific records sections of
1323 - Technology Independent Records: This version of the document
1324 specifies the model for Fault, Heartbeat, State Change, Syslog,
1325 Threshold Crossing Alerts, and VNF Scaling* (short for
1326 measurementForVfScalingFields – actual name used in JSON
1327 specification) records. In the future, these may be extended to
1328 support other types of technology independent records. Each of
1329 these records allows additional fields (name/ value pairs) for
1330 extensibility. The VNF provider can use these VNF Provider-specific
1331 additional fields to provide additional information that may be
1332 relevant to the managing systems.
1334 - Technology Specific Records: This version of the document specifies
1335 the model for Mobile Flow records, Signaling and Voice Quality records.
1336 In the future, these may be extended to support other types of records
1337 (e.g. Network Fabric, Security records, etc.). Each of these records
1338 allows additional fields (name/value pairs) for extensibility. The VNF
1339 providers can use these VNF-specific additional fields to provide
1340 additional information that may be relevant to the managing systems.
1341 A placeholder for additional technology specific areas of interest to
1342 be defined in the future documents has been depicted.
1346 Figure 1. Data Model for Event Records
1348 Event Records - Data Structure Description
1349 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1351 The data structure for event records consists of:
1353 - a Common Event Header block;
1355 - zero or more technology independent domain blocks; and
1357 - e.g., Fault domain, State Change domain, Syslog domain, etc.
1359 - zero or more technology specific domain blocks.
1361 - e.g., Mobile Flow domain, Signaling domain, Voice Quality domain,
1365 ~~~~~~~~~~~~~~~~~~~~~
1367 The common header that precedes any of the domain-specific records contains
1368 information identifying the type of record to follow, information about
1369 the sender and other identifying characteristics related to timestamp,
1370 sequence number, etc.
1372 Technology Independent Records – Fault Fields
1373 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1375 The Fault Record, describing a condition in the Fault domain, contains
1376 information about the fault such as the entity under fault, the
1377 severity, resulting status, etc.
1379 Technology Independent Records – Heartbeat Fields
1380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1382 The Heartbeat Record provides an optional structure for communicating
1383 information about heartbeat or watchdog signaling events. It can
1384 contain information about service intervals, status information etc.
1385 as required by the heartbeat implementation.
1387 Note: Heartbeat records would only have the Common Event Header block.
1388 An optional heartbeat domain is available if required by the heartbeat
1391 Technology Independent Records – State Change Fields
1392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1394 The State Change Record provides a structure for communicating information
1395 about data flow through the VNF. It can contain information about state
1396 change related to physical device that is reported by VNF. As an example,
1397 when cards or port name of the entity that has changed state.
1399 Technology Independent Records – Syslog Fields
1400 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1402 The Syslog Record provides a structure for communicating any type of
1403 information that may be logged by the VNF. It can contain information
1404 about system internal events, status, errors, etc.
1406 Technology Independent Records – Threshold Crossing Alert Fields
1407 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1409 The Threshold Crossing Alert (TCA) Record provides a structure for
1410 communicating information about threshold crossing alerts. It can
1411 contain alert definitions and types, actions, events, timestamps
1412 and physical or logical details.
1414 Technology Independent Records - VNF Scaling Fields
1415 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1417 The VNF Scaling\* (short for measurementForVfScalingFields –
1418 actual name used in JSON specification) Record contains information
1419 about VNF and VNF resource structure and its condition to help in
1420 the management of the resources for purposes of elastic scaling.
1422 Technology Independent Records – otherFields
1423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1425 The otherFields Record defines fields for events belonging to the
1426 otherFields domain of the Technology Independent domain enumeration.
1427 This record provides a mechanism to convey a complex set of fields
1428 (possibly nested or opaque) and is purely intended to address
1429 miscellaneous needs such as addressing time-to-market considerations
1430 or other proof-of-concept evaluations. Hence, use of this record
1431 type is discouraged and should be minimized.
1433 Technology Specific Records – Mobile Flow Fields
1434 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1436 The Mobile Flow Record provides a structure for communicating
1437 information about data flow through the VNF. It can contain
1438 information about connectivity and data flows between serving
1439 elements for mobile service, such as between LTE reference points, etc.
1441 Technology Specific Records – Signaling Fields
1442 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1444 The Signaling Record provides a structure for communicating information
1445 about signaling messages, parameters and signaling state. It can
1446 contain information about data flows for signaling and controlling
1447 multimedia communication sessions such as voice and video calls.
1449 Technology Specific Records – Voice Quality Fields
1450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1451 The Voice Quality Record provides a structure for communicating information
1452 about voice quality statistics including media connection information,
1453 such as transmitted octet and packet counts, packet loss, packet delay
1454 variation, round-trip delay, QoS parameters and codec selection.
1456 Technology Specific Records – Future Domains
1457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1459 The futureDomains Record is a placeholder for additional technology
1460 specific areas of interest that will be defined and described
1461 in the future documents.
1463 Data Structure Specification of the Event Record
1464 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1466 For additional information on the event record formats of the data
1467 structures mentioned above, please refer to `VES Event
1468 Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__.
1470 Transports and Protocols Supporting Resource Interfaces
1471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1473 Delivery of data from VNFs to ONAP must use the common transport
1474 mechanisms and protocols for all VNFs as defined in this document.
1475 Transport mechanisms and protocols have been selected to enable both
1476 high volume and moderate volume datasets, as well as asynchronous and
1477 synchronous communications over secure connections. The specified
1478 encoding provides self-documenting content, so data fields can be
1479 changed as needs evolve, while minimizing changes to data delivery.
1481 The term ‘Event Record’ is used throughout this document to represent
1482 various forms of telemetry or instrumentation made available by the
1483 VNF including, faults, status events, various other types of VNF
1484 measurements and logs. Headers received by themselves must be used
1485 as heartbeat indicators. Common structures and delivery protocols for
1486 other types of data will be given in future versions of this document
1487 as we get more insight into data volumes and required processing.
1489 In the following sections, we provide options for encoding, serialization
1490 and data delivery. Agreements between Service Providers and VNF providers
1491 shall determine which encoding, serialization and delivery method to use
1492 for particular data sets. The selected methods must be agreed to prior to
1493 the on-boarding of the VNF into ONAP design studio.
1495 VNF Telemetry using VES/JSON Model
1496 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1498 The preferred model for data delivery from a VNF to ONAP DCAE is
1499 the JSON driven model as depicted in Figure 2.
1503 Figure 2. VES/JSON Driven Model
1505 VNF providers will provide a YAML artifact to the Service Provider
1508 * standard VES/JSON model information elements (key/values) that
1510 * any additional non-standard (custom) VES/JSON model information
1511 elements (key/values) that the VNF provides
1513 Using the semantics and syntax supported by YAML, VNF providers
1514 will indicate specific conditions that may arise, and recommend
1515 actions that should be taken at specific thresholds, or if specific
1516 conditions repeat within a specified time interval.
1518 Based on the VNF provider's recommendations, the Service Provider may
1519 create additional YAML artifacts (using ONAP design Studio), which
1520 finalizes Service Provider engineering rules for the processing of
1521 the VNF events. The Service Provider may alter the threshold levels
1522 recommended by the VNF providor, and may modify and more clearly
1523 specify actions that should be taken when specified conditions arise.
1524 The Service Provider-created version of the YAML artifact will be
1525 distributed to ONAP applications by the Design framework.
1527 VNF Telemetry using YANG Model
1528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1530 In addition to the JSON driven model described above, a YANG
1531 driven model can also be supported, as depicted in Figure 3.
1535 Figure 3. YANG Driven Model
1537 VNF providers will provide to the Service Provider the following
1538 YANG model artifacts:
1540 * common IETF YANG modules that support the VNF
1541 * native (VNF provider-supplied) YANG modules that support the VNF
1542 * open (OpenConfig) YANG modules and the following
1543 configuration-related information, including:
1545 * telemetry configuration and operational state data; such as:
1548 * subscription bindings
1550 * delivery frequency
1551 * transport mechanisms
1554 * a YAML artifact that provides all necessary mapping relationships
1555 between YANG model data types to VES/JSON information elements
1556 * YANG helper or decoder functions that automate the conversion between
1557 YANG model data types to VES/JSON information elements
1558 * OPTIONAL: YANG Telemetry modules in JSON format per RFC 7951
1560 Using the semantics and syntax supported by YANG, VNF providers
1561 will indicate specific conditions that may arise, and recommend
1562 actions that should be taken at specific thresholds, or if specific
1563 conditions repeat within a specified time interval.
1565 Based on the VNF provider's recommendations, the Service Provider may
1566 create additional YAML artifacts (using ONAP design Studio), which
1567 finalizes Service Provider engineering rules for the processing of the
1568 VNF events. The Service Provider may alter the threshold levels recommended
1569 by the VNF provider, and may modify and more clearly specify actions that
1570 should be taken when specified conditions arise. The Service
1571 Provided-created version of the YAML will be distributed to ONAP
1572 applications by the Design framework.
1574 Note: While supporting the YANG model described above, we are still
1575 leveraging the VES JSON based model in DCAE. The purpose of the
1576 diagram above is to illustrate the concept only and not to imply a
1577 specific implementation.
1579 VNF Telemetry using Google Protocol Buffers
1580 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1582 In addition to the data delivery models described above, support for
1583 delivery of VNF telemetry using Google Protocol Buffers (GPB) can
1584 also be supported, as depicted in Figure 4.
1586 VNF providers will provide to the Service Provider the additional
1587 following artifacts to support the delivery of VNF telemetry to DCAE
1588 via the open-source gRPC mechanism using Google's Protocol Buffers:
1590 * the YANG model artifacts described in support of the
1591 "VNF Telemetry using YANG Model"
1592 * valid definition file(s) for all GPB / KV-GPB encoded messages
1593 * valid definition file(s) for all gRPC services
1594 * gRPC method parameters and return types specified as Protocol
1599 Figure 4. Protocol Buffers Driven Model
1601 Note: if Google Protocol Buffers are employed for delivery of VNF
1602 telemetry, Key-Value Google Protocol Buffers (KV-GPB) is the
1603 preferred serialization method. Details of specifications and
1604 versioning corresponding to a release can be found at:
1605 `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__.
1607 Note: While supporting the VNF telemetry delivery approach described above,
1608 we are still leveraging the VES JSON based model in DCAE. The purpose of
1609 the diagram above is to illustrate the concept only and not to imply a
1610 specific implementation.
1612 Monitoring & Management Requirements
1613 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1615 VNF telemetry via standardized interface
1616 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1618 * R-51910 The xNF **MUST** provide all telemetry (e.g., fault event
1619 records, syslog records, performance records etc.) to ONAP using the
1620 model, format and mechanisms described in this section.
1622 Encoding and Serialization
1623 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1625 Content delivered from VNFs to ONAP is to be encoded and serialized using JSON:
1630 * R-19624 The xNF **MUST** encode and serialize content delivered to ONAP using JSON (RFC 7159) plain text format. High-volume data
1631 is to be encoded and serialized using `Avro <http://avro.apache.org/>`_, where the Avro [5]_ data format are described using JSON.
1633 - JSON plain text format is preferred for moderate volume data sets
1634 (option 1), as JSON has the advantage of having well-understood simple
1635 processing and being human-readable without additional decoding. Examples
1636 of moderate volume data sets include the fault alarms and performance
1637 alerts, heartbeat messages, measurements used for xNF scaling and syslogs.
1638 - Binary format using Avro is preferred for high volume data sets
1639 (option 2) such as mobility flow measurements and other high-volume
1640 streaming events (such as mobility signaling events or SIP signaling)
1641 or bulk data, as this will significantly reduce the volume of data
1642 to be transmitted. As of the date of this document, all events are
1643 reported using plain text JSON and REST.
1644 - Avro content is self-documented, using a JSON schema. The JSON schema is
1645 delivered along with the data content
1646 (http://avro.apache.org/docs/current/ ). This means the presence and
1647 position of data fields can be recognized automatically, as well as the
1648 data format, definition and other attributes. Avro content can be
1649 serialized as JSON tagged text or as binary. In binary format, the
1650 JSON schema is included as a separate data block, so the content is
1651 not tagged, further compressing the volume. For streaming data, Avro
1652 will read the schema when the stream is established and apply the
1653 schema to the received content.
1655 In addition to the preferred method (JSON), content can be delivered
1656 from xNFs to ONAP can be encoded and serialized using Google Protocol
1662 Telemetry data delivered using Google Protocol Buffers v3 (proto3)
1663 can be serialized in one of the following methods:
1665 * Key-value Google Protocol Buffers (KV-GPB) is also known as
1666 self-describing GPB:
1668 * keys are strings that correspond to the path of the system
1669 resources for the VNF being monitored.
1670 * values correspond to integers or strings that identify the
1671 operational state of the VNF resource, such a statistics counters
1672 and the state of a VNF resource.
1674 * VNF providers must supply valid KV-GPB definition file(s) to allow
1675 for the decoding of all KV-GPB encoded telemetry messages.
1677 * Native Google Protocol Buffers (GPB) is also known as compact GPB:
1679 * keys are represented as integers pointing to the system resources for
1680 the VNF being monitored.
1681 * values correspond to integers or strings that identify the operational
1682 state of the VNF resource, such a statistics counters and the state
1685 * Google Protocol Buffers (GPB) requires metadata in the form of .proto
1686 files. VNF providers must supply the necessary GPB .proto files such that
1687 GPB telemetry messages can be encoded and decoded.
1689 * In the future, we may consider support for other types of
1690 encoding & serialization methods based on industry demand.
1694 ~~~~~~~~~~~~~~~~~~~~~
1696 * R-98191 The xNF **MUST** vary the frequency that asynchronous data
1697 is delivered based on the content and how data may be aggregated or
1698 grouped together. For example, alarms and alerts are expected to be
1699 delivered as soon as they appear. In contrast, other content, such as
1700 performance measurements, KPIs or reported network signaling may have
1701 various ways of packaging and delivering content. Some content should
1702 be streamed immediately; or content may be monitored over a time interval,
1703 then packaged as collection of records and delivered as block; or data
1704 may be collected until a package of a certain size has been collected;
1705 or content may be summarized statistically over a time interval, or
1706 computed as a KPI, with the summary or KPI being delivered.
1708 - We expect the reporting frequency to be configurable depending
1709 on the virtual network function’s needs for management. For example,
1710 Service Provider may choose to vary the frequency of collection between
1711 normal and trouble-shooting scenarios.
1712 - Decisions about the frequency of data reporting will affect the
1713 size of delivered data sets, recommended delivery method, and how the
1714 data will be interpreted by ONAP. These considerations should not
1715 affect deserialization and decoding of the data, which will be guided
1716 by the accompanying JSON schema or GPB definition files.
1718 Addressing and Delivery Protocol
1719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1721 ONAP destinations can be addressed by URLs for RESTful data PUT. Future
1722 data sets may also be addressed by host name and port number for TCP
1723 streaming, or by host name and landing zone directory for SFTP transfer
1726 * R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain
1727 text JSON for moderate sized asynchronous data sets, and for high
1728 volume data sets when feasible.
1729 * R-84879 The xNF **MUST** have the capability of maintaining a primary
1730 and backup DNS name (URL) for connecting to ONAP collectors, with the
1731 ability to switch between addresses based on conditions defined by policy
1732 such as time-outs, and buffering to store messages until they can be
1733 delivered. At its discretion, the service provider may choose to populate
1734 only one collector address for a xNF. In this case, the network will
1735 promptly resolve connectivity problems caused by a collector or network
1736 failure transparently to the xNF.
1737 * R-81777 The xNF **MUST** be configured with initial address(es) to use
1738 at deployment time. Subsequently, address(es) may be changed through
1739 ONAP-defined policies delivered from ONAP to the xNF using PUTs to a
1740 RESTful API, in the same manner that other controls over data reporting
1741 will be controlled by policy.
1742 * R-08312 The xNF **MAY** use other options which are expected to include:
1744 - REST delivery of binary encoded data sets.
1745 - TCP for high volume streaming asynchronous data sets and for other
1746 high volume data sets. TCP delivery can be used for either
1747 JSON or binary encoded data sets.
1748 - SFTP for asynchronous bulk files, such as bulk files that contain
1749 large volumes of data collected over a long time interval or data
1750 collected across many xNFs. This is not preferred. Preferred is to
1751 reorganize the data into more frequent or more focused data sets, and
1752 deliver these by REST or TCP as appropriate.
1753 - REST for synchronous data, using RESTCONF (e.g., for xNF state polling).
1755 * R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses
1756 as data destinations for each xNF, and may be changed by Policy while
1757 the xNF is in operation. We expect the xNF to be capable of redirecting
1758 traffic to changed destinations with no loss of data, for example from
1759 one REST URL to another, or from one TCP host and port to another.
1761 Asynchronous and Synchronous Data Delivery
1762 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1764 * R-06924 The xNF **MUST** deliver asynchronous data as data becomes
1765 available, or according to the configured frequency.
1766 * R-73285 The xNF **MUST** must encode, address and deliver the data
1767 as described in the previous paragraphs.
1768 * R-42140 The xNF **MUST** respond to data requests from ONAP as soon
1769 as those requests are received, as a synchronous response.
1770 * R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by
1771 the ONAP configuration subsystem for synchronous communication.
1772 * R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF
1773 [RFC8040] (https://tools.ietf.org/html/rfc8040).
1774 * R-11240 The xNF **MUST** respond with content encoded in JSON, as
1775 described in the RESTCONF specification. This way the encoding of a
1776 synchronous communication will be consistent with Avro.
1777 * R-70266 The xNF **MUST** respond to an ONAP request to deliver the
1778 current data for any of the record types defined in
1779 `Event Records - Data Structure Description`_ by returning the requested
1780 record, populated with the current field values. (Currently the defined
1781 record types include fault fields, mobile flow fields, measurements for
1782 xNF scaling fields, and syslog fields. Other record types will be added
1783 in the future as they become standardized and are made available.)
1784 * R-46290 The xNF **MUST** respond to an ONAP request to deliver granular
1785 data on device or subsystem status or performance, referencing the YANG
1786 configuration model for the xNF by returning the requested data elements.
1787 * R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG
1788 <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be
1789 translated to and from JSON{RFC7951]. YANG configuration and content can
1790 be represented via JSON, consistent with Avro, as described in “Encoding
1791 and Serialization” section.
1796 * R-42366 The xNF **MUST** support secure connections and transports such as
1797 Transport Layer Security (TLS) protocol
1798 [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to
1799 the best current practices outlined in
1800 `RFC7525 <https://tools.ietf.org/html/rfc7525>`_.
1801 * R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation
1802 of connections, through secure credentials, log-on and exchange mechanisms.
1803 * R-47597 The xNF **MUST** carry data in motion only over secure connections.
1804 * R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal
1805 Information (SPI) or certain proprietary data, in addition to applying the
1806 regular procedures for securing access and delivery.
1810 https://github.com/mbj4668/pyang
1813 Recall that the Node Object **is required** to be identical across
1814 all VMs of a VNF invoked as part of the action except for the “name”.
1817 Upstream elements must provide the appropriate FQDN in the request to
1818 ONAP for the desired action.
1821 Multiple ONAP actions may map to one playbook.
1824 This option is not currently supported in ONAP and it is currently
1825 under consideration.
1828 https://wiki.opnfv.org/display/PROJ/VNF+Event+Stream
1830 .. |image0| image:: Data_Model_For_Event_Records.png
1835 .. |image1| image:: VES_JSON_Driven_Model.png
1839 .. |image2| image:: YANG_Driven_Model.png
1843 .. |image3| image:: Protocol_Buffers_Driven_Model.png