etsi-nfv-vnf.yang 95.1 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
Bug#251  
Mahesh Jethanandani committed
19
20
21
22
23
24
25
26
  revision 2019-10-01 {
    description
      "Version 2.7.1.

       Common data structures to support VNFD and NSD according to:
       ETSI GS NFV-IFA 014 Ed271v264
       ETSI GS NFV-IFA 011 Ed271v264";
  }
27
  revision 2019-03-18 {
28
29
30
31
    description
      "Initial revision.

       Common data structure to support VNFD according to:
32
       VNFD according to ETSI GS NFV-IFA 011 Ed261v254";
33
34

    reference
35
      "ETSI GS NFV-IFA 011 Ed261v254";
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
  }

  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
56

57
58
59
60
61
62
63
64
      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
65

66
      leaf support-mandatory {
67
	status "deprecated";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
68
        default "false";
69
70
71
72
73
74
75
76
77
        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
78

79
80
      list network-interface-requirements {
        key "key";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
81
        min-elements "1";
82
        max-elements "1";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
83

84
85
86
87
88
89
90
91
92
93
94
        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
Mahesh Jethanandani's avatar
Issue#3  
Mahesh Jethanandani committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }

      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
112
113
114
115
116
117
118
          "GS NFV-IFA011: Section 7.1.6.6,
           VirtualNetworkInterfaceRequirements information element";
      }
    }
  }

  grouping vnfd {
119
120
121
122
123
124
125
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
    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;
198
      description
199
        "Information about the language of the VNF.";
200
201
      reference
        "GS NFV-IFA011: Section 7.1.2, VNFD information element";
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    }

    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";

227
228
229
      leaf id {
        type string;
        description
230
          "Unique identifier of this VDU in VNFD.";
231
        reference
232
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
233
      }
234
235

      leaf name {
236
237
238
        type string;
        mandatory true;
        description
239
          "Human readable name of the VDU.";
240
        reference
241
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
242
      }
243
244

      leaf description {
245
246
        type string;
        description
247
          "Human readable description of the VDU.";
248
        reference
249
          "GS NFV IFA011: Section 7.1.6.2, Vdu information element";
250
      }
251
252
253
254

      list int-cpd {
        key "id";
        min-elements 1;
255
        description
256
257
258
259
          "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.";
260
        reference
261
262
263
264
          "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
265
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
          }
          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
288
            path "/nfv:nfv/nfv:vnfd/nfv:virtual-compute-desc/nfv:id";
289
290
291
292
293
294
295
296
297
298
299
300
301
          }
          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";
        }

jethanandani's avatar
jethanandani committed
302
        leaf order {
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
          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.";
        }
jethanandani's avatar
jethanandani committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341

        leaf vnic-type {
	  type identityref {
	    base vnic-type;
	  }
	  description
	    "Describes the type of the virtual network interface
             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.";
        }
342
343
344
345
346
347
348
349
350
351
352
353
        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";
        }
354
      }
355
356
357
358
359
360
361
362
363
364

      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" {
        }
365
        description
366
367
          "Describes CPU, Memory and acceleration requirements of
           the Virtualisation Container realizing this VDU.";
368
        reference
369
370
371
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.2.2, VirtualComputeDesc
           information element.";
372
      }
373
374
375
376
377

      leaf-list virtual-storage-desc {
        type leafref {
          path "../../virtual-storage-desc/id";
        }
378
        description
379
380
381
          "Describes storage requirements for a VirtualStorage
           instance attached to the virtualisation container
           created from virtualComputeDesc defined for this VDU.";
382
        reference
383
384
385
          "GS NFV IFA011: Section 7.1.6.2, VDU information
           element, and Section 7.1.9.4, Information elements
           related to Virtual Storage.";
386
      }
387
388
389
390
391
392
393
394
395
396
397
398
399
400

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

        leaf key {
          type uint32;
        }

        leaf value {
          type leafref {
            path "../../virtual-storage-desc";
          }
        }
401
        description
402
403
404
405
406
407
408
409
          "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.";
410
        reference
411
412
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
413
      }
414
415
416
417
418

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
        }
419
        description
420
421
          "Describes the software image which is directly loaded on
           the virtualisation container realising this Vdu.";
422
        reference
423
424
          "GS NFV IFA011: Section 7.1.6.2, Vdu information
           element.";
425
      }
426
427

      leaf-list nfvi-constraint {
428
429
        type string;
        description
430
431
432
433
          "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.";
434
        reference
435
436
          "GS NFV IFA011: Section 7.1.6.2, VDU Information
           element.";
437
      }
438

439
      list monitoring-parameter {
440
441
442
443
        key "id";
        leaf id {
          type string;
          description
444
            "Unique identifier of the monitoring parameter.";
445
          reference
446
447
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
448
        }
449
450
451
452
453
454
        uses monitoring-parameter;
      }

      list configurable-properties {
        key "key";
        leaf key {
455
456
          type string;
        }
457
        leaf value {
458
459
          type string;
        }
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
        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;
502
          description
503
            "Identifies this set of logical node requirements.";
504
          reference
505
506
507
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
             Information elements.";
        }
508

509
510
        list requirement-detail {
          key "key";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
511

512
513
          leaf key {
            type string;
514
          }
515
516
517

          leaf value {
            type string;
518
          }
519
          description
520
521
522
523
524
525
526
527
528
529
            "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.";
530
          reference
531
            "GS NFV IFA011: Section 7.1.9.6, LogicalNodeRequirements
532
533
             information element.";
        }
534
535
536
537
538
539
        description
          "The logical node requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2, VirtualComputeDesc
           information element.";
      }
540

541
542
543
544
545
      list request-additional-capability {
        key "name";

        leaf name {
          type string;
546
          description
547
548
549
            "Identifies a requested additional capability for the
             VDU. ETSI GS NFV-IFA 002 [i.1] describes acceleration
             capabilities.";
550
          reference
551
552
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
553
        }
554

555
556
557
558
559
        leaf support-mandatory {
          type boolean;
          description
            "Indicates whether the requested additional capability
             is mandatory for successful operation.";
560
          reference
561
562
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information
563
             element.";
564
        }
565
566
567

        leaf min-version {
          type string;
568
          description
569
570
            "Identifies the minimum version of the requested
             additional capability.";
571
          reference
572
573
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
574
        }
575
576

        leaf preferred-version {
577
578
          type string;
          description
579
580
            "Identifies the preferred version of the requested
             additional capability.";
581
          reference
582
583
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
584
        }
585
586

        list target-performance-parameters {
587
          key "key";
588

589
590
591
          leaf key {
            type string;
          }
592

593
594
595
          leaf value {
            type string;
          }
596
          description
597
598
            "Identifies specific attributes, dependent on the
             requested additional capability type.";
599
          reference
600
601
            "GS NFV IFA011: Section 7.1.9.5,
             RequestedAdditionalCapabilityData Information element.";
602
603
        }
      }
604

605
606
      leaf compute-requirements {
        type string;
607
        description
608
609
610
611
612
          "Specifies compute requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.2.2, VirtualComputeDesc
           Information element.";
      }
613

614
615
616
617
618
      container virtual-memory {
        leaf size {
          type decimal64 {
            fraction-digits 1;
            range "0..max";
619
          }
620
621
622
623
624
625
626
627
          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.";
        }
628

629
630
        leaf over-subscription-policy {
          type string;
631
          description
632
633
634
635
            "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.";
636
          reference
637
638
            "GS NFV IFA011: Section 7.1.9.3, Information elements
             related to Virtual Memory.";
639
640
        }

641
642
        list vdu-mem-requirements {
          key "key";
643

644
          leaf key {
645
646
647
            type string;
          }

648
          leaf value {
649
650
            type string;
          }
651
652
653
654
655
656
          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.";
657
658
        }

659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
        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 {
685
686
          type string;
          description
687
688
689
            "CPU architecture type. Examples are x86, ARM. The
             cardinality can be 0 during the allocation request,
             if no particular CPU architecture type is requested.";
690
          reference
691
692
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
693
694
        }

695
696
697
        leaf num-virtual-cpu {
          type uint16 {
            range "1..max";
698
          }
699
700
701
702
703
704
705
          default 1;
          description
            "Number of virtual CPUs.";
          reference
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }
706

707
708
709
        leaf clock {
          type uint32;
          units "MHz";
710
          description
711
712
713
            "Minimum virtual CPU clock rate (e.g. in MHz). The
             cardinality can be 0 during the allocation request,
             if no particular value is requested.";
714
          reference
715
716
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
717
        }
718
719
720

        leaf oversubscription-policy {
          type string;
721
          description
722
723
724
725
            "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.";
726
          reference
727
728
729
730
731
732
            "GS NFV IFA011: Section 7.1.9.2.3, VirtualCpuData
             information elements.";
        }

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

734
          leaf key {
735
736
            type string;
          }
737
738

          leaf value {
739
            type string;
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
          }
          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";
            }
758
            description
759
760
761
762
763
764
765
766
              "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).";
767
            reference
768
769
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
770
          }
771
772
773

          list rule {
            when "../policy = 'static'";
774
            key "key";
775

776
777
778
779
780
781
782
            leaf key {
              type string;
            }
            leaf value {
              type string;
            }
            description
783
784
785
              "A list of rules that should be considered during the
               allocation of the virtual CPUs to logical CPUs in case
               of 'static' virtualCpuPinningPolicy.";
786
            reference
787
788
              "GS NFV IFA011: Section 7.1.9.2.4,
               VirtualCpuPinningData information element.";
789
          }
790
791
792
793
794
795
796
797
798
          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
Mahesh Jethanandani committed
799

800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
    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
        default root-storage;
        type identityref {
          base storage-type;
820
        }
821
822
823
824
825
826
        description
          "Type of virtualised storage resource (e.g. volume,
           object).";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
827
      }
828

829
830
831
832
      leaf size-of-storage {
        type uint64;
        units "GB";
        default 0;
833
        description
834
835
836
837
838
839
840
841
842
843
844
          "Size of virtualised storage resource (e.g. size of
           volume, in GB)";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

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

        leaf key {
845
846
847
          type string;
        }

848
849
        leaf value {
          type string;
850
        }
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
        description
          "Array of key-value pairs that articulate the storage
           deployment requirements.";
        reference
          "GS NFV IFA011: Section 7.1.9.4.2, VirtualStorageDesc
           information element.";
      }

      leaf rdma-enabled {
        type boolean;
        description
          "Indicate if the storage support RDMA.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
      }

      leaf sw-image-desc {
        type leafref {
          path "../../sw-image-desc/id";
871
        }
872
873
        must "../size-of-storage >=" +
          "../../sw-image-desc[id=current()]/min-disk" {
874
        }
875
876
877
878
879
880
        description
          "Software image to be loaded on the VirtualStorage
           resource created based on this VirtualStorageDesc.";
        reference
          "GS NFV IFA011: Section 7.1.9.4, Information elements
           related to Virtual Storage.";
881
      }
882
    }
883

884
885
886
887
888
889
890
891
892
893
    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;
894
        description
895
          "The identifier of this software image.";
896
        reference
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
          "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.";
      }

921
922
923
924
925
926
927
928
929
930
931
      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.";
      }

932
933
934
      container checksum {

        leaf algorithm {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
935
          mandatory true;
936
937
938
          type identityref {
            base checksum-algorithm;
          }
939
          description
940
941
            "Species the algorithm used to obtain the checksum
             value.";
942
          reference
943
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
944
945
             information element.";
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
946

947
948
        leaf hash {
          mandatory true;
949
950
          type string;
          description
951
952
953
            "Contains the result of applying the algorithm
             indicated by the algorithm attribute to the data to
             which this ChecksumData refers.";
954
          reference
955
            "GS NFV IFA011: Section 7.1.6.10 ChecksumData
956
957
             information element.";
        }
958
959
960
961
962
963
        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
964

965
966
967
968
      leaf container-format {
        default "bare";
        type enumeration {
          enum "aki" {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
969
            description
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
              "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.";
996
997
          }
        }
998
999
1000
1001
1002
1003
1004
        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
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
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
      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.";
1058
1059
          }
        }
1060
1061
1062
1063
        description
          "The disk format of a software image is the format of
           the underlying disk image.";
      }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1064

1065
1066
        leaf min-disk {
          type uint64;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1067
          units "GB";
1068
          mandatory true;
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
          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
1079

1080
1081
1082
1083
      leaf min-ram {
        type decimal64 {
          fraction-digits 1;
          range "0..max";
1084
        }
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
        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
1097

1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
      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
1108

1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
      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
1120

1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
      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
1131

1132
1133
1134
1135
1136
1137
1138
1139
1140
      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.";
1141
      }
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
    }

    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.";
1152

1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
      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 {
1163
1164
        key "id";
        description
1165
1166
          "Describes a specific flavour of the VL with specific
             bitrate requirements.";
1167
        reference
1168
1169
1170
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           Information elements.";

1171
1172
1173
        leaf id {
          type string;
          description
1174
            "Identifies a flavour within a VnfVirtualLinkDesc.";
1175
          reference
1176
1177
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1178
1179
        }

1180
1181
        container qos {
          presence "VL QoS parameters";
1182
          description
1183
            "QoS of the VL.";
1184
          reference
1185
1186
            "GS NFV IFA011: Section 7.1.8.5, VirtualLinkDescFlavour
             information element.";
1187

1188
1189
1190
1191
          leaf latency {
            type uint32;
            units "ms";
            mandatory true;
1192
            description
1193
              "Specifies the maximum latency in ms.";
1194
            reference
1195
1196
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1197
          }
1198
1199
1200
1201
1202

          leaf packet-delay-variation {
            type uint32;
            units "ms";
            mandatory true;
1203
            description
1204
              "Specifies the maximum jitter in ms.";
1205
            reference
1206
1207
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1208
          }
1209

1210
1211
1212
1213
1214
          leaf packet-loss-ratio {
            type decimal64 {
              fraction-digits "2";
              range "0..1.00";
            }
1215
            description
1216
1217
1218
1219
              "Specifies the maximum packet loss ratio.";
            reference
              "GS NFV IFA011: Section 7.1.8.10, QoS information
               element.";
1220
1221
1222
          }
        }
      }
1223

1224
      uses connectivity-type;
1225

1226
1227
      leaf-list test-access {
        type string;
1228
        description
1229
1230
1231
          "Specifies test access facilities expected on the VL
           (e.g. none, passive monitoring, or active (intrusive)
           loopbacks at endpoints.";
1232
        reference
1233
1234
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
1235
1236
      }

1237
1238
      leaf description {
        type string;
1239
        description
1240
1241
          "Provides human-readable information on the purpose of
           the VL (e.g. control plane traffic).";
1242
        reference
1243
1244
1245
1246
1247
1248
1249
          "GS NFV IFA011: Section 7.1.7.2, VnfVirtualLinkDesc
           information element.";
      }

      list monitoring-parameters {
        key "id";

1250
1251
1252
        leaf id {
          type string;
          description
1253
            "Unique identifier of the monitoring parameter.";
1254
          reference
1255
1256
            "GS NFV IFA011: Section 7.1.11.3, MonitoringParameter
             information element.";
1257
        }
1258
1259
1260
        uses monitoring-parameter;
      }
    }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1261

1262
    uses security-group-rule;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1263

1264
1265
1266
    list ext-cpd {
      key "id";
      min-elements 1;
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1267

1268
1269
1270
1271
1272
      description
        "Describes an external interface exposed by this VNF enabling
         connection with a Virual Link";
      reference
        "GS NFV IFA011: Section 7.1.2, VNFD information element.";
1273

1274
1275
1276
1277
1278
1279
1280
1281
      choice cp-connection {
        leaf int-virtual-link-desc {
          description
            "Reference to the internal Virtual Link Descriptor (VLD)
             to which CPs instantiated from this external CP
             Descriptor (CPD) connect. Either intVirtualLinkDesc or
             intCpd shall be present.";
          type leafref {
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1282
            path "/nfv:nfv/nfv:vnfd/nfv:int-virtual-link-desc/nfv:id";
1283
          }
1284
        }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1285

1286
1287
        container int-cpd {
          leaf vdu-id {
1288
            type leafref {
1289
              path "../../../vdu/id";
1290
1291
            }
          }
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1292

1293
1294
1295
          leaf cpd {
            type leafref {
              path "deref(../vdu-id)/../int-cpd/id";
Mahesh Jethanandani's avatar
Mahesh Jethanandani committed
1296
1297
            }
          }
1298
        }
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313

        leaf vip-cpd