1 **7. ONAP Management Requirements**
2 =====================================
7 The ONAP Design Time Framework provides the ability to design NFV
8 resources including VNFs, services, and products. The vendor must
9 provide VNF packages that include a rich set of recipes, management and
10 functional interfaces, policies, configuration parameters, and
11 infrastructure requirements that can be utilized by the ONAP Design
12 module to onboard and catalog these resources. Initially this
13 information may be provided in documents, but in the near future a
14 method will be developed to automate as much of the transfer of data as
15 possible to satisfy its long term requirements.
17 The current VNF Package Requirement is based on a subset of the
18 Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
19 and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
20 (NFV), Management and Orchestration, VNF Packaging Specification.
24 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
25 | **Principle** | **Description** | **Type** | **ID #** |
26 +========================+===================================================================================================================================================================================================================================================================================================================================================================+============+============+
27 | 2.0.1 | The VNF Vendor must provide a Manifest File that contains a list of all the components in the VNF package. | Must | 10010 |
32 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
33 | | The package must include VNF Identification Data to uniquely identify the resource for a given Vendor. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF Vendor, VNF description, VNF Vendor, and version. | Must | 10020 |
34 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
35 | | The VNF Vendor must provide documentation describing VNF Management APIs. The document must include information and tools for: | Optional | 10030 |
37 | | - ONAP to deploy and configure (initially and ongoing) the VNF application(s) (e.g., NETCONF APIs). Includes description of configurable parameters for the VNF and whether the parameters can be configured after VNF instantiation. | | |
39 | | - ONAP to monitor the health of the VNF (conditions that require healing and/or scaling responses). Includes a description of: | | |
41 | | - Parameters that can be monitored for the VNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the VNF after instantiation. | | |
43 | | - Runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the VNF. | | |
44 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
45 | | The VNF package must include documentation describing VNF Functional APIs that are utilized to build network and application services. Provides the externally exposed functional inputs and outputs for the VNF, including interface format and protocols supported. | Must | 10040 |
46 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
47 | | The VNF Vendor must provide documentation describing VNF Functional Capabilities that are utilized to operationalize the VNF and compose complex services. | Must | 10050 |
48 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
49 | | The VNF Vendor must provide information regarding any dependency with other VNFs and resources. | Must | 10060 |
50 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
51 | 2.0.2 | The VNF Vendor must provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. This will include VNF attributes/parameters and valid values/attributes configurable by policy. | Optional | 10070 |
55 | Configuration | | | |
56 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
57 | | The VNF Package must include configuration scripts for boot sequence and configuration. | Must | 10080 |
58 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
59 | | The VNF Vendor must provide configurable parameters (if unable to conform to YANG model) including VNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data). | Optional | 10090 |
60 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
61 | 2.0.3 | The VNF Vendor must provide documentation for the VNF Policy Description to manage the VNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the VNF. | Must | 10100 |
65 | Control Loop | | | |
66 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
67 | | The VNF Package must include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the VNF. The document must include: | Must | 10110 |
69 | | - A unique identification string for the specific VNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue. | | |
71 | | - All events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event. | | |
73 | | - All events (fault, measurement for VNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in *VNF Guidelines for Network Cloud and ONAP*) and for the overall VNF. | | |
74 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
75 | | The VNF Vendor must provide documentationthat contains a list of VNF error codes, descriptions of the error, and possible causes/corrective action. | Optional | 10120 |
76 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
77 | | Provide documentation describing all parameters that are available to monitor the VNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc., that must be collected for reporting purposes. The documentation must include a list of: | Optional | 10130 |
79 | | - Monitoring parameters/counters exposed for virtual resource management and VNF application management. | | |
81 | | - KPIs and metrics that need to be collected at each VM for capacity planning purposes. | | |
83 | | - For each KPI, provide lower and upper limits. | | |
85 | | - When relevant, provide a threshold crossing alert point for each KPI at which time scaling rules will apply. | | |
87 | | - For each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded. | | |
89 | | - Describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the VNF. | | |
91 | | - When applicable, provide calculators needed to convert raw data into appropriate reporting artifacts. | | |
92 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
93 | | The VNF Package must include documentation describing supported VNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls). | Optional | 10140 |
94 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
95 | | The VNF Package must include documentation describing the characteristics for the VNF reliability and high availability. | Must | 10150 |
96 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
97 | 2.0.4 | The VNF Package must include VNF topology that describes basic network and application connectivity internal and external to the VNF including Link type, KPIs, Bandwidth, QoS (if applicable) for each interface. | Must | 10160 |
105 | Requirements | | | |
106 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
107 | | The VNF Package must include VM requirements via a Heat template that provides the necessary data for: | Optional | 10170 |
109 | | - VM specifications for all VNF components - for hypervisor, CPU, memory, storage. | | |
111 | | - Network connections, interface connections, internal and external to VNF. | | |
113 | | - High availability redundancy model. | | |
115 | | - Static scaling/growth VM specifications. | | |
117 | | Note1: Must comply with the *Heat Template Requirements for Virtual Network Functions*. | | |
119 | | Note2: Must comply with the Network Cloud Specifications defined in *Example Implementation of Network Cloud.* | | |
120 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
121 | | The VNF Vendor must provide the binaries and images needed to instantiate the VNF (VNF and VNFC images). | Must | 10180 |
122 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
123 | | The VNF Vendor must describe scaling capabilities to manage scaling characteristics of the VNF. | Must | 10190 |
124 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
125 | 2.0.5 | The VNF Package must include documentation describing the tests that were conducted by the Vendor and the test results. | Must | 10200 |
128 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
129 | | The VNF Vendor must provide their testing scripts to support testing. | Must | 10210 |
130 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
131 | | The VNF Vendor must provide software components that can be packaged with/near the VNF, if needed, to simulate any functions or systems that connect to the VNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators. | Must | 10220 |
132 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
133 | 2.0.6 | VNFs must provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license. | Must | 10230 |
135 | Licensing Guidelines | | | |
136 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
137 | | Contract shall define the reporting process and the available reporting tools. The vendor will have to agree to the process that can be met by Service Provider reporting infrastructure. | Must | 10240 |
138 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
139 | | VNF vendors shall enumerate all of the open source licenses their VNF(s) incorporate. | Must | 10250 |
140 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
141 | | Audits of Service Provider’s business must not be required. | Must | 10260 |
142 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
143 | | Vendor functions and metrics that require additional infrastructure such as a vendor license server for deployment shall not be supported. | Must | 10270 |
144 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
145 | | Provide clear measurements for licensing purposes to allow automated scale up/down by the management system. | Must | 10280 |
146 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
147 | | The vendor must provide the ability to scale up a vendor supplied product during growth and scale down a vendor supplied product during decline without “real-time” restrictions based upon vendor permissions. | Must | 10290 |
148 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
149 | | A universal license key must be provided per VNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The vendor may provide pools of Unique VNF License Keys, where there is a unique key for each VNF instance as an alternate solution. Licensing issues should be resolved without interrupting in-service VNFs. | Must | 10300 |
150 +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
152 b. VNF On-boarding and package management
153 ==========================================
158 The ONAP Design Time Framework provides the ability to design NFV
159 resources including VNFs, Services, and products. The vendor must
160 provide VNF packages that include a rich set of recipes, management and
161 functional interfaces, policies, configuration parameters, and
162 infrastructure requirements that can be utilized by the ONAP Design
163 module to onboard and catalog these resources. Initially this
164 information may be provided in documents, but in the near future a
165 method will be developed to automate as much of the transfer of data as
166 possible to satisfy its long term requirements.
168 The current VNF Package Requirement is based on a subset of the
169 Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
170 and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
171 (NFV), Management and Orchestration, VNF Packaging Specification.
173 **Resource Description**
175 * R-xxxxx The VNF Vendor **MUST** include a Manifest File that contains a list of all the components in the VNF package.
176 * R-xxxxx The VNF Package **MUST** include VNF Identification Data to uniquely identify the resource for a given Vendor. The identification data must include: an identifier for the VNF, the name of the VNF as was given by the VNF Vendor, VNF description, VNF Vendor, and version.
177 * R-xxxxx The VNF Package **MUST** include documentation describing VNF Management APIs. The document must include information and tools for:
179 - ONAP to deploy and configure (initially and ongoing) the VNF application(s) (e.g., NETCONF APIs). Includes description of configurable parameters for the VNF and whether the parameters can be configured after VNF instantiation.
180 - ONAP to monitor the health of the VNF (conditions that require healing and/or scaling responses). Includes a description of:
182 - Parameters that can be monitored for the VNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the VNF after instantiation.
183 - Runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the VNF.
184 * R-xxxxx The VNF Package **MUST** include documentation describing VNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the VNF, including interface format and protocols supported.
185 * R-xxxxx The VNF Vendor **MUST** provide documentation describing VNF Functional Capabilities that are utilized to operationalize the VNF and compose complex services.
186 * R-xxxxx The VNF Vendor **MUST** provide information regarding any dependency (e.g., affinity, anti-affinity) with other VNFs and resources.
188 **Resource Configuration**
190 * R-xxxxx The VNF **MUST** support and provide artifacts for configuration management using at least one of the following technologies:
194 Note: The requirements for Netconf/YANG, Chef, and Ansible protocols are provided separately and must be supported only if the corresponding protocol option is provided by the vendor.
196 **Configuration Management via Netconf/YANG**
198 * R-xxxxx The VNF Vendor **MUST** provide a Resource/Device YANG model as a foundation for creating the YANG model for configuration. This will include VNF attributes/parameters and valid values/attributes configurable by policy.
199 **Configuration Management via Chef**
201 * R-xxxxx The VNF Vendor **MUST** provide cookbooks to be loaded on the appropriate Chef Server.
202 * R-xxxxx The VNF Vendor **MUST** provide a JSON file for each supported action for the VNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Appendix A.
203 Note: Chef support in ONAP is not currently available and planned for 4Q 2017.
205 **Configuration Management via Ansible**
207 * R-xxxxx The VNF Vendor **MUST** provide playbooks to be loaded on the appropriate Ansible Server.
208 * R-xxxxx The VNF Vendor **MUST** provide a JSON file for each supported action for the VNF. The JSON file must contain key value pairs with all relevant values populated with sample data that illustrates its usage. The fields and their description are defined in Appendix B.
209 Note: Ansible support in ONAP is not currently available and planned for 4Q 2017.
210 * R-xxxxx The VNF Package **MUST** include configuration scripts for boot sequence and configuration.
211 * R-xxxxx The VNF Vendor **MUST** provide configurable parameters (if unable to conform to YANG model) including VNF attributes/parameters and valid values, dynamic attributes and cross parameter dependencies (e.g., customer provisioning data).
213 **Resource Control Loop**
215 * R-xxxxx The VNF Vendor **MUST** provide documentation for the VNF Policy Description to manage the VNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the VNF.
216 * R-xxxxx The VNF Package **MUST** include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the VNF. The document must include:
217 - A unique identification string for the specific VNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue.
218 - All events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event.
219 - All events (fault, measurement for VNF Scaling, Syslogs, State Change and Mobile Flow), that need to be collected at each VM, VNFC (defined in *VNF Guidelines for Network Cloud and ONAP*) and for the overall VNF.
220 * R-xxxxx The VNF Vendor **MUST** provide an XML file that contains a list of VNF error codes, descriptions of the error, and possible causes/corrective action.
221 * R-xxxxx The VNF Package **MUST** include documentation describing all parameters that are available to monitor the VNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes. The documentation must include a list of:
223 - Monitoring parameters/counters exposed for virtual resource management and VNF application management.
224 - KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes.
225 - The monitoring parameters must include latencies, success rates, retry rates, load and quality (e.g., DPM) for the key transactions/functions supported by the VNF and those that must be exercised by the VNF in order to perform its function.
226 - For each KPI, provide lower and upper limits.
227 - When relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing.
228 - For each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded.
229 - Describe any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the VNF.
230 - When applicable, provide calculators needed to convert raw data into appropriate reporting artifacts.
231 * R-xxxxx The VNF Package **MUST** include documentation describing supported VNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls).
232 * R-xxxxx The VNF Package **MUST** include documentation describing the characteristics for the VNF reliability and high availability.
233 * R-xxxxx The VNF Vendor **MUST** provide an artifact per VNF that contains all of the VNF Event Records supported. The artifact should include reference to the specific release of the VNF Event Stream Common Event Data Model document it is based on. ( `AT&T Service Specification; Service: VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
235 **Compute, Network, abd Storage Requirements**
237 * R-xxxxx The VNF Package **MUST** include VNF topology that describes basic network and application connectivity internal and external to the VNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) for each interface.
238 * R-xxxxx The VNF Package **MUST** include VM requirements via a Heat template that provides the necessary data for:
240 - VM specifications for all VNF components - for hypervisor, CPU, memory, storage.
241 - Network connections, interface connections, internal and external to VNF.
242 - High availability redundancy model.
243 - Scaling/growth VM specifications.
244 Note: Must comply with the *Heat requirements in 5.b*.
245 * R-xxxxx The VNF Vendor **MUST** provide the binaries and images needed to instantiate the VNF (VNF and VNFC images).
246 * R-xxxxx The VNF Vendor **MUST** describe scaling capabilities to manage scaling characteristics of the VNF.
251 * R-xxxxx The VNF Package **MUST** include documentation describing the tests that were conducted by the Vendor and the test results.
252 * R-xxxxx The VNF Vendor **MUST** provide their testing scripts to support testing.
253 * R-xxxxx The VNF Vendor **MUST** provide software components that can be packaged with/near the VNF, if needed, to simulate any functions or systems that connect to the VNF system under test. This component is necessary only if the existing testing environment does not have the necessary simulators.
255 **Licensing Requirements**
257 * R-xxxxx The VNF **MUST** provide metrics (e.g., number of sessions, number of subscribers, number of seats, etc.) to ONAP for tracking every license.
258 * R-xxxxx The VNF Vendor **MUST** agree to the process that can be met by Service Provider reporting infrastructure. The Contract shall define the reporting process and the available reporting tools.
259 * R-xxxxx The VNF Vendor **MUST** enumerate all of the open source licenses their VNF(s) incorporate.
260 * R-xxxxx The VNF Vendor **MUST NOT** require audits of Service Provider’s business.
261 * R-xxxxx The VNF Vendor **MUST NOT** require additional infrastructure such as a vendor license server for Vendor functions and metrics..
262 * R-xxxxx The VNF **MUST** provide clear measurements for licensing purposes to allow automated scale up/down by the management system.
263 * R-xxxxx The VNF Vendor **MUST** provide the ability to scale up a vendor supplied product during growth and scale down a vendor supplied product during decline without “real-time” restrictions based upon vendor permissions.
264 * R-xxxxx The VNF Vendor **MUST** provide a universal license key per VNF to be used as needed by services (i.e., not tied to a VM instance) as the recommended solution. The vendor may provide pools of Unique VNF License Keys, where there is a unique key for each VNF instance as an alternate solution. Licensing issues should be resolved without interrupting in-service VNFs.
265 * R-xxxxx The VNF Vendor **MUST** support the metadata about licenses (and their applicable entitlements) as defined in this document for VNF software, and any license keys required to authorize use of the VNF software. This metadata will be used to facilitate onboarding the VNF into the ONAP environment and automating processes for putting the licenses into use and managing the full lifecycle of the licenses. The details of this license model are described in Appendix C. Note: License metadata support in ONAP is not currently available and planned for 1Q 2018.
267 c. Configuration Management
268 ===========================
270 ONAP interacts directly with VNFs through its Network and Application
271 Adapters to perform configuration activities within NFV environment.
272 These activities include service and resource
273 configuration/reconfiguration, automated scaling of resources, service
274 and resource removal to support runtime lifecycle management of VNFs and
275 services. The Adapters employ a model driven approach along with
276 standardized APIs provided by the VNF developers to configure resources
277 and manage their runtime lifecycle.
279 NETCONF Standards and Capabilities
280 ----------------------------------
282 ONAP Controllers and their Adapters utilize device YANG model and
283 NETCONF APIs to make the required changes in the VNF state and
284 configuration. The VNF providers must provide the Device YANG model and
285 NETCONF server supporting NETCONF APIs to comply with target ONAP and
288 **Table 2. VNF Configuration via NETCONF**
290 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
291 | **Principle** | **Description** | **Type** | **ID #** |
292 +=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+============+============+
293 | Configuration | Virtual Network functions (VNFs) must include a NETCONF server enabling runtime configuration and lifecycle management capabilities. The NETCONF server embedded in VNFs shall provide a NETCONF interface fully defined by supplied YANG models. | Must | 11010 |
296 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
297 | NETCONF | NETCONF server connection parameters shall be configurable during virtual machine instantiation through Heat templates where SSH keys, usernames, passwords, SSH service and SSH port numbers are Heat template parameters. | Must | 11020 |
301 | Requirements | | | |
302 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
303 | | Following protocol operations must be implemented: | Must | 11030 |
305 | | **close-session()**- Gracefully close the current session. | | |
307 | | **commit(confirmed, confirm-timeout)** - Commit candidate configuration datastore to the running configuration. | | |
309 | | **discard-changes()** - Revert the candidate configuration datastore to the running configuration | | |
311 | | **edit-config(target, default-operation, test-option, error-option, config)** - Edit the target configuration datastore by merging, replacing, creating, or deleting new config elements. | | |
313 | | **get(filter)** - Retrieve (a filtered subset of) the running configuration and device state information. This should include the list of VNF supported schemas. | | |
315 | | **get-config(source, filter)** - Retrieve a (filtered subset of a) configuration from the configuration datastore source. | | |
317 | | **kill-session(session)** - Force the termination of **session**. | | |
319 | | **lock(target)** - Lock the configuration datastore target. | | |
321 | | **unlock(target)** - Unlock the configuration datastore target. | | |
322 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
323 | | Following protocol operations should be implemented: | Should | 11040 |
325 | | **copy-config(target, source) -** Copy the content of the configuration datastore source to the configuration datastore target. | | |
327 | | **delete-config(target) -** Delete the named configuration datastore target. | | |
329 | | **get-schema(identifier, version, format) -** Retrieve the YANG schema. | | |
330 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
331 | | All configuration data shall be editable through a NETCONF <*edit-config*> operation. Proprietary NETCONF RPCs that make configuration changes are not sufficient. | Must | 11050 |
332 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
333 | | By default, the entire configuration of the VNF must be retrievable via NETCONF's <get-config> and <edit-config>, independently of whether it was configured via NETCONF or other mechanisms. | Must | 11060 |
334 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
335 | | The **:partial-lock** and **:partial-unlock** capabilities, defined in RFC 5717 must be supported. This allows multiple independent clients to each write to a different part of the <running> configuration at the same time. | Must | 11070 |
336 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
337 | | The **:rollback-on-error** value for the <error-option> parameter to the <edit-config> operation must be supported. If any error occurs during the requested edit operation, then the target database (usually the running configuration) will be left affected. This provides an 'all-or-nothing' edit mode for a single <edit-config> request. | Must | 11080 |
338 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
339 | | The server must support the **:startup** capability. It will allow the running configuration to be copied to this special database. It can also be locked and unlocked. | Must | 11090 |
340 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
341 | | The **:url** value must be supported to specify protocol operation source and target parameters. The capability URI for this feature will indicate which schemes (e.g., file, https, sftp) that the server supports within a particular URL value. The 'file' scheme allows for editable local configuration databases. The other schemes allow for remote storage of configuration databases. | Must | 11100 |
342 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
343 | | At least one of the capabilities **:candidate** or **:writable-running** must be implemented. If both **:candidate** and **:writable-running** are provided then two locks should be supported. | Must | 11110 |
344 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
345 | | The server must fully support the XPath 1.0 specification for filtered retrieval of configuration and other database contents. The 'type' attribute within the <filter> parameter for <get> and <get-config> operations may be set to 'xpath'. The 'select' attribute (which contains the XPath expression) will also be supported by the server. A server may support partial XPath retrieval filtering, but it cannot advertise the **:xpath** capability unless the entire XPath 1.0 specification is supported. | Must | 11120 |
346 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
347 | | The **:validate** capability must be implemented. | Must | 11130 |
348 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
349 | | If **:candidate** is supported, **:confirmed-commit** must be implemented. | Must | 11140 |
350 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
351 | | The **:with-defaults** capability [RFC6243] shall be implemented. | Must | 11150 |
352 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
353 | | Data model discovery and download as defined in [RFC6022] shall be implemented. | Must | 11160 |
354 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
355 | | NETCONF Event Notifications [RFC5277] should be implemented. | Should | 11170 |
356 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
357 | | All data models shall be defined in YANG [RFC6020], and the mapping to NETCONF shall follow the rules defined in this RFC. | Must | 11180 |
358 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
359 | | The data model upgrade rules defined in [RFC6020] section 10 should be followed. All deviations from section 10 rules shall be handled by a built-in automatic upgrade mechanism. | Must | 11190 |
360 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
361 | | The VNF must support parallel and simultaneous configuration of separate objects within itself. | Must | 11200 |
362 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
363 | | Locking is required if a common object is being manipulated by two simultaneous NETCONF configuration operations on the same VNF within the context of the same writable running data store (e.g., if an interface parameter is being configured then it should be locked out for configuration by a simultaneous configuration operation on that same interface parameter). | Must | 11210 |
364 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
365 | | Locking must be applied based on the sequence of NETCONF operations, with the first configuration operation locking out all others until completed. | Must | 11220 |
366 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
367 | | If a VNF needs to lock an object for configuration, the lock must be permitted at the finest granularity to avoid blocking simultaneous configuration operations on unrelated objects (e.g., BGP configuration should not be locked out if an interface is being configured, Entire Interface configuration should not be locked out if a non-overlapping parameter on the interface is being configured). The granularity of the lock must be able to be specified via a restricted or full XPath expression. | Must | 11230 |
368 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
369 | | All simultaneous configuration operations should guarantee the VNF configuration integrity (e.g., if a change is attempted to the BUM filter rate from multiple interfaces on the same EVC, then they need to be sequenced in the VNF without locking either configuration method out). | Must | 11240 |
370 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
371 | | To prevent permanent lock-outs, locks must be released: | Must | 11250 |
373 | | a. when/if a session applying the lock is terminated (e.g., SSH session is terminated) | | |
375 | | b. when the corresponding <partial-unlock> operation succeeds | | |
377 | | c. when a user configured timer has expired forcing the NETCONF SSH Session termination (i.e., product must expose a configuration knob for a user setting of a lock expiration timer) | | |
379 | | Additionally, to guard against hung NETCONF sessions, another NETCONF session should be able to initiate the release of the lock by killing the session owning the lock, using the <kill-session> operation. | | |
380 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
381 | | The VNF should support simultaneous <commit> operations within the context of this locking requirements framework. | Must | 11260 |
382 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
383 | | The supplied YANG code and associated NETCONF servers shall support all operations, administration and management (OAM) functions available from the supplier for VNFs. | Must | 11270 |
384 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
385 | | Sub tree filtering must be supported. | Must | 11280 |
386 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
387 | | Heartbeat via a <get> with null filter shall be supported. | Must | 11290 |
388 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
389 | | Get-schema (ietf-netconf-monitoring) must be supported to pull YANG model over session. | Must | 11300 |
390 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
391 | | The supplied YANG code shall be validated using the open source pyang [2]_ program using the following commands: | Must | 11310 |
393 | | $ pyang --verbose --strict <YANG-file-name(s)> | | |
396 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
397 | | The echo command must return a zero value otherwise the validation has failed. | Must | 11320 |
398 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
399 | | The supplier shall demonstrate mounting the NETCONF server on OpenDaylight (client) and: | Must | 11330 |
401 | | - Modify, update, change, rollback configurations using each configuration data element. | | |
403 | | - Query each state (non-configuration) data element. | | |
405 | | - Execute each YANG RPC. | | |
407 | | - Receive data through each notification statement. | | |
408 +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
410 The following table provides the Yang models that suppliers must
411 conform, and those where applicable, that suppliers need to use.
415 +----------------+------------------------------------------------------------------------------------+------------+------------+
416 | **RFC** | **Description** | **Type** | **ID #** |
417 +================+====================================================================================+============+============+
418 | RFC 6020 | YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF) | Must | 12010 |
419 +----------------+------------------------------------------------------------------------------------+------------+------------+
420 | RFC 6022 | YANG module for NETCONF monitoring | Must | 12020 |
421 +----------------+------------------------------------------------------------------------------------+------------+------------+
422 | RFC 6470 | NETCONF Base Notifications | Must | 12030 |
423 +----------------+------------------------------------------------------------------------------------+------------+------------+
424 | RFC 6244 | An Architecture for Network Management Using NETCONF and YANG | Must | 12040 |
425 +----------------+------------------------------------------------------------------------------------+------------+------------+
426 | RFC 6087 | Guidelines for Authors and Reviewers of YANG Data Model Documents | Must | 12050 |
427 +----------------+------------------------------------------------------------------------------------+------------+------------+
428 | \*\*RFC 6991 | Common YANG Data Types | Should | 12060 |
429 +----------------+------------------------------------------------------------------------------------+------------+------------+
430 | RFC 6536 | NETCONF Access Control Model | Should | 12070 |
431 +----------------+------------------------------------------------------------------------------------+------------+------------+
432 | RFC 7223 | A YANG Data Model for Interface Management | Should | 12080 |
433 +----------------+------------------------------------------------------------------------------------+------------+------------+
434 | RFC 7224 | IANA Interface Type YANG Module | Should | 12090 |
435 +----------------+------------------------------------------------------------------------------------+------------+------------+
436 | RFC 7277 | A YANG Data Model for IP Management | Should | 12100 |
437 +----------------+------------------------------------------------------------------------------------+------------+------------+
438 | RFC 7317 | A YANG Data Model for System Management | Should | 12110 |
439 +----------------+------------------------------------------------------------------------------------+------------+------------+
440 | RFC 7407 | A YANG Data Model for SNMP Configuration | Should | 12120 |
441 +----------------+------------------------------------------------------------------------------------+------------+------------+
443 The NETCONF server interface shall fully conform to the following
446 Table 4. NETCONF RFCs
448 +------------+--------------------------------------------------------------------+------------+------------+
449 | **RFC** | **Description** | **Type** | **ID #** |
450 +============+====================================================================+============+============+
451 | RFC 4741 | NETCONF Configuration Protocol | Must | 12130 |
452 +------------+--------------------------------------------------------------------+------------+------------+
453 | RFC 4742 | Using the NETCONF Configuration Protocol over Secure Shell (SSH) | Must | 12140 |
454 +------------+--------------------------------------------------------------------+------------+------------+
455 | RFC 5277 | NETCONF Event Notification | Must | 12150 |
456 +------------+--------------------------------------------------------------------+------------+------------+
457 | RFC 5717 | Partial Lock Remote Procedure Call | Must | 12160 |
458 +------------+--------------------------------------------------------------------+------------+------------+
459 | RFC 6241 | NETCONF Configuration Protocol | Must | 12170 |
460 +------------+--------------------------------------------------------------------+------------+------------+
461 | RFC 6242 | Using the Network Configuration Protocol over Secure Shell | Must | 12180 |
462 +------------+--------------------------------------------------------------------+------------+------------+
467 Healthcheck is a command for which no NETCONF support exists. Therefore,
468 this must be supported using a RESTful interface which we have defined.
470 The VNF via APP-C must provide a REST formatted GET RPCs to support Healthcheck
471 queries via the GET method over HTTP(s).
473 The VNF via VF-C must provide REST APIs to make the configurations of
476 The port number, url, and other authentication information is provided
479 **Table 5. VNF REST APIs**
481 +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
482 | **Principal** | **Description** | **Type** | **ID #** |
483 +=================+=======================================================================================================================================================================================================================================================================================================================================================================================================+============+============+
484 | REST APIs | The HealthCheck RPC, executes a vendor-defined VNF Healthcheck over the scope of the entire VNF (e.g., if there are multiple VNFCs, then run a health check, as appropriate, for all VNFCs). It returns a 200 OK if the test completes. A JSON object is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information. | Must | 12190 |
486 | | If the VNF is unable to run the HealthCheck, return a standard http error code and message. | | |
494 | | "identifier": "scope represented", | | |
496 | | "state": "healthy", | | |
498 | | "time": "01-01-1000:0000" | | |
506 | | "identifier": "scope represented", | | |
508 | | "state": "unhealthy", | | |
512 | | "info": "System threshold exceeded details", | | |
518 | | "cpuOverall": 0.80, | | |
520 | | "cpuThreshold": 0.45 | | |
526 | | "time": "01-01-1000:0000" | | |
529 +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
530 | REST APIs | **/configuration** This API executes a vendor-defined VNF configuration action over the scope of the entire VNF(e.g if there are multiple VMs, then run configuration on all VMs according to the input parameters). | Must | 12200 |
531 | | **/configuration** returns a 201 Created if the configuration succeeds or a 4XX/5XX response if it fails. A JSON object is returned indicating the outcome of the VNF configuration including all the necessary configuration info. | | |
532 +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
534 Chef Standards and Capabilities
535 -------------------------------
537 ONAP will support configuration of VNFs via Chef subject to the
538 requirements and guidelines defined in this section.
540 The Chef configuration management mechanism follows a client-server
541 model. It requires the presence of a Chef-Client on the VNF that will be
542 directly managed by a Chef Server. The Chef-client will register with
543 the appropriate Chef Server and are managed via ‘cookbooks’ and
544 configuration attributes loaded on the Chef Server which contain all
545 necessary information to execute the appropriate actions on the VNF via
548 ONAP will utilize the open source Chef Server, invoke the documented
549 Chef REST APIs to manage the VNF and requires the use of open source
550 Chef-Client and Push Jobs Client on the VNF
551 (https://downloads.chef.io/).
553 **Table 6. VNF Configuration via Chef**
555 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
556 | **Principle** | **Description** | **Type** | **ID #** |
557 +============================+===================================================================================================================================================================================================================================================================================================================================================+============+============+
558 | Chef Server Requirements | ONAP will interact with the Chef Server designated to manage a target VNF. ONAP design allows for the VNF to register with the following types of Chef Server [3]_: | Must | 12310 |
560 | | - **Chef Server hosted by ONAP**: ONAP will provide a Chef Server to manage a VNF. If this choice is used then it is required that the VNF Vendor provide all relevant cookbooks to ONAP to be loaded on the Chef Server. | | |
562 | | - **Chef Server hosted in Tenant Space**: The Chef Server may also be hosted external to ONAP in tenant space. Same guidelines as ONAP Chef Server apply. In addition, the owner is required to provide appropriate credentials to ONAP in order to interact with the Chef Server. | | |
563 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
564 | Chef Client | It is required that as part of the installation process, the chef-client on the VNF be preloaded with validator keys and configuration to register with the designated Chef Server. | Must | 12320 |
566 | Requirements | | | |
567 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
568 | | All the endpoints (VMs) of a VNF that contain chef-clients are required to have routable FQDNs which are used to register with the Chef Server. As part of invoking VNF actions, ONAP will trigger push jobs against FQDNs of endpoints for a VNF, if required. | Must | 12330 |
569 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
570 | | It is recommended that each VNF expose a single endpoint that is responsible for all functionality. | May | 12331 |
571 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
572 | | It is required that the VNF be installed with | Must | 12340 |
574 | | - Chef-Client >= 12.0 | | |
576 | | - Chef push jobs client >= 2.0 | | |
577 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
578 | Chef Roles/ | Each VNF Vendor is required to make available for loading on appropriate Chef Server, all relevant Chef artifacts (roles/cookbooks/recipes) required to execute VNF actions requested by ONAP. | Must | 12350 |
580 | Requirements | | | |
581 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
582 | | For each supported VNF action, the VNF Vendor is required to provide a run list of roles/cookbooks/recipes that will perform the desired VNF action in its entirety as specified by ONAP (see Section 8.c, ONAP Controller APIs and Behavior, for list of VNF actions and requirements), when triggered by a chef-client run list in JSON file. | Must | 12360 |
583 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
584 | | Roles/cookbooks/recipes invoked for a VNF action must not contain any instance specific parameters for the VNF. Instead they must accept all necessary instance specific data from the environment or node object attributes. | Must | 12370 |
585 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
586 | | It is required that all configurable parameters in the roles, cookbooks and recipes that can be set by ONAP, over-ride any default values. | Must | 12380 |
587 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
588 | | It is required that when executing a VNF action, if the chef-client run encounters any critical errors/failures, it update status on the Chef Server appropriately (e.g., via a fail or raise an exception). | Must | 12390 |
589 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
590 | | If the VNF action requires the output of a chef-client run be made available (e.g., get running configuration), an attribute, defined as node[‘PushJobOutput’] must be populated with the desired output on all nodes in the push job that execute chef-client run. | Must | 12400 |
591 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
592 | | It is recommended that, for actions that change state of the VNF (e.g., configure), the Vendor design appropriate cookbooks that can automatically ‘rollback’ to the original state in case of any errors. | Must | 12410 |
593 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
594 | | It is recommended that any chef-client run associated with a VNF action support callback URLs to return information to ONAP upon completion of the chef-client run. | Should | 12420 |
596 | | - As part of the push job, ONAP will provide two parameters in the environment of the push job JSON object: | | |
598 | | - ‘RequestId’ a unique Id to be used to identify the request, | | |
600 | | - ‘CallbackUrl’, the URL to post response back. | | |
602 | | - If the CallbackUrl field is empty or missing in the push job, then the chef-client run need not post the results back via callback. | | |
604 | | - If the chef-client run list includes a cookbook/recipe that is callback capable, it is required to, upon completion of the chef-client run, POST back on the callback URL, a JSON object as described in Table A2. | | |
606 | | - Failure to POST on the Callback Url should not be considered a critical error. That is, if the chef-client successfully completes the VNF action, it should reflect this status on the Chef Server regardless of whether the Callback succeeded or not. | | |
607 +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
612 This section outlines the workflow that ONAP invokes when it receives an
613 action request against a Chef managed VNF.
615 1. When ONAP receives a request for an action for a Chef Managed VNF, it
616 retrieves the corresponding template (based on **action** and
617 **VNF)** from its database and sets necessary values in the
618 “Environment”, “Node” and “NodeList” keys (if present) from either
619 the payload of the received action or internal data.
621 2. If “Environment” key is present in the updated template, it posts the
622 corresponding JSON dictionary to the appropriate Environment object
623 REST endpoint on the Chef Server thus updating the Environment
624 attributes on the Chef Server.
626 3. Next, it creates a Node Object from the “Node” JSON dictionary for
627 all elements listed in the NodeList (using the FQDN to construct the
628 endpoint) by replicating it [4]_. As part of this process, it will
629 set the name field in each Node Object to the corresponding FQDN.
630 These node objects are then posted on the Chef Server to
631 corresponding Node Object REST endpoints to update the corresponding
634 4. If PushJobFlag is set to “True” in the template, ONAP requests a push
635 job against all the nodes in the NodeList to trigger
636 chef-client\ **.** It will not invoke any other command via the push
637 job. ONAP will include a callback URL in the push job request and a
638 unique Request Id. An example push job posted by ONAP is listed
643 "command": "chef-client",
647 "nodes”: [“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
651 “RequestId”:”8279-abcd-aksdj-19231”,
653 “CallbackUrl”:”<callback>”
659 5. If CallbackCapable field in the template is not present or set to
660 “False” ONAP will poll the Chef Server to check completion status of
663 6. If “GetOutputFlag” is set to “True” in the template and
664 CallbackCapable is not set to “True”, ONAP will retrieve any output
665 from each node where the push job has finished by accessing the Node
666 Object attribute node[‘PushJobOutput’].
668 Ansible Standards and Capabilities
669 ----------------------------------
671 ONAP will support configuration of VNFs via Ansible subject to the
672 requirements and guidelines defined in this section.
674 Ansible allows agentless management of VMs via execution of ‘playbooks’
675 over ssh. The ‘playbooks’ are a structured set of tasks which contain
676 all the necessary data and execution capabilities to take the necessary
677 action on one or more target VMs of the VNF. ONAP will utilize the
678 framework of an Ansible Server that will host and invoke playbooks to
679 manage VNFs that support Ansible.
681 **Table 7. VNF Configuration via Ansible**
683 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
684 | **Principle** | **Description** | **Type** | **ID #** |
685 +===============================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+============+============+
686 | Ansible Server Requirements | ONAP will utilize an Ansible server in order to manage VNFs that support Ansible playbooks. We note that Ansible in general does not require the use of a server. However, this framework has been adopted to align with ONAP architecture, ease of management and scalability. | Must | 12510 |
688 | | All playbooks for the VNF will be hosted on a designated Ansible Server that meets ONAP Ansible API requirements. ONAP design allows for VNFs to be managed by an Ansible Server in any of the two following forms [5]_: | | |
690 | | - **Ansible Server hosted by ONAP**: ONAP will provide an Ansible Server to manage a VNF. If this choice is used then it is required that the VNF Vendor provide all relevant playbooks to ONAP to be loaded on the Ansible Server. | | |
692 | | - **Ansible Server hosted in Tenant Space**: Same guidelines as the ONAP Ansible Server. The Ansible Server must meet the ONAP Ansible Server API Interface requirements. | | |
693 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
694 | Ansible Client | The endpoints (VMs) of a VNF on which playbooks will be executed must have routable FQDNs that are reachable via the Ansible Server. ONAP will initiate requests to the Ansible Server for invocation of playbooks against these end points [6]_. | Must | 12520 |
696 | Requirements | | | |
697 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
698 | | It is recommended that a VNF typically have a single endpoint. | May | 12521 |
699 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
700 | | The endpoint VM(s) of a VNF on which an Ansible playbook will be executed is required to have Python >= 2.7. | Must | 12530 |
701 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
702 | | The endpoint VM(s) must support SSH and allow SSH access to the Ansible server in line with Network Cloud Service Provider guidelines for authentication and access. | Must | 12540 |
703 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
704 | Ansible Playbook | An Ansible playbook is a collection of tasks that is executed on the Ansible server (local host) and/or the target VM (s) in order to complete the desired action. Each VNF Vendor is required to make available (or load on VNF Ansible Server) playbooks that conform to the ONAP requirements. | Must | 12550 |
706 | Requirements | | | |
707 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
708 | | It is required that each VNF action be supported by invocation of **one** playbook [7]_. The playbook will be responsible for executing all necessary tasks (as well as calling other playbooks) to complete the request. | Must | 12560 |
709 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
710 | | A playbook must not contain any instance specific parameters. It must utilize information from key value pairs that will be provided by the Ansible Server as extra-vars during invocation to execute the desired VNF action. If the playbook requires files, they must also be supplied using the methodology detailed in the Ansible Server API. | Must | 12570 |
711 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
712 | | The Ansible Server will determine if a playbook invoked to execute a VNF action finished successfully or not using the “PLAY\_RECAP” summary in Ansible log. The playbook will be considered to successfully finish only if the “PLAY RECAP” section at the end of playbook execution output has no unreachable hosts and no failed tasks. Otherwise, the playbook will be considered to have failed. | Must | 12580 |
713 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
714 | | VNF vendor must design playbooks to allow Ansible Server to infer failure or success based on the “PLAY\_RECAP” capability. | Must | 12590 |
715 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
716 | | If, as part of a VNF action (e.g., audit), a playbook is required to return any VNF information, it must be written to a specific set of text files that will be retrieved and made available by the Ansible Server. The text files must be written in the same directory as the one from which the playbook is being executed. A text file must be created for each host the playbook is run on, with the name ‘<playbook name> <hostname>\_results.txt’ into which any desired output from each respective VM/VNF must be written. | Must | 12600 |
717 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
718 | | It is recommended that, for actions that change state of the VNF (e.g., configure), the VNF Vendor design appropriate playbooks that can automatically ‘rollback’ to the original state in case of any errors. | Should | 12610 |
720 | | NOTE: In case rollback at the playbook level is not supported or possible, vendor shall provide alternative locking mechanism (e.g., for a small VNF the rollback mechanism may rely on workflow to terminate and re-instantiate VNF VMs and then re-run playbook(s)). | | |
721 +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
723 ONAP Controller APIs and Behavior
724 ---------------------------------
726 ONAP Controllers support the following operations which act directly
727 upon the VNF. Most of these utilize the NETCONF interface. There are
728 additional commands in use but these either act internally on Controller
729 itself or depend upon network cloud components for implementation. Those
730 actions do not put any special requirement on the VNF provider.
732 The following table summarizes how the VNF must act in response to
735 Table 8. ONAP Controller APIs and NETCONF Commands
737 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
738 | **Action** | **Description** | **NETCONF Commands** |
739 +=====================+==================================================================================================================================================================================================================================================================================+===============================================================================================================================================================================================================================+
740 | Action | Queries ONAP Controller for the current state of a previously submitted runtime LCM (Lifecycle Management) action. | There is currently no way to check the request status in NETCONF so action status is managed internally by the ONAP controller. |
743 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
744 | Audit, Sync | Compare active (uploaded) configuration against the current configuration in the ONAP controller. Audit returns failure if different. Sync considers the active (uploaded) configuration as the current configuration. | The <get-config> operation is used to retrieve the running configuration from the VNF. |
745 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
746 | Lock, | Returns true when the given VNF has been locked. | There is currently no way to query lock state in NETCONF so VNF locking and unlocking is managed internally by the ONAP controller. |
751 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
752 | Configure, | Configure applies a post-instantiation configuration the target VNF or VNFC. ConfigModify updates only a subset of the total configuration parameters of a VNF. | The <edit-config> operation loads all or part of a specified configuration data set to the specified target database. If there is no <candidate/> database, then the target is the <running/> database. A <commit> follows. |
755 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
756 | Health | Executes a VNF health check and returns the result. A health check is VNF-specific. | The ONAP health check interface is defined over REST and requires the target VNF to expose a standardized HTTP(S) interface for that purpose. See Section 8.c VNF REST APIs. |
759 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
760 | StartApplication, | ONAP requests application to be started or stopped on the VNF or VNFC. These actions do not need to be supported if (1) the application starts automatically after Configure or if the VM’s are started and (2) the application gracefully shuts down if the VM’s are stopped. | These commands have no specific NETCONF RPC action. |
762 | StopApplication | | They can be supported using Ansible or Chef (see Table 9 below). |
763 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
764 | SoftwareUpload, | Upgrades the target VNF to a new version without interrupting VNF operation. | These commands have no specific NETCONF RPC action. |
766 | LiveUpgrade | | They can be supported using Ansible or Chef (see Table 9 below). |
767 +---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
769 Table 9 lists the required Chef and Ansible support for commands from
772 Table 9. ONAP Controller APIs and Chef/Ansible Support
774 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
775 | **Action** | **Chef** | **Ansible** |
776 +=====================+==================================================================================================================================================================================================================================================================================================+=========================================================================================================================================================================================================================================================+
777 | Action | Not needed. ActionStatus is managed internally by the ONAP controller. | Not needed. ActionStatus is managed internally by the ONAP controller. |
780 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
781 | Audit, Sync | VNF Vendor must provide any necessary roles, cookbooks, recipes to retrieve the running configuration from a VNF and place it in the respective Node Objects ‘PushJobOutput’ attribute of all nodes in NodeList when triggered by a chef-client run. | VNF Vendor must provide an Ansible playbook to retrieve the running configuration from a VNF and place the output on the Ansible server in a manner aligned with playbook requirements listed in this document. |
783 | | The JSON file for this VNF action is required to set “PushJobFlag” to “True” and “GetOutputFlag” to “True”. The “Node” JSON dictionary must have the run list populated with the necessary sequence of roles, cookbooks, recipes. | The PlaybookName must be provided in the JSON file. |
785 | | The Environment and Node values should contain all appropriate configuration attributes. | NodeList must list FQDNs of an example VNF on which to execute playbook. |
787 | | NodeList must list sample FQDNs that are required to conduct a chef-client run for this VNF Action. | |
788 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
789 | Lock, | Not needed. VNF locking and unlocking is managed internally by the ONAP controller. | Not needed. VNF locking and unlocking is managed internally by the ONAP controller. |
794 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
795 | Configure, | VNF Vendor must provide any necessary roles, cookbooks, recipes to apply configuration attributes to the VNF when triggered by a chef-client run. All configurable attributes must be obtained from the Environment and Node objects on the Chef Server. | VNF Vendor must provide an Ansible playbook that can configure the VNF with parameters supplied by the Ansible Server. |
797 | ConfigModify | The JSON file for this VNF action should include all configurable attributes in the Environment and/or Node JSON dictionary. | The PlaybookName must be provided in the JSON file. |
799 | | The “PushJobFlag” must be set to “True”. | The “EnvParameters” and/or “FileParameters” field values should be provided and contain all configurable parameters for the VNF. |
801 | | The “Node” JSON dictionary must have the run list populated with necessary sequence of roles, cookbooks, recipes. This action is not expected to return an output. | NodeList must list FQDNs of an example VNF on which to execute playbook. |
803 | | “GetOutputFlag” must be set to “False”. | |
805 | | NodeList must list sample FQDNs that are required to conduct a chef-client run for this VNF Action. | |
806 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
807 | Health | The ONAP health check interface is defined over REST and requires the target VNF to expose a standardized HTTP(S) interface for that purpose. See Section 8.c VNF REST APIs. | The ONAP health check interface is defined over REST and requires the target VNF to expose a standardized HTTP(S) interface for that purpose. See Section 8.c VNF REST APIs. |
810 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
811 | StartApplication, | VNF Vendor must provide roles, cookbooks, recipes to start an application on the VNF when triggered by a chef-client run. If application does not start, the run must fail or raise an exception. If application is already started, or starts successfully, the run must finish successfully. | VNF Vendor must provide an Ansible playbook to start the application on the VNF. If application does not start, the playbook must indicate failure. If application is already started, or starts successfully, the playbook must finish successfully. |
813 | StopApplication | For StopApplication, the application must be stopped gracefully (no loss of traffic). | For StopApplication, the application must be stopped gracefully (no loss of traffic). |
814 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
815 | SoftwareUpload, | VNF Vendor must provide any necessary roles, cookbooks, recipes to apply a software upgrade to the VNF when triggered by a chef-client run. | VNF Vendor must provide an Ansible playbook that can apply a software upgrade to the VNF when triggered by the Ansible server |
818 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
820 For information purposes, the following ONAP controller functions are
821 planned in the future:
823 Table 10. Planned ONAP Controller Functions
825 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
826 | ConfigSave, | ConfigSave stores the VNF running configuration to a url or file using a specified name. ConfigRestore replaces the VNF running configuration with the configuration previously stored with a url or file with the specified name. |
829 +==================+==================================================================================================================================================================================================================================================================================================================+
830 | Reconfigure | If the audit fails, Reconfigure may be used to be replace the VNF running configuration using a previously uploaded configuration in the ONAP controller. |
831 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
832 | ConfigStartup | ConfigStartup is used to store a running configuration to be used when a VNF is rebooted. |
833 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
834 | ConfigRecovery | ConfigRecovery is used to replace the running configuration with a recovery configuration. This recovery configuration is stored in the ONAP Controller and is the configuration uploaded after instantiation. It will only be used if there is no other option to restore the VNF to a working configuration. |
835 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
836 | StatusQuery | Executes a VNF status query and returns the result. A status query is VNF-specific. |
837 +------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
840 d. Monitoring & Management
841 ===========================
842 Monitoring & Management
843 =======================
845 This section addresses data collection and event processing
846 functionality that is directly dependent on the interfaces provided by
847 the VNFs’ APIs. These can be in the form of asynchronous interfaces for
848 event, fault notifications, and autonomous data streams. They can also
849 be synchronous interfaces for on-demand requests to retrieve various
850 performance, usage, and other event information.
852 The target direction for VNF interfaces is to employ APIs that are
853 implemented utilizing standardized messaging and modeling protocols over
854 standardized transports. Migrating to a virtualized environment presents
855 a tremendous opportunity to eliminate the need for proprietary
856 interfaces for vendor equipment while removing the traditional
857 boundaries between Network Management Systems and Element Management
858 Systems. Additionally, VNFs provide the ability to instrument the
859 networking applications by creating event records to test and monitor
860 end-to-end data flow through the network, similar to what physical or
861 virtual probes provide without the need to insert probes at various
862 points in the network. The VNF vendors must be able to provide the
863 aforementioned set of required data directly to the ONAP collection
864 layer using standardized interfaces.
866 Transports and Protocols Supporting Resource Interfaces
867 -------------------------------------------------------
869 Delivery of data from VNFs to ONAP must use the same common transport
870 mechanisms and protocols for all VNFs. Transport mechanisms and
871 protocols have been selected to enable both high volume and moderate
872 volume datasets, as well as asynchronous and synchronous communications
873 over secure connections. The specified encoding provides
874 self-documenting content, so data fields can be changed as needs evolve,
875 while minimizing changes to data delivery.
877 The term ‘Event Record’ is used throughout this document to represent
878 various forms instrumentation/telemetry made available by the VNF
879 including, faults, status events and various other types of VNF
880 measurements and logs. Headers received by themselves must be used as
881 heartbeat indicators. The common structure and delivery protocols for
882 other types of data will be given in future versions of this document as
883 we get more insight into data volumes and required processing.
885 In the following guidelines, we provide options for encoding,
886 serialization and data delivery. Agreements between Service Providers
887 and VNF vendors shall determine which encoding, serialization and
888 delivery method to use for particular data sets. The selected methods
889 must be agreed to prior to the on-boarding of the VNF into ONAP design
892 Table 11. Monitoring & Management
894 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
895 | **Principle** | **Description** | **Type** | **ID #** |
896 +==============================================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+============+============+
897 | VNF telemetry via standardized interface | VNFs must provide all telemetry (e.g., fault event records, syslog records, performance records etc.) to ONAP using the model, format and mechanisms described in this section. | Must | 13005 |
898 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
899 | Encoding and Serialization | Content delivered from VNFs to ONAP is to be encoded and serialized using JSON (option 1). High-volume data is to be encoded and serialized using Avro, where Avro data format are described using JSON (option 2) [8]_. | Must | 13010 |
901 | | - JSON plain text format is preferred for moderate volume data sets (option 1), as JSON has the advantage of having well-understood simple processing and being human-readable without additional decoding. Examples of moderate volume data sets include the fault alarms and performance alerts, heartbeat messages, measurements used for VNF scaling and syslogs. | | |
903 | | - Binary format using Avro is preferred for high volume data sets (option 2) such as mobility flow measurements and other high-volume streaming events (such as mobility signaling events or SIP signaling) or bulk data, as this will significantly reduce the volume of data to be transmitted. As of the date of this document, all events are reported using plain text JSON and REST. | | |
905 | | - Avro content is self-documented, using a JSON schema. The JSON schema is delivered along with the data content (http://avro.apache.org/docs/current/ ). This means the presence and position of data fields can be recognized automatically, as well as the data format, definition and other attributes. Avro content can be serialized as JSON tagged text or as binary. In binary format, the JSON schema is included as a separate data block, so the content is not tagged, further compressing the volume. For streaming data, Avro will read the schema when the stream is established and apply the schema to the received content. | | |
907 | | - In the future, we may consider support for other types of encoding & serialization (e.g., gRPC) based on industry demand. | | |
908 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
909 | Reporting Frequency | The frequency that asynchronous data is delivered will vary based on the content and how data may be aggregated or grouped together. For example, alarms and alerts are expected to be delivered as soon as they appear. In contrast, other content, such as performance measurements, KPIs or reported network signaling may have various ways of packaging and delivering content. Some content should be streamed immediately; or content may be monitored over a time interval, then packaged as collection of records and delivered as block; or data may be collected until a package of a certain size has been collected; or content may be summarized statistically over a time interval, or computed as a KPI, with the summary or KPI being delivered. | Must | 13020 |
911 | | - We expect the reporting frequency to be configurable depending on the virtual network function’s needs for management. For example, Service Provider may choose to vary the frequency of collection between normal and trouble-shooting scenarios. | | |
913 | | - Decisions about the frequency of data reporting will affect the size of delivered data sets, recommended delivery method, and how the data will be interpreted by ONAP. However, this should not affect deserialization and decoding of the data, which will be guided by the accompanying JSON schema. | | |
914 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
915 | Addressing and Delivery Protocol | ONAP destinations can be addressed by URLs for RESTful data PUT. Future data sets may also be addressed by host name and port number for TCP streaming, or by host name and landing zone directory for SFTP transfer of bulk files. | Must | 13030 |
917 | | - REST using HTTPS delivery of plain text JSON is preferred for moderate sized asynchronous data sets, and for high volume data sets when feasible. | | |
919 | | - VNFs must have the capability of maintaining a primary and backup DNS name (URL) for connecting to ONAP collectors, with the ability to switch between addresses based on conditions defined by policy such as time-outs, and buffering to store messages until they can be delivered. At its discretion, the service provider may choose to populate only one collector address for a VNF. In this case, the network will promptly resolve connectivity problems caused by a collector or network failure transparently to the VNF. | | |
921 | | - VNFs will be configured with initial address(es) to use at deployment time. After that the address(es) may be changed through ONAP-defined policies delivered from ONAP to the VNF using PUTs to a RESTful API, in the same way that other controls over data reporting will be controlled by policy. | | |
923 | | - Other options are expected to include: | | |
925 | | - REST delivery of binary encoded data sets. | | |
927 | | - TCP for high volume streaming asynchronous data sets and for other high volume data sets. TCP delivery can be used for either JSON or binary encoded data sets. | | |
929 | | - SFTP for asynchronous bulk files, such as bulk files that contain large volumes of data collected over a long time interval or data collected across many VNFs. This is not preferred. Preferred is to reorganize the data into more frequent or more focused data sets, and deliver these by REST or TCP as appropriate. | | |
931 | | - REST for synchronous data, using RESTCONF (e.g., for VNF state polling). | | |
933 | | - The ONAP addresses as data destinations for each VNF must be provided by ONAP Policy, and may be changed by Policy while the VNF is in operation. We expect the VNF to be capable of redirecting traffic to changed destinations with no loss of data, for example from one REST URL to another, or from one TCP host and port to another. | | |
934 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
935 | Asynchronous and Synchronous Data Delivery | VNFs are to deliver asynchronous data as data becomes available, or according to the configured frequency. The delivered data must be encoded using JSON or Avro, addressed and delivered as described in the previous paragraphs. | Must | 13040 |
936 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
937 | | VNFs are to respond to data requests from ONAP as soon as those requests are received, as a synchronous response. | Must | 13050 |
938 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
939 | | Synchronous communication must leverage the RESTCONF/NETCONF framework used by the ONAP configuration subsystem. This shall include using YANG configuration models and RESTCONF (https://tools.ietf.org/html/draft-ietf-netconf-restconf-09#page-46). | Must | 13060 |
940 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
941 | | The VNF must respond with content encoded in JSON, as described in the RESTCONF specification. This way the encoding of a synchronous communication will be consistent with Avro. | Must | 13070 |
942 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
943 | | ONAP may request the VNF to deliver the current data for any of the record types defined in Section 8.d Data Model for Event Records below. The VNF must respond by returning the requested record, populated with the current field values. (Currently the defined record types include the common header record, technology independent records such as Fault, Heartbeat, State Change, Syslog, and technology specific records such as Mobile Flow, Signaling and Voice Quality records. Additional record types will be added in the future as they are standardized and become available.) | Must | 13080 |
944 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
945 | | ONAP may request the VNF to deliver granular data on device or subsystem status or performance, referencing the YANG configuration model for the VNF. The VNF must respond by returning the requested data elements. | Must | 13090 |
946 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
947 | | If YANG models need to be translated to and from JSON, (https://trac.tools.ietf.org/id/draft-lhotka-netmod-yang-json-00.html) should be utilized for translation, meaning YANG configuration and content can be represented via JSON, consistent with Avro, as described in “Encoding and Serialization” section. | Should | 13100 |
948 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
949 | Security | VNFs must support secure connections and transports. | Must | 13110 |
950 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
951 | | Access to ONAP and to VNFs, and creation of connections, must be controlled through secure credentials, log-on and exchange mechanisms. | Must | 13120 |
952 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
953 | | Data in motion must be carried only over secure connections. | Must | 13130 |
954 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
955 | | Service Providers require that any content containing Sensitive Personal Information (SPI) or certain proprietary data must be encrypted, in addition to applying the regular procedures for securing access and delivery. | Must | 13140 |
956 +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
958 Data Model for Event Records
959 -----------------------------
961 This section describes the data model for the collection of telemetry
962 data from VNFs by Service Providers (SPs) to manage VNF health and
963 runtime lifecycle. This data model is referred to as the VNF Event
964 Streaming (VES) specifications. While this document is focused on
965 specifying some of the records from the ONAP perspective, there may be
966 other external bodies using the same framework to specify additional
967 records. For example, OPNFV has a VES project [9]_ that is looking to
968 specify records for OpenStack’s internal telemetry to manage Application
969 (VNFs), physical and virtual infrastructure (compute, storage, network
970 devices), and virtual infrastructure managers (cloud controllers, SDN
971 controllers). Note that any configurable parameters for these data
972 records (e.g., frequency, granularity, policy-based configuration) will
973 be managed using the “Configuration” framework described in the prior
974 sections of this document.
976 The Data Model consists of:
978 - Common Header Record: This data structure precedes each of the
979 Technology Independent and Technology Specific records sections of
982 - Technology Independent Records: This version of the document
983 specifies the model for Fault, Heartbeat, State Change, Syslog,
984 Threshold Crossing Alerts, and VF Scaling\* (short for
985 measurementForVfScalingFields) records. In the future, these may be
986 extended to support other types of technology independent records.
987 Each of these records allows additional fields (name/ value pairs)
988 for extensibility. The vendors can use these vendor-specific
989 additional fields to provide additional information that may be
990 relevant to the managing systems.
992 - Technology Specific Records: This version of the document specifies
993 the model for Mobile Flow records, Signaling and Voice Quality
994 records. In the future, these may be extended to support other types
995 of records (e.g., Network Fabric, Security records, etc.). Each of
996 these records allows additional fields (name/value pairs) for
997 extensibility. The VNF vendors can use these VNF-specific additional
998 fields to provide additional information that may be relevant to the
999 managing systems. A placeholder for additional technology specific
1000 areas of interest to be defined in the future documents has been
1004 Figure 1. Data Model for Event Records
1006 Event Records - Data Structure Description
1007 ------------------------------------------
1009 The data structure for event records consists of:
1011 - a Common Event Header block;
1013 - zero or more technology independent domain blocks; and
1015 - e.g., Fault domain, State Change domain, Syslog domain, etc.
1017 - zero or more technology specific domain blocks.
1019 - e.g., Mobile Flow domain, Signaling domain, Voice Quality domain,
1022 Note: Heartbeat records would only have the Common Event Header block.
1023 An optional heartbeat domain is available if required by the heartbeat
1027 ~~~~~~~~~~~~~~~~~~~~~
1029 The common header that precedes any of the domain-specific records
1030 contains information identifying the type of record to follow,
1031 information about the sender and other identifying characteristics
1032 related to timestamp, sequence number, etc.
1034 Technology Independent Records – Fault Fields
1035 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1037 The Fault Record, describing a condition in the Fault domain, contains
1038 information about the fault such as the entity under fault, the
1039 severity, resulting status, etc.
1041 Technology Independent Records – Heartbeat Fields
1042 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1044 The Heartbeat Record provides an optional structure for communicating
1045 information about heartbeat or watchdog signaling events. It can contain
1046 information about service intervals, status information etc. as required
1047 by the heartbeat implementation.
1049 Technology Independent Records – State Change Fields
1050 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1052 The State Change Record provides a structure for communicating
1053 information about data flow through the VNF. It can contain information
1054 about state change related to physical device that is reported by VNF.
1055 As an example, when cards or port name of the entity that has changed
1058 Technology Independent Records – Syslog Fields
1059 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1061 The Syslog Record provides a structure for communicating any type of
1062 information that may be logged by the VNF. It can contain information
1063 about system internal events, status, errors, etc.
1065 Technology Independent Records – Threshold Crossing Alert Fields
1066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1068 The Threshold Crossing Alert (TCA) Record provides a structure for
1069 communicating information about threshold crossing alerts. It can
1070 contain alert definitions and types, actions, events, timestamps and
1071 physical or logical details.
1073 Technology Independent Records - VF Scaling Fields
1074 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1076 The VF Scaling\* (short for measurementForVfScalingFields) Record
1077 contains information about VF and VNF resource structure and its
1078 condition to help in the management of the resources for purposes of
1081 Technology Independent Records – otherFields
1082 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1084 The otherFields Record defines fields for events belonging to the
1085 otherFields domain of the Technology Independent domain enumeration.
1086 This record provides a mechanism to convey a complex set of fields
1087 (possibly nested or opaque) and is purely intended to address
1088 miscellaneous needs such as addressing time-to-market considerations or
1089 other proof-of-concept evaluations. Hence, use of this record type is
1090 discouraged and should be minimized.
1092 Technology Specific Records – Mobile Flow Fields
1093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1095 The Mobile Flow Record provides a structure for communicating
1096 information about data flow through the VNF. It can contain information
1097 about connectivity and data flows between serving elements for mobile
1098 service, such as between LTE reference points, etc.
1100 Technology Specific Records – Signaling Fields
1101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1103 The Signaling Record provides a structure for communicating information
1104 about signaling messages, parameters and signaling state. It can contain
1105 information about data flows for
1106 `signaling <https://en.wikipedia.org/wiki/Signaling_%28telecommunications%29>`__
1108 `multimedia <https://en.wikipedia.org/wiki/Multimedia>`__ communication
1109 `session <https://en.wikipedia.org/wiki/Session_%28computer_science%29>`__\ s
1110 such as `voice <https://en.wikipedia.org/wiki/Telephone_call>`__ and
1111 `video calls <https://en.wikipedia.org/wiki/Video_call>`__.
1113 Technology Specific Records – Voice Quality Fields
1114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116 The Voice Quality Record provides a structure for communicating
1117 information about voice quality statistics including media connection
1118 information, such as transmitted octet and packet counts, packet loss,
1119 packet delay variation, round-trip delay, QoS parameters and codec
1122 Technology Specific Records – Future Domains
1123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1125 The futureDomains Record is a placeholder for additional technology
1126 specific areas of interest that will be defined and described in the
1129 Data Structure Specification of the Event Record
1130 ------------------------------------------------
1132 For additional information on the event record formats of the data
1133 structures mentioned above, please refer to `AT&T Service Specification;
1135 Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__.
1138 ECOMP (Enhanced Control Orchestration, Management & Policy)
1139 Architecture White Paper
1140 (http://about.att.com/content/dam/snrdocs/ecomp.pdf)
1143 https://github.com/mbj4668/pyang
1146 Decision on which Chef Server instance associates with a VNF will be
1147 made on a case-by-case basis depending on VNF, access requirements,
1148 etc. and are outside the scope of this document. The specific
1149 criteria for this would involve considerations like connectivity and
1150 access required by the VNF, security, VNF topology and proprietary
1154 Recall that the Node Object **is required** to be identical across
1155 all VMs of a VNF invoked as part of the action except for the “name”.
1158 Decision on which Ansible Server to use may happen on a case-by-case
1159 basis depending on VNF, access requirements etc. and are outside the
1160 scope of this document. The specific criteria for this could involve
1161 considerations like connectivity and access required by the VNF,
1162 security, VNF topology and proprietary playbooks.
1165 Upstream elements must provide the appropriate FQDN in the request to
1166 ONAP for the desired action.
1169 Multiple ONAP actions may map to one playbook.
1172 This option is not currently supported in ONAP and it is currently
1173 under consideration.
1176 https://wiki.opnfv.org/display/PROJ/VNF+Event+Stream
1179 The “name” field is a mandatory field in a valid Chef Node Object
1182 .. |image0| image:: Data_Model_For_Event_Records.png
Code Review / vnfrqts / requirements.git / blob