33baff1451ad8ab984af3d6a18edcfb6775d1515
[genesis.git] / fuel / deploy / README.txt
1
2 ======== PREREQUISITES ========
3
4 the following applications and python modules are required to be installed:
5
6 - example for Ubuntu environment:
7
8 sudo apt-get install -y libvirt-bin qemu-kvm tightvncserver virt-manager
9 sshpass fuseiso genisoimage blackbox xterm python-pip
10 sudo restart libvirt-bin
11 sudo pip install pyyaml netaddr paramiko lxml scp
12
13
14
15 ======== PREPARE and RUN the OPNFV Autodeployment ========
16
17
18 --- Step.1 Prepare the DEA and DHA configuration files and the OPNFV ISO file
19
20 Make sure that you are using the right DEA - Deployment Environment Adapter and
21 DHA - Deployment Hardware Adapter configuration files, the ones provided are only templates
22 you will have to modify them according to your needs
23
24 - If wou wish to deploy OPNFV cloud environment on top of KVM/Libvirt
25   virtualization use as example the following configuration files:
26
27   =>   libvirt/conf/ha
28                 dea.yaml
29                 dha.yaml
30
31   =>   libvirt/conf/multinode
32                 dea.yaml
33                 dha.yaml
34
35
36 - If you wish to deploy OPNFV cloud environment on baremetal
37   use as example the following configuration files:
38
39   =>   baremetal/conf/ericsson_montreal_lab/ha
40                 dea.yaml
41                 dha.yaml
42
43   =>   baremetal/conf/ericsson_montreal_lab/multinode
44                 dea.yaml
45                 dha.yaml
46
47   =>   baremetal/conf/linux_foundation_lab/ha
48                 dea.yaml
49                 dha.yaml
50
51   =>   baremetal/conf/linux_foundation_lab/multinode
52                 dea.yaml
53                 dha.yaml
54
55
56 --- Step.2 Run Autodeployment:
57
58 usage: python deploy.py [-h] [-nf] [-s [STORAGE_DIR]] [-b [PXE_BRIDGE]]
59                         [iso_file] dea_file dha_file
60
61 positional arguments:
62   iso_file          ISO File [default: OPNFV.iso]
63   dea_file          Deployment Environment Adapter: dea.yaml
64   dha_file          Deployment Hardware Adapter: dha.yaml
65
66 optional arguments:
67   -h, --help        show this help message and exit
68   -nf               Do not install Fuel Master (and Node VMs when using
69                     libvirt)
70   -s [STORAGE_DIR]  Storage Directory [default: images]
71   -b [PXE_BRIDGE]   Linux Bridge for booting up the Fuel Master VM [default:
72                     pxebr]
73
74
75 * WARNING:
76
77 If optional argument -s <storage_dir> is not specified, Autodeployment will use
78 "<current_working_dir>/images" as default, and it will create it, if it hasn't been created before
79
80 If optional argument -b <pxe_bridge> is not specified, Autodeployment will use "pxebr" as default,
81 if the bridge does not exist, the application will terminate with an error message
82
83 IF optional argument <iso_file> is not specified, Autodeployment will use "<current_working_dir>/OPNFV.iso"
84 as default, if the iso file does not exist, the application will terminate with an error message
85
86 <pxe_bridge> is not required for Autodeployment in virtual environment, even if it is specified
87 it will not be used at all
88
89
90 * EXAMPLES:
91
92 - Install Fuel Master and deploy OPNFV Cloud from scratch on Baremetal Environment
93
94 sudo python deploy.py ~/ISO/opnfv.iso ~/CONF/baremetal/dea.yaml ~/CONF/baremetal/dha.yaml -s /mnt/images -b pxebr
95
96
97 - Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual Environment
98
99 sudo python deploy.py ~/ISO/opnfv.iso ~/CONF/virtual/dea.yaml ~/CONF/virtual/dha.yaml -s /mnt/images
100
101
102
103 - Deploy OPNFV Cloud on an already active Environment where Fuel Master VM is running
104   so no need to install Fuel again
105
106 sudo python deploy.py -nf ~/CONF/baremetal/dea.yaml ~/CONF/baremetal/dha.yaml
107
108 sudo python deploy.py -nf ~/CONF/virtual/dea.yaml ~/CONF/virtual/dha.yaml
109