etsi-nfv-vnf.yang 112 KB
Newer Older
1
submodule etsi-nfv-vnf {
2
  yang-version 1.1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
3
  belongs-to etsi-nfv-descriptors {
4
5
6
    prefix nfv;
  }

7
8
  include etsi-nfv-common;

9
10
11
12
13
14
15
16
17
18
  import ietf-inet-types {
    prefix inet;
  }
  import ietf-yang-types {
    prefix yang;
  }

  description
    "Models for VNFD according to GS NFV-IFA 011.";

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
19
20
21
22
23
24
25
26
  revision 2020-02-11 {
    description
      "Version 3.3.1

       Data structures to support VNFD according to:
       ETSI GS NFV-IFA 011 Ed341v332.";
  }

Mahesh Jethanandani's avatar
Bug#251  
Mahesh Jethanandani committed
27
28
29
30
  revision 2019-10-01 {
    description
      "Version 2.7.1.

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
31
       Data structures to support VNFD according to:
Mahesh Jethanandani's avatar
Bug#251  
Mahesh Jethanandani committed
32
33
       ETSI GS NFV-IFA 011 Ed271v264";
  }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
34

35
  revision 2019-03-18 {
36
37
38
    description
      "Initial revision.

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
39
40
       Data structure to support VNFD according to:
       ETSI GS NFV-IFA 011 Ed261v254";
41
42

    reference
43
      "ETSI GS NFV-IFA 011 Ed261v254";
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  }

  grouping virtual-network-interface-requirements {
    list virtual-network-interface-requirement {
      key "name";
      description
        "Specifies requirements on a virtual network interface
         realising the CPs instantiated from this CPD.";
      reference
        "GS NFV-IFA011: Section 7.1.6.4, VduCpd information
         element";

      leaf name {
        type string;
        description
          "Provides a human readable name for the requirement.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
64

65
66
67
68
69
70
71
72
      leaf description {
        type string;
        description
          "Provides a human readable description of the requirement.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
73

74
      leaf support-mandatory {
75
        status "deprecated";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
76
        default "false";
77
78
79
80
81
82
83
84
85
        type boolean;
        description
          "Indicates whether fulfilling the constraint is
           mandatory (true) for successful operation or desirable
           (false).";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
86

87
88
      list network-interface-requirements {
        key "key";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
89
        min-elements "1";
90
        max-elements "1";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
91

92
93
94
95
96
97
98
99
100
101
102
103
104
105
        leaf key {
          type string;
        }
        leaf value {
          type string;
        }
        description
          "The network interface requirements. An element from an
           array of key-value pairs that articulate the network
           interface deployment requirements.";
        reference
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
Mahesh Jethanandani's avatar
Issue#3  
Mahesh Jethanandani committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119

      leaf nic-io-requirements {
	type leafref {
          path "/nfv:nfv/nfv:vnfd/nfv:virtual-compute-desc/" +
	       "nfv:logical-node/nfv:id";
	}
	description
	  "This references (couples) the CPD with any logical node
           I/O requirements (for network devices) that may have been
           created. Linking these attributes is necessary so that I/O
           requirements that need to be articulated at the logical
           node level can be associated with the network interface
           requirements associated with the CPD.";
        reference
120
121
122
123
124
125
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
    }
  }

Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
  grouping block-storage-data {
    leaf size-of-storage {
      type uint64;
      units "GB";
      default 0;
      description
        "Size of virtualized storage resource in GB.";
      reference
        "GS NFV IFA011: Section 7.1.9.4.3, BlockStorageData
             Information element.";
    }

    list vdu-storage-requirements {
      key "key";

      leaf key {
        type string;
      }

      leaf value {
        type string;
      }
      description
        "An array of key-value pairs that articulate
             the storage deployment requirements.";
      reference
        "GS NFV IFA011: Section 7.1.9.4.3, BlockStorageData
             Information element.";
    }

    leaf rdma-enabled {
      type boolean;
      description
        "Indicate if the storage support RDMA.";
      reference
        "GS NFV IFA011: Section 7.1.9.4.3, BlockStorageData
             Information element.";
    }

    leaf sw-image-desc {
      type leafref {
        path "../../../sw-image-desc/id";
      }
      must "../size-of-storage >=" +
        "../../../sw-image-desc[id=current()]/min-disk" {
      }
      description
        "Software image to be loaded on the VirtualStorage
             resource created based on this VirtualStorageDesc.
             Shall be absent when used for virtual disks.";
      reference
        "GS NFV IFA011: Section 7.1.9.4.3, BlockStorageData
             Information element.";
179
180
181
    }
  }

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
  grouping vnf-local-affinity-or-anti-affinity-rule {
    list local-affinity-or-anti-affinity-rule {
      key "type scope";

      leaf type {
        type affinity-type;
        description
          "Specifies whether the rule is an affinity rule or an
           anti-affinity rule.";
        reference
          "GS NFV IFA011: Section 7.1.8.11,
           LocalAffinityOrAntiAffinityRule information element.";
      }

      leaf scope {
        type affinity-scope;
        description
          "Specifies the scope of the rule, possible values are
           'NFVI-PoP', 'Zone', 'ZoneGroup', 'NFVI-node'.";
        reference
          "GS NFV IFA011: Section 7.1.8.11,
           LocalAffinityOrAntiAffinityRule information element.";
      }

      uses nfvi-maintenance-info {
        description
          "When present, provides information on the impact tolerance
           and rules to be observed when a group of instances based
           on the same VDU is impacted during NFVI operation and
           maintenance (e.g. NFVI resource upgrades).";
        reference
          "GS NFV IFA011: Section 7.1.8.11,
           LocalAffinityOrAntiAffinityRule information element.";
      }
    }
  }

219
  grouping vnfd {
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    leaf id {
      type string;
      description
        "Identifier of this VNFD information element. This attribute
         shall be globally unique. The format will be defined in the
         data model specification phase.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf provider {
      type string;
      mandatory true;
      description
        "Provider of the VNF and of the VNFD";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-name {
      type string;
      mandatory true;
      description
        "Name to identify the VNF Product. Invariant for the VNF
         Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf software-version {
      type string;
      mandatory true;
      description
        "Software version of the VNF. This is changed when there is
         any change to the software that is included in the VNF
         Package";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf version {
      type string;
      mandatory true;
      description
        "Identifies the version of the VNFD";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-info-name {
      type string;
      description
        "Human readable name of the VNFD. Can change
         during the VNF Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf product-info-description {
      type string;
      description
        "Human readable description of the VNFD. Can change during
         the VNF Product lifetime.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf-list vnfm-info {
      type string;
      min-elements 1;
      description
        "Identifies VNFM(s) compatible with the VNF described in
         this version of the VNFD.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    leaf localization-language {
      type string;
299
      description
300
        "Information about the language of the VNF.";
301
302
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    }

    leaf default-localization-language {
      when "../localization-language";
      type string;
      description
        "Default localization language that is instantiated if no
         information about selected localization language is
         available. Shall be present if 'localization-language'
         is present and shall be absent otherwise.";
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
    }

    list vdu {
      key "id";
      min-elements 1;
      description
        "The Virtualisation Deployment Unit (VDU) is a construct supporting
         the description of the deployment and operational behaviour of a
         VNF component, or the entire VNF if it was not componentized in
         components.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element";

328
329
330
      leaf id {
        type string;
        description
331
          "Unique identifier of this VDU in VNFD.";
332
        reference
333
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
334
      }
335
336

      leaf name {
337
338
339
        type string;
        mandatory true;
        description
340
          "Human readable name of the VDU.";
341
        reference
342
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
343
      }
344
345

      leaf description {
346
347
        type string;
        description
348
          "Human readable description of the VDU.";
349
        reference
350
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
351
      }
352
353
354
355

      list int-cpd {
        key "id";
        min-elements 1;
356
        description
357
358
359
360
          "A internal-connection-point element is a type of
           connection point and describes network connectivity
           between a VDU instance and an internal Virtual Link or
           an external connection point.";
361
        reference
362
363
364
365
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";

        leaf int-virtual-link-desc {
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
366
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
          }
          description
            "Reference of the internal VLD which this internal CPD
             connects to.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element";
        }

        leaf bitrate-requirement {
          type uint64;
          units "Mbps";
          description
            "Bitrate requirement on this CP.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
        uses virtual-network-interface-requirements;

        leaf nicio-requirements {
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
389
            path "/nfv:nfv/nfv:vnfd/nfv:virtual-compute-desc/nfv:id";
390
391
392
393
394
395
396
397
398
399
400
401
402
          }
          description
            "This references (couples) the CPD with any logical node I/O
             requirements (for network devices) that may have been
             created. Linking these attributes is necessary so that so
             that I/O requirements that need to be articulated at the
             logical node level can be associated with the network
             interface requirements associated with the CPD.";
          reference
            "GS NFV-IFA011: Section 7.1.6.6,
             VirtualNetworkInterfaceRequirements information element";
        }

403
        leaf order {
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
          type uint32;
          description
            "The order of the NIC to be assigned on the compute
             instance (e.g. 2 for eth2).

             Note: when binding more than one port to a single
             compute (aka multi vNICs) and ordering is desired, it
             is mandatory that all ports will be set with an order
             value. The order values shall represent a positive,
             arithmetic progression that starts with 0 (i.e. 0, 1,
             2,..., n).

             If the property is not present, it shall be left to the
             VIM to assign a value when creating the instance.";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
422
423

        leaf vnic-type {
424
425
426
427
428
          type identityref {
            base vnic-type;
          }
          description
            "Describes the type of the virtual network interface
429
430
431
432
433
434
435
436
437
438
439
440
441
442
             realizing the CPs instantiated from this CPD. This is
             used to determine which mechanism driver(s) to be used
             to bind the port. Value:
             • NORMAL
             • VIRTIO
             • DIRECT
             • BAREMETAL
             • VIRTIO-FORWARDER
             • DIRECT-PHYSICAL
             • SMART-NIC";
          reference
            "GS NFV IFA011: Section 7.1.6.4, VduCpd information
             element.";
        }
443
444
445
446
447
448
449
450
451
452
453
454
        uses cpd;

        leaf security-group-rule-id {
          type leafref {
            path "../../../security-group-rule/id";
          }
          description
            "Reference of the security group rules bound to this
             CPD.";
          reference
            "GS NFV IFA011: Section 7.1.6.3 Cpd information element";
        }
455
      }
456
457
458
459
460
461
462
463
464
465

      leaf virtual-compute-desc {
        type leafref {
          path "../../virtual-compute-desc/id";
        }
        must "../../virtual-compute-desc[id=current()]/" +
             "virtual-memory/size >=" +
             "../../sw-image-desc[id=current()/" +
             "../sw-image-desc]/min-ram" {
        }
466
        description
467
468
          "Describes CPU, Memory and acceleration requirements of
           the Virtualisation Container realizing this VDU.";
469
        reference
470
471
472
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.2.2, VirtualComputeDesc
           information element.";
473
      }
474
475
476
477
478

      leaf-list virtual-storage-desc {
        type leafref {
          path "../../virtual-storage-desc/id";
        }
479
        description
480
481
482
          "Describes storage requirements for a VirtualStorage
           instance attached to the virtualisation container
           created from virtualComputeDesc defined for this VDU.";
483
        reference
484
485
486
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.4, Information elements
           related to Virtual Storage.";
487
      }
488
489
490
491
492
493
494
495
496
497
498
499
500
501

      list boot-order {
        ordered-by user;
        key "key";

        leaf key {
          type uint32;
        }

        leaf value {
          type leafref {
            path "../../virtual-storage-desc";
          }
        }
502
        description
503
504
505
506
507
508
509
510
          "The key indicates the boot index (lowest index defines
           highest boot priority). The Value references a descriptor
           from which a valid boot device is created e.g.
           VirtualStorageDesc from which a VirtualStorage instance
           is created.

           Editor's note: The boot-order node requires further
           study.";
511
        reference
512
513
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
514
      }
515
516
517
518
519

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
        }
520
        description
521
522
          "Describes the software image which is directly loaded on
           the virtualisation container realising this Vdu.";
523
        reference
524
525
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
526
      }
527
528

      leaf-list nfvi-constraint {
529
530
        type string;
        description
531
532
533
534
          "Describes constraints on the NFVI for the VNFC
           instance(s) created from this Vdu. For example, aspects
           of a secure hosting environment for the VNFC instance
           that involve additional entities or processes.";
535
        reference
536
537
          "GS NFV IFA011: Section 7.1.6.2, VDU Information
           element.";
538
      }
539

540
      list monitoring-parameter {
541
542
543
544
        key "id";
        leaf id {
          type string;
          description
545
            "Unique identifier of the monitoring parameter.";
546
          reference
547
548
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
549
        }
550
551
552
553
554
555
        uses monitoring-parameter;
      }

      list configurable-properties {
        key "key";
        leaf key {
556
557
          type string;
        }
558
        leaf value {
559
560
          type string;
        }
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
        description
          "It provides VNFC configurable properties that can be
           modified using the ModifyVnfInfo operation.";
        reference
          "GS NFV IFA011: Section 7.1.6.7,
           VnfcConfigurableProperties Information element.";
      }

      leaf boot-data {
        type string;
        description
          "Contains a string or a URL to a file contained in the
           VNF package used to customize a virtualised compute
           resource at boot time. The bootData may contain variable
           parts that are replaced by deployment specific values
           before being sent to the VIM.";
        reference
          "GS NFV IFA011: Section 7.1.6.7,
           VnfcConfigurableProperties Information element.";
      }
    }

    list virtual-compute-desc {
      key "id";
      description
        "Defines descriptors of virtual compute resources to be
         used by the VNF.";
      leaf id {
        type string;
        description
          "Unique identifier of this VirtualComputeDesc in the
           VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.9.2, Information elements
           related to Virtual CPU.";
      }

      list logical-node {
        key "id";

        leaf id {
          type string;
603
          description
604
            "Identifies this set of logical node requirements.";
605
          reference
606
607
608
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
             Information elements.";
        }
609

610
611
        list requirement-detail {
          key "key";
612
          min-elements 1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
613

614
615
          leaf key {
            type string;
616
          }
617
618
619

          leaf value {
            type string;
620
          }
621
          description
622
623
624
625
626
627
628
629
630
631
            "The logical node-level compute, memory and I/O
             requirements. An array of key-value pairs that
             articulate the deployment requirements.

             This could include the number of CPU cores on this
             logical node, a memory configuration specific to a
             logical node (e.g. such as available in the Linux
             kernel via the libnuma library) or a requirement
             related to the association of an I/O device with the
             logical node.";
632
          reference
633
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
634
635
             information element.";
        }
636
637
638
639
640
641
        description
          "The logical node requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2, VirtualComputeDesc
           information element.";
      }
642

643
644
645
646
647
      list request-additional-capability {
        key "name";

        leaf name {
          type string;
648
          description
649
650
651
            "Identifies a requested additional capability for the
             VDU. ETSI GS NFV-IFA 002 [i.1] describes acceleration
             capabilities.";
652
          reference
653
654
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
655
        }
656

657
658
659
660
661
        leaf support-mandatory {
          type boolean;
          description
            "Indicates whether the requested additional capability
             is mandatory for successful operation.";
662
          reference
663
664
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information
665
             element.";
666
        }
667
668
669

        leaf min-version {
          type string;
670
          description
671
672
            "Identifies the minimum version of the requested
             additional capability.";
673
          reference
674
675
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
676
        }
677
678

        leaf preferred-version {
679
680
          type string;
          description
681
682
            "Identifies the preferred version of the requested
             additional capability.";
683
          reference
684
685
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
686
        }
687
688

        list target-performance-parameters {
689
          key "key";
690

691
692
693
          leaf key {
            type string;
          }
694

695
696
697
          leaf value {
            type string;
          }
698
          description
699
700
            "Identifies specific attributes, dependent on the
             requested additional capability type.";
701
          reference
702
703
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
704
705
        }
      }
706

707
708
      leaf compute-requirements {
        type string;
709
        description
710
711
712
713
714
          "Specifies compute requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";
      }
715

716
717
718
719
720
      container virtual-memory {
        leaf size {
          type decimal64 {
            fraction-digits 1;
            range "0..max";
721
          }
722
723
724
725
726
727
728
729
          units "GB";
          default 1;
          description
            "Amount of virtual memory in GB.";
          reference
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
        }
730

731
732
        leaf over-subscription-policy {
          type string;
733
          description
734
735
736
737
            "The memory core oversubscription policy in terms of
             virtual memory to physical memory on the platform.
             The cardinality can be 0 during the allocation
             request, if no particular value is requested.";
738
          reference
739
740
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
741
742
        }

743
744
        list vdu-mem-requirements {
          key "key";
745

746
          leaf key {
747
748
749
            type string;
          }

750
          leaf value {
751
752
            type string;
          }
753
754
755
756
757
758
          description
            "Array of key-value pair requirements on the memory for
             the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.9.3.2, VirtualMemoryData
             information element.";
759
760
        }

761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
        leaf numa-enabled {
          type boolean;
          description
            "It specifies the memory allocation to be cognisant of
             the relevant process/core allocation. The cardinality
             can be 0 during the allocation request, if no
             particular value is requested.";
          reference
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
        }
        description
          "The virtual memory of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";
      }

      container virtual-cpu {
        description
          "The virtual CPU(s)of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";

        leaf cpu-architecture {
787
788
          type string;
          description
789
790
791
            "CPU architecture type. Examples are x86, ARM. The
             cardinality can be 0 during the allocation request,
             if no particular CPU architecture type is requested.";
792
          reference
793
794
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
795
796
        }

797
798
799
        leaf num-virtual-cpu {
          type uint16 {
            range "1..max";
800
          }
801
802
803
804
805
806
807
          default 1;
          description
            "Number of virtual CPUs.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }
808

809
810
811
        leaf clock {
          type uint32;
          units "MHz";
812
          description
813
814
815
            "Minimum virtual CPU clock rate (e.g. in MHz). The
             cardinality can be 0 during the allocation request,
             if no particular value is requested.";
816
          reference
817
818
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
819
        }
820
821
822

        leaf oversubscription-policy {
          type string;
823
          description
824
825
826
827
            "The CPU core oversubscription policy e.g. the relation
             of virtual CPU cores to physical CPU cores/threads.
             The cardinality can be 0 during the allocation request,
             if no particular value is requested.";
828
          reference
829
830
831
832
833
834
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }

        list vdu-cpu-requirements {
          key "key";
835

836
          leaf key {
837
838
            type string;
          }
839
840

          leaf value {
841
            type string;
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
          }
          description
            "Array of key-value pair requirements on the compute
             (CPU) for the VDU.";
          reference
            "GS NFV IFA011: Section 7.1.9.3.2, VirtualCpuData
             information element.";
        }

        container pinning {
          presence "Set to specify CPU pinning.";

          leaf policy {
            default "dynamic";
            type enumeration {
              enum "static";
              enum "dynamic";
            }
860
            description
861
862
863
864
865
866
867
868
              "The policy can take values of 'static' or 'dynamic'.
               In case of 'static' the virtual CPU cores are
               requested to be allocated to logical CPU cores
               according to the rules defined in
               virtualCpuPinningRules. In case of 'dynamic' the
               allocation of virtual CPU cores to logical CPU cores
               is decided by the VIM. (e.g. SMT (Simultaneous
               MultiThreading) requirements).";
869
            reference
870
871
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
872
          }
873
874
875

          list rule {
            when "../policy = 'static'";
876
            key "key";
877

878
879
880
881
882
883
884
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
885
886
887
              "A list of rules that should be considered during the
               allocation of the virtual CPUs to logical CPUs in case
               of 'static' virtualCpuPinningPolicy.";
888
            reference
889
890
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
891
          }
Mahesh Jethanandani's avatar
Issue#6  
Mahesh Jethanandani committed
892

Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
893
894
895
896
897
898
899
          leaf-list cpu-policy {
            type enumeration {
              enum "dedicated";
              enum "shared";
            }
            description
              "Shows the list of dedicated virtual CPU cores and
Mahesh Jethanandani's avatar
Issue#6  
Mahesh Jethanandani committed
900
901
902
903
904
905
906
               shared virtual CPU cores in a VM. Dedicated refers to
               a virtual CPU core occupies one physical CPU core.
               Shared refers to multi virtual CPU cores shared one
               physical CPU core.";
            reference
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
907
          }
908
909
910
911
912
913
914
915
          description
            "The virtual CPU pinning configuration for the
             virtualised compute resource.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3,
             VirtualCpuData information element.";
        }
      }
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933

      list virtual-disk {
	key "id";

        description
          "The local or ephemeral disk(s) of the virtualised compute.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";

	leaf id {
	  type string;
	  description
	    "Unique identifier for the list of virtual disks.";
	}

        uses block-storage-data;
      }
934
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
935

936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
    list virtual-storage-desc {
      key "id";
      description
        "Storage requirements for a Virtual Storage instance
         attached to the VNFC created from this VDU";
      leaf id {
        type string;
        description
          "Unique identifier of this VirtualStorageDesc in the
           VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      leaf type-of-storage {
        // Needed to be able to onboard images
        type identityref {
          base storage-type;
955
        }
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
956
        default "nfv:block";
957
        description
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
958
959
          "Type of virtualised storage resource (BLOCK, OBJECT,
           FILE).";
960
961
962
963
964
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
965
966
      choice storage {
	container block-storage-data {
967
	  when '../type-of-storage = "nfv:block"';
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
968
	  description
969
            "Specifies the details of block storage. It shall
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
970
971
972
973
974
975
976
977
978
979
             be present when the 'typeOfStorage' attribute is set to
             'BLOCK'. It shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  uses block-storage-data;
	}

	container object-storage-data {
980
	  when '../type-of-storage = "nfv:object"';
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
	  description
	    "Specifies the details of object storage. It shall be
             present when the 'typeOfStorage' attribute is set to
             'OBJECT'. It shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  leaf max-size-of-storage {
	    type uint64;
	    units "GB";
	    default 0;
	    description
	      "Max size of virtualised storage resource in GB.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.4, ObjectStorage Information
               element.";
	  }
	}

	container file-storage-data {
1002
	  when '../type-of-storage = "nfv:file"';
Mahesh Jethanandani's avatar
Issue#2  
Mahesh Jethanandani committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
	  description
	    "Specifies the details of file storage. It shall be present
             when the 'typeOfStorage' attribute is set to 'FILE'. It
             shall be absent otherwise.";
	  reference
	    "GS NFV IFA011: Section 7.1.9.4, Information elements
             related to Virtual Storage.";

	  leaf size-of-storage {
	    type uint64;
	    units "GB";
	    default 0;
	    description
	      "Size of virtualised storage resource in GB.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }

	  leaf file-system-protocol {
	    type string;
	    default "cifs";
	    description
	      "The shared file system protocol (e.g. NFS, CIFS).";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }

	  leaf int-virtual-link-desc {
	    type leafref {
	      path "../../../sw-image-desc/id";
	    }
	    mandatory true;
	    description
	      "Reference of the internal VLD which this file storage
               connects to. The attached VDUs shall connect to the
               same internal VLD.";
	    reference
	      "GS NFV IFA011: Section 7.1.9.4.5, FileStorageData
               Information element.";
	  }
	}
1046
      }
1047
    }
1048

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
    list sw-image-desc {
      key "id";
      description
        "Defines descriptors of software images to be used by the
         VNF.";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD Information element.";

      leaf id {
        type string;
1059
        description
1060
          "The identifier of this software image.";
1061
        reference
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc information
           element";
      }

      leaf name {
        mandatory true;
        type string;
        description
          "The name of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

      leaf version {
        mandatory true;
        type string;
        description
          "The version of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
      leaf provider {
        type string;
        description
          "The provider of this software image. If not present the
           provider of the software image is assumed to be same as
           the VNF provider.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }

1097
1098
1099
      container checksum {

        leaf algorithm {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1100
          mandatory true;
1101
1102
1103
          type identityref {
            base checksum-algorithm;
          }
1104
          description
1105
1106
            "Species the algorithm used to obtain the checksum
             value.";
1107
          reference
1108
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
1109
1110
             information element.";
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1111

1112
1113
        leaf hash {
          mandatory true;
1114
1115
          type string;
          description
1116
1117
1118
            "Contains the result of applying the algorithm
             indicated by the algorithm attribute to the data to
             which this ChecksumData refers.";
1119
          reference
1120
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
1121
1122
             information element.";
        }
1123
1124
1125
1126
1127
1128
        description
          "The checksum of the software image file.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1129

1130
1131
1132
1133
      leaf container-format {
        default "bare";
        type enumeration {
          enum "aki" {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1134
            description
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "bare" {
            description
              "The image does not have a container or metadata
               envelope.";
          }
          enum "docker" {
            description
              "A docker container format.";
          }
          enum "ova" {
            description
              "An OVF package in a tarfile.";
          }
          enum "ovf" {
            description
              "The OVF container format.";
1161
1162
          }
        }
1163
1164
1165
1166
1167
1168
1169
        description
          "The container format describes the container file
           format in which software image is provided.";
        reference
          "GS NFV IFA011: Section 7.1.6.5 SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1170

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
      leaf disk-format {
        default "qcow2";
        type enumeration {
          enum "aki" {
            description
              "An Amazon kernel image.";
          }
          enum "ami" {
            description
              "An Amazon machine image.";
          }
          enum "ari" {
            description
              "An Amazon ramdisk image.";
          }
          enum "iso" {
            description
              "An archive format for the data contents of an
               disk, such as CD-ROM.";
          }
          enum "qcow2" {
            description
              "Supported by the QEMU emulator that can expand
               dynamically and supports Copy on Write.";
          }
          enum "raw" {
            description
              "An unstructured disk image format; if you have a
               file without an extension it is possibly a raw
               format.";
          }
          enum "vdi" {
            description
              "Supported by VirtualBox virtual machine monitor
               and the QEMU emulator.";
          }
          enum "vhd" {
            description
              "The VHD disk format, a common disk format used by
               virtual machine monitors from VMware, Xen,
               Microsoft, VirtualBox, and others.";
          }
          enum "vhdx" {
            description
              "The VHDX disk format, an enhanced version of the
               VHD format, which supports larger disk sizes among
               other features.";
          }
          enum "vmdk" {
            description
              "Common disk format supported by many common virtual
               machine monitors.";
1223
1224
          }
        }
1225
1226
1227
1228
        description
          "The disk format of a software image is the format of
           the underlying disk image.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1229

1230
1231
        leaf min-disk {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1232
          units "GB";
1233
          mandatory true;
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
          description
            "The minimal disk size requirement for this software
             image. The value of the 'size of storage' attribute
             of the VirtualStorageDesc referencing this
             SwImageDesc shall not be smaller than the value of
             minDisk.";
          reference
            "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
             information element.";
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1244

1245
1246
1247
1248
      leaf min-ram {
        type decimal64 {
          fraction-digits 1;
          range "0..max";
1249
        }
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
        units "GB";
        default 0;
        description
          "The minimal RAM requirement for this software image.
           The value of the 'size' attribute of
           VirtualMemoryData of the Vdu referencing this
           SwImageDesc shall not be smaller than the value of
           minRam.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1262

1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
      leaf size {
        mandatory true;
        type uint64;
        units "GB";
        description
          "The size of this software image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1273

1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
      leaf image {
        default ".";
        type inet:uri;
        description
          "This is a reference to the actual software image.
           The reference can be relative to the root of the VNF
           Package or can be a URL";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1285

1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
      leaf operating-system {
        type string;
        description
          "Identifies the operating system used in the software
           image. This attribute may also identify if a 32 bit
           or 64 bit software image is used.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1296

1297
1298
1299
1300
1301
1302
1303
1304
1305
      leaf-list supported-virtualization-environment {
        type string;
        description
          "Identifies the virtualisation environments
           (e.g. hypervisor) compatible with this software
           image.";
        reference
          "GS NFV IFA011: Section 7.1.6.5, SwImageDesc
           information element.";
1306
      }
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
    }

    list int-virtual-link-desc {
      key "id";
      description
        "Represents the type of network connectivity mandated by the
         VNF provider between two or more CPs which includes at
         least one internal CP.";
      reference
        "GS NFV IFA011: Section 7.1.2, Vnfd information element.";
1317

1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
      leaf id {
        type string;
        description
          "Unique identifier of this internal VLD in VNFD.";
        reference
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";
      }

      list flavour {
1328
1329
        key "id";
        description
1330
1331
          "Describes a specific flavour of the VL with specific
             bitrate requirements.";
1332
        reference
1333
1334
1335
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";

1336
1337
1338
        leaf id {
          type string;
          description
1339
            "Identifies a flavour within a VnfVirtualLinkDesc.";
1340
          reference
1341
1342
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1343
1344
        }

1345
1346
        container qos {
          presence "VL QoS parameters";
1347
          description
1348
            "QoS of the VL.";
1349
          reference
1350
1351
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1352

1353
1354
1355
1356
          leaf latency {
            type uint32;
            units "ms";
            mandatory true;
1357
            description
1358
              "Specifies the maximum latency in ms.";
1359
            reference
1360
1361
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1362
          }
1363
1364
1365
1366
1367

          leaf packet-delay-variation {
            type uint32;
            units "ms";
            mandatory true;
1368
            description
1369
              "Specifies the maximum jitter in ms.";
1370
            reference
1371
1372
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1373
          }
1374

1375
1376
1377
1378
1379
          leaf packet-loss-ratio {
            type decimal64 {
              fraction-digits "2";
              range "0..1.00";
            }
1380
            description
1381
1382
1383
1384
              "Specifies the maximum packet loss ratio.";
            reference
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1385
1386
1387
          }
        }
      }
1388

1389
      uses connectivity-type;
1390

1391
1392
      leaf-list test-access {
        type string;
1393
        description
1394
1395
1396
          "Specifies test access facilities expected on the VL
           (e.g. none, passive monitoring, or active (intrusive)
           loopbacks at endpoints.";
1397
        reference
1398