1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property. All rights reserved.
9 Chef JSON Key Value Description
10 -------------------------------------
12 The following provides the key value pairs that must be contained in the
13 JSON file supporting Chef action.
15 Table A1. Chef JSON File key value description
16 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18 +----------------+--------------------------+---------+----------------------+
19 | **Field Name** | **Description** | **Type**| **Comment** |
20 +================+==========================+=========+======================+
21 | Environment | A JSON dictionary | Optional|Depends on VNF action.|
22 | | representing a Chef | | |
23 | | Environment object. If | | |
24 | | the VNF action requires | | |
25 | | loading or modifying Chef| | |
26 | | environment attributes | | |
27 | | associated with the VNF, | | |
28 | | all the relevant | | |
29 | | information must be | | |
30 | | provided in this JSON | | |
31 | | dictionary in a structure| | |
32 | | that conforms to a Chef | | |
33 | | Environment Object. | | |
34 +----------------+--------------------------+---------+----------------------+
35 | Node | A JSON dictionary |Mandatory| |
36 | | representing a Chef Node | | |
39 | | The Node JSON dictionary | | |
40 | | must include the run list| | |
41 | | to be triggered for the | | |
42 | | desired VNF action by the| | |
43 | | push job. It should also | | |
44 | | include any attributes | | |
45 | | that need to be | | |
46 | | configured on the Node | | |
47 | | Object as part of the VNF| | |
49 +----------------+--------------------------+---------+----------------------+
50 | NodeList | Array of FQDNs that |Mandatory| |
51 | | correspond to the | | |
52 | | endpoints (VMs) of a VNF | | |
53 | | registered with the Chef | | |
54 | | Server that need to | | |
55 | | trigger a chef-client run| | |
56 | | as part of the desired | | |
58 +----------------+--------------------------+---------+----------------------+
59 | PushJobFlag | This field indicates |Mandatory| If set to “True”, |
60 | | whether the VNF action | | ONAP will request a |
61 | | requires a push Job. Push| | push job. Ignored |
62 | | job object will be | | otherwise. |
63 | | created by ONAP if | | |
65 +----------------+--------------------------+---------+----------------------+
66 | CallbackCapable| This field indicates if | Optional| If Chef cookbook is |
67 | | the chef-client run | | callback capable, VNF|
68 | | invoked by push job | | owner is required to |
69 | | corresponding to the VNF | | set it to “True”. |
70 | | action is capable of | | Ignored otherwise. |
71 | | posting results on a | | |
72 | | callback URL. | | |
73 +----------------+--------------------------+---------+----------------------+
74 | GetOutputFlag | Flag which indicates |Mandatory| ONAP will retrieve |
75 | | whether ONAP should | | output from |
76 | | retrieve output generated| | NodeObject attributes|
77 | | in a chef-client run from| | [‘PushJobOutput’] for|
78 | | Node object attribute | | all nodes in NodeList|
79 | | node[‘PushJobOutput’] for| | if set to “True”. |
80 | | this VNF action (e.g., in| | Ignored otherwise. |
82 +----------------+--------------------------+---------+----------------------+
84 Chef Template example:
90 "description": "VNF Chef environment for HAR",
91 "json\_class": "Chef::Environment",
92 "chef\_type": "environment",
93 "default\_attributes": { },
94 "override\_attributes": {
97 “Database\_IP”:”10.10.1.5”
102 “name” : “signal.network.com “
103 "chef\_type": "node",
104 "json\_class": "Chef::Node",
106 “IPAddress1”: “192.168.1.2”,
107 “IPAddress2”:”135.16.162.5”,
114 “chef\_environment” : “\_default”
115 "run\_list": [ "configure\_signal" ]
117 “NodeList”:[“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
118 “PushJobFlag”: “True”
119 “CallbackCapable”:True
120 “GetOutputFlag” : “False”
123 The example JSON file provided by the VNF provider for each VNF action will be
124 turned into a template by ONAP, that can be updated with instance
125 specific values at run-time.
127 Some points worth noting regarding the JSON fields:
129 a. The JSON file must be created for each action for each VNF.
131 b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will
132 replicate the “Node” JSON dictionary in the template and post it to
133 each FQDN (i.e., endpoint) in the NodeList after setting the “name”
134 field in the Node object to be the respective FQDN [1]_. Hence, it
135 is required that all end points (VMs) of a VNF involved in a VNF
136 action support the same set of Node Object attributes.
138 The following table describes the JSON dictionary to post in Callback.
140 Table A2. JSON Dictionary to Post in Callback
141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143 +--------------+----------------------------+---------+-----------------------+
144 | **Key** | **Description** | **Type**| **Comment** |
145 +==============+============================+=========+=======================+
146 | RequestId | A unique string associated |Mandatory| |
147 | | with the original request | | |
148 | | by ONAP. This key-value | | |
149 | | pair will be provided by | | |
150 | | ONAP in the environment of | | |
151 | | the push job request and | | |
152 | | must be returned as part of| | |
153 | | the POST message. | | |
154 +--------------+----------------------------+---------+-----------------------+
155 | StatusCode | An integer that must be set|Mandatory| |
156 | | to 200 if chef-client run | | |
157 | | on the node finished | | |
158 | | successfully 500 otherwise.| | |
159 +--------------+----------------------------+---------+-----------------------+
160 | StatusMessage| A string which must be set |Mandatory| |
161 | | to ‘SUCCESS’ if StatusCode | | |
164 | | Appropriate error message | | |
166 +--------------+----------------------------+---------+-----------------------+
167 | Name | A string which corresponds |Mandatory| |
168 | | to the name of the node | | |
169 | | where push job is run. It | | |
170 | | is required that the value | | |
171 | | be retrieved from the node | | |
172 | | object attributes (where it| | |
173 | | is always defined). | | |
174 +--------------+----------------------------+---------+-----------------------+
175 | PushJobOutput| Any output from the |Optional | Depends on VNF action.|
176 | | chef-client run that needs | | If empty, it must not |
177 | | to be returned to ONAP. | | be included. |
178 +--------------+----------------------------+---------+-----------------------+
180 Ansible JSON Key Value Description
181 -------------------------------------------------------------
183 The following provides the key value pairs that must be contained in the
184 JSON file supporting Ansible action.
186 Table B1. Ansible JSON File key value description
187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
189 +---------------+----------------------+---------+----------------------------+
190 | **Field Name**| **Description** | **Type**| **Comment** |
191 +===============+======================+=========+============================+
192 | PlaybookName | VNF providor must |Mandatory|Currently following |
193 | | list name of the | |Ansible standard |
194 | | playbook relative | |naming, where main |
195 | | path used to | |playbook is always |
196 | | execute the VNF | |named site.yml, and |
197 | | action. | |directory name where |
198 | | | |this main playbook resides, |
199 | | | |is named after the |
200 | | | |command/action playbook |
201 | | | |performs, in lower case, |
202 | | | |example, configure. |
203 +---------------+----------------------+---------+----------------------------+
204 | Action | Name of VNF action. | Optional| |
205 +---------------+----------------------+---------+----------------------------+
206 | EnvParameters | A JSON dictionary | Optional|Depends on the VNF action. |
207 | | which should list key| | |
208 | | value pairs to be | |Attribute names (variable |
209 | | passed to the Ansible| |names) passed to Ansible |
210 | | playbook. These | |shall follow Ansible valid |
211 | | values would | |variable names: “Variable |
212 | | correspond to | |names should be letters, |
213 | | instance specific | |numbers, and underscores. |
214 | | parameters that a | |Variables should always |
215 | | playbook may need to | |start with a letter.” |
216 | | execute an action. | | |
217 +---------------+----------------------+---------+----------------------------+
218 | NodeList |Ansible inventory | Optional|If not provided, pre-loaded |
219 | |hosts file with | |(VNF) inventory hosts |
220 | |VNF groups and | |file must exist in the |
221 | |respective IP | |Ansible Server otherwise |
222 | |addresses or DNS | |request fails. |
223 | |supported FQDNs | | |
224 | |that the playbook must| | |
225 | |be executed against. | | |
226 +---------------+----------------------+---------+----------------------------+
227 | FileParameters| A JSON dictionary | Optional| Depends on the VNF action |
228 | | where keys are | | and playbook design. |
229 | | filenames and values | | |
230 | | are contents of | | |
231 | | files. The Ansible | | |
232 | | Server will utilize | | |
233 | | this feature to | | |
234 | | generate files with | | |
235 | | keys as filenames and| | |
236 | | values as content. | | |
237 | | This attribute can be| | |
238 | | used to generate | | |
239 | | files that a playbook| | |
240 | | may require as part | | |
241 | | of execution. | | |
242 +---------------+----------------------+---------+----------------------------+
243 | Timeout | Time (in seconds) | Optional| |
244 | | that a playbook is | | |
245 | | expected to take to | | |
246 | | finish execution for | | |
247 | | the VNF. If playbook | | |
248 | | execution time | | |
249 | | exceeds this value, | | |
250 | | Ansible Server will | | |
251 | | terminate the | | |
252 | | playbook process. | | |
253 +---------------+----------------------+---------+----------------------------+
255 Ansible JSON file example:
259 “Action”:”Configure”,
261 "PlaybookName": "<VNFCode>/<Version>/ansible/configure/site.yml",
263 "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”],
267 "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”},
269 “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”}
273 In the above example, the Ansible Server will:
275 a. Process the “FileParameters” dictionary and generate a file named
276 ‘config.txt’ with contents set to the value of the ‘config.txt’ key.
278 b. Execute the playbook named ‘<VNFCode>/<Version>/ansible/configure/site.yml’
279 on nodes with FQDNs test1.vnf\_b.onap.com and test2.vnf\_b.onap.com
280 respectively while providing the following key value pairs to the playbook:
281 Retry=3, Wait=5, ConfigFile=config.txt
284 c. If execution time of the playbook exceeds 60 secs (across all hosts),
285 it will be terminated.
287 VNF License Information Guidelines
288 ------------------------------------------------------------
290 This Appendix describes the metadata to be supplied for VNF licenses.
292 1. General Information
294 Table C1 defines the required and optional fields for licenses.
296 Table C1. Required Fields for General Information
297 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
299 +---------------+-----------------------------------+--------------+----------+
300 | **Field Name**| **Description** | **Data Type**| **Type** |
301 +===============+===================================+==============+==========+
302 | VNF Provider | The name of the VNF provider. | String | Mandatory|
304 +---------------+-----------------------------------+--------------+----------+
305 | VNF Provider | The name of the product to which | String | Mandatory|
306 | Product | this agreement applies. | | |
308 | | Note: a contract/agreement may | | |
309 | | apply to more than one VNF | | |
310 | | provider product. In that case, | | |
311 | | provide the metadata for each | | |
312 | | product separately. | | |
313 +---------------+-----------------------------------+--------------+----------+
314 | VNF Provider | A general description of VNF | String | Optional |
315 | Product | provider software product. | | |
316 | Description | | | |
317 +---------------+-----------------------------------+--------------+----------+
318 | Export Control| ECCNs are 5-character | String | Mandatory|
319 | Classification| alpha-numeric designations used on| | |
320 | Number (ECCN) | the Commerce Control List (CCL) to| | |
321 | | identify dual-use items for export| | |
322 | | control purposes. An ECCN | | |
323 | | categorizes items based on the | | |
324 | | nature of the product, i.e. type | | |
325 | | of commodity, software, or | | |
326 | | technology and its respective | | |
327 | | technical parameters. | | |
328 +---------------+-----------------------------------+--------------+----------+
329 | Reporting | A list of any reporting | List of | Optional |
330 | Requirements | requirements on the usage of the | strings | |
331 | | software product. | | |
332 +---------------+-----------------------------------+--------------+----------+
336 Entitlements describe software license use rights. The use rights may be
337 quantified by various metrics: # users, # software instances, # units.
338 The use rights may be limited by various criteria: location (physical or
339 logical), type of customer, type of device, time, etc.
341 One or more entitlements can be defined; each one consists of the
344 Table C2. Required Fields for Entitlements
345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
347 +---------------+-----------------------------------+-------------+-----------+
348 | **Field Name**| **Description** |**Data Type**| **Type** |
349 +===============+===================================+=============+===========+
350 | VNF Provider | Identifier for the entitlement as | String | Mandatory |
351 | Part Number / | described by the VNF provider in | | |
352 | Manufacture | their price list / catalog / | | |
353 | Reference | contract. | | |
355 +---------------+-----------------------------------+-------------+-----------+
356 | Description | Verbiage that describes the | String | Optional |
357 | | entitlement | | |
358 +---------------+-----------------------------------+-------------+-----------+
359 | Entitlement | Each entitlement defined must be | String | Mandatory |
360 | Identifier | identified by a unique value (e.g.| | |
361 | | numbered 1, 2, 3….) | | |
362 +---------------+-----------------------------------+-------------+-----------+
363 | Minimum Order | The minimum number of entitlements| Number | Mandatory |
364 | Requirement | that need to be purchased. | | |
365 | | For example, the entitlements must| | |
366 | | be purchased in a block of 100. If| | |
367 | | no minimum is required, the value | | |
368 | | will be zero. | | |
369 +---------------+-----------------------------------+-------------+-----------+
370 | Unique | A list of any reporting | List of | Optional |
371 | Reporting | requirements on the usage of the | Strings | |
372 | Requirements | software product. (e.g.: quarterly| | |
373 | | usage reports are required) | | |
374 +---------------+-----------------------------------+-------------+-----------+
375 | License Type | Type of license applicable to the | String | Mandatory |
376 | | software product. (e.g.: | | |
377 | | fixed-term, perpetual, trial, | | |
378 | | subscription.) | | |
379 +---------------+-----------------------------------+-------------+-----------+
380 | License | Valid values: | String |Conditional|
382 | | **year**, **quarter**, **month**, | | |
385 | | Not applicable when license type | | |
386 | | is Perpetual. | | |
387 +---------------+-----------------------------------+-------------+-----------+
388 | License | Number of years, quarters, months,| Number |Conditional|
389 | Duration | or days for which the license is | | |
390 | Quantification| valid. | | |
392 | | Not applicable when license type | | |
393 | | is Perpetual. | | |
394 +---------------+-----------------------------------+-------------+-----------+
395 | Limits | see section C.4 for possible | List | Optional |
397 +---------------+-----------------------------------+-------------+-----------+
401 This section defines information on any License Keys associated with the
402 Software Product. A license key is a data string (or a file) providing a
403 means to authorize the use of software. License key does not provide
404 entitlement information.
406 License Keys are not required. Optionally, one or more license keys can
407 be defined; each one consists of the following fields:
409 Table C3. Required Fields for License Keys
410 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
412 +---------------+-----------------------------------+--------------+----------+
413 | **Field Name**| **Description** | **Data Type**| **Type** |
414 +===============+===================================+==============+==========+
415 | Description | Verbiage that describes the | String | Mandatory|
416 | | license key | | |
417 +---------------+-----------------------------------+--------------+----------+
418 | License Key | Each license key defined must be | String | Mandatory|
419 | Identifier | identified by a unique value | | |
420 | | (e.g., numbered 1, 2, 3….) | | |
421 +---------------+-----------------------------------+--------------+----------+
422 | Key Function | Lifecycle stage (e.g., | String | Optional |
423 | | Instantiation or Activation) at | | |
424 | | which the license key is applied | | |
425 | | to the software. | | |
426 +---------------+-----------------------------------+--------------+----------+
427 | License Key | Valid values: | String | Mandatory|
429 | | **Universal, Unique** | | |
431 | | **Universal** - a single license | | |
432 | | key value that may be used with | | |
433 | | any number of instances of the | | |
436 | | **Unique**- a unique license key | | |
437 | | value is required for each | | |
438 | | instance of the software. | | |
439 +---------------+-----------------------------------+--------------+----------+
440 | Limits | see section C.4 for possible | List | Optional |
442 +---------------+-----------------------------------+--------------+----------+
444 1. Entitlement and License Key Limits
446 Limitations on the use of software entitlements and license keys may be
447 based on factors such as: features enabled in the product, the allowed
448 capacity of the product, number of installations, etc... The limits may
449 generally be categorized as:
461 Multiple limits may be applicable for an entitlement or license key.
462 Each limit may further be described by limit behavior, duration,
463 quantification, aggregation, aggregation interval, start date, end date,
466 When the limit is associated with a quantity, the quantity is relative
467 to an instance of the entitlement or license key. For example:
469 - Each entitlement grants the right to 50 concurrent users. If 10
470 entitlements are purchased, the total number of concurrent users
471 permitted would be 500. In this example, the limit category is
472 **amount**, the limit type is **users**, and the limit
473 **quantification** is **50.**
475 Each license key may be installed on 3 devices. If 5 license keys are
476 acquired, the total number of devices allowed would be 15. In this
477 example, the limit category is **usages**, the limit type is
478 **device**, and the limit **quantification** is **3.**
482 Locations may be logical or physical location (e.g., site, country). For
485 - use is allowed in Canada
487 Table C4. Required Fields for Location
488 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
490 +------------------+--------------------------------+--------------+----------+
491 | **Field Name** | **Description** | **Data Type**| **Type** |
492 +==================+================================+==============+==========+
493 | Limit Identifier | Each limit defined for an | String | Mandatory|
494 | | entitlement or license key must| | |
495 | | be identified by a unique value| | |
496 | | (e.g., numbered 1,2,3…) | | |
497 +------------------+--------------------------------+--------------+----------+
498 | Limit Description| Verbiage describing the limit. | String | Mandatory|
499 +------------------+--------------------------------+--------------+----------+
500 | Limit Behavior | Description of the actions | String | Mandatory|
501 | | taken when the limit boundaries| | |
502 | | are reached. | | |
503 +------------------+--------------------------------+--------------+----------+
504 | Limit Category | Valid value: **location** | String | Mandatory|
505 +------------------+--------------------------------+--------------+----------+
506 | Limit Type | Valid values: **city, county, | String | Mandatory|
507 | | state, country, region, MSA, | | |
508 | | BTA, CLLI** | | |
509 +------------------+--------------------------------+--------------+----------+
510 | Limit List | List of locations where the VNF| List of | Mandatory|
511 | | provider Product can be used or| String | |
512 | | needs to be restricted from use| | |
513 +------------------+--------------------------------+--------------+----------+
514 | Limit Set Type | Indicates if the list is an | String | Mandatory|
515 | | inclusion or exclusion. | | |
517 | | Valid Values: | | |
519 | | **Allowed** | | |
521 | | **Not allowed** | | |
522 +------------------+--------------------------------+--------------+----------+
523 | Limit | The quantity (amount) the limit| Number | Optional |
524 | Quantification | expresses. | | |
525 +------------------+--------------------------------+--------------+----------+
529 Limit on the length of time the software may be used. For example:
531 - license key valid for 1 year from activation
533 - entitlement valid from 15 May 2018 thru 30 June 2020
535 Table C5. Required Fields for Time
536 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
538 +------------------+-------------------------------+--------------+-----------+
539 | **Field Name** | **Description** | **Data Type**| **Type** |
540 +==================+===============================+==============+===========+
541 | Limit Identifier | Each limit defined for an | String | Mandatory |
542 | | entitlement or license key | | |
543 | | must be identified by a unique| | |
544 | | value (e.g., numbered) | | |
545 +------------------+-------------------------------+--------------+-----------+
546 | Limit Description| Verbiage describing the limit.| String | Mandatory |
547 +------------------+-------------------------------+--------------+-----------+
548 | Limit Behavior | Description of the actions | String | Mandatory |
549 | | taken when the limit | | |
550 | | boundaries are reached. | | |
552 | | The limit behavior may also | | |
553 | | describe when a time limit | | |
554 | | takes effect. (e.g., key is | | |
555 | | valid for 1 year from date of | | |
557 +------------------+-------------------------------+--------------+-----------+
558 | Limit Category | Valid value: **time** | String | Mandatory |
559 +------------------+-------------------------------+--------------+-----------+
560 | Limit Type | Valid values: | String | Mandatory |
561 | | **duration, date** | | |
562 +------------------+-------------------------------+--------------+-----------+
563 | Limit List | List of times for which the | List of | Mandatory |
564 | | VNF Provider Product can be | String | |
565 | | used or needs to be restricted| | |
567 +------------------+-------------------------------+--------------+-----------+
568 | Duration Units | Required when limit type is | String |Conditional|
569 | | duration. Valid values: | | |
570 | | **perpetual, year, quarter, | | |
571 | | month, day, minute, second, | | |
572 | | millisecond** | | |
573 +------------------+-------------------------------+--------------+-----------+
574 | Limit | The quantity (amount) the | Number | Optional |
575 | Quantification | limit expresses. | | |
576 +------------------+-------------------------------+--------------+-----------+
577 | Start Date | Required when limit type is | Date | Optional |
579 +------------------+-------------------------------+--------------+-----------+
580 | End Date | May be used when limit type is| Date | Optional |
582 +------------------+-------------------------------+--------------+-----------+
586 Limits based on how the software is used. For example:
588 - use is limited to a specific sub-set of the features/capabilities the
591 - use is limited to a certain environment (e.g., test, development,
594 - use is limited by processor (vm, cpu, core)
596 - use is limited by software release
598 Table C6. Required Fields for Usage
599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
601 +------------------+-------------------------------+---------------+----------+
602 | **Field Name** | **Description** | **Data Type** | **Type** |
603 +==================+===============================+===============+==========+
604 | Limit Identifier | Each limit defined for an | String | Mandatory|
605 | | entitlement or license key | | |
606 | | must be identified by a unique| | |
607 | | value (e.g., numbered) | | |
608 +------------------+-------------------------------+---------------+----------+
609 | Limit Description| Verbiage describing the limit.| String | Mandatory|
610 +------------------+-------------------------------+---------------+----------+
611 | Limit Behavior | Description of the actions | String | Mandatory|
612 | | taken when the limit | | |
613 | | boundaries are reached. | | |
614 +------------------+-------------------------------+---------------+----------+
615 | Limit Category | Valid value: **usages** | String | Mandatory|
616 +------------------+-------------------------------+---------------+----------+
617 | Limit Type | Valid values: **feature, | String | Mandatory|
618 | | environment, processor, | | |
620 +------------------+-------------------------------+---------------+----------+
621 | Limit List | List of usage limits (e.g., | List of String| Mandatory|
622 | | test, development, vm, core, | | |
623 | | R1.2.1, R1.3.5…) | | |
624 +------------------+-------------------------------+---------------+----------+
625 | Limit Set Type | Indicates if the list is an | String | Mandatory|
626 | | inclusion or exclusion. | | |
628 | | Valid Values: | | |
630 | | **Allowed** | | |
632 | | **Not allowed** | | |
633 +------------------+-------------------------------+---------------+----------+
634 | Limit | The quantity (amount) the | Number | Optional |
635 | Quantification | limit expresses. | | |
636 +------------------+-------------------------------+---------------+----------+
640 Limit on the entity (product line, organization, customer) allowed to
641 make use of the software. For example:
643 - allowed to be used in support of wireless products
645 - allowed to be used only for government entities
647 Table C7. Required Fields for Entity
648 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
650 +------------------+--------------------------------+--------------+----------+
651 | **Field Name** | **Description** |**Data Type** | **Type** |
652 +==================+================================+==============+==========+
653 | Limit Identifier | Each limit defined for an | String | Mandatory|
654 | | entitlement or license key must| | |
655 | | be identified by a unique value| | |
656 | | (e.g., numbered) | | |
657 +------------------+--------------------------------+--------------+----------+
658 | Limit Description| Verbiage describing the limit. | String | Mandatory|
659 +------------------+--------------------------------+--------------+----------+
660 | Limit Behavior | Description of the actions | String | Mandatory|
661 | | taken when the limit boundaries| | |
662 | | are reached. | | |
663 +------------------+--------------------------------+--------------+----------+
664 | Limit Category | Valid value: **entity** | String | Mandatory|
665 +------------------+--------------------------------+--------------+----------+
666 | Limit Type | Valid values: **product line, | String | Mandatory|
667 | | organization, internal | | |
668 | | customer, external customer** | | |
669 +------------------+--------------------------------+--------------+----------+
670 | Limit List | List of entities for which the |List of String| Mandatory|
671 | | VNF Provider Product can be | | |
672 | | used or needs to be restricted | | |
674 +------------------+--------------------------------+--------------+----------+
675 | Limit Set Type | Indicates if the list is an | String | Mandatory|
676 | | inclusion or exclusion. | | |
678 | | Valid Values: | | |
680 | | **Allowed** | | |
682 | | **Not allowed** | | |
683 +------------------+--------------------------------+--------------+----------+
684 | Limit | The quantity (amount) the limit| Number | Optional |
685 | Quantification | expresses. | | |
686 +------------------+--------------------------------+--------------+----------+
690 These limits describe terms relative to utilization of the functions of
691 the software (for example, number of named users permitted, throughput,
692 or capacity). Limits of this type may also be relative to utilization of
693 other resources (for example, a limit for firewall software is not based
694 on use of the firewall software, but on the number of network
697 The metadata describing this type of limit includes the unit of measure
698 (e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units,
699 any aggregation function (e.g., peak or average users), and aggregation
700 interval (day, month, quarter, year, etc.).
702 Table C8. Required Fields for Amount
703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
705 +------------------+---------------------------------+-------------+----------+
706 | **Field Name** | **Description** |**Data Type**| **Type** |
707 +==================+=================================+=============+==========+
708 | Limit Identifier | Each limit defined for an | String | Mandatory|
709 | | entitlement or license key must | | |
710 | | be identified by a unique value | | |
711 | | (e.g., numbered) | | |
712 +------------------+---------------------------------+-------------+----------+
713 | Limit Description| Verbiage describing the limit. | String | Mandatory|
714 +------------------+---------------------------------+-------------+----------+
715 | Limit Behavior | Description of the actions taken| String | Mandatory|
716 | | when the limit boundaries are | | |
718 +------------------+---------------------------------+-------------+----------+
719 | Limit Category | Valid value: **amount** | String | Mandatory|
720 +------------------+---------------------------------+-------------+----------+
721 | Limit Type | Valid values: **trunk, user, | String | Mandatory|
722 | | subscriber, session, token, | | |
723 | | transactions, seats, KB, MB, TB,| | |
725 +------------------+---------------------------------+-------------+----------+
726 | Type of | Is the limit relative to | String | Mandatory|
727 | Utilization | utilization of the functions of | | |
728 | | the software or relative to | | |
729 | | utilization of other resources? | | |
731 | | Valid values: | | |
733 | | - **software functions** | | |
735 | | - **other resources** | | |
736 +------------------+---------------------------------+-------------+----------+
737 | Limit | The quantity (amount) the limit | Number | Optional |
738 | Quantification | expresses. | | |
739 +------------------+---------------------------------+-------------+----------+
740 | Aggregation | Valid values: **peak, average** | String | Optional |
742 +------------------+---------------------------------+-------------+----------+
743 | Aggregation | Time period over which the | String | Optional |
744 | Interval | aggregation is done (e.g., | | |
745 | | average sessions per quarter). | | |
746 | | Required when an Aggregation | | |
747 | | Function is specified. | | |
749 | | Valid values: **day, month, | | |
750 | | quarter, year, minute, second, | | |
751 | | millisecond** | | |
752 +------------------+---------------------------------+-------------+----------+
753 | Aggregation | Is the limit quantity applicable| String | Optional |
754 | Scope | to a single entitlement or | | |
755 | | license key (each separately)? | | |
756 | | Or may the limit quantity be | | |
757 | | combined with others of the same| | |
758 | | type (resulting in limit amount | | |
759 | | that is the sum of all the | | |
760 | | purchased entitlements or | | |
761 | | license keys)? | | |
763 | | Valid values: | | |
765 | | - **single** | | |
767 | | - **combined** | | |
768 +------------------+---------------------------------+-------------+----------+
769 | Type of User | Describes the types of users of | String | Optional |
770 | | the functionality offered by the| | |
771 | | software (e.g., authorized, | | |
772 | | named). This field is included | | |
773 | | when Limit Type is user. | | |
774 +------------------+---------------------------------+-------------+----------+
777 -----------------------------
779 Table D1. ONAP Resource DM TOSCA/YAML constructs
780 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
782 Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by
783 VNF vendors to create a standard VNF descriptor.
785 All definitions are summarized in the table below based on the agreed ONAP
786 Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in
787 ETSI GS NFV-SOL001 stable draft for VNF-D.
789 +------------+------------------------------+---------------------------------+
790 | Requirement| Resource IM Info Elements | TOSCA Constructs as per SOL001 |
792 +============+==============================+=================================+
793 | R-02454 | VNFD.vnfSoftwareVersion | For VDU.Compute - |
794 | | | tosca.artifacts.nfv.SwImage |
796 | | SwImageDesc.Version | For Virtual Storage - |
797 | | | tosca.artifacts.Deployment.Image|
798 +------------+------------------------------+---------------------------------+
799 | R-03070 | vnfExtCpd's with virtual | tosca.nodes.nfv.VnfExtCp with a |
800 | | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\ |
801 | | (vNIC) | VirtualNetworkInterface\ |
803 +------------+------------------------------+---------------------------------+
804 | R-09467 | VDU.Compute descriptor | tosca.nodes.nfv.Vdu.Compute |
805 +------------+------------------------------+---------------------------------+
806 | R-16065 | VDU.Compute. Configurable | tosca.datatypes.nfv.Vnfc |
807 | | Properties | ConfigurableProperties |
808 +------------+------------------------------+---------------------------------+
809 | R-30654 | VNFD.lifeCycleManagement | Interface construct tosca.\ |
810 | | Script - IFA011 LifeCycle\ | interfaces.nfv.vnf.lifecycle.Nfv|
811 | | ManagementScript | with a list of standard LCM |
813 +------------+------------------------------+---------------------------------+
814 | R-35851 | CPD: VduCp, VnfExtCp, | tosca.nodes.nfv.VduCp, tosca.\ |
815 | | VnfVirtualLinkDesc, QoS | nodes.nfv.VnfVirtualLink, |
816 | | Monitoring info element - | tosca.nodes.nfv.VnfExtCp |
818 +------------+------------------------------+---------------------------------+
819 | R-41215 | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile |
820 | | aspect | and tosca.datatypes.nfv.\ |
821 | | | ScalingAspect |
822 +------------+------------------------------+---------------------------------+
823 | R-66070 | VNFD meta data | tosca.datatypes.nfv. |
824 | | | VnfInfoModifiableAttributes - |
826 +------------+------------------------------+---------------------------------+
827 | R-96634 | VNFD.configurableProperties | tosca.datatypes.nfv.Vnf\ |
828 | | describing scaling | ConfigurableProperties, |
829 | | characteristics. VNFD.\ | tosca.datatypes.nfv.ScaleInfo |
830 | | autoscale defines the rules | |
831 | | for scaling based on specific| |
832 | | VNF indications | |
833 +------------+------------------------------+---------------------------------+
834 | ? | VDU Virtual Storage | tosca.nodes.nfv.Vdu.\ |
835 | | | VirtualStorage |
836 +------------+------------------------------+---------------------------------+
837 | R-01478 | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - |
838 | | - SOL001 per VNF/VDU/VLink | type for monitoring |
839 | R-01556 | memory-consumption, | |
840 | | CPU-utilization, | monitoring_parameter of above |
841 | | bandwidth-consumption, VNFC | type per VNF/VDU/VLink |
842 | | downtime, etc. | |
843 +------------+------------------------------+---------------------------------+
846 Table D2. TOSCA CSAR structure
847 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
849 This section defines the requirements around the CSAR structure.
851 The table below describes the numbered requirements for CSAR structure as
852 agreed with SDC. The format of the CSAR is specified in SOL004.
854 +------------+-------------------------------------+--------------------------+
855 | Requirement| Description | CSAR artifact directory |
857 +============+=====================================+==========================+
858 | R-26881 | The VNF provider MUST provide the | ROOT\\Artifacts\ |
859 | | binaries and images needed to | \\VNF_Image.bin |
860 | | instantiate the VNF (VNF and VNFC | |
862 +------------+-------------------------------------+--------------------------+
863 | R-30654 | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\ |
864 | | includes a list of events and | \\Informational\ |
865 | | corresponding management scripts | \\Install.csh |
866 | | performed for the VNF - SOL001 | |
867 +------------+-------------------------------------+--------------------------+
868 | R-35851 | All VNF topology related definitions| ROOT\\Definitions\ |
869 | | in yaml files VNFD/Main Service | \\VNFC.yaml |
870 | | template at the ROOT | |
872 | | | \\MainService\ |
873 | | | \\Template.yaml |
874 +------------+-------------------------------------+--------------------------+
875 | R-40827 | CSAR License directory - SOL004 | ROOT\\Licenses\ |
876 | | | \\License_term.txt |
877 +------------+-------------------------------------+--------------------------+
878 | R-77707 | CSAR Manifest file - SOL004 | ROOT\ |
879 | | | \\MainServiceTemplate.mf |
880 +------------+-------------------------------------+--------------------------+
884 --------------------------------
886 **VNF Development Requirements**
887 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892 R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs.
894 R-82223 The VNF **MUST** be decomposed if the functions have
895 significantly different scaling characteristics (e.g., signaling
896 versus media functions, control versus data plane functions).
898 R-16496 The VNF **MUST** enable instantiating only the functionality that
899 is needed for the decomposed VNF (e.g., if transcoding is not needed it
900 should not be instantiated).
902 R-02360 The VNFC **MUST** be designed as a standalone, executable process.
904 R-34484 The VNF **SHOULD** create a single component VNF for VNFCs
905 that can be used by other VNFs.
907 R-23035 The VNF **MUST** be designed to scale horizontally (more
908 instances of a VNF or VNFC) and not vertically (moving the existing
909 instances to larger VMs or increasing the resources within a VM)
910 to achieve effective utilization of cloud resources.
912 R-30650 The VNF **MUST** utilize cloud provided infrastructure and
913 VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so
914 that the cloud can manage and provide a consistent service resiliency
915 and methods across all VNF's.
917 R-12709 The VNFC **SHOULD** be independently deployed, configured,
918 upgraded, scaled, monitored, and administered by ONAP.
920 R-37692 The VNFC **MUST** provide API versioning to allow for
921 independent upgrades of VNFC.
923 R-86585 The VNFC **SHOULD** minimize the use of state within
924 a VNFC to facilitate the movement of traffic from one instance
927 R-65134 The VNF **SHOULD** maintain state in a geographically
928 redundant datastore that may, in fact, be its own VNFC.
930 R-75850 The VNF **SHOULD** decouple persistent data from the VNFC
931 and keep it in its own datastore that can be reached by all instances
932 of the VNFC requiring the data.
934 R-88199 The VNF **MUST** utilize a persistent datastore service that
935 can meet the data performance/latency requirements. (For example:
936 Datastore service could be a VNFC in VNF or a DBaaS in the Cloud
937 execution environment)
939 R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC
942 R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring
943 high packets/sec performance. High packet throughput is defined as greater
944 than 500K packets/sec.
946 R-54430 The VNF **MUST** use the NCSP’s supported library and compute
947 flavor that supports DPDK to optimize network efficiency if using DPDK. [5]_
949 R-18864 The VNF **MUST** NOT use technologies that bypass virtualization
950 layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary
951 to meet functional or performance requirements).
953 R-64768 The VNF **MUST** limit the size of application data packets
954 to no larger than 9000 bytes for SDN network-based tunneling when
955 guest data packets are transported between tunnel endpoints that
956 support guest logical networks.
958 R-74481 The VNF **MUST** NOT require the use of a dynamic routing
959 protocol unless necessary to meet functional requirements.
962 ~~~~~~~~~~~~~~~~~~~~~~~~~
964 R-52499 The VNF **MUST** meet their own resiliency goals and not rely
965 on the Network Cloud.
967 R-42207 The VNF **MUST** design resiliency into a VNF such that the
968 resiliency deployment model (e.g., active-active) can be chosen at
971 R-03954 The VNF **MUST** survive any single points of failure within
972 the Network Cloud (e.g., virtual NIC, VM, disk failure).
974 R-89010 The VNF **MUST** survive any single points of software failure
975 internal to the VNF (e.g., in memory structures, JMS message queues).
977 R-67709 The VNF **MUST** be designed, built and packaged to enable
978 deployment across multiple fault zones (e.g., VNFCs deployed in
979 different servers, racks, OpenStack regions, geographies) so that
980 in the event of a planned/unplanned downtime of a fault zone, the
981 overall operation/throughput of the VNF is maintained.
983 R-35291 The VNF **MUST** support the ability to failover a VNFC
984 automatically to other geographically redundant sites if not
985 deployed active-active to increase the overall resiliency of the VNF.
987 R-36843 The VNF **MUST** support the ability of the VNFC to be deployable
988 in multi-zoned cloud sites to allow for site support in the event of cloud
989 zone failure or upgrades.
991 R-00098 The VNF **MUST NOT** impact the ability of the VNF to provide
992 service/function due to a single container restart.
994 R-79952 The VNF **SHOULD** support container snapshots if not for rebuild
995 and evacuate for rollback or back out mechanism.
997 R-92935 The VNF **SHOULD** minimize the propagation of state information
998 across multiple data centers to avoid cross data center traffic.
1000 R-26371 The VNF **MUST** detect communication failure for inter VNFC
1001 instance and intra/inter VNF and re-establish communication
1002 automatically to maintain the VNF without manual intervention to
1003 provide service continuity.
1005 R-18725 The VNF **MUST** handle the restart of a single VNFC instance
1006 without requiring all VNFC instances to be restarted.
1008 R-06668 The VNF **MUST** handle the start or restart of VNFC instances
1009 in any order with each VNFC instance establishing or re-establishing
1010 required connections or relationships with other VNFC instances and/or
1011 VNFs required to perform the VNF function/role without requiring VNFC
1012 instance(s) to be started/restarted in a particular order.
1014 R-80070 The VNF **MUST** handle errors and exceptions so that they do
1015 not interrupt processing of incoming VNF requests to maintain service
1016 continuity (where the error is not directly impacting the software
1017 handling the incoming request).
1019 R-32695 The VNF **MUST** provide the ability to modify the number of
1020 retries, the time between retries and the behavior/action taken after
1021 the retries have been exhausted for exception handling to allow the
1022 NCSP to control that behavior, where the interface and/or functional
1023 specification allows for altering behaviour.
1025 R-48356 The VNF **MUST** fully exploit exception handling to the extent
1026 that resources (e.g., threads and memory) are released when no longer
1027 needed regardless of programming language.
1029 R-67918 The VNF **MUST** handle replication race conditions both locally
1030 and geo-located in the event of a data base instance failure to maintain
1033 R-36792 The VNF **MUST** automatically retry/resubmit failed requests
1034 made by the software to its downstream system to increase the success rate.
1036 R-70013 The VNF **MUST NOT** require any manual steps to get it ready for
1037 service after a container rebuild.
1039 R-65515 The VNF **MUST** provide a mechanism and tool to start VNF
1040 containers (VMs) without impacting service or service quality assuming
1041 another VNF in same or other geographical location is processing service
1044 R-94978 The VNF **MUST** provide a mechanism and tool to perform a graceful
1045 shutdown of all the containers (VMs) in the VNF without impacting service
1046 or service quality assuming another VNF in same or other geographical
1047 location can take over traffic and process service requests.
1049 R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO,
1050 database, network operations, service calls) in a critical section
1051 of code, so as to minimize blocking of other operations and increase
1052 concurrent throughput.
1054 R-63473 The VNF **MUST** automatically advertise newly scaled
1055 components so there is no manual intervention required.
1057 R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for
1058 both Service Chaining and scaling.
1060 R-41159 The VNF **MUST** deliver any and all functionality from any
1061 VNFC in the pool (where pooling is the most suitable solution). The
1062 VNFC pool member should be transparent to the client. Upstream and
1063 downstream clients should only recognize the function being performed,
1064 not the member performing it.
1066 R-85959 The VNF **SHOULD** automatically enable/disable added/removed
1067 sub-components or component so there is no manual intervention required.
1069 R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool
1070 without jeopardizing active sessions. Ideally, an active session should
1071 not be tied to any particular VNFC instance.
1073 R-12538 The VNF **SHOULD** support load balancing and discovery
1074 mechanisms in resource pools containing VNFC instances.
1076 R-98989 The VNF **SHOULD** utilize resource pooling (threads,
1077 connections, etc.) within the VNF application so that resources
1078 are not being created and destroyed resulting in resource management
1081 R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when
1082 initialization includes loading catalogues and/or lists which can grow
1083 over time, so that the VNF startup time does not grow at a rate
1084 proportional to that of the list.
1086 R-35532 The VNF **SHOULD** release and clear all shared assets (memory,
1087 database operations, connections, locks, etc.) as soon as possible,
1088 especially before long running sync and asynchronous operations, so as
1089 to not prevent use of these assets by other entities.
1091 R-77334 The VNF **MUST** allow configurations and configuration parameters
1092 to be managed under version control to ensure consistent configuration
1093 deployment, traceability and rollback.
1095 R-99766 The VNF **MUST** allow configurations and configuration parameters
1096 to be managed under version control to ensure the ability to rollback to
1097 a known valid configuration.
1099 R-73583 The VNF **MUST** allow changes of configuration parameters
1100 to be consumed by the VNF without requiring the VNF or its sub-components
1101 to be bounced so that the VNF availability is not effected.
1103 R-21558 The VNF **SHOULD** use intelligent routing by having knowledge
1104 of multiple downstream/upstream endpoints that are exposed to it, to
1105 ensure there is no dependency on external services (such as load balancers)
1106 to switch to alternate endpoints.
1108 R-08315 The VNF **SHOULD** use redundant connection pooling to connect
1109 to any backend data source that can be switched between pools in an
1110 automated/scripted fashion to ensure high availability of the connection
1113 R-27995 The VNF **SHOULD** include control loop mechanisms to notify
1114 the consumer of the VNF of their exceeding SLA thresholds so the consumer
1115 is able to control its load against the VNF.
1117 R-73364 The VNF **MUST** support at least two major versions of the
1118 VNF software and/or sub-components to co-exist within production
1119 environments at any time so that upgrades can be applied across
1120 multiple systems in a staggered manner.
1122 R-02454 The VNF **MUST** support the existence of multiple major/minor
1123 versions of the VNF software and/or sub-components and interfaces that
1124 support both forward and backward compatibility to be transparent to
1125 the Service Provider usage.
1127 R-57855 The VNF **MUST** support hitless staggered/rolling deployments
1128 between its redundant instances to allow "soak-time/burn in/slow roll"
1129 which can enable the support of low traffic loads to validate the
1130 deployment prior to supporting full traffic loads.
1132 R-64445 The VNF **MUST** support the ability of a requestor of the
1133 service to determine the version (and therefore capabilities) of the
1134 service so that Network Cloud Service Provider can understand the
1135 capabilities of the service.
1137 R-56793 The VNF **MUST** test for adherence to the defined performance
1138 budgets at each layer, during each delivery cycle with delivered
1139 results, so that the performance budget is measured and the code
1140 is adjusted to meet performance budget.
1142 R-77667 The VNF **MUST** test for adherence to the defined performance
1143 budget at each layer, during each delivery cycle so that the performance
1144 budget is measured and feedback is provided where the performance budget
1147 R-49308 The VNF **SHOULD** test for adherence to the defined resiliency
1148 rating recommendation at each layer, during each delivery cycle with
1149 delivered results, so that the resiliency rating is measured and the
1150 code is adjusted to meet software resiliency requirements.
1152 R-16039 The VNF **SHOULD** test for adherence to the defined
1153 resiliency rating recommendation at each layer, during each
1154 delivery cycle so that the resiliency rating is measured and
1155 feedback is provided where software resiliency requirements are
1158 R-34957 The VNF **MUST** provide a method of metrics gathering for each
1159 layer's performance to identify/document variances in the allocations so
1160 they can be addressed.
1162 R-49224 The VNF **MUST** provide unique traceability of a transaction
1163 through its life cycle to ensure quick and efficient troubleshooting.
1165 R-52870 The VNF **MUST** provide a method of metrics gathering
1166 and analysis to evaluate the resiliency of the software from both
1167 a granular as well as a holistic standpoint. This includes, but is
1168 not limited to thread utilization, errors, timeouts, and retries.
1170 R-92571 The VNF **MUST** provide operational instrumentation such as
1171 logging, so as to facilitate quick resolution of issues with the VNF to
1172 provide service continuity.
1174 R-48917 The VNF **MUST** monitor for and alert on (both sender and
1175 receiver) errant, running longer than expected and missing file transfers,
1176 so as to minimize the impact due to file transfer errors.
1178 R-28168 The VNF **SHOULD** use an appropriately configured logging
1179 level that can be changed dynamically, so as to not cause performance
1180 degradation of the VNF due to excessive logging.
1182 R-87352 The VNF **SHOULD** utilize Cloud health checks, when available
1183 from the Network Cloud, from inside the application through APIs to check
1184 the network connectivity, dropped packets rate, injection, and auto failover
1185 to alternate sites if needed.
1187 R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all
1188 inter/intra-connectivity points in the VNF to provide an overall resiliency
1189 rating for the VNF to be incorporated into the software design and
1190 development of the VNF.
1195 R-23740 The VNF **MUST** accommodate the security principle of
1196 “least privilege” during development, implementation and operation.
1197 The importance of “least privilege” cannot be overstated and must be
1198 observed in all aspects of VNF development and not limited to security.
1199 This is applicable to all sections of this document.
1201 R-61354 The VNF **MUST** implement access control list for OA&M
1202 services (e.g., restricting access to certain ports or applications).
1204 R-85633 The VNF **MUST** implement Data Storage Encryption
1205 (database/disk encryption) for Sensitive Personal Information (SPI)
1206 and other subscriber identifiable data. Note: subscriber’s SPI/data
1207 must be encrypted at rest, and other subscriber identifiable data
1208 should be encrypted at rest. Other data protection requirements exist
1209 and should be well understood by the developer.
1211 R-92207 The VNF **SHOULD** implement a mechanism for automated and
1212 frequent "system configuration (automated provisioning / closed loop)"
1215 R-23882 The VNF **SHOULD** be scanned using both network scanning
1216 and application scanning security tools on all code, including underlying
1217 OS and related configuration. Scan reports shall be provided. Remediation
1218 roadmaps shall be made available for any findings.
1220 R-46986 The VNF **SHOULD** have source code scanned using scanning
1221 tools (e.g., Fortify) and provide reports.
1223 R-55830 The VNF **MUST** distribute all production code from NCSP
1224 internal sources only. No production code, libraries, OS images, etc.
1225 shall be distributed from publically accessible depots.
1227 R-99771 The VNF **MUST** provide all code/configuration files in a
1228 "Locked down" or hardened state or with documented recommendations for
1229 such hardening. All unnecessary services will be disabled. VNF provider
1230 default credentials, community strings and other such artifacts will be
1231 removed or disclosed so that they can be modified or removed during
1234 R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of
1235 traffic by application (dropping packets not belonging to the VPN) (i.e.,
1236 AVPN, IPSec VPN for Internet routes).
1238 R-33981 The VNF **SHOULD** interoperate with various access control
1239 mechanisms for the Network Cloud execution environment (e.g.,
1240 Hypervisors, containers).
1242 R-40813 The VNF **SHOULD** support the use of virtual trusted platform
1243 module, hypervisor security testing and standards scanning tools.
1245 R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that
1246 it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual
1247 routing and forwarding rules.
1249 R-26586 The VNF **SHOULD** support the ability to work with aliases
1250 (e.g., gateways, proxies) to protect and encapsulate resources.
1252 R-49956 The VNF **MUST** pass all access to applications (Bearer,
1253 signaling and OA&M) through various security tools and platforms from
1254 ACLs, stateful firewalls and application layer gateways depending on
1255 manner of deployment. The application is expected to function (and in
1256 some cases, interwork) with these security tools.
1258 R-69649 The VNF **MUST** have all vulnerabilities patched as soon
1259 as possible. Patching shall be controlled via change control process
1260 with vulnerabilities disclosed along with mitigation recommendations.
1262 R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification,
1263 authentication and access control of customer or VNF application users.
1265 R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with
1266 the requirements if not using the NCSP’s IDAM API, for identification,
1267 authentication and access control of OA&M and other system level
1270 R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1271 User-IDs and passwords to uniquely identify the user/application. VNF
1272 needs to have appropriate connectors to the Identity, Authentication
1273 and Authorization systems that enables access at OS, Database and
1274 Application levels as appropriate.
1276 R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide
1277 the ability to support Multi-Factor Authentication (e.g., 1st factor =
1278 Software token on device (RSA SecureID); 2nd factor = User Name+Password,
1279 etc.) for the users.
1281 R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1282 Role-Based Access Control to permit/limit the user/application to
1283 performing specific activities.
1285 R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1286 logging via ONAP for a historical view of “who did what and when”.
1288 R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt
1289 OA&M access (e.g., SSH, SFTP).
1291 R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce
1292 a configurable maximum number of Login attempts policy for the users.
1293 VNF provider must comply with "terminate idle sessions" policy.
1294 Interactive sessions must be terminated, or a secure, locking screensaver
1295 must be activated requiring authentication, after a configurable period
1296 of inactivity. The system-based inactivity timeout for the enterprise
1297 identity and access management system must also be configurable.
1299 R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1300 with the NCSP’s credential management policy.
1302 R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire
1303 passwords at regular configurable intervals.
1305 R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1306 with "password complexity" policy. When passwords are used, they shall
1307 be complex and shall at least meet the following password construction
1308 requirements: (1) be a minimum configurable number of characters in
1309 length, (2) include 3 of the 4 following types of characters:
1310 upper-case alphabetic, lower-case alphabetic, numeric, and special,
1311 (3) not be the same as the UserID with which they are associated or
1312 other common strings as specified by the environment, (4) not contain
1313 repeating or sequential characters or numbers, (5) not to use special
1314 characters that may have command functions, and (6) new passwords must
1315 not contain sequences of three or more characters from the previous
1318 R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1319 with "password changes (includes default passwords)" policy. Products
1320 will support password aging, syntax and other credential management
1321 practices on a configurable basis.
1323 R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1324 use of common third party authentication and authorization tools such
1327 R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1328 with "No Self-Signed Certificates" policy. Self-signed certificates
1329 must be used for encryption only, using specified and approved
1330 encryption protocols such as TLS 1.2 or higher or equivalent security
1331 protocols such as IPSec, AES.
1333 R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API,
1334 authenticate system to system communications where one system
1335 accesses the resources of another system, and must never conceal
1336 individual accountability.
1338 R-95105 The VNF **MUST** host connectors for access to the application
1341 R-45496 The VNF **MUST** host connectors for access to the OS
1342 (Operating System) layer.
1344 R-05470 The VNF **MUST** host connectors for access to the database layer.
1346 R-99174 The VNF **MUST** comply with Individual Accountability
1347 (each person must be assigned a unique ID) when persons or non-person
1348 entities access VNFs.
1350 R-42874 The VNF **MUST** comply with Least Privilege (no more
1351 privilege than required to perform job functions) when persons
1352 or non-person entities access VNFs.
1354 R-71787 The VNF **MUST** comply with Segregation of Duties (access to a
1355 single layer and no developer may access production without special
1356 oversight) when persons or non-person entities access VNFs.
1358 R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely.
1360 R-49945 The VNF **MUST** authorize VNF provider access through a
1361 client application API by the client application owner and the resource
1362 owner of the VNF before provisioning authorization through Role Based
1363 Access Control (RBAC), Attribute Based Access Control (ABAC), or other
1364 policy based mechanism.
1366 R-31751 The VNF **MUST** subject VNF provider access to privilege
1367 reconciliation tools to prevent access creep and ensure correct
1368 enforcement of access policies.
1370 R-34552 The VNF **MUST** provide or support the Identity and Access
1371 Management (IDAM) based threat detection data for OWASP Top 10.
1373 R-29301 The VNF **MUST** provide or support the Identity and Access
1374 Management (IDAM) based threat detection data for Password Attacks.
1376 R-72243 The VNF **MUST** provide or support the Identity and Access
1377 Management (IDAM) based threat detection data for Phishing / SMishing.
1379 R-58998 The VNF **MUST** provide or support the Identity and Access
1380 Management (IDAM) based threat detection data for Malware (Key Logger).
1382 R-14025 The VNF **MUST** provide or support the Identity and Access
1383 Management (IDAM) based threat detection data for Session Hijacking.
1385 R-31412 The VNF **MUST** provide or support the Identity and Access
1386 Management (IDAM) based threat detection data for XSS / CSRF.
1388 R-51883 The VNF **MUST** provide or support the Identity and Access
1389 Management (IDAM) based threat detection data for Replay.
1391 R-44032 The VNF **MUST** provide or support the Identity and Access
1392 Management (IDAM) based threat detection data for Man in the Middle (MITM).
1394 R-58977 The VNF **MUST** provide or support the Identity and Access
1395 Management (IDAM) based threat detection data for Eavesdropping.
1397 R-24825 The VNF **MUST** provide Context awareness data (device,
1398 location, time, etc.) and be able to integrate with threat detection system.
1400 R-59391 The VNF provider **MUST**, where a VNF provider requires
1401 the assumption of permissions, such as root or administrator, first
1402 log in under their individual user login ID then switch to the other
1403 higher level account; or where the individual user login is infeasible,
1404 must login with an account with admin privileges in a way that
1405 uniquely identifies the individual performing the function.
1407 R-85028 The VNF **MUST** authenticate system to system access and
1408 do not conceal a VNF provider user’s individual accountability for
1411 R-80335 The VNF **MUST** make visible a Warning Notice: A formal
1412 statement of resource intent, i.e., a warning notice, upon initial
1413 access to a VNF provider user who accesses private internal networks
1414 or Company computer resources, e.g., upon initial logon to an internal
1415 web site, system or application which requires authentication.
1417 R-73541 The VNF **MUST** use access controls for VNFs and their
1418 supporting computing systems at all times to restrict access to
1419 authorized personnel only, e.g., least privilege. These controls
1420 could include the use of system configuration or access control
1423 R-64503 The VNF **MUST** provide minimum privileges for initial
1424 and default settings for new user accounts.
1426 R-86835 The VNF **MUST** set the default settings for user access
1427 to sensitive commands and data to deny authorization.
1429 R-77157 The VNF **MUST** conform to approved request, workflow
1430 authorization, and authorization provisioning requirements when
1431 creating privileged users.
1433 R-81147 The VNF **MUST** have greater restrictions for access and
1434 execution, such as up to 3 factors of authentication and restricted
1435 authorization, for commands affecting network services, such as
1436 commands relating to VNFs.
1438 R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2)
1439 transmission of data on internal and external networks.
1441 R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs.
1443 R-15671 The VNF **MUST NOT** provide public or unrestricted access
1444 to any data without the permission of the data owner. All data
1445 classification and access controls must be followed.
1447 R-89753 The VNF **MUST NOT** install or use systems, tools or
1448 utilities capable of capturing or logging data that was not created
1449 by them or sent specifically to them in production, without
1450 authorization of the VNF system owner.
1452 R-19082 The VNF **MUST NOT** run security testing tools and
1453 programs, e.g., password cracker, port scanners, hacking tools
1454 in production, without authorization of the VNF system owner.
1456 R-19790 The VNF **MUST NOT** include authentication credentials
1457 in security audit logs, even if encrypted.
1459 R-85419 The VNF **SHOULD** use REST APIs exposed to Client
1460 Applications for the implementation of OAuth 2.0 Authorization
1461 Code Grant and Client Credentials Grant, as the standard interface
1464 R-48080 The VNF **SHOULD** support SCEP (Simple Certificate
1465 Enrollment Protocol).
1467 R-37608 The VNF **MUST** provide a mechanism to restrict access based
1468 on the attributes of the VNF and the attributes of the subject.
1470 R-43884 The VNF **MUST** integrate with external authentication
1471 and authorization services (e.g., IDAM).
1473 R-25878 The VNF **MUST** use certificates issued from publicly
1474 recognized Certificate Authorities (CA) for the authentication process
1475 where PKI-based authentication is used.
1477 R-19804 The VNF **MUST** validate the CA signature on the certificate,
1478 ensure that the date is within the validity period of the certificate,
1479 check the Certificate Revocation List (CRL), and recognize the identity
1480 represented by the certificate where PKI-based authentication is used.
1482 R-47204 The VNF **MUST** protect the confidentiality and integrity of
1483 data at rest and in transit from unauthorized access and modification.
1485 R-33488 The VNF **MUST** protect against all denial of service
1486 attacks, both volumetric and non-volumetric, or integrate with external
1487 denial of service protection tools.
1489 R-21652 The VNF **MUST** implement the following input validation
1490 control: Check the size (length) of all input. Do not permit an amount
1491 of input so great that it would cause the VNF to fail. Where the input
1492 may be a file, the VNF API must enforce a size limit.
1494 R-54930 The VNF **MUST** implement the following input validation
1495 control: Do not permit input that contains content or characters
1496 inappropriate to the input expected by the design. Inappropriate input,
1497 such as SQL insertions, may cause the system to execute undesirable
1498 and unauthorized transactions against the database or allow other
1499 inappropriate access to the internal network.
1501 R-21210 The VNF **MUST** implement the following input validation
1502 control: Validate that any input file has a correct and valid
1503 Multipurpose Internet Mail Extensions (MIME) type. Input files
1504 should be tested for spoofed MIME types.
1506 R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs.
1508 R-87135 The VNF **MUST** comply with NIST standards and industry
1509 best practices for all implementations of cryptography.
1511 R-02137 The VNF **MUST** implement all monitoring and logging as
1512 described in the Security Analytics section.
1514 R-15659 The VNF **MUST** restrict changing the criticality level of
1515 a system security alarm to administrator(s).
1517 R-19367 The VNF **MUST** monitor API invocation patterns to detect
1518 anomalous access patterns that may represent fraudulent access or
1519 other types of attacks, or integrate with tools that implement anomaly
1520 and abuse detection.
1522 R-78066 The VNF **MUST** support requests for information from law
1523 enforcement and government agencies.
1525 R-48470 The VNF **MUST** support Real-time detection and
1526 notification of security events.
1528 R-22286 The VNF **MUST** support Integration functionality via
1529 API/Syslog/SNMP to other functional modules in the network (e.g.,
1530 PCRF, PCEF) that enable dynamic security control by blocking the
1531 malicious traffic or malicious end users.
1533 R-32636 The VNF **MUST** support API-based monitoring to take care of
1534 the scenarios where the control interfaces are not exposed, or are
1535 optimized and proprietary in nature.
1537 R-61648 The VNF **MUST** support event logging, formats, and delivery
1538 tools to provide the required degree of event data to ONAP.
1540 R-22367 The VNF **MUST** support detection of malformed packets due to
1541 software misconfiguration or software vulnerability.
1543 R-31961 The VNF **MUST** support integrated DPI/monitoring functionality
1544 as part of VNFs (e.g., PGW, MME).
1546 R-20912 The VNF **MUST** support alternative monitoring capabilities
1547 when VNFs do not expose data or control traffic or use proprietary and
1548 optimized protocols for inter VNF communication.
1550 R-73223 The VNF **MUST** support proactive monitoring to detect and
1551 report the attacks on resources so that the VNFs and associated VMs can
1552 be isolated, such as detection techniques for resource exhaustion, namely
1553 OS resource attacks, CPU attacks, consumption of kernel memory, local
1556 R-58370 The VNF **MUST** coexist and operate normally with commercial
1557 anti-virus software which shall produce alarms every time when there is a
1560 R-56920 The VNF **MUST** protect all security audit logs (including
1561 API, OS and application-generated logs), security audit software, data,
1562 and associated documentation from modification, or unauthorized viewing,
1563 by standard OS access control mechanisms, by sending to a remote system,
1566 R-54520 The VNF **MUST** log successful and unsuccessful login attempts.
1568 R-55478 The VNF **MUST** log logoffs.
1570 R-08598 The VNF **MUST** log successful and unsuccessful changes to
1573 R-13344 The VNF **MUST** log starting and stopping of security
1576 R-07617 The VNF **MUST** log creating, removing, or changing the
1577 inherent privilege level of users.
1579 R-94525 The VNF **MUST** log connections to a network listener of the
1582 R-31614 The VNF **MUST** log the field “event type” in the security
1585 R-97445 The VNF **MUST** log the field “date/time” in the security
1588 R-25547 The VNF **MUST** log the field “protocol” in the security audit logs.
1590 R-06413 The VNF **MUST** log the field “service or program used for
1591 access” in the security audit logs.
1593 R-15325 The VNF **MUST** log the field “success/failure” in the
1594 security audit logs.
1596 R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs.
1598 R-04982 The VNF **MUST NOT** include an authentication credential,
1599 e.g., password, in the security audit logs, even if encrypted.
1601 R-63330 The VNF **MUST** detect when the security audit log storage
1602 medium is approaching capacity (configurable) and issue an alarm via
1603 SMS or equivalent as to allow time for proper actions to be taken to
1604 pre-empt loss of audit data.
1606 R-41252 The VNF **MUST** support the capability of online storage of
1607 security audit logs.
1609 R-41825 The VNF **MUST** activate security alarms automatically when
1610 the following event is detected: configurable number of consecutive
1611 unsuccessful login attempts
1613 R-43332 The VNF **MUST** activate security alarms automatically when
1614 the following event is detected: successful modification of critical
1615 system or application files
1617 R-74958 The VNF **MUST** activate security alarms automatically when
1618 the following event is detected: unsuccessful attempts to gain permissions
1619 or assume the identity of another user
1621 R-15884 The VNF **MUST** include the field “date” in the Security alarms
1622 (where applicable and technically feasible).
1624 R-23957 The VNF **MUST** include the field “time” in the Security alarms
1625 (where applicable and technically feasible).
1627 R-71842 The VNF **MUST** include the field “service or program used for
1628 access” in the Security alarms (where applicable and technically feasible).
1630 R-57617 The VNF **MUST** include the field “success/failure” in the
1631 Security alarms (where applicable and technically feasible).
1633 R-99730 The VNF **MUST** include the field “Login ID” in the Security
1634 alarms (where applicable and technically feasible).
1636 R-29705 The VNF **MUST** restrict changing the criticality level of a
1637 system security alarm to administrator(s).
1639 R-13627 The VNF **MUST** monitor API invocation patterns to detect
1640 anomalous access patterns that may represent fraudulent access or other
1641 types of attacks, or integrate with tools that implement anomaly and
1644 R-21819 The VNF **MUST** support requests for information from law
1645 enforcement and government agencies.
1647 R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation
1648 (without human intervention) for Known Threats with detection rate in low
1651 R-25094 The VNF **MUST** perform data capture for security functions.
1653 R-04492 The VNF **MUST** generate security audit logs that must be sent
1654 to Security Analytics Tools for analysis.
1656 R-19219 The VNF **MUST** provide audit logs that include user ID, dates,
1657 times for log-on and log-off, and terminal location at minimum.
1659 R-30932 The VNF **MUST** provide security audit logs including records
1660 of successful and rejected system access data and other resource access
1663 R-54816 The VNF **MUST** support the storage of security audit logs
1664 for agreed period of time for forensic analysis.
1666 R-57271 The VNF **MUST** provide the capability of generating security
1667 audit logs by interacting with the operating system (OS) as appropriate.
1669 R-84160 The VNF **MUST** have security logging for VNFs and their
1670 OSs be active from initialization. Audit logging includes automatic
1671 routines to maintain activity records and cleanup programs to ensure
1672 the integrity of the audit/logging systems.
1674 R-58964 The VNF **MUST** provide the capability to restrict read
1675 and write access to data.
1677 R-99112 The VNF **MUST** provide the capability to restrict access
1678 to data to specific users.
1680 R-83227 The VNF **MUST** Provide the capability to encrypt data in
1681 transit on a physical or virtual network.
1683 R-32641 The VNF **MUST** provide the capability to encrypt data on
1684 non-volatile memory.
1686 R-13151 The VNF **SHOULD** disable the paging of the data requiring
1687 encryption, if possible, where the encryption of non-transient data is
1688 required on a device for which the operating system performs paging to
1689 virtual memory. If not possible to disable the paging of the data
1690 requiring encryption, the virtual memory should be encrypted.
1692 R-93860 The VNF **MUST** provide the capability to integrate with an
1693 external encryption service.
1695 R-73067 The VNF **MUST** use industry standard cryptographic algorithms
1696 and standard modes of operations when implementing cryptography.
1698 R-22645 The VNF **SHOULD** use commercial algorithms only when there
1699 are no applicable governmental standards for specific cryptographic
1700 functions, e.g., public key cryptography, message digests.
1702 R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and
1703 Skipjack algorithms or other compromised encryption.
1705 R-02170 The VNF **MUST** use, whenever possible, standard implementations
1706 of security applications, protocols, and format, e.g., S/MIME, TLS, SSH,
1707 IPSec, X.509 digital certificates for cryptographic implementations.
1708 These implementations must be purchased from reputable vendors and must
1709 not be developed in-house.
1711 R-70933 The VNF **MUST** provide the ability to migrate to newer
1712 versions of cryptographic algorithms and protocols with no impact.
1714 R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length.
1716 R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length.
1718 R-95864 The VNF **MUST** use commercial tools that comply with X.509
1719 standards and produce x.509 compliant keys for public/private key generation.
1721 R-12110 The VNF **MUST NOT** use keys generated or derived from
1722 predictable functions or values, e.g., values considered predictable
1723 include user identity information, time of day, stored/transmitted data.
1725 R-52060 The VNF **MUST** provide the capability to configure encryption
1726 algorithms or devices so that they comply with the laws of the jurisdiction
1727 in which there are plans to use data encryption.
1729 R-69610 The VNF **MUST** provide the capability of using certificates
1730 issued from a Certificate Authority not provided by the VNF provider.
1732 R-83500 The VNF **MUST** provide the capability of allowing certificate
1733 renewal and revocation.
1735 R-29977 The VNF **MUST** provide the capability of testing the validity
1736 of a digital certificate by validating the CA signature on the certificate.
1738 R-24359 The VNF **MUST** provide the capability of testing the validity
1739 of a digital certificate by validating the date the certificate is being
1740 used is within the validity period for the certificate.
1742 R-39604 The VNF **MUST** provide the capability of testing the
1743 validity of a digital certificate by checking the Certificate Revocation
1744 List (CRL) for the certificates of that type to ensure that the
1745 certificate has not been revoked.
1747 R-75343 The VNF **MUST** provide the capability of testing the
1748 validity of a digital certificate by recognizing the identity represented
1749 by the certificate — the "distinguished name".
1754 R-37028 The VNF **MUST** be composed of one “base” module.
1756 R-41215 The VNF **MAY** have zero to many “incremental” modules.
1758 R-20974 The VNF **MUST** deploy the base module first, prior to
1759 the incremental modules.
1761 R-11200 The VNF **MUST** keep the scope of a Cinder volume module,
1762 when it exists, to be 1:1 with the VNF Base Module or Incremental Module.
1764 R-38474 The VNF **MUST** have a corresponding environment file for
1767 R-81725 The VNF **MUST** have a corresponding environment file for
1768 an Incremental Module.
1770 R-53433 The VNF **MUST** have a corresponding environment file for
1771 a Cinder Volume Module.
1776 R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU
1777 architectures and families, virtual machines, etc.
1779 R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud
1780 (such as hardware, host OS, Hypervisor or container technology) and must run
1781 on the Network Cloud with acknowledgement to the paradigm that the Network
1782 Cloud will continue to rapidly evolve and the underlying components of
1783 the platform will change regularly.
1785 R-33846 The VNF **MUST** install the NCSP required software on Guest OS
1786 images when not using the NCSP provided Guest OS images. [5]_
1788 R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [5]_
1790 R-02997 The VNF **MUST** preserve their persistent data. Running VMs
1791 will not be backed up in the Network Cloud infrastructure.
1793 R-29760 The VNFC **MUST** be installed on non-root file systems,
1794 unless software is specifically included with the operating system
1795 distribution of the guest image.
1797 R-20860 The VNF **MUST** be agnostic to the underlying infrastructure
1798 (such as hardware, host OS, Hypervisor), any requirements should be
1799 provided as specification to be fulfilled by any hardware.
1801 R-89800 The VNF **MUST NOT** require Hypervisor-level customization
1802 from the cloud provider.
1804 R-86758 The VNF **SHOULD** provide an automated test suite to validate
1805 every new version of the software on the target environment(s). The tests
1806 should be of sufficient granularity to independently test various
1807 representative VNF use cases throughout its lifecycle. Operations might
1808 choose to invoke these tests either on a scheduled basis or on demand to
1809 support various operations functions including test, turn-up and
1812 R-39650 The VNF **SHOULD** provide the ability to test incremental
1815 R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command
1816 against a specific VNFC, moving all existing session elsewhere with
1817 minimal disruption if a VNF provides a load balancing function across
1818 multiple instances of its VNFCs. Note: Individual VNF performance
1819 aspects (e.g., move duration or disruption scope) may require further
1822 R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against
1823 a specific VNFC, preventing new session from reaching the targeted VNFC,
1824 with no disruption to active sessions on the impacted VNFC, if a VNF
1825 provides a load balancing function across multiple instances of its VNFCs.
1826 This is used to support scenarios such as proactive maintenance with no
1829 R-64713 The VNF **SHOULD** support a software promotion methodology
1830 from dev/test -> pre-prod -> production in software, development &
1831 testing and operations.
1833 **VNF Modeling Requirements**
1834 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1839 R-43125 The VNF Heat **MUST** indent properties and lists with 1 or
1842 R-67888 The VNF Heat **MUST** contain the following
1845 - heat\_template\_version:
1850 R-39402 The VNF Heat **MUST** contain the description section.
1852 R-35414 The VNF Heat **MUST** contain the parameter section.
1854 R-90279 The VNF Heat **MUST** use in a resource all parameters declared in
1855 a template except for the parameters for the OS::Nova::Server property
1856 availability\_zone. See Property: availability\_zone. for more details on
1859 R-28657 The VNF Heat **MUST** provide the attribute 'type' on
1860 parameters per the OpenStack Heat Orchestration Template standard.
1862 R-44001 The VNF Heat **MUST** provide the attribute 'description'
1863 on parameters. (Note that this attribute is OpenStack optional.)
1865 R-90526 The VNF Heat **MUST NOT** use the attribute 'default'.
1866 If a parameter has a default value, it must be provided in
1867 the environment file. (Note that this attribute is OpenStack
1870 R-88863 The VNF Heat **MUST** have a constraint of range or
1871 allowed\_values for a parameter type 'number'.
1873 - range: The range constraint applies to parameters of type number.
1874 It defines a lower and upper limit for the numeric value of the
1875 parameter. The syntax of the range constraint is
1877 R-23664 The VNF Heat **MUST** have a resources: section with the
1878 declaration of at least one resource.
1880 R-16447 The VNF Heat **MUST** have unique resource IDs across all Heat
1881 Orchestration Templates that compose the VNF. This requirement
1882 also applies when a VNF is composed of more than one Heat
1883 Orchestration Template (see ONAP VNF Modularity Overview).
1885 R-97199 The VNF Heat **MUST** use the metadata property for
1886 OS::Nova::Server resource type.
1888 R-03324 The VNF Heat **MUST** contain the following sections in the
1893 R-19473 The VNF Heat **MUST** include “base” in the filename for the
1896 R-81339 The VNF Heat **MUST** match one of the following options for
1897 the base module file name:
1899 - base\_<text>.y[a]ml
1900 - <text>\_base.y[a]ml
1902 - <text>\_base\_<text>.y[a]ml
1904 R-91342 The VNF Heat **MUST** name the base module’s corresponding
1905 environment file to be identical to the base module with “.y[a]ml”
1906 replaced with “.env”.
1908 R-87247 The VNF Heat **MUST NOT** use any special characters or the
1909 word “base” in the name of the incremental module.
1913 R-94509 The VNF Heat **MUST** name the incremental module’s
1914 corresponding environment file to be identical to the incremental
1915 module with “.y[a]ml” replaced with “.env”.
1917 R-82732 The VNF Heat **MUST** name the Cinder volume module file name
1918 to be the same as the corresponding module it is supporting (base
1919 module or incremental module) with “\_volume” appended.
1921 - <base module name>\_volume.y[a]ml
1922 - <incremental module name>\_volume.y[a]ml
1924 R-31141 The VNF Heat **MUST** name the volume module’s corresponding
1925 environment file to be identical to the volume module with “.y[a]ml”
1926 replaced with “.env”.
1928 R-76057 The VNF Heat **MUST NOT** use special characters
1929 or the word “base” in the file name for the nested template.
1931 R-18224 The VNF Heat **MUST** pass in as properties all parameter values
1932 associated with the nested heat file in the resource definition defined
1933 in the parent heat template.
1935 R-07443 The VNF Heat **MUST** match the Output parameter name and type with
1936 the input parameter name and type unless the Output parameter is of the
1937 type comma\_delimited\_list.
1939 R-23983 The VNF **MUST** pass the external networks into the VNF Heat
1940 Orchestration Templates as parameters.
1942 - Neutron Network-id (UUID)
1943 - Neutron Network subnet ID (UUID)
1944 - Contrail Network Fully Qualified Domain Name (FQDN)
1946 R-63345 The VNF Heat **MUST** pass the appropriate external
1947 network IDs into nested VM templates when nested Heat is used.
1949 R-35666 The VNF Heat **MUST** include the resource(s) to
1950 create the internal network. The internal network must be either a
1951 Neutron Network or a Contrail Network.
1953 R-86972 The VNF Heat **MUST** create internal networks in the Base
1954 Module, in the modular approach, with their resource IDs exposed as outputs
1955 (i.e., ONAP Base Module Output Parameters) for use by all incremental
1956 modules. If the Network resource ID is required in the base template,
1957 then a get\_resource must be used.
1959 R-68936 The VNF Heat **SHOULD** assign a unique
1960 {network-role} in the context of the VNF, when the internal network is
1961 created. ONAP Resource ID and Parameter Naming Convention provides
1964 R-01455 The VNF Heat **MUST** assign a VNF unique
1965 {vm-type} for each Virtual Machine type (i.e., OS::Nova::Server)
1966 instantiated in the VNF. While the {vm-type} must be unique to the VNF,
1967 it does not have to be globally unique across all VNFs that ONAP
1970 R-82481 The VNF Heat **MUST** include {vm-type} as part of the parameter name
1971 for any parameter that is associated with a unique Virtual Machine type.
1973 R-66729 The VNF Heat **MUST** include {vm-type} as part of the resource ID
1974 for any resource ID that is associated with a unique Virtual Machine type in
1977 R-32394 The VNF Heat **MUST** use the same case for {vm-type} for all
1978 parameter names in the VNF.
1980 R-46839 The VNF Heat **MUST** use the same case for {vm-type} for all
1981 Resource IDs in the VNF.
1983 R-05008 The VNF Heat **MUST NOT** be prefixed with a common
1984 {vm-type} identifier for the six ONAP Metadata parameters.
1985 They are *vnf\_name*, *vnf\_id*, *vf\_module\_id*, *vf\_module\_name*,
1986 *vm\_role*. The ONAP Metadata parameters are described in
1987 Resource: OS::Nova::Server – Metadata Parameters.
1989 R-15422 The VNF Heat **MUST NOT** be prefixed with a common {vm-type}
1990 identifier the parameter referring to the OS::Nova::Server property
1991 availability\_zone. availability\_zone is described in
1992 Property: availability_zone.
1994 R-21330 The VNF Heat **MUST** include the {network-role} as part of the
1995 parameter name for any parameter that is associated with an external network.
1997 R-11168 The VNF Heat **MUST** include the {network-role} as part of the
1998 resource ID for any resource ID that is associated with an external network
2001 R-84322 The VNF Heat **MUST** include int\_{network-role} as part of the
2002 parameter name for any parameter that is associated with an internal network.
2004 R-96983 The VNF Heat **MUST** include int\_{network-role} as part of the
2005 resource ID for any resource ID that is associated with an internal network.
2007 R-58424 The VNF Heat **MUST** use the same case for {network-role} for
2008 all parameter names in the VNF.
2010 R-21511 The VNF Heat **MUST** use the same case for {network-role} for
2011 all Resource IDs in the VNF.
2013 R-59629 The VNF Heat **MUST** have unique resource IDs within the
2014 resources section of a Heat Orchestration Template. This is an
2015 OpenStack Requirement.
2017 R-43319 The VNF Heat **MUST** have unique resource IDs
2018 across all modules that compose the VNF,
2019 when a VNF is composed of more than one Heat Orchestration Template
2022 R-54517 The VNF Heat **MUST** include {vm-type} in the resource ID
2023 when a resource is associated with a single {vm-type}.
2025 R-96482 The VNF Heat **MUST** include {network-role} in the resource ID
2026 when a resource is associated with a single external network.
2028 R-98138 The VNF Heat **MUST** include int\_{network-role} in the resource ID
2029 when a resource is associated with a single internal network.
2031 R-82115 The VNF Heat **MUST** include both the {vm-type} and
2032 {network-role} in the resource ID,
2033 when a resource is associated with a single {vm-type} and a single
2036 - The {vm-type} must appear before the {network-role} and must be
2037 separated by an underscore (i.e., {vm-type}\_{network-role}).
2038 - Note that an {index} value may separate the {vm-type} and the
2039 {network-role}. An underscore will separate the three values (i.e.,
2040 {vm-type}\_{index}\_{network-role}).
2042 R-82551 The VNF Heat **MUST** include both the {vm-type} and
2043 int\_{network-role} in the resource ID,
2044 when a resource is associated with a single {vm-type} and a single
2047 - The {vm-type} must appear before the int\_{network-role} and must be
2048 separated by an underscore (i.e., {vm-type}\_int\_{network-role}).
2049 - Note that an {index} value may separate the {vm-type} and the
2050 int\_{network-role}. An underscore will separate the three values
2051 (i.e., {vm-type}\_{index}\_int\_{network-role}).
2053 R-69287 The VNF Heat **MUST** use only alphanumeric characters and “\_”
2054 underscores in the resource ID. Special characters must not be used.
2056 R-71152 The VNF Heat **MUST** declare as type: string the parameter
2059 R-91125 The VNF Heat **MUST** enumerate the parameter for property
2060 image in the Heat Orchestration Template environment file.
2062 R-57282 The VNF Heat **MUST** have a separate parameter for image for
2063 Each VM type (i.e., {vm-type}) even if more than one {vm-type} shares
2064 the same image. This provides maximum clarity and flexibility.
2066 R-50436 The VNF Heat **MUST** declare the parameter property for
2067 flavor as type: string.
2069 R-69431 The VNF Heat **MUST** enumerate the parameter for property
2070 flavor in the Heat Orchestration Template environment file.
2072 R-40499 The VNF Heat **MUST** have a separate parameter for flavor for each
2073 VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same
2074 flavor. This provides maximum clarity and flexibility.
2076 R-22838 The VNF Heat **MUST NOT** enumerate the parameter for property name
2077 in the environment file.
2079 R-51430 The VNF Heat **MUST** declare the parameter for property name as
2080 type: string or type: comma\_delimited\_list
2082 R-98450 The VNF Heat **MUST** name the parameter availability\_zone\_{index}
2083 in the Heat Orchestration Template.
2085 R-13561 The VNF Heat **MUST** start the {index} at zero.
2087 R-60204 The VNF Heat **MUST** increment the {index} by one.
2089 R-36887 The VNF Heat **MUST NOT** include the {vm-type} in the parameter name.
2091 R-17020 The VNF Heat **MUST** include the following three mandatory
2092 metadata parameters for an OS::Nova::Server resource:
2098 R-55218 The VNF Heat **MUST NOT** have parameter constraints defined
2099 for the OS::Nova::Server metadata parameter vnf\_id.
2101 R-20856 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2102 metadata parameter vnf\_id in environment file.
2104 R-98374 The VNF Heat **MUST NOT** have parameter constraints
2105 defined for the OS::Nova::Server metadata parameter vf\_module\_id.
2107 R-72871 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2108 metadata parameter vf\_module\_id in environment file.
2110 R-44318 The VNF Heat **MUST NOT** have parameter constraints defined
2111 for the OS::Nova::Server metadata parameter vnf\_name.
2113 R-36542 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2114 metadata parameter vnf\_name in the environment file.
2116 R-72050 The VNF Heat **MUST** contain {network-role} in the parameter name
2118 R-57576 The VNF Heat **MUST** contain int\_{network-role}
2119 in the parameter name.
2121 R-93272 The VNF Heat **MUST** adhere to the following parameter naming
2122 convention in the Heat Orchestration Template, when the parameter
2123 associated with the property network is referencing an “external” network:
2125 - {network-role}\_net\_id for the Neutron network ID
2126 - {network-role}\_net\_name for the network name in OpenStack
2128 R-65373 The VNF Heat **MUST** adhere to the following parameter naming
2129 convention, when the parameter associated with the property network is
2130 referencing an “internal” network:
2132 - int\_{network-role}\_net\_id for the Neutron network ID
2133 - int\_{network-role}\_net\_name for the network name in OpenStack
2135 R-47716 The VNF Heat **MUST** adhere to the following parameter naming
2136 convention for the property fixed\_ips and Map Property subnet\_id
2137 parameter, when the parameter is referencing a subnet of an
2140 - {network-role}\_subnet\_id if the subnet is an IPv4 subnet
2141 - {network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
2143 R-20106 The VNF Heat **MUST** adhere to the following naming convention for
2144 the property fixed\_ips and Map Property subnet\_id parameter,
2145 when the parameter is referencing the subnet of an “internal” network:
2147 - int\_{network-role}\_subnet\_id if the subnet is an IPv4 subnet
2148 - int\_{network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
2150 R-41177 The VNF Heat **MUST** include {vm-type} and {network-role}
2151 in the parameter name, when a SDN-C IP assignment is made to a
2152 port connected to an external network.
2154 R-84898 The VNF Heat **MUST** adhere to the following naming convention,
2155 when the parameter for property fixed\_ips and Map Property ip\_address
2156 is declared type: comma\_delimited\_list:
2158 - {vm-type}\_{network-role}\_ips for IPv4 address
2159 - {vm-type}\_{network-role}\_v6\_ips for IPv6 address
2161 R-34960 The VNF Heat **MUST** adhere to the following
2163 when the parameter for property fixed\_ips and Map Property ip\_address
2164 is declared type: string:
2166 - {vm-type}\_{network-role}\_ip\_{index} for an IPv4 address
2167 - {vm-type}\_{network-role}\_v6\_ip\_{index} for an IPv6 address
2169 R-62584 The VNF Heat **MUST** adhere to
2170 the following naming convention,
2171 when the parameter for property fixed\_ips and Map Property ip\_address
2172 is declared type: comma\_delimited\_list:
2174 - {vm-type}\_int\_{network-role}\_ips for IPv4 address
2175 - {vm-type}\_int\_{network-role}\_v6\_ips for IPv6 address
2177 R-29256 The VNF Heat **MUST** must adhere to the following
2179 when the parameter for property fixed\_ips and Map Property ip\_address
2180 is declared type: string:
2182 - {vm-type}\_int\_{network-role}\_ip\_{index} for an IPv4 address
2183 - {vm-type}\_int\_{network-role}\_v6\_ip\_{index} for an IPv6 address
2185 R-61282 The VNF Heat **MUST**
2186 adhere to the following naming convention for the property
2187 allowed\_address\_pairs and Map Property ip\_address parameter,
2188 when the parameter is referencing an “external” network:
2190 - {vm-type}\_{network-role}\_floating\_ip for an IPv4 address
2191 - {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address
2193 R-16805 The VNF Heat **MUST** adhere to the following naming convention
2194 for the property allowed\_address\_pairs and Map Property ip\_address
2195 parameter when the parameter is referencing an “internal” network.
2197 - {vm-type}\_int\_{network-role}\_floating\_ip for an IPv4 address
2198 - {vm-type}\_int\_{network-role}\_floating\_v6\_ip for an IPv6 address
2200 R-85734 The VNF Heat **MUST** use the intrinsic function str\_replace
2201 in conjunction with the ONAP supplied metadata parameter
2202 vnf\_name to generate a unique value,
2203 when the property name for a non OS::Nova::Server resources is defined
2204 in a Heat Orchestration Template.
2206 R-47788 The VNF Heat **MUST** have a 1:1 scope of a cinder volume module,
2207 when it exists, with the Base Module or Incremental Module
2209 R-79531 The VNF Heat **MUST** define “outputs” in the volume
2210 template for each Cinder volume resource universally unique
2211 identifier (UUID) (i.e. ONAP Volume Template Output Parameters).
2213 R-86285 The VNF Heat **MUST** have a
2214 corresponding environment file, even if no parameters are required to be
2217 R-67205 The VNF Heat **MUST** have a corresponding
2218 environment file for a Base Module.
2220 R-35727 The VNF Heat **MUST** have a
2221 corresponding environment file for an Incremental module.
2223 R-22656 The VNF Heat **MUST** have a corresponding environment file
2224 for a Cinder Volume Module.
2226 R-89868 The VNF Heat **MUST** have unique file names within the scope
2227 of the VNF for a nested heat yaml file.
2229 R-52530 The VNF Heat **MUST NOT** use a directory hierarchy for
2230 nested templates. All templates must be in a single, flat directory
2233 R-11041 The VNF Heat **MUST** have the resource calling the
2234 nested yaml file pass in as properties all parameters defined
2235 in nested yaml file.
2237 R-61183 The VNF Heat **MUST NOT** change the parameter names, when
2238 OS::Nova::Server metadata parameters are past into a nested heat template.
2240 R-76718 The VNF Heat **MUST** reference the get\_files targets in
2241 Heat templates by file name, and the corresponding files should be
2242 delivered to ONAP along with the Heat templates.
2244 R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval.
2246 R-62177 The VNF Heat **MUST** have unique file names for the included
2247 files within the scope of the VNF.
2249 R-87848 The VNF Heat **MUST** have all included files in a single, flat
2250 directory per VNF. ONAP does not support a directory hierarchy.
2252 - Included files may be used by all Modules within a given VNF.
2253 - get\_file directives may be used in both non-nested and nested
2256 **ONAP Management Requirements**
2257 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2260 VNF On-boarding and package management
2261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2264 R-77707 The xNF provider **MUST** include a Manifest File that
2265 contains a list of all the components in the xNF package.
2267 R-66070 The xNF Package **MUST** include xNF Identification Data to
2268 uniquely identify the resource for a given xNF provider. The identification
2269 data must include: an identifier for the xNF, the name of the xNF as was
2270 given by the xNF provider, xNF description, xNF provider, and version.
2272 R-69565 The xNF Package **MUST** include documentation describing xNF
2273 Management APIs, which must include information and tools for ONAP to
2274 deploy and configure (initially and ongoing) the xNF application(s)
2275 (e.g., NETCONF APIs) which includes a description of configurable
2276 parameters for the xNF and whether the parameters can be configured
2277 after xNF instantiation.
2279 R-00156 The xNF Package **MUST** include documentation describing xNF
2280 Management APIs, which must include information and tools for ONAP
2281 to monitor the health of the xNF (conditions that require healing
2282 and/or scaling responses).
2284 R-00068 The xNF Package **MUST** include documentation which includes
2285 a description of parameters that can be monitored for the xNF and
2286 event records (status, fault, flow, session, call, control plane,
2287 etc.) generated by the xNF after instantiation.
2289 R-12678 The xNF Package **MUST** include documentation which includes a
2290 description of runtime lifecycle events and related actions (e.g.,
2291 control responses, tests) which can be performed for the xNF.
2293 R-84366 The xNF Package **MUST** include documentation describing
2294 xNF Functional APIs that are utilized to build network and
2295 application services. This document describes the externally exposed
2296 functional inputs and outputs for the xNF, including interface
2297 format and protocols supported.
2299 R-36280 The xNF provider **MUST** provide documentation describing
2300 xNF Functional Capabilities that are utilized to operationalize the
2301 xNF and compose complex services.
2303 R-98617 The xNF provider **MUST** provide information regarding any
2304 dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
2306 R-89571 The xNF **MUST** support and provide artifacts for configuration
2307 management using at least one of the following technologies;
2308 a) Netconf/YANG, b) Chef, or c) Ansible.
2310 R-30278 The xNF provider **MUST** provide a Resource/Device YANG model
2311 as a foundation for creating the YANG model for configuration. This will
2312 include xNF attributes/parameters and valid values/attributes configurable
2315 R-13390 The xNF provider **MUST** provide cookbooks to be loaded
2316 on the appropriate Chef Server.
2318 R-18525 The xNF provider **MUST** provide a JSON file for each
2319 supported action for the xNF. The JSON file must contain key value
2320 pairs with all relevant values populated with sample data that illustrates
2321 its usage. The fields and their description are defined in Tables A1 and A2 in the Appendix.
2323 R-75608 The xNF provider **MUST** provide playbooks to be loaded
2324 on the appropriate Ansible Server.
2326 R-16777 The xNF provider **MUST** provide a JSON file for each
2327 supported action for the xNF. The JSON file must contain key value
2328 pairs with all relevant values populated with sample data that illustrates
2329 its usage. The fields and their description are defined in Table B1 in the Appendix.
2331 R-46567 The xNF Package **MUST** include configuration scripts
2332 for boot sequence and configuration.
2334 R-16065 The xNF provider **MUST** provide configurable parameters
2335 (if unable to conform to YANG model) including xNF attributes/parameters
2336 and valid values, dynamic attributes and cross parameter dependencies
2337 (e.g., customer provisioning data).
2339 R-22888 The xNF provider **MUST** provide documentation for the xNF
2340 Policy Description to manage the xNF runtime lifecycle. The document
2341 must include a description of how the policies (conditions and actions)
2342 are implemented in the xNF.
2344 R-01556 The xNF Package **MUST** include documentation describing the
2345 fault, performance, capacity events/alarms and other event records
2346 that are made available by the xNF.
2348 R-16875 The xNF Package **MUST** include documentation which must include
2349 a unique identification string for the specific xNF, a description of
2350 the problem that caused the error, and steps or procedures to perform
2351 Root Cause Analysis and resolve the issue.
2353 R-35960 The xNF Package **MUST** include documentation which must include
2354 all events, severity level (e.g., informational, warning, error) and
2355 descriptions including causes/fixes if applicable for the event.
2357 R-42018 The xNF Package **MUST** include documentation which must include
2358 all events (fault, measurement for xNF Scaling, Syslogs, State Change
2359 and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF.
2361 R-27711 The xNF provider **MUST** provide an XML file that contains a
2362 list of xNF error codes, descriptions of the error, and possible
2363 causes/corrective action.
2365 R-01478 The xNF Package **MUST** include documentation describing all
2366 parameters that are available to monitor the xNF after instantiation
2367 (includes all counters, OIDs, PM data, KPIs, etc.) that must be
2368 collected for reporting purposes.
2370 R-73560 The xNF Package **MUST** include documentation about monitoring
2371 parameters/counters exposed for virtual resource management and xNF
2372 application management.
2374 R-90632 The xNF Package **MUST** include documentation about KPIs and
2375 metrics that need to be collected at each VM for capacity planning
2376 and performance management purposes.
2378 R-86235 The xNF Package **MUST** include documentation about the monitoring
2379 parameters that must include latencies, success rates, retry rates, load
2380 and quality (e.g., DPM) for the key transactions/functions supported by
2381 the xNF and those that must be exercised by the xNF in order to perform
2384 R-33904 The xNF Package **MUST** include documentation for each KPI, provide
2385 lower and upper limits.
2387 R-53598 The xNF Package **MUST** include documentation to, when relevant,
2388 provide a threshold crossing alert point for each KPI and describe the
2389 significance of the threshold crossing.
2391 R-69877 The xNF Package **MUST** include documentation for each KPI,
2392 identify the suggested actions that need to be performed when a
2393 threshold crossing alert event is recorded.
2395 R-22680 The xNF Package **MUST** include documentation that describes
2396 any requirements for the monitoring component of tools for Network
2397 Cloud automation and management to provide these records to components
2400 R-33694 The xNF Package **MUST** include documentation to when applicable,
2401 provide calculators needed to convert raw data into appropriate reporting
2404 R-56815 The xNF Package **MUST** include documentation describing
2405 supported xNF scaling capabilities and capacity limits (e.g., number
2406 of users, bandwidth, throughput, concurrent calls).
2408 R-48596 The xNF Package **MUST** include documentation describing
2409 the characteristics for the xNF reliability and high availability.
2411 R-74763 The xNF provider **MUST** provide an artifact per xNF that contains
2412 all of the xNF Event Records supported. The artifact should include reference
2413 to the specific release of the xNF Event Stream Common Event Data Model
2414 document it is based on. (e.g., `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
2416 R-35851 The xNF Package **MUST** include xNF topology that describes
2417 basic network and application connectivity internal and external to the
2418 xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if
2419 applicable) for each interface.
2421 R-97102 The VNF Package **MUST** include VM requirements via a Heat
2422 template that provides the necessary data for VM specifications
2423 for all VNF components - for hypervisor, CPU, memory, storage.
2425 R-20204 The VNF Package **MUST** include VM requirements via a Heat
2426 template that provides the necessary data for network connections,
2427 interface connections, internal and external to VNF.
2429 R-44896 The VNF Package **MUST** include VM requirements via a Heat
2430 template that provides the necessary data for high availability
2433 R-55802 The VNF Package **MUST** include VM requirements via a Heat
2434 template that provides the necessary data for scaling/growth VM
2437 R-26881 The xNF provider **MUST** provide the binaries and images
2438 needed to instantiate the xNF (xNF and VNFC images).
2440 R-96634 The xNF provider **MUST** describe scaling capabilities
2441 to manage scaling characteristics of the xNF.
2443 R-43958 The xNF Package **MUST** include documentation describing
2444 the tests that were conducted by the xNF providor and the test results.
2446 R-04298 The xNF provider **MUST** provide their testing scripts to
2449 R-58775 The xNF provider **MUST** provide software components that
2450 can be packaged with/near the xNF, if needed, to simulate any functions
2451 or systems that connect to the xNF system under test. This component is
2452 necessary only if the existing testing environment does not have the
2453 necessary simulators.
2455 R-85653 The xNF **MUST** provide metrics (e.g., number of sessions,
2456 number of subscribers, number of seats, etc.) to ONAP for tracking
2459 R-44125 The xNF provider **MUST** agree to the process that can
2460 be met by Service Provider reporting infrastructure. The Contract
2461 shall define the reporting process and the available reporting tools.
2463 R-40827 The xNF provider **MUST** enumerate all of the open
2464 source licenses their xNF(s) incorporate.
2466 R-97293 The xNF provider **MUST NOT** require audits of
2467 Service Provider’s business.
2469 R-44569 The xNF provider **MUST NOT** require additional
2470 infrastructure such as a xNF provider license server for xNF provider
2471 functions and metrics.
2473 R-13613 The VNF **MUST** provide clear measurements for licensing
2474 purposes to allow automated scale up/down by the management system.
2476 R-27511 The VNF provider **MUST** provide the ability to scale
2477 up a VNF provider supplied product during growth and scale down a
2478 VNF provider supplied product during decline without “real-time”
2479 restrictions based upon VNF provider permissions.
2481 R-85991 The xNF provider **MUST** provide a universal license key
2482 per xNF to be used as needed by services (i.e., not tied to a VM
2483 instance) as the recommended solution. The xNF provider may provide
2484 pools of Unique xNF License Keys, where there is a unique key for
2485 each xNF instance as an alternate solution. Licensing issues should
2486 be resolved without interrupting in-service xNFs.
2488 R-47849 The xNF provider **MUST** support the metadata about
2489 licenses (and their applicable entitlements) as defined in this
2490 document for xNF software, and any license keys required to authorize
2491 use of the xNF software. This metadata will be used to facilitate
2492 onboarding the xNF into the ONAP environment and automating processes
2493 for putting the licenses into use and managing the full lifecycle of
2494 the licenses. The details of this license model are described in
2495 Tables C1 to C8 in the Appendix. Note: License metadata support in
2496 ONAP is not currently available and planned for 1Q 2018.
2498 Configuration Management
2499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2501 R-20741 The xNF **MUST** support ONAP Controller’s **Configure** command.
2503 R-19366 The xNF **MUST** support ONAP Controller’s **ConfigModify** command.
2505 R-32981 The xNF **MUST** support ONAP Controller’s **ConfigBackup** command.
2507 R-48247 The xNF **MUST** support ONAP Controller’s **ConfigRestore** command.
2509 R-94084 The xNF **MUST** support ONAP Controller’s **ConfigScaleOut**
2512 R-56385 The xNF **MUST** support ONAP Controller’s **Audit** command.
2514 R-12706 The xNF **MUST** support ONAP Controller’s **QuiesceTraffic**
2517 R-07251 The xNF **MUST** support ONAP Controller’s **ResumeTraffic**
2520 R-83146 The xNF **MUST** support ONAP Controller’s **StopApplication**
2523 R-82811 The xNF **MUST** support ONAP Controller’s **StartApplication**
2526 R-19922 The xNF **MUST** support ONAP Controller’s **UpgradePrecheck**
2529 R-49466 The xNF **MUST** support ONAP Controller’s **UpgradeSoftware**
2532 R-45856 The xNF **MUST** support ONAP Controller’s **UpgradePostCheck**
2535 R-97343 The xNF **MUST** support ONAP Controller’s **UpgradeBackup**
2538 R-65641 The xNF **MUST** support ONAP Controller’s **UpgradeBackOut**
2541 R-11790 The VNF **MUST** support ONAP Controller’s
2542 **Restart (stop/start or reboot)** command.
2544 R-56218 The VNF **MUST** support ONAP Controller’s Migrate command that
2545 moves container (VM) from a live Physical Server / Compute Node to
2546 another live Physical Server / Compute Node.
2548 R-38001 The VNF MUST support ONAP Controller’s **Rebuild** command.
2550 R-76901 VNF MUST support a container rebuild mechanism based on existing
2551 image (e.g. Glance image in Openstack environment) or a snapshot.
2553 R-41430 The xNF **MUST** support ONAP Controller’s **HealthCheck**
2556 R-88026 The xNF **MUST** include a NETCONF server enabling
2557 runtime configuration and lifecycle management capabilities.
2559 R-95950 The xNF **MUST** provide a NETCONF interface fully defined
2560 by supplied YANG models for the embedded NETCONF server.
2562 R-73468 The xNF **MUST** allow the NETCONF server connection
2563 parameters to be configurable during virtual machine instantiation
2564 through Heat templates where SSH keys, usernames, passwords, SSH
2565 service and SSH port numbers are Heat template parameters.
2567 R-90007 The xNF **MUST** implement the protocol operation:
2568 **close-session()**- Gracefully close the current session.
2570 R-70496 The xNF **MUST** implement the protocol operation:
2571 **commit(confirmed, confirm-timeout)** - Commit candidate
2572 configuration datastore to the running configuration.
2574 R-18733 The xNF **MUST** implement the protocol operation:
2575 **discard-changes()** - Revert the candidate configuration
2576 datastore to the running configuration.
2578 R-44281 The xNF **MUST** implement the protocol operation:
2579 **edit-config(target, default-operation, test-option, error-option,
2580 config)** - Edit the target configuration datastore by merging,
2581 replacing, creating, or deleting new config elements.
2583 R-60106 The xNF **MUST** implement the protocol operation:
2584 **get(filter)** - Retrieve (a filtered subset of) the running
2585 configuration and device state information. This should include
2586 the list of xNF supported schemas.
2588 R-29488 The xNF **MUST** implement the protocol operation:
2589 **get-config(source, filter)** - Retrieve a (filtered subset of
2590 a) configuration from the configuration datastore source.
2592 R-11235 The xNF **MUST** implement the protocol operation:
2593 **kill-session(session)** - Force the termination of **session**.
2595 R-02597 The xNF **MUST** implement the protocol operation:
2596 **lock(target)** - Lock the configuration datastore target.
2598 R-96554 The xNF **MUST** implement the protocol operation:
2599 **unlock(target)** - Unlock the configuration datastore target.
2601 R-29324 The xNF **SHOULD** implement the protocol operation:
2602 **copy-config(target, source) -** Copy the content of the
2603 configuration datastore source to the configuration datastore target.
2605 R-88031 The xNF **SHOULD** implement the protocol operation:
2606 **delete-config(target) -** Delete the named configuration
2609 R-97529 The xNF **SHOULD** implement the protocol operation:
2610 **get-schema(identifier, version, format) -** Retrieve the YANG schema.
2612 R-62468 The xNF **MUST** allow all configuration data to be
2613 edited through a NETCONF <edit-config> operation. Proprietary
2614 NETCONF RPCs that make configuration changes are not sufficient.
2616 R-01382 The xNF **MUST** allow the entire configuration of the
2617 xNF to be retrieved via NETCONF's <get-config> and <edit-config>,
2618 independently of whether it was configured via NETCONF or other
2621 R-28756 The xNF **MUST** support **:partial-lock** and
2622 **:partial-unlock** capabilities, defined in RFC 5717. This
2623 allows multiple independent clients to each write to a different
2624 part of the <running> configuration at the same time.
2626 R-83873 The xNF **MUST** support **:rollback-on-error** value for
2627 the <error-option> parameter to the <edit-config> operation. If any
2628 error occurs during the requested edit operation, then the target
2629 database (usually the running configuration) will be left unaffected.
2630 This provides an 'all-or-nothing' edit mode for a single <edit-config>
2633 R-68990 The xNF **MUST** support the **:startup** capability. It
2634 will allow the running configuration to be copied to this special
2635 database. It can also be locked and unlocked.
2637 R-68200 The xNF **MUST** support the **:url** value to specify
2638 protocol operation source and target parameters. The capability URI
2639 for this feature will indicate which schemes (e.g., file, https, sftp)
2640 that the server supports within a particular URL value. The 'file'
2641 scheme allows for editable local configuration databases. The other
2642 schemes allow for remote storage of configuration databases.
2644 R-20353 The xNF **MUST** implement both **:candidate** and
2645 **:writable-running** capabilities. When both **:candidate** and
2646 **:writable-running** are provided then two locks should be supported.
2648 R-11499 The xNF **MUST** fully support the XPath 1.0 specification
2649 for filtered retrieval of configuration and other database contents.
2650 The 'type' attribute within the <filter> parameter for <get> and
2651 <get-config> operations may be set to 'xpath'. The 'select' attribute
2652 (which contains the XPath expression) will also be supported by the
2653 server. A server may support partial XPath retrieval filtering, but
2654 it cannot advertise the **:xpath** capability unless the entire XPath
2655 1.0 specification is supported.
2657 R-83790 The xNF **MUST** implement the **:validate** capability
2659 R-49145 The xNF **MUST** implement **:confirmed-commit** If
2660 **:candidate** is supported.
2662 R-58358 The xNF **MUST** implement the **:with-defaults** capability
2665 R-59610 The xNF **MUST** implement the data model discovery and
2666 download as defined in [RFC6022].
2668 R-87662 The xNF **SHOULD** implement the NETCONF Event Notifications
2671 R-93443 The xNF **MUST** define all data models in YANG [RFC6020],
2672 and the mapping to NETCONF shall follow the rules defined in this RFC.
2674 R-26115 The xNF **MUST** follow the data model upgrade rules defined
2675 in [RFC6020] section 10. All deviations from section 10 rules shall
2676 be handled by a built-in automatic upgrade mechanism.
2678 R-10716 The xNF **MUST** support parallel and simultaneous
2679 configuration of separate objects within itself.
2681 R-29495 The xNF **MUST** support locking if a common object is
2682 being manipulated by two simultaneous NETCONF configuration operations
2683 on the same xNF within the context of the same writable running data
2684 store (e.g., if an interface parameter is being configured then it
2685 should be locked out for configuration by a simultaneous configuration
2686 operation on that same interface parameter).
2688 R-53015 The xNF **MUST** apply locking based on the sequence of
2689 NETCONF operations, with the first configuration operation locking
2690 out all others until completed.
2692 R-02616 The xNF **MUST** permit locking at the finest granularity
2693 if a xNF needs to lock an object for configuration to avoid blocking
2694 simultaneous configuration operations on unrelated objects (e.g., BGP
2695 configuration should not be locked out if an interface is being
2696 configured or entire Interface configuration should not be locked out
2697 if a non-overlapping parameter on the interface is being configured).
2699 R-41829 The xNF **MUST** be able to specify the granularity of the
2700 lock via a restricted or full XPath expression.
2702 R-66793 The xNF **MUST** guarantee the xNF configuration integrity
2703 for all simultaneous configuration operations (e.g., if a change is
2704 attempted to the BUM filter rate from multiple interfaces on the same
2705 EVC, then they need to be sequenced in the xNF without locking either
2706 configuration method out).
2708 R-54190 The xNF **MUST** release locks to prevent permanent lock-outs
2709 when/if a session applying the lock is terminated (e.g., SSH session
2712 R-03465 The xNF **MUST** release locks to prevent permanent lock-outs
2713 when the corresponding <partial-unlock> operation succeeds.
2715 R-63935 The xNF **MUST** release locks to prevent permanent lock-outs
2716 when a user configured timer has expired forcing the NETCONF SSH Session
2717 termination (i.e., product must expose a configuration knob for a user
2718 setting of a lock expiration timer)
2720 R-10173 The xNF **MUST** allow another NETCONF session to be able to
2721 initiate the release of the lock by killing the session owning the lock,
2722 using the <kill-session> operation to guard against hung NETCONF sessions.
2724 R-88899 The xNF **MUST** support simultaneous <commit> operations
2725 within the context of this locking requirements framework.
2727 R-07545 The xNF **MUST** support all operations, administration and
2728 management (OAM) functions available from the supplier for xNFs using
2729 the supplied YANG code and associated NETCONF servers.
2731 R-60656 The xNF **MUST** support sub tree filtering.
2733 R-80898 The xNF **MUST** support heartbeat via a <get> with null filter.
2735 R-06617 The xNF **MUST** support get-schema (ietf-netconf-monitoring)
2736 to pull YANG model over session.
2738 R-25238 The xNF PACKAGE **MUST** validated YANG code using the open
2739 source pyang [3]_ program using the following commands:
2741 R-63953 The xNF **MUST** have the echo command return a zero value
2742 otherwise the validation has failed
2744 R-26508 The xNF **MUST** support a NETCONF server that can be mounted on
2745 OpenDaylight (client) and perform the operations of: modify, update,
2746 change, rollback configurations using each configuration data element,
2747 query each state (non-configuration) data element, execute each YANG
2748 RPC, and receive data through each notification statement.
2750 R-28545 The xNF **MUST** conform its YANG model to RFC 6060,
2751 “YANG - A Data Modeling Language for the Network Configuration
2754 R-29967 The xNF **MUST** conform its YANG model to RFC 6022,
2755 “YANG module for NETCONF monitoring”.
2757 R-22700 The xNF **MUST** conform its YANG model to RFC 6470,
2758 “NETCONF Base Notifications”.
2760 R-10353 The xNF **MUST** conform its YANG model to RFC 6244,
2761 “An Architecture for Network Management Using NETCONF and YANG”.
2763 R-53317 The xNF **MUST** conform its YANG model to RFC 6087,
2764 “Guidelines for Authors and Reviewers of YANG Data Model Documents”.
2766 R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991,
2767 “Common YANG Data Types”.
2769 R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536,
2770 “NETCONF Access Control Model”.
2772 R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223,
2773 “A YANG Data Model for Interface Management”.
2775 R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223,
2776 “IANA Interface Type YANG Module”.
2778 R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277,
2779 “A YANG Data Model for IP Management”.
2781 R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317,
2782 “A YANG Data Model for System Management”.
2784 R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407,
2785 “A YANG Data Model for SNMP Configuration”.
2787 R-33946 The xNF **MUST** conform to the NETCONF RFC 4741,
2788 “NETCONF Configuration Protocol”.
2790 R-04158 The xNF **MUST** conform to the NETCONF RFC 4742,
2791 “Using the NETCONF Configuration Protocol over Secure Shell (SSH)”.
2793 R-13800 The xNF **MUST** conform to the NETCONF RFC 5277,
2794 “NETCONF Event Notification”.
2796 R-01334 The xNF **MUST** conform to the NETCONF RFC 5717,
2797 “Partial Lock Remote Procedure Call”.
2799 R-08134 The xNF **MUST** conform to the NETCONF RFC 6241,
2800 “NETCONF Configuration Protocol”.
2802 R-78282 The xNF **MUST** conform to the NETCONF RFC 6242,
2803 “Using the Network Configuration Protocol over Secure Shell”.
2805 R-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck
2806 RPC executes a xNF Provider-defined xNF HealthCheck over the scope of
2807 the entire xNF (e.g., if there are multiple VNFCs, then run a health check,
2808 as appropriate, for all VNFCs). It returns a 200 OK if the test completes.
2809 A JSON object is returned indicating state (healthy, unhealthy), scope
2810 identifier, time-stamp and one or more blocks containing info and fault
2811 information. If the xNF is unable to run the HealthCheck, return a
2812 standard http error code and message.
2814 R-79224 The xNF **MUST** have the chef-client be preloaded with
2815 validator keys and configuration to register with the designated
2816 Chef Server as part of the installation process.
2818 R-72184 The xNF **MUST** have routable FQDNs for all the endpoints
2819 (VMs) of a xNF that contain chef-clients which are used to register
2820 with the Chef Server. As part of invoking xNF actions, ONAP will
2821 trigger push jobs against FQDNs of endpoints for a xNF, if required.
2823 R-47068 The xNF **MAY** expose a single endpoint that is
2824 responsible for all functionality.
2826 R-67114 The xNF **MUST** be installed with Chef-Client >= 12.0 and
2827 Chef push jobs client >= 2.0.
2829 R-27310 The xNF Package **MUST** include all relevant Chef artifacts
2830 (roles/cookbooks/recipes) required to execute xNF actions requested by
2831 ONAP for loading on appropriate Chef Server.
2833 R-26567 The xNF Package **MUST** include a run list of
2834 roles/cookbooks/recipes, for each supported xNF action, that will
2835 perform the desired xNF action in its entirety as specified by ONAP
2836 (see Section 7.c, ONAP Controller APIs and Behavior, for list of xNF
2837 actions and requirements), when triggered by a chef-client run list
2840 R-98911 The xNF **MUST NOT** use any instance specific parameters
2841 for the xNF in roles/cookbooks/recipes invoked for a xNF action.
2843 R-37929 The xNF **MUST** accept all necessary instance specific
2844 data from the environment or node object attributes for the xNF
2845 in roles/cookbooks/recipes invoked for a xNF action.
2847 R-62170 The xNF **MUST** over-ride any default values for
2848 configurable parameters that can be set by ONAP in the roles,
2849 cookbooks and recipes.
2851 R-78116 The xNF **MUST** update status on the Chef Server
2852 appropriately (e.g., via a fail or raise an exception) if the
2853 chef-client run encounters any critical errors/failures when
2854 executing a xNF action.
2856 R-44013 The xNF **MUST** populate an attribute, defined as node
2857 [‘PushJobOutput’] with the desired output on all nodes in the push job
2858 that execute chef-client run if the xNF action requires the output of a
2859 chef-client run be made available (e.g., get running configuration).
2861 R-30654 The xNF Package **MUST** have appropriate cookbooks that are
2862 designed to automatically ‘rollback’ to the original state in case of
2863 any errors for actions that change state of the xNF (e.g., configure).
2865 R-65755 The xNF **SHOULD** support callback URLs to return information
2866 to ONAP upon completion of the chef-client run for any chef-client run
2867 associated with a xNF action.
2869 R-15885 The xNF **MUST** Upon completion of the chef-client run,
2870 POST back on the callback URL, a JSON object as described in Table
2871 A2 if the chef-client run list includes a cookbook/recipe that is
2872 callback capable. Failure to POST on the Callback Url should not be
2873 considered a critical error. That is, if the chef-client successfully
2874 completes the xNF action, it should reflect this status on the Chef
2875 Server regardless of whether the Callback succeeded or not.
2877 R-32217 The xNF **MUST** have routable FQDNs that are reachable via
2878 the Ansible Server for the endpoints (VMs) of a xNF on which playbooks
2879 will be executed. ONAP will initiate requests to the Ansible Server
2880 for invocation of playbooks against these end points [4]_.
2882 R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)
2883 of a xNF on which an Ansible playbook will be executed.
2885 R-35401 The xNF **MUST** support SSH and allow SSH access by the
2886 Ansible server for the endpoint VM(s) and comply with the Network
2887 Cloud Service Provider guidelines for authentication and access.
2889 R-82018 The xNF **MUST** load the Ansible Server SSH public key onto xNF
2890 VM(s) as part of instantiation. This will allow the Ansible Server
2891 to authenticate to perform post-instantiation configuration without
2892 manual intervention and without requiring specific xNF login IDs
2895 R-92866 The xNF **MUST** include as part of post-instantiation configuration
2896 done by Ansible Playbooks the removal/update of the SSH public key from
2897 /root/.ssh/authorized_keys, and update of SSH keys loaded through
2898 instantiation to support Ansible. This may include download and install of
2899 new SSH keys and new mechanized IDs.
2901 R-91745 The xNF **MUST** update the Ansible Server and other entities
2902 storing and using the SSH keys for authentication when the SSH keys used
2903 by Ansible are regenerated/updated.
2905 R-40293 The xNF **MUST** make available playbooks that conform
2906 to the ONAP requirement.
2908 R-49396 The xNF **MUST** support each ONAP (APPC) xNF action by invocation
2909 of **one** playbook [7]_. The playbook will be responsible
2910 for executing all necessary tasks (as well as calling other playbooks)
2911 to complete the request.
2913 R-33280 The xNF **MUST NOT** use any instance specific parameters
2916 R-48698 The xNF **MUST** utilize information from key value pairs
2917 that will be provided by the Ansible Server as "extra-vars" during
2918 invocation to execute the desired xNF action. If the playbook requires
2919 files, they must also be supplied using the methodology detailed in
2920 the Ansible Server API, unless they are bundled with playbooks, example,
2923 R-43253 The xNF **MUST** use playbooks designed to allow Ansible
2924 Server to infer failure or success based on the “PLAY_RECAP” capability.
2925 NOTE: There are cases where playbooks need to interpret results of a task
2926 and then determine success or failure and return result accordingly
2927 (failure for failed tasks).
2929 R-50252 The xNF **MUST** write to a specific one text files that
2930 will be retrieved and made available by the Ansible Server if, as part
2931 of a xNF action (e.g., audit), a playbook is required to return any
2932 xNF information. The text files must be written in the same directory as
2933 the one from which the playbook is being executed. A text file must be
2934 created for the xNF playbook run targets/affects, with the name
2935 ‘<VNFname>_results.txt’ into which any desired output from each
2936 respective VM/xNF must be written.
2938 R-51442 The xNF **SHOULD** use playbooks that are designed to
2939 automatically ‘rollback’ to the original state in case of any errors
2940 for actions that change state of the xNF (e.g., configure).
2942 R-58301 The xNF **SHOULD NOT** use playbooks that make requests to
2943 Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);
2944 therefore, there is no use for Cloud specific variables like Openstack
2945 UUIDs in Ansible Playbooks.
2947 R-02651 The xNF **SHOULD** use the Ansible backup feature to save a
2948 copy of configuration files before implementing changes to support
2949 operations such as backing out of software upgrades, configuration
2950 changes or other work as this will help backing out of configuration
2951 changes when needed.
2953 R-43353 The xNF **MUST** return control from Ansible Playbooks only
2954 after tasks are fully complete, signaling that the playbook completed
2955 all tasks. When starting services, return control only after all services
2956 are up. This is critical for workflows where the next steps are dependent
2958 R-51910 The xNF **MUST** provide all telemetry (e.g., fault event
2959 records, syslog records, performance records etc.) to ONAP using the
2960 model, format and mechanisms described in this section.
2962 R-19624 The xNF **MUST** encode and serialize content delivered to
2963 ONAP using JSON (RFC 7159) plain text format. High-volume data is to
2964 be encoded and serialized using `Avro <http://avro.apache.org/>`_,
2965 where the Avro [6]_ data format are described using JSON.
2969 - JSON plain text format is preferred for moderate volume data sets
2970 (option 1), as JSON has the advantage of having well-understood simple
2971 processing and being human-readable without additional decoding. Examples
2972 of moderate volume data sets include the fault alarms and performance
2973 alerts, heartbeat messages, measurements used for xNF scaling and syslogs.
2974 - Binary format using Avro is preferred for high volume data sets
2975 (option 2) such as mobility flow measurements and other high-volume
2976 streaming events (such as mobility signaling events or SIP signaling)
2977 or bulk data, as this will significantly reduce the volume of data
2978 to be transmitted. As of the date of this document, all events are
2979 reported using plain text JSON and REST.
2980 - Avro content is self-documented, using a JSON schema. The JSON schema is
2981 delivered along with the data content
2982 (http://avro.apache.org/docs/current/ ). This means the presence and
2983 position of data fields can be recognized automatically, as well as the
2984 data format, definition and other attributes. Avro content can be
2985 serialized as JSON tagged text or as binary. In binary format, the
2986 JSON schema is included as a separate data block, so the content is
2987 not tagged, further compressing the volume. For streaming data, Avro
2988 will read the schema when the stream is established and apply the
2989 schema to the received content.
2991 R-98191 The xNF **MUST** vary the frequency that asynchronous data is
2992 delivered based on the content and how data may be aggregated or grouped
2997 - For example, alarms and alerts are expected to be delivered as soon
2998 as they appear. In contrast, other content, such as performance
2999 measurements, KPIs or reported network signaling may have various ways
3000 of packaging and delivering content. Some content should be streamed
3001 immediately; or content may be monitored over a time interval, then packaged
3002 as collection of records and delivered as block; or data may be collected
3003 until a package of a certain size has been collected; or content may be
3004 summarized statistically over a time interval, or computed as a KPI, with
3005 the summary or KPI being delivered.
3006 - We expect the reporting frequency to be configurable depending
3007 on the virtual network function’s needs for management. For example,
3008 Service Provider may choose to vary the frequency of collection between
3009 normal and trouble-shooting scenarios.
3010 - Decisions about the frequency of data reporting will affect the
3011 size of delivered data sets, recommended delivery method, and how the
3012 data will be interpreted by ONAP. These considerations should not
3013 affect deserialization and decoding of the data, which will be guided
3014 by the accompanying JSON schema or GPB definition files.
3016 R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain
3017 text JSON for moderate sized asynchronous data sets, and for high
3018 volume data sets when feasible.
3020 R-84879 The xNF **MUST** have the capability of maintaining a primary
3021 and backup DNS name (URL) for connecting to ONAP collectors, with the
3022 ability to switch between addresses based on conditions defined by policy
3023 such as time-outs, and buffering to store messages until they can be
3024 delivered. At its discretion, the service provider may choose to populate
3025 only one collector address for a xNF. In this case, the network will
3026 promptly resolve connectivity problems caused by a collector or network
3027 failure transparently to the xNF.
3029 R-81777 The xNF **MUST** be configured with initial address(es) to use
3030 at deployment time. Subsequently, address(es) may be changed through
3031 ONAP-defined policies delivered from ONAP to the xNF using PUTs to a
3032 RESTful API, in the same manner that other controls over data reporting
3033 will be controlled by policy.
3035 R-08312 The xNF **MAY** use another option which is expected to include REST
3036 delivery of binary encoded data sets.
3038 R-79412 The xNF **MAY** use another option which is expected to include TCP
3039 for high volume streaming asynchronous data sets and for other high volume
3040 data sets. TCP delivery can be used for either JSON or binary encoded data
3043 R-01033 The xNF **MAY** use another option which is expected to include SFTP
3044 for asynchronous bulk files, such as bulk files that contain large volumes of
3045 data collected over a long time interval or data collected across many xNFs.
3046 (Preferred is to reorganize the data into more frequent or more focused data
3047 sets, and deliver these by REST or TCP as appropriate.)
3049 R-63229 The xNF **MAY** use another option which is expected to include REST
3050 for synchronous data, using RESTCONF (e.g., for xNF state polling).
3052 R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses
3053 as data destinations for each xNF, and may be changed by Policy while
3054 the xNF is in operation. We expect the xNF to be capable of redirecting
3055 traffic to changed destinations with no loss of data, for example from
3056 one REST URL to another, or from one TCP host and port to another.
3058 R-06924 The xNF **MUST** deliver asynchronous data as data becomes
3059 available, or according to the configured frequency.
3061 R-73285 The xNF **MUST** must encode, address and deliver the data
3062 as described in the previous paragraphs.
3064 R-42140 The xNF **MUST** respond to data requests from ONAP as soon
3065 as those requests are received, as a synchronous response.
3067 R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by
3068 the ONAP configuration subsystem for synchronous communication.
3070 R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF
3071 [RFC8040] (https://tools.ietf.org/html/rfc8040).
3073 R-11240 The xNF **MUST** respond with content encoded in JSON, as
3074 described in the RESTCONF specification. This way the encoding of a
3075 synchronous communication will be consistent with Avro.
3077 R-70266 The xNF **MUST** respond to an ONAP request to deliver the
3078 current data for any of the record types defined in
3079 Event Records - Data Structure Description by returning the requested
3080 record, populated with the current field values. (Currently the defined
3081 record types include fault fields, mobile flow fields, measurements for
3082 xNF scaling fields, and syslog fields. Other record types will be added
3083 in the future as they become standardized and are made available.)
3085 R-46290 The xNF **MUST** respond to an ONAP request to deliver granular
3086 data on device or subsystem status or performance, referencing the YANG
3087 configuration model for the xNF by returning the requested data elements.
3089 R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG
3090 <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be
3091 translated to and from JSON[RFC7951]. YANG configuration and content can
3092 be represented via JSON, consistent with Avro, as described in “Encoding
3093 and Serialization” section.
3095 R-42366 The xNF **MUST** support secure connections and transports such as
3096 Transport Layer Security (TLS) protocol
3097 [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to
3098 the best current practices outlined in
3099 `RFC7525 <https://tools.ietf.org/html/rfc7525>`_.
3101 R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation
3102 of connections, through secure credentials, log-on and exchange mechanisms.
3104 R-47597 The xNF **MUST** carry data in motion only over secure connections.
3106 R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal
3107 Information (SPI) or certain proprietary data, in addition to applying the
3108 regular procedures for securing access and delivery.
3111 Ansible Playbook Examples
3112 -----------------------------------------------
3114 The following sections contain examples of Ansible playbooks
3115 which follow the guidelines.
3117 Guidelines for Playbooks to properly integrate with APPC
3118 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3120 NOTE: To support concurrent requests to multiple VNF instances of same
3121 or different type, VNF hosts and other files with VNF specific default
3122 values are kept or created in separate directories.
3124 Example of an Ansible command (after pwd) to run playbook again
3125 vfdb9904v VNF instance:
3127 .. code-block:: none
3130 /storage/vfdb/V16.1/ansible/configure
3131 $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3133 NOTE: To preserve Ansible inventory/group_vars capability, that makes
3134 group_vars contents global variables available to all playbooks, when they
3135 reside in the inventory directory, guidelines are being updated to name the
3136 VNF inventory hosts file as (a flat file) <VNFName>hosts, stored in the
3137 inventory directory, not a subdirectory under inventory. In the above
3138 example: vfdb9904vhosts (removed / VNF name and hosts vfdb9904/vhosts)
3140 Example of corresponding APPC API Call from ONAP – Ansible Server
3143 An example of a curl request simulating a Rest API POST requesting execution
3144 of configure Playbook (using playbook relative path):
3146 .. code-block:: none
3148 curl -u APIUser:APIPassword -H "Content-type:application/json" -X POST
3149 -d '{"Id": "8412", "PlaybookName": "vfdb/V5.x.x/ansible/configure/site.yml",
3150 "Timeout":"600", "EnvParameters": { "vnf_instance": "vfdb9904v" }}'
3151 http://ansible.server.com:5000/Dispatch
3153 Rest API GET request to obtain response/results for prior request
3154 (same Id as POST request above):
3156 .. code-block:: none
3158 curl -u APIUser:APIPassword -H 'Content-type: application/json' -X GET
3159 'http://ansible.server.com:5000/Dispatch/?Id=8412&Type=GetResult'
3163 - An ID number is assigned to each request. This ID number is used to
3164 track request down to completion and provide status to APPC when
3167 - Playbook Name relative path provided in the request as PlaybookName
3169 - Ansible Server Rest API is aware of playbook’s root directory which may
3170 vary from instance to instance or Ansible Server cluster to cluster.
3172 Ansible Playbooks will use the VNF instance name (passed using
3173 --extra-vars "vnf\_instance=vfdb9904v") to identify other default values
3174 to run the playbook(s) against the target VNF instance. Same example as
3177 .. code-block:: none
3179 $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3181 Each Ansible Server or cluster is assigned its own identification to be used
3182 to authenticate to VNF VMs using Ansible Server or cluster specific set of
3183 SSH keys that may be rotated regularly. Here hosts file, no longer referencing
3184 file with SSH key credentials, to run ansible-playbook listed in this example
3185 above (IP addresses were scrubbed):
3187 .. code-block:: none
3189 $ more ../inventory/vfdb9904v/hosts
3191 localhost ansible_connection=local
3201 NOTE: APPC requests to run Playbooks/Cookbooks are specific to a VNF,
3202 but could be more limited to one VM or one type of VM by the request
3203 parameters. Actions that may impact a site (LCP), a service, or an
3204 entire platform must be orchestrated by MSO in order to execute requests
3205 via APPC which then invoke VNF level playbooks. Playbooks that impact
3206 more than a single VNF are not the current focus of these guidelines.
3208 Since last release of these guidelines, based on recent learnings,
3209 moving VNF Type global variables under inventory/group_vars files, this
3210 way variables and respective values are available to all playbooks without
3211 being explicitly referenced though an include statement. Also creating
3212 templates that are VNF Type specific, but moving away from static files
3213 that are VNF instance specific, working to obtain VNF instance specific
3214 from other sources, inventory database, etc.
3216 And here the scrubbed default arguments for this VNF instance(originated
3217 from previously re-factored playbooks now being phased out):
3219 .. code-block:: none
3221 vnf_instance=vfdb9904v
3223 $ more ../vars/vfdb9904v/default_args.yml
3224 vm_config_oam_vnfc_name: vfdb9904vm001oam001
3225 vm_config_oam_hostname: vfdb9904vm001
3226 vm_config_oam_provider_ip_address: 1xx.2yy.zzz.109
3229 IMPORTANT: The APPC and default file attribute name for
3230 vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config
3231 array structure (list) in the CSAR package ENV file, with dots replaced
3234 .. code-block:: none
3238 oam: {vnfc_name: {{ vm_config_oam_vnfc_name }}, hostname: {{
3239 vm_config_oam_hostname }}, provider_ip_address: {{
3240 vm_config_oam_provider_ip_address }
3244 Parameters like VNF names, VNFC names, OA&M IP addresses, after
3245 February, 2018 ONAP release, will be extracted from A&AI by APPC and
3246 then passed down to Ansible Server, as part of APPC request through REST
3247 API. In the meantime, VNF instance specific required values, will
3248 be stored on VNF instance directory, default arguments file and will be
3249 used as defaults. For parameterized playbooks attribute-value pairs
3250 passed down by APPC to Ansible Server always take precedence over
3251 template or VNF instance specific defaults stored in defaults file(s).
3253 .. code-block:: none
3256 /storage/vfdb/latest/ansible
3257 Again, originated from previously re-factored playbooks now being phased out:
3259 $ more vars/vfdb9904v/default_args.yml
3261 vm_config_oam1_vnfc_name: vfdb9904vm001oam001
3262 vm_config_oam1_hostname: vfdb9904vm001
3263 vm_config_oam1_provider_ip_address: 1xx.2yy.zzz.109
3265 vm_config_oam2_vnfc_name: vfdb9904vm002oam001
3266 vm_config_oam2_hostname: vfdb9904vm002
3267 vm_config_oam2_provider_ip_address: 1xx.2yy.zzz.110
3269 vm_config_rdb1_vnfc_name: vfdb9904vm003rdb001
3270 vm_config_rdb1_hostname: vfdb9904vm003
3271 vm_config_rdb1_provider_ip_address: 1xx.2yy.zzz.105
3273 vm_config_rdb2_vnfc_name: vfdb9904vm004rdb001
3274 vm_config_rdb2_hostname: vfdb9904vm004
3275 vm_config_rdb2_provider_ip_address: 1xx.2yy.zzz.106
3277 vm_config_rdb3_vnfc_name: vfdb9904vm005rdb001
3278 vm_config_rdb3_hostname: vfdb9904vm005
3279 vm_config_rdb3_provider_ip_address: 1xx.2yy.zzz.xxx
3281 vm_config_rdb4_vnfc_name: vfdb9904vm006rdb001
3282 vm_config_rdb4_hostname: vfdb9904vm006
3283 vm_config_rdb4_provider_ip_address: 1xx.2yy.zzz.yyy
3285 One of the first tasks on the Ansible Playbooks is to combine the VNF
3286 type generic template, derived from ENV files in CSAR or other files,
3287 with these default values stored on the Ansible Server, together with
3288 the overriding parameters passed down from APPC, to create the VNF
3289 instance specific set of attribute-value pairs to be used for the run, in
3290 INI format. Here is an excerpt from such a file that should look
3291 somewhat similar to ENV files:
3293 .. code-block:: none
3295 $ more tmp/vfdb9904v/all.yml
3297 deployment_prefix: vfdb9904v
3301 template_version: '2014-10-16'
3302 stack_name: vfdb9904v
3304 stackName: vfdb9904v
3308 # logins list contain 'login name', 'login group', 'login password'
3310 .. code-block:: none
3313 - { name: 'm99999', group: 'm99999', password: 'abcdefgha' }
3314 - { name: 'gsuser', group: 'gsuser', password: ' abcdefgha' }
3315 - { name: 'peruser', group: 'peruser', password: ' abcdefgha' }
3316 - { name: 'dbuser', group: 'dbuser', password: ' abcdefgha' }
3318 NOTE: Arguments passed by APPC to Ansible Server to run a playbook take
3319 precedence over any defaults stored in Ansible Server.
3321 Ansible Playbooks – Notes On Artifacts Required to Run Playbooks
3322 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3324 Inventory hosts file: should be VNF instance specific.
3326 Default variables: should be VNF instance specific.
3328 NOTE: Some playbooks may rely on inventory directory contents to target
3329 the collection of VNFs in the Services Platform supported through
3332 Playbooks and paths to referenced files: Playbooks shall not use
3333 absolute paths in include or import entries (variables or playbooks) or
3334 other types of references.
3336 For this to work properly, when running playbooks, the directory where
3337 the main playbook resides shall be the current directory.
3339 Playbook imports, when used, shall use paths relative to the main
3342 Root directory named ansible - Any files provided with playbooks,
3343 included, imported, or referenced by playbooks, shall reside under the ansible
3344 playbooks (root) directory, containing all playbook subdirectories, or
3345 below that ansible root directory, in other subdirectories to support
3346 on-boarding and portability of VNF collection of playbooks and related
3349 Designing for a shared environment, concurrently running playbooks,
3350 targeting multiple VNF instances – inventory hosts file:
3352 To avoid inventory hosts file overwrites or collisions between multiple
3353 concurrently running VNF instance requests, chosen approach is for each
3354 VNF instance hosts file, to be stored under the Ansible Server Playbooks
3355 root directory, under the inventory subdirectory, and under a directory
3356 for each VNF instance, named after the VNF instance, as follows:
3358 ansible/inventory/<VNF\_instance\_name>/hosts
3360 Example of inventory hosts file path, relative to ansible playbooks root
3361 directory (playbooks\_dir): ansible/inventory/vnfx0001v/hosts
3363 **Designing for a shared environment, concurrently running multiple playbooks,
3364 targeting multiple VNF instances – default argument variables for
3365 specific VNF instances:**
3367 Files containing attribute name value pairs (variable name and default
3368 values), referenced/included by playbooks – Files containing VNF
3369 instance specific default values – in a later APPC release, some or all
3370 the default attribute value pairs contained in the defaults file, may be
3371 passed down by APPC, to the Ansible Server, overriding these defaults:
3373 VNF instance specific files
3374 referenced/included by playbooks, containing default values, example,
3375 default\_args.yml, shall be stored under a directory with VNF instance
3380 ansible/vars/<VNF\_instance\_name>/default\_args.yml
3382 Example of include statement:
3384 - include_vars: ../vars/{{ vnf_instance }}/default_args.yml
3386 Again, this was originated from previously re-factored playbooks, now being
3387 phased out, to move away from having to create VNF instance specific files
3388 with VNF instance default variables. Moving to extract these values from
3389 inventory databases and provide them to Ansible Server as part of the APPC
3390 request, but may be used in a transition from having everything stored in the
3391 Ansible Server to APPC extracting and providing VNF instance specific
3392 attribute-value pairs to the Ansible Server as part of the request.
3394 Files containing attribute name value pairs (variable name and default
3395 values), referenced/included by playbooks – created dynamically by
3399 overwrites or collisions of multiple concurrently running VNF instance
3400 requests, files created dynamically by playbooks, based on VNF generic
3401 templates, combined with default values and arguments passed down by
3402 APPC (as part of the request), shall be stored under a directory with
3403 VNF instance name on the path.
3407 tmp/<VNF\_instance\_name>/all.yml
3409 Files containing site specific (Openstack location non-instance
3410 specific) attribute name value pairs, like NTP server and DNS server’s
3411 IP addresses and other parameters, referenced/included by playbooks, not
3412 VNF specific – Could/should be stored under inventory/group_vars directory,
3413 in a subdirectory named after the string used to identify the site (nyc1,
3418 ansible/inventory/group_vars/<Site>
3420 ansible/inventory/group_vars/nyc1
3422 ansible/inventory/group_vars/lax2
3425 \ **Ansible Server Design - Directory Structure**
3427 To help understanding the contents of this section, here are few basic
3430 **VNF type a.k.a VNF Function Code** - Based on current Services
3431 Platform naming convention, each Virtual Network Function is assigned a
3432 4 character string (example vfdb), these are 4 characters in
3433 the VNF instance name, followed by (4) numbers, ending in a "v", but the
3434 naming convention is evolving. VNF instance name in
3435 some cases corresponds to the stack name for the VNF when VNF instance
3436 is built based on a single module, single stack. Example of VNF instance
3437 name: vfdb9904v. All VNF performing this function, running the same
3438 software, coming from the same VNF provider will have the same 4
3439 characters in the VNF instance name, in this example, vfdb.
3441 NOTE: New naming convention includes a prefix indicating geographical
3442 location where VNF is instantiated.
3444 VNF type, determined through these 4 characters, is also known as VNF
3445 Function Code and is assigned by inventory team. All Services Platform
3446 VNF Function Codes can be found in inventory database and/or A&AI as
3447 well as Services Platform Network Design Documents.
3449 Version – As in VNF software version is the release of the software
3450 running on the VNF for which the playbooks were developed. VNF
3451 configuration steps may change from release to release and this
3452 <Version> in the path will allow the Ansible Server to host playbooks
3453 associated with each software release. And run the playbooks that match
3454 the software release running on each VNF instance. APPC initially will
3455 not support playbook versioning only latest playbook is supported or a hard
3456 coded version that later should become a variable to allow multiple
3457 actively in use playbook versions according to VNF release.
3459 Playbook Function - Is a name associated with a life cycle management
3460 task(s) performed by the playbook(s) stored in this directory. It should
3461 clearly identify the type of action(s) performed by the main playbook
3462 and possibly other playbooks stored in this same directory. Ideally,
3463 playbook function would match APPC corresponding command or function that
3464 is performed by the main playbook in this directory. Following Ansible naming
3465 standards main playbook is usually named site.yml. There can be other
3466 playbooks on the same directory that use a subset of the roles used by the
3467 main playbook site.yml. Examples of Playbook Function directory names:
3469 - configure – Contains post-instantiation (bulk) configuration
3472 - healthcheck – Contains VNF health check playbook(s), roles,…
3474 - stop – Contains VNF application stop (stopApplication) playbook(s),
3477 - start – Contains VNF application start (startApplication) playbook(s),
3480 Directory structure to allow hosting multiple version sets of playbooks,
3481 for the same VNF type, to be hosted in the runtime environment on the
3482 Ansible Servers. Generic directory structure:
3484 Ansible Playbooks – Function directory and main playbook:
3486 .. code-block:: none
3488 <VNF type>/<Version>/ansible/<Playbook Function>/site.yml
3490 Example – Post-instantiation (bulk) configuration –APPC Function -
3493 .. code-block:: none
3495 <VNF type>/<Version>/ansible/configure/site.yml
3497 Example – Post-instantiation (bulk) configuration –APPC Function
3498 – Configure – VNF software version 16.1:
3500 .. code-block:: none
3502 vfdb/V16.1/ansible/configure/site.yml
3504 Example – Health-check –APPC Function - HealthCheck:
3506 .. code-block:: none
3508 <VNF type>/<Version>/ansible/healthcheck/site.yml
3510 OR (Function directory name does not need to match APPC function name)
3512 .. code-block:: none
3514 <VNF type>/<Version>/ansible/check/site.yml
3516 Ansible Directories for other artifacts – VNF inventory hosts file -
3519 .. code-block:: none
3521 <VNF type>/<Version>/ansible/inventory/<VNF instance name>hosts
3523 Ansible Directories for other artifacts – VNF instance specific default
3524 arguments – Optional:
3526 .. code-block:: none
3528 <VNF type>/<Version>/ansible/group_vars/<VNF instance name>
3530 NOTE: This requirement is expected to be deprecated all or in part in the
3531 future, for automated actions, once APPC can pass down all VNF specific
3532 arguments for each action. Requirement remains while manual actions are
3533 to be supported. Other automated inventory management mechanisms may be
3534 considered in the future, Ansible supports many automated inventory
3535 management mechanisms/tools/solutions.
3537 Ansible Directories for other artifacts – VNF (special) groups –
3540 .. code-block:: none
3542 <VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name>
3544 NOTE: Default groups will be created based on VNFC type, 3 characters,
3545 on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,…
3547 Ansible Directories for other artifacts – VNF (special) other files –
3548 Optional – Example – License file:
3550 .. code-block:: none
3552 <VNF type>/<Version>/ansible/<Other directory(s)>
3554 CAUTION: On referenced files used/required by playbooks.
3556 - To avoid missing files, during on-boarding or uploading of Ansible
3557 Playbooks and related artifacts, all permanent files (not generated
3558 by playbooks as part of execution), required to run any playbook,
3559 shall reside under the ansible root directory or below on other
3562 - Any references to files, on includes or other playbook entries, shall
3565 - This is the ansible (root) directory referenced on this
3566 note (Ansible Server mount point not included):
3568 .. code-block:: none
3570 <VNF type>/<Version>/ansible/
3572 There will be a soft link to the latest set of Ansible Playbooks for
3575 VNF type directories use A&AI inventory VNF function code. Ansible
3576 Playbooks will be stored on a Cinder Volume mounted on the Ansible
3577 Servers as /storage. Example:
3579 /storage/vfdb/latest/ansible – This soft link point to the latest set of
3580 playbooks (or the only set)
3582 /storage/vfdb/V16.1/ansible – Root directory for database VNF Ansible
3583 Playbooks for release 16.1
3585 CAUTION: To support this directory structure as the repository to store
3586 Ansible Playbooks run by APPC, APPC API in the Ansible Server side needs
3587 to be configured to run playbooks from directory, not MySQL database.
3589 Ansible Server HTTP will be configured to support APPC REST API requests
3590 to run playbooks as needed, against specific VNF instances, or specific
3591 VM(s) as specified in the request.
3593 ONAP APPC REST API to Ansible Server is documented separately and can be
3594 found under ONAP (onap.org).
3596 **Ansible Server – On-boarding Ansible Playbooks**
3598 Once playbooks are developed following the guidelines listed in prior
3599 section(s), playbooks need to be on-boarded onto Ansible Server(s). In
3600 the future, they’ll be on-boarded and distributed through ONAP, at least
3601 that is the proposed plan, but for now they need to be uploaded
3602 manually. There is work in progress to use a Git as the playbook
3603 repository to store and track playbooks by version, version control.
3605 These are the basic steps to on-board playbooks manually onto the
3608 1. Upload CSAR, zip, or tar file containing VNF playbooks and related
3611 2. Create full directory (using –p option below) to store Ansible
3612 Playbooks and other artifacts under /storage (or other configured)
3615 a. Includes VNF type using VNF function code 4 characters under
3618 b. Includes VNF “Version” directory as part of the path to store
3619 playbooks for this VNF version.
3621 c. Include generic ansible root directory. Creating full directory
3624 .. code-block:: none
3626 $ mkdir –p /storage/vfdb/V16.1/ansible**/**
3628 3. Make this directory (VNF ansible root directory) current directory
3631 .. code-block:: none
3633 cd /storage/vfdb/V16.1/ansible/
3635 4. Extract Ansible Playbooks and other Ansible artifacts associated with
3636 the playbooks onto the ansible directory. Command depends on the type
3637 of file uploaded, examples would be:
3639 .. code-block:: none
3645 5. Create VNF inventory hosts file with all VMs and
3646 OA&M IP addresses for all VNF instances with known OA&M IP addresses
3647 for respective VMs, example:
3649 .. code-block:: none
3653 $ touch inventory/vfdb9904vhosts
3655 $ cat inventory/vfdb9904vhosts
3658 localhost ansible\_connection=local
3668 6. (Optional, being deprecated) Create directory to hold default
3669 arguments for each VNF instance,
3672 .. code-block:: none
3674 $ mkdir –p vars/vfdb9904v
3675 $ touch vars/vfdb9904v/default\_args.yml
3676 $ cat vars/vfdb9904v/default\_args.yml
3677 vm\_config\_oam1\_vnfc\_name: vfdb9904vm001oam001
3678 vm\_config\_oam1\_hostname: vfdb9904vm001
3679 vm\_config\_oam1\_provider\_ip\_address: 1xx.2yy.zzz.109
3681 vm\_config\_oam2\_vnfc\_name: vfdb9904vm002oam001
3682 vm\_config\_oam2\_hostname: vfdb9904vm002
3683 vm\_config\_oam2\_provider\_ip\_address: 1xx.2yy.zzz.110
3685 vm\_config\_rdb1\_vnfc\_name: vfdb9904vm003rdb001
3686 vm\_config\_rdb1\_hostname: vfdb9904vm003
3687 vm\_config\_rdb1\_provider\_ip\_address: 1xx.2yy.zzz.105
3689 vm\_config\_rdb2\_vnfc\_name: vfdb9904vm004rdb001
3690 vm\_config\_rdb2\_hostname: vfdb9904vm004
3691 vm\_config\_rdb2\_provider\_ip\_address: 1xx.2yy.zzz.106
3693 vm\_config\_rdb3\_vnfc\_name: vfdb9904vm005rdb001
3694 vm\_config\_rdb3\_hostname: vfdb9904vm005
3695 vm\_config\_rdb3\_provider\_ip\_address: 1xx.2yy.zzz.xxx
3697 vm\_config\_rdb4\_vnfc\_name: vfdb9904vm006rdb001
3698 vm\_config\_rdb4\_hostname: vfdb9904vm006
3699 vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy
3701 NOTE: Please note names in this file shall use underscore “\_” not dots
3704 7. Perform some basic playbook validation running with “--check” option,
3705 running dummy playbooks or other.
3707 NOTE: Each Ansible Server or cluster of Ansible Server will have its own
3708 credentials to authenticate to VNF VMs. Ansible Server SSH public key(s)
3709 have to be loaded onto VNF VMs during instantiation or other way before
3710 Ansible Server can access VNF VMs and run playbooks. HOT templates used
3711 by heat to instantiate VNFs to be configured by these Ansible Servers running
3712 playbooks shall include the same SSH public key and load them onto VNF VM(s)
3713 as part of instantiation.
3715 Other non-vendor specific playbook tasks need to be incorporated in overall
3716 post-instantiation configuration playbook. Alternative is for company
3717 developed playbooks to be uploaded and executed, after VNF vendor provided
3720 **A couple of playbooks used for proof-of-concept testing as examples:**
3724 .. code-block:: none
3727 /storage/comx/V5.3.1.3/ansible/upgradeprecheck
3732 - import_playbook: ../common/create_vars.yml
3733 - import_playbook: ../common/create_hosts.yml
3735 - name: upgrade software pre check
3741 max_fail_percentage: 0
3742 any_errors_fatal: True
3747 $ more roles/precheck/tasks/main.yml
3750 - include_vars: /tmp/{{ vnf_instance }}/all.yml
3752 - name: get software version installed on vnf
3753 shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ existing_software_version }}"
3754 register: version_line
3757 - name: send msg when matches expected version
3758 debug: msg="*** OK *** VNF software release matches (old) release to be upgraded."
3760 when: version_line.stdout.find('1') != -1
3762 # send warning message and failure when release is not a match
3764 msg="*** WARNING *** VNF software release does not match expected (pre-upgrade) release."
3765 when: (version_line | failed) or version_line.stdout.find('1') == -1
3770 .. code-block:: none
3773 /storage/comx/V5.3.1.3/ansible/upgradepostcheck
3778 - import_playbook: ../common/create_vars.yml
3779 - import_playbook: ../common/create_hosts.yml
3781 - name: upgrade software post check
3787 max_fail_percentage: 0
3788 any_errors_fatal: True
3793 $ more roles/postcheck/tasks/main.yml
3796 - include_vars: /tmp/{{ vnf_instance }}/all.yml
3798 - name: get post upgrade software version installed on vnf
3799 shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ new_software_version }}"
3800 register: version_line
3803 - name: send msg when matches expected version
3804 debug: msg="*** OK *** VNF software release matches new release."
3806 when: version_line.stdout.find('1') != -1
3808 # send warning message and failure when release is not a match
3810 msg="*** WARNING *** VNF software release does not match expected new (post-upgrade) release."
3811 when: (version_line | failed) or version_line.stdout.find('1') == -1
3815 The “name” field is a mandatory field in a valid Chef Node Object
3819 Not currently supported in ONAP release 1
3822 https://github.com/mbj4668/pyang
3825 Upstream elements must provide the appropriate FQDN in the request to
3826 ONAP for the desired action.
3829 Refer to NCSP’s Network Cloud specification
3832 This option is not currently supported in ONAP and it is currently
3833 under consideration.
3836 Multiple ONAP actions may map to one playbook.
Code Review / vnfrqts / requirements.git / blob