Initial openvim v0.4.6 upload
[osm/openvim.git] / templates / server.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 server:
23     name:         vm-name         # name 
24     description:  vm-description  # Optional user description
25     imageRef:     24640fe0-8a9e-11e4-a236-52540056c317   # valid image uuid 
26     flavorRef:    e22dd8a8-9ca5-11e4-99b6-52540056c317   # valid flavor uuid
27     networks:  # List of control plane interfaces, Optional
28     -   name:     mgmt0          #friendly user name
29         vpci:     "0000:00:0a.0" #Optional guess PCI
30         uuid:     c09b2f1a-8a9e-11e4-a236-52540056c317   # valid network uuid
31         #mac_address:  #guess concrete mac address, by default one is asigned
32         #model:        "virtio","e1000","ne2k_pci","pcnet","rtl8139", By default auto, normally virtio
33     start:    "yes"    # "yes","no","paused".  By default it is started upon creted
34     hostId:   ec656bc4-9ca5-11e4-99b6-52540056c317      #prefered host where to allocate
35    
36     # allocating EXCLUSIVE resoureces in the same NUMA node. 
37     # If provided, it overrides extended values at flavor
38     extended:                             # optional
39         processor_ranking: 100            # minimal processor family. Not used in current version
40         numas:                            # list of numa set. Only one supported in current version
41         -  memory:         8              # GByte of huge pages at this numa
42
43            #Choose among one of "cores", "paired-threads", "threads"
44            paired-threads: 5              # Cores with two paired hyper threads
45            #paired-threads-id: [[0,1],[2,3],[4,5],[6,7],[8,9]] # Guess pinning. By default follows incremental order
46            #threads:       10             # threads awereness of the hyperthreading
47            ##threads-id: [0,1,2,3,4,5,6,7,8,9] #Optional. Guess pinning
48            #cores:         5              # Complete cores, without hyperthreading. VIM ensures the other paired thread is idle
49            ##cores-id:      [0,1,2,3,4]   # Optional. Guess pinning of cores
50
51            #Optional: Dataplane needed interfaces
52            interfaces:                    
53            -   name:       xe0            # Optional. User friendly name
54                vpci:       "0000:00:10.0" # Optional. Guess PCI 
55                bandwidth:  10 Gbps        # Needed minimun bandwidth
56                dedicated:  "yes"          # "yes"(passthrough), "no"(sriov with vlan tags), "yes:sriov"(sriovi, but exclusive and without vlan tag)
57                # you can attach this inteface to a network at server creation or later with a port attach
58                #uuid:       41bcac58-9be9-11e4-b1b6-52540056c317 # Attach the interface to this network uuid
59            -   name:       xe1
60                vpci:       "0000:00:11.0"
61                bandwidth:  10 Gbps
62                dedicated:  "no"
63                #mac_address:  #guess concrete mac address, by default one is asigned. Not possible for dedicated: "yes"
64            
65         #Optional: List of extra devices
66         devices:                       # order determines device letter asignation (hda, hdb, ...)
67         -   type:      disk            # "disk","cdrom","xml","usb"
68             imageRef:  37598e34-ccb3-11e4-a996-52540030594e # UUID of an image, only for disk,cdrom,xml
69             # vpci:      "0000:00:03.0"   # Optional, not for disk or cdrom
70             # xml:     'Only for type xml: a XML described device xml text. Do not use single quotes inside
71             #        The following words, if found, will be replaced:
72             #        __file__    by image path, (imageiRef must be provided)
73             #        __format__  by qcow2 or raw (imageRef must be provided)
74             #        __dev__     by device letter (b, c, d ...)
75             #        __vpci__    by vpci (vpci must be provided)
76