-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathvnfd-schema.yml
1051 lines (1039 loc) · 36.9 KB
/
vnfd-schema.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
198
199
200
201
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
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
299
300
301
302
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
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
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
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
996
997
998
999
1000
## Copyright (c) 2015 SONATA-NFV, 2017 5GTANGO
## ALL RIGHTS RESERVED.
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## http://www.apache.org/licenses/LICENSE-2.0
##
## Unless required by applicable law or agreed to in writing, software
## distributed under the License is distributed on an "AS IS" BASIS,
## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
## See the License for the specific language governing permissions and
## limitations under the License.
##
## Neither the name of the SONATA-NFV, 5GTANGO
## nor the names of its contributors may be used to endorse or promote
## products derived from this software without specific prior written
## permission.
##
## This work has been performed in the framework of the SONATA project,
## funded by the European Commission under Grant number 671517 through
## the Horizon 2020 and 5G-PPP programmes. The authors would like to
## acknowledge the contributions of their colleagues of the SONATA
## partner consortium (www.sonata-nfv.eu).
##
## This work has been performed in the framework of the 5GTANGO project,
## funded by the European Commission under Grant number 761493 through
## the Horizon 2020 and 5G-PPP programmes. The authors would like to
## acknowledge the contributions of their colleagues of the 5GTANGO
## partner consortium (www.5gtango.eu).
---
$schema: "http://json-schema.org/draft-04/schema#"
title: "Virtual Network Function Descriptor Schema"
version: 0.9
description: "The core schema for SONATA network function descriptors."
##
## Some definitions used later on.
##
definitions:
general_units:
enum:
- "Percentage"
- "Binary"
- "Other"
time_units:
enum:
- "ns" # nano seconds
- "ms" # milli seconds
- "s" # seconds
- "m" # minutes
- "h" # hours
- "d" # days
memory_units:
enum:
- "B" # Byte
- "kB" # Kilobyte
- "KiB" # Kibityte
- "MB" # Megabyte
- "MiB" # Mebibyte
- "GB" # Gigabyte
- "GiB" # Gibibyte
- "TB" # Terabyte
- "TiB" # Tebibyte
- "PT" # Petabyte
- "PiT" # Pebibyte
bandwidth_units:
enum:
- "bps" # Bit per second
- "kbps" # Kilobit per second
- "Mbps" # Megabit per second
- "Gbps" # Gigabit per second
- "Tbps" # Terabit per second
frequency_units:
enum:
- "Hz" # Hertz, 1/sec
- "kHz" # Kilohertz
- "MHz" # Megahertz
- "GHz" # Gigahertz
- "THz" # Terahertz
images_formats:
enum:
- "raw"
- "vhd"
- "vmdk"
- "vdi"
- "iso"
- "qcow2"
- "docker"
- "ova"
- "ovf"
- "bare"
connection_point_types:
enum:
- "internal"
- "external"
- "management"
- "serviceendpoint"
interfaces:
enum:
- "ethernet"
- "ipv4"
- "ipv6"
# single connection point definition reused in VDUs, CDUs, and PDUs (avoid redundant, copy&paste code)
# VDUs, PDUs, VNFs: id, interface, type
# CDUs: id, port
connection_points:
description: "The connection points of a VDU, CDU, PDU or complete VNF. Connects it to other units or the external world."
type: "array"
items:
type: "object"
properties:
# id is the only required attribute
id:
description: "A VNF-unique id of the connection point. Can be used for references."
type: "string"
mac:
description: "MAC address of the connection point"
type: "string"
ip:
description: "IP address of the connection point"
type: "string"
port:
description: "For CUDs only: Port of the container's connection point."
type: "integer"
ports: # see: https://github.com/containernet/containernet/wiki/Exposing-and-mapping-network-ports
description: "For CUDs only: List of ports"
type: "array"
publish: # see: https://github.com/containernet/containernet/wiki/Exposing-and-mapping-network-ports
description: "For CUDs only: Directly publish a port of a CDU, e.g., for debugging."
type: "object"
interface:
description: "The type of connection point, such as a virtual port, a virtual NIC address, a physical port, a physcial NIC address, or the endpoint of a VPN tunnel."
$ref: "#/definitions/interfaces"
type:
description: "The type of the connection point with respect to its visibility in the service platform"
$ref: "#/definitions/connection_point_types"
# TODO: Remove? Cyclic reference with virtual_links?
virtual_link_reference:
description: "A reference to a virtual link, i.e. the virtual_links:id."
type: "string"
security_groups:
description: "List of security groups assigned to the connection point"
type: "array"
items:
type: "string"
# QoS requirements: either policy name or explicit requirements
qos:
description: "Name of a pre-defined QoS policy"
type: "string"
qos_requirements:
description: "Explicit QoS requirements supported by OpenStack"
type: "object"
properties:
# currently three supported QoS requirements
bandwidth_limit:
description: "Bandwidth limitations on networks, ports or floating IPs"
type: "object"
properties:
bandwidth:
type: "number"
bandwidth_unit:
$ref: "#/definitions/bandwidth_units"
additionalProperties: false
minimum_bandwidth:
description: "Minimum bandwidth constraints on certain types of traffic"
type: "object"
properties:
bandwidth:
type: "number"
bandwidth_unit:
$ref: "#/definitions/bandwidth_units"
additionalProperties: false
dscp_marking:
description: "Marking network traffic with a DSCP value"
type: "string"
additionalProperties: false
required:
- id
minItems: 0
uniqueItems: true
additionalProperties: false
monitoring:
type: "object"
properties:
name:
description: "The name of the parameter to monitor. The name has to be supported by the service platform or the FSM."
type: "string"
#pattern: "^[A-Za-z-_]+$"
unit:
description: "The unit used to monitor (or represent) the parameter."
oneOf:
- $ref: "#/definitions/general_units"
- $ref: "#/definitions/memory_units"
- $ref: "#/definitions/bandwidth_units"
- $ref: "#/definitions/frequency_units"
frequency:
description: "The sample rate of the monitoring parameter."
type: "number"
minimum: 0
exclusiveMinimum: true
frequency_unit:
description: "The unit of the sample frequency."
$ref: "#/definitions/frequency_units"
default: "Hz"
command:
description: "A command that is executed in order to perform custom monitoring."
type: "string"
required:
- name
- unit
additionalProperties: false
virtual_deployment_units:
description: "The virtual deployment units (VDUs) of the virtual network function."
type: "array"
items:
type: "object"
properties:
description:
description: "An arbitrary description of the VDU:"
type: "string"
id:
description: "A unique identifier of this VDU within the scope of this VNF descriptor."
type: "string"
# required default image
vm_image:
description: "The reference to a virtual machine image."
type: "string"
vm_image_format:
description: "The format of the virtual machine image."
$ref: "#/definitions/images_formats"
vm_image_md5:
description: "An MD5 hash of the virtual machine image."
type: "string"
pattern: "^[A-Fa-f0-9]{32}$"
vm_flavor:
description: "Predefined flavor of the VM (e.g., EC2 instance instead of resource_requirements"
type: "string"
# optional alternative images for x86, ARM, etc
alternative_images:
description: "Alternative images for other architectures"
type: "array"
items:
type: "object"
properties:
vm_image:
description: "The reference to a virtual machine image."
type: "string"
vm_image_format:
description: "The format of the virtual machine image."
$ref: "#/definitions/images_formats"
vm_image_md5:
description: "An MD5 hash of the virtual machine image."
type: "string"
pattern: "^[A-Fa-f0-9]{32}$"
vm_image_arch:
description: "Target architecture for this image"
type: "string"
required:
- vm_image
- vm_image_format
- vm_image_arch
additionalProperties: false
uniqueItems: true
snmp_parameters:
description: "Definition of SNMP parameters available from the VDU"
type: "object"
properties:
version:
description: "SNMP version to be used."
type: "string"
auth_protocol:
description: "Authentication protocol to be used when requesting SNMP data."
type: "string"
security_level:
description: "Security level."
type: "string"
username:
description: "SNMP username."
type: "string"
port:
description: "SNMP port."
type: "integer"
interval:
description: "Time interval between SNMP requests."
type: "integer"
oids:
description: "List of oids."
type: "array"
items:
type: "object"
properties:
oid:
description: "metric oid."
type: "string"
metric_name:
description: "metric name."
type: "string"
metric_type:
description: "metric type."
type: "string"
unit:
description: "metric unit."
type: "string"
mib_name:
description: "metric mib name."
type: "string"
required:
- oid
- metric_name
- metric_type
- unit
- mib_name
required:
- version
- interval
- oids
resource_requirements:
description: "The requirments of a (virtual) machine that hosts this VDU. The service platform has to provide machines that meet these requirements."
type: "object"
properties:
hypervisor_parameters:
description: "The requirements and parameters of a (potential) hyperviser that operates the VDU VM."
type: "object"
properties:
type:
description: "The type of hypervisor needed for this VDU."
type: "string"
version:
description: "The version of the hypervisor needed for this VDU."
type: "string"
pattern: "^(== |>= |<= |!= )?[0-9\\-_.]+$"
vswitch_capabilities:
type: "object"
properties:
version:
description: "The version of vswitch to use."
type: "string"
pattern: "^(== |>= |<= |!= )?[0-9\\-_.]+$"
type:
description: "The type of vswitch to use."
type: "string"
overlay_tunnel:
type: "string"
cpu:
description: "All the requirements and parameters related to the (virtual) CPU."
type: "object"
properties:
vcpus:
description: "The number of (virtualized) CPU cores."
type: "integer"
minimum: 0
exclusiveMinimum: true
cpu_support_accelerator:
type: "string"
required:
- vcpus
memory:
type: "object"
properties:
size:
description: "The size of the memory for this VDU."
type: "number"
minimum: 0
exclusiveMinimum: true
size_unit:
description: "The unit the host memory is measured in. Default is MB (Megabyte)."
$ref: "#/definitions/memory_units"
default: "MB"
large_pages_required:
description: "States whether large memory pages are required or not."
type: "boolean"
numa_allocation_policy:
description: "Names the NUMA allocaton policy."
type: "string"
required:
- size
additionalProperties: false
storage:
# TODO: This has to be an array! There can be more than one storage entity.
type: "object"
properties:
size:
description: "The size of the storage for this VDU."
type: "number"
minimum: 0
exclusiveMinimum: true
size_unit:
description: "The unit the host storage is measured in. Default is MB (Megabyte)."
$ref: "#/definitions/memory_units"
default: "MB"
persistence:
description: "States whether this is persistent storage or not."
type: "boolean"
required:
- size
additionalProperties: false
network:
# TODO: This has to be an array! There can be more than one network interface.
type: "object"
properties:
network_interface_bandwidth:
description: "The size of the bandwidth for this VDU."
type: "number"
minimum: 0
exclusiveMinimum: true
network_interface_bandwidth_unit:
description: "The unit of the network interface bandwidth. Default is bps (bit per second)."
$ref: "#/definitions/bandwidth_units"
network_interface_card_capabilities:
description: "Additional NIC capabilities:"
type: "object"
properties:
SR-IOV:
description: "States whether this VDU requires Single Root I/O Virtualization on this NIC."
type: "boolean"
mirroring:
description: "States whether the traffic is mirrored or not."
type: "boolean"
data_processing_acceleration_library:
description: "The name of the data processing acceleration library."
type: "string"
pcie:
# TODO: This has to be an array! There can be more than one PCI entity.
description: "The PCIe parameters of the platform."
type: "object"
properties:
SR-IOV:
description: "States whether this VDU requires Single Root I/O Virtualization on this PCI entity."
type: "boolean"
device_pass_through:
description: "States whether this PCI entity MUST support PCI pass through."
type: "boolean"
required:
- cpu
- memory
additionalProperties: false
connection_points:
$ref: "#/definitions/connection_points"
monitoring_parameters:
description: "The various metrics and parameters to monitor."
type: "array"
items:
description: "A specific monitoring metric or parameter."
$ref: "#/definitions/monitoring"
scale_in_out:
description: "The scale-in/scale-out parameters."
type: "object"
properties:
minimum:
description: "The minimum number of VDUs instantiated at any time."
type: "integer"
minimum: 0
default: 1
maximum:
description: "The maximum number of VDUs instantiated at any time. 0 means unlimited."
type: "integer"
minimum: 0
default: 1
additionalProperties: false
user_data:
description: "A script that configures the VDU during boot time."
type: "string"
required:
- id
- resource_requirements
additionalProperties: false
minItems: 1
uniqueItems: true
cloudnative_deployment_units:
description: "The cloud native deployment units (CNDUs) of the virtual network function."
type: "array"
items:
type: "object"
properties:
description:
description: "An arbitrary description of the CNDU:"
type: "string"
id:
description: "A unique identifier of this CNDU within the scope of this VNF descriptor."
type: "string"
image:
description: "The container image of this CNDU."
type: "string"
snmp_parameters:
description: "Definition of SNMP parameters available from the VDU"
type: "object"
properties:
version:
description: "SNMP version to be used."
type: "string"
auth_protocol:
description: "Authentication protocol to be used when requesting SNMP data."
type: "string"
security_level:
description: "Security level."
type: "string"
username:
description: "SNMP username."
type: "string"
port:
description: "SNMP port."
type: "integer"
interval:
description: "Time interval between SNMP requests."
type: "integer"
oids:
description: "List of oids."
type: "array"
items:
type: "object"
properties:
oid:
description: "metric oid."
type: "string"
metric_name:
description: "metric name."
type: "string"
metric_type:
description: "metric type."
type: "string"
unit:
description: "metric unit."
type: "string"
mib_name:
description: "metric mib name."
type: "string"
required:
- oid
- metric_name
- metric_type
- unit
- mib_name
required:
- version
- interval
- oids
resource_requirements:
description: "The requirments of a (virtual) machine that hosts this VDU. The service platform has to provide machines that meet these requirements."
type: "object"
properties:
cpu:
description: "All the requirements and parameters related to the (virtual) CPU."
type: "object"
properties:
vcpus:
description: "The number of (virtualized) CPU cores."
type: "integer"
minimum: 0
exclusiveMinimum: true
cpu_support_accelerator:
type: "string"
required:
- vcpus
gpu:
description: "All the requirements and parameters related to the (virtual) CPU."
type: "object"
properties:
amd:
description: "The number of amd GPU cores."
type: "integer"
minimum: 0
exclusiveMinimum: true
nvidia:
description: "The number of nvidia GPU cores."
type: "integer"
minimum: 0
exclusiveMinimum: true
memory:
type: "object"
properties:
size:
description: "The size of the memory for this CDU."
type: "number"
minimum: 0
exclusiveMinimum: true
size_unit:
description: "The unit the host memory is measured in. Default is MB (Megabyte)."
$ref: "#/definitions/memory_units"
default: "MB"
large_pages_required:
description: "States whether large memory pages are required or not."
type: "boolean"
required:
- size
additionalProperties: false
storage:
# TODO: This has to be an array! There can be more than one storage entity.
type: "object"
properties:
size:
description: "The size of the storage for this CDU."
type: "number"
minimum: 0
exclusiveMinimum: true
size_unit:
description: "The unit the host storage is measured in. Default is MB (Megabyte)."
$ref: "#/definitions/memory_units"
default: "MB"
persistence:
description: "States whether this is persistent storage or not."
type: "boolean"
required:
- size
additionalProperties: false
network:
# TODO: This has to be an array! There can be more than one network interface.
type: "object"
properties:
network_interface_bandwidth:
description: "The size of the bandwidth for this CDU."
type: "number"
minimum: 0
exclusiveMinimum: true
network_interface_bandwidth_unit:
description: "The unit of the network interface bandwidth. Default is bps (bit per second)."
$ref: "#/definitions/bandwidth_units"
pcie:
# TODO: This has to be an array! There can be more than one PCI entity.
description: "The PCIe parameters of the platform."
type: "object"
properties:
SR-IOV:
description: "States whether this CDU requires Single Root I/O Virtualization on this PCI entity."
type: "boolean"
additionalProperties: false
connection_points:
$ref: "#/definitions/connection_points"
monitoring_parameters:
description: "The various metrics and parameters to monitor."
type: "array"
items:
description: "A specific monitoring metric or parameter."
$ref: "#/definitions/monitoring"
parameters:
description: "Additional CNDU parameter dictionaries."
type: "object"
properties:
env:
description: "Dictionary of key/values of environment variables for CNFs."
type: "object"
k8s_deployment:
description: "Dictionary of key/values forwarded to K8s."
type: "object"
k8s_service:
description: "Dictionary of key/values forwarded to K8s."
type: "object"
additionalProperties: true # allow flexability here
required:
- id
- image
additionalProperties: false
minItems: 1
uniqueItems: false
physical_deployment_units:
description: "The pythical deployment units (PDUs) of the physical network function."
type: "array"
items:
type: "object"
properties:
id:
description: "A unique identifier of this PDU within the scope of this VNF descriptor."
type: "string"
vendor:
description: "The vendor of this PDU."
type: "string"
version:
description: "The version of this PDU."
type: "string"
description:
description: "An arbitrary description of the PDU"
type: "string"
address:
description: "The address to reach the PDU (eg, IP address)"
type: "string"
port:
description: "The PDU's port number"
type: "number"
geo_location:
description: "The geographical location of the PDU. Either descriptive or as GPS coordinates"
type: "string"
performance:
description: "Specification of the possible performance with this PDU"
type: "array"
items:
type: "object"
properties:
throughput:
type: "object"
description: "An example performance item with a value and a unit. There might be more"
properties:
value:
type: "number"
unit:
type: "string"
additionalProperties: true
connection_points:
$ref: "#/definitions/connection_points"
required:
- id
- address
- port
additionalProperties: false
minItems: 1
uniqueItems: false
virtual_links:
description: "VNF internal virtual link. A link interconnects at least two connection points."
type: "array"
items:
type: "object"
properties:
id:
description: "A VNF-unique id of the virtual link. Can be used for references."
type: "string"
connectivity_type:
description: "The connectivity type, such as point-to-point, point-to-multipoint, and multipoint-to-multipoint."
enum:
- "E-Line" # Point-to-point
- "E-Tree" # Point-to-multipoint
- "E-LAN" # Multipoint-to-multipoint
connection_points_reference:
description: "The references to the connection points connected to this virtual link."
type: "array"
items:
type: "string"
minItems: 2
uniqueItems: true
access:
type: "boolean"
external_access:
type: "boolean"
root_requirement:
type: "string"
leaf_requirement:
type: "string"
dhcp:
type: "boolean"
cidr:
type: "string"
# QoS requirements: either policy name or explicit requirements. If specified at a vLink, the QoS req. will be applied to all corresponding connection points.
qos:
description: "Name of a pre-defined QoS policy"
type: "string"
qos_requirements:
description: "Explicit QoS requirements supported by OpenStack"
type: "object"
properties:
# currently three supported QoS requirements
bandwidth_limit:
description: "Bandwidth limitations on networks, ports or floating IPs"
type: "object"
properties:
bandwidth:
type: "number"
bandwidth_unit:
$ref: "#/definitions/bandwidth_units"
additionalProperties: false
minimum_bandwidth:
description: "Minimum bandwidth constraints on certain types of traffic"
type: "object"
properties:
bandwidth:
type: "number"
bandwidth_unit:
$ref: "#/definitions/bandwidth_units"
additionalProperties: false
dscp_marking:
description: "Marking network traffic with a DSCP value"
type: "string"
additionalProperties: false
required:
- id
- connectivity_type
- connection_points_reference
additionalProperties: false
##
## The actual document description.
##
type: "object"
properties:
descriptor_schema:
description: "Reference to the schema corresponding to the descriptor (e.g., URL or local path)."
type: "string"
vendor:
description: "The vendor id allows to identify a VNF descriptor uniquely across all function descriptor vendors."
type: "string"
pattern: "^[a-z0-9\\-_.]+$"
name:
description: "The name of the function description."
type: "string"
pattern: "^[a-z0-9\\-_.]+$"
version:
description: "The version of the function descriptor."
type: "string"
pattern: "^[0-9\\-_.]+$"
author:
description: "The person or organization that created the VNF descriptor."
type: "string"
description:
description: "A longer description of the network function."
type: "string"
logo:
description: "Path to VNF logo."
type: "string"
pattern: "^[A-Za-z0-9\\-_./]+$"
licenses:
description: "Information on the license of this VNFD."
type: "array"
items:
anyOf:
- type: "object"
properties:
type:
description: "The type of license, 'public' in this case."
type: "string"
enum:
- "public"
required:
- "type"
additionalProperties: false
- type: "object"
properties:
type:
description: "The type of license, 'private' in this case."
type: "string"
enum:
- "private"
url:
description: "The URL to the license file."
type: "string"
required:
- "type"
- "url"
additionalProperties: false
additionalItems: false
uniqueItems: true
function_specific_managers:
description: "A list of FSMs used to manage this VNF."
type: "array"
items:
description: "An FSM object of this VNF. FSMs are always Docker containers."
type: "object"
properties:
description:
description: "An arbitrary description of the FSM."
type: "string"
id:
description: "A unique identifier of this FSM within the scope of this VNF descriptor."
type: "string"
image:
description: "The reference to a Docker image."
type: "string"
image_md5:
description: "An MD5 hash of the Docker image."
type: "string"
pattern: "^[A-Fa-f0-9]{32}$"
resource_requirements:
description: "The requirements for the Docker environment that runs the FSM."
type: "object"
properties:
docker_version:
description: "The version of Docker needed for this FSM."
type: "string"
pattern: "^(== |>= |<= |!= )?[0-9\\-_.]+$"
options:
description: "The options as key-value parameters that are passed to the Docker container. Can be used to configure the Docker."
type: "array"
items:
description: "A key-value parameter object."
type: "object"
properties:
key:
type: "string"
value:
type: "string"
required:
- key
- value
additionalProperties: false
uniqueItems: true
required:
- id
- image
additionalProperties: false
uniqueItems: true
minItems: 0
virtual_deployment_units:
$ref: "#/definitions/virtual_deployment_units"
cloudnative_deployment_units:
$ref: "#/definitions/cloudnative_deployment_units"
physical_deployment_units:
$ref: "#/definitions/physical_deployment_units"
connection_points:
$ref: "#/definitions/connection_points"
virtual_links:
$ref: "#/definitions/virtual_links"
deployment_flavours:
description: "The flavours of the VNF that can be deployed. Adjusted copies of fields above."
type: "array"
items:
type: "object"
properties:
virtual_deployment_units:
$ref: "#/definitions/virtual_deployment_units"
cloudnative_deployment_units:
$ref: "#/definitions/cloudnative_deployment_units"
physical_deployment_units:
$ref: "#/definitions/physical_deployment_units"
connection_points:
$ref: "#/definitions/connection_points"
virtual_links:
$ref: "#/definitions/virtual_links"
additionalProperties: true
lifecycle_events:
type: "array"
items:
type: "object"
properties:
authentication_username:
type: "string"
driver:
type: "string"
authentication_type:
type: "string"
authentication:
type: "string"
vnf_container:
type: "string"
events:
type: "object"
properties:
start:
type: "object"
properties:
command:
type: "string"
template_file_format:
type: "string"
template_file:
type: "string"
additionalProperties: false
stop:
type: "object"
properties:
command:
type: "string"
template_file:
type: "string"
template_file_format:
type: "string"
additionalProperties: false
restart:
type: "object"
properties:
command:
type: "string"
template_file:
type: "string"
template_file_format:
type: "string"
additionalProperties: false
scale-in:
type: "object"
properties:
command:
type: "string"
template_file:
type: "string"
template_file_format:
type: "string"
additionalProperties: false
scale-out:
type: "object"
properties:
command:
type: "string"
template_file:
type: "string"
template_file_format:
type: "string"
additionalProperties: false
additionalProperties: false
flavor_id_ref:
type: "string"
additionalProperties: false
monitoring_rules:
type: "array"
items: