vnfs/vnf-template.yaml

   1 ##\r
   2 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.\r
   3 # This file is part of openmano\r
   4 # All Rights Reserved.\r
   5 #\r
   6 # Licensed under the Apache License, Version 2.0 (the "License"); you may\r
   7 # not use this file except in compliance with the License. You may obtain\r
   8 # a copy of the License at\r
   9 #\r
  10 #         http://www.apache.org/licenses/LICENSE-2.0\r
  11 #\r
  12 # Unless required by applicable law or agreed to in writing, software\r
  13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\r
  15 # License for the specific language governing permissions and limitations\r
  16 # under the License.\r
  17 #\r
  18 # For those usages not covered by the Apache License, Version 2.0 please\r
  19 # contact with: nfvlabs@tid.es\r
  20 ##\r
  21 ---\r
  22 vnf:\r
  23     name: TEMPLATE\r
  24     description: This is a template to help in the creation of your own VNFs\r
  25     # class: parent      # Optional. Used to organize VNFs\r
  26     external-connections:\r
  27     -   name:              mgmt0\r
  28         type:              mgmt        # "mgmt" (autoconnect to management net), "bridge", "data"\r
  29         VNFC:              TEMPLATE-VM # Virtual Machine this interface belongs to\r
  30         local_iface_name:  mgmt0       # interface name inside this Virtual Machine (must be defined in the VNFC section)\r
  31         description:       Management interface\r
  32     -   name:              xe0\r
  33         type:              data\r
  34         VNFC:              TEMPLATE-VM\r
  35         local_iface_name:  xe0\r
  36         description:       Data interface 1\r
  37     -   name:              xe1\r
  38         type:              data\r
  39         VNFC:              TEMPLATE-VM\r
  40         local_iface_name:  xe1\r
  41         description:       Data interface 2\r
  42     -   name:              ge0\r
  43         type:              bridge\r
  44         VNFC:              TEMPLATE-VM\r
  45         local_iface_name:  ge0\r
  46         description:       Bridge interface\r
  47     VNFC:                              # Virtual machine array \r
  48     -   name:        TEMPLATE-VM       # name of Virtual Machine\r
  49         description: TEMPLATE description\r
  50         VNFC image: /path/to/imagefolder/TEMPLATE-VM.qcow2\r
  51         # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" } #Optional\r
  52         # processor:                     #Optional\r
  53         #     model: Intel(R) Xeon(R) CPU E5-4620 0 @ 2.20GHz\r
  54         #     features: ["64b", "iommu", "lps", "tlbps", "hwsv", "dioc", "ht"]\r
  55         # hypervisor:                    #Optional\r
  56         #     type: QEMU-kvm\r
  57         #     version: "10002|12001|2.6.32-358.el6.x86_64"\r
  58         # vcpus: 1          # Only for traditional cloud VMs. Number of virtual CPUs (oversubscription is allowed).\r
  59         # ram: 1024         # Only for traditional cloud VMs. Memory in MBytes (not from hugepages, oversubscription is allowed)\r
  60         # disk: 10          # disk size in GiB, by default 1\r
  61         numas: \r
  62         -   paired-threads: 5          # "cores", "paired-threads", "threads"\r
  63             paired-threads-id: [ [0,1], [2,3], [4,5], [6,7], [8,9] ] # By default follows incremental order\r
  64             memory: 14                 # GBytes\r
  65             interfaces:\r
  66             -   name:      xe0\r
  67                 vpci:      "0000:00:11.0"     \r
  68                 dedicated: "yes"         # "yes"(passthrough), "no"(sriov with vlan tags), "yes:sriov"(sriovi, but exclusive and without vlan tag)\r
  69                 bandwidth: 10 Gbps\r
  70                 # mac_address: '20:33:45:56:77:44' #avoid this option if possible\r
  71             -   name:      xe1\r
  72                 vpci:      "0000:00:12.0"\r
  73                 dedicated: "yes"\r
  74                 bandwidth: 10 Gbps\r
  75                 # mac_address: '20:33:45:56:77:45' #avoid this option if possible\r
  76         bridge-ifaces:\r
  77         -   name:      mgmt0\r
  78             vpci:      "0000:00:09.0"    # Optional. Virtual PCI address\r
  79             bandwidth: 1 Mbps            # Optional. Informative only\r
  80             # mac_address: '20:33:45:56:77:46' #avoid this option if possible\r
  81             # model:       'virtio'      # ("virtio","e1000","ne2k_pci","pcnet","rtl8139") By default, it is automatically filled by libvirt\r
  82         -   name:      ge0\r
  83             vpci:      "0000:00:10.0"\r
  84             bandwidth: 1 Mbps\r
  85             # mac_address: '20:33:45:56:77:47' #avoid this option if possible\r
  86             # model:       'virtio'      # ("virtio","e1000","ne2k_pci","pcnet","rtl8139") By default, it is automatically filled by libvirt\r
  87         devices:                       # Optional, order determines device letter asignation (hda, hdb, ...)\r
  88         -   type:      disk            # "disk","cdrom","xml"\r
  89             image:     /path/to/imagefolder/SECOND-DISK.qcow2\r
  90             # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" }\r
  91             # vpci:      "0000:00:03.0"   # Optional, not for disk or cdrom\r
  92         -   type:      cdrom\r
  93             image:     /path/to/imagefolder/CDROM-IMAGE.qcow2\r
  94             # image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" }\r
  95         -   type:      xml\r
  96             image:     /path/to/imagefolder/ADDITIONAL-DISK.qcow2   # Optional, depending on the device type\r
  97             image metadata: {"bus":"ide", "os_type":"windows", "use_incremental": "no" }  # Optional, depending on the device type\r
  98             vpci:      "0000:00:03.0"                          # Optional, depending on the device type (not needed for disk or cdrom)\r
  99             xml:   '   xml text for XML described devices. Do not use single quotes inside\r
 100                        The following words, if found, will be replaced:\r
 101                        __file__    by image path, (image must be provided)\r
 102                        __format__  by qcow2 or raw (image must be provided)\r
 103                        __dev__     by device letter (b, c, d ...) \r
 104                        __vpci__    by vpci (vpci must be provided)\r
 105                    '\r
 106     # Additional Virtual Machines would be included here\r
 107 \r