1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property. All rights reserved.
9 Chef JSON Key Value Description
10 -------------------------------------
12 The following provides the key value pairs that must be contained in the
13 JSON file supporting Chef action.
15 Table A1. Chef JSON File key value description
16 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18 +----------------+--------------------------+---------+----------------------+
19 | **Field Name** | **Description** | **Type**| **Comment** |
20 +================+==========================+=========+======================+
21 | Environment | A JSON dictionary | Optional|Depends on VNF action.|
22 | | representing a Chef | | |
23 | | Environment object. If | | |
24 | | the VNF action requires | | |
25 | | loading or modifying Chef| | |
26 | | environment attributes | | |
27 | | associated with the VNF, | | |
28 | | all the relevant | | |
29 | | information must be | | |
30 | | provided in this JSON | | |
31 | | dictionary in a structure| | |
32 | | that conforms to a Chef | | |
33 | | Environment Object. | | |
34 +----------------+--------------------------+---------+----------------------+
35 | Node | A JSON dictionary |Mandatory| |
36 | | representing a Chef Node | | |
39 | | The Node JSON dictionary | | |
40 | | must include the run list| | |
41 | | to be triggered for the | | |
42 | | desired VNF action by the| | |
43 | | push job. It should also | | |
44 | | include any attributes | | |
45 | | that need to be | | |
46 | | configured on the Node | | |
47 | | Object as part of the VNF| | |
49 +----------------+--------------------------+---------+----------------------+
50 | NodeList | Array of FQDNs that |Mandatory| |
51 | | correspond to the | | |
52 | | endpoints (VMs) of a VNF | | |
53 | | registered with the Chef | | |
54 | | Server that need to | | |
55 | | trigger a chef-client run| | |
56 | | as part of the desired | | |
58 +----------------+--------------------------+---------+----------------------+
59 | PushJobFlag | This field indicates |Mandatory| If set to “True”, |
60 | | whether the VNF action | | ONAP will request a |
61 | | requires a push Job. Push| | push job. Ignored |
62 | | job object will be | | otherwise. |
63 | | created by ONAP if | | |
65 +----------------+--------------------------+---------+----------------------+
66 | CallbackCapable| This field indicates if | Optional| If Chef cookbook is |
67 | | the chef-client run | | callback capable, VNF|
68 | | invoked by push job | | owner is required to |
69 | | corresponding to the VNF | | set it to “True”. |
70 | | action is capable of | | Ignored otherwise. |
71 | | posting results on a | | |
72 | | callback URL. | | |
73 +----------------+--------------------------+---------+----------------------+
74 | GetOutputFlag | Flag which indicates |Mandatory| ONAP will retrieve |
75 | | whether ONAP should | | output from |
76 | | retrieve output generated| | NodeObject attributes|
77 | | in a chef-client run from| | [‘PushJobOutput’] for|
78 | | Node object attribute | | all nodes in NodeList|
79 | | node[‘PushJobOutput’] for| | if set to “True”. |
80 | | this VNF action (e.g., in| | Ignored otherwise. |
82 +----------------+--------------------------+---------+----------------------+
84 Chef Template example:
90 "description": "VNF Chef environment for HAR",
91 "json\_class": "Chef::Environment",
92 "chef\_type": "environment",
93 "default\_attributes": { },
94 "override\_attributes": {
97 “Database\_IP”:”10.10.1.5”
102 “name” : “signal.network.com “
103 "chef\_type": "node",
104 "json\_class": "Chef::Node",
106 “IPAddress1”: “192.168.1.2”,
107 “IPAddress2”:”135.16.162.5”,
114 “chef\_environment” : “\_default”
115 "run\_list": [ "configure\_signal" ]
117 “NodeList”:[“node1.vnf\_a.onap.com”, “node2.vnf\_a.onap.com”],
118 “PushJobFlag”: “True”
119 “CallbackCapable”:True
120 “GetOutputFlag” : “False”
123 The example JSON file provided by the VNF provider for each VNF action will be
124 turned into a template by ONAP, that can be updated with instance
125 specific values at run-time.
127 Some points worth noting regarding the JSON fields:
129 a. The JSON file must be created for each action for each VNF.
131 b. If a VNF action involves multiple endpoints (VMs) of a VNF, ONAP will
132 replicate the “Node” JSON dictionary in the template and post it to
133 each FQDN (i.e., endpoint) in the NodeList after setting the “name”
134 field in the Node object to be the respective FQDN [1]_. Hence, it
135 is required that all end points (VMs) of a VNF involved in a VNF
136 action support the same set of Node Object attributes.
138 The following table describes the JSON dictionary to post in Callback.
140 Table A2. JSON Dictionary to Post in Callback
141 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143 +--------------+----------------------------+---------+-----------------------+
144 | **Key** | **Description** | **Type**| **Comment** |
145 +==============+============================+=========+=======================+
146 | RequestId | A unique string associated |Mandatory| |
147 | | with the original request | | |
148 | | by ONAP. This key-value | | |
149 | | pair will be provided by | | |
150 | | ONAP in the environment of | | |
151 | | the push job request and | | |
152 | | must be returned as part of| | |
153 | | the POST message. | | |
154 +--------------+----------------------------+---------+-----------------------+
155 | StatusCode | An integer that must be set|Mandatory| |
156 | | to 200 if chef-client run | | |
157 | | on the node finished | | |
158 | | successfully 500 otherwise.| | |
159 +--------------+----------------------------+---------+-----------------------+
160 | StatusMessage| A string which must be set |Mandatory| |
161 | | to ‘SUCCESS’ if StatusCode | | |
164 | | Appropriate error message | | |
166 +--------------+----------------------------+---------+-----------------------+
167 | Name | A string which corresponds |Mandatory| |
168 | | to the name of the node | | |
169 | | where push job is run. It | | |
170 | | is required that the value | | |
171 | | be retrieved from the node | | |
172 | | object attributes (where it| | |
173 | | is always defined). | | |
174 +--------------+----------------------------+---------+-----------------------+
175 | PushJobOutput| Any output from the |Optional | Depends on VNF action.|
176 | | chef-client run that needs | | If empty, it must not |
177 | | to be returned to ONAP. | | be included. |
178 +--------------+----------------------------+---------+-----------------------+
180 Ansible JSON Key Value Description
181 -------------------------------------------------------------
183 The following provides the key value pairs that must be contained in the
184 JSON file supporting Ansible action.
186 Table B1. Ansible JSON File key value description
187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
189 +---------------+----------------------+---------+----------------------------+
190 | **Field Name**| **Description** | **Type**| **Comment** |
191 +===============+======================+=========+============================+
192 | PlaybookName | VNF providor must |Mandatory|Currently following |
193 | | list name of the | |Ansible standard |
194 | | playbook relative | |naming, where main |
195 | | path used to | |playbook is always |
196 | | execute the VNF | |named site.yml, and |
197 | | action. | |directory name where |
198 | | | |this main playbook resides, |
199 | | | |is named after the |
200 | | | |command/action playbook |
201 | | | |performs, in lower case, |
202 | | | |example, configure. |
203 +---------------+----------------------+---------+----------------------------+
204 | Action | Name of VNF action. | Optional| |
205 +---------------+----------------------+---------+----------------------------+
206 | EnvParameters | A JSON dictionary | Optional|Depends on the VNF action. |
207 | | which should list key| | |
208 | | value pairs to be | |Attribute names (variable |
209 | | passed to the Ansible| |names) passed to Ansible |
210 | | playbook. These | |shall follow Ansible valid |
211 | | values would | |variable names: “Variable |
212 | | correspond to | |names should be letters, |
213 | | instance specific | |numbers, and underscores. |
214 | | parameters that a | |Variables should always |
215 | | playbook may need to | |start with a letter.” |
216 | | execute an action. | | |
217 +---------------+----------------------+---------+----------------------------+
218 | NodeList |Ansible inventory | Optional|If not provided, pre-loaded |
219 | |hosts file with | |(VNF) inventory hosts |
220 | |VNF groups and | |file must exist in the |
221 | |respective IP | |Ansible Server otherwise |
222 | |addresses or DNS | |request fails. |
223 | |supported FQDNs | | |
224 | |that the playbook must| | |
225 | |be executed against. | | |
226 +---------------+----------------------+---------+----------------------------+
227 | FileParameters| A JSON dictionary | Optional| Depends on the VNF action |
228 | | where keys are | | and playbook design. |
229 | | filenames and values | | |
230 | | are contents of | | |
231 | | files. The Ansible | | |
232 | | Server will utilize | | |
233 | | this feature to | | |
234 | | generate files with | | |
235 | | keys as filenames and| | |
236 | | values as content. | | |
237 | | This attribute can be| | |
238 | | used to generate | | |
239 | | files that a playbook| | |
240 | | may require as part | | |
241 | | of execution. | | |
242 +---------------+----------------------+---------+----------------------------+
243 | Timeout | Time (in seconds) | Optional| |
244 | | that a playbook is | | |
245 | | expected to take to | | |
246 | | finish execution for | | |
247 | | the VNF. If playbook | | |
248 | | execution time | | |
249 | | exceeds this value, | | |
250 | | Ansible Server will | | |
251 | | terminate the | | |
252 | | playbook process. | | |
253 +---------------+----------------------+---------+----------------------------+
255 Ansible JSON file example:
259 “Action”:”Configure”,
261 "PlaybookName": "<VNFCode>/<Version>/ansible/configure/site.yml",
263 "NodeList": ["test1.vnf\_b.onap.com", “test2.vnf\_b.onap.com”],
267 "EnvParameters": {"Retry": 3, "Wait": 5, “ConfigFile”:”config.txt”},
269 “FileParameters”:{“config.txt”:”db\_ip=10.1.1.1, sip\_timer=10000”}
273 In the above example, the Ansible Server will:
275 a. Process the “FileParameters” dictionary and generate a file named
276 ‘config.txt’ with contents set to the value of the ‘config.txt’ key.
278 b. Execute the playbook named ‘<VNFCode>/<Version>/ansible/configure/site.yml’
279 on nodes with FQDNs test1.vnf\_b.onap.com and test2.vnf\_b.onap.com
280 respectively while providing the following key value pairs to the playbook:
281 Retry=3, Wait=5, ConfigFile=config.txt
284 c. If execution time of the playbook exceeds 60 secs (across all hosts),
285 it will be terminated.
287 VNF License Information Guidelines
288 ------------------------------------------------------------
290 This Appendix describes the metadata to be supplied for VNF licenses.
292 1. General Information
294 Table C1 defines the required and optional fields for licenses.
296 Table C1. Required Fields for General Information
297 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
299 +---------------+-----------------------------------+--------------+----------+
300 | **Field Name**| **Description** | **Data Type**| **Type** |
301 +===============+===================================+==============+==========+
302 | VNF Provider | The name of the VNF provider. | String | Mandatory|
304 +---------------+-----------------------------------+--------------+----------+
305 | VNF Provider | The name of the product to which | String | Mandatory|
306 | Product | this agreement applies. | | |
308 | | Note: a contract/agreement may | | |
309 | | apply to more than one VNF | | |
310 | | provider product. In that case, | | |
311 | | provide the metadata for each | | |
312 | | product separately. | | |
313 +---------------+-----------------------------------+--------------+----------+
314 | VNF Provider | A general description of VNF | String | Optional |
315 | Product | provider software product. | | |
316 | Description | | | |
317 +---------------+-----------------------------------+--------------+----------+
318 | Export Control| ECCNs are 5-character | String | Mandatory|
319 | Classification| alpha-numeric designations used on| | |
320 | Number (ECCN) | the Commerce Control List (CCL) to| | |
321 | | identify dual-use items for export| | |
322 | | control purposes. An ECCN | | |
323 | | categorizes items based on the | | |
324 | | nature of the product, i.e. type | | |
325 | | of commodity, software, or | | |
326 | | technology and its respective | | |
327 | | technical parameters. | | |
328 +---------------+-----------------------------------+--------------+----------+
329 | Reporting | A list of any reporting | List of | Optional |
330 | Requirements | requirements on the usage of the | strings | |
331 | | software product. | | |
332 +---------------+-----------------------------------+--------------+----------+
336 Entitlements describe software license use rights. The use rights may be
337 quantified by various metrics: # users, # software instances, # units.
338 The use rights may be limited by various criteria: location (physical or
339 logical), type of customer, type of device, time, etc.
341 One or more entitlements can be defined; each one consists of the
344 Table C2. Required Fields for Entitlements
345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
347 +---------------+-----------------------------------+-------------+-----------+
348 | **Field Name**| **Description** |**Data Type**| **Type** |
349 +===============+===================================+=============+===========+
350 | VNF Provider | Identifier for the entitlement as | String | Mandatory |
351 | Part Number / | described by the VNF provider in | | |
352 | Manufacture | their price list / catalog / | | |
353 | Reference | contract. | | |
355 +---------------+-----------------------------------+-------------+-----------+
356 | Description | Verbiage that describes the | String | Optional |
357 | | entitlement | | |
358 +---------------+-----------------------------------+-------------+-----------+
359 | Entitlement | Each entitlement defined must be | String | Mandatory |
360 | Identifier | identified by a unique value (e.g.| | |
361 | | numbered 1, 2, 3….) | | |
362 +---------------+-----------------------------------+-------------+-----------+
363 | Minimum Order | The minimum number of entitlements| Number | Mandatory |
364 | Requirement | that need to be purchased. | | |
365 | | For example, the entitlements must| | |
366 | | be purchased in a block of 100. If| | |
367 | | no minimum is required, the value | | |
368 | | will be zero. | | |
369 +---------------+-----------------------------------+-------------+-----------+
370 | Unique | A list of any reporting | List of | Optional |
371 | Reporting | requirements on the usage of the | Strings | |
372 | Requirements | software product. (e.g.: quarterly| | |
373 | | usage reports are required) | | |
374 +---------------+-----------------------------------+-------------+-----------+
375 | License Type | Type of license applicable to the | String | Mandatory |
376 | | software product. (e.g.: | | |
377 | | fixed-term, perpetual, trial, | | |
378 | | subscription.) | | |
379 +---------------+-----------------------------------+-------------+-----------+
380 | License | Valid values: | String |Conditional|
382 | | **year**, **quarter**, **month**, | | |
385 | | Not applicable when license type | | |
386 | | is Perpetual. | | |
387 +---------------+-----------------------------------+-------------+-----------+
388 | License | Number of years, quarters, months,| Number |Conditional|
389 | Duration | or days for which the license is | | |
390 | Quantification| valid. | | |
392 | | Not applicable when license type | | |
393 | | is Perpetual. | | |
394 +---------------+-----------------------------------+-------------+-----------+
395 | Limits | see section C.4 for possible | List | Optional |
397 +---------------+-----------------------------------+-------------+-----------+
401 This section defines information on any License Keys associated with the
402 Software Product. A license key is a data string (or a file) providing a
403 means to authorize the use of software. License key does not provide
404 entitlement information.
406 License Keys are not required. Optionally, one or more license keys can
407 be defined; each one consists of the following fields:
409 Table C3. Required Fields for License Keys
410 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
412 +---------------+-----------------------------------+--------------+----------+
413 | **Field Name**| **Description** | **Data Type**| **Type** |
414 +===============+===================================+==============+==========+
415 | Description | Verbiage that describes the | String | Mandatory|
416 | | license key | | |
417 +---------------+-----------------------------------+--------------+----------+
418 | License Key | Each license key defined must be | String | Mandatory|
419 | Identifier | identified by a unique value | | |
420 | | (e.g., numbered 1, 2, 3….) | | |
421 +---------------+-----------------------------------+--------------+----------+
422 | Key Function | Lifecycle stage (e.g., | String | Optional |
423 | | Instantiation or Activation) at | | |
424 | | which the license key is applied | | |
425 | | to the software. | | |
426 +---------------+-----------------------------------+--------------+----------+
427 | License Key | Valid values: | String | Mandatory|
429 | | **Universal, Unique** | | |
431 | | **Universal** - a single license | | |
432 | | key value that may be used with | | |
433 | | any number of instances of the | | |
436 | | **Unique**- a unique license key | | |
437 | | value is required for each | | |
438 | | instance of the software. | | |
439 +---------------+-----------------------------------+--------------+----------+
440 | Limits | see section C.4 for possible | List | Optional |
442 +---------------+-----------------------------------+--------------+----------+
444 1. Entitlement and License Key Limits
446 Limitations on the use of software entitlements and license keys may be
447 based on factors such as: features enabled in the product, the allowed
448 capacity of the product, number of installations, etc... The limits may
449 generally be categorized as:
461 Multiple limits may be applicable for an entitlement or license key.
462 Each limit may further be described by limit behavior, duration,
463 quantification, aggregation, aggregation interval, start date, end date,
466 When the limit is associated with a quantity, the quantity is relative
467 to an instance of the entitlement or license key. For example:
469 - Each entitlement grants the right to 50 concurrent users. If 10
470 entitlements are purchased, the total number of concurrent users
471 permitted would be 500. In this example, the limit category is
472 **amount**, the limit type is **users**, and the limit
473 **quantification** is **50.**
475 Each license key may be installed on 3 devices. If 5 license keys are
476 acquired, the total number of devices allowed would be 15. In this
477 example, the limit category is **usages**, the limit type is
478 **device**, and the limit **quantification** is **3.**
482 Locations may be logical or physical location (e.g., site, country). For
485 - use is allowed in Canada
487 Table C4. Required Fields for Location
488 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
490 +------------------+--------------------------------+--------------+----------+
491 | **Field Name** | **Description** | **Data Type**| **Type** |
492 +==================+================================+==============+==========+
493 | Limit Identifier | Each limit defined for an | String | Mandatory|
494 | | entitlement or license key must| | |
495 | | be identified by a unique value| | |
496 | | (e.g., numbered 1,2,3…) | | |
497 +------------------+--------------------------------+--------------+----------+
498 | Limit Description| Verbiage describing the limit. | String | Mandatory|
499 +------------------+--------------------------------+--------------+----------+
500 | Limit Behavior | Description of the actions | String | Mandatory|
501 | | taken when the limit boundaries| | |
502 | | are reached. | | |
503 +------------------+--------------------------------+--------------+----------+
504 | Limit Category | Valid value: **location** | String | Mandatory|
505 +------------------+--------------------------------+--------------+----------+
506 | Limit Type | Valid values: **city, county, | String | Mandatory|
507 | | state, country, region, MSA, | | |
508 | | BTA, CLLI** | | |
509 +------------------+--------------------------------+--------------+----------+
510 | Limit List | List of locations where the VNF| List of | Mandatory|
511 | | provider Product can be used or| String | |
512 | | needs to be restricted from use| | |
513 +------------------+--------------------------------+--------------+----------+
514 | Limit Set Type | Indicates if the list is an | String | Mandatory|
515 | | inclusion or exclusion. | | |
517 | | Valid Values: | | |
519 | | **Allowed** | | |
521 | | **Not allowed** | | |
522 +------------------+--------------------------------+--------------+----------+
523 | Limit | The quantity (amount) the limit| Number | Optional |
524 | Quantification | expresses. | | |
525 +------------------+--------------------------------+--------------+----------+
529 Limit on the length of time the software may be used. For example:
531 - license key valid for 1 year from activation
533 - entitlement valid from 15 May 2018 thru 30 June 2020
535 Table C5. Required Fields for Time
536 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
538 +------------------+-------------------------------+--------------+-----------+
539 | **Field Name** | **Description** | **Data Type**| **Type** |
540 +==================+===============================+==============+===========+
541 | Limit Identifier | Each limit defined for an | String | Mandatory |
542 | | entitlement or license key | | |
543 | | must be identified by a unique| | |
544 | | value (e.g., numbered) | | |
545 +------------------+-------------------------------+--------------+-----------+
546 | Limit Description| Verbiage describing the limit.| String | Mandatory |
547 +------------------+-------------------------------+--------------+-----------+
548 | Limit Behavior | Description of the actions | String | Mandatory |
549 | | taken when the limit | | |
550 | | boundaries are reached. | | |
552 | | The limit behavior may also | | |
553 | | describe when a time limit | | |
554 | | takes effect. (e.g., key is | | |
555 | | valid for 1 year from date of | | |
557 +------------------+-------------------------------+--------------+-----------+
558 | Limit Category | Valid value: **time** | String | Mandatory |
559 +------------------+-------------------------------+--------------+-----------+
560 | Limit Type | Valid values: | String | Mandatory |
561 | | **duration, date** | | |
562 +------------------+-------------------------------+--------------+-----------+
563 | Limit List | List of times for which the | List of | Mandatory |
564 | | VNF Provider Product can be | String | |
565 | | used or needs to be restricted| | |
567 +------------------+-------------------------------+--------------+-----------+
568 | Duration Units | Required when limit type is | String |Conditional|
569 | | duration. Valid values: | | |
570 | | **perpetual, year, quarter, | | |
571 | | month, day, minute, second, | | |
572 | | millisecond** | | |
573 +------------------+-------------------------------+--------------+-----------+
574 | Limit | The quantity (amount) the | Number | Optional |
575 | Quantification | limit expresses. | | |
576 +------------------+-------------------------------+--------------+-----------+
577 | Start Date | Required when limit type is | Date | Optional |
579 +------------------+-------------------------------+--------------+-----------+
580 | End Date | May be used when limit type is| Date | Optional |
582 +------------------+-------------------------------+--------------+-----------+
586 Limits based on how the software is used. For example:
588 - use is limited to a specific sub-set of the features/capabilities the
591 - use is limited to a certain environment (e.g., test, development,
594 - use is limited by processor (vm, cpu, core)
596 - use is limited by software release
598 Table C6. Required Fields for Usage
599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
601 +------------------+-------------------------------+---------------+----------+
602 | **Field Name** | **Description** | **Data Type** | **Type** |
603 +==================+===============================+===============+==========+
604 | Limit Identifier | Each limit defined for an | String | Mandatory|
605 | | entitlement or license key | | |
606 | | must be identified by a unique| | |
607 | | value (e.g., numbered) | | |
608 +------------------+-------------------------------+---------------+----------+
609 | Limit Description| Verbiage describing the limit.| String | Mandatory|
610 +------------------+-------------------------------+---------------+----------+
611 | Limit Behavior | Description of the actions | String | Mandatory|
612 | | taken when the limit | | |
613 | | boundaries are reached. | | |
614 +------------------+-------------------------------+---------------+----------+
615 | Limit Category | Valid value: **usages** | String | Mandatory|
616 +------------------+-------------------------------+---------------+----------+
617 | Limit Type | Valid values: **feature, | String | Mandatory|
618 | | environment, processor, | | |
620 +------------------+-------------------------------+---------------+----------+
621 | Limit List | List of usage limits (e.g., | List of String| Mandatory|
622 | | test, development, vm, core, | | |
623 | | R1.2.1, R1.3.5…) | | |
624 +------------------+-------------------------------+---------------+----------+
625 | Limit Set Type | Indicates if the list is an | String | Mandatory|
626 | | inclusion or exclusion. | | |
628 | | Valid Values: | | |
630 | | **Allowed** | | |
632 | | **Not allowed** | | |
633 +------------------+-------------------------------+---------------+----------+
634 | Limit | The quantity (amount) the | Number | Optional |
635 | Quantification | limit expresses. | | |
636 +------------------+-------------------------------+---------------+----------+
640 Limit on the entity (product line, organization, customer) allowed to
641 make use of the software. For example:
643 - allowed to be used in support of wireless products
645 - allowed to be used only for government entities
647 Table C7. Required Fields for Entity
648 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
650 +------------------+--------------------------------+--------------+----------+
651 | **Field Name** | **Description** |**Data Type** | **Type** |
652 +==================+================================+==============+==========+
653 | Limit Identifier | Each limit defined for an | String | Mandatory|
654 | | entitlement or license key must| | |
655 | | be identified by a unique value| | |
656 | | (e.g., numbered) | | |
657 +------------------+--------------------------------+--------------+----------+
658 | Limit Description| Verbiage describing the limit. | String | Mandatory|
659 +------------------+--------------------------------+--------------+----------+
660 | Limit Behavior | Description of the actions | String | Mandatory|
661 | | taken when the limit boundaries| | |
662 | | are reached. | | |
663 +------------------+--------------------------------+--------------+----------+
664 | Limit Category | Valid value: **entity** | String | Mandatory|
665 +------------------+--------------------------------+--------------+----------+
666 | Limit Type | Valid values: **product line, | String | Mandatory|
667 | | organization, internal | | |
668 | | customer, external customer** | | |
669 +------------------+--------------------------------+--------------+----------+
670 | Limit List | List of entities for which the |List of String| Mandatory|
671 | | VNF Provider Product can be | | |
672 | | used or needs to be restricted | | |
674 +------------------+--------------------------------+--------------+----------+
675 | Limit Set Type | Indicates if the list is an | String | Mandatory|
676 | | inclusion or exclusion. | | |
678 | | Valid Values: | | |
680 | | **Allowed** | | |
682 | | **Not allowed** | | |
683 +------------------+--------------------------------+--------------+----------+
684 | Limit | The quantity (amount) the limit| Number | Optional |
685 | Quantification | expresses. | | |
686 +------------------+--------------------------------+--------------+----------+
690 These limits describe terms relative to utilization of the functions of
691 the software (for example, number of named users permitted, throughput,
692 or capacity). Limits of this type may also be relative to utilization of
693 other resources (for example, a limit for firewall software is not based
694 on use of the firewall software, but on the number of network
697 The metadata describing this type of limit includes the unit of measure
698 (e.g., # users, # sessions, # MB, # TB, etc.), the quantity of units,
699 any aggregation function (e.g., peak or average users), and aggregation
700 interval (day, month, quarter, year, etc.).
702 Table C8. Required Fields for Amount
703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
705 +------------------+---------------------------------+-------------+----------+
706 | **Field Name** | **Description** |**Data Type**| **Type** |
707 +==================+=================================+=============+==========+
708 | Limit Identifier | Each limit defined for an | String | Mandatory|
709 | | entitlement or license key must | | |
710 | | be identified by a unique value | | |
711 | | (e.g., numbered) | | |
712 +------------------+---------------------------------+-------------+----------+
713 | Limit Description| Verbiage describing the limit. | String | Mandatory|
714 +------------------+---------------------------------+-------------+----------+
715 | Limit Behavior | Description of the actions taken| String | Mandatory|
716 | | when the limit boundaries are | | |
718 +------------------+---------------------------------+-------------+----------+
719 | Limit Category | Valid value: **amount** | String | Mandatory|
720 +------------------+---------------------------------+-------------+----------+
721 | Limit Type | Valid values: **trunk, user, | String | Mandatory|
722 | | subscriber, session, token, | | |
723 | | transactions, seats, KB, MB, TB,| | |
725 +------------------+---------------------------------+-------------+----------+
726 | Type of | Is the limit relative to | String | Mandatory|
727 | Utilization | utilization of the functions of | | |
728 | | the software or relative to | | |
729 | | utilization of other resources? | | |
731 | | Valid values: | | |
733 | | - **software functions** | | |
735 | | - **other resources** | | |
736 +------------------+---------------------------------+-------------+----------+
737 | Limit | The quantity (amount) the limit | Number | Optional |
738 | Quantification | expresses. | | |
739 +------------------+---------------------------------+-------------+----------+
740 | Aggregation | Valid values: **peak, average** | String | Optional |
742 +------------------+---------------------------------+-------------+----------+
743 | Aggregation | Time period over which the | String | Optional |
744 | Interval | aggregation is done (e.g., | | |
745 | | average sessions per quarter). | | |
746 | | Required when an Aggregation | | |
747 | | Function is specified. | | |
749 | | Valid values: **day, month, | | |
750 | | quarter, year, minute, second, | | |
751 | | millisecond** | | |
752 +------------------+---------------------------------+-------------+----------+
753 | Aggregation | Is the limit quantity applicable| String | Optional |
754 | Scope | to a single entitlement or | | |
755 | | license key (each separately)? | | |
756 | | Or may the limit quantity be | | |
757 | | combined with others of the same| | |
758 | | type (resulting in limit amount | | |
759 | | that is the sum of all the | | |
760 | | purchased entitlements or | | |
761 | | license keys)? | | |
763 | | Valid values: | | |
765 | | - **single** | | |
767 | | - **combined** | | |
768 +------------------+---------------------------------+-------------+----------+
769 | Type of User | Describes the types of users of | String | Optional |
770 | | the functionality offered by the| | |
771 | | software (e.g., authorized, | | |
772 | | named). This field is included | | |
773 | | when Limit Type is user. | | |
774 +------------------+---------------------------------+-------------+----------+
777 -----------------------------
779 Table D1. ONAP Resource DM TOSCA/YAML constructs
780 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
782 Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by
783 VNF vendors to create a standard VNF descriptor.
785 All definitions are summarized in the table below based on the agreed ONAP
786 Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in
787 ETSI GS NFV-SOL001 stable draft for VNF-D.
789 +------------+------------------------------+---------------------------------+
790 | Requirement| Resource IM Info Elements | TOSCA Constructs as per SOL001 |
792 +============+==============================+=================================+
793 | R-02454 | VNFD.vnfSoftwareVersion | For VDU.Compute - |
794 | | | tosca.artifacts.nfv.SwImage |
796 | | SwImageDesc.Version | For Virtual Storage - |
797 | | | tosca.artifacts.Deployment.Image|
798 +------------+------------------------------+---------------------------------+
799 | R-03070 | vnfExtCpd's with virtual | tosca.nodes.nfv.VnfExtCp with a |
800 | | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\ |
801 | | (vNIC) | VirtualNetworkInterface\ |
803 +------------+------------------------------+---------------------------------+
804 | R-09467 | VDU.Compute descriptor | tosca.nodes.nfv.Vdu.Compute |
805 +------------+------------------------------+---------------------------------+
806 | R-16065 | VDU.Compute. Configurable | tosca.datatypes.nfv.Vnfc |
807 | | Properties | ConfigurableProperties |
808 +------------+------------------------------+---------------------------------+
809 | R-30654 | VNFD.lifeCycleManagement | Interface construct tosca.\ |
810 | | Script - IFA011 LifeCycle\ | interfaces.nfv.vnf.lifecycle.Nfv|
811 | | ManagementScript | with a list of standard LCM |
813 +------------+------------------------------+---------------------------------+
814 | R-35851 | CPD: VduCp, VnfExtCp, | tosca.nodes.nfv.VduCp, tosca.\ |
815 | | VnfVirtualLinkDesc, QoS | nodes.nfv.VnfVirtualLink, |
816 | | Monitoring info element - | tosca.nodes.nfv.VnfExtCp |
818 +------------+------------------------------+---------------------------------+
819 | R-41215 | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile |
820 | | aspect | and tosca.datatypes.nfv.\ |
821 | | | ScalingAspect |
822 +------------+------------------------------+---------------------------------+
823 | R-66070 | VNFD meta data | tosca.datatypes.nfv. |
824 | | | VnfInfoModifiableAttributes - |
826 +------------+------------------------------+---------------------------------+
827 | R-96634 | VNFD.configurableProperties | tosca.datatypes.nfv.Vnf\ |
828 | | describing scaling | ConfigurableProperties, |
829 | | characteristics. VNFD.\ | tosca.datatypes.nfv.ScaleInfo |
830 | | autoscale defines the rules | |
831 | | for scaling based on specific| |
832 | | VNF indications | |
833 +------------+------------------------------+---------------------------------+
834 | ? | VDU Virtual Storage | tosca.nodes.nfv.Vdu.\ |
835 | | | VirtualStorage |
836 +------------+------------------------------+---------------------------------+
837 | R-01478 | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - |
838 | | - SOL001 per VNF/VDU/VLink | type for monitoring |
839 | R-01556 | memory-consumption, | |
840 | | CPU-utilization, | monitoring_parameter of above |
841 | | bandwidth-consumption, VNFC | type per VNF/VDU/VLink |
842 | | downtime, etc. | |
843 +------------+------------------------------+---------------------------------+
846 Table D2. TOSCA CSAR structure
847 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
849 This section defines the requirements around the CSAR structure.
851 The table below describes the numbered requirements for CSAR structure as
852 agreed with SDC. The format of the CSAR is specified in SOL004.
854 +------------+-------------------------------------+--------------------------+
855 | Requirement| Description | CSAR artifact directory |
857 +============+=====================================+==========================+
858 | R-26881 | The VNF provider MUST provide the | ROOT\\Artifacts\ |
859 | | binaries and images needed to | \\VNF_Image.bin |
860 | | instantiate the VNF (VNF and VNFC | |
862 +------------+-------------------------------------+--------------------------+
863 | R-30654 | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\ |
864 | | includes a list of events and | \\Informational\ |
865 | | corresponding management scripts | \\Install.csh |
866 | | performed for the VNF - SOL001 | |
867 +------------+-------------------------------------+--------------------------+
868 | R-35851 | All VNF topology related definitions| ROOT\\Definitions\ |
869 | | in yaml files VNFD/Main Service | \\VNFC.yaml |
870 | | template at the ROOT | |
872 | | | \\MainService\ |
873 | | | \\Template.yaml |
874 +------------+-------------------------------------+--------------------------+
875 | R-40827 | CSAR License directory - SOL004 | ROOT\\Licenses\ |
876 | | | \\License_term.txt |
877 +------------+-------------------------------------+--------------------------+
878 | R-77707 | CSAR Manifest file - SOL004 | ROOT\ |
879 | | | \\MainServiceTemplate.mf |
880 +------------+-------------------------------------+--------------------------+
884 --------------------------------
886 **VNF Development Requirements**
887 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892 R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs.
894 R-82223 The VNF **MUST** be decomposed if the functions have
895 significantly different scaling characteristics (e.g., signaling
896 versus media functions, control versus data plane functions).
898 R-16496 The VNF **MUST** enable instantiating only the functionality that
899 is needed for the decomposed VNF (e.g., if transcoding is not needed it
900 should not be instantiated).
902 R-02360 The VNFC **MUST** be designed as a standalone, executable process.
904 R-34484 The VNF **SHOULD** create a single component VNF for VNFCs
905 that can be used by other VNFs.
907 R-23035 The VNF **MUST** be designed to scale horizontally (more
908 instances of a VNF or VNFC) and not vertically (moving the existing
909 instances to larger VMs or increasing the resources within a VM)
910 to achieve effective utilization of cloud resources.
912 R-30650 The VNF **MUST** utilize cloud provided infrastructure and
913 VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so
914 that the cloud can manage and provide a consistent service resiliency
915 and methods across all VNF's.
917 R-12709 The VNFC **SHOULD** be independently deployed, configured,
918 upgraded, scaled, monitored, and administered by ONAP.
920 R-37692 The VNFC **MUST** provide API versioning to allow for
921 independent upgrades of VNFC.
923 R-86585 The VNFC **SHOULD** minimize the use of state within
924 a VNFC to facilitate the movement of traffic from one instance
927 R-65134 The VNF **SHOULD** maintain state in a geographically
928 redundant datastore that may, in fact, be its own VNFC.
930 R-75850 The VNF **SHOULD** decouple persistent data from the VNFC
931 and keep it in its own datastore that can be reached by all instances
932 of the VNFC requiring the data.
934 R-88199 The VNF **MUST** utilize a persistent datastore service that
935 can meet the data performance/latency requirements. (For example:
936 Datastore service could be a VNFC in VNF or a DBaaS in the Cloud
937 execution environment)
939 R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC
942 R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring
943 high packets/sec performance. High packet throughput is defined as greater
944 than 500K packets/sec.
946 R-54430 The VNF **MUST** use the NCSP’s supported library and compute
947 flavor that supports DPDK to optimize network efficiency if using DPDK. [5]_
949 R-18864 The VNF **MUST** NOT use technologies that bypass virtualization
950 layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary
951 to meet functional or performance requirements).
953 R-64768 The VNF **MUST** limit the size of application data packets
954 to no larger than 9000 bytes for SDN network-based tunneling when
955 guest data packets are transported between tunnel endpoints that
956 support guest logical networks.
958 R-74481 The VNF **MUST** NOT require the use of a dynamic routing
959 protocol unless necessary to meet functional requirements.
962 ~~~~~~~~~~~~~~~~~~~~~~~~~
964 R-52499 The VNF **MUST** meet their own resiliency goals and not rely
965 on the Network Cloud.
967 R-42207 The VNF **MUST** design resiliency into a VNF such that the
968 resiliency deployment model (e.g., active-active) can be chosen at
971 R-03954 The VNF **MUST** survive any single points of failure within
972 the Network Cloud (e.g., virtual NIC, VM, disk failure).
974 R-89010 The VNF **MUST** survive any single points of software failure
975 internal to the VNF (e.g., in memory structures, JMS message queues).
977 R-67709 The VNF **MUST** be designed, built and packaged to enable
978 deployment across multiple fault zones (e.g., VNFCs deployed in
979 different servers, racks, OpenStack regions, geographies) so that
980 in the event of a planned/unplanned downtime of a fault zone, the
981 overall operation/throughput of the VNF is maintained.
983 R-35291 The VNF **MUST** support the ability to failover a VNFC
984 automatically to other geographically redundant sites if not
985 deployed active-active to increase the overall resiliency of the VNF.
987 R-36843 The VNF **MUST** support the ability of the VNFC to be deployable
988 in multi-zoned cloud sites to allow for site support in the event of cloud
989 zone failure or upgrades.
991 R-00098 The VNF **MUST NOT** impact the ability of the VNF to provide
992 service/function due to a single container restart.
994 R-79952 The VNF **SHOULD** support container snapshots if not for rebuild
995 and evacuate for rollback or back out mechanism.
997 R-92935 The VNF **SHOULD** minimize the propagation of state information
998 across multiple data centers to avoid cross data center traffic.
1000 R-26371 The VNF **MUST** detect communication failure for inter VNFC
1001 instance and intra/inter VNF and re-establish communication
1002 automatically to maintain the VNF without manual intervention to
1003 provide service continuity.
1005 R-18725 The VNF **MUST** handle the restart of a single VNFC instance
1006 without requiring all VNFC instances to be restarted.
1008 R-06668 The VNF **MUST** handle the start or restart of VNFC instances
1009 in any order with each VNFC instance establishing or re-establishing
1010 required connections or relationships with other VNFC instances and/or
1011 VNFs required to perform the VNF function/role without requiring VNFC
1012 instance(s) to be started/restarted in a particular order.
1014 R-80070 The VNF **MUST** handle errors and exceptions so that they do
1015 not interrupt processing of incoming VNF requests to maintain service
1016 continuity (where the error is not directly impacting the software
1017 handling the incoming request).
1019 R-32695 The VNF **MUST** provide the ability to modify the number of
1020 retries, the time between retries and the behavior/action taken after
1021 the retries have been exhausted for exception handling to allow the
1022 NCSP to control that behavior, where the interface and/or functional
1023 specification allows for altering behaviour.
1025 R-48356 The VNF **MUST** fully exploit exception handling to the extent
1026 that resources (e.g., threads and memory) are released when no longer
1027 needed regardless of programming language.
1029 R-67918 The VNF **MUST** handle replication race conditions both locally
1030 and geo-located in the event of a data base instance failure to maintain
1033 R-36792 The VNF **MUST** automatically retry/resubmit failed requests
1034 made by the software to its downstream system to increase the success rate.
1036 R-70013 The VNF **MUST NOT** require any manual steps to get it ready for
1037 service after a container rebuild.
1039 R-65515 The VNF **MUST** provide a mechanism and tool to start VNF
1040 containers (VMs) without impacting service or service quality assuming
1041 another VNF in same or other geographical location is processing service
1044 R-94978 The VNF **MUST** provide a mechanism and tool to perform a graceful
1045 shutdown of all the containers (VMs) in the VNF without impacting service
1046 or service quality assuming another VNF in same or other geographical
1047 location can take over traffic and process service requests.
1049 R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO,
1050 database, network operations, service calls) in a critical section
1051 of code, so as to minimize blocking of other operations and increase
1052 concurrent throughput.
1054 R-63473 The VNF **MUST** automatically advertise newly scaled
1055 components so there is no manual intervention required.
1057 R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for
1058 both Service Chaining and scaling.
1060 R-41159 The VNF **MUST** deliver any and all functionality from any
1061 VNFC in the pool (where pooling is the most suitable solution). The
1062 VNFC pool member should be transparent to the client. Upstream and
1063 downstream clients should only recognize the function being performed,
1064 not the member performing it.
1066 R-85959 The VNF **SHOULD** automatically enable/disable added/removed
1067 sub-components or component so there is no manual intervention required.
1069 R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool
1070 without jeopardizing active sessions. Ideally, an active session should
1071 not be tied to any particular VNFC instance.
1073 R-12538 The VNF **SHOULD** support load balancing and discovery
1074 mechanisms in resource pools containing VNFC instances.
1076 R-98989 The VNF **SHOULD** utilize resource pooling (threads,
1077 connections, etc.) within the VNF application so that resources
1078 are not being created and destroyed resulting in resource management
1081 R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when
1082 initialization includes loading catalogues and/or lists which can grow
1083 over time, so that the VNF startup time does not grow at a rate
1084 proportional to that of the list.
1086 R-35532 The VNF **SHOULD** release and clear all shared assets (memory,
1087 database operations, connections, locks, etc.) as soon as possible,
1088 especially before long running sync and asynchronous operations, so as
1089 to not prevent use of these assets by other entities.
1091 R-77334 The VNF **MUST** allow configurations and configuration parameters
1092 to be managed under version control to ensure consistent configuration
1093 deployment, traceability and rollback.
1095 R-99766 The VNF **MUST** allow configurations and configuration parameters
1096 to be managed under version control to ensure the ability to rollback to
1097 a known valid configuration.
1099 R-73583 The VNF **MUST** allow changes of configuration parameters
1100 to be consumed by the VNF without requiring the VNF or its sub-components
1101 to be bounced so that the VNF availability is not effected.
1103 R-21558 The VNF **SHOULD** use intelligent routing by having knowledge
1104 of multiple downstream/upstream endpoints that are exposed to it, to
1105 ensure there is no dependency on external services (such as load balancers)
1106 to switch to alternate endpoints.
1108 R-08315 The VNF **SHOULD** use redundant connection pooling to connect
1109 to any backend data source that can be switched between pools in an
1110 automated/scripted fashion to ensure high availability of the connection
1113 R-27995 The VNF **SHOULD** include control loop mechanisms to notify
1114 the consumer of the VNF of their exceeding SLA thresholds so the consumer
1115 is able to control its load against the VNF.
1117 R-73364 The VNF **MUST** support at least two major versions of the
1118 VNF software and/or sub-components to co-exist within production
1119 environments at any time so that upgrades can be applied across
1120 multiple systems in a staggered manner.
1122 R-02454 The VNF **MUST** support the existence of multiple major/minor
1123 versions of the VNF software and/or sub-components and interfaces that
1124 support both forward and backward compatibility to be transparent to
1125 the Service Provider usage.
1127 R-57855 The VNF **MUST** support hitless staggered/rolling deployments
1128 between its redundant instances to allow "soak-time/burn in/slow roll"
1129 which can enable the support of low traffic loads to validate the
1130 deployment prior to supporting full traffic loads.
1132 R-64445 The VNF **MUST** support the ability of a requestor of the
1133 service to determine the version (and therefore capabilities) of the
1134 service so that Network Cloud Service Provider can understand the
1135 capabilities of the service.
1137 R-56793 The VNF **MUST** test for adherence to the defined performance
1138 budgets at each layer, during each delivery cycle with delivered
1139 results, so that the performance budget is measured and the code
1140 is adjusted to meet performance budget.
1142 R-77667 The VNF **MUST** test for adherence to the defined performance
1143 budget at each layer, during each delivery cycle so that the performance
1144 budget is measured and feedback is provided where the performance budget
1147 R-49308 The VNF **SHOULD** test for adherence to the defined resiliency
1148 rating recommendation at each layer, during each delivery cycle with
1149 delivered results, so that the resiliency rating is measured and the
1150 code is adjusted to meet software resiliency requirements.
1152 R-16039 The VNF **SHOULD** test for adherence to the defined
1153 resiliency rating recommendation at each layer, during each
1154 delivery cycle so that the resiliency rating is measured and
1155 feedback is provided where software resiliency requirements are
1158 R-34957 The VNF **MUST** provide a method of metrics gathering for each
1159 layer's performance to identify/document variances in the allocations so
1160 they can be addressed.
1162 R-49224 The VNF **MUST** provide unique traceability of a transaction
1163 through its life cycle to ensure quick and efficient troubleshooting.
1165 R-52870 The VNF **MUST** provide a method of metrics gathering
1166 and analysis to evaluate the resiliency of the software from both
1167 a granular as well as a holistic standpoint. This includes, but is
1168 not limited to thread utilization, errors, timeouts, and retries.
1170 R-92571 The VNF **MUST** provide operational instrumentation such as
1171 logging, so as to facilitate quick resolution of issues with the VNF to
1172 provide service continuity.
1174 R-48917 The VNF **MUST** monitor for and alert on (both sender and
1175 receiver) errant, running longer than expected and missing file transfers,
1176 so as to minimize the impact due to file transfer errors.
1178 R-28168 The VNF **SHOULD** use an appropriately configured logging
1179 level that can be changed dynamically, so as to not cause performance
1180 degradation of the VNF due to excessive logging.
1182 R-87352 The VNF **SHOULD** utilize Cloud health checks, when available
1183 from the Network Cloud, from inside the application through APIs to check
1184 the network connectivity, dropped packets rate, injection, and auto failover
1185 to alternate sites if needed.
1187 R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all
1188 inter/intra-connectivity points in the VNF to provide an overall resiliency
1189 rating for the VNF to be incorporated into the software design and
1190 development of the VNF.
1195 R-23740 The VNF **MUST** accommodate the security principle of
1196 “least privilege” during development, implementation and operation.
1197 The importance of “least privilege” cannot be overstated and must be
1198 observed in all aspects of VNF development and not limited to security.
1199 This is applicable to all sections of this document.
1201 R-61354 The VNF **MUST** implement access control list for OA&M
1202 services (e.g., restricting access to certain ports or applications).
1204 R-85633 The VNF **MUST** implement Data Storage Encryption
1205 (database/disk encryption) for Sensitive Personal Information (SPI)
1206 and other subscriber identifiable data. Note: subscriber’s SPI/data
1207 must be encrypted at rest, and other subscriber identifiable data
1208 should be encrypted at rest. Other data protection requirements exist
1209 and should be well understood by the developer.
1211 R-92207 The VNF **SHOULD** implement a mechanism for automated and
1212 frequent "system configuration (automated provisioning / closed loop)"
1215 R-23882 The VNF **SHOULD** be scanned using both network scanning
1216 and application scanning security tools on all code, including underlying
1217 OS and related configuration. Scan reports shall be provided. Remediation
1218 roadmaps shall be made available for any findings.
1220 R-46986 The VNF **SHOULD** have source code scanned using scanning
1221 tools (e.g., Fortify) and provide reports.
1223 R-55830 The VNF **MUST** distribute all production code from NCSP
1224 internal sources only. No production code, libraries, OS images, etc.
1225 shall be distributed from publically accessible depots.
1227 R-99771 The VNF **MUST** provide all code/configuration files in a
1228 "Locked down" or hardened state or with documented recommendations for
1229 such hardening. All unnecessary services will be disabled. VNF provider
1230 default credentials, community strings and other such artifacts will be
1231 removed or disclosed so that they can be modified or removed during
1234 R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of
1235 traffic by application (dropping packets not belonging to the VPN) (i.e.,
1236 AVPN, IPSec VPN for Internet routes).
1238 R-33981 The VNF **SHOULD** interoperate with various access control
1239 mechanisms for the Network Cloud execution environment (e.g.,
1240 Hypervisors, containers).
1242 R-40813 The VNF **SHOULD** support the use of virtual trusted platform
1243 module, hypervisor security testing and standards scanning tools.
1245 R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that
1246 it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual
1247 routing and forwarding rules.
1249 R-26586 The VNF **SHOULD** support the ability to work with aliases
1250 (e.g., gateways, proxies) to protect and encapsulate resources.
1252 R-49956 The VNF **MUST** pass all access to applications (Bearer,
1253 signaling and OA&M) through various security tools and platforms from
1254 ACLs, stateful firewalls and application layer gateways depending on
1255 manner of deployment. The application is expected to function (and in
1256 some cases, interwork) with these security tools.
1258 R-69649 The VNF **MUST** have all vulnerabilities patched as soon
1259 as possible. Patching shall be controlled via change control process
1260 with vulnerabilities disclosed along with mitigation recommendations.
1262 R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification,
1263 authentication and access control of customer or VNF application users.
1265 R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with
1266 the requirements if not using the NCSP’s IDAM API, for identification,
1267 authentication and access control of OA&M and other system level
1270 R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1271 User-IDs and passwords to uniquely identify the user/application. VNF
1272 needs to have appropriate connectors to the Identity, Authentication
1273 and Authorization systems that enables access at OS, Database and
1274 Application levels as appropriate.
1276 R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide
1277 the ability to support Multi-Factor Authentication (e.g., 1st factor =
1278 Software token on device (RSA SecureID); 2nd factor = User Name+Password,
1279 etc.) for the users.
1281 R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1282 Role-Based Access Control to permit/limit the user/application to
1283 performing specific activities.
1285 R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1286 logging via ONAP for a historical view of “who did what and when”.
1288 R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt
1289 OA&M access (e.g., SSH, SFTP).
1291 R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce
1292 a configurable maximum number of Login attempts policy for the users.
1293 VNF provider must comply with "terminate idle sessions" policy.
1294 Interactive sessions must be terminated, or a secure, locking screensaver
1295 must be activated requiring authentication, after a configurable period
1296 of inactivity. The system-based inactivity timeout for the enterprise
1297 identity and access management system must also be configurable.
1299 R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1300 with the NCSP’s credential management policy.
1302 R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire
1303 passwords at regular configurable intervals.
1305 R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1306 with "password complexity" policy. When passwords are used, they shall
1307 be complex and shall at least meet the following password construction
1308 requirements: (1) be a minimum configurable number of characters in
1309 length, (2) include 3 of the 4 following types of characters:
1310 upper-case alphabetic, lower-case alphabetic, numeric, and special,
1311 (3) not be the same as the UserID with which they are associated or
1312 other common strings as specified by the environment, (4) not contain
1313 repeating or sequential characters or numbers, (5) not to use special
1314 characters that may have command functions, and (6) new passwords must
1315 not contain sequences of three or more characters from the previous
1318 R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1319 with "password changes (includes default passwords)" policy. Products
1320 will support password aging, syntax and other credential management
1321 practices on a configurable basis.
1323 R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support
1324 use of common third party authentication and authorization tools such
1327 R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply
1328 with "No Self-Signed Certificates" policy. Self-signed certificates
1329 must be used for encryption only, using specified and approved
1330 encryption protocols such as TLS 1.2 or higher or equivalent security
1331 protocols such as IPSec, AES.
1333 R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API,
1334 authenticate system to system communications where one system
1335 accesses the resources of another system, and must never conceal
1336 individual accountability.
1338 R-95105 The VNF **MUST** host connectors for access to the application
1341 R-45496 The VNF **MUST** host connectors for access to the OS
1342 (Operating System) layer.
1344 R-05470 The VNF **MUST** host connectors for access to the database layer.
1346 R-99174 The VNF **MUST** comply with Individual Accountability
1347 (each person must be assigned a unique ID) when persons or non-person
1348 entities access VNFs.
1350 R-42874 The VNF **MUST** comply with Least Privilege (no more
1351 privilege than required to perform job functions) when persons
1352 or non-person entities access VNFs.
1354 R-71787 The VNF **MUST** comply with Segregation of Duties (access to a
1355 single layer and no developer may access production without special
1356 oversight) when persons or non-person entities access VNFs.
1358 R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely.
1360 R-49945 The VNF **MUST** authorize VNF provider access through a
1361 client application API by the client application owner and the resource
1362 owner of the VNF before provisioning authorization through Role Based
1363 Access Control (RBAC), Attribute Based Access Control (ABAC), or other
1364 policy based mechanism.
1366 R-31751 The VNF **MUST** subject VNF provider access to privilege
1367 reconciliation tools to prevent access creep and ensure correct
1368 enforcement of access policies.
1370 R-34552 The VNF **MUST** provide or support the Identity and Access
1371 Management (IDAM) based threat detection data for OWASP Top 10.
1373 R-29301 The VNF **MUST** provide or support the Identity and Access
1374 Management (IDAM) based threat detection data for Password Attacks.
1376 R-72243 The VNF **MUST** provide or support the Identity and Access
1377 Management (IDAM) based threat detection data for Phishing / SMishing.
1379 R-58998 The VNF **MUST** provide or support the Identity and Access
1380 Management (IDAM) based threat detection data for Malware (Key Logger).
1382 R-14025 The VNF **MUST** provide or support the Identity and Access
1383 Management (IDAM) based threat detection data for Session Hijacking.
1385 R-31412 The VNF **MUST** provide or support the Identity and Access
1386 Management (IDAM) based threat detection data for XSS / CSRF.
1388 R-51883 The VNF **MUST** provide or support the Identity and Access
1389 Management (IDAM) based threat detection data for Replay.
1391 R-44032 The VNF **MUST** provide or support the Identity and Access
1392 Management (IDAM) based threat detection data for Man in the Middle (MITM).
1394 R-58977 The VNF **MUST** provide or support the Identity and Access
1395 Management (IDAM) based threat detection data for Eavesdropping.
1397 R-24825 The VNF **MUST** provide Context awareness data (device,
1398 location, time, etc.) and be able to integrate with threat detection system.
1400 R-59391 The VNF provider **MUST**, where a VNF provider requires
1401 the assumption of permissions, such as root or administrator, first
1402 log in under their individual user login ID then switch to the other
1403 higher level account; or where the individual user login is infeasible,
1404 must login with an account with admin privileges in a way that
1405 uniquely identifies the individual performing the function.
1407 R-85028 The VNF **MUST** authenticate system to system access and
1408 do not conceal a VNF provider user’s individual accountability for
1411 R-80335 The VNF **MUST** make visible a Warning Notice: A formal
1412 statement of resource intent, i.e., a warning notice, upon initial
1413 access to a VNF provider user who accesses private internal networks
1414 or Company computer resources, e.g., upon initial logon to an internal
1415 web site, system or application which requires authentication.
1417 R-73541 The VNF **MUST** use access controls for VNFs and their
1418 supporting computing systems at all times to restrict access to
1419 authorized personnel only, e.g., least privilege. These controls
1420 could include the use of system configuration or access control
1423 R-64503 The VNF **MUST** provide minimum privileges for initial
1424 and default settings for new user accounts.
1426 R-86835 The VNF **MUST** set the default settings for user access
1427 to sensitive commands and data to deny authorization.
1429 R-77157 The VNF **MUST** conform to approved request, workflow
1430 authorization, and authorization provisioning requirements when
1431 creating privileged users.
1433 R-81147 The VNF **MUST** have greater restrictions for access and
1434 execution, such as up to 3 factors of authentication and restricted
1435 authorization, for commands affecting network services, such as
1436 commands relating to VNFs.
1438 R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2)
1439 transmission of data on internal and external networks.
1441 R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs.
1443 R-15671 The VNF **MUST NOT** provide public or unrestricted access
1444 to any data without the permission of the data owner. All data
1445 classification and access controls must be followed.
1447 R-89753 The VNF **MUST NOT** install or use systems, tools or
1448 utilities capable of capturing or logging data that was not created
1449 by them or sent specifically to them in production, without
1450 authorization of the VNF system owner.
1452 R-19082 The VNF **MUST NOT** run security testing tools and
1453 programs, e.g., password cracker, port scanners, hacking tools
1454 in production, without authorization of the VNF system owner.
1456 R-19790 The VNF **MUST NOT** include authentication credentials
1457 in security audit logs, even if encrypted.
1459 R-85419 The VNF **SHOULD** use REST APIs exposed to Client
1460 Applications for the implementation of OAuth 2.0 Authorization
1461 Code Grant and Client Credentials Grant, as the standard interface
1464 R-48080 The VNF **SHOULD** support SCEP (Simple Certificate
1465 Enrollment Protocol).
1467 R-37608 The VNF **MUST** provide a mechanism to restrict access based
1468 on the attributes of the VNF and the attributes of the subject.
1470 R-43884 The VNF **MUST** integrate with external authentication
1471 and authorization services (e.g., IDAM).
1473 R-25878 The VNF **MUST** use certificates issued from publicly
1474 recognized Certificate Authorities (CA) for the authentication process
1475 where PKI-based authentication is used.
1477 R-19804 The VNF **MUST** validate the CA signature on the certificate,
1478 ensure that the date is within the validity period of the certificate,
1479 check the Certificate Revocation List (CRL), and recognize the identity
1480 represented by the certificate where PKI-based authentication is used.
1482 R-47204 The VNF **MUST** protect the confidentiality and integrity of
1483 data at rest and in transit from unauthorized access and modification.
1485 R-33488 The VNF **MUST** protect against all denial of service
1486 attacks, both volumetric and non-volumetric, or integrate with external
1487 denial of service protection tools.
1489 R-21652 The VNF **MUST** implement the following input validation
1490 control: Check the size (length) of all input. Do not permit an amount
1491 of input so great that it would cause the VNF to fail. Where the input
1492 may be a file, the VNF API must enforce a size limit.
1494 R-54930 The VNF **MUST** implement the following input validation
1495 control: Do not permit input that contains content or characters
1496 inappropriate to the input expected by the design. Inappropriate input,
1497 such as SQL insertions, may cause the system to execute undesirable
1498 and unauthorized transactions against the database or allow other
1499 inappropriate access to the internal network.
1501 R-21210 The VNF **MUST** implement the following input validation
1502 control: Validate that any input file has a correct and valid
1503 Multipurpose Internet Mail Extensions (MIME) type. Input files
1504 should be tested for spoofed MIME types.
1506 R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs.
1508 R-87135 The VNF **MUST** comply with NIST standards and industry
1509 best practices for all implementations of cryptography.
1511 R-02137 The VNF **MUST** implement all monitoring and logging as
1512 described in the Security Analytics section.
1514 R-15659 The VNF **MUST** restrict changing the criticality level of
1515 a system security alarm to administrator(s).
1517 R-19367 The VNF **MUST** monitor API invocation patterns to detect
1518 anomalous access patterns that may represent fraudulent access or
1519 other types of attacks, or integrate with tools that implement anomaly
1520 and abuse detection.
1522 R-78066 The VNF **MUST** support requests for information from law
1523 enforcement and government agencies.
1525 R-48470 The VNF **MUST** support Real-time detection and
1526 notification of security events.
1528 R-22286 The VNF **MUST** support Integration functionality via
1529 API/Syslog/SNMP to other functional modules in the network (e.g.,
1530 PCRF, PCEF) that enable dynamic security control by blocking the
1531 malicious traffic or malicious end users.
1533 R-32636 The VNF **MUST** support API-based monitoring to take care of
1534 the scenarios where the control interfaces are not exposed, or are
1535 optimized and proprietary in nature.
1537 R-61648 The VNF **MUST** support event logging, formats, and delivery
1538 tools to provide the required degree of event data to ONAP.
1540 R-22367 The VNF **MUST** support detection of malformed packets due to
1541 software misconfiguration or software vulnerability.
1543 R-31961 The VNF **MUST** support integrated DPI/monitoring functionality
1544 as part of VNFs (e.g., PGW, MME).
1546 R-20912 The VNF **MUST** support alternative monitoring capabilities
1547 when VNFs do not expose data or control traffic or use proprietary and
1548 optimized protocols for inter VNF communication.
1550 R-73223 The VNF **MUST** support proactive monitoring to detect and
1551 report the attacks on resources so that the VNFs and associated VMs can
1552 be isolated, such as detection techniques for resource exhaustion, namely
1553 OS resource attacks, CPU attacks, consumption of kernel memory, local
1556 R-58370 The VNF **MUST** coexist and operate normally with commercial
1557 anti-virus software which shall produce alarms every time when there is a
1560 R-56920 The VNF **MUST** protect all security audit logs (including
1561 API, OS and application-generated logs), security audit software, data,
1562 and associated documentation from modification, or unauthorized viewing,
1563 by standard OS access control mechanisms, by sending to a remote system,
1566 R-54520 The VNF **MUST** log successful and unsuccessful login attempts.
1568 R-55478 The VNF **MUST** log logoffs.
1570 R-08598 The VNF **MUST** log successful and unsuccessful changes to
1573 R-13344 The VNF **MUST** log starting and stopping of security
1576 R-07617 The VNF **MUST** log creating, removing, or changing the
1577 inherent privilege level of users.
1579 R-94525 The VNF **MUST** log connections to a network listener of the
1582 R-31614 The VNF **MUST** log the field “event type” in the security
1585 R-97445 The VNF **MUST** log the field “date/time” in the security
1588 R-25547 The VNF **MUST** log the field “protocol” in the security audit logs.
1590 R-06413 The VNF **MUST** log the field “service or program used for
1591 access” in the security audit logs.
1593 R-15325 The VNF **MUST** log the field “success/failure” in the
1594 security audit logs.
1596 R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs.
1598 R-04982 The VNF **MUST NOT** include an authentication credential,
1599 e.g., password, in the security audit logs, even if encrypted.
1601 R-63330 The VNF **MUST** detect when the security audit log storage
1602 medium is approaching capacity (configurable) and issue an alarm via
1603 SMS or equivalent as to allow time for proper actions to be taken to
1604 pre-empt loss of audit data.
1606 R-41252 The VNF **MUST** support the capability of online storage of
1607 security audit logs.
1609 R-41825 The VNF **MUST** activate security alarms automatically when
1610 the following event is detected: configurable number of consecutive
1611 unsuccessful login attempts
1613 R-43332 The VNF **MUST** activate security alarms automatically when
1614 the following event is detected: successful modification of critical
1615 system or application files
1617 R-74958 The VNF **MUST** activate security alarms automatically when
1618 the following event is detected: unsuccessful attempts to gain permissions
1619 or assume the identity of another user
1621 R-15884 The VNF **MUST** include the field “date” in the Security alarms
1622 (where applicable and technically feasible).
1624 R-23957 The VNF **MUST** include the field “time” in the Security alarms
1625 (where applicable and technically feasible).
1627 R-71842 The VNF **MUST** include the field “service or program used for
1628 access” in the Security alarms (where applicable and technically feasible).
1630 R-57617 The VNF **MUST** include the field “success/failure” in the
1631 Security alarms (where applicable and technically feasible).
1633 R-99730 The VNF **MUST** include the field “Login ID” in the Security
1634 alarms (where applicable and technically feasible).
1636 R-29705 The VNF **MUST** restrict changing the criticality level of a
1637 system security alarm to administrator(s).
1639 R-13627 The VNF **MUST** monitor API invocation patterns to detect
1640 anomalous access patterns that may represent fraudulent access or other
1641 types of attacks, or integrate with tools that implement anomaly and
1644 R-21819 The VNF **MUST** support requests for information from law
1645 enforcement and government agencies.
1647 R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation
1648 (without human intervention) for Known Threats with detection rate in low
1651 R-25094 The VNF **MUST** perform data capture for security functions.
1653 R-04492 The VNF **MUST** generate security audit logs that must be sent
1654 to Security Analytics Tools for analysis.
1656 R-19219 The VNF **MUST** provide audit logs that include user ID, dates,
1657 times for log-on and log-off, and terminal location at minimum.
1659 R-30932 The VNF **MUST** provide security audit logs including records
1660 of successful and rejected system access data and other resource access
1663 R-54816 The VNF **MUST** support the storage of security audit logs
1664 for agreed period of time for forensic analysis.
1666 R-57271 The VNF **MUST** provide the capability of generating security
1667 audit logs by interacting with the operating system (OS) as appropriate.
1669 R-84160 The VNF **MUST** have security logging for VNFs and their
1670 OSs be active from initialization. Audit logging includes automatic
1671 routines to maintain activity records and cleanup programs to ensure
1672 the integrity of the audit/logging systems.
1674 R-58964 The VNF **MUST** provide the capability to restrict read
1675 and write access to data.
1677 R-99112 The VNF **MUST** provide the capability to restrict access
1678 to data to specific users.
1680 R-83227 The VNF **MUST** Provide the capability to encrypt data in
1681 transit on a physical or virtual network.
1683 R-32641 The VNF **MUST** provide the capability to encrypt data on
1684 non-volatile memory.
1686 R-13151 The VNF **SHOULD** disable the paging of the data requiring
1687 encryption, if possible, where the encryption of non-transient data is
1688 required on a device for which the operating system performs paging to
1689 virtual memory. If not possible to disable the paging of the data
1690 requiring encryption, the virtual memory should be encrypted.
1692 R-93860 The VNF **MUST** provide the capability to integrate with an
1693 external encryption service.
1695 R-73067 The VNF **MUST** use industry standard cryptographic algorithms
1696 and standard modes of operations when implementing cryptography.
1698 R-22645 The VNF **SHOULD** use commercial algorithms only when there
1699 are no applicable governmental standards for specific cryptographic
1700 functions, e.g., public key cryptography, message digests.
1702 R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and
1703 Skipjack algorithms or other compromised encryption.
1705 R-02170 The VNF **MUST** use, whenever possible, standard implementations
1706 of security applications, protocols, and format, e.g., S/MIME, TLS, SSH,
1707 IPSec, X.509 digital certificates for cryptographic implementations.
1708 These implementations must be purchased from reputable vendors and must
1709 not be developed in-house.
1711 R-70933 The VNF **MUST** provide the ability to migrate to newer
1712 versions of cryptographic algorithms and protocols with no impact.
1714 R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length.
1716 R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length.
1718 R-95864 The VNF **MUST** use commercial tools that comply with X.509
1719 standards and produce x.509 compliant keys for public/private key generation.
1721 R-12110 The VNF **MUST NOT** use keys generated or derived from
1722 predictable functions or values, e.g., values considered predictable
1723 include user identity information, time of day, stored/transmitted data.
1725 R-52060 The VNF **MUST** provide the capability to configure encryption
1726 algorithms or devices so that they comply with the laws of the jurisdiction
1727 in which there are plans to use data encryption.
1729 R-69610 The VNF **MUST** provide the capability of using certificates
1730 issued from a Certificate Authority not provided by the VNF provider.
1732 R-83500 The VNF **MUST** provide the capability of allowing certificate
1733 renewal and revocation.
1735 R-29977 The VNF **MUST** provide the capability of testing the validity
1736 of a digital certificate by validating the CA signature on the certificate.
1738 R-24359 The VNF **MUST** provide the capability of testing the validity
1739 of a digital certificate by validating the date the certificate is being
1740 used is within the validity period for the certificate.
1742 R-39604 The VNF **MUST** provide the capability of testing the
1743 validity of a digital certificate by checking the Certificate Revocation
1744 List (CRL) for the certificates of that type to ensure that the
1745 certificate has not been revoked.
1747 R-75343 The VNF **MUST** provide the capability of testing the
1748 validity of a digital certificate by recognizing the identity represented
1749 by the certificate — the "distinguished name".
1754 R-37028 The VNF **MUST** be composed of one “base” module.
1756 R-41215 The VNF **MAY** have zero to many “incremental” modules.
1758 R-20974 The VNF **MUST** deploy the base module first, prior to
1759 the incremental modules.
1761 R-11200 The VNF **MUST** keep the scope of a Cinder volume module,
1762 when it exists, to be 1:1 with the VNF Base Module or Incremental Module.
1764 R-38474 The VNF **MUST** have a corresponding environment file for
1767 R-81725 The VNF **MUST** have a corresponding environment file for
1768 an Incremental Module.
1770 R-53433 The VNF **MUST** have a corresponding environment file for
1771 a Cinder Volume Module.
1776 R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU
1777 architectures and families, virtual machines, etc.
1779 R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud
1780 (such as hardware, host OS, Hypervisor or container technology) and must run
1781 on the Network Cloud with acknowledgement to the paradigm that the Network
1782 Cloud will continue to rapidly evolve and the underlying components of
1783 the platform will change regularly.
1785 R-33846 The VNF **MUST** install the NCSP required software on Guest OS
1786 images when not using the NCSP provided Guest OS images. [5]_
1788 R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [5]_
1790 R-02997 The VNF **MUST** preserve their persistent data. Running VMs
1791 will not be backed up in the Network Cloud infrastructure.
1793 R-29760 The VNFC **MUST** be installed on non-root file systems,
1794 unless software is specifically included with the operating system
1795 distribution of the guest image.
1797 R-20860 The VNF **MUST** be agnostic to the underlying infrastructure
1798 (such as hardware, host OS, Hypervisor), any requirements should be
1799 provided as specification to be fulfilled by any hardware.
1801 R-89800 The VNF **MUST NOT** require Hypervisor-level customization
1802 from the cloud provider.
1804 R-86758 The VNF **SHOULD** provide an automated test suite to validate
1805 every new version of the software on the target environment(s). The tests
1806 should be of sufficient granularity to independently test various
1807 representative VNF use cases throughout its lifecycle. Operations might
1808 choose to invoke these tests either on a scheduled basis or on demand to
1809 support various operations functions including test, turn-up and
1812 R-39650 The VNF **SHOULD** provide the ability to test incremental
1815 R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command
1816 against a specific VNFC, moving all existing session elsewhere with
1817 minimal disruption if a VNF provides a load balancing function across
1818 multiple instances of its VNFCs. Note: Individual VNF performance
1819 aspects (e.g., move duration or disruption scope) may require further
1822 R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against
1823 a specific VNFC, preventing new session from reaching the targeted VNFC,
1824 with no disruption to active sessions on the impacted VNFC, if a VNF
1825 provides a load balancing function across multiple instances of its VNFCs.
1826 This is used to support scenarios such as proactive maintenance with no
1829 R-64713 The VNF **SHOULD** support a software promotion methodology
1830 from dev/test -> pre-prod -> production in software, development &
1831 testing and operations.
1833 **VNF Modeling Requirements**
1834 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1839 R-95303 A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.
1841 R-27078 A VNF's Heat Orchestration template **MUST** contain
1842 the section "heat_template_version:".
1844 R-39402 A VNF's Heat Orchestration Template **MUST**
1845 contain the section "description:".
1847 R-35414 A VNF Heat Orchestration's template **MUST**
1848 contain the section "parameters:".
1850 R-90279 A VNF Heat Orchestration's template's parameter **MUST**
1851 be used in a resource with the exception of the parameters
1852 for the OS::Nova::Server resource property availability_zone.
1854 R-91273 A VNF Heat Orchestration’s template’s parameter for
1855 the OS::Nova::Server resource property availability_zone
1856 **MAY NOT** be used in any OS::Nova::Resource.
1858 R-25877 A VNF's Heat Orchestration Template's parameter
1859 name (i.e., <param name>) **MUST** contain only
1860 alphanumeric characters and underscores ('_').
1862 R-36772 A VNF’s Heat Orchestration Template’s parameter
1863 **MUST** include the attribute “type:”.
1865 R-11441 A VNF’s Heat Orchestration Template’s parameter
1866 type **MUST** be one of the following values: "string",
1867 "number", "json", "comma_delimited_list" or "boolean".
1869 R-32094 A VNF's Heat Orchestration Template parameter
1870 declaration **MAY** contain the attribute "label:"
1872 R-44001 A VNF's Heat Orchestration Template parameter
1873 declaration **MUST** contain the attribute "description".
1875 R-90526 A VNF Heat Orchestration Template parameter
1876 declaration **MUST** not contain the default attribute.
1878 R-26124 If a VNF Heat Orchestration Template parameter
1879 requires a default value, it **MUST** be enumerated in the environment file.
1881 R-32557 A VNF's Heat Orchestration Template parameter
1882 declaration MAY contain the attribute "hidden:".
1884 R-88863 A VNF's Heat Orchestration Template's parameter defined as
1885 type "number" **MUST** have a parameter constraint of "range" or
1886 "allowed_values" defined.
1888 R-40518 A VNF's Heat Orchestration Template’s parameter defined as
1889 type "string" **MAY** have a parameter constraint defined.
1891 R-96227 A VNF's Heat Orchestration Template’s parameter defined as
1892 type "json" **MAY** have a parameter constraint defined.
1894 R-79817 A VNF's Heat Orchestration Template’s parameter defined as
1895 type "comma_delimited_list" **MAY** have a parameter constraint defined.
1897 R-06613 A VNF's Heat Orchestration Template’s parameter defined as
1898 type "boolean" **MAY** have a parameter constraint defined.
1900 R-00011 A VNF's Heat Orchestration Template's Nested YAML files
1901 parameter's **MUST NOT** have a parameter constraint defined.
1903 R-22589 A VNF’s Heat Orchestration Template parameter declaration
1904 **MAY** contain the attribute "immutable:".
1906 R-23664 A VNF's Heat Orchestration template **MUST** contain
1907 the section "resources:".
1909 R-90152 A VNF's Heat Orchestration Template's "resources:"
1910 section **MUST** contain the declaration of at least one resource.
1912 R-40551 A VNF's Heat Orchestration Template's Nested YAML files
1913 **MAY** contain the section "resources:".
1915 R-75141 A VNF's Heat Orchestration Template's resource name
1916 (i.e., <resource ID>) **MUST** only contain alphanumeric
1917 characters and underscores ('_').
1919 R-16447 A VNF's <resource ID> **MUST** be unique across all
1920 Heat Orchestration Templates and all HEAT Orchestration Template
1921 Nested YAML files that are used to create the VNF.
1923 R-53952 A VNF’s Heat Orchestration Template’s Resource
1924 **MUST NOT** reference a HTTP-based resource definitions.
1926 R-71699 A VNF’s Heat Orchestration Template’s Resource
1927 **MUST NOT** reference a HTTP-based Nested YAML file.
1929 R-10834 If a VNF Heat Orchestration Template resource attribute
1930 "property:" uses a nested "get_param", one level of nesting is
1931 supported and the nested "get_param" **MUST** reference an index
1933 R-97199 A VNF's Heat Orchestration Template's OS::Nova::Server
1934 resource **MUST** contain the attribute "metadata".
1936 R-46968 VNF’s Heat Orchestration Template’s Resource **MAY**
1937 declare the attribute “depends_on:”.
1939 R-63137 VNF’s Heat Orchestration Template’s Resource **MAY**
1940 declare the attribute “update_policy:”.
1942 R-43740 A VNF’s Heat Orchestration Template’s Resource
1943 **MAY** declare the attribute “deletion_policy:”.
1945 R-78569 A VNF’s Heat Orchestration Template’s Resouce **MAY**
1946 declare the attribute “external_id:”.
1948 R-36982 A VNF’s Heat Orchestration template **MAY** contain the “outputs:” section.
1950 R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding
1951 environment file, even if no parameters are required to be enumerated.
1953 R-86285 The VNF Heat Orchestration Template **MUST** have a
1954 corresponding environment file, even if no parameters are required to be
1957 R-03324 The VNF Heat Orchestration Template **MUST** contain the
1958 "parameters" section in the
1961 R-68198 A VNF’s Heat Orchestration template’s Environment File’s
1962 “parameters:” section **MAY** enumerate parameters.
1964 R-59930 A VNF’s Heat Orchestration template’s Environment
1965 File’s **MAY** contain the “parameter_defaults:” section.
1967 R-46096 A VNF’s Heat Orchestration template’s Environment File’s
1968 **MAY** contain the “encrypted_parameters:” section.
1970 R-24893 A VNF’s Heat Orchestration template’s Environment File’s
1971 **MAY** contain the “event_sinks:” section.
1973 R-42685 A VNF’s Heat Orchestration template’s Environment File’s
1974 **MAY** contain the “parameter_merge_strategies:” section.
1976 R-67231 A VNF’s Heat Orchestration template’s Environment File’s **MUST NOT**
1977 contain the “resource_registry:” section.
1979 R-69663 A VNF **MAY** be composed from one or more Heat Orchestration
1980 Templates, each of which represents a subset of the overall VNF.
1982 R-33132 A VNF’s Heat Orchestration Template **MAY** be 1.) Base Module
1983 Heat Orchestration Template (also referred to as a Base Module), 2.)
1984 Incremental Module Heat Orchestration Template (referred to as an Incremental
1985 Module), or 3.) a Cinder Volume Module Heat Orchestration Template
1986 (referred to as Cinder Volume Module).
1988 R-13196 A VNF **MAY** be composed of zero to many Incremental Modules
1990 R-28980 A VNF’s incremental module **MAY** be used for initial VNF
1993 R-86926 A VNF’s incremental module **MAY** be used for scale out only.
1995 R-91497 A VNF’s incremental module **MAY** be used for both deployment
1998 R-68122 A VNF’s incremental module **MAY** be deployed more than once,
1999 either during initial VNF deployment and/or scale out.
2001 R-46119 A VNF’s Heat Orchestration Template’s Resource OS::Heat::CinderVolume
2002 **MAY** be defined in a Base Module.
2004 R-90748 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume
2005 **MAY** be defined in an Incremental Module.
2007 R-03251 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume
2008 **MAY** be defined in a Cinder Volume Module.
2010 * R-11200 The VNF **MUST** keep the scope of a Cinder volume module,
2011 when it exists, to be 1:1 with the VNF Base Module or Incremental Module.
2013 R-11200 The VNF **MUST** keep the scope of a Cinder volume module, when it
2014 exists, to be 1:1 with the VNF Base Module or Incremental Module
2016 R-36582 A VNF’s Base Module **MAY** utilize nested heat.
2018 R-56721 A VNF’s Incremental Module **MAY** utilize nested heat.
2020 R-30395 A VNF’s Cinder Volume Module **MAY** utilize nested heat.
2022 R-87485 A VNF’s Heat Orchestration Template’s file extension **MUST**
2023 be in the lower case format ‘.yaml’ or ‘.yml’.
2025 R-56438 A VNF’s Heat Orchestration Template’s Nested YAML file extension
2026 **MUST** be in the lower case format ‘.yaml’ or ‘.yml’.
2028 R-74304 A VNF’s Heat Orchestration Template’s Environment file extension
2029 **MUST** be in the lower case format ‘.env’.
2031 R-81339 A VNF Heat Orchestration Template’s Base Module file name **MUST**
2032 include ‘base’ in the filename and **MUST** match one of the following four
2033 formats: 1.) ‘base_<text>.y[a]ml’, 2.) ‘<text>_base.y[a]ml’, 3.)
2034 ‘base.y[a]ml’, or 4.) ‘<text>_base_<text>’.y[a]ml; where ‘base’ is case
2035 insensitive and where ‘<text>’ **MUST** contain only alphanumeric characters
2036 and underscores ‘_’ and **MUST NOT** contain the case insensitive word ‘base’.
2038 R-91342 A VNF Heat Orchestration Template’s Base Module’s Environment File
2039 **MUST** be named identical to the VNF Heat Orchestration Template’s Base
2040 Module with ‘.y[a]ml’ replaced with ‘.env’.
2042 R-87247 A VNF Heat Orchestration Template’s Incremental Module file name
2043 **MUST** contain only alphanumeric characters and underscores ‘_’ and
2044 **MUST NOT** contain the case insensitive word ‘base’.
2046 R-94509 A VNF Heat Orchestration Template’s Incremental Module’s Environment
2047 File **MUST** be named identical to the VNF Heat Orchestration Template’s
2048 Incremental Module with ‘.y[a]ml’ replaced with ‘.env’.
2050 R-82732 A VNF Heat Orchestration Template’s Cinder Volume Module **MUST** be
2051 named identical to the base or incremental module it is supporting with
2054 R-31141 A VNF Heat Orchestration Template’s Cinder Volume Module’s Environment
2055 File **MUST** be named identical to the VNF Heat Orchestration Template’s
2056 Cinder Volume Module with .y[a]ml replaced with ‘.env’.
2058 R-76057 A VNF Heat Orchestration Template’s Nested YAML file name **MUST**
2059 contain only alphanumeric characters and underscores ‘_’ and **MUST NOT**
2060 contain the case insensitive word ‘base’.
2062 R-18224 The VNF Heat Orchestration Template **MUST** pass in as properties
2063 all parameter values
2064 associated with the nested heat file in the resource definition defined
2065 in the parent heat template.
2067 R-52753 VNF’s Heat Orchestration Template’s Base Module’s output parameter’s
2068 name and type **MUST** match the VNF’s Heat Orchestration Template’s
2069 incremental Module’s name and type unless the output parameter is of type
2070 ‘comma_delimited_list’, then the corresponding input parameter **MUST**
2071 be declared as type ‘json’.
2073 R-22608 When a VNF’s Heat Orchestration Template’s Base Module’s output
2074 parameter is declared as an input parameter in an Incremental Module,
2075 the parameter attribute ‘constraints:’ **MUST NOT** be declared.
2077 R-89913 A VNF’s Heat Orchestration Template’s Cinder Volume Module Output
2078 Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in
2079 template, while other Output Parameters **MAY** be included.
2081 R-07443 A VNF’s Heat Orchestration Templates’ Cinder Volume Module Output
2082 Parameter’s name and type **MUST** match the input parameter name and type
2083 in the corresponding Base Module or Incremental Module unless the Output
2084 Parameter is of the type ‘comma_delimited_list’, then the corresponding input
2085 parameter **MUST** be declared as type ‘json’.
2087 R-20547 When an ONAP Volume Module Output Parameter is declared as an input
2088 parameter in a base or an incremental module Heat Orchestration Template,
2089 parameter constraints **MUST NOT** be declared.
2091 R-39349 A VNF Heat Orchestration Template **MUST NOT** be designed to
2092 utilize the OpenStack ‘heat stack-update’ command for scaling
2095 R-43413 A VNF **MUST** utilize a modular Heat Orchestration Template
2096 design to support scaling (growth/de-growth).
2098 R-59482 A VNF’s Heat Orchestration Template **MUST NOT** be VNF instance
2099 specific or Cloud site specific
2101 R-56750 A VNF’s Heat Orchestration Template’s parameter values that are
2102 constant across all deployments **MUST** be declared in a Heat Orchestration
2103 Template Environment File.
2105 R-01896 A VNF’s Heat Orchestration Template’s parameter values that are
2106 constant across all deployments **MUST** be declared in a Heat Orchestration
2107 Template Environment File.
2109 R-16968 A VNF’s Heat Orchestration Templates **MUST NOT** include heat
2110 resources to create external networks.
2112 R-00606 A VNF **MAY** be connected to zero, one or more than one external
2115 R-57424 A VNF’s port connected to an external network **MUST** connect the
2116 port to VMs in another VNF and/or an external gateway and/or external router.
2118 R-29865 A VNF’s port connected to an external network **MUST NOT** connect
2119 the port to VMs in the same VNF.
2121 R-69014 When a VNF connects to an external network, a network role, referred
2122 to as the ‘{network-role}’ **MUST** be assigned to the external network
2123 for use in the VNF’s Heat Orchestration Template.
2125 R-05201 When a VNF connects to two or more external networks, each external
2126 network **MUST** be assigned a unique ‘{network-role}’ in the context of
2127 the VNF for use in the VNF’s Heat Orchestration Template.
2129 R-83015 A VNF’s ‘{network-role}’ assigned to an external network **MUST**
2130 be different than the ‘{network-role}’ assigned to the VNF’s internal
2131 networks, if internal networks exist.
2133 R-87096 A VNF **MAY** contain zero, one or more than one internal networks.
2135 R-35666 If a VNF has an internal network, the VNF Heat Orchestration
2136 Template **MUST** include the heat resources to create the internal network.
2138 R-86972 A VNF **SHOULD** create the internal network in the VNF’s Heat
2139 Orchestration Template Base Module.
2141 R-52425 A VNF’s port connected to an internal network **MUST** connect
2142 the port to VMs in the same VNF.
2144 R-46461 A VNF’s port connected to an internal network **MUST NOT** connect
2145 the port to VMs in another VNF and/or an external gateway and/or
2148 R-68936 When a VNF creates an internal network, a network role, referred to
2149 as the ‘{network-role}’ **MUST** be assigned to the internal network for
2150 use in the VNF’s Heat Orchestration Template.
2152 R-32025 When a VNF creates two or more internal networks, each internal
2153 network **MUST** be assigned a unique ‘{network-role}’ in the context of
2154 the VNF for use in the VNF’s Heat Orchestration Template.
2156 R-69874 A VNF’s ‘{network-role}’ assigned to an internal network **MUST**
2157 be different than the ‘{network-role}’ assigned to the VNF’s external
2160 R-34726 If a VNF’s port is connected to an internal network and the port
2161 is created in the same Heat Orchestration Template as the internal network,
2162 then the port resource **MUST** use a ‘get_resource’ to obtain
2165 R-22688 If a VNF’s port is connected to an internal network and the
2166 port is created in an Incremental Module and the internal network is created
2167 in the Base Module then the UUID of the internal network **MUST** be exposed
2168 as a parameter in the ‘outputs:’ section of the Base Module and the port
2169 resource **MUST** use a ‘get_param’ to obtain the network UUID.
2171 R-01455 When a VNF's Heat Orchestration Template creates a Virtual Machine (i.e., 'OS::Nova::Server'),
2172 each 'class' of VMs **MUST** be assigned a VNF unique
2173 '{vm-type}'; where 'class' defines VMs that **MUST** have the following
2174 identical characteristics:
2176 R-82481 A VNF's Heat Orchestration Template's Resource property
2178 associated with a unique Virtual Machine type **MUST**
2179 include '{vm-type}' as part of the parameter name with two
2182 R-66729 A VNF’s Heat Orchestration Template’s Resource that is
2183 associated with a unique Virtual Machine type **MUST** include
2184 ‘{vm-type}’ as part of the resource ID.
2186 R-98407 A VNF's Heat Orchestration Template's '{vm-type}' **MUST** contain
2187 only alphanumeric characters and/or underscores '_' and
2188 **MUST NOT** contain any of the following strings: '_int' or 'int\_'
2191 R-48067 A VNF's Heat Orchestration Template's {vm-type} **MUST NOT** be a
2192 substring of {network-role}.
2194 R-32394 A VNF’s Heat Orchestration Template’s use of ‘{vm-type}’
2195 in all Resource property parameter names **MUST** be the same case.
2197 R-46839 A VNF’s Heat Orchestration Template’s use of
2198 ‘{vm-type}’ in all Resource IDs **MUST** be the same case.
2200 R-36687 A VNF’s Heat Orchestration Template’s ‘{vm-type}’ case in
2201 Resource property parameter names **SHOULD** match the case of
2202 ‘{vm-type}’ in Resource IDs and vice versa.
2204 R-21330 A VNF’s Heat Orchestration Template’s Resource property parameter
2205 that is associated with external network **MUST** include the ‘{network-role}’’ as part of the parameter name
2207 R-11168 A VNF's Heat Orchestration Template's Resource ID that is
2208 associated with an external network **MUST** include the
2209 '{network-role}' as part of the resource ID.
2211 R-84322 A VNF's Heat Orchestration Template's Resource property
2212 parameter that is associated with an internal network
2213 **MUST** include 'int\_{network-role}' as part of the parameter
2214 name, where 'int\_' is a hard coded string.
2216 R-96983 A VNF's Heat Orchestration Template's Resource ID that is
2217 associated with an internal network **MUST** include
2218 'int\_{network-role}' as part of the Resource ID, where
2219 'int\_' is a hard coded string.
2221 R-26506 A VNF's Heat Orchestration Template's '{network-role}'
2222 **MUST** contain only alphanumeric characters and/or
2223 underscores '_' and **MUST NOT** contain any of the following
2224 strings: '_int' or 'int\_' or '\_int\_'.
2226 R-00977 A VNF’s Heat Orchestration Template’s ‘{network-role}’
2227 **MUST NOT** be a substring of ‘{vm-type}’.
2229 R-58424 A VNF’s Heat Orchestration Template’s use of ‘{network-role}’
2230 in all Resource property parameter names **MUST** be the same case
2232 R-21511 A VNF’s Heat Orchestration Template’s use of ‘{network-role}’
2233 in all Resource IDs **MUST** be the same case.
2235 R-86588 A VNF’s Heat Orchestration Template’s ‘{network-role}’ case
2236 in Resource property parameter names **SHOULD** match the case
2237 of ‘{network-role}’ in Resource IDs and vice versa.
2239 R-54517 When a VNF’s Heat Orchestration Template’s resource is associated
2240 with a single ‘{vm-type}’, the Resource ID **MUST** contain the ‘{vm-type}’.
2242 R-96482 When a VNF’s Heat Orchestration Template’s resource is associated
2243 with a single external network, the Resource ID MUST contain the text
2246 R-98138 When a VNF’s Heat Orchestration Template’s resource is associated
2247 with a single internal network, the Resource ID MUST contain the text
2248 ‘int\_{network-role}’.
2250 R-82115 When a VNF's Heat Orchestration Template's resource is associated
2251 with a single '{vm-type}' and a single external network, the Resource
2252 ID text **MUST** contain both the '{vm-type}' and the '{network-role}'
2254 - the '{vm-type}' **MUST** appear before the '{network-role}' and **MUST**
2255 be separated by an underscore '_'
2257 - e.g., '{vm-type}_{network-role}', '{vm-type}_{index}_{network-role}'
2259 - note that an '{index}' value **MAY** separate the '{vm-type}' and the
2260 '{network-role}' and when this occurs underscores **MUST** separate the
2263 R-82551 When a VNF's Heat Orchestration Template's resource is associated
2264 with a single '{vm-type}' and a single internal network, the Resource ID
2265 **MUST** contain both the '{vm-type}' and the 'int\_{network-role}' and
2267 - the '{vm-type}' **MUST** appear before the 'int\_{network-role}' and
2268 **MUST** be separated by an underscore '_'
2270 - (e.g., '{vm-type}\_int\_{network-role}', '{vm-type}_{index}\_int\_{network-role}')
2272 - note that an '{index}' value **MAY** separate the '{vm-type}' and the
2273 'int\_{network-role}' and when this occurs underscores **MUST** separate
2276 R-67793 When a VNF’s Heat Orchestration Template’s resource is associated
2277 with more than one ‘{vm-type}’ and/or more than one internal and/or
2278 external network, the Resource ID **MUST NOT** contain the ‘{vm-type}’
2279 and/or ‘{network-role}’/’int\_{network-role}’. It also should contain the
2280 term ‘shared’ and/or contain text that identifies the VNF
2282 R-27970 When a VNF’s Heat Orchestration Template’s resource is associated
2283 with more than one ‘{vm-type}’ and/or more than one internal and/or
2284 external network, the Resource ID **MAY** contain the term ‘shared’
2285 and/or **MAY** contain text that identifies the VNF.
2287 R-11690 When a VNF’s Heat Orchestration Template’s Resource ID contains
2288 an {index} value (e.g. multiple VMs of same {vm-type}), the ‘{index}’
2289 **MUST** start at zero and increment by one.
2291 R-71152 The VNF’s Heat Orchestration Template’s Resource
2292 ‘OS::Nova::Server’ property ‘image’ parameter **MUST** be declared as
2295 R-58670 The VNF’s Heat Orchestration Template’s Resource
2296 ‘OS::Nova::Server’ property ‘image’ parameter name **MUST** follow the
2297 naming convention ‘{vm-type}_image_name’.
2299 R-91125 The VNF’s Heat Orchestration Template’s Resource
2300 ‘OS::Nova::Server’ property ‘image’ parameter **MUST** be enumerated in
2301 the Heat Orchestration Template’s Environment File and a value **MUST** be
2304 R-57282 Each VNF’s Heat Orchestration Template’s ‘{vm-type}’
2305 **MUST** have a unique parameter name for the ‘OS::Nova::Server’
2306 property ‘image’ even if more than one {vm-type} shares the same image.
2308 R-50436 The VNF’s Heat Orchestration Template’s Resource
2309 ‘OS::Nova::Server’ property ‘flavor’ parameter **MUST** be declared as
2312 R-45188 The VNF’s Heat Orchestration Template’s Resource
2313 ‘OS::Nova::Server’ property ‘flavor’ parameter name **MUST** follow the
2314 naming convention ‘{vm-type}_flavor_name’.
2316 R-69431 The VNF’s Heat Orchestration Template’s Resource
2317 ‘OS::Nova::Server’ property ‘flavor’ parameter **MUST** be enumerated in the
2318 Heat Orchestration Template’s Environment File and a value **MUST** be
2321 R-40499 Each VNF’s Heat Orchestration Template’s ‘{vm-type}’ **MUST**
2322 have a unique parameter name for the ‘OS::Nova::Server’ property
2323 ‘flavor’ even if more than one {vm-type} shares the same flavor.
2325 R-51430 The VNF’s Heat Orchestration Template’s Resource
2326 ‘OS::Nova::Server’ property ‘name’ parameter **MUST** be declared as
2327 either type ‘string’ or type ‘comma_delimited_list”.
2329 R-54171 When the VNF’s Heat Orchestration Template’s Resource
2330 ‘OS::Nova::Server’ property ‘name’ parameter is defined as a ‘string’,
2331 the parameter name **MUST** follow the naming convention
2332 ‘{vm-type}\_name\_{index}’, where {index} is a numeric value that starts
2333 at zero and increments by one.
2335 R-40899 When the VNF’s Heat Orchestration Template’s Resource
2336 ‘OS::Nova::Server’ property ‘name’ parameter is defined as a ‘string’,
2337 a parameter **MUST** be declared for each ‘OS::Nova::Server’ resource
2338 associated with the ‘{vm-type}’.
2340 R-87817 When the VNF’s Heat Orchestration Template’s Resource
2341 ‘OS::Nova::Server’ property ‘name’ parameter is defined as a
2342 ‘comma_delimited_list’, the parameter name **MUST** follow the naming
2343 convention ‘{vm-type}_names’.
2345 R-85800 When the VNF’s Heat Orchestration Template’s Resource
2346 ‘OS::Nova::Server’ property ‘name’ parameter is defined as a
2347 ‘comma_delimited_list’, a parameter **MUST** be delcared once for all
2348 ‘OS::Nova::Server’ resources associated with the ‘{vm-type}’.
2350 R-22838 The VNF’s Heat Orchestration Template’s Resource
2351 ‘OS::Nova::Server’ property ‘name’ parameter **MUST NOT** be enumerated
2352 in the Heat Orchestration Template’s Environment File.
2354 R-44271 The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property
2355 'name' parameter value **SHOULD NOT** contain special characters
2356 since the Contrail GUI has a limitation displaying special characters.
2358 R-98450 The VNF’s Heat Orchestration Template’s Resource
2359 ‘OS::Nova::Server’ property ‘availability_zone’ parameter name
2360 **MUST** follow the naming convention ‘availability\_zone\_{index}’
2361 where the ‘{index}’ **MUST** start at zero and increment by one.
2363 R-23311 The VNF’s Heat Orchestration Template’s Resource
2364 ‘OS::Nova::Server’ property ‘availability_zone’ parameter **MUST**
2365 be declared as type: ‘string’.
2367 R-59568 The VNF’s Heat Orchestration Template’s Resource
2368 ‘OS::Nova::Server’ property ‘availability_zone’ parameter **MUST NOT**
2369 be enumerated in the Heat Orchestration Template’s Environment File.
2371 R-01359 A VNF’s Heat Orchstration Template that contains an
2372 ‘OS::Nova:Server’ Resource **MAY** define a parameter for the property
2373 ‘availability_zone’ that is not utilized in any ‘OS::Nova::Server’
2374 resources in the Heat Orchestration Template.
2376 R-99798 A VNF’s Heat Orchestration Template’s Virtual Machine
2377 (i.e., OS::Nova::Server Resource) **MAY** boot from an image or **MAY**
2378 boot from a Cinder Volume.
2380 R-83706 When a VNF’s Heat Orchestration Template’s Virtual Machine
2381 (i.e., ‘OS::Nova::Server’ Resource) boots from an image, the
2382 ‘OS::Nova::Server’ resource property ‘image’ **MUST** be used.
2384 R-69588 When a VNF’s Heat Orchestration Template’s Virtual Machine
2385 (i.e., ‘OS::Nova::Server’ Resource) boots from Cinder Volume, the
2386 ‘OS::Nova::Server’ resource property ‘block_device_mapping’ or
2387 ‘block_device_mapping_v2’ **MUST** be used.
2389 R-37437 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2390 Resource **MUST** contain the metadata map value parameter ‘vnf_id’.
2392 R-07507 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2393 Resource metadata map value parameter ‘vnf_id’ **MUST** be declared
2396 R-55218 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2397 Resource metadata map value parameter ‘vnf_id’ **MUST NOT** have
2398 parameter contraints defined.
2400 R-20856 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2401 Resource metadata map value parameter ‘vnf_id’ **MUST NOT** be
2402 enumerated in the Heat Orchestration Template’s environment file.
2404 R-44491 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2405 Resource metadata map value parameter ‘vnf_id’ is passed into a
2406 Nested YAML file, the parameter name ‘vnf_id’ **MUST NOT** change.
2408 R-71493 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2409 Resource **MUST** contain the metadata map value parameter
2412 R-82134 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2413 Resource metadata map value parameter ‘vf\_module\_id’ **MUST**
2414 be declared as type: ‘string’.
2416 R-98374 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2417 Resource metadata map value parameter ‘vf\_module\_id’ **MUST NOT**
2418 have parameter contraints defined.
2420 R-72871 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2421 Resource metadata map value parameter ‘vf\_module\_id’ **MUST NOT**
2422 be enumerated in the Heat Orchestration Template’s environment file.
2424 R-86237 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2425 Resource metadata map value parameter ‘vf_module_id’ is passed
2426 into a Nested YAML file, the parameter name ‘vf\_module\_id’
2427 **MUST NOT** change.
2429 R-72483 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2430 Resource **MUST** contain the metadata map value parameter
2433 R-62428 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2434 Resource metadata map value parameter ‘vnf_name’ **MUST** be
2435 declared as type: ‘string’.
2437 R-44318 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2438 Resource metadata map value parameter ‘vnf_name’ **MUST NOT** have
2439 parameter contraints defined.
2441 R-36542 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2442 Resource metadata map value parameter ‘vnf_name’ **MUST NOT** be
2443 enumerated in the Heat Orchestration Template’s environment file.
2445 R-16576 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2446 Resource metadata map value parameter ‘vnf_name’ is passed into a
2447 Nested YAML file, the parameter name ‘vnf_name’ **MUST NOT** change.
2449 R-68023 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2450 Resource **SHOULD** contain the metadata map value parameter
2453 R-39067 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2454 Resource metadata map value parameter ‘vf\_module\_name’ **MUST**
2455 be declared as type: ‘string’.
2457 R-15480 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2458 Resource metadata map value parameter ‘vf\_module\_name’
2459 **MUST NOT** have parameter contraints defined.
2461 R-80374 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2462 Resource metadata map value parameter ‘vf\_module\_name’
2463 **MUST NOT** be enumerated in the Heat Orchestration Template’s
2466 R-49177 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2467 Resource metadata map value parameter ‘vf\_module\_name’ is passed
2468 into a Nested YAML file, the parameter name ‘vf\_module\_name’
2469 **MUST NOT** change.
2471 R-85328 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2472 Resource **MAY** contain the metadata map value parameter ‘vm_role’.
2474 R-95430 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2475 Resource metadata map value parameter ‘vm_role’ **MUST** be
2476 declared as type: ‘string’.
2478 R-67597 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2479 Resource metadata map value parameter ‘vm_role’ **MUST NOT** have
2480 parameter contraints defined.
2482 R-46823 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2483 Resource metadata map value parameter ‘vnf_name’ **MUST** be
2486 - enumerated in the VNF’s Heat Orchestration
2487 Template’s environment file.
2489 - hard coded in the VNF’s Heat Orchestration
2490 Template’s OS::Nova::Resource metadata property.
2492 R-86476 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2493 Resource metadata map value parameter ‘vm_role’ value **MUST only**
2494 contain alphanumeric characters and underscores ‘_’.
2496 R-70757 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2497 Resource metadata map value parameter ‘vm_role’ is passed into a
2498 Nested YAML file, the parameter name ‘vm_role’ **MUST NOT** change.
2500 R-50816 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2501 Resource **MAY** contain the metadata map value parameter
2502 ‘vf\_module\_index’.
2504 R-54340 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2505 Resource metadata map value parameter ‘vf\_module\_index’ **MUST** be
2506 declared as type: ‘number’.
2508 R-09811 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2509 Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT**
2510 have parameter contraints defined.
2512 R-37039 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2513 Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT**
2514 be enumerated in the Heat Orchestration Template’s environment file.
2516 R-22441 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2517 Resource metadata map value parameter ‘vf\_module\_index’ is passed
2518 into a Nested YAML file, the parameter name ‘vf\_module\_index’
2519 **MUST NOT** change.
2521 R-55306 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2522 Resource metadata map value parameter ‘vf\_module\_index’ **MUST NOT** be
2523 used in a VNF’s Volume Template; it is not supported.
2525 R-47061 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2526 Resource **SHOULD** contain the metadata map value parameter
2529 R-74978 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2530 Resource metadata map value parameter ‘workload_context’ **MUST** be
2531 declared as type: ‘string’.
2533 R-34055 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2534 Resource metadata map value parameter ‘workload_context’ **MUST NOT**
2535 have parameter contraints defined.
2537 R-02691 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2538 Resource metadata map value parameter ‘workload_context’ **MUST NOT**
2539 be enumerated in the Heat Orchestration Template’s environment file.
2541 R-75202 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2542 Resource metadata map value parameter ‘workload_context’ is passed
2543 into a Nested YAML file, the parameter name ‘workload_context’
2544 **MUST NOT** change.
2546 R-88536 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2547 Resource **SHOULD** contain the metadata map value parameter
2548 ‘environment_context’.
2550 R-20308 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2551 Resource metadata map value parameter ‘environment_context’ **MUST**
2552 be declared as type: ‘string’.
2554 R-56183 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2555 Resource metadata map value parameter ‘environment_context’ **MUST NOT**
2556 have parameter contraints defined.
2558 R-13194 A VNF’s Heat Orchestration Template’s OS::Nova::Server
2559 Resource metadata map value parameter ‘environment_context’ **MUST NOT**
2560 be enumerated in the Heat Orchestration Template’s environment file.
2562 R-62954 If a VNF’s Heat Orchestration Template’s OS::Nova::Server
2563 Resource metadata map value parameter ‘environment_context’ is
2564 passed into a Nested YAML file, the parameter name
2565 ‘environment_context’ **MUST NOT** change.
2567 R-18008 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2568 property ‘network’ parameter **MUST** be declared as type: ‘string’.
2570 R-62983 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2571 is attaching to an external network, the ‘network’ parameter name **MUST**
2573 - follow the naming convention ‘{network-role}_net_id’ if the Neutron
2574 network UUID value is used to reference the network
2575 - follow the naming convention ‘{network-role}_net_name’ if the OpenStack
2576 network name is used to reference the network.
2578 where ‘{network-role}’ is the network-role of the external network and
2579 a ‘get_param’ **MUST** be used as the intrinsic function.
2581 R-86182 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2582 is attaching to an internal network, and the internal network is created in a different
2583 Heat Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’
2584 parameter name **MUST**
2586 - follow the naming convention ‘int\_{network-role}_net_id’ if the Neutron
2587 network UUID value is used to reference the network
2588 - follow the naming convention ‘int\_{network-role}_net_name’ if the
2589 OpenStack network name in is used to reference the network.
2591 where ‘{network-role}’ is the network-role of the internal network and a ‘get_param’ **MUST** be used as the intrinsic function.
2593 R-93177 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2594 is attaching to an internal network, and the internal network is created in the same Heat
2595 Orchestration Template than the ‘OS::Neutron::Port’, the ‘network’
2596 parameter name **MUST** obtain the UUID of the internal network by using
2597 the intrinsic function ‘get_resource’ or ‘get_attr’ and referencing the
2598 Resource ID of the internal network.
2600 R-29872 The VNF’s Heat Orchestration Template’s Resource ‘OS::Nova::Server’
2601 property ‘network’ parameter **MUST NOT** be enumerated in the Heat
2602 Orchestration Template’s Environment File.
2604 R-34037 The VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’
2605 property ‘fixed_ips’ map property ‘ip_address’ parameter **MUST** be declared as
2606 either type ‘string’ or type ‘comma_delimited_list’.
2608 R-40971 When the VNF’s Heat Orchestration Template’s Resource
2609 ‘OS::Neutron::Port’ is attaching to an external network, and an IPv4 address is
2610 assigned using the property
2611 ‘fixed_ips’ map property ‘ip_address’ and the parameter type is defined
2612 as a string, the parameter name **MUST** follow the naming
2613 convention ‘{vm-type}_{network-role}\_ip\_{index}’, where
2615 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2616 - ‘{network-role}’ is the {network-role} of the external network
2617 - the value for {index} must start at zero (0) and increment by one
2619 R-39841 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2620 property ‘fixed_ips’ map property ‘ip_address’ parameter
2621 ‘{vm-type}_{network-role}\_ip\_{index}’ **MUST NOT** be enumerated in the
2622 VNF’s Heat Orchestration Template’s Environment File.
2624 R-04697 When the VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2625 is attaching to an external network, and an IPv4 address is assigned using
2626 the property ‘fixed_ips’ map property ‘ip_address’ and the parameter type
2627 is defined as a comma_delimited_list, the parameter name **MUST** follow the
2628 naming convention ‘{vm-type}_{network-role}_ips’, where
2630 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2631 - ‘{network-role}’ is the {network-role} of the external network
2633 R-98905 The VNF’s Heat Orchestration Template’s Resource ‘OS::Neutron::Port’
2634 property ‘fixed_ips’ map property ‘ip_address’ parameter
2635 ‘{vm-type}_{network-role}_ips’ **MUST NOT** be enumerated in the VNF’s
2636 Heat Orchestration Template’s Environment File.
2638 R-71577 When the VNF’s Heat Orchestration Template’s Resource
2639 ‘OS::Neutron::Port’ is attaching to an external network, and an IPv6 address
2640 is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and
2641 the parameter type is defined as a string, the parameter name **MUST** follow
2642 the naming convention ‘{vm-type}_{network-role}\_v6\_ip\_{index}’, where
2644 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2645 - ‘{network-role}’ is the {network-role} of the external network
2646 - the value for {index} must start at zero (0) and increment by one
2648 R-87123 The VNF’s Heat Orchestration Template’s Resource
2649 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2650 parameter ‘{vm-type}_{network-role}\_v6\_ip\_{index}’ **MUST NOT** be enumerated
2651 in the VNF’s Heat Orchestration Template’s Environment File.
2653 R-23503 When the VNF’s Heat Orchestration Template’s Resource
2654 ‘OS::Neutron::Port’ is attaching to an external network, and an IPv6
2655 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’
2656 and the parameter type is defined as a comma_delimited_list, the parameter
2657 name **MUST** follow the naming convention ‘{vm-type}_{network-role}_v6_ips’, where
2659 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2660 - ‘{network-role}’ is the {network-role} of the external network
2662 R-93030 The VNF’s Heat Orchestration Template’s Resource
2663 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2664 parameter ‘{vm-type}_{network-role}_v6_ips’ **MUST NOT** be enumerated in the
2665 VNF’s Heat Orchestration Template’s Environment File.
2667 R-78380 When the VNF’s Heat Orchestration Template’s Resource
2668 ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv4 address
2669 is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and
2670 the parameter type is defined as a string, the parameter name **MUST** follow
2671 the naming convention ‘{vm-type}\_int\_{network-role}\_ip\_{index}’, where
2673 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2674 - ‘{network-role}’ is the {network-role} of the internal network
2675 - the value for {index} must start at zero (0) and increment by one
2677 R-28795 The VNF’s Heat Orchestration Template’s Resource
2678 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2679 parameter ‘{vm-type}\_int\_{network-role}\_ip\_{index}’ **MUST** be enumerated
2680 in the VNF’s Heat Orchestration Template’s Environment File.
2682 R-85235 When the VNF’s Heat Orchestration Template’s Resource
2683 ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv4
2684 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’
2685 and the parameter type is defined as a comma_delimited_list, the parameter
2686 name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_ips’, where
2688 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2689 - ‘{network-role}’ is the {network-role} of the internal network
2691 R-90206 The VNF’s Heat Orchestration Template’s Resource
2692 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2693 parameter ‘{vm-type}\_int\_{network-role}_int_ips’ **MUST** be enumerated in
2694 the VNF’s Heat Orchestration Template’s Environment File.
2696 R-27818 When the VNF’s Heat Orchestration Template’s Resource
2697 ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv6 address
2698 is assigned using the property ‘fixed_ips’ map property ‘ip_address’ and
2699 the parameter type is defined as a string, the parameter name **MUST** follow
2700 the naming convention ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’, where
2702 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2703 - ‘{network-role}’ is the {network-role} of the internal network
2704 - the value for {index} must start at zero (0) and increment by one
2706 R-97201 The VNF’s Heat Orchestration Template’s Resource
2707 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2708 parameter ‘{vm-type}\_int\_{network-role}\_v6\_ip\_{index}’ **MUST** be enumerated
2709 in the VNF’s Heat Orchestration Template’s Environment File.
2711 R-29765 When the VNF’s Heat Orchestration Template’s Resource
2712 ‘OS::Neutron::Port’ is attaching to an internal network, and an IPv6
2713 address is assigned using the property ‘fixed_ips’ map property ‘ip_address’
2714 and the parameter type is defined as a comma_delimited_list, the parameter
2715 name **MUST** follow the naming convention ‘{vm-type}\_int\_{network-role}_v6_ips’, where
2717 - ‘{vm-type}’ is the {vm-type} associated with the OS::Nova::Server
2718 - ‘{network-role}’ is the {network-role} of the internal network
2720 R-98569 The VNF’s Heat Orchestration Template’s Resource
2721 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2722 parameter ‘{vm-type}\_int\_{network-role}_v6_ips’ **MUST** be enumerated in
2723 the VNF’s Heat Orchestration Template’s Environment File.
2725 R-62590 The VNF’s Heat Orchestration Template’s Resource
2726 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2727 parameter associated with an external network, i.e.,
2729 R-93496 The VNF’s Heat Orchestration Template’s Resource
2730 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property ‘ip_address’
2731 parameter associated with an internal network, i.e.,
2733 R-38236 The VNF’s Heat Orchestration Template’s resource
2734 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property
2735 ‘subnet’/’subnet_id’ parameter **MUST** be declared type ‘string’.
2737 R-62802 When the VNF’s Heat Orchestration Template’s resource
2738 ‘OS::Neutron::Port’ is attaching to an external network, and an IPv4
2739 address is being Cloud Assigned by OpenStack’s DHCP Service and the
2740 external network IPv4 subnet is to be specified using the property
2741 ‘fixed_ips’ map property ‘subnet’/’subnet_id’, the parameter **MUST**
2742 follow the naming convention ‘{network-role}_subnet_id’, where
2743 ‘{network-role}’ is the network role of the network.
2745 R-83677 The VNF’s Heat Orchestration Template’s Resource
2746 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property
2747 subnet’/’subnet_id’ parameter ‘{network-role}_subnet_id’
2748 **MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s
2751 R-15287 When the VNF’s Heat Orchestration Template’s resource
2752 ‘OS::Neutron::Port’ is attaching to an external network, and an IPv6
2753 address is being Cloud Assigned by OpenStack’s DHCP Service and the
2754 external network IPv6 subnet is to be specified using the property
2755 ‘fixed_ips’ map property ‘subnet’/’subnet_id’, the parameter **MUST**
2756 follow the naming convention ‘{network-role}_subnet_v6_id’, where
2757 ‘{network-role}’ is the network role of the network.
2759 R-80829 The VNF’s Heat Orchestration Template’s Resource
2760 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property
2761 subnet’/’subnet_id’ parameter ‘{network-role}_subnet_v6_id’
2762 **MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s
2767 - the VNF’s Heat Orchestration Template’s resource ‘OS::Neutron::Port’
2768 in an Incremental Module is attaching to an internal network
2769 that is created in the Base Module, AND
2770 - an IPv4 address is being Cloud Assigned by OpenStack’s DHCP Service AND
2771 - the internal network IPv4 subnet is to be specified using the
2772 property ‘fixed_ips’ map property ‘subnet’/’subnet_id’,
2774 the parameter **MUST** follow the naming convention
2775 ‘int\_{network-role}_subnet_id’, where ‘{network-role}’ is the
2776 network role of the internal network
2778 - Note that the parameter **MUST** be defined as an ‘output’ parameter in
2781 R-69634 The VNF’s Heat Orchestration Template’s Resource
2782 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property
2783 subnet’/’subnet_id’ parameter ‘int\_{network-role}_subnet_id’
2784 **MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s
2789 - the VNF’s Heat Orchestration Template’s resource
2790 ‘OS::Neutron::Port’ in an Incremental Module is attaching to an
2791 internal network that is created in the Base Module, AND
2792 - an IPv6 address is being Cloud Assigned by OpenStack’s DHCP Service AND
2793 - the internal network IPv6 subnet is to be specified using the property
2794 ‘fixed_ips’ map property ‘subnet’/’subnet_id’,
2796 the parameter **MUST** follow the naming convention
2797 ‘int\_{network-role}_v6_subnet_id’, where ‘{network-role}’
2798 is the network role of the internal network
2800 - Note that the parameter **MUST** be defined as an ‘output’ parameter in
2803 R-22288 The VNF’s Heat Orchestration Template’s Resource
2804 ‘OS::Neutron::Port’ property ‘fixed_ips’ map property
2805 ‘subnet’/’subnet_id’ parameter ‘int\_{network-role}_v6_subnet_id’
2806 **MUST NOT** be enumerated in the VNF’s Heat Orchestration Template’s
2809 R-61282 The VNF Heat Orchestration Template **MUST**
2810 adhere to the following naming convention for the property
2811 allowed\_address\_pairs and Map Property ip\_address parameter,
2812 when the parameter is referencing an “external” network:
2814 - {vm-type}\_{network-role}\_floating\_ip for an IPv4 address
2816 - {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address
2818 R-16805 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention
2819 for the property allowed\_address\_pairs and Map Property ip\_address
2820 parameter when the parameter is referencing an “internal” network.
2822 R-85734 The VNF Heat Orchestration Template **MUST** use the intrinsic function str\_replace
2823 in conjunction with the ONAP supplied metadata parameter
2824 vnf\_name to generate a unique value,
2825 when the property name for a non OS::Nova::Server resources is defined
2826 in a Heat Orchestration Template.
2828 R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 scope of a cinder volume module,
2829 when it exists, with the Base Module or Incremental Module
2831 R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding
2832 environment file, even if no parameters are required to be enumerated.
2834 R-86285 The VNF Heat Orchestration Template **MUST** have a
2835 corresponding environment file, even if no parameters are required to be
2838 R-67205 The VNF Heat Orchestration Template **MUST** have a corresponding
2839 environment file for a Base Module.
2841 R-35727 The VNF Heat Orchestration Template **MUST** have a
2842 corresponding environment file for an Incremental module.
2844 R-22656 The VNF Heat Orchestration Template **MUST** have a corresponding environment file
2845 for a Cinder Volume Module.
2847 R-89868 The VNF Heat Orchestration Template **MUST** have unique file names within the scope
2848 of the VNF for a nested heat yaml file.
2850 R-52530 The VNF Heat Orchestration Template **MUST NOT** use a directory hierarchy for
2851 nested templates. All templates must be in a single, flat directory
2854 R-76718 The VNF Heat Orchestration Template **MUST** reference the get\_files targets in
2855 Heat templates by file name, and the corresponding files should be
2856 delivered to ONAP along with the Heat templates.
2858 R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval.
2860 R-62177 The VNF Heat Orchestration Template **MUST** have unique file names for the included
2861 files within the scope of the VNF.
2863 **ONAP Management Requirements**
2864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2867 VNF On-boarding and package management
2868 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2871 R-77707 The xNF provider **MUST** include a Manifest File that
2872 contains a list of all the components in the xNF package.
2874 R-66070 The xNF Package **MUST** include xNF Identification Data to
2875 uniquely identify the resource for a given xNF provider. The identification
2876 data must include: an identifier for the xNF, the name of the xNF as was
2877 given by the xNF provider, xNF description, xNF provider, and version.
2879 R-69565 The xNF Package **MUST** include documentation describing xNF
2880 Management APIs, which must include information and tools for ONAP to
2881 deploy and configure (initially and ongoing) the xNF application(s)
2882 (e.g., NETCONF APIs) which includes a description of configurable
2883 parameters for the xNF and whether the parameters can be configured
2884 after xNF instantiation.
2886 R-00156 The xNF Package **MUST** include documentation describing xNF
2887 Management APIs, which must include information and tools for ONAP
2888 to monitor the health of the xNF (conditions that require healing
2889 and/or scaling responses).
2891 R-00068 The xNF Package **MUST** include documentation which includes
2892 a description of parameters that can be monitored for the xNF and
2893 event records (status, fault, flow, session, call, control plane,
2894 etc.) generated by the xNF after instantiation.
2896 R-12678 The xNF Package **MUST** include documentation which includes a
2897 description of runtime lifecycle events and related actions (e.g.,
2898 control responses, tests) which can be performed for the xNF.
2900 R-84366 The xNF Package **MUST** include documentation describing
2901 xNF Functional APIs that are utilized to build network and
2902 application services. This document describes the externally exposed
2903 functional inputs and outputs for the xNF, including interface
2904 format and protocols supported.
2906 R-36280 The xNF provider **MUST** provide documentation describing
2907 xNF Functional Capabilities that are utilized to operationalize the
2908 xNF and compose complex services.
2910 R-98617 The xNF provider **MUST** provide information regarding any
2911 dependency (e.g., affinity, anti-affinity) with other xNFs and resources.
2913 R-89571 The xNF **MUST** support and provide artifacts for configuration
2914 management using at least one of the following technologies;
2915 a) Netconf/YANG, b) Chef, or c) Ansible.
2917 R-30278 The xNF provider **MUST** provide a Resource/Device YANG model
2918 as a foundation for creating the YANG model for configuration. This will
2919 include xNF attributes/parameters and valid values/attributes configurable
2922 R-13390 The xNF provider **MUST** provide cookbooks to be loaded
2923 on the appropriate Chef Server.
2925 R-18525 The xNF provider **MUST** provide a JSON file for each
2926 supported action for the xNF. The JSON file must contain key value
2927 pairs with all relevant values populated with sample data that illustrates
2928 its usage. The fields and their description are defined in Tables A1 and A2 in the Appendix.
2930 R-75608 The xNF provider **MUST** provide playbooks to be loaded
2931 on the appropriate Ansible Server.
2933 R-16777 The xNF provider **MUST** provide a JSON file for each
2934 supported action for the xNF. The JSON file must contain key value
2935 pairs with all relevant values populated with sample data that illustrates
2936 its usage. The fields and their description are defined in Table B1 in the Appendix.
2938 R-46567 The xNF Package **MUST** include configuration scripts
2939 for boot sequence and configuration.
2941 R-16065 The xNF provider **MUST** provide configurable parameters
2942 (if unable to conform to YANG model) including xNF attributes/parameters
2943 and valid values, dynamic attributes and cross parameter dependencies
2944 (e.g., customer provisioning data).
2946 R-22888 The xNF provider **MUST** provide documentation for the xNF
2947 Policy Description to manage the xNF runtime lifecycle. The document
2948 must include a description of how the policies (conditions and actions)
2949 are implemented in the xNF.
2951 R-01556 The xNF Package **MUST** include documentation describing the
2952 fault, performance, capacity events/alarms and other event records
2953 that are made available by the xNF.
2955 R-16875 The xNF Package **MUST** include documentation which must include
2956 a unique identification string for the specific xNF, a description of
2957 the problem that caused the error, and steps or procedures to perform
2958 Root Cause Analysis and resolve the issue.
2960 R-35960 The xNF Package **MUST** include documentation which must include
2961 all events, severity level (e.g., informational, warning, error) and
2962 descriptions including causes/fixes if applicable for the event.
2964 R-42018 The xNF Package **MUST** include documentation which must include
2965 all events (fault, measurement for xNF Scaling, Syslogs, State Change
2966 and Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF.
2968 R-27711 The xNF provider **MUST** provide an XML file that contains a
2969 list of xNF error codes, descriptions of the error, and possible
2970 causes/corrective action.
2972 R-01478 The xNF Package **MUST** include documentation describing all
2973 parameters that are available to monitor the xNF after instantiation
2974 (includes all counters, OIDs, PM data, KPIs, etc.) that must be
2975 collected for reporting purposes.
2977 R-73560 The xNF Package **MUST** include documentation about monitoring
2978 parameters/counters exposed for virtual resource management and xNF
2979 application management.
2981 R-90632 The xNF Package **MUST** include documentation about KPIs and
2982 metrics that need to be collected at each VM for capacity planning
2983 and performance management purposes.
2985 R-86235 The xNF Package **MUST** include documentation about the monitoring
2986 parameters that must include latencies, success rates, retry rates, load
2987 and quality (e.g., DPM) for the key transactions/functions supported by
2988 the xNF and those that must be exercised by the xNF in order to perform
2991 R-33904 The xNF Package **MUST** include documentation for each KPI, provide
2992 lower and upper limits.
2994 R-53598 The xNF Package **MUST** include documentation to, when relevant,
2995 provide a threshold crossing alert point for each KPI and describe the
2996 significance of the threshold crossing.
2998 R-69877 The xNF Package **MUST** include documentation for each KPI,
2999 identify the suggested actions that need to be performed when a
3000 threshold crossing alert event is recorded.
3002 R-22680 The xNF Package **MUST** include documentation that describes
3003 any requirements for the monitoring component of tools for Network
3004 Cloud automation and management to provide these records to components
3007 R-33694 The xNF Package **MUST** include documentation to when applicable,
3008 provide calculators needed to convert raw data into appropriate reporting
3011 R-56815 The xNF Package **MUST** include documentation describing
3012 supported xNF scaling capabilities and capacity limits (e.g., number
3013 of users, bandwidth, throughput, concurrent calls).
3015 R-48596 The xNF Package **MUST** include documentation describing
3016 the characteristics for the xNF reliability and high availability.
3018 R-74763 The xNF provider **MUST** provide an artifact per xNF that contains
3019 all of the xNF Event Records supported. The artifact should include reference
3020 to the specific release of the xNF Event Stream Common Event Data Model
3021 document it is based on. (e.g., `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__)
3023 R-35851 The xNF Package **MUST** include xNF topology that describes
3024 basic network and application connectivity internal and external to the
3025 xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if
3026 applicable) for each interface.
3028 R-97102 The VNF Package **MUST** include VM requirements via a Heat
3029 template that provides the necessary data for VM specifications
3030 for all VNF components - for hypervisor, CPU, memory, storage.
3032 R-20204 The VNF Package **MUST** include VM requirements via a Heat
3033 template that provides the necessary data for network connections,
3034 interface connections, internal and external to VNF.
3036 R-44896 The VNF Package **MUST** include VM requirements via a Heat
3037 template that provides the necessary data for high availability
3040 R-55802 The VNF Package **MUST** include VM requirements via a Heat
3041 template that provides the necessary data for scaling/growth VM
3044 R-26881 The xNF provider **MUST** provide the binaries and images
3045 needed to instantiate the xNF (xNF and VNFC images).
3047 R-96634 The xNF provider **MUST** describe scaling capabilities
3048 to manage scaling characteristics of the xNF.
3050 R-43958 The xNF Package **MUST** include documentation describing
3051 the tests that were conducted by the xNF providor and the test results.
3053 R-04298 The xNF provider **MUST** provide their testing scripts to
3056 R-58775 The xNF provider **MUST** provide software components that
3057 can be packaged with/near the xNF, if needed, to simulate any functions
3058 or systems that connect to the xNF system under test. This component is
3059 necessary only if the existing testing environment does not have the
3060 necessary simulators.
3062 R-85653 The xNF **MUST** provide metrics (e.g., number of sessions,
3063 number of subscribers, number of seats, etc.) to ONAP for tracking
3066 R-44125 The xNF provider **MUST** agree to the process that can
3067 be met by Service Provider reporting infrastructure. The Contract
3068 shall define the reporting process and the available reporting tools.
3070 R-40827 The xNF provider **MUST** enumerate all of the open
3071 source licenses their xNF(s) incorporate.
3073 R-97293 The xNF provider **MUST NOT** require audits of
3074 Service Provider’s business.
3076 R-44569 The xNF provider **MUST NOT** require additional
3077 infrastructure such as a xNF provider license server for xNF provider
3078 functions and metrics.
3080 R-13613 The VNF **MUST** provide clear measurements for licensing
3081 purposes to allow automated scale up/down by the management system.
3083 R-27511 The VNF provider **MUST** provide the ability to scale
3084 up a VNF provider supplied product during growth and scale down a
3085 VNF provider supplied product during decline without “real-time”
3086 restrictions based upon VNF provider permissions.
3088 R-85991 The xNF provider **MUST** provide a universal license key
3089 per xNF to be used as needed by services (i.e., not tied to a VM
3090 instance) as the recommended solution. The xNF provider may provide
3091 pools of Unique xNF License Keys, where there is a unique key for
3092 each xNF instance as an alternate solution. Licensing issues should
3093 be resolved without interrupting in-service xNFs.
3095 R-47849 The xNF provider **MUST** support the metadata about
3096 licenses (and their applicable entitlements) as defined in this
3097 document for xNF software, and any license keys required to authorize
3098 use of the xNF software. This metadata will be used to facilitate
3099 onboarding the xNF into the ONAP environment and automating processes
3100 for putting the licenses into use and managing the full lifecycle of
3101 the licenses. The details of this license model are described in
3102 Tables C1 to C8 in the Appendix. Note: License metadata support in
3103 ONAP is not currently available and planned for 1Q 2018.
3105 Configuration Management
3106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3108 R-20741 The xNF **MUST** support ONAP Controller’s **Configure** command.
3110 R-19366 The xNF **MUST** support ONAP Controller’s **ConfigModify** command.
3112 R-32981 The xNF **MUST** support ONAP Controller’s **ConfigBackup** command.
3114 R-48247 The xNF **MUST** support ONAP Controller’s **ConfigRestore** command.
3116 R-94084 The xNF **MUST** support ONAP Controller’s **ConfigScaleOut**
3119 R-56385 The xNF **MUST** support ONAP Controller’s **Audit** command.
3121 R-12706 The xNF **MUST** support ONAP Controller’s **QuiesceTraffic**
3124 R-07251 The xNF **MUST** support ONAP Controller’s **ResumeTraffic**
3127 R-83146 The xNF **MUST** support ONAP Controller’s **StopApplication**
3130 R-82811 The xNF **MUST** support ONAP Controller’s **StartApplication**
3133 R-19922 The xNF **MUST** support ONAP Controller’s **UpgradePrecheck**
3136 R-49466 The xNF **MUST** support ONAP Controller’s **UpgradeSoftware**
3139 R-45856 The xNF **MUST** support ONAP Controller’s **UpgradePostCheck**
3142 R-97343 The xNF **MUST** support ONAP Controller’s **UpgradeBackup**
3145 R-65641 The xNF **MUST** support ONAP Controller’s **UpgradeBackOut**
3148 R-11790 The VNF **MUST** support ONAP Controller’s
3149 **Restart (stop/start or reboot)** command.
3151 R-56218 The VNF **MUST** support ONAP Controller’s Migrate command that
3152 moves container (VM) from a live Physical Server / Compute Node to
3153 another live Physical Server / Compute Node.
3155 R-38001 The VNF MUST support ONAP Controller’s **Rebuild** command.
3157 R-76901 VNF MUST support a container rebuild mechanism based on existing
3158 image (e.g. Glance image in Openstack environment) or a snapshot.
3160 R-41430 The xNF **MUST** support ONAP Controller’s **HealthCheck**
3163 R-88026 The xNF **MUST** include a NETCONF server enabling
3164 runtime configuration and lifecycle management capabilities.
3166 R-95950 The xNF **MUST** provide a NETCONF interface fully defined
3167 by supplied YANG models for the embedded NETCONF server.
3169 R-73468 The xNF **MUST** allow the NETCONF server connection
3170 parameters to be configurable during virtual machine instantiation
3171 through Heat templates where SSH keys, usernames, passwords, SSH
3172 service and SSH port numbers are Heat template parameters.
3174 R-90007 The xNF **MUST** implement the protocol operation:
3175 **close-session()**- Gracefully close the current session.
3177 R-70496 The xNF **MUST** implement the protocol operation:
3178 **commit(confirmed, confirm-timeout)** - Commit candidate
3179 configuration datastore to the running configuration.
3181 R-18733 The xNF **MUST** implement the protocol operation:
3182 **discard-changes()** - Revert the candidate configuration
3183 datastore to the running configuration.
3185 R-44281 The xNF **MUST** implement the protocol operation:
3186 **edit-config(target, default-operation, test-option, error-option,
3187 config)** - Edit the target configuration datastore by merging,
3188 replacing, creating, or deleting new config elements.
3190 R-60106 The xNF **MUST** implement the protocol operation:
3191 **get(filter)** - Retrieve (a filtered subset of) the running
3192 configuration and device state information. This should include
3193 the list of xNF supported schemas.
3195 R-29488 The xNF **MUST** implement the protocol operation:
3196 **get-config(source, filter)** - Retrieve a (filtered subset of
3197 a) configuration from the configuration datastore source.
3199 R-11235 The xNF **MUST** implement the protocol operation:
3200 **kill-session(session)** - Force the termination of **session**.
3202 R-02597 The xNF **MUST** implement the protocol operation:
3203 **lock(target)** - Lock the configuration datastore target.
3205 R-96554 The xNF **MUST** implement the protocol operation:
3206 **unlock(target)** - Unlock the configuration datastore target.
3208 R-29324 The xNF **SHOULD** implement the protocol operation:
3209 **copy-config(target, source) -** Copy the content of the
3210 configuration datastore source to the configuration datastore target.
3212 R-88031 The xNF **SHOULD** implement the protocol operation:
3213 **delete-config(target) -** Delete the named configuration
3216 R-97529 The xNF **SHOULD** implement the protocol operation:
3217 **get-schema(identifier, version, format) -** Retrieve the YANG schema.
3219 R-62468 The xNF **MUST** allow all configuration data to be
3220 edited through a NETCONF <edit-config> operation. Proprietary
3221 NETCONF RPCs that make configuration changes are not sufficient.
3223 R-01382 The xNF **MUST** allow the entire configuration of the
3224 xNF to be retrieved via NETCONF's <get-config> and <edit-config>,
3225 independently of whether it was configured via NETCONF or other
3228 R-28756 The xNF **MUST** support **:partial-lock** and
3229 **:partial-unlock** capabilities, defined in RFC 5717. This
3230 allows multiple independent clients to each write to a different
3231 part of the <running> configuration at the same time.
3233 R-83873 The xNF **MUST** support **:rollback-on-error** value for
3234 the <error-option> parameter to the <edit-config> operation. If any
3235 error occurs during the requested edit operation, then the target
3236 database (usually the running configuration) will be left unaffected.
3237 This provides an 'all-or-nothing' edit mode for a single <edit-config>
3240 R-68990 The xNF **MUST** support the **:startup** capability. It
3241 will allow the running configuration to be copied to this special
3242 database. It can also be locked and unlocked.
3244 R-68200 The xNF **MUST** support the **:url** value to specify
3245 protocol operation source and target parameters. The capability URI
3246 for this feature will indicate which schemes (e.g., file, https, sftp)
3247 that the server supports within a particular URL value. The 'file'
3248 scheme allows for editable local configuration databases. The other
3249 schemes allow for remote storage of configuration databases.
3251 R-20353 The xNF **MUST** implement both **:candidate** and
3252 **:writable-running** capabilities. When both **:candidate** and
3253 **:writable-running** are provided then two locks should be supported.
3255 R-11499 The xNF **MUST** fully support the XPath 1.0 specification
3256 for filtered retrieval of configuration and other database contents.
3257 The 'type' attribute within the <filter> parameter for <get> and
3258 <get-config> operations may be set to 'xpath'. The 'select' attribute
3259 (which contains the XPath expression) will also be supported by the
3260 server. A server may support partial XPath retrieval filtering, but
3261 it cannot advertise the **:xpath** capability unless the entire XPath
3262 1.0 specification is supported.
3264 R-83790 The xNF **MUST** implement the **:validate** capability
3266 R-49145 The xNF **MUST** implement **:confirmed-commit** If
3267 **:candidate** is supported.
3269 R-58358 The xNF **MUST** implement the **:with-defaults** capability
3272 R-59610 The xNF **MUST** implement the data model discovery and
3273 download as defined in [RFC6022].
3275 R-87662 The xNF **SHOULD** implement the NETCONF Event Notifications
3278 R-93443 The xNF **MUST** define all data models in YANG [RFC6020],
3279 and the mapping to NETCONF shall follow the rules defined in this RFC.
3281 R-26115 The xNF **MUST** follow the data model upgrade rules defined
3282 in [RFC6020] section 10. All deviations from section 10 rules shall
3283 be handled by a built-in automatic upgrade mechanism.
3285 R-10716 The xNF **MUST** support parallel and simultaneous
3286 configuration of separate objects within itself.
3288 R-29495 The xNF **MUST** support locking if a common object is
3289 being manipulated by two simultaneous NETCONF configuration operations
3290 on the same xNF within the context of the same writable running data
3291 store (e.g., if an interface parameter is being configured then it
3292 should be locked out for configuration by a simultaneous configuration
3293 operation on that same interface parameter).
3295 R-53015 The xNF **MUST** apply locking based on the sequence of
3296 NETCONF operations, with the first configuration operation locking
3297 out all others until completed.
3299 R-02616 The xNF **MUST** permit locking at the finest granularity
3300 if a xNF needs to lock an object for configuration to avoid blocking
3301 simultaneous configuration operations on unrelated objects (e.g., BGP
3302 configuration should not be locked out if an interface is being
3303 configured or entire Interface configuration should not be locked out
3304 if a non-overlapping parameter on the interface is being configured).
3306 R-41829 The xNF **MUST** be able to specify the granularity of the
3307 lock via a restricted or full XPath expression.
3309 R-66793 The xNF **MUST** guarantee the xNF configuration integrity
3310 for all simultaneous configuration operations (e.g., if a change is
3311 attempted to the BUM filter rate from multiple interfaces on the same
3312 EVC, then they need to be sequenced in the xNF without locking either
3313 configuration method out).
3315 R-54190 The xNF **MUST** release locks to prevent permanent lock-outs
3316 when/if a session applying the lock is terminated (e.g., SSH session
3319 R-03465 The xNF **MUST** release locks to prevent permanent lock-outs
3320 when the corresponding <partial-unlock> operation succeeds.
3322 R-63935 The xNF **MUST** release locks to prevent permanent lock-outs
3323 when a user configured timer has expired forcing the NETCONF SSH Session
3324 termination (i.e., product must expose a configuration knob for a user
3325 setting of a lock expiration timer)
3327 R-10173 The xNF **MUST** allow another NETCONF session to be able to
3328 initiate the release of the lock by killing the session owning the lock,
3329 using the <kill-session> operation to guard against hung NETCONF sessions.
3331 R-88899 The xNF **MUST** support simultaneous <commit> operations
3332 within the context of this locking requirements framework.
3334 R-07545 The xNF **MUST** support all operations, administration and
3335 management (OAM) functions available from the supplier for xNFs using
3336 the supplied YANG code and associated NETCONF servers.
3338 R-60656 The xNF **MUST** support sub tree filtering.
3340 R-80898 The xNF **MUST** support heartbeat via a <get> with null filter.
3342 R-25238 The xNF PACKAGE **MUST** validated YANG code using the open
3343 source pyang [3]_ program using the following commands:
3345 R-63953 The xNF **MUST** have the echo command return a zero value
3346 otherwise the validation has failed
3348 R-26508 The xNF **MUST** support a NETCONF server that can be mounted on
3349 OpenDaylight (client) and perform the operations of: modify, update,
3350 change, rollback configurations using each configuration data element,
3351 query each state (non-configuration) data element, execute each YANG
3352 RPC, and receive data through each notification statement.
3354 R-28545 The xNF **MUST** conform its YANG model to RFC 6060,
3355 “YANG - A Data Modeling Language for the Network Configuration
3358 R-22700 The xNF **MUST** conform its YANG model to RFC 6470,
3359 “NETCONF Base Notifications”.
3361 R-10353 The xNF **MUST** conform its YANG model to RFC 6244,
3362 “An Architecture for Network Management Using NETCONF and YANG”.
3364 R-53317 The xNF **MUST** conform its YANG model to RFC 6087,
3365 “Guidelines for Authors and Reviewers of YANG Data Model Documents”.
3367 R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991,
3368 “Common YANG Data Types”.
3370 R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536,
3371 “NETCONF Access Control Model”.
3373 R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223,
3374 “A YANG Data Model for Interface Management”.
3376 R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223,
3377 “IANA Interface Type YANG Module”.
3379 R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277,
3380 “A YANG Data Model for IP Management”.
3382 R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317,
3383 “A YANG Data Model for System Management”.
3385 R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407,
3386 “A YANG Data Model for SNMP Configuration”.
3388 R-33946 The xNF **MUST** conform to the NETCONF RFC 4741,
3389 “NETCONF Configuration Protocol”.
3391 R-04158 The xNF **MUST** conform to the NETCONF RFC 4742,
3392 “Using the NETCONF Configuration Protocol over Secure Shell (SSH)”.
3394 R-13800 The xNF **MUST** conform to the NETCONF RFC 5277,
3395 “NETCONF Event Notification”.
3397 R-01334 The xNF **MUST** conform to the NETCONF RFC 5717,
3398 “Partial Lock Remote Procedure Call”.
3400 R-08134 The xNF **MUST** conform to the NETCONF RFC 6241,
3401 “NETCONF Configuration Protocol”.
3403 R-78282 The xNF **MUST** conform to the NETCONF RFC 6242,
3404 “Using the Network Configuration Protocol over Secure Shell”.
3406 R-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck
3407 RPC executes a xNF Provider-defined xNF HealthCheck over the scope of
3408 the entire xNF (e.g., if there are multiple VNFCs, then run a health check,
3409 as appropriate, for all VNFCs). It returns a 200 OK if the test completes.
3410 A JSON object is returned indicating state (healthy, unhealthy), scope
3411 identifier, time-stamp and one or more blocks containing info and fault
3412 information. If the xNF is unable to run the HealthCheck, return a
3413 standard http error code and message.
3415 R-79224 The xNF **MUST** have the chef-client be preloaded with
3416 validator keys and configuration to register with the designated
3417 Chef Server as part of the installation process.
3419 R-72184 The xNF **MUST** have routable FQDNs for all the endpoints
3420 (VMs) of a xNF that contain chef-clients which are used to register
3421 with the Chef Server. As part of invoking xNF actions, ONAP will
3422 trigger push jobs against FQDNs of endpoints for a xNF, if required.
3424 R-47068 The xNF **MAY** expose a single endpoint that is
3425 responsible for all functionality.
3427 R-67114 The xNF **MUST** be installed with Chef-Client >= 12.0 and
3428 Chef push jobs client >= 2.0.
3430 R-27310 The xNF Package **MUST** include all relevant Chef artifacts
3431 (roles/cookbooks/recipes) required to execute xNF actions requested by
3432 ONAP for loading on appropriate Chef Server.
3434 R-26567 The xNF Package **MUST** include a run list of
3435 roles/cookbooks/recipes, for each supported xNF action, that will
3436 perform the desired xNF action in its entirety as specified by ONAP
3437 (see Section 7.c, ONAP Controller APIs and Behavior, for list of xNF
3438 actions and requirements), when triggered by a chef-client run list
3441 R-98911 The xNF **MUST NOT** use any instance specific parameters
3442 for the xNF in roles/cookbooks/recipes invoked for a xNF action.
3444 R-37929 The xNF **MUST** accept all necessary instance specific
3445 data from the environment or node object attributes for the xNF
3446 in roles/cookbooks/recipes invoked for a xNF action.
3448 R-62170 The xNF **MUST** over-ride any default values for
3449 configurable parameters that can be set by ONAP in the roles,
3450 cookbooks and recipes.
3452 R-78116 The xNF **MUST** update status on the Chef Server
3453 appropriately (e.g., via a fail or raise an exception) if the
3454 chef-client run encounters any critical errors/failures when
3455 executing a xNF action.
3457 R-44013 The xNF **MUST** populate an attribute, defined as node
3458 [‘PushJobOutput’] with the desired output on all nodes in the push job
3459 that execute chef-client run if the xNF action requires the output of a
3460 chef-client run be made available (e.g., get running configuration).
3462 R-30654 The xNF Package **MUST** have appropriate cookbooks that are
3463 designed to automatically ‘rollback’ to the original state in case of
3464 any errors for actions that change state of the xNF (e.g., configure).
3466 R-65755 The xNF **SHOULD** support callback URLs to return information
3467 to ONAP upon completion of the chef-client run for any chef-client run
3468 associated with a xNF action.
3470 R-15885 The xNF **MUST** Upon completion of the chef-client run,
3471 POST back on the callback URL, a JSON object as described in Table
3472 A2 if the chef-client run list includes a cookbook/recipe that is
3473 callback capable. Failure to POST on the Callback Url should not be
3474 considered a critical error. That is, if the chef-client successfully
3475 completes the xNF action, it should reflect this status on the Chef
3476 Server regardless of whether the Callback succeeded or not.
3478 R-32217 The xNF **MUST** have routable FQDNs that are reachable via
3479 the Ansible Server for the endpoints (VMs) of a xNF on which playbooks
3480 will be executed. ONAP will initiate requests to the Ansible Server
3481 for invocation of playbooks against these end points [4]_.
3483 R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)
3484 of a xNF on which an Ansible playbook will be executed.
3486 R-35401 The xNF **MUST** support SSH and allow SSH access by the
3487 Ansible server for the endpoint VM(s) and comply with the Network
3488 Cloud Service Provider guidelines for authentication and access.
3490 R-82018 The xNF **MUST** load the Ansible Server SSH public key onto xNF
3491 VM(s) as part of instantiation. This will allow the Ansible Server
3492 to authenticate to perform post-instantiation configuration without
3493 manual intervention and without requiring specific xNF login IDs
3496 R-92866 The xNF **MUST** include as part of post-instantiation configuration
3497 done by Ansible Playbooks the removal/update of the SSH public key from
3498 /root/.ssh/authorized_keys, and update of SSH keys loaded through
3499 instantiation to support Ansible. This may include download and install of
3500 new SSH keys and new mechanized IDs.
3502 R-91745 The xNF **MUST** update the Ansible Server and other entities
3503 storing and using the SSH keys for authentication when the SSH keys used
3504 by Ansible are regenerated/updated.
3506 R-40293 The xNF **MUST** make available playbooks that conform
3507 to the ONAP requirement.
3509 R-49396 The xNF **MUST** support each ONAP (APPC) xNF action by invocation
3510 of **one** playbook [7]_. The playbook will be responsible
3511 for executing all necessary tasks (as well as calling other playbooks)
3512 to complete the request.
3514 R-33280 The xNF **MUST NOT** use any instance specific parameters
3517 R-48698 The xNF **MUST** utilize information from key value pairs
3518 that will be provided by the Ansible Server as "extra-vars" during
3519 invocation to execute the desired xNF action. If the playbook requires
3520 files, they must also be supplied using the methodology detailed in
3521 the Ansible Server API, unless they are bundled with playbooks, example,
3524 R-43253 The xNF **MUST** use playbooks designed to allow Ansible
3525 Server to infer failure or success based on the “PLAY_RECAP” capability.
3526 NOTE: There are cases where playbooks need to interpret results of a task
3527 and then determine success or failure and return result accordingly
3528 (failure for failed tasks).
3530 R-50252 The xNF **MUST** write to a specific one text files that
3531 will be retrieved and made available by the Ansible Server if, as part
3532 of a xNF action (e.g., audit), a playbook is required to return any
3533 xNF information. The text files must be written in the same directory as
3534 the one from which the playbook is being executed. A text file must be
3535 created for the xNF playbook run targets/affects, with the name
3536 ‘<VNFname>_results.txt’ into which any desired output from each
3537 respective VM/xNF must be written.
3539 R-51442 The xNF **SHOULD** use playbooks that are designed to
3540 automatically ‘rollback’ to the original state in case of any errors
3541 for actions that change state of the xNF (e.g., configure).
3543 R-58301 The xNF **SHOULD NOT** use playbooks that make requests to
3544 Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);
3545 therefore, there is no use for Cloud specific variables like Openstack
3546 UUIDs in Ansible Playbooks.
3548 R-02651 The xNF **SHOULD** use the Ansible backup feature to save a
3549 copy of configuration files before implementing changes to support
3550 operations such as backing out of software upgrades, configuration
3551 changes or other work as this will help backing out of configuration
3552 changes when needed.
3554 R-43353 The xNF **MUST** return control from Ansible Playbooks only
3555 after tasks are fully complete, signaling that the playbook completed
3556 all tasks. When starting services, return control only after all services
3557 are up. This is critical for workflows where the next steps are dependent
3559 R-51910 The xNF **MUST** provide all telemetry (e.g., fault event
3560 records, syslog records, performance records etc.) to ONAP using the
3561 model, format and mechanisms described in this section.
3563 R-19624 The xNF **MUST** encode and serialize content delivered to
3564 ONAP using JSON (RFC 7159) plain text format. High-volume data is to
3565 be encoded and serialized using `Avro <http://avro.apache.org/>`_,
3566 where the Avro [6]_ data format are described using JSON.
3570 - JSON plain text format is preferred for moderate volume data sets
3571 (option 1), as JSON has the advantage of having well-understood simple
3572 processing and being human-readable without additional decoding. Examples
3573 of moderate volume data sets include the fault alarms and performance
3574 alerts, heartbeat messages, measurements used for xNF scaling and syslogs.
3575 - Binary format using Avro is preferred for high volume data sets
3576 (option 2) such as mobility flow measurements and other high-volume
3577 streaming events (such as mobility signaling events or SIP signaling)
3578 or bulk data, as this will significantly reduce the volume of data
3579 to be transmitted. As of the date of this document, all events are
3580 reported using plain text JSON and REST.
3581 - Avro content is self-documented, using a JSON schema. The JSON schema is
3582 delivered along with the data content
3583 (http://avro.apache.org/docs/current/ ). This means the presence and
3584 position of data fields can be recognized automatically, as well as the
3585 data format, definition and other attributes. Avro content can be
3586 serialized as JSON tagged text or as binary. In binary format, the
3587 JSON schema is included as a separate data block, so the content is
3588 not tagged, further compressing the volume. For streaming data, Avro
3589 will read the schema when the stream is established and apply the
3590 schema to the received content.
3592 R-98191 The xNF **MUST** vary the frequency that asynchronous data is
3593 delivered based on the content and how data may be aggregated or grouped
3598 - For example, alarms and alerts are expected to be delivered as soon
3599 as they appear. In contrast, other content, such as performance
3600 measurements, KPIs or reported network signaling may have various ways
3601 of packaging and delivering content. Some content should be streamed
3602 immediately; or content may be monitored over a time interval, then packaged
3603 as collection of records and delivered as block; or data may be collected
3604 until a package of a certain size has been collected; or content may be
3605 summarized statistically over a time interval, or computed as a KPI, with
3606 the summary or KPI being delivered.
3607 - We expect the reporting frequency to be configurable depending
3608 on the virtual network function’s needs for management. For example,
3609 Service Provider may choose to vary the frequency of collection between
3610 normal and trouble-shooting scenarios.
3611 - Decisions about the frequency of data reporting will affect the
3612 size of delivered data sets, recommended delivery method, and how the
3613 data will be interpreted by ONAP. These considerations should not
3614 affect deserialization and decoding of the data, which will be guided
3615 by the accompanying JSON schema or GPB definition files.
3617 R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain
3618 text JSON for moderate sized asynchronous data sets, and for high
3619 volume data sets when feasible.
3621 R-84879 The xNF **MUST** have the capability of maintaining a primary
3622 and backup DNS name (URL) for connecting to ONAP collectors, with the
3623 ability to switch between addresses based on conditions defined by policy
3624 such as time-outs, and buffering to store messages until they can be
3625 delivered. At its discretion, the service provider may choose to populate
3626 only one collector address for a xNF. In this case, the network will
3627 promptly resolve connectivity problems caused by a collector or network
3628 failure transparently to the xNF.
3630 R-81777 The xNF **MUST** be configured with initial address(es) to use
3631 at deployment time. Subsequently, address(es) may be changed through
3632 ONAP-defined policies delivered from ONAP to the xNF using PUTs to a
3633 RESTful API, in the same manner that other controls over data reporting
3634 will be controlled by policy.
3636 R-08312 The xNF **MAY** use another option which is expected to include REST
3637 delivery of binary encoded data sets.
3639 R-79412 The xNF **MAY** use another option which is expected to include TCP
3640 for high volume streaming asynchronous data sets and for other high volume
3641 data sets. TCP delivery can be used for either JSON or binary encoded data
3644 R-01033 The xNF **MAY** use another option which is expected to include SFTP
3645 for asynchronous bulk files, such as bulk files that contain large volumes of
3646 data collected over a long time interval or data collected across many xNFs.
3647 (Preferred is to reorganize the data into more frequent or more focused data
3648 sets, and deliver these by REST or TCP as appropriate.)
3650 R-63229 The xNF **MAY** use another option which is expected to include REST
3651 for synchronous data, using RESTCONF (e.g., for xNF state polling).
3653 R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses
3654 as data destinations for each xNF, and may be changed by Policy while
3655 the xNF is in operation. We expect the xNF to be capable of redirecting
3656 traffic to changed destinations with no loss of data, for example from
3657 one REST URL to another, or from one TCP host and port to another.
3659 R-06924 The xNF **MUST** deliver asynchronous data as data becomes
3660 available, or according to the configured frequency.
3662 R-73285 The xNF **MUST** must encode, address and deliver the data
3663 as described in the previous paragraphs.
3665 R-42140 The xNF **MUST** respond to data requests from ONAP as soon
3666 as those requests are received, as a synchronous response.
3668 R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by
3669 the ONAP configuration subsystem for synchronous communication.
3671 R-86586 The xNF **MUST** use the YANG configuration models and RESTCONF
3672 [RFC8040] (https://tools.ietf.org/html/rfc8040).
3674 R-11240 The xNF **MUST** respond with content encoded in JSON, as
3675 described in the RESTCONF specification. This way the encoding of a
3676 synchronous communication will be consistent with Avro.
3678 R-70266 The xNF **MUST** respond to an ONAP request to deliver the
3679 current data for any of the record types defined in
3680 Event Records - Data Structure Description by returning the requested
3681 record, populated with the current field values. (Currently the defined
3682 record types include fault fields, mobile flow fields, measurements for
3683 xNF scaling fields, and syslog fields. Other record types will be added
3684 in the future as they become standardized and are made available.)
3686 R-46290 The xNF **MUST** respond to an ONAP request to deliver granular
3687 data on device or subsystem status or performance, referencing the YANG
3688 configuration model for the xNF by returning the requested data elements.
3690 R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG
3691 <https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be
3692 translated to and from JSON[RFC7951]. YANG configuration and content can
3693 be represented via JSON, consistent with Avro, as described in “Encoding
3694 and Serialization” section.
3696 R-42366 The xNF **MUST** support secure connections and transports such as
3697 Transport Layer Security (TLS) protocol
3698 [`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to
3699 the best current practices outlined in
3700 `RFC7525 <https://tools.ietf.org/html/rfc7525>`_.
3702 R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation
3703 of connections, through secure credentials, log-on and exchange mechanisms.
3705 R-47597 The xNF **MUST** carry data in motion only over secure connections.
3707 R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal
3708 Information (SPI) or certain proprietary data, in addition to applying the
3709 regular procedures for securing access and delivery.
3712 Ansible Playbook Examples
3713 -----------------------------------------------
3715 The following sections contain examples of Ansible playbooks
3716 which follow the guidelines.
3718 Guidelines for Playbooks to properly integrate with APPC
3719 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3721 NOTE: To support concurrent requests to multiple VNF instances of same
3722 or different type, VNF hosts and other files with VNF specific default
3723 values are kept or created in separate directories.
3725 Example of an Ansible command (after pwd) to run playbook again
3726 vfdb9904v VNF instance:
3728 .. code-block:: none
3731 /storage/vfdb/V16.1/ansible/configure
3732 $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3734 NOTE: To preserve Ansible inventory/group_vars capability, that makes
3735 group_vars contents global variables available to all playbooks, when they
3736 reside in the inventory directory, guidelines are being updated to name the
3737 VNF inventory hosts file as (a flat file) <VNFName>hosts, stored in the
3738 inventory directory, not a subdirectory under inventory. In the above
3739 example: vfdb9904vhosts (removed / VNF name and hosts vfdb9904/vhosts)
3741 Example of corresponding APPC API Call from ONAP – Ansible Server
3744 An example of a curl request simulating a Rest API POST requesting execution
3745 of configure Playbook (using playbook relative path):
3747 .. code-block:: none
3749 curl -u APIUser:APIPassword -H "Content-type:application/json" -X POST
3750 -d '{"Id": "8412", "PlaybookName": "vfdb/V5.x.x/ansible/configure/site.yml",
3751 "Timeout":"600", "EnvParameters": { "vnf_instance": "vfdb9904v" }}'
3752 http://ansible.server.com:5000/Dispatch
3754 Rest API GET request to obtain response/results for prior request
3755 (same Id as POST request above):
3757 .. code-block:: none
3759 curl -u APIUser:APIPassword -H 'Content-type: application/json' -X GET
3760 'http://ansible.server.com:5000/Dispatch/?Id=8412&Type=GetResult'
3764 - An ID number is assigned to each request. This ID number is used to
3765 track request down to completion and provide status to APPC when
3768 - Playbook Name relative path provided in the request as PlaybookName
3770 - Ansible Server Rest API is aware of playbook’s root directory which may
3771 vary from instance to instance or Ansible Server cluster to cluster.
3773 Ansible Playbooks will use the VNF instance name (passed using
3774 --extra-vars "vnf\_instance=vfdb9904v") to identify other default values
3775 to run the playbook(s) against the target VNF instance. Same example as
3778 .. code-block:: none
3780 $ ansible-playbook -i ../inventory/vfdb9904vhosts site.yml --extra-vars "vnf_instance=vfdb9904v"
3782 Each Ansible Server or cluster is assigned its own identification to be used
3783 to authenticate to VNF VMs using Ansible Server or cluster specific set of
3784 SSH keys that may be rotated regularly. Here hosts file, no longer referencing
3785 file with SSH key credentials, to run ansible-playbook listed in this example
3786 above (IP addresses were scrubbed):
3788 .. code-block:: none
3790 $ more ../inventory/vfdb9904v/hosts
3792 localhost ansible_connection=local
3802 NOTE: APPC requests to run Playbooks/Cookbooks are specific to a VNF,
3803 but could be more limited to one VM or one type of VM by the request
3804 parameters. Actions that may impact a site (LCP), a service, or an
3805 entire platform must be orchestrated by MSO in order to execute requests
3806 via APPC which then invoke VNF level playbooks. Playbooks that impact
3807 more than a single VNF are not the current focus of these guidelines.
3809 Since last release of these guidelines, based on recent learnings,
3810 moving VNF Type global variables under inventory/group_vars files, this
3811 way variables and respective values are available to all playbooks without
3812 being explicitly referenced though an include statement. Also creating
3813 templates that are VNF Type specific, but moving away from static files
3814 that are VNF instance specific, working to obtain VNF instance specific
3815 from other sources, inventory database, etc.
3817 And here the scrubbed default arguments for this VNF instance(originated
3818 from previously re-factored playbooks now being phased out):
3820 .. code-block:: none
3822 vnf_instance=vfdb9904v
3824 $ more ../vars/vfdb9904v/default_args.yml
3825 vm_config_oam_vnfc_name: vfdb9904vm001oam001
3826 vm_config_oam_hostname: vfdb9904vm001
3827 vm_config_oam_provider_ip_address: 1xx.2yy.zzz.109
3830 IMPORTANT: The APPC and default file attribute name for
3831 vm\_config\_oam\_vnfc\_name, as an example, is derived from vm\_config
3832 array structure (list) in the CSAR package ENV file, with dots replaced
3835 .. code-block:: none
3839 oam: {vnfc_name: {{ vm_config_oam_vnfc_name }}, hostname: {{
3840 vm_config_oam_hostname }}, provider_ip_address: {{
3841 vm_config_oam_provider_ip_address }
3845 Parameters like VNF names, VNFC names, OA&M IP addresses, after
3846 February, 2018 ONAP release, will be extracted from A&AI by APPC and
3847 then passed down to Ansible Server, as part of APPC request through REST
3848 API. In the meantime, VNF instance specific required values, will
3849 be stored on VNF instance directory, default arguments file and will be
3850 used as defaults. For parameterized playbooks attribute-value pairs
3851 passed down by APPC to Ansible Server always take precedence over
3852 template or VNF instance specific defaults stored in defaults file(s).
3854 .. code-block:: none
3857 /storage/vfdb/latest/ansible
3858 Again, originated from previously re-factored playbooks now being phased out:
3860 $ more vars/vfdb9904v/default_args.yml
3862 vm_config_oam1_vnfc_name: vfdb9904vm001oam001
3863 vm_config_oam1_hostname: vfdb9904vm001
3864 vm_config_oam1_provider_ip_address: 1xx.2yy.zzz.109
3866 vm_config_oam2_vnfc_name: vfdb9904vm002oam001
3867 vm_config_oam2_hostname: vfdb9904vm002
3868 vm_config_oam2_provider_ip_address: 1xx.2yy.zzz.110
3870 vm_config_rdb1_vnfc_name: vfdb9904vm003rdb001
3871 vm_config_rdb1_hostname: vfdb9904vm003
3872 vm_config_rdb1_provider_ip_address: 1xx.2yy.zzz.105
3874 vm_config_rdb2_vnfc_name: vfdb9904vm004rdb001
3875 vm_config_rdb2_hostname: vfdb9904vm004
3876 vm_config_rdb2_provider_ip_address: 1xx.2yy.zzz.106
3878 vm_config_rdb3_vnfc_name: vfdb9904vm005rdb001
3879 vm_config_rdb3_hostname: vfdb9904vm005
3880 vm_config_rdb3_provider_ip_address: 1xx.2yy.zzz.xxx
3882 vm_config_rdb4_vnfc_name: vfdb9904vm006rdb001
3883 vm_config_rdb4_hostname: vfdb9904vm006
3884 vm_config_rdb4_provider_ip_address: 1xx.2yy.zzz.yyy
3886 One of the first tasks on the Ansible Playbooks is to combine the VNF
3887 type generic template, derived from ENV files in CSAR or other files,
3888 with these default values stored on the Ansible Server, together with
3889 the overriding parameters passed down from APPC, to create the VNF
3890 instance specific set of attribute-value pairs to be used for the run, in
3891 INI format. Here is an excerpt from such a file that should look
3892 somewhat similar to ENV files:
3894 .. code-block:: none
3896 $ more tmp/vfdb9904v/all.yml
3898 deployment_prefix: vfdb9904v
3902 template_version: '2014-10-16'
3903 stack_name: vfdb9904v
3905 stackName: vfdb9904v
3909 # logins list contain 'login name', 'login group', 'login password'
3911 .. code-block:: none
3914 - { name: 'm99999', group: 'm99999', password: 'abcdefgha' }
3915 - { name: 'gsuser', group: 'gsuser', password: ' abcdefgha' }
3916 - { name: 'peruser', group: 'peruser', password: ' abcdefgha' }
3917 - { name: 'dbuser', group: 'dbuser', password: ' abcdefgha' }
3919 NOTE: Arguments passed by APPC to Ansible Server to run a playbook take
3920 precedence over any defaults stored in Ansible Server.
3922 Ansible Playbooks – Notes On Artifacts Required to Run Playbooks
3923 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3925 Inventory hosts file: should be VNF instance specific.
3927 Default variables: should be VNF instance specific.
3929 NOTE: Some playbooks may rely on inventory directory contents to target
3930 the collection of VNFs in the Services Platform supported through
3933 Playbooks and paths to referenced files: Playbooks shall not use
3934 absolute paths in include or import entries (variables or playbooks) or
3935 other types of references.
3937 For this to work properly, when running playbooks, the directory where
3938 the main playbook resides shall be the current directory.
3940 Playbook imports, when used, shall use paths relative to the main
3943 Root directory named ansible - Any files provided with playbooks,
3944 included, imported, or referenced by playbooks, shall reside under the ansible
3945 playbooks (root) directory, containing all playbook subdirectories, or
3946 below that ansible root directory, in other subdirectories to support
3947 on-boarding and portability of VNF collection of playbooks and related
3950 Designing for a shared environment, concurrently running playbooks,
3951 targeting multiple VNF instances – inventory hosts file:
3953 To avoid inventory hosts file overwrites or collisions between multiple
3954 concurrently running VNF instance requests, chosen approach is for each
3955 VNF instance hosts file, to be stored under the Ansible Server Playbooks
3956 root directory, under the inventory subdirectory, and under a directory
3957 for each VNF instance, named after the VNF instance, as follows:
3959 ansible/inventory/<VNF\_instance\_name>/hosts
3961 Example of inventory hosts file path, relative to ansible playbooks root
3962 directory (playbooks\_dir): ansible/inventory/vnfx0001v/hosts
3964 **Designing for a shared environment, concurrently running multiple playbooks,
3965 targeting multiple VNF instances – default argument variables for
3966 specific VNF instances:**
3968 Files containing attribute name value pairs (variable name and default
3969 values), referenced/included by playbooks – Files containing VNF
3970 instance specific default values – in a later APPC release, some or all
3971 the default attribute value pairs contained in the defaults file, may be
3972 passed down by APPC, to the Ansible Server, overriding these defaults:
3974 VNF instance specific files
3975 referenced/included by playbooks, containing default values, example,
3976 default\_args.yml, shall be stored under a directory with VNF instance
3981 ansible/vars/<VNF\_instance\_name>/default\_args.yml
3983 Example of include statement:
3985 - include_vars: ../vars/{{ vnf_instance }}/default_args.yml
3987 Again, this was originated from previously re-factored playbooks, now being
3988 phased out, to move away from having to create VNF instance specific files
3989 with VNF instance default variables. Moving to extract these values from
3990 inventory databases and provide them to Ansible Server as part of the APPC
3991 request, but may be used in a transition from having everything stored in the
3992 Ansible Server to APPC extracting and providing VNF instance specific
3993 attribute-value pairs to the Ansible Server as part of the request.
3995 Files containing attribute name value pairs (variable name and default
3996 values), referenced/included by playbooks – created dynamically by
4000 overwrites or collisions of multiple concurrently running VNF instance
4001 requests, files created dynamically by playbooks, based on VNF generic
4002 templates, combined with default values and arguments passed down by
4003 APPC (as part of the request), shall be stored under a directory with
4004 VNF instance name on the path.
4008 tmp/<VNF\_instance\_name>/all.yml
4010 Files containing site specific (Openstack location non-instance
4011 specific) attribute name value pairs, like NTP server and DNS server’s
4012 IP addresses and other parameters, referenced/included by playbooks, not
4013 VNF specific – Could/should be stored under inventory/group_vars directory,
4014 in a subdirectory named after the string used to identify the site (nyc1,
4019 ansible/inventory/group_vars/<Site>
4021 ansible/inventory/group_vars/nyc1
4023 ansible/inventory/group_vars/lax2
4026 \ **Ansible Server Design - Directory Structure**
4028 To help understanding the contents of this section, here are few basic
4031 **VNF type a.k.a VNF Function Code** - Based on current Services
4032 Platform naming convention, each Virtual Network Function is assigned a
4033 4 character string (example vfdb), these are 4 characters in
4034 the VNF instance name, followed by (4) numbers, ending in a "v", but the
4035 naming convention is evolving. VNF instance name in
4036 some cases corresponds to the stack name for the VNF when VNF instance
4037 is built based on a single module, single stack. Example of VNF instance
4038 name: vfdb9904v. All VNF performing this function, running the same
4039 software, coming from the same VNF provider will have the same 4
4040 characters in the VNF instance name, in this example, vfdb.
4042 NOTE: New naming convention includes a prefix indicating geographical
4043 location where VNF is instantiated.
4045 VNF type, determined through these 4 characters, is also known as VNF
4046 Function Code and is assigned by inventory team. All Services Platform
4047 VNF Function Codes can be found in inventory database and/or A&AI as
4048 well as Services Platform Network Design Documents.
4050 Version – As in VNF software version is the release of the software
4051 running on the VNF for which the playbooks were developed. VNF
4052 configuration steps may change from release to release and this
4053 <Version> in the path will allow the Ansible Server to host playbooks
4054 associated with each software release. And run the playbooks that match
4055 the software release running on each VNF instance. APPC initially will
4056 not support playbook versioning only latest playbook is supported or a hard
4057 coded version that later should become a variable to allow multiple
4058 actively in use playbook versions according to VNF release.
4060 Playbook Function - Is a name associated with a life cycle management
4061 task(s) performed by the playbook(s) stored in this directory. It should
4062 clearly identify the type of action(s) performed by the main playbook
4063 and possibly other playbooks stored in this same directory. Ideally,
4064 playbook function would match APPC corresponding command or function that
4065 is performed by the main playbook in this directory. Following Ansible naming
4066 standards main playbook is usually named site.yml. There can be other
4067 playbooks on the same directory that use a subset of the roles used by the
4068 main playbook site.yml. Examples of Playbook Function directory names:
4070 - configure – Contains post-instantiation (bulk) configuration
4073 - healthcheck – Contains VNF health check playbook(s), roles,…
4075 - stop – Contains VNF application stop (stopApplication) playbook(s),
4078 - start – Contains VNF application start (startApplication) playbook(s),
4081 Directory structure to allow hosting multiple version sets of playbooks,
4082 for the same VNF type, to be hosted in the runtime environment on the
4083 Ansible Servers. Generic directory structure:
4085 Ansible Playbooks – Function directory and main playbook:
4087 .. code-block:: none
4089 <VNF type>/<Version>/ansible/<Playbook Function>/site.yml
4091 Example – Post-instantiation (bulk) configuration –APPC Function -
4094 .. code-block:: none
4096 <VNF type>/<Version>/ansible/configure/site.yml
4098 Example – Post-instantiation (bulk) configuration –APPC Function
4099 – Configure – VNF software version 16.1:
4101 .. code-block:: none
4103 vfdb/V16.1/ansible/configure/site.yml
4105 Example – Health-check –APPC Function - HealthCheck:
4107 .. code-block:: none
4109 <VNF type>/<Version>/ansible/healthcheck/site.yml
4111 OR (Function directory name does not need to match APPC function name)
4113 .. code-block:: none
4115 <VNF type>/<Version>/ansible/check/site.yml
4117 Ansible Directories for other artifacts – VNF inventory hosts file -
4120 .. code-block:: none
4122 <VNF type>/<Version>/ansible/inventory/<VNF instance name>hosts
4124 Ansible Directories for other artifacts – VNF instance specific default
4125 arguments – Optional:
4127 .. code-block:: none
4129 <VNF type>/<Version>/ansible/group_vars/<VNF instance name>
4131 NOTE: This requirement is expected to be deprecated all or in part in the
4132 future, for automated actions, once APPC can pass down all VNF specific
4133 arguments for each action. Requirement remains while manual actions are
4134 to be supported. Other automated inventory management mechanisms may be
4135 considered in the future, Ansible supports many automated inventory
4136 management mechanisms/tools/solutions.
4138 Ansible Directories for other artifacts – VNF (special) groups –
4141 .. code-block:: none
4143 <VNF type>/<Version>/ansible/inventory/group_vars/<VNF instance name>
4145 NOTE: Default groups will be created based on VNFC type, 3 characters,
4146 on VNFC name. Example: “oam”, “rdb”, “dbs”, “man”, “iox”, “app”,…
4148 Ansible Directories for other artifacts – VNF (special) other files –
4149 Optional – Example – License file:
4151 .. code-block:: none
4153 <VNF type>/<Version>/ansible/<Other directory(s)>
4155 CAUTION: On referenced files used/required by playbooks.
4157 - To avoid missing files, during on-boarding or uploading of Ansible
4158 Playbooks and related artifacts, all permanent files (not generated
4159 by playbooks as part of execution), required to run any playbook,
4160 shall reside under the ansible root directory or below on other
4163 - Any references to files, on includes or other playbook entries, shall
4166 - This is the ansible (root) directory referenced on this
4167 note (Ansible Server mount point not included):
4169 .. code-block:: none
4171 <VNF type>/<Version>/ansible/
4173 There will be a soft link to the latest set of Ansible Playbooks for
4176 VNF type directories use A&AI inventory VNF function code. Ansible
4177 Playbooks will be stored on a Cinder Volume mounted on the Ansible
4178 Servers as /storage. Example:
4180 /storage/vfdb/latest/ansible – This soft link point to the latest set of
4181 playbooks (or the only set)
4183 /storage/vfdb/V16.1/ansible – Root directory for database VNF Ansible
4184 Playbooks for release 16.1
4186 CAUTION: To support this directory structure as the repository to store
4187 Ansible Playbooks run by APPC, APPC API in the Ansible Server side needs
4188 to be configured to run playbooks from directory, not MySQL database.
4190 Ansible Server HTTP will be configured to support APPC REST API requests
4191 to run playbooks as needed, against specific VNF instances, or specific
4192 VM(s) as specified in the request.
4194 ONAP APPC REST API to Ansible Server is documented separately and can be
4195 found under ONAP (onap.org).
4197 **Ansible Server – On-boarding Ansible Playbooks**
4199 Once playbooks are developed following the guidelines listed in prior
4200 section(s), playbooks need to be on-boarded onto Ansible Server(s). In
4201 the future, they’ll be on-boarded and distributed through ONAP, at least
4202 that is the proposed plan, but for now they need to be uploaded
4203 manually. There is work in progress to use a Git as the playbook
4204 repository to store and track playbooks by version, version control.
4206 These are the basic steps to on-board playbooks manually onto the
4209 1. Upload CSAR, zip, or tar file containing VNF playbooks and related
4212 2. Create full directory (using –p option below) to store Ansible
4213 Playbooks and other artifacts under /storage (or other configured)
4216 a. Includes VNF type using VNF function code 4 characters under
4219 b. Includes VNF “Version” directory as part of the path to store
4220 playbooks for this VNF version.
4222 c. Include generic ansible root directory. Creating full directory
4225 .. code-block:: none
4227 $ mkdir –p /storage/vfdb/V16.1/ansible**/**
4229 3. Make this directory (VNF ansible root directory) current directory
4232 .. code-block:: none
4234 cd /storage/vfdb/V16.1/ansible/
4236 4. Extract Ansible Playbooks and other Ansible artifacts associated with
4237 the playbooks onto the ansible directory. Command depends on the type
4238 of file uploaded, examples would be:
4240 .. code-block:: none
4246 5. Create VNF inventory hosts file with all VMs and
4247 OA&M IP addresses for all VNF instances with known OA&M IP addresses
4248 for respective VMs, example:
4250 .. code-block:: none
4254 $ touch inventory/vfdb9904vhosts
4256 $ cat inventory/vfdb9904vhosts
4259 localhost ansible\_connection=local
4269 6. (Optional, being deprecated) Create directory to hold default
4270 arguments for each VNF instance,
4273 .. code-block:: none
4275 $ mkdir –p vars/vfdb9904v
4276 $ touch vars/vfdb9904v/default\_args.yml
4277 $ cat vars/vfdb9904v/default\_args.yml
4278 vm\_config\_oam1\_vnfc\_name: vfdb9904vm001oam001
4279 vm\_config\_oam1\_hostname: vfdb9904vm001
4280 vm\_config\_oam1\_provider\_ip\_address: 1xx.2yy.zzz.109
4282 vm\_config\_oam2\_vnfc\_name: vfdb9904vm002oam001
4283 vm\_config\_oam2\_hostname: vfdb9904vm002
4284 vm\_config\_oam2\_provider\_ip\_address: 1xx.2yy.zzz.110
4286 vm\_config\_rdb1\_vnfc\_name: vfdb9904vm003rdb001
4287 vm\_config\_rdb1\_hostname: vfdb9904vm003
4288 vm\_config\_rdb1\_provider\_ip\_address: 1xx.2yy.zzz.105
4290 vm\_config\_rdb2\_vnfc\_name: vfdb9904vm004rdb001
4291 vm\_config\_rdb2\_hostname: vfdb9904vm004
4292 vm\_config\_rdb2\_provider\_ip\_address: 1xx.2yy.zzz.106
4294 vm\_config\_rdb3\_vnfc\_name: vfdb9904vm005rdb001
4295 vm\_config\_rdb3\_hostname: vfdb9904vm005
4296 vm\_config\_rdb3\_provider\_ip\_address: 1xx.2yy.zzz.xxx
4298 vm\_config\_rdb4\_vnfc\_name: vfdb9904vm006rdb001
4299 vm\_config\_rdb4\_hostname: vfdb9904vm006
4300 vm\_config\_rdb4\_provider\_ip\_address: 1xx.2yy.zzz.yyy
4302 NOTE: Please note names in this file shall use underscore “\_” not dots
4305 7. Perform some basic playbook validation running with “--check” option,
4306 running dummy playbooks or other.
4308 NOTE: Each Ansible Server or cluster of Ansible Server will have its own
4309 credentials to authenticate to VNF VMs. Ansible Server SSH public key(s)
4310 have to be loaded onto VNF VMs during instantiation or other way before
4311 Ansible Server can access VNF VMs and run playbooks. HOT templates used
4312 by heat to instantiate VNFs to be configured by these Ansible Servers running
4313 playbooks shall include the same SSH public key and load them onto VNF VM(s)
4314 as part of instantiation.
4316 Other non-vendor specific playbook tasks need to be incorporated in overall
4317 post-instantiation configuration playbook. Alternative is for company
4318 developed playbooks to be uploaded and executed, after VNF vendor provided
4321 **A couple of playbooks used for proof-of-concept testing as examples:**
4325 .. code-block:: none
4328 /storage/comx/V5.3.1.3/ansible/upgradeprecheck
4333 - import_playbook: ../common/create_vars.yml
4334 - import_playbook: ../common/create_hosts.yml
4336 - name: upgrade software pre check
4342 max_fail_percentage: 0
4343 any_errors_fatal: True
4348 $ more roles/precheck/tasks/main.yml
4351 - include_vars: /tmp/{{ vnf_instance }}/all.yml
4353 - name: get software version installed on vnf
4354 shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ existing_software_version }}"
4355 register: version_line
4358 - name: send msg when matches expected version
4359 debug: msg="*** OK *** VNF software release matches (old) release to be upgraded."
4361 when: version_line.stdout.find('1') != -1
4363 # send warning message and failure when release is not a match
4365 msg="*** WARNING *** VNF software release does not match expected (pre-upgrade) release."
4366 when: (version_line | failed) or version_line.stdout.find('1') == -1
4371 .. code-block:: none
4374 /storage/comx/V5.3.1.3/ansible/upgradepostcheck
4379 - import_playbook: ../common/create_vars.yml
4380 - import_playbook: ../common/create_hosts.yml
4382 - name: upgrade software post check
4388 max_fail_percentage: 0
4389 any_errors_fatal: True
4394 $ more roles/postcheck/tasks/main.yml
4397 - include_vars: /tmp/{{ vnf_instance }}/all.yml
4399 - name: get post upgrade software version installed on vnf
4400 shell: grep "^SW_VERSION =" /vendor/software/config/param_common.cfg | grep -c "{{ new_software_version }}"
4401 register: version_line
4404 - name: send msg when matches expected version
4405 debug: msg="*** OK *** VNF software release matches new release."
4407 when: version_line.stdout.find('1') != -1
4409 # send warning message and failure when release is not a match
4411 msg="*** WARNING *** VNF software release does not match expected new (post-upgrade) release."
4412 when: (version_line | failed) or version_line.stdout.find('1') == -1
4416 The “name” field is a mandatory field in a valid Chef Node Object
4420 Not currently supported in ONAP release 1
4423 https://github.com/mbj4668/pyang
4426 Upstream elements must provide the appropriate FQDN in the request to
4427 ONAP for the desired action.
4430 Refer to NCSP’s Network Cloud specification
4433 This option is not currently supported in ONAP and it is currently
4434 under consideration.
4437 Multiple ONAP actions may map to one playbook.
Code Review / vnfrqts / requirements.git / blob