blob: 31c865539994a0958534fc1bde79c0d788bd7591 [file] [log] [blame]
tierno7edb6752016-03-21 17:37:52 +01001---
2vnf:
3 name: TEMPLATE
4 description: This is a template to help in the creation of your own VNFs
5 # class: parent # Optional. Used to organize VNFs
6 external-connections:
7 - name: mgmt0
8 type: mgmt # "mgmt" (autoconnect to management net), "bridge", "data"
9 VNFC: TEMPLATE-VM # Virtual Machine this interface belongs to
10 local_iface_name: mgmt0 # interface name inside this Virtual Machine (must be defined in the VNFC section)
11 description: Management interface
12 - name: xe0
13 type: data
14 VNFC: TEMPLATE-VM
15 local_iface_name: xe0
16 description: Data interface 1
17 - name: xe1
18 type: data
19 VNFC: TEMPLATE-VM
20 local_iface_name: xe1
21 description: Data interface 2
22 - name: ge0
23 type: bridge
24 VNFC: TEMPLATE-VM
25 local_iface_name: ge0
26 description: Bridge interface
27 VNFC: # Virtual machine array
28 - name: TEMPLATE-VM # name of Virtual Machine
29 description: TEMPLATE description
30 VNFC image: /path/to/imagefolder/TEMPLATE-VM.qcow2
31 # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" } #Optional
32 # processor: #Optional
33 # model: Intel(R) Xeon(R) CPU E5-4620 0 @ 2.20GHz
34 # features: ["64b", "iommu", "lps", "tlbps", "hwsv", "dioc", "ht"]
35 # hypervisor: #Optional
36 # type: QEMU-kvm
37 # version: "10002|12001|2.6.32-358.el6.x86_64"
38 # vcpus: 1 # Only for traditional cloud VMs. Number of virtual CPUs (oversubscription is allowed).
39 # ram: 1024 # Only for traditional cloud VMs. Memory in MBytes (not from hugepages, oversubscription is allowed)
40 # disk: 10 # disk size in GiB, by default 1
41 numas:
42 - paired-threads: 5 # "cores", "paired-threads", "threads"
43 paired-threads-id: [ [0,1], [2,3], [4,5], [6,7], [8,9] ] # By default follows incremental order
44 memory: 14 # GBytes
45 interfaces:
46 - name: xe0
47 vpci: "0000:00:11.0"
48 dedicated: "yes" # "yes"(passthrough), "no"(sriov with vlan tags), "yes:sriov"(sriovi, but exclusive and without vlan tag)
49 bandwidth: 10 Gbps
50 # mac_address: '20:33:45:56:77:44' #avoid this option if possible
51 - name: xe1
52 vpci: "0000:00:12.0"
53 dedicated: "yes"
54 bandwidth: 10 Gbps
55 # mac_address: '20:33:45:56:77:45' #avoid this option if possible
56 bridge-ifaces:
57 - name: mgmt0
58 vpci: "0000:00:09.0" # Optional. Virtual PCI address
59 bandwidth: 1 Mbps # Optional. Informative only
60 # mac_address: '20:33:45:56:77:46' #avoid this option if possible
61 # model: 'virtio' # ("virtio","e1000","ne2k_pci","pcnet","rtl8139") By default, it is automatically filled by libvirt
62 - name: ge0
63 vpci: "0000:00:10.0"
64 bandwidth: 1 Mbps
65 # mac_address: '20:33:45:56:77:47' #avoid this option if possible
66 # model: 'virtio' # ("virtio","e1000","ne2k_pci","pcnet","rtl8139") By default, it is automatically filled by libvirt
67 devices: # Optional, order determines device letter asignation (hda, hdb, ...)
68 - type: disk # "disk","cdrom","xml"
69 image: /path/to/imagefolder/SECOND-DISK.qcow2
70 # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" }
71 # vpci: "0000:00:03.0" # Optional, not for disk or cdrom
72 - type: cdrom
73 image: /path/to/imagefolder/CDROM-IMAGE.qcow2
74 # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" }
75 - type: xml
76 image: /path/to/imagefolder/ADDITIONAL-DISK.qcow2 # Optional, depending on the device type
77 image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" } # Optional, depending on the device type
78 vpci: "0000:00:03.0" # Optional, depending on the device type (not needed for disk or cdrom)
79 xml: ' xml text for XML described devices. Do not use single quotes inside
80 The following words, if found, will be replaced:
81 __file__ by image path, (image must be provided)
82 __format__ by qcow2 or raw (image must be provided)
83 __dev__ by device letter (b, c, d ...)
84 __vpci__ by vpci (vpci must be provided)
85 '
86 # Additional Virtual Machines would be included here
87