Updates docs for SR1 with final revision
[genesis.git] / fuel / prototypes / auto-deploy / documentation / 3-dha.txt
1 The structure is being reworked. This page describes the DHA.yaml file.
2
3 Below is an example DHA for a libvirt deployment. An actual hardware deployment
4 could for instance add additional data fields to the node list, such as:
5
6 nodes:
7 - id: 1
8   pxeMac: 52:54:00:9c:c2:c9
9   ipmiIp: 192.168.220.1
10   ipmiUser: admin
11   impiPassword: ericsson
12   isFuel: true
13
14 The important thing is to keep the mandatory fields and add additional
15 ones to map to the DHA adapter implementation for the hardware in
16 question.
17
18 The following example for libvirt is based on what's created by
19 create_template.sh.
20
21 Example DHA.yaml file for a libvirt adapter
22
23 # DHA API version supported
24 version: 1.1
25 created: Wed Apr 22 11:34:14 UTC 2015
26 comment: Small libvirt deployment
27
28 # Adapter to use for this definition
29 adapter: libvirt
30
31 # Node list.
32 # Mandatory fields are id, role and the "isFuel: true" property
33 # for the Fuel node if not fuelCustomInstall is set, when it is
34 # optional.
35 # The MAC address of the PXE boot interface is not mandatory
36 #   to be set, but the field must be present.
37 # All other fields are adapter specific.
38
39 nodes:
40 - id: 1
41   pxeMac: 52:54:00:38:c7:8e
42 - id: 2
43   pxeMac: 52:54:00:9c:c2:c9
44 - id: 3
45   pxeMac: 11:11:11:11:11:11
46   isFuel: true
47
48 # Deployment power on strategy
49 # all:      Turn on all nodes at once. If MAC addresses are set these
50 #           will be used for connecting roles to physical nodes, if the
51 #           installation order will be arbitrary.
52 # sequence: Turn on the nodes in sequence starting with the lowest order
53 #           node and wait for the node to be detected by Fuel. Not until
54 #           the node has been detected and assigned a role will the next
55 #           node be turned on.
56 powerOnStrategy: all
57
58 # If fuelCustomInstall is set to true, Fuel is assumed to be installed by
59 # calling the DHA adapter function "dha_fuelCustomInstall()"  with two
60 # arguments: node ID and the ISO file name to deploy. The custom install
61 # function is then to handle all necessary logic to boot the Fuel master
62 # from the ISO and then return.
63 # Allowed values: true, false
64
65 fuelCustomInstall: false