vnfs/vnf-template.yaml

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