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| |
193 | | list name of the | | |
194 | | playbook used to | | |
195 | | execute the VNF | | |
197 +---------------+----------------------+---------+----------------------------+
198 | Action | Name of VNF action. | Optional| |
199 +---------------+----------------------+---------+----------------------------+
200 | EnvParameters | A JSON dictionary | Optional| Depends on the VNF action. |
201 | | which should list key| | |
202 | | value pairs to be | | |
203 | | passed to the Ansible| | |
204 | | playbook. These | | |
205 | | values would | | |
206 | | correspond to | | |
207 | | instance specific | | |
208 | | parameters that a | | |
209 | | playbook may need to | | |
210 | | execute an action. | | |
211 +---------------+----------------------+---------+----------------------------+
212 | NodeList | A JSON array of FQDNs| Optional| If not provided, playbook |
213 | | that the playbook | | will be executed on the |
214 | | must be executed on. | | Ansible Server. |
215 +---------------+----------------------+---------+----------------------------+
216 | FileParameters| A JSON dictionary | Optional| Depends on the VNF action |
217 | | where keys are | | and playbook design. |
218 | | filenames and values | | |
219 | | are contents of | | |
220 | | files. The Ansible | | |
221 | | Server will utilize | | |
222 | | this feature to | | |
223 | | generate files with | | |
224 | | keys as filenames and| | |
225 | | values as content. | | |
226 | | This attribute can be| | |
227 | | used to generate | | |
228 | | files that a playbook| | |
229 | | may require as part | | |
230 | | of execution. | | |
231 +---------------+----------------------+---------+----------------------------+
232 | Timeout | Time (in seconds) | Optional| |
233 | | that a playbook is | | |
234 | | expected to take to | | |
235 | | finish execution for | | |
236 | | the VNF. If playbook | | |
237 | | execution time | | |
238 | | exceeds this value, | | |
239 | | Ansible Server will | | |
240 | | terminate the | | |
241 | | playbook process. | | |
242 +---------------+----------------------+---------+----------------------------+
244 Ansible JSON file example:
248 “Action”:”Configure”,
250 "PlaybookName": "Ansible\_configure.yml",
252 "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”],
256 "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”},
258 “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”}
262 In the above example, the Ansible Server will:
264 a. Process the “FileParameters” dictionary and generate a file named
265 ‘config.txt’ with contents set to the value of the ‘config.txt’ key.
267 b. Execute the playbook named ‘Ansible\_configure.yml’ on nodes with
268 FQDNs test1.vnf\_b.onap.com and test2.vnf\_b.onap.com respectively
269 while providing the following key value pairs to the playbook:
270 Retry=3, Wait=5, ConfigFile=config.txt
272 c. If execution time of the playbook exceeds 60 secs (across all hosts),
273 it will be terminated.
275 VNF License Information Guidelines
276 ------------------------------------------------------------
278 This Appendix describes the metadata to be supplied for VNF licenses.
280 1. General Information
282 Table C1 defines the required and optional fields for licenses.
284 Table C1. Required Fields for General Information
285 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
287 +---------------+-----------------------------------+--------------+----------+
288 | **Field Name**| **Description** | **Data Type**| **Type** |
289 +===============+===================================+==============+==========+
290 | VNF Provider | The name of the VNF provider. | String | Mandatory|
292 +---------------+-----------------------------------+--------------+----------+
293 | VNF Provider | The name of the product to which | String | Mandatory|
294 | Product | this agreement applies. | | |
296 | | Note: a contract/agreement may | | |
297 | | apply to more than one VNF | | |
298 | | provider product. In that case, | | |
299 | | provide the metadata for each | | |
300 | | product separately. | | |
301 +---------------+-----------------------------------+--------------+----------+
302 | VNF Provider | A general description of VNF | String | Optional |
303 | Product | provider software product. | | |
304 | Description | | | |
305 +---------------+-----------------------------------+--------------+----------+
306 | Export Control| ECCNs are 5-character | String | Mandatory|
307 | Classification| alpha-numeric designations used on| | |
308 | Number (ECCN) | the Commerce Control List (CCL) to| | |
309 | | identify dual-use items for export| | |
310 | | control purposes. An ECCN | | |
311 | | categorizes items based on the | | |
312 | | nature of the product, i.e. type | | |
313 | | of commodity, software, or | | |
314 | | technology and its respective | | |
315 | | technical parameters. | | |
316 +---------------+-----------------------------------+--------------+----------+
317 | Reporting | A list of any reporting | List of | Optional |
318 | Requirements | requirements on the usage of the | strings | |
319 | | software product. | | |
320 +---------------+-----------------------------------+--------------+----------+
324 Entitlements describe software license use rights. The use rights may be
325 quantified by various metrics: # users, # software instances, # units.
326 The use rights may be limited by various criteria: location (physical or
327 logical), type of customer, type of device, time, etc.
329 One or more entitlements can be defined; each one consists of the
332 Table C2. Required Fields for Entitlements
333 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
335 +---------------+-----------------------------------+-------------+-----------+
336 | **Field Name**| **Description** |**Data Type**| **Type** |
337 +===============+===================================+=============+===========+
338 | VNF Provider | Identifier for the entitlement as | String | Mandatory |
339 | Part Number / | described by the VNF provider in | | |
340 | Manufacture | their price list / catalog / | | |
341 | Reference | contract. | | |
343 +---------------+-----------------------------------+-------------+-----------+
344 | Description | Verbiage that describes the | String | Optional |
345 | | entitlement | | |
346 +---------------+-----------------------------------+-------------+-----------+
347 | Entitlement | Each entitlement defined must be | String | Mandatory |
348 | Identifier | identified by a unique value (e.g.| | |
349 | | numbered 1, 2, 3….) | | |
350 +---------------+-----------------------------------+-------------+-----------+
351 | Minimum Order | The minimum number of entitlements| Number | Mandatory |
352 | Requirement | that need to be purchased. | | |
353 | | For example, the entitlements must| | |
354 | | be purchased in a block of 100. If| | |
355 | | no minimum is required, the value | | |
356 | | will be zero. | | |
357 +---------------+-----------------------------------+-------------+-----------+
358 | Unique | A list of any reporting | List of | Optional |
359 | Reporting | requirements on the usage of the | Strings | |
360 | Requirements | software product. (e.g.: quarterly| | |
361 | | usage reports are required) | | |
362 +---------------+-----------------------------------+-------------+-----------+
363 | License Type | Type of license applicable to the | String | Mandatory |
364 | | software product. (e.g.: | | |
365 | | fixed-term, perpetual, trial, | | |
366 | | subscription.) | | |
367 +---------------+-----------------------------------+-------------+-----------+
368 | License | Valid values: | String |Conditional|
370 | | **year**, **quarter**, **month**, | | |
373 | | Not applicable when license type | | |
374 | | is Perpetual. | | |
375 +---------------+-----------------------------------+-------------+-----------+
376 | License | Number of years, quarters, months,| Number |Conditional|
377 | Duration | or days for which the license is | | |
378 | Quantification| valid. | | |
380 | | Not applicable when license type | | |
381 | | is Perpetual. | | |
382 +---------------+-----------------------------------+-------------+-----------+
383 | Limits | see section C.4 for possible | List | Optional |
385 +---------------+-----------------------------------+-------------+-----------+
389 This section defines information on any License Keys associated with the
390 Software Product. A license key is a data string (or a file) providing a
391 means to authorize the use of software. License key does not provide
392 entitlement information.
394 License Keys are not required. Optionally, one or more license keys can
395 be defined; each one consists of the following fields:
397 Table C3. Required Fields for License Keys
398 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
400 +---------------+-----------------------------------+--------------+----------+
401 | **Field Name**| **Description** | **Data Type**| **Type** |
402 +===============+===================================+==============+==========+
403 | Description | Verbiage that describes the | String | Mandatory|
404 | | license key | | |
405 +---------------+-----------------------------------+--------------+----------+
406 | License Key | Each license key defined must be | String | Mandatory|
407 | Identifier | identified by a unique value | | |
408 | | (e.g., numbered 1, 2, 3….) | | |
409 +---------------+-----------------------------------+--------------+----------+
410 | Key Function | Lifecycle stage (e.g., | String | Optional |
411 | | Instantiation or Activation) at | | |
412 | | which the license key is applied | | |
413 | | to the software. | | |
414 +---------------+-----------------------------------+--------------+----------+
415 | License Key | Valid values: | String | Mandatory|
417 | | **Universal, Unique** | | |
419 | | **Universal** - a single license | | |
420 | | key value that may be used with | | |
421 | | any number of instances of the | | |
424 | | **Unique**- a unique license key | | |
425 | | value is required for each | | |
426 | | instance of the software. | | |
427 +---------------+-----------------------------------+--------------+----------+
428 | Limits | see section C.4 for possible | List | Optional |
430 +---------------+-----------------------------------+--------------+----------+
432 1. Entitlement and License Key Limits
434 Limitations on the use of software entitlements and license keys may be
435 based on factors such as: features enabled in the product, the allowed
436 capacity of the product, number of installations, etc... The limits may
437 generally be categorized as:
449 Multiple limits may be applicable for an entitlement or license key.
450 Each limit may further be described by limit behavior, duration,
451 quantification, aggregation, aggregation interval, start date, end date,
454 When the limit is associated with a quantity, the quantity is relative
455 to an instance of the entitlement or license key. For example:
457 - Each entitlement grants the right to 50 concurrent users. If 10
458 entitlements are purchased, the total number of concurrent users
459 permitted would be 500. In this example, the limit category is
460 **amount**, the limit type is **users**, and the limit
461 **quantification** is **50.**
463 Each license key may be installed on 3 devices. If 5 license keys are
464 acquired, the total number of devices allowed would be 15. In this
465 example, the limit category is **usages**, the limit type is
466 **device**, and the limit **quantification** is **3.**
470 Locations may be logical or physical location (e.g., site, country). For
473 - use is allowed in Canada
475 Table C4. Required Fields for Location
476 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
478 +------------------+--------------------------------+--------------+----------+
479 | **Field Name** | **Description** | **Data Type**| **Type** |
480 +==================+================================+==============+==========+
481 | Limit Identifier | Each limit defined for an | String | Mandatory|
482 | | entitlement or license key must| | |
483 | | be identified by a unique value| | |
484 | | (e.g., numbered 1,2,3…) | | |
485 +------------------+--------------------------------+--------------+----------+
486 | Limit Description| Verbiage describing the limit. | String | Mandatory|
487 +------------------+--------------------------------+--------------+----------+
488 | Limit Behavior | Description of the actions | String | Mandatory|
489 | | taken when the limit boundaries| | |
490 | | are reached. | | |
491 +------------------+--------------------------------+--------------+----------+
492 | Limit Category | Valid value: **location** | String | Mandatory|
493 +------------------+--------------------------------+--------------+----------+
494 | Limit Type | Valid values: **city, county, | String | Mandatory|
495 | | state, country, region, MSA, | | |
496 | | BTA, CLLI** | | |
497 +------------------+--------------------------------+--------------+----------+
498 | Limit List | List of locations where the VNF| List of | Mandatory|
499 | | provider Product can be used or| String | |
500 | | needs to be restricted from use| | |
501 +------------------+--------------------------------+--------------+----------+
502 | Limit Set Type | Indicates if the list is an | String | Mandatory|
503 | | inclusion or exclusion. | | |
505 | | Valid Values: | | |
507 | | **Allowed** | | |
509 | | **Not allowed** | | |
510 +------------------+--------------------------------+--------------+----------+
511 | Limit | The quantity (amount) the limit| Number | Optional |
512 | Quantification | expresses. | | |
513 +------------------+--------------------------------+--------------+----------+
517 Limit on the length of time the software may be used. For example:
519 - license key valid for 1 year from activation
521 - entitlement valid from 15 May 2018 thru 30 June 2020
523 Table C5. Required Fields for Time
524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526 +------------------+-------------------------------+--------------+-----------+
527 | **Field Name** | **Description** | **Data Type**| **Type** |
528 +==================+===============================+==============+===========+
529 | Limit Identifier | Each limit defined for an | String | Mandatory |
530 | | entitlement or license key | | |
531 | | must be identified by a unique| | |
532 | | value (e.g., numbered) | | |
533 +------------------+-------------------------------+--------------+-----------+
534 | Limit Description| Verbiage describing the limit.| String | Mandatory |
535 +------------------+-------------------------------+--------------+-----------+
536 | Limit Behavior | Description of the actions | String | Mandatory |
537 | | taken when the limit | | |
538 | | boundaries are reached. | | |
540 | | The limit behavior may also | | |
541 | | describe when a time limit | | |
542 | | takes effect. (e.g., key is | | |
543 | | valid for 1 year from date of | | |
545 +------------------+-------------------------------+--------------+-----------+
546 | Limit Category | Valid value: **time** | String | Mandatory |
547 +------------------+-------------------------------+--------------+-----------+
548 | Limit Type | Valid values: | String | Mandatory |
549 | | **duration, date** | | |
550 +------------------+-------------------------------+--------------+-----------+
551 | Limit List | List of times for which the | List of | Mandatory |
552 | | VNF Provider Product can be | String | |
553 | | used or needs to be restricted| | |
555 +------------------+-------------------------------+--------------+-----------+
556 | Duration Units | Required when limit type is | String |Conditional|
557 | | duration. Valid values: | | |
558 | | **perpetual, year, quarter, | | |
559 | | month, day, minute, second, | | |
560 | | millisecond** | | |
561 +------------------+-------------------------------+--------------+-----------+
562 | Limit | The quantity (amount) the | Number | Optional |
563 | Quantification | limit expresses. | | |
564 +------------------+-------------------------------+--------------+-----------+
565 | Start Date | Required when limit type is | Date | Optional |
567 +------------------+-------------------------------+--------------+-----------+
568 | End Date | May be used when limit type is| Date | Optional |
570 +------------------+-------------------------------+--------------+-----------+
574 Limits based on how the software is used. For example:
576 - use is limited to a specific sub-set of the features/capabilities the
579 - use is limited to a certain environment (e.g., test, development,
582 - use is limited by processor (vm, cpu, core)
584 - use is limited by software release
586 Table C6. Required Fields for Usage
587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
589 +------------------+-------------------------------+---------------+----------+
590 | **Field Name** | **Description** | **Data Type** | **Type** |
591 +==================+===============================+===============+==========+
592 | Limit Identifier | Each limit defined for an | String | Mandatory|
593 | | entitlement or license key | | |
594 | | must be identified by a unique| | |
595 | | value (e.g., numbered) | | |
596 +------------------+-------------------------------+---------------+----------+
597 | Limit Description| Verbiage describing the limit.| String | Mandatory|
598 +------------------+-------------------------------+---------------+----------+
599 | Limit Behavior | Description of the actions | String | Mandatory|
600 | | taken when the limit | | |
601 | | boundaries are reached. | | |
602 +------------------+-------------------------------+---------------+----------+
603 | Limit Category | Valid value: **usages** | String | Mandatory|
604 +------------------+-------------------------------+---------------+----------+
605 | Limit Type | Valid values: **feature, | String | Mandatory|
606 | | environment, processor, | | |
608 +------------------+-------------------------------+---------------+----------+
609 | Limit List | List of usage limits (e.g., | List of String| Mandatory|
610 | | test, development, vm, core, | | |
611 | | R1.2.1, R1.3.5…) | | |
612 +------------------+-------------------------------+---------------+----------+
613 | Limit Set Type | Indicates if the list is an | String | Mandatory|
614 | | inclusion or exclusion. | | |
616 | | Valid Values: | | |
618 | | **Allowed** | | |
620 | | **Not allowed** | | |
621 +------------------+-------------------------------+---------------+----------+
622 | Limit | The quantity (amount) the | Number | Optional |
623 | Quantification | limit expresses. | | |
624 +------------------+-------------------------------+---------------+----------+
628 Limit on the entity (product line, organization, customer) allowed to
629 make use of the software. For example:
631 - allowed to be used in support of wireless products
633 - allowed to be used only for government entities
635 Table C7. Required Fields for Entity
636 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
638 +------------------+--------------------------------+--------------+----------+
639 | **Field Name** | **Description** |**Data Type** | **Type** |
640 +==================+================================+==============+==========+
641 | Limit Identifier | Each limit defined for an | String | Mandatory|
642 | | entitlement or license key must| | |
643 | | be identified by a unique value| | |
644 | | (e.g., numbered) | | |
645 +------------------+--------------------------------+--------------+----------+
646 | Limit Description| Verbiage describing the limit. | String | Mandatory|
647 +------------------+--------------------------------+--------------+----------+
648 | Limit Behavior | Description of the actions | String | Mandatory|
649 | | taken when the limit boundaries| | |
650 | | are reached. | | |
651 +------------------+--------------------------------+--------------+----------+
652 | Limit Category | Valid value: **entity** | String | Mandatory|
653 +------------------+--------------------------------+--------------+----------+
654 | Limit Type | Valid values: **product line, | String | Mandatory|
655 | | organization, internal | | |
656 | | customer, external customer** | | |
657 +------------------+--------------------------------+--------------+----------+
658 | Limit List | List of entities for which the |List of String| Mandatory|
659 | | VNF Provider Product can be | | |
660 | | used or needs to be restricted | | |
662 +------------------+--------------------------------+--------------+----------+
663 | Limit Set Type | Indicates if the list is an | String | Mandatory|
664 | | inclusion or exclusion. | | |
666 | | Valid Values: | | |
668 | | **Allowed** | | |
670 | | **Not allowed** | | |
671 +------------------+--------------------------------+--------------+----------+
672 | Limit | The quantity (amount) the limit| Number | Optional |
673 | Quantification | expresses. | | |
674 +------------------+--------------------------------+--------------+----------+
678 These limits describe terms relative to utilization of the functions of
679 the software (for example, number of named users permitted, throughput,
680 or capacity). Limits of this type may also be relative to utilization of
681 other resources (for example, a limit for firewall software is not based
682 on use of the firewall software, but on the number of network
685 The metadata describing this type of limit includes the unit of measure
686 (e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units,
687 any aggregation function (e.g., peak or average users), and aggregation
688 interval (day, month, quarter, year, etc.).
690 Table C8. Required Fields for Amount
691 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
693 +------------------+---------------------------------+-------------+----------+
694 | **Field Name** | **Description** |**Data Type**| **Type** |
695 +==================+=================================+=============+==========+
696 | Limit Identifier | Each limit defined for an | String | Mandatory|
697 | | entitlement or license key must | | |
698 | | be identified by a unique value | | |
699 | | (e.g., numbered) | | |
700 +------------------+---------------------------------+-------------+----------+
701 | Limit Description| Verbiage describing the limit. | String | Mandatory|
702 +------------------+---------------------------------+-------------+----------+
703 | Limit Behavior | Description of the actions taken| String | Mandatory|
704 | | when the limit boundaries are | | |
706 +------------------+---------------------------------+-------------+----------+
707 | Limit Category | Valid value: **amount** | String | Mandatory|
708 +------------------+---------------------------------+-------------+----------+
709 | Limit Type | Valid values: **trunk, user, | String | Mandatory|
710 | | subscriber, session, token, | | |
711 | | transactions, seats, KB, MB, TB,| | |
713 +------------------+---------------------------------+-------------+----------+
714 | Type of | Is the limit relative to | String | Mandatory|
715 | Utilization | utilization of the functions of | | |
716 | | the software or relative to | | |
717 | | utilization of other resources? | | |
719 | | Valid values: | | |
721 | | - **software functions** | | |
723 | | - **other resources** | | |
724 +------------------+---------------------------------+-------------+----------+
725 | Limit | The quantity (amount) the limit | Number | Optional |
726 | Quantification | expresses. | | |
727 +------------------+---------------------------------+-------------+----------+
728 | Aggregation | Valid values: **peak, average** | String | Optional |
730 +------------------+---------------------------------+-------------+----------+
731 | Aggregation | Time period over which the | String | Optional |
732 | Interval | aggregation is done (e.g., | | |
733 | | average sessions per quarter). | | |
734 | | Required when an Aggregation | | |
735 | | Function is specified. | | |
737 | | Valid values: **day, month, | | |
738 | | quarter, year, minute, second, | | |
739 | | millisecond** | | |
740 +------------------+---------------------------------+-------------+----------+
741 | Aggregation | Is the limit quantity applicable| String | Optional |
742 | Scope | to a single entitlement or | | |
743 | | license key (each separately)? | | |
744 | | Or may the limit quantity be | | |
745 | | combined with others of the same| | |
746 | | type (resulting in limit amount | | |
747 | | that is the sum of all the | | |
748 | | purchased entitlements or | | |
749 | | license keys)? | | |
751 | | Valid values: | | |
753 | | - **single** | | |
755 | | - **combined** | | |
756 +------------------+---------------------------------+-------------+----------+
757 | Type of User | Describes the types of users of | String | Optional |
758 | | the functionality offered by the| | |
759 | | software (e.g., authorized, | | |
760 | | named). This field is included | | |
761 | | when Limit Type is user. | | |
762 +------------------+---------------------------------+-------------+----------+
765 -----------------------------
767 Table D1. ONAP Resource DM TOSCA/YAML constructs
768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
770 Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by
771 VNF vendors to create a standard VNF descriptor.
773 All definitions are summarized in the table below based on the agreed ONAP
774 Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in
775 ETSI GS NFV-SOL001 stable draft for VNF-D.
777 +------------+------------------------------+---------------------------------+
778 | Requirement| Resource IM Info Elements | TOSCA Constructs as per SOL001 |
780 +============+==============================+=================================+
781 | R-02454 | VNFD.vnfSoftwareVersion | For VDU.Compute - |
782 | | | tosca.artifacts.nfv.SwImage |
784 | | SwImageDesc.Version | For Virtual Storage - |
785 | | | tosca.artifacts.Deployment.Image|
786 +------------+------------------------------+---------------------------------+
787 | R-03070 | vnfExtCpd's with virtual | tosca.nodes.nfv.VnfExtCp with a |
788 | | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\ |
789 | | (vNIC) | VirtualNetworkInterface\ |
791 +------------+------------------------------+---------------------------------+
792 | R-09467 | VDU.Compute descriptor | tosca.nodes.nfv.Vdu.Compute |
793 +------------+------------------------------+---------------------------------+
794 | R-16065 | VDU.Compute. Configurable | tosca.datatypes.nfv.Vnfc |
795 | | Properties | ConfigurableProperties |
796 +------------+------------------------------+---------------------------------+
797 | R-30654 | VNFD.lifeCycleManagement | Interface construct tosca.\ |
798 | | Script - IFA011 LifeCycle\ | interfaces.nfv.vnf.lifecycle.Nfv|
799 | | ManagementScript | with a list of standard LCM |
801 +------------+------------------------------+---------------------------------+
802 | R-35851 | CPD: VduCp, VnfExtCp, | tosca.nodes.nfv.VduCp, tosca.\ |
803 | | VnfVirtualLinkDesc, QoS | nodes.nfv.VnfVirtualLink, |
804 | | Monitoring info element - | tosca.nodes.nfv.VnfExtCp |
806 +------------+------------------------------+---------------------------------+
807 | R-41215 | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile |
808 | | aspect | and tosca.datatypes.nfv.\ |
809 | | | ScalingAspect |
810 +------------+------------------------------+---------------------------------+
811 | R-66070 | VNFD meta data | tosca.datatypes.nfv. |
812 | | | VnfInfoModifiableAttributes - |
814 +------------+------------------------------+---------------------------------+
815 | R-96634 | VNFD.configurableProperties | tosca.datatypes.nfv.Vnf\ |
816 | | describing scaling | ConfigurableProperties, |
817 | | characteristics. VNFD.\ | tosca.datatypes.nfv.ScaleInfo |
818 | | autoscale defines the rules | |
819 | | for scaling based on specific| |
820 | | VNF indications | |
821 +------------+------------------------------+---------------------------------+
822 | ? | VDU Virtual Storage | tosca.nodes.nfv.Vdu.\ |
823 | | | VirtualStorage |
824 +------------+------------------------------+---------------------------------+
825 | R-01478 | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - |
826 | | - SOL001 per VNF/VDU/VLink | type for monitoring |
827 | R-01556 | memory-consumption, | |
828 | | CPU-utilization, | monitoring_parameter of above |
829 | | bandwidth-consumption, VNFC | type per VNF/VDU/VLink |
830 | | downtime, etc. | |
831 +------------+------------------------------+---------------------------------+
834 Table D2. TOSCA CSAR structure
835 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
837 This section defines the requirements around the CSAR structure.
839 The table below describes the numbered requirements for CSAR structure as
840 agreed with SDC. The format of the CSAR is specified in SOL004.
842 +------------+-------------------------------------+--------------------------+
843 | Requirement| Description | CSAR artifact directory |
845 +============+=====================================+==========================+
846 | R-26881 | The VNF provider MUST provide the | ROOT\\Artifacts\ |
847 | | binaries and images needed to | \\VNF_Image.bin |
848 | | instantiate the VNF (VNF and VNFC | |
850 +------------+-------------------------------------+--------------------------+
851 | R-30654 | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\ |
852 | | includes a list of events and | \\Informational\ |
853 | | corresponding management scripts | \\Install.csh |
854 | | performed for the VNF - SOL001 | |
855 +------------+-------------------------------------+--------------------------+
856 | R-35851 | All VNF topology related definitions| ROOT\\Definitions\ |
857 | | in yaml files VNFD/Main Service | \\VNFC.yaml |
858 | | template at the ROOT | |
860 | | | \\MainService\ |
861 | | | \\Template.yaml |
862 +------------+-------------------------------------+--------------------------+
863 | R-40827 | CSAR License directory - SOL004 | ROOT\\Licenses\ |
864 | | | \\License_term.txt |
865 +------------+-------------------------------------+--------------------------+
866 | R-77707 | CSAR Manifest file - SOL004 | ROOT\ |
867 | | | \\MainServiceTemplate.mf |
868 +------------+-------------------------------------+--------------------------+
871 --------------------------------
873 **VNF Development Requirements**
874 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
879 R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs.
881 R-82223 The VNF **MUST** be decomposed if the functions have
882 significantly different scaling characteristics (e.g., signaling
883 versus media functions, control versus data plane functions).
885 R-16496 The VNF **MUST** enable instantiating only the functionality that
886 is needed for the decomposed VNF (e.g., if transcoding is not needed it
887 should not be instantiated).
889 R-02360 The VNFC **MUST** be designed as a standalone, executable process.
891 R-34484 The VNF **SHOULD** create a single component VNF for VNFCs
892 that can be used by other VNFs.
894 R-23035 The VNF **MUST** be designed to scale horizontally (more
895 instances of a VNF or VNFC) and not vertically (moving the existing
896 instances to larger VMs or increasing the resources within a VM)
897 to achieve effective utilization of cloud resources.
899 R-30650 The VNF **MUST** utilize cloud provided infrastructure and
900 VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so
901 that the cloud can manage and provide a consistent service resiliency
902 and methods across all VNF's.
904 R-12709 The VNFC **SHOULD** be independently deployed, configured,
905 upgraded, scaled, monitored, and administered by ONAP.
907 R-37692 The VNFC **MUST** provide API versioning to allow for
908 independent upgrades of VNFC.
910 R-86585 The VNFC **SHOULD** minimize the use of state within
911 a VNFC to facilitate the movement of traffic from one instance
914 R-65134 The VNF **SHOULD** maintain state in a geographically
915 redundant datastore that may, in fact, be its own VNFC.
917 R-75850 The VNF **SHOULD** decouple persistent data from the VNFC
918 and keep it in its own datastore that can be reached by all instances
919 of the VNFC requiring the data.
921 R-88199 The VNF **MUST** utilize a persistent datastore service that
922 can meet the data performance/latency requirements. (For example:
923 Datastore service could be a VNFC in VNF or a DBaaS in the Cloud
924 execution environment)
926 R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC
929 R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring
930 high packets/sec performance. High packet throughput is defined as greater
931 than 500K packets/sec.
933 R-54430 The VNF **MUST** use the NCSP’s supported library and compute
934 flavor that supports DPDK to optimize network efficiency if using DPDK. [5]_
936 R-18864 The VNF **MUST** NOT use technologies that bypass virtualization
937 layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary
938 to meet functional or performance requirements).
940 R-64768 The VNF **MUST** limit the size of application data packets
941 to no larger than 9000 bytes for SDN network-based tunneling when
942 guest data packets are transported between tunnel endpoints that
943 support guest logical networks.
945 R-74481 The VNF **MUST** NOT require the use of a dynamic routing
946 protocol unless necessary to meet functional requirements.
949 ~~~~~~~~~~~~~~~~~~~~~~~~~
951 R-52499 The VNF **MUST** meet their own resiliency goals and not rely
952 on the Network Cloud.
954 R-42207 The VNF **MUST** design resiliency into a VNF such that the
955 resiliency deployment model (e.g., active-active) can be chosen at
958 R-03954 The VNF **MUST** survive any single points of failure within
959 the Network Cloud (e.g., virtual NIC, VM, disk failure).
961 R-89010 The VNF **MUST** survive any single points of software failure
962 internal to the VNF (e.g., in memory structures, JMS message queues).
964 R-67709 The VNF **MUST** be designed, built and packaged to enable
965 deployment across multiple fault zones (e.g., VNFCs deployed in
966 different servers, racks, OpenStack regions, geographies) so that
967 in the event of a planned/unplanned downtime of a fault zone, the
968 overall operation/throughput of the VNF is maintained.
970 R-35291 The VNF **MUST** support the ability to failover a VNFC
971 automatically to other geographically redundant sites if not
972 deployed active-active to increase the overall resiliency of the VNF.
974 R-36843 The VNF **MUST** support the ability of the VNFC to be deployable
975 in multi-zoned cloud sites to allow for site support in the event of cloud
976 zone failure or upgrades.
978 R-92935 The VNF **SHOULD** minimize the propagation of state information
979 across multiple data centers to avoid cross data center traffic.
981 R-26371 The VNF **MUST** detect communication failure for inter VNFC
982 instance and intra/inter VNF and re-establish communication
983 automatically to maintain the VNF without manual intervention to
984 provide service continuity.
986 R-18725 The VNF **MUST** handle the restart of a single VNFC instance
987 without requiring all VNFC instances to be restarted.
989 R-06668 The VNF **MUST** handle the start or restart of VNFC instances
990 in any order with each VNFC instance establishing or re-establishing
991 required connections or relationships with other VNFC instances and/or
992 VNFs required to perform the VNF function/role without requiring VNFC
993 instance(s) to be started/restarted in a particular order.
995 R-80070 The VNF **MUST** handle errors and exceptions so that they do
996 not interrupt processing of incoming VNF requests to maintain service
997 continuity (where the error is not directly impacting the software
998 handling the incoming request).
1000 R-32695 The VNF **MUST** provide the ability to modify the number of
1001 retries, the time between retries and the behavior/action taken after
1002 the retries have been exhausted for exception handling to allow the
1003 NCSP to control that behavior, where the interface and/or functional
1004 specification allows for altering behaviour.
1006 R-48356 The VNF **MUST** fully exploit exception handling to the extent
1007 that resources (e.g., threads and memory) are released when no longer
1008 needed regardless of programming language.
1010 R-67918 The VNF **MUST** handle replication race conditions both locally
1011 and geo-located in the event of a data base instance failure to maintain
1014 R-36792 The VNF **MUST** automatically retry/resubmit failed requests
1015 made by the software to its downstream system to increase the success rate.
1017 R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO,
1018 database, network operations, service calls) in a critical section
1019 of code, so as to minimize blocking of other operations and increase
1020 concurrent throughput.
1022 R-63473 The VNF **MUST** automatically advertise newly scaled
1023 components so there is no manual intervention required.
1025 R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for
1026 both Service Chaining and scaling.
1028 R-41159 The VNF **MUST** deliver any and all functionality from any
1029 VNFC in the pool (where pooling is the most suitable solution). The
1030 VNFC pool member should be transparent to the client. Upstream and
1031 downstream clients should only recognize the function being performed,
1032 not the member performing it.
1034 R-85959 The VNF **SHOULD** automatically enable/disable added/removed
1035 sub-components or component so there is no manual intervention required.
1037 R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool
1038 without jeopardizing active sessions. Ideally, an active session should
1039 not be tied to any particular VNFC instance.
1041 R-12538 The VNF **SHOULD** support load balancing and discovery
1042 mechanisms in resource pools containing VNFC instances.
1044 R-98989 The VNF **SHOULD** utilize resource pooling (threads,
1045 connections, etc.) within the VNF application so that resources
1046 are not being created and destroyed resulting in resource management
1049 R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when
1050 initialization includes loading catalogues and/or lists which can grow
1051 over time, so that the VNF startup time does not grow at a rate
1052 proportional to that of the list.
1054 R-35532 The VNF **SHOULD** release and clear all shared assets (memory,
1055 database operations, connections, locks, etc.) as soon as possible,
1056 especially before long running sync and asynchronous operations, so as
1057 to not prevent use of these assets by other entities.
1059 R-77334 The VNF **MUST** allow configurations and configuration parameters
1060 to be managed under version control to ensure consistent configuration
1061 deployment, traceability and rollback.
1063 R-99766 The VNF **MUST** allow configurations and configuration parameters
1064 to be managed under version control to ensure the ability to rollback to
1065 a known valid configuration.
1067 R-73583 The VNF **MUST** allow changes of configuration parameters
1068 to be consumed by the VNF without requiring the VNF or its sub-components
1069 to be bounced so that the VNF availability is not effected.
1071 R-21558 The VNF **SHOULD** use intelligent routing by having knowledge
1072 of multiple downstream/upstream endpoints that are exposed to it, to
1073 ensure there is no dependency on external services (such as load balancers)
1074 to switch to alternate endpoints.
1076 R-08315 The VNF **SHOULD** use redundant connection pooling to connect
1077 to any backend data source that can be switched between pools in an
1078 automated/scripted fashion to ensure high availability of the connection
1081 R-27995 The VNF **SHOULD** include control loop mechanisms to notify
1082 the consumer of the VNF of their exceeding SLA thresholds so the consumer
1083 is able to control its load against the VNF.
1085 R-73364 The VNF **MUST** support at least two major versions of the
1086 VNF software and/or sub-components to co-exist within production
1087 environments at any time so that upgrades can be applied across
1088 multiple systems in a staggered manner.
1090 R-02454 The VNF **MUST** support the existence of multiple major/minor
1091 versions of the VNF software and/or sub-components and interfaces that
1092 support both forward and backward compatibility to be transparent to
1093 the Service Provider usage.
1095 R-57855 The VNF **MUST** support hitless staggered/rolling deployments
1096 between its redundant instances to allow "soak-time/burn in/slow roll"
1097 which can enable the support of low traffic loads to validate the
1098 deployment prior to supporting full traffic loads.
1100 R-64445 The VNF **MUST** support the ability of a requestor of the
1101 service to determine the version (and therefore capabilities) of the
1102 service so that Network Cloud Service Provider can understand the
1103 capabilities of the service.
1105 R-56793 The VNF **MUST** test for adherence to the defined performance
1106 budgets at each layer, during each delivery cycle with delivered
1107 results, so that the performance budget is measured and the code
1108 is adjusted to meet performance budget.
1110 R-77667 The VNF **MUST** test for adherence to the defined performance
1111 budget at each layer, during each delivery cycle so that the performance
1112 budget is measured and feedback is provided where the performance budget
1115 R-49308 The VNF **SHOULD** test for adherence to the defined resiliency
1116 rating recommendation at each layer, during each delivery cycle with
1117 delivered results, so that the resiliency rating is measured and the
1118 code is adjusted to meet software resiliency requirements.
1120 R-16039 The VNF **SHOULD** test for adherence to the defined
1121 resiliency rating recommendation at each layer, during each
1122 delivery cycle so that the resiliency rating is measured and
1123 feedback is provided where software resiliency requirements are
1126 R-34957 The VNF **MUST** provide a method of metrics gathering for each
1127 layer's performance to identify/document variances in the allocations so
1128 they can be addressed.
1130 R-49224 The VNF **MUST** provide unique traceability of a transaction
1131 through its life cycle to ensure quick and efficient troubleshooting.
1133 R-52870 The VNF **MUST** provide a method of metrics gathering
1134 and analysis to evaluate the resiliency of the software from both
1135 a granular as well as a holistic standpoint. This includes, but is
1136 not limited to thread utilization, errors, timeouts, and retries.
1138 R-92571 The VNF **MUST** provide operational instrumentation such as
1139 logging, so as to facilitate quick resolution of issues with the VNF to
1140 provide service continuity.
1142 R-48917 The VNF **MUST** monitor for and alert on (both sender and
1143 receiver) errant, running longer than expected and missing file transfers,
1144 so as to minimize the impact due to file transfer errors.
1146 R-28168 The VNF **SHOULD** use an appropriately configured logging
1147 level that can be changed dynamically, so as to not cause performance
1148 degradation of the VNF due to excessive logging.
1150 R-87352 The VNF **SHOULD** utilize Cloud health checks, when available
1151 from the Network Cloud, from inside the application through APIs to check
1152 the network connectivity, dropped packets rate, injection, and auto failover
1153 to alternate sites if needed.
1155 R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all
1156 inter/intra-connectivity points in the VNF to provide an overall resiliency
1157 rating for the VNF to be incorporated into the software design and
1158 development of the VNF.
1163 R-23740 The VNF **MUST** accommodate the security principle of
1164 “least privilege” during development, implementation and operation.
1165 The importance of “least privilege” cannot be overstated and must be
1166 observed in all aspects of VNF development and not limited to security.
1167 This is applicable to all sections of this document.
1169 R-61354 The VNF **MUST** implement access control list for OA&M
1170 services (e.g., restricting access to certain ports or applications).
1172 R-85633 The VNF **MUST** implement Data Storage Encryption
1173 (database/disk encryption) for Sensitive Personal Information (SPI)
1174 and other subscriber identifiable data. Note: subscriber’s SPI/data
1175 must be encrypted at rest, and other subscriber identifiable data
1176 should be encrypted at rest. Other data protection requirements exist
1177 and should be well understood by the developer.
1179 R-92207 The VNF **SHOULD** implement a mechanism for automated and
1180 frequent "system configuration (automated provisioning / closed loop)"
1183 R-23882 The VNF **SHOULD** be scanned using both network scanning
1184 and application scanning security tools on all code, including underlying
1185 OS and related configuration. Scan reports shall be provided. Remediation
1186 roadmaps shall be made available for any findings.
1188 R-46986 The VNF **SHOULD** have source code scanned using scanning
1189 tools (e.g., Fortify) and provide reports.
1191 R-55830 The VNF **MUST** distribute all production code from NCSP
1192 internal sources only. No production code, libraries, OS images, etc.
1193 shall be distributed from publically accessible depots.
1195 R-99771 The VNF **MUST** provide all code/configuration files in a
1196 "Locked down" or hardened state or with documented recommendations for
1197 such hardening. All unnecessary services will be disabled. VNF provider
1198 default credentials, community strings and other such artifacts will be
1199 removed or disclosed so that they can be modified or removed during
1202 R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of
1203 traffic by application (dropping packets not belonging to the VPN) (i.e.,
1204 AVPN, IPSec VPN for Internet routes).
1206 R-33981 The VNF **SHOULD** interoperate with various access control
1207 mechanisms for the Network Cloud execution environment (e.g.,
1208 Hypervisors, containers).
1210 R-40813 The VNF **SHOULD** support the use of virtual trusted platform
1211 module, hypervisor security testing and standards scanning tools.
1213 R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that
1214 it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual
1215 routing and forwarding rules.
1217 R-26586 The VNF **SHOULD** support the ability to work with aliases
1218 (e.g., gateways, proxies) to protect and encapsulate resources.
1220 R-49956 The VNF **MUST** pass all access to applications (Bearer,
1221 signaling and OA&M) through various security tools and platforms from
1222 ACLs, stateful firewalls and application layer gateways depending on
1223 manner of deployment. The application is expected to function (and in
1224 some cases, interwork) with these security tools.
1226 R-69649 The VNF **MUST** have all vulnerabilities patched as soon
1227 as possible. Patching shall be controlled via change control process
1228 with vulnerabilities disclosed along with mitigation recommendations.
1230 R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification,
1231 authentication and access control of customer or VNF application users.
1233 R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with
1234 the requirements if not using the NCSP’s IDAM API, for identification,
1235 authentication and access control of OA&M and other system level
1238 R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1239 User-IDs and passwords to uniquely identify the user/application. VNF
1240 needs to have appropriate connectors to the Identity, Authentication
1241 and Authorization systems that enables access at OS, Database and
1242 Application levels as appropriate.
1244 R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide
1245 the ability to support Multi-Factor Authentication (e.g., 1st factor =
1246 Software token on device (RSA SecureID); 2nd factor = User Name+Password,
1247 etc.) for the users.
1249 R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1250 Role-Based Access Control to permit/limit the user/application to
1251 performing specific activities.
1253 R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1254 logging via ONAP for a historical view of “who did what and when”.
1256 R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt
1257 OA&M access (e.g., SSH, SFTP).
1259 R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce
1260 a configurable maximum number of Login attempts policy for the users.
1261 VNF provider must comply with "terminate idle sessions" policy.
1262 Interactive sessions must be terminated, or a secure, locking screensaver
1263 must be activated requiring authentication, after a configurable period
1264 of inactivity. The system-based inactivity timeout for the enterprise
1265 identity and access management system must also be configurable.
1267 R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1268 with the NCSP’s credential management policy.
1270 R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire
1271 passwords at regular configurable intervals.
1273 R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1274 with "password complexity" policy. When passwords are used, they shall
1275 be complex and shall at least meet the following password construction
1276 requirements: (1) be a minimum configurable number of characters in
1277 length, (2) include 3 of the 4 following types of characters:
1278 upper-case alphabetic, lower-case alphabetic, numeric, and special,
1279 (3) not be the same as the UserID with which they are associated or
1280 other common strings as specified by the environment, (4) not contain
1281 repeating or sequential characters or numbers, (5) not to use special
1282 characters that may have command functions, and (6) new passwords must
1283 not contain sequences of three or more characters from the previous
1286 R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1287 with "password changes (includes default passwords)" policy. Products
1288 will support password aging, syntax and other credential management
1289 practices on a configurable basis.
1291 R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1292 use of common third party authentication and authorization tools such
1295 R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1296 with "No Self-Signed Certificates" policy. Self-signed certificates
1297 must be used for encryption only, using specified and approved
1298 encryption protocols such as TLS 1.2 or higher or equivalent security
1299 protocols such as IPSec, AES.
1301 R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API,
1302 authenticate system to system communications where one system
1303 accesses the resources of another system, and must never conceal
1304 individual accountability.
1306 R-95105 The VNF **MUST** host connectors for access to the application
1309 R-45496 The VNF **MUST** host connectors for access to the OS
1310 (Operating System) layer.
1312 R-05470 The VNF **MUST** host connectors for access to the database layer.
1314 R-99174 The VNF **MUST** comply with Individual Accountability
1315 (each person must be assigned a unique ID) when persons or non-person
1316 entities access VNFs.
1318 R-42874 The VNF **MUST** comply with Least Privilege (no more
1319 privilege than required to perform job functions) when persons
1320 or non-person entities access VNFs.
1322 R-71787 The VNF **MUST** comply with Segregation of Duties (access to a
1323 single layer and no developer may access production without special
1324 oversight) when persons or non-person entities access VNFs.
1326 R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely.
1328 R-49945 The VNF **MUST** authorize VNF provider access through a
1329 client application API by the client application owner and the resource
1330 owner of the VNF before provisioning authorization through Role Based
1331 Access Control (RBAC), Attribute Based Access Control (ABAC), or other
1332 policy based mechanism.
1334 R-31751 The VNF **MUST** subject VNF provider access to privilege
1335 reconciliation tools to prevent access creep and ensure correct
1336 enforcement of access policies.
1338 R-34552 The VNF **MUST** provide or support the Identity and Access
1339 Management (IDAM) based threat detection data for OWASP Top 10.
1341 R-29301 The VNF **MUST** provide or support the Identity and Access
1342 Management (IDAM) based threat detection data for Password Attacks.
1344 R-72243 The VNF **MUST** provide or support the Identity and Access
1345 Management (IDAM) based threat detection data for Phishing / SMishing.
1347 R-58998 The VNF **MUST** provide or support the Identity and Access
1348 Management (IDAM) based threat detection data for Malware (Key Logger).
1350 R-14025 The VNF **MUST** provide or support the Identity and Access
1351 Management (IDAM) based threat detection data for Session Hijacking.
1353 R-31412 The VNF **MUST** provide or support the Identity and Access
1354 Management (IDAM) based threat detection data for XSS / CSRF.
1356 R-51883 The VNF **MUST** provide or support the Identity and Access
1357 Management (IDAM) based threat detection data for Replay.
1359 R-44032 The VNF **MUST** provide or support the Identity and Access
1360 Management (IDAM) based threat detection data for Man in the Middle (MITM).
1362 R-58977 The VNF **MUST** provide or support the Identity and Access
1363 Management (IDAM) based threat detection data for Eavesdropping.
1365 R-24825 The VNF **MUST** provide Context awareness data (device,
1366 location, time, etc.) and be able to integrate with threat detection system.
1368 R-59391 The VNF provider **MUST**, where a VNF provider requires
1369 the assumption of permissions, such as root or administrator, first
1370 log in under their individual user login ID then switch to the other
1371 higher level account; or where the individual user login is infeasible,
1372 must login with an account with admin privileges in a way that
1373 uniquely identifies the individual performing the function.
1375 R-85028 The VNF **MUST** authenticate system to system access and
1376 do not conceal a VNF provider user’s individual accountability for
1379 R-80335 The VNF **MUST** make visible a Warning Notice: A formal
1380 statement of resource intent, i.e., a warning notice, upon initial
1381 access to a VNF provider user who accesses private internal networks
1382 or Company computer resources, e.g., upon initial logon to an internal
1383 web site, system or application which requires authentication.
1385 R-73541 The VNF **MUST** use access controls for VNFs and their
1386 supporting computing systems at all times to restrict access to
1387 authorized personnel only, e.g., least privilege. These controls
1388 could include the use of system configuration or access control
1391 R-64503 The VNF **MUST** provide minimum privileges for initial
1392 and default settings for new user accounts.
1394 R-86835 The VNF **MUST** set the default settings for user access
1395 to sensitive commands and data to deny authorization.
1397 R-77157 The VNF **MUST** conform to approved request, workflow
1398 authorization, and authorization provisioning requirements when
1399 creating privileged users.
1401 R-81147 The VNF **MUST** have greater restrictions for access and
1402 execution, such as up to 3 factors of authentication and restricted
1403 authorization, for commands affecting network services, such as
1404 commands relating to VNFs.
1406 R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2)
1407 transmission of data on internal and external networks.
1409 R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs.
1411 R-15671 The VNF **MUST NOT** provide public or unrestricted access
1412 to any data without the permission of the data owner. All data
1413 classification and access controls must be followed.
1415 R-89753 The VNF **MUST NOT** install or use systems, tools or
1416 utilities capable of capturing or logging data that was not created
1417 by them or sent specifically to them in production, without
1418 authorization of the VNF system owner.
1420 R-19082 The VNF **MUST NOT** run security testing tools and
1421 programs, e.g., password cracker, port scanners, hacking tools
1422 in production, without authorization of the VNF system owner.
1424 R-19790 The VNF **MUST NOT** include authentication credentials
1425 in security audit logs, even if encrypted.
1427 R-85419 The VNF **SHOULD** use REST APIs exposed to Client
1428 Applications for the implementation of OAuth 2.0 Authorization
1429 Code Grant and Client Credentials Grant, as the standard interface
1432 R-86455 The VNF **SHOULD** support hosting connectors for OS
1433 Level and Application Access.
1435 R-48080 The VNF **SHOULD** support SCEP (Simple Certificate
1436 Enrollment Protocol).
1438 R-37608 The VNF **MUST** provide a mechanism to restrict access based
1439 on the attributes of the VNF and the attributes of the subject.
1441 R-43884 The VNF **MUST** integrate with external authentication
1442 and authorization services (e.g., IDAM).
1444 R-25878 The VNF **MUST** use certificates issued from publicly
1445 recognized Certificate Authorities (CA) for the authentication process
1446 where PKI-based authentication is used.
1448 R-19804 The VNF **MUST** validate the CA signature on the certificate,
1449 ensure that the date is within the validity period of the certificate,
1450 check the Certificate Revocation List (CRL), and recognize the identity
1451 represented by the certificate where PKI-based authentication is used.
1453 R-47204 The VNF **MUST** protect the confidentiality and integrity of
1454 data at rest and in transit from unauthorized access and modification.
1456 R-33488 The VNF **MUST** protect against all denial of service
1457 attacks, both volumetric and non-volumetric, or integrate with external
1458 denial of service protection tools.
1460 R-21652 The VNF **MUST** implement the following input validation
1461 control: Check the size (length) of all input. Do not permit an amount
1462 of input so great that it would cause the VNF to fail. Where the input
1463 may be a file, the VNF API must enforce a size limit.
1465 R-54930 The VNF **MUST** implement the following input validation
1466 control: Do not permit input that contains content or characters
1467 inappropriate to the input expected by the design. Inappropriate input,
1468 such as SQL insertions, may cause the system to execute undesirable
1469 and unauthorized transactions against the database or allow other
1470 inappropriate access to the internal network.
1472 R-21210 The VNF **MUST** implement the following input validation
1473 control: Validate that any input file has a correct and valid
1474 Multipurpose Internet Mail Extensions (MIME) type. Input files
1475 should be tested for spoofed MIME types.
1477 R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs.
1479 R-87135 The VNF **MUST** comply with NIST standards and industry
1480 best practices for all implementations of cryptography.
1482 R-02137 The VNF **MUST** implement all monitoring and logging as
1483 described in the Security Analytics section.
1485 R-15659 The VNF **MUST** restrict changing the criticality level of
1486 a system security alarm to administrator(s).
1488 R-19367 The VNF **MUST** monitor API invocation patterns to detect
1489 anomalous access patterns that may represent fraudulent access or
1490 other types of attacks, or integrate with tools that implement anomaly
1491 and abuse detection.
1493 R-78066 The VNF **MUST** support requests for information from law
1494 enforcement and government agencies.
1496 R-48470 The VNF **MUST** support Real-time detection and
1497 notification of security events.
1499 R-22286 The VNF **MUST** support Integration functionality via
1500 API/Syslog/SNMP to other functional modules in the network (e.g.,
1501 PCRF, PCEF) that enable dynamic security control by blocking the
1502 malicious traffic or malicious end users.
1504 R-32636 The VNF **MUST** support API-based monitoring to take care of
1505 the scenarios where the control interfaces are not exposed, or are
1506 optimized and proprietary in nature.
1508 R-61648 The VNF **MUST** support event logging, formats, and delivery
1509 tools to provide the required degree of event data to ONAP.
1511 R-22367 The VNF **MUST** support detection of malformed packets due to
1512 software misconfiguration or software vulnerability.
1514 R-31961 The VNF **MUST** support integrated DPI/monitoring functionality
1515 as part of VNFs (e.g., PGW, MME).
1517 R-20912 The VNF **MUST** support alternative monitoring capabilities
1518 when VNFs do not expose data or control traffic or use proprietary and
1519 optimized protocols for inter VNF communication.
1521 R-73223 The VNF **MUST** support proactive monitoring to detect and
1522 report the attacks on resources so that the VNFs and associated VMs can
1523 be isolated, such as detection techniques for resource exhaustion, namely
1524 OS resource attacks, CPU attacks, consumption of kernel memory, local
1527 R-58370 The VNF **MUST** coexist and operate normally with commercial
1528 anti-virus software which shall produce alarms every time when there is a
1531 R-56920 The VNF **MUST** protect all security audit logs (including
1532 API, OS and application-generated logs), security audit software, data,
1533 and associated documentation from modification, or unauthorized viewing,
1534 by standard OS access control mechanisms, by sending to a remote system,
1537 R-54520 The VNF **MUST** log successful and unsuccessful login attempts.
1539 R-55478 The VNF **MUST** log logoffs.
1541 R-08598 The VNF **MUST** log successful and unsuccessful changes to
1544 R-13344 The VNF **MUST** log starting and stopping of security
1547 R-07617 The VNF **MUST** log creating, removing, or changing the
1548 inherent privilege level of users.
1550 R-94525 The VNF **MUST** log connections to a network listener of the
1553 R-31614 The VNF **MUST** log the field “event type” in the security
1556 R-97445 The VNF **MUST** log the field “date/time” in the security
1559 R-25547 The VNF **MUST** log the field “protocol” in the security audit logs.
1561 R-06413 The VNF **MUST** log the field “service or program used for
1562 access” in the security audit logs.
1564 R-15325 The VNF **MUST** log the field “success/failure” in the
1565 security audit logs.
1567 R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs.
1569 R-04982 The VNF **MUST NOT** include an authentication credential,
1570 e.g., password, in the security audit logs, even if encrypted.
1572 R-63330 The VNF **MUST** detect when the security audit log storage
1573 medium is approaching capacity (configurable) and issue an alarm via
1574 SMS or equivalent as to allow time for proper actions to be taken to
1575 pre-empt loss of audit data.
1577 R-41252 The VNF **MUST** support the capability of online storage of
1578 security audit logs.
1580 R-41825 The VNF **MUST** activate security alarms automatically when
1581 the following event is detected: configurable number of consecutive
1582 unsuccessful login attempts
1584 R-43332 The VNF **MUST** activate security alarms automatically when
1585 the following event is detected: successful modification of critical
1586 system or application files
1588 R-74958 The VNF **MUST** activate security alarms automatically when
1589 the following event is detected: unsuccessful attempts to gain permissions
1590 or assume the identity of another user
1592 R-15884 The VNF **MUST** include the field “date” in the Security alarms
1593 (where applicable and technically feasible).
1595 R-23957 The VNF **MUST** include the field “time” in the Security alarms
1596 (where applicable and technically feasible).
1598 R-71842 The VNF **MUST** include the field “service or program used for
1599 access” in the Security alarms (where applicable and technically feasible).
1601 R-57617 The VNF **MUST** include the field “success/failure” in the
1602 Security alarms (where applicable and technically feasible).
1604 R-99730 The VNF **MUST** include the field “Login ID” in the Security
1605 alarms (where applicable and technically feasible).
1607 R-29705 The VNF **MUST** restrict changing the criticality level of a
1608 system security alarm to administrator(s).
1610 R-13627 The VNF **MUST** monitor API invocation patterns to detect
1611 anomalous access patterns that may represent fraudulent access or other
1612 types of attacks, or integrate with tools that implement anomaly and
1615 R-21819 The VNF **MUST** support requests for information from law
1616 enforcement and government agencies.
1618 R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation
1619 (without human intervention) for Known Threats with detection rate in low
1622 R-25094 The VNF **MUST** perform data capture for security functions.
1624 R-04492 The VNF **MUST** generate security audit logs that must be sent
1625 to Security Analytics Tools for analysis.
1627 R-19219 The VNF **MUST** provide audit logs that include user ID, dates,
1628 times for log-on and log-off, and terminal location at minimum.
1630 R-30932 The VNF **MUST** provide security audit logs including records
1631 of successful and rejected system access data and other resource access
1634 R-54816 The VNF **MUST** support the storage of security audit logs
1635 for agreed period of time for forensic analysis.
1637 R-57271 The VNF **MUST** provide the capability of generating security
1638 audit logs by interacting with the operating system (OS) as appropriate.
1640 R-84160 The VNF **MUST** have security logging for VNFs and their
1641 OSs be active from initialization. Audit logging includes automatic
1642 routines to maintain activity records and cleanup programs to ensure
1643 the integrity of the audit/logging systems.
1645 R-58964 The VNF **MUST** provide the capability to restrict read
1646 and write access to data.
1648 R-99112 The VNF **MUST** provide the capability to restrict access
1649 to data to specific users.
1651 R-83227 The VNF **MUST** Provide the capability to encrypt data in
1652 transit on a physical or virtual network.
1654 R-32641 The VNF **MUST** provide the capability to encrypt data on
1655 non-volatile memory.
1657 R-13151 The VNF **SHOULD** disable the paging of the data requiring
1658 encryption, if possible, where the encryption of non-transient data is
1659 required on a device for which the operating system performs paging to
1660 virtual memory. If not possible to disable the paging of the data
1661 requiring encryption, the virtual memory should be encrypted.
1663 R-93860 The VNF **MUST** provide the capability to integrate with an
1664 external encryption service.
1666 R-73067 The VNF **MUST** use industry standard cryptographic algorithms
1667 and standard modes of operations when implementing cryptography.
1669 R-22645 The VNF **SHOULD** use commercial algorithms only when there
1670 are no applicable governmental standards for specific cryptographic
1671 functions, e.g., public key cryptography, message digests.
1673 R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and
1674 Skipjack algorithms or other compromised encryption.
1676 R-02170 The VNF **MUST** use, whenever possible, standard implementations
1677 of security applications, protocols, and format, e.g., S/MIME, TLS, SSH,
1678 IPSec, X.509 digital certificates for cryptographic implementations.
1679 These implementations must be purchased from reputable vendors and must
1680 not be developed in-house.
1682 R-70933 The VNF **MUST** provide the ability to migrate to newer
1683 versions of cryptographic algorithms and protocols with no impact.
1685 R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length.
1687 R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length.
1689 R-95864 The VNF **MUST** use commercial tools that comply with X.509
1690 standards and produce x.509 compliant keys for public/private key generation.
1692 R-12110 The VNF **MUST NOT** use keys generated or derived from
1693 predictable functions or values, e.g., values considered predictable
1694 include user identity information, time of day, stored/transmitted data.
1696 R-52060 The VNF **MUST** provide the capability to configure encryption
1697 algorithms or devices so that they comply with the laws of the jurisdiction
1698 in which there are plans to use data encryption.
1700 R-69610 The VNF **MUST** provide the capability of using certificates
1701 issued from a Certificate Authority not provided by the VNF provider.
1703 R-83500 The VNF **MUST** provide the capability of allowing certificate
1704 renewal and revocation.
1706 R-29977 The VNF **MUST** provide the capability of testing the validity
1707 of a digital certificate by validating the CA signature on the certificate.
1709 R-24359 The VNF **MUST** provide the capability of testing the validity
1710 of a digital certificate by validating the date the certificate is being
1711 used is within the validity period for the certificate.
1713 R-39604 The VNF **MUST** provide the capability of testing the
1714 validity of a digital certificate by checking the Certificate Revocation
1715 List (CRL) for the certificates of that type to ensure that the
1716 certificate has not been revoked.
1718 R-75343 The VNF **MUST** provide the capability of testing the
1719 validity of a digital certificate by recognizing the identity represented
1720 by the certificate — the "distinguished name".
1725 R-37028 The VNF **MUST** be composed of one “base” module.
1727 R-41215 The VNF **MAY** have zero to many “incremental” modules.
1729 R-20974 The VNF **MUST** deploy the base module first, prior to
1730 the incremental modules.
1732 R-11200 The VNF **MUST** keep the scope of a Cinder volume module,
1733 when it exists, to be 1:1 with the VNF Base Module or Incremental Module.
1735 R-38474 The VNF **MUST** have a corresponding environment file for
1738 R-81725 The VNF **MUST** have a corresponding environment file for
1739 an Incremental Module.
1741 R-53433 The VNF **MUST** have a corresponding environment file for
1742 a Cinder Volume Module.
1747 R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU
1748 architectures and families, virtual machines, etc.
1750 R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud
1751 (such as hardware, host OS, Hypervisor or container technology) and must run
1752 on the Network Cloud with acknowledgement to the paradigm that the Network
1753 Cloud will continue to rapidly evolve and the underlying components of
1754 the platform will change regularly.
1756 R-33846 The VNF **MUST** install the NCSP required software on Guest OS
1757 images when not using the NCSP provided Guest OS images. [5]_
1759 R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [5]_
1761 R-02997 The VNF **MUST** preserve their persistent data. Running VMs
1762 will not be backed up in the Network Cloud infrastructure.
1764 R-29760 The VNFC **MUST** be installed on non-root file systems,
1765 unless software is specifically included with the operating system
1766 distribution of the guest image.
1768 R-20860 The VNF **MUST** be agnostic to the underlying infrastructure
1769 (such as hardware, host OS, Hypervisor), any requirements should be
1770 provided as specification to be fulfilled by any hardware.
1772 R-89800 The VNF **MUST NOT** require Hypervisor-level customization
1773 from the cloud provider.
1775 R-86758 The VNF **SHOULD** provide an automated test suite to validate
1776 every new version of the software on the target environment(s). The tests
1777 should be of sufficient granularity to independently test various
1778 representative VNF use cases throughout its lifecycle. Operations might
1779 choose to invoke these tests either on a scheduled basis or on demand to
1780 support various operations functions including test, turn-up and
1783 R-39650 The VNF **SHOULD** provide the ability to test incremental
1786 R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command
1787 against a specific VNFC, moving all existing session elsewhere with
1788 minimal disruption if a VNF provides a load balancing function across
1789 multiple instances of its VNFCs. Note: Individual VNF performance
1790 aspects (e.g., move duration or disruption scope) may require further
1793 R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against
1794 a specific VNFC, preventing new session from reaching the targeted VNFC,
1795 with no disruption to active sessions on the impacted VNFC, if a VNF
1796 provides a load balancing function across multiple instances of its VNFCs.
1797 This is used to support scenarios such as proactive maintenance with no
1800 R-64713 The VNF **SHOULD** support a software promotion methodology
1801 from dev/test -> pre-prod -> production in software, development &
1802 testing and operations.
1804 **VNF Modeling Requirements**
1805 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1810 R-43125 The VNF Heat **MUST** indent properties and lists with 1 or
1813 R-67888 The VNF Heat **MUST** contain the following
1816 - heat\_template\_version:
1821 R-39402 The VNF Heat **MUST** contain the description section.
1823 R-35414 The VNF Heat **MUST** contain the parameter section.
1825 R-90279 The VNF Heat **MUST** use in a resource all parameters declared in
1826 a template except for the parameters for the OS::Nova::Server property
1827 availability\_zone. See Property: availability\_zone. for more details on
1830 R-28657 The VNF Heat **MUST** provide the attribute 'type' on
1831 parameters per the OpenStack Heat Orchestration Template standard.
1833 R-44001 The VNF Heat **MUST** provide the attribute 'description'
1834 on parameters. (Note that this attribute is OpenStack optional.)
1836 R-90526 The VNF Heat **MUST NOT** use the attribute 'default'.
1837 If a parameter has a default value, it must be provided in
1838 the environment file. (Note that this attribute is OpenStack
1841 R-88863 The VNF Heat **MUST** have a constraint of range or
1842 allowed\_values for a parameter type 'number'.
1844 - range: The range constraint applies to parameters of type number.
1845 It defines a lower and upper limit for the numeric value of the
1846 parameter. The syntax of the range constraint is
1848 R-23664 The VNF Heat **MUST** have a resources: section with the
1849 declaration of at least one resource.
1851 R-16447 The VNF Heat **MUST** have unique resource IDs across all Heat
1852 Orchestration Templates that compose the VNF. This requirement
1853 also applies when a VNF is composed of more than one Heat
1854 Orchestration Template (see ONAP VNF Modularity Overview).
1856 R-97199 The VNF Heat **MUST** use the metadata property for
1857 OS::Nova::Server resource type.
1859 R-03324 The VNF Heat **MUST** contain the following sections in the
1864 R-19473 The VNF Heat **MUST** include “base” in the filename for the
1867 R-81339 The VNF Heat **MUST** match one of the following options for
1868 the base module file name:
1870 - base\_<text>.y[a]ml
1871 - <text>\_base.y[a]ml
1873 - <text>\_base\_<text>.y[a]ml
1875 R-91342 The VNF Heat **MUST** name the base module’s corresponding
1876 environment file to be identical to the base module with “.y[a]ml”
1877 replaced with “.env”.
1879 R-87247 The VNF Heat **MUST NOT** use any special characters or the
1880 word “base” in the name of the incremental module.
1884 R-94509 The VNF Heat **MUST** name the incremental module’s
1885 corresponding environment file to be identical to the incremental
1886 module with “.y[a]ml” replaced with “.env”.
1888 R-82732 The VNF Heat **MUST** name the Cinder volume module file name
1889 to be the same as the corresponding module it is supporting (base
1890 module or incremental module) with “\_volume” appended.
1892 - <base module name>\_volume.y[a]ml
1893 - <incremental module name>\_volume.y[a]ml
1895 R-31141 The VNF Heat **MUST** name the volume module’s corresponding
1896 environment file to be identical to the volume module with “.y[a]ml”
1897 replaced with “.env”.
1899 R-76057 The VNF Heat **MUST NOT** use special characters
1900 or the word “base” in the file name for the nested template.
1902 R-18224 The VNF Heat **MUST** pass in as properties all parameter values
1903 associated with the nested heat file in the resource definition defined
1904 in the parent heat template.
1906 R-07443 The VNF Heat **MUST** match the Output parameter name and type with
1907 the input parameter name and type unless the Output parameter is of the
1908 type comma\_delimited\_list.
1910 R-23983 The VNF **MUST** pass the external networks into the VNF Heat
1911 Orchestration Templates as parameters.
1913 - Neutron Network-id (UUID)
1914 - Neutron Network subnet ID (UUID)
1915 - Contrail Network Fully Qualified Domain Name (FQDN)
1917 R-63345 The VNF Heat **MUST** pass the appropriate external
1918 network IDs into nested VM templates when nested Heat is used.
1920 R-35666 The VNF Heat **MUST** include the resource(s) to
1921 create the internal network. The internal network must be either a
1922 Neutron Network or a Contrail Network.
1924 R-86972 The VNF Heat **MUST** create internal networks in the Base
1925 Module, in the modular approach, with their resource IDs exposed as outputs
1926 (i.e., ONAP Base Module Output Parameters) for use by all incremental
1927 modules. If the Network resource ID is required in the base template,
1928 then a get\_resource must be used.
1930 R-68936 The VNF Heat **SHOULD** assign a unique
1931 {network-role} in the context of the VNF, when the internal network is
1932 created. ONAP Resource ID and Parameter Naming Convention provides
1935 R-01455 The VNF Heat **MUST** assign a VNF unique
1936 {vm-type} for each Virtual Machine type (i.e., OS::Nova::Server)
1937 instantiated in the VNF. While the {vm-type} must be unique to the VNF,
1938 it does not have to be globally unique across all VNFs that ONAP
1941 R-82481 The VNF Heat **MUST** include {vm-type} as part of the parameter name
1942 for any parameter that is associated with a unique Virtual Machine type.
1944 R-66729 The VNF Heat **MUST** include {vm-type} as part of the resource ID
1945 for any resource ID that is associated with a unique Virtual Machine type in
1948 R-32394 The VNF Heat **MUST** use the same case for {vm-type} for all
1949 parameter names in the VNF.
1951 R-46839 The VNF Heat **MUST** use the same case for {vm-type} for all
1952 Resource IDs in the VNF.
1954 R-05008 The VNF Heat **MUST NOT** be prefixed with a common
1955 {vm-type} identifier for the six ONAP Metadata parameters.
1956 They are *vnf\_name*, *vnf\_id*, *vf\_module\_id*, *vf\_module\_name*,
1957 *vm\_role*. The ONAP Metadata parameters are described in
1958 Resource: OS::Nova::Server – Metadata Parameters.
1960 R-15422 The VNF Heat **MUST NOT** be prefixed with a common {vm-type}
1961 identifier the parameter referring to the OS::Nova::Server property
1962 availability\_zone. availability\_zone is described in
1963 Property: ailability_zone.
1965 R-21330 The VNF Heat **MUST** include the {network-role} as part of the
1966 parameter name for any parameter that is associated with an external network.
1968 R-11168 The VNF Heat **MUST** include the {network-role} as part of the
1969 resource ID for any resource ID that is associated with an external network
1972 R-84322 The VNF Heat **MUST** include int\_{network-role} as part of the
1973 parameter name for any parameter that is associated with an internal network.
1975 R-96983 The VNF Heat **MUST** include int\_{network-role} as part of the
1976 resource ID for any resource ID that is associated with an internal network.
1978 R-58424 The VNF Heat **MUST** use the same case for {network-role} for
1979 all parameter names in the VNF.
1981 R-21511 The VNF Heat **MUST** use the same case for {network-role} for
1982 all Resource IDs in the VNF.
1984 R-59629 The VNF Heat **MUST** have unique resource IDs within the
1985 resources section of a Heat Orchestration Template. This is an
1986 OpenStack Requirement.
1988 R-43319 The VNF Heat **MUST** have unique resource IDs
1989 across all modules that compose the VNF,
1990 when a VNF is composed of more than one Heat Orchestration Template
1993 R-54517 The VNF Heat **MUST** include {vm-type} in the resource ID
1994 when a resource is associated with a single {vm-type}.
1996 R-96482 The VNF Heat **MUST** include {network-role} in the resource ID
1997 when a resource is associated with a single external network.
1999 R-98138 The VNF Heat **MUST** include int\_{network-role} in the resource ID
2000 when a resource is associated with a single internal network.
2002 R-82115 The VNF Heat **MUST** include both the {vm-type} and
2003 {network-role} in the resource ID,
2004 when a resource is associated with a single {vm-type} and a single
2007 - The {vm-type} must appear before the {network-role} and must be
2008 separated by an underscore (i.e., {vm-type}\_{network-role}).
2009 - Note that an {index} value may separate the {vm-type} and the
2010 {network-role}. An underscore will separate the three values (i.e.,
2011 {vm-type}\_{index}\_{network-role}).
2013 R-82551 The VNF Heat **MUST** include both the {vm-type} and
2014 int\_{network-role} in the resource ID,
2015 when a resource is associated with a single {vm-type} and a single
2018 - The {vm-type} must appear before the int\_{network-role} and must be
2019 separated by an underscore (i.e., {vm-type}\_int\_{network-role}).
2020 - Note that an {index} value may separate the {vm-type} and the
2021 int\_{network-role}. An underscore will separate the three values
2022 (i.e., {vm-type}\_{index}\_int\_{network-role}).
2024 R-69287 The VNF Heat **MUST** use only alphanumeric characters and “\_”
2025 underscores in the resource ID. Special characters must not be used.
2027 R-71152 The VNF Heat **MUST** declare as type: string the parameter
2030 R-91125 The VNF Heat **MUST** enumerate the parameter for property
2031 image in the Heat Orchestration Template environment file.
2033 R-57282 The VNF Heat **MUST** have a separate parameter for image for
2034 Each VM type (i.e., {vm-type}) even if more than one {vm-type} shares
2035 the same image. This provides maximum clarity and flexibility.
2037 R-50436 The VNF Heat **MUST** declare the parameter property for
2038 flavor as type: string.
2040 R-69431 The VNF Heat **MUST** enumerate the parameter for property
2041 flavor in the Heat Orchestration Template environment file.
2043 R-40499 The VNF Heat **MUST** have a separate parameter for flavor for each
2044 VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same
2045 flavor. This provides maximum clarity and flexibility.
2047 R-22838 The VNF Heat **MUST NOT** enumerate the parameter for property name
2048 in the environment file.
2050 R-51430 The VNF Heat **MUST** declare the parameter for property name as
2051 type: string or type: comma\_delimited\_list
2053 R-98450 The VNF Heat **MUST** name the parameter availability\_zone\_{index}
2054 in the Heat Orchestration Template.
2056 R-13561 The VNF Heat **MUST** start the {index} at zero.
2058 R-60204 The VNF Heat **MUST** increment the {index} by one.
2060 R-36887 The VNF Heat **MUST NOT** include the {vm-type} in the parameter name.
2062 R-17020 The VNF Heat **MUST** include the following three mandatory
2063 metadata parameters for an OS::Nova::Server resource:
2069 R-55218 The VNF Heat **MUST NOT** have parameter constraints defined
2070 for the OS::Nova::Server metadata parameter vnf\_id.
2072 R-20856 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2073 metadata parameter vnf\_id in environment file.
2075 R-98374 The VNF Heat **MUST NOT** have parameter constraints
2076 defined for the OS::Nova::Server metadata parameter vf\_module\_id.
2078 R-72871 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2079 metadata parameter vf\_module\_id in environment file.
2081 R-44318 The VNF Heat **MUST NOT** have parameter constraints defined
2082 for the OS::Nova::Server metadata parameter vnf\_name.
2084 R-36542 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
2085 metadata parameter vnf\_name in the environment file.
2087 R-72050 The VNF Heat **MUST** contain {network-role} in the parameter name
2089 R-57576 The VNF Heat **MUST** contain int\_{network-role}
2090 in the parameter name.
2092 R-93272 The VNF Heat **MUST** adhere to the following parameter naming
2093 convention in the Heat Orchestration Template, when the parameter
2094 associated with the property network is referencing an “external” network:
2096 - {network-role}\_net\_id for the Neutron network ID
2097 - {network-role}\_net\_name for the network name in OpenStack
2099 R-65373 The VNF Heat **MUST** adhere to the following parameter naming
2100 convention, when the parameter associated with the property network is
2101 referencing an “internal” network:
2103 - int\_{network-role}\_net\_id for the Neutron network ID
2104 - int\_{network-role}\_net\_name for the network name in OpenStack
2106 R-47716 The VNF Heat **MUST** adhere to the following parameter naming
2107 convention for the property fixed\_ips and Map Property subnet\_id
2108 parameter, when the parameter is referencing a subnet of an
2111 - {network-role}\_subnet\_id if the subnet is an IPv4 subnet
2112 - {network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
2114 R-20106 The VNF Heat **MUST** adhere to the following naming convention for
2115 the property fixed\_ips and Map Property subnet\_id parameter,
2116 when the parameter is referencing the subnet of an “internal” network:
2118 - int\_{network-role}\_subnet\_id if the subnet is an IPv4 subnet
2119 - int\_{network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
2121 R-41177 The VNF Heat **MUST** include {vm-type} and {network-role}
2122 in the parameter name, when a SDN-C IP assignment is made to a
2123 port connected to an external network.
2125 R-84898 The VNF Heat **MUST** adhere to the following naming convention,
2126 when the parameter for property fixed\_ips and Map Property ip\_address
2127 is declared type: comma\_delimited\_list:
2129 - {vm-type}\_{network-role}\_ips for IPv4 address
2130 - {vm-type}\_{network-role}\_v6\_ips for IPv6 address
2132 R-34960 The VNF Heat **MUST** adhere to the following
2134 when the parameter for property fixed\_ips and Map Property ip\_address
2135 is declared type: string:
2137 - {vm-type}\_{network-role}\_ip\_{index} for an IPv4 address
2138 - {vm-type}\_{network-role}\_v6\_ip\_{index} for an IPv6 address
2140 R-62584 The VNF Heat **MUST** adhere to
2141 the following naming convention,
2142 when the parameter for property fixed\_ips and Map Property ip\_address
2143 is declared type: comma\_delimited\_list:
2145 - {vm-type}\_int\_{network-role}\_ips for IPv4 address
2146 - {vm-type}\_int\_{network-role}\_v6\_ips for IPv6 address
2148 R-29256 The VNF Heat **MUST** must adhere to the following
2150 when the parameter for property fixed\_ips and Map Property ip\_address
2151 is declared type: string:
2153 - {vm-type}\_int\_{network-role}\_ip\_{index} for an IPv4 address
2154 - {vm-type}\_int\_{network-role}\_v6\_ip\_{index} for an IPv6 address
2156 R-61282 The VNF Heat **MUST**
2157 adhere to the following naming convention for the property
2158 allowed\_address\_pairs and Map Property ip\_address parameter,
2159 when the parameter is referencing an “external” network:
2161 - {vm-type}\_{network-role}\_floating\_ip for an IPv4 address
2162 - {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address
2164 R-16805 The VNF Heat **MUST** adhere to the following naming convention
2165 for the property allowed\_address\_pairs and Map Property ip\_address
2166 parameter when the parameter is referencing an “internal” network.
2168 - {vm-type}\_int\_{network-role}\_floating\_ip for an IPv4 address
2169 - {vm-type}\_int\_{network-role}\_floating\_v6\_ip for an IPv6 address
2171 R-85734 The VNF Heat **MUST** use the intrinsic function str\_replace
2172 in conjunction with the ONAP supplied metadata parameter
2173 vnf\_name to generate a unique value,
2174 when the property name for a non OS::Nova::Server resources is defined
2175 in a Heat Orchestration Template.
2177 R-47788 The VNF Heat **MUST** have a 1:1 scope of a cinder volume module,
2178 when it exists, with the Base Module or Incremental Module
2180 R-79531 The VNF Heat **MUST** define “outputs” in the volume
2181 template for each Cinder volume resource universally unique
2182 identifier (UUID) (i.e. ONAP Volume Template Output Parameters).
2184 R-86285 The VNF Heat **MUST** have a
2185 corresponding environment file, even if no parameters are required to be
2188 R-67205 The VNF Heat **MUST** have a corresponding
2189 environment file for a Base Module.
2191 R-35727 The VNF Heat **MUST** have a
2192 corresponding environment file for an Incremental module.
2194 R-22656 The VNF Heat **MUST** have a corresponding environment file
2195 for a Cinder Volume Module.
2197 R-89868 The VNF Heat **MUST** have unique file names within the scope
2198 of the VNF for a nested heat yaml file.
2200 R-52530 The VNF Heat **MUST NOT** use a directory hierarchy for
2201 nested templates. All templates must be in a single, flat directory
2204 R-11041 The VNF Heat **MUST** have the resource calling the
2205 nested yaml file pass in as properties all parameters defined
2206 in nested yaml file.
2208 R-61183 The VNF Heat **MUST NOT** change the parameter names, when
2209 OS::Nova::Server metadata parameters are past into a nested heat template.
2211 R-76718 The VNF Heat **MUST** reference the get\_files targets in
2212 Heat templates by file name, and the corresponding files should be
2213 delivered to ONAP along with the Heat templates.
2215 R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval.
2217 R-62177 The VNF Heat **MUST** have unique file names for the included
2218 files within the scope of the VNF.
2220 R-87848 The VNF Heat **MUST** have all included files in a single, flat
2221 directory per VNF. ONAP does not support a directory hierarchy.
2223 - Included files may be used by all Modules within a given VNF.
2224 - get\_file directives may be used in both non-nested and nested
2227 **ONAP Management Requirements**
2228 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2231 VNF On-boarding and package management
2232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2235 R-77707 The VNF provider **MUST** include a Manifest File that
2236 contains a list of all the components in the VNF package.
2238 R-66070 The xNF Package **MUST** include xNF Identification Data to
2239 uniquely identify the resource for a given xNF provider. The identification
2240 data must include: an identifier for the xNF, the name of the xNF as was
2241 given by the xNF provider, xNF description, xNF provider, and version.
2243 R-69565 The xNF Package **MUST** include documentation describing
2244 xNF Management APIs. The document must include information and
2247 - ONAP to deploy and configure (initially and ongoing) the xNF
2248 application(s) (e.g., NETCONF APIs). Includes description of
2249 configurable parameters for the xNF and whether the parameters
2250 can be configured after xNF instantiation.
2251 - ONAP to monitor the health of the xNF (conditions that require
2252 healing and/or scaling responses). Includes a description of:
2254 - Parameters that can be monitored for the xNF and event records
2255 (status, fault, flow, session, call, control plane, etc.) generated
2256 by the xNF after instantiation.
2257 - Runtime lifecycle events and related actions (e.g., control
2258 responses, tests) which can be performed for the xNF.
2260 R-84366 The xNF Package **MUST** include documentation describing
2261 xNF Functional APIs that are utilized to build network and
2262 application services. This document describes the externally exposed
2263 functional inputs and outputs for the xNF, including interface
2264 format and protocols supported.
2266 R-36280 The xNF provider **MUST** provide documentation describing
2267 xNF Functional Capabilities that are utilized to operationalize the
2268 xNF and compose complex services.
2270 R-98617 The xNF provider **MUST** provide information regarding any
2271 dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
2273 R-89571 The xNF **MUST** support and provide artifacts for
2274 configuration management using at least one of the following
2281 R-30278 The xNF provider **MUST** provide a Resource/Device YANG model
2282 as a foundation for creating the YANG model for configuration. This will
2283 include xNF attributes/parameters and valid values/attributes configurable
2286 R-13390 The xNF provider **MUST** provide cookbooks to be loaded
2287 on the appropriate Chef Server.
2289 R-18525 The xNF provider **MUST** provide a JSON file for each
2290 supported action for the xNF. The JSON file must contain key value
2291 pairs with all relevant values populated with sample data that illustrates
2292 its usage. The fields and their description are defined in Appendix A.
2294 R-75608 The xNF provider **MUST** provide playbooks to be loaded
2295 on the appropriate Ansible Server.
2297 R-16777 The xNF provider **MUST** provide a JSON file for each
2298 supported action for the xNF. The JSON file must contain key value
2299 pairs with all relevant values populated with sample data that illustrates
2300 its usage. The fields and their description are defined in Appendix B.
2302 R-46567 The xNF Package **MUST** include configuration scripts
2303 for boot sequence and configuration.
2305 R-16065 The xNF provider **MUST** provide configurable parameters
2306 (if unable to conform to YANG model) including xNF attributes/parameters
2307 and valid values, dynamic attributes and cross parameter dependencies
2308 (e.g., customer provisioning data).
2310 R-22888 The xNF provider **MUST** provide documentation for the xNF
2311 Policy Description to manage the xNF runtime lifecycle. The document
2312 must include a description of how the policies (conditions and actions)
2313 are implemented in the xNF.
2315 R-01556 The xNF Package **MUST** include documentation describing the
2316 fault, performance, capacity events/alarms and other event records that
2317 are made available by the xNF. The document must include:
2319 - A unique identification string for the specific xNF, a description
2320 of the problem that caused the error, and steps or procedures to
2321 perform Root Cause Analysis and resolve the issue.
2322 - All events, severity level (e.g., informational, warning, error)
2323 and descriptions including causes/fixes if applicable for the event.
2324 - All events (fault, measurement for xNF Scaling, Syslogs, State Change
2325 and Mobile Flow), that need to be collected at each VM, VNFC
2326 (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.
2328 R-27711 The xNF provider **MUST** provide an XML file that contains a
2329 list of xNF error codes, descriptions of the error, and possible
2330 causes/corrective action.
2332 R-01478 The xNF Package **MUST** include documentation describing all
2333 parameters that are available to monitor the xNF after instantiation
2334 (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected
2335 for reporting purposes. The documentation must include a list of:
2337 - Monitoring parameters/counters exposed for virtual resource
2338 management and xNF application management.
2339 - KPIs and metrics that need to be collected at each VM for capacity
2340 planning and performance management purposes.
2341 - The monitoring parameters must include latencies, success rates,
2342 retry rates, load and quality (e.g., DPM) for the key
2343 transactions/functions supported by the xNF and those that must
2344 be exercised by the xNF in order to perform its function.
2345 - For each KPI, provide lower and upper limits.
2346 - When relevant, provide a threshold crossing alert point for
2347 each KPI and describe the significance of the threshold crossing.
2348 - For each KPI, identify the suggested actions that need to be
2349 performed when a threshold crossing alert event is recorded.
2350 - Describe any requirements for the monitoring component of tools
2351 for Network Cloud automation and management to provide these records
2352 to components of the xNF.
2353 - When applicable, provide calculators needed to convert raw data
2354 into appropriate reporting artifacts.
2356 R-56815 The xNF Package **MUST** include documentation describing
2357 supported xNF scaling capabilities and capacity limits (e.g., number
2358 of users, bandwidth, throughput, concurrent calls).
2360 R-48596 The xNF Package **MUST** include documentation describing
2361 the characteristics for the xNF reliability and high availability.
2363 R-74763 The xNF provider **MUST** provide an artifact per xNF that contains
2364 all of the xNF Event Records supported. The artifact should include reference
2365 to the specific release of the xNF Event Stream Common Event Data Model
2366 document it is based on. (e.g., `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
2368 R-35851 The xNF Package **MUST** include xNF topology that describes
2369 basic network and application connectivity internal and external to the
2370 xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if
2371 applicable) for each interface.
2373 R-97102 The VNF Package **MUST** include VM requirements via a Heat
2374 template that provides the necessary data for:
2376 - VM specifications for all VNF components - for hypervisor, CPU,
2378 - Network connections, interface connections, internal and external to VNF.
2379 - High availability redundancy model.
2380 - Scaling/growth VM specifications.
2382 R-26881 The xNF provider **MUST** provide the binaries and images
2383 needed to instantiate the xNF (xNF and VNFC images).
2385 R-96634 The VNF provider **MUST** describe scaling capabilities
2386 to manage scaling characteristics of the VNF.
2388 R-43958 The xNF Package **MUST** include documentation describing
2389 the tests that were conducted by the xNF providor and the test results.
2391 R-04298 The xNF provider **MUST** provide their testing scripts to
2394 R-58775 The xNF provider **MUST** provide software components that
2395 can be packaged with/near the xNF, if needed, to simulate any functions
2396 or systems that connect to the xNF system under test. This component is
2397 necessary only if the existing testing environment does not have the
2398 necessary simulators.
2400 R-85653 The xNF **MUST** provide metrics (e.g., number of sessions,
2401 number of subscribers, number of seats, etc.) to ONAP for tracking
2404 R-44125 The xNF provider **MUST** agree to the process that can
2405 be met by Service Provider reporting infrastructure. The Contract
2406 shall define the reporting process and the available reporting tools.
2408 R-40827 The xNF provider **MUST** enumerate all of the open
2409 source licenses their xNF(s) incorporate.
2411 R-97293 The xNF provider **MUST NOT** require audits of
2412 Service Provider’s business.
2414 R-44569 The xNF provider **MUST NOT** require additional
2415 infrastructure such as a xNF provider license server for xNF provider
2416 functions and metrics.
2418 R-13613 The VNF **MUST** provide clear measurements for licensing
2419 purposes to allow automated scale up/down by the management system.
2421 R-27511 The VNF provider **MUST** provide the ability to scale
2422 up a VNF provider supplied product during growth and scale down a
2423 VNF provider supplied product during decline without “real-time”
2424 restrictions based upon VNF provider permissions.
2426 R-85991 The xNF provider **MUST** provide a universal license key
2427 per xNF to be used as needed by services (i.e., not tied to a VM
2428 instance) as the recommended solution. The xNF provider may provide
2429 pools of Unique xNF License Keys, where there is a unique key for
2430 each xNF instance as an alternate solution. Licensing issues should
2431 be resolved without interrupting in-service xNFs.
2433 R-47849 The xNF provider **MUST** support the metadata about
2434 licenses (and their applicable entitlements) as defined in this
2435 document for xNF software, and any license keys required to authorize
2436 use of the xNF software. This metadata will be used to facilitate
2437 onboarding the xNF into the ONAP environment and automating processes
2438 for putting the licenses into use and managing the full lifecycle of
2439 the licenses. The details of this license model are described in
2440 Appendix C. Note: License metadata support in ONAP is not currently
2441 available and planned for 1Q 2018.
2443 Configuration Management
2444 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2446 R-20741 The xNF **MUST** support ONAP Controller’s **Configure** command.
2448 R-19366 The xNF **MUST** support ONAP Controller’s **ConfigModify** command.
2450 R-32981 The xNF **MUST** support ONAP Controller’s **ConfigBackup** command.
2452 R-48247 The xNF **MUST** support ONAP Controller’s **ConfigRestore** command.
2454 R-94084 The xNF **MUST** support ONAP Controller’s **ConfigScaleOut**
2457 R-56385 The xNF **MUST** support ONAP Controller’s **Audit** command.
2459 R-12706 The xNF **MUST** support ONAP Controller’s **QuiesceTraffic**
2462 R-07251 The xNF **MUST** support ONAP Controller’s **ResumeTraffic**
2465 R-83146 The xNF **MUST** support ONAP Controller’s **StopApplication**
2468 R-82811 The xNF **MUST** support ONAP Controller’s **StartApplication**
2471 R-19922 The xNF **MUST** support ONAP Controller’s **UpgradePrecheck**
2474 R-49466 The xNF **MUST** support ONAP Controller’s **UpgradeSoftware**
2477 R-45856 The xNF **MUST** support ONAP Controller’s **UpgradePostCheck**
2480 R-97343 The xNF **MUST** support ONAP Controller’s **UpgradeBackup**
2483 R-65641 The xNF **MUST** support ONAP Controller’s **UpgradeBackOut**
2486 R-41430 The xNF **MUST** support ONAP Controller’s **HealthCheck**
2489 R-88026 The xNF **MUST** include a NETCONF server enabling
2490 runtime configuration and lifecycle management capabilities.
2492 R-95950 The xNF **MUST** provide a NETCONF interface fully defined
2493 by supplied YANG models for the embedded NETCONF server.
2495 R-73468 The xNF **MUST** allow the NETCONF server connection
2496 parameters to be configurable during virtual machine instantiation
2497 through Heat templates where SSH keys, usernames, passwords, SSH
2498 service and SSH port numbers are Heat template parameters.
2500 R-90007 The xNF **MUST** implement the protocol operation:
2501 **close-session()**- Gracefully close the current session.
2503 R-70496 The xNF **MUST** implement the protocol operation:
2504 **commit(confirmed, confirm-timeout)** - Commit candidate
2505 configuration datastore to the running configuration.
2507 R-18733 The xNF **MUST** implement the protocol operation:
2508 **discard-changes()** - Revert the candidate configuration
2509 datastore to the running configuration.
2511 R-44281 The xNF **MUST** implement the protocol operation:
2512 **edit-config(target, default-operation, test-option, error-option,
2513 config)** - Edit the target configuration datastore by merging,
2514 replacing, creating, or deleting new config elements.
2516 R-60106 The xNF **MUST** implement the protocol operation:
2517 **get(filter)** - Retrieve (a filtered subset of) the running
2518 configuration and device state information. This should include
2519 the list of xNF supported schemas.
2521 R-29488 The xNF **MUST** implement the protocol operation:
2522 **get-config(source, filter)** - Retrieve a (filtered subset of
2523 a) configuration from the configuration datastore source.
2525 R-11235 The xNF **MUST** implement the protocol operation:
2526 **kill-session(session)** - Force the termination of **session**.
2528 R-02597 The xNF **MUST** implement the protocol operation:
2529 **lock(target)** - Lock the configuration datastore target.
2531 R-96554 The xNF **MUST** implement the protocol operation:
2532 **unlock(target)** - Unlock the configuration datastore target.
2534 R-29324 The xNF **SHOULD** implement the protocol operation:
2535 **copy-config(target, source) -** Copy the content of the
2536 configuration datastore source to the configuration datastore target.
2538 R-88031 The xNF **SHOULD** implement the protocol operation:
2539 **delete-config(target) -** Delete the named configuration
2542 R-97529 The xNF **SHOULD** implement the protocol operation:
2543 **get-schema(identifier, version, format) -** Retrieve the YANG schema.
2545 R-62468 The xNF **MUST** allow all configuration data to be
2546 edited through a NETCONF <edit-config> operation. Proprietary
2547 NETCONF RPCs that make configuration changes are not sufficient.
2549 R-01382 The xNF **MUST** allow the entire configuration of the
2550 xNF to be retrieved via NETCONF's <get-config> and <edit-config>,
2551 independently of whether it was configured via NETCONF or other
2554 R-28756 The xNF **MUST** support **:partial-lock** and
2555 **:partial-unlock** capabilities, defined in RFC 5717. This
2556 allows multiple independent clients to each write to a different
2557 part of the <running> configuration at the same time.
2559 R-83873 The xNF **MUST** support **:rollback-on-error** value for
2560 the <error-option> parameter to the <edit-config> operation. If any
2561 error occurs during the requested edit operation, then the target
2562 database (usually the running configuration) will be left unaffected.
2563 This provides an 'all-or-nothing' edit mode for a single <edit-config>
2566 R-68990 The xNF **MUST** support the **:startup** capability. It
2567 will allow the running configuration to be copied to this special
2568 database. It can also be locked and unlocked.
2570 R-68200 The xNF **MUST** support the **:url** value to specify
2571 protocol operation source and target parameters. The capability URI
2572 for this feature will indicate which schemes (e.g., file, https, sftp)
2573 that the server supports within a particular URL value. The 'file'
2574 scheme allows for editable local configuration databases. The other
2575 schemes allow for remote storage of configuration databases.
2577 R-20353 The xNF **MUST** implement both **:candidate** and
2578 **:writable-running** capabilities. When both **:candidate** and
2579 **:writable-running** are provided then two locks should be supported.
2581 R-11499 The xNF **MUST** fully support the XPath 1.0 specification
2582 for filtered retrieval of configuration and other database contents.
2583 The 'type' attribute within the <filter> parameter for <get> and
2584 <get-config> operations may be set to 'xpath'. The 'select' attribute
2585 (which contains the XPath expression) will also be supported by the
2586 server. A server may support partial XPath retrieval filtering, but
2587 it cannot advertise the **:xpath** capability unless the entire XPath
2588 1.0 specification is supported.
2590 R-83790 The xNF **MUST** implement the **:validate** capability
2592 R-49145 The xNF **MUST** implement **:confirmed-commit** If
2593 **:candidate** is supported.
2595 R-58358 The xNF **MUST** implement the **:with-defaults** capability
2598 R-59610 The xNF **MUST** implement the data model discovery and
2599 download as defined in [RFC6022].
2601 R-87662 The xNF **SHOULD** implement the NETCONF Event Notifications
2604 R-93443 The xNF **MUST** define all data models in YANG [RFC6020],
2605 and the mapping to NETCONF shall follow the rules defined in this RFC.
2607 R-26115 The xNF **MUST** follow the data model upgrade rules defined
2608 in [RFC6020] section 10. All deviations from section 10 rules shall
2609 be handled by a built-in automatic upgrade mechanism.
2611 R-10716 The xNF **MUST** support parallel and simultaneous
2612 configuration of separate objects within itself.
2614 R-29495 The xNF **MUST** support locking if a common object is
2615 being manipulated by two simultaneous NETCONF configuration operations
2616 on the same xNF within the context of the same writable running data
2617 store (e.g., if an interface parameter is being configured then it
2618 should be locked out for configuration by a simultaneous configuration
2619 operation on that same interface parameter).
2621 R-53015 The xNF **MUST** apply locking based on the sequence of
2622 NETCONF operations, with the first configuration operation locking
2623 out all others until completed.
2625 R-02616 The xNF **MUST** permit locking at the finest granularity
2626 if a xNF needs to lock an object for configuration to avoid blocking
2627 simultaneous configuration operations on unrelated objects (e.g., BGP
2628 configuration should not be locked out if an interface is being
2629 configured or entire Interface configuration should not be locked out
2630 if a non-overlapping parameter on the interface is being configured).
2632 R-41829 The xNF **MUST** be able to specify the granularity of the
2633 lock via a restricted or full XPath expression.
2635 R-66793 The xNF **MUST** guarantee the xNF configuration integrity
2636 for all simultaneous configuration operations (e.g., if a change is
2637 attempted to the BUM filter rate from multiple interfaces on the same
2638 EVC, then they need to be sequenced in the xNF without locking either
2639 configuration method out).
2641 R-54190 The xNF **MUST** release locks to prevent permanent lock-outs
2642 when/if a session applying the lock is terminated (e.g., SSH session
2645 R-03465 The xNF **MUST** release locks to prevent permanent lock-outs
2646 when the corresponding <partial-unlock> operation succeeds.
2648 R-63935 The xNF **MUST** release locks to prevent permanent lock-outs
2649 when a user configured timer has expired forcing the NETCONF SSH Session
2650 termination (i.e., product must expose a configuration knob for a user
2651 setting of a lock expiration timer)
2653 R-10173 The xNF **MUST** allow another NETCONF session to be able to
2654 initiate the release of the lock by killing the session owning the lock,
2655 using the <kill-session> operation to guard against hung NETCONF sessions.
2657 R-88899 The xNF **MUST** support simultaneous <commit> operations
2658 within the context of this locking requirements framework.
2660 R-07545 The xNF **MUST** support all operations, administration and
2661 management (OAM) functions available from the supplier for xNFs using
2662 the supplied YANG code and associated NETCONF servers.
2664 R-60656 The xNF **MUST** support sub tree filtering.
2666 R-80898 The xNF **MUST** support heartbeat via a <get> with null filter.
2668 R-06617 The xNF **MUST** support get-schema (ietf-netconf-monitoring)
2669 to pull YANG model over session.
2671 R-25238 The xNF PACKAGE **MUST** validated YANG code using the open
2672 source pyang [3]_ program using the following commands:
2674 R-63953 The xNF **MUST** have the echo command return a zero value
2675 otherwise the validation has failed
2677 R-26508 The xNF **MUST** support NETCONF server that can be
2678 mounted on OpenDaylight (client) and perform the following operations:
2680 - Modify, update, change, rollback configurations using each
2681 configuration data element.
2682 - Query each state (non-configuration) data element.
2683 - Execute each YANG RPC.
2684 - Receive data through each notification statement.
2686 R-28545 The xNF **MUST** conform its YANG model to RFC 6060,
2687 “YANG - A Data Modeling Language for the Network Configuration
2690 R-29967 The xNF **MUST** conform its YANG model to RFC 6022,
2691 “YANG module for NETCONF monitoring”.
2693 R-22700 The xNF **MUST** conform its YANG model to RFC 6470,
2694 “NETCONF Base Notifications”.
2696 R-10353 The xNF **MUST** conform its YANG model to RFC 6244,
2697 “An Architecture for Network Management Using NETCONF and YANG”.
2699 R-53317 The xNF **MUST** conform its YANG model to RFC 6087,
2700 “Guidelines for Authors and Reviewers of YANG Data Model Documents”.
2702 R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991,
2703 “Common YANG Data Types”.
2705 R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536,
2706 “NETCONF Access Control Model”.
2708 R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223,
2709 “A YANG Data Model for Interface Management”.
2711 R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223,
2712 “IANA Interface Type YANG Module”.
2714 R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277,
2715 “A YANG Data Model for IP Management”.
2717 R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317,
2718 “A YANG Data Model for System Management”.
2720 R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407,
2721 “A YANG Data Model for SNMP Configuration”.
2723 R-33946 The xNF **MUST** conform to the NETCONF RFC 4741,
2724 “NETCONF Configuration Protocol”.
2726 R-04158 The xNF **MUST** conform to the NETCONF RFC 4742,
2727 “Using the NETCONF Configuration Protocol over Secure Shell (SSH)”.
2729 R-13800 The xNF **MUST** conform to the NETCONF RFC 5277,
2730 “NETCONF Event Notification”.
2732 R-01334 The xNF **MUST** conform to the NETCONF RFC 5717,
2733 “Partial Lock Remote Procedure Call”.
2735 R-08134 The xNF **MUST** conform to the NETCONF RFC 6241,
2736 “NETCONF Configuration Protocol”.
2738 R-78282 The xNF **MUST** conform to the NETCONF RFC 6242,
2739 “Using the Network Configuration Protocol over Secure Shell”.
2741 R-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck
2742 RPC executes a xNF Provider-defined xNF HealthCheck over the scope of
2743 the entire xNF (e.g., if there are multiple VNFCs, then run a health check,
2744 as appropriate, for all VNFCs). It returns a 200 OK if the test completes.
2745 A JSON object is returned indicating state (healthy, unhealthy), scope
2746 identifier, time-stamp and one or more blocks containing info and fault
2747 information. If the xNF is unable to run the HealthCheck, return a
2748 standard http error code and message.
2750 R-79224 The xNF **MUST** have the chef-client be preloaded with
2751 validator keys and configuration to register with the designated
2752 Chef Server as part of the installation process.
2754 R-72184 The xNF **MUST** have routable FQDNs for all the endpoints
2755 (VMs) of a xNF that contain chef-clients which are used to register
2756 with the Chef Server. As part of invoking xNF actions, ONAP will
2757 trigger push jobs against FQDNs of endpoints for a xNF, if required.
2759 R-47068 The xNF **MAY** expose a single endpoint that is
2760 responsible for all functionality.
2762 R-67114 The xNF **MUST** be installed with:
2764 - Chef-Client >= 12.0
2765 - Chef push jobs client >= 2.0
2767 R-27310 The xNF Package **MUST** include all relevant Chef artifacts
2768 (roles/cookbooks/recipes) required to execute xNF actions requested by
2769 ONAP for loading on appropriate Chef Server.
2771 R-26567 The xNF Package **MUST** include a run list of
2772 roles/cookbooks/recipes, for each supported xNF action, that will
2773 perform the desired xNF action in its entirety as specified by ONAP
2774 (see Section 7.c, ONAP Controller APIs and Behavior, for list of xNF
2775 actions and requirements), when triggered by a chef-client run list
2778 R-98911 The xNF **MUST NOT** use any instance specific parameters
2779 for the xNF in roles/cookbooks/recipes invoked for a xNF action.
2781 R-37929 The xNF **MUST** accept all necessary instance specific
2782 data from the environment or node object attributes for the xNF
2783 in roles/cookbooks/recipes invoked for a xNF action.
2785 R-62170 The xNF **MUST** over-ride any default values for
2786 configurable parameters that can be set by ONAP in the roles,
2787 cookbooks and recipes.
2789 R-78116 The xNF **MUST** update status on the Chef Server
2790 appropriately (e.g., via a fail or raise an exception) if the
2791 chef-client run encounters any critical errors/failures when
2792 executing a xNF action.
2794 R-44013 The xNF **MUST** populate an attribute, defined as node
2795 [‘PushJobOutput’] with the desired output on all nodes in the push job
2796 that execute chef-client run if the xNF action requires the output of a
2797 chef-client run be made available (e.g., get running configuration).
2799 R-30654 The xNF Package **MUST** have appropriate cookbooks that are
2800 designed to automatically ‘rollback’ to the original state in case of
2801 any errors for actions that change state of the xNF (e.g., configure).
2803 R-65755 The xNF **SHOULD** support callback URLs to return information
2804 to ONAP upon completion of the chef-client run for any chef-client run
2805 associated with a xNF action.
2807 - As part of the push job, ONAP will provide two parameters in the
2808 environment of the push job JSON object:
2810 - ‘RequestId’ a unique Id to be used to identify the request,
2811 - ‘CallbackUrl’, the URL to post response back.
2813 - If the CallbackUrl field is empty or missing in the push job, then
2814 the chef-client run need not post the results back via callback.
2816 R-15885 The xNF **MUST** Upon completion of the chef-client run,
2817 POST back on the callback URL, a JSON object as described in Table
2818 A2 if the chef-client run list includes a cookbook/recipe that is
2819 callback capable. Failure to POST on the Callback Url should not be
2820 considered a critical error. That is, if the chef-client successfully
2821 completes the xNF action, it should reflect this status on the Chef
2822 Server regardless of whether the Callback succeeded or not.
2824 R-32217 The xNF **MUST** have routable FQDNs that are reachable via
2825 the Ansible Server for the endpoints (VMs) of a xNF on which playbooks
2826 will be executed. ONAP will initiate requests to the Ansible Server
2827 for invocation of playbooks against these end points [4]_.
2829 R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)
2830 of a xNF on which an Ansible playbook will be executed.
2832 R-35401 The xNF **MUST** support SSH and allow SSH access by the
2833 Ansible server for the endpoint VM(s) and comply with the Network
2834 Cloud Service Provider guidelines for authentication and access.
2836 R-82018 The VNF **MUST** load the Ansible Server SSH public key onto VNF
2837 VM(s) as part of instantiation. This will allow the Ansible Server
2838 to authenticate to perform post-instantiation configuration without
2839 manual intervention and without requiring specific VNF login IDs and
2842 R-92866 The VNF **MUST** include as part of post-instantiation
2843 configuration done by Ansible Playbooks the removal/update of SSH
2844 public keys loaded through instantiation to support Ansible. This may
2845 include download and install of new SSH public keys.
2847 R-91745 The VNF **MUST** update the Ansible Server and other entities
2848 storing and using the SSH keys for authentication when the SSH keys used
2849 by Ansible are regenerated/updated.
2851 R-40293 The xNF **MUST** make available playbooks that conform
2852 to the ONAP requirement.
2854 R-49396 The xNF **MUST** support each ONAP (APPC) xNF action by
2855 invocation of **one** playbook [7]_. The playbook will be responsible
2856 for executing all necessary tasks (as well as calling other playbooks)
2857 to complete the request.
2859 R-33280 The xNF **MUST NOT** use any instance specific parameters
2862 R-48698 The xNF **MUST** utilize information from key value pairs
2863 that will be provided by the Ansible Server as "extra-vars" during
2864 invocation to execute the desired xNF action. If the playbook requires
2865 files, they must also be supplied using the methodology detailed in
2866 the Ansible Server API, unless they are bundled with playbooks, example,
2869 R-43253 The xNF **MUST** use playbooks designed to allow Ansible
2870 Server to infer failure or success based on the “PLAY_RECAP” capability.
2871 NOTE: There are cases where playbooks need to interpret results of a task
2872 and then determine success or failure and return result accordingly
2873 (failure for failed tasks).
2875 R-50252 The xNF **MUST** write to a specific one text files that
2876 will be retrieved and made available by the Ansible Server if, as part
2877 of a xNF action (e.g., audit), a playbook is required to return any
2878 xNF information. The text files must be written in the same directory as
2879 the one from which the playbook is being executed. A text file must be
2880 created for the xNF playbook run targets/affects, with the name
2881 ‘<VNFname>_results.txt’ into which any desired output from each
2882 respective VM/xNF must be written.
2884 R-51442 The xNF **SHOULD** use playbooks that are designed to
2885 automatically ‘rollback’ to the original state in case of any errors
2886 for actions that change state of the xNF (e.g., configure).
2888 R-58301 The VNF **SHOULD NOT** use playbooks that make requests to
2889 Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);
2890 therefore, there is no use for Cloud specific variables like Openstack
2891 UUIDs in Ansible Playbooks.
2893 R-02651 The VNF **SHOULD** use the Ansible backup feature to save a
2894 copy of configuration files before implementing changes to support
2895 operations such as backing out of software upgrades, configuration
2896 changes or other work as this will help backing out of configuration
2897 changes when needed.
2899 R-43353 The VNF **MUST** return control from Ansible Playbooks only
2900 after tasks are fully complete, signaling that the playbook completed
2901 all tasks. When starting services, return control only after all services
2902 are up. This is critical for workflows where the next steps are dependent
2904 R-51910 The xNF **MUST** provide all telemetry (e.g., fault event
2905 records, syslog records, performance records etc.) to ONAP using the
2906 model, format and mechanisms described in this section.
2908 R-19624 The xNF **MUST** encode and serialize content delivered to
2909 ONAP using JSON (RFC 7159) plain text format. High-volume data is to
2910 be encoded and serialized using `Avro <http://avro.apache.org/>`_,
2911 where the Avro [6]_ data format are described using JSON.
2913 - JSON plain text format is preferred for moderate volume data sets
2914 (option 1), as JSON has the advantage of having well-understood simple
2915 processing and being human-readable without additional decoding. Examples
2916 of moderate volume data sets include the fault alarms and performance
2917 alerts, heartbeat messages, measurements used for xNF scaling and syslogs.
2918 - Binary format using Avro is preferred for high volume data sets
2919 (option 2) such as mobility flow measurements and other high-volume
2920 streaming events (such as mobility signaling events or SIP signaling)
2921 or bulk data, as this will significantly reduce the volume of data
2922 to be transmitted. As of the date of this document, all events are
2923 reported using plain text JSON and REST.
2924 - Avro content is self-documented, using a JSON schema. The JSON schema is
2925 delivered along with the data content
2926 (http://avro.apache.org/docs/current/ ). This means the presence and
2927 position of data fields can be recognized automatically, as well as the
2928 data format, definition and other attributes. Avro content can be
2929 serialized as JSON tagged text or as binary. In binary format, the
2930 JSON schema is included as a separate data block, so the content is
2931 not tagged, further compressing the volume. For streaming data, Avro
2932 will read the schema when the stream is established and apply the
2933 schema to the received content.
2935 R-98191 The xNF **MUST** vary the frequency that asynchronous data
2936 is delivered based on the content and how data may be aggregated or
2937 grouped together. For example, alarms and alerts are expected to be
2938 delivered as soon as they appear. In contrast, other content, such as
2939 performance measurements, KPIs or reported network signaling may have
2940 various ways of packaging and delivering content. Some content should
2941 be streamed immediately; or content may be monitored over a time interval,
2942 then packaged as collection of records and delivered as block; or data
2943 may be collected until a package of a certain size has been collected;
2944 or content may be summarized statistically over a time interval, or
2945 computed as a KPI, with the summary or KPI being delivered.
2947 - We expect the reporting frequency to be configurable depending
2948 on the virtual network function’s needs for management. For example,
2949 Service Provider may choose to vary the frequency of collection between
2950 normal and trouble-shooting scenarios.
2951 - Decisions about the frequency of data reporting will affect the
2952 size of delivered data sets, recommended delivery method, and how the
2953 data will be interpreted by ONAP. These considerations should not
2954 affect deserialization and decoding of the data, which will be guided
2955 by the accompanying JSON schema or GPB definition files.
2957 R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain
2958 text JSON for moderate sized asynchronous data sets, and for high
2959 volume data sets when feasible.
2961 R-84879 The xNF **MUST** have the capability of maintaining a primary
2962 and backup DNS name (URL) for connecting to ONAP collectors, with the
2963 ability to switch between addresses based on conditions defined by policy
2964 such as time-outs, and buffering to store messages until they can be
2965 delivered. At its discretion, the service provider may choose to populate
2966 only one collector address for a xNF. In this case, the network will
2967 promptly resolve connectivity problems caused by a collector or network
2968 failure transparently to the xNF.
2970 R-81777 The VNF **MUST** be configured with initial address(es) to use
2971 at deployment time. Subsequently, address(es) may be changed through
2972 ONAP-defined policies delivered from ONAP to the VNF using PUTs to a
2973 RESTful API, in the same manner that other controls over data reporting
2974 will be controlled by policy.
2976 R-08312 The xNF **MAY** use other options which are expected to include
2978 - REST delivery of binary encoded data sets.
2979 - TCP for high volume streaming asynchronous data sets and for other
2980 high volume data sets. TCP delivery can be used for either
2981 JSON or binary encoded data sets.
2982 - SFTP for asynchronous bulk files, such as bulk files that contain
2983 large volumes of data collected over a long time interval or data
2984 collected across many xNFs. This is not preferred. Preferred is to
2985 reorganize the data into more frequent or more focused data sets, and
2986 deliver these by REST or TCP as appropriate.
2987 - REST for synchronous data, using RESTCONF (e.g., for xNF state polling).
2989 R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses
2990 as data destinations for each xNF, and may be changed by Policy while
2991 the xNF is in operation. We expect the xNF to be capable of redirecting
2992 traffic to changed destinations with no loss of data, for example from
2993 one REST URL to another, or from one TCP host and port to another.
2995 R-06924 The xNF **MUST** deliver asynchronous data as data becomes
2996 available, or according to the configured frequency.
2998 R-73285 The xNF **MUST** must encode, address and deliver the data
2999 as described in the previous paragraphs.
3001 R-42140 The xNF **MUST** respond to data requests from ONAP as soon
3002 as those requests are received, as a synchronous response.
3004 R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by
3005 the ONAP configuration subsystem for synchronous communication.
3007 R-86586 The VNF **MUST** use the YANG configuration models and RESTCONF
3008 [RFC8040] (https://tools.ietf.org/html/rfc8040).
3010 R-11240 The xNF **MUST** respond with content encoded in JSON, as
3011 described in the RESTCONF specification. This way the encoding of a
3012 synchronous communication will be consistent with Avro.
3014 R-70266 The xNF **MUST** respond to an ONAP request to deliver the
3015 current data for any of the record types defined in
3016 Event Records - Data Structure Description by returning the requested
3017 record, populated with the current field values. (Currently the defined
3018 record types include fault fields, mobile flow fields, measurements for
3019 xNF scaling fields, and syslog fields. Other record types will be added
3020 in the future as they become standardized and are made available.)
3022 R-46290 The xNF **MUST** respond to an ONAP request to deliver granular
3023 data on device or subsystem status or performance, referencing the YANG
3024 configuration model for the xNF by returning the requested data elements.
3026 R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG
3027 <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be
3028 translated to and from JSON[RFC7951]. YANG configuration and content can
3029 be represented via JSON, consistent with Avro, as described in “Encoding
3030 and Serialization” section.
3032 R-42366 The xNF **MUST** support secure connections and transports such as
3033 Transport Layer Security (TLS) protocol
3034 [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to
3035 the best current practices outlined in
3036 `RFC7525 <https://tools.ietf.org/html/rfc7525>`_.
3038 R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation
3039 of connections, through secure credentials, log-on and exchange mechanisms.
3041 R-47597 The xNF **MUST** carry data in motion only over secure connections.
3043 R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal
3044 Information (SPI) or certain proprietary data, in addition to applying the
3045 regular procedures for securing access and delivery.
3048 Ansible Playbook Examples
3049 -----------------------------------------------
3051 The following sections contain examples of Ansible playbook contents
3052 which follow the guidelines.
3054 Guidelines for Playbooks to properly integrate with APPC
3055 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3057 NOTE: To support concurrent requests to multiple VNF instances of same
3058 or different type, VNF hosts and other files with VNF specific default
3059 values are kept or created in separate directories.
3061 Example of an Ansible command (after pwd) to run playbook again
3062 vfdb9904v VNF instance:
3064 .. code-block:: none
3067 /storage/vfdb/V16.1/ansible/configure
3068 $ ansible-playbook -i ../inventory/vfdb9904v/hosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3070 Example of corresponding APPC API Call from ONAP – Ansible Server
3073 An example POST for requesting execution of configure Playbook:
3075 .. code-block:: none
3077 {"Id": "10", "PlaybookName":
3078 "/storage/vfdb/latest/ansible/configure/site.yml", "NodeList":
3079 ["vfdb9904v"], "Timeout": 60, "EnvParameters": {"Retry": 3, "Wait": 5},
3080 "LocalParameters": {"vfdb9904v": {"T_true": 10, "T_false": 5,
3085 - An ID number is assigned to each request. This ID number is used to
3086 track request down to completion and provide status to APPC when
3089 - Playbook Name provided in the request (full path in this case)
3091 - Playbook path (in this example provided as part of playbook name as
3092 full path) or, later in a separate variable, playbook root directory
3093 needs to be part of APPC template.
3095 Ansible Playbooks will use the VNF instance name (passed using
3096 --extra-vars "vnf\_instance=vfdb9904v") to identify other default values
3097 to run the playbook(s) against the target VNF instance. Same example as
3100 .. code-block:: none
3102 $ ansible-playbook -i ../inventory/vfdb9904v/hosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3104 SSH key info (name/path), used to authenticate with the VNF VMs, is one
3105 of the attributes stored in the Ansible Server inventory hosts file for
3106 the VNF instance and later will be passed down by APPC, in the inventory
3107 hosts file, to the Ansible Server as part of the request. Here hosts
3108 file to run ansible-playbook listed in this example above (IP addresses
3111 .. code-block:: none
3113 $ more ../inventory/vfdb9904v/hosts
3115 localhost ansible_connection=local
3118 1xx.2yy.zzz.109 ansible_ssh_private_key_file=/storage/.ssh/Kilo-SSH-Key.pem
3119 1xx.2yy.zzz.110 ansible_ssh_private_key_file=/storage/.ssh/Kilo-SSH-Key.pem
3122 1xx.2yy.zzz.105 ansible_ssh_private_key_file=/storage/.ssh/Kilo-SSH-Key.pem
3123 1xx.2yy.zzz.106 ansible_ssh_private_key_file=/storage/.ssh/Kilo-SSH-Key.pem
3125 NOTE: APPC requests to run Playbooks/Cookbooks are specific to a VNF,
3126 but could be more limited to one VM or one type of VM by the request
3127 parameters. Actions that may impact a site (LCP), a service, or an
3128 entire platform must be orchestrated by MSO in order to execute requests
3129 via APPC which then invoke VNF level playbooks. Playbooks that impact
3130 more than a single VNF are not the current focus of these guidelines.
3132 And here the scrubbed default arguments for this VNF instance:
3134 .. code-block:: none
3136 vnf_instance=vfdb9904v
3138 $ more ../vars/vfdb9904v/default_args.yml
3139 vnf_provider_network_network: d69fea03-xxx-yyy-zzz-nnnnnnnnnnnn
3140 vnf_provider_network_subnet: a07f6a3d-xxxx-yyy-zzz-ssssssssssss
3141 vm_config_oam_vnfc_name: vfdb9904vm001oam001
3142 vm_config_oam_hostname: vfdb9904vm001
3143 vm_config_oam_provider_ip_address: 1xx.2yy.zzz.109
3146 IMPORTANT: The APPC and default file attribute name for
3147 vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config
3148 array structure (list) in the CSAR package ENV file, with dots replaced
3151 .. code-block:: none
3155 oam: {vnfc_name: {{ vm_config_oam_vnfc_name }}, hostname: {{
3156 vm_config_oam_hostname }}, provider_ip_address: {{
3157 vm_config_oam_provider_ip_address }
3161 Parameters like VNF names, VNFC names, OA&M IP addresses, after
3162 February, 2018 ONAP release, will be extracted from A&AI by APPC and
3163 then passed down to Ansible Server, as part of APPC request through REST
3164 API. In the meantime, these VNF instance specific required values, will
3165 be stored on VNF instance directory, default arguments file and will be
3166 used as defaults. For parameterized playbooks attribute-value pairs
3167 passed down by APPC to Ansible Server always take precedence over
3168 template or VNF instance specific defaults stored in defaults file(s).
3170 .. code-block:: none
3173 /storage/vfdb/latest/ansible
3175 $ more vars/vfdb9904v/default_args.yml
3177 vm_config_oam1_vnfc_name: vfdb9904vm001oam001
3178 vm_config_oam1_hostname: vfdb9904vm001
3179 vm_config_oam1_provider_ip_address: 1xx.2yy.zzz.109
3181 vm_config_oam2_vnfc_name: vfdb9904vm002oam001
3182 vm_config_oam2_hostname: vfdb9904vm002
3183 vm_config_oam2_provider_ip_address: 1xx.2yy.zzz.110
3185 vm_config_rdb1_vnfc_name: vfdb9904vm003rdb001
3186 vm_config_rdb1_hostname: vfdb9904vm003
3187 vm_config_rdb1_provider_ip_address: 1xx.2yy.zzz.105
3189 vm_config_rdb2_vnfc_name: vfdb9904vm004rdb001
3190 vm_config_rdb2_hostname: vfdb9904vm004
3191 vm_config_rdb2_provider_ip_address: 1xx.2yy.zzz.106
3193 vm_config_rdb3_vnfc_name: vfdb9904vm005rdb001
3194 vm_config_rdb3_hostname: vfdb9904vm005
3195 vm_config_rdb3_provider_ip_address: 1xx.2yy.zzz.xxx
3197 vm_config_rdb4_vnfc_name: vfdb9904vm006rdb001
3198 vm_config_rdb4_hostname: vfdb9904vm006
3199 vm_config_rdb4_provider_ip_address: 1xx.2yy.zzz.yyy
3201 One of the first tasks on the Ansible Playbooks is to combine the VNF
3202 type generic template, derived from ENV files in CSAR or other files,
3203 with these default values stored on the Ansible Server, together with
3204 the overriding parameters passed down from APPC, to create the VNF
3205 instance specific set of attribute-value pairs to be used for the run in
3206 YAML format. Here is an excerpt from such a file that should look
3207 somewhat similar to ENV files:
3209 .. code-block:: none
3211 $ more tmp/vfdb9904v/all.yml
3213 deployment_prefix: vfdb9904v
3215 oam1: { vnfc_name: vfdb9904vm001oam001, hostname: vfdb9904vm001, provider_ip_address: 1xx.2yy.zzz.109, private_ip_address: 192.168.10.107 }
3216 oam2: { vnfc_name: vfdb9904vm002oam001, hostname: vfdb9904vm002, provider_ip_address: 1xx.2yy.zzz.110, private_ip_address: 192.168.10.108 }
3217 rdb1: { vnfc_name: vfdb9904vm003rdb001, hostname: vfdb9904vm003, provider_ip_address: 1xx.2yy.zzz.105, private_ip_address: 192.168.10.109 }
3218 rdb2: { vnfc_name: vfdb9904vm004rdb001, hostname: vfdb9904vm004, provider_ip_address: 1xx.2yy.zzz.106, private_ip_address: 192.168.10.110 }
3219 rdb3: { vnfc_name: vfdb9904vm005rdb001, hostname: vfdb9904vm005, provider_ip_address: 1xx.2yy.zzz.xxx, private_ip_address: 192.168.10.111 }
3220 rdb4: { vnfc_name: vfdb9904vm006rdb001, hostname: vfdb9904vm006, provider_ip_address: 1xx.2yy.zzz.yyy, private_ip_address: 192.168.10.112 }
3224 template_version: '2014-10-16'
3225 stack_name: vfdb9904v
3226 key_name: ONAPkilo-keypair
3228 stackName: vfdb9904v
3232 # logins list contain 'login name', 'login group', 'login password'
3234 .. code-block:: none
3237 - { name: 'm99999', group: 'm99999', password: 'abcdefgha' }
3238 - { name: 'gsuser', group: 'gsuser', password: ' abcdefgha' }
3239 - { name: 'peruser', group: 'peruser', password: ' abcdefgha' }
3240 - { name: 'dbuser', group: 'dbuser', password: ' abcdefgha' }
3242 NOTE: Arguments passed by APPC to Ansible Server to run a playbook take
3243 precedence over any defaults stored in Ansible Server.
3245 Ansible Playbooks – Notes On Artifacts Required to Run Playbooks
3246 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3248 Inventory hosts file: should be VNF instance specific.
3250 Default variables: should be VNF instance specific/
3252 NOTE: Some playbooks may rely on inventory directory contents to target
3253 the collection of VNFs in the Services Platform supported through
3256 Playbooks and paths to referenced files: Playbooks shall not use
3257 absolute paths for file include entries (variables or playbooks) or
3258 other types of references.
3260 For this to work properly when running playbooks, the directory where
3261 the playbook resides shall be the current directory.
3263 Playbook includes use paths relative to the main playbook directory when
3266 Root directory named ansible - Any files provided with playbooks,
3267 included or referenced by playbooks, shall reside under the ansible
3268 playbooks (root) directory, containing all playbook subdirectories, or
3269 below that ansible root directory, in other subdirectories to support
3270 on-boarding and portability of VNF collection of playbooks and related
3273 Designing for a shared environment, concurrently running playbooks,
3274 targeting multiple VNF instances – inventory hosts file:
3276 To avoid inventory hosts file overwrites or collisions between multiple
3277 concurrently running VNF instance requests, chosen approach is for each
3278 VNF instance hosts file, to be stored under the Ansible Server Playbooks
3279 root directory, under the inventory subdirectory, and under a directory
3280 for each VNF instance, named after the VNF instance, as follows:
3282 ansible/inventory/<VNF\_instance\_name>/hosts
3284 Example of inventory hosts file path, relative to ansible playbooks root
3285 directory (playbooks\_dir): ansible/inventory/vnfx0001v/hosts
3287 Designing for a shared environment, concurrently running playbooks,
3288 targeting multiple VNF instances – default argument variables for
3289 specific VNF instances:
3291 Files containing attribute name value pairs (variable name and default
3292 values), referenced/included by playbooks – Files containing VNF
3293 instance specific default values – in a later APPC release, some or all
3294 the default attribute value pairs contained in the defaults file, may be
3295 passed down by APPC, to the Ansible Server, overriding these defaults:
3297 Following the same approach for inventory hosts files, files
3298 referenced/included by playbooks containing default values,
3299 default\_args.yml, shall be stored under a directory with VNF instance
3304 ansible/vars/<VNF\_instance\_name>/default\_args.yml
3306 Files containing attribute name value pairs (variable name and default
3307 values), referenced/included by playbooks – created dynamically by
3310 Following the same approach for inventory hosts files, to avoid
3311 overwrites or collisions of multiple concurrently running VNF instance
3312 requests, files created dynamically by playbooks, based on VNF generic
3313 templates, combined with default values and arguments passed down by
3314 APPC (as part of the request), shall be stored under a directory with
3315 VNF instance name on the path.
3319 tmp/<VNF\_instance\_name>/all.yml
3321 Files containing site specific (Openstack location non-instance
3322 specific) attribute name value pairs, like NTP server and DNS server’s
3323 IP addresses and other parameters, referenced/included by playbooks, not
3324 VNF specific – Could/should be stored under vars directory, in a
3325 subdirectory named after the string used to identify the site (nyc1,
3330 ansible/vars/<Site>/default\_args.yml
3332 ansible/vars/nyc1/default\_args.yml
3334 ansible/vars/lax2/default\_args.yml
3336 \ **Ansible Server Design - Directory Structure**
3338 To help understanding the contents of this section, here are few basic
3341 **VNF type a.k.a VNF Function Code** - Based on current Services
3342 Platform naming convention, each Virtual Network Function is assigned a
3343 4 character string (example vfdb), they are the first 4 characters on
3344 the VNF instance name, which is 9 characters long. VNF instance name in
3345 some cases corresponds to the stack name for the VNF when VNF instance
3346 is built based on a single module, single stack. Example of VNF instance
3347 name: vfdb9904v. All VNF performing this function, running the same
3348 software, coming from the same VNF provider will start with the same 4
3349 characters, in this example, vfdb.
3351 VNF type, determined through these 4 characters, is also known as VNF
3352 Function Code and is assigned by inventory team. All Services Platform
3353 VNF Function Codes can be found in inventory database and/or A&AI as
3354 well as Services Platform Network Design Documents.
3356 NOTE: Current Services Platform naming convention is undergoing changes
3357 to include geographical location to the VNF names.
3359 Version – As in VNF software version is the release of the software
3360 running on the VNF for which the playbooks were developed. VNF
3361 configuration steps may change from release to release and this
3362 <Version> in the path will allow the Ansible Server to host playbooks
3363 associated with each software release. And run the playbooks that match
3364 the software release running on each VNF instance. APPC initially will
3365 not support playbook versioning only latest playbook is supported.
3367 Playbook Function - Is a name associated with a life cycle management
3368 task(s) performed by the playbook(s) stored in this directory. It should
3369 clearly identify the type of action(s) performed by the main playbook
3370 and possibly other playbooks stored in this same directory. Ideally,
3371 playbook function would match APPC corresponding function that executes
3372 the main playbook in this directory. Following Ansible Naming standards
3373 main playbook is usually named site.yml. There can be other playbooks on
3374 the same directory that use a subset of the roles used by the main
3375 playbook site.yml. Examples of Playbook Function directory names:
3377 - configure – Contains post-instantiation (bulk) configuration
3380 - healthcheck – Contains VNF health check playbook(s), roles,…
3382 - stop – Contains VNF application stop playbook(s), roles,…
3384 - start – Contains VNF application start playbook(s), roles,…
3386 Directory structure to allow hosting multiple version sets of playbooks,
3387 for the same VNF type, to be hosted in the runtime environment on the
3388 Ansible Servers. Generic directory structure:
3390 Ansible Playbooks – Function directory and main playbook:
3392 .. code-block:: none
3394 /storage/<VNF type>/<Version>/ansible/<Playbook Function>/site.yml
3396 Example – Post-instantiation (bulk) configuration –APPC Function -
3399 .. code-block:: none
3401 /storage/<VNF type>/<Version>/ansible/configure/site.yml
3403 Example – Health-check –APPC Function - HealthCheck:
3405 .. code-block:: none
3407 /storage/<VNF type>/<Version>/ansible/healthcheck/site.yml
3409 OR (Function directory name does not need to match APPC function name)
3411 .. code-block:: none
3413 /storage/<VNF type>/<Version>/ansible/check/site.yml
3415 Ansible Directories for other artifacts – VNF inventory hosts file -
3418 .. code-block:: none
3420 /storage/<VNF type>/<Version>/ansible/inventory/<VNF instance name>/hosts
3422 Ansible Directories for other artifacts – VNF inventory hosts file –
3425 .. code-block:: none
3427 /storage/<VNF type>/<Version>/ansible/vars/<VNF instance name>/default\_args.yml
3429 NOTE: This requirement is expected to be deprecated in part in the
3430 future, for automated actions, once APPC can pass down all VNF specific
3431 arguments for each action. Requirement remains while manual actions are
3432 to be supported. Other automated inventory management mechanisms may be
3433 considered in the future, Ansible supports many automated inventory
3434 management mechanisms/tools/solutions.
3436 Ansible Directories for other artifacts – VNF (special) groups –
3439 .. code-block:: none
3441 /storage/<VNF type>/<Version>/ansible/groups/<VNF instance name>/common\_groups.yml
3443 NOTE: Default groups will be created based on VNFC type, 3 characters,
3444 on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,…
3446 Ansible Directories for other artifacts – VNF (special) other files –
3447 Optional – Example – License file:
3449 .. code-block:: none
3451 /storage/<VNF type>/<Version>/ansible/<Other directory(s)>
3453 CAUTION: On referenced files used/required by playbooks.
3455 - To avoid missing files, during on-boarding or uploading of Ansible
3456 Playbooks and related artifacts, all permanent files (not generated
3457 by playbooks as part of execution), required to run any playbook,
3458 shall reside under the ansible root directory or below on other
3461 - Any references to files, on includes or other playbook entries, shall
3464 - This is the ansible (root directory) directory referenced on this
3467 .. code-block:: none
3469 /storage/<VNF type>/<Version>/ansible/
3471 There will be a soft link to the latest set of Ansible Playbooks for
3472 each VNF type and this is the default set of playbooks that are executed
3473 unless a different release is specified in APPC request.
3475 VNF type directories use A&AI inventory VNF function code. Ansible
3476 Playbooks will be stored on a Cinder Volume mounted on the Ansible
3477 Servers as /storage. Example:
3479 /storage/vfdb/latest/ansible – This soft link point to the latest set of
3480 playbooks (or the only set)
3482 /storage/vfdb/V16.1/ansible – Root directory for database VNF Ansible
3483 Playbooks for release 16.1
3485 CAUTION: To support this directory structure as the repository to store
3486 Ansible Playbooks run by APPC, APPC API in the Ansible Server side needs
3487 to be configured to run playbooks from directory, not MySQL database.
3489 Ansible Server HTTP will be configured to support APPC REST API requests
3490 to run playbooks as needed, against specific VNF instances, or specific
3491 VM(s) as specified in the request.
3493 ONAP APPC REST API to Ansible Server is documented separately and can be
3494 found under ONAP (onap.org).
3496 **Ansible Server – On-boarding Ansible Playbooks**
3498 Once playbooks are developed following the guidelines listed in prior
3499 section(s), playbooks need to be on-boarded onto Ansible Server(s). In
3500 the future, they’ll be on-boarded and distributed through ONAP, at least
3501 that is the proposed plan, but for now they need to be uploaded
3504 These are the basic steps to on-board playbooks manually onto the
3507 1. Upload CSAR, zip, or tar file containing VNF playbooks and related
3510 2. Create full directory (using –p option below) to store Ansible
3511 Playbooks and other artifacts under /storage file system.
3513 a. Includes VNF type using VNF function code 4 characters under
3516 b. Includes VNF “Version” directory as part of the path to store
3517 playbooks for this VNF version.
3519 c. Include generic ansible root directory. Creating full directory
3522 .. code-block:: none
3524 $ mkdir –p /storage/vfdb/V16.1/ansible**/**
3526 3. Make this directory (VNF ansible root directory) current directory
3529 .. code-block:: none
3531 cd /storage/vfdb/V16.1/ansible/
3533 4. Extract Ansible Playbooks and other Ansible artifacts associated with
3534 the playbooks onto the ansible directory. Command depends on the type
3535 of file uploaded, examples would be:
3537 .. code-block:: none
3543 5. Create directory for VNF (VMs) inventory hosts file with all VMs and
3544 OA&M IP addresses for all VNF instances with known OA&M IP addresses
3545 for respective VMs, example:
3547 .. code-block:: none
3549 $ mkdir –p inventory/vfdb9904v
3551 $ touch inventory/vfdb9904v/hosts
3553 $ cat inventory/vfdb9904v/hosts
3556 localhost ansible\_connection=local
3559 1xx.2yy.zzz.109 ansible\_ssh\_private\_key\_file=/storage/.ssh/Kilo-SSH-Key.pem
3560 1xx.2yy.zzz.110 ansible\_ssh\_private\_key\_file=/storage/.ssh/Kilo-SSH-Key.pem
3563 1xx.2yy.zzz.105 ansible\_ssh\_private\_key\_file=/storage/.ssh/Kilo-SSH-Key.pem
3564 1xx.2yy.zzz.106 ansible\_ssh\_private\_key\_file=/storage/.ssh/Kilo-SSH-Key.pem
3566 6. Create directory to hold default arguments for each VNF instance,
3569 .. code-block:: none
3571 $ mkdir –p vars/vfdb9904v
3572 $ touch vars/vfdb9904v/default\_args.yml
3573 $ cat vars/vfdb9904v/default\_args.yml
3574 vm\_config\_oam1\_vnfc\_name: vfdb9904vm001oam001
3575 vm\_config\_oam1\_hostname: vfdb9904vm001
3576 vm\_config\_oam1\_provider\_ip\_address: 1xx.2yy.zzz.109
3578 vm\_config\_oam2\_vnfc\_name: vfdb9904vm002oam001
3579 vm\_config\_oam2\_hostname: vfdb9904vm002
3580 vm\_config\_oam2\_provider\_ip\_address: 1xx.2yy.zzz.110
3582 vm\_config\_rdb1\_vnfc\_name: vfdb9904vm003rdb001
3583 vm\_config\_rdb1\_hostname: vfdb9904vm003
3584 vm\_config\_rdb1\_provider\_ip\_address: 1xx.2yy.zzz.105
3586 vm\_config\_rdb2\_vnfc\_name: vfdb9904vm004rdb001
3587 vm\_config\_rdb2\_hostname: vfdb9904vm004
3588 vm\_config\_rdb2\_provider\_ip\_address: 1xx.2yy.zzz.106
3590 vm\_config\_rdb3\_vnfc\_name: vfdb9904vm005rdb001
3591 vm\_config\_rdb3\_hostname: vfdb9904vm005
3592 vm\_config\_rdb3\_provider\_ip\_address: 1xx.2yy.zzz.xxx
3594 vm\_config\_rdb4\_vnfc\_name: vfdb9904vm006rdb001
3595 vm\_config\_rdb4\_hostname: vfdb9904vm006
3596 vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy
3598 NOTE: Please note names in this file shall use underscore “\_” not dots
3601 7. Perform some basic playbook validation running with “--check” option,
3602 running dummy playbooks or other.
3604 8. Upload any SSH keys referenced on hosts file to appropriate
3607 NOTE: HOT templates used by Heat to instantiate VNF configured by these
3608 playbooks shall include the same SSH key to be installed as part of
3611 Other non-VNF provider specific playbook tasks need to be incorporated on
3612 overall post-instantiation configuration playbooks or company Playbooks
3613 need to be uploaded and executed after VNF provided or internally
3614 developed playbooks for the VNF.
3618 The “name” field is a mandatory field in a valid Chef Node Object
3622 Not currently supported in ONAP release 1
3625 https://github.com/mbj4668/pyang
3628 Upstream elements must provide the appropriate FQDN in the request to
3629 ONAP for the desired action.
3632 Refer to NCSP’s Network Cloud specification
3635 This option is not currently supported in ONAP and it is currently
3636 under consideration.
3639 Multiple ONAP actions may map to one playbook.
Code Review / vnfrqts / requirements.git / blob