Updates docs for SR1 with final revision
[genesis.git] / fuel / prototypes / auto-deploy / documentation / 1-introduction.txt
1 The structure is being reworked. This page is an introduction to DEA
2 and DHA.
3
4 Introduction
5
6 The aim of the deployment prototype is to try out a (hopefully)
7 logical setup to support Fuel deployment on a variety of different
8 hardware platforms using a common data format to describe the
9 deployment itself and another data format to describe the hardware in
10 question.
11
12 DEA.yaml The DEA.yaml file describes a Fuel deployment, complete with
13         all settings. The easiest way to create this file is to use
14         the "create_templates.sh" script in an existing deployment to
15         copy its configuration to the DEA.yaml file.
16
17 DHA.yaml The DHA.yaml file describes to hardware setup for an
18         installation. This file denotes among other things which DHA
19         adapter to use when deploying Fuel on this hardware setup.
20         
21 DHA adapter interface: The DHA adapter interface contains a number of
22     functions calls available to the automatic Fuel deployer script
23     (deploy.sh). Each adapter creates an implementation of this
24     interface in order for the deployer to orchestrate the
25     installation. There's currently an example DHA adapter "libvirt"
26     that is able to deploy Fuel in a nested KVM environment. Future
27     adapters could support HP C7000, Dell R620 or other types of
28     hardware.
29
30     It is important to note that a certain DHA adapter could implement
31     the dha_fuelCustomInstall() function, which for instance could
32     install the Fuel master as a VM or using PXE.
33
34 A typical installation would be kicked off by the following command:
35
36 ./deploy.sh <isofile to deploy> <dea.yaml> <dha.yaml>