Code Review / fuel.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
deploy: fix: remove storage files during cleanup
[fuel.git] / deploy / README
diff --git a/deploy/README b/deploy/README
index 7a3e09d..40f95ef 100644 (file)
--- a/deploy/README
+++ b/deploy/README
@@ -1,3 +1,11 @@
+##############################################################################
+# Copyright (c) 2015 Ericsson AB and others.
+# peter.barabas@ericsson.com
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
 
 ======== PREREQUISITES ========
 
 
 ======== PREREQUISITES ========
 
@@ -6,7 +14,7 @@ the following dependencies and python modules are required to be installed:
 - for Ubuntu:
 
 sudo apt-get install -y libvirt-bin qemu-kvm python-pip fuseiso mkisofs genisoimage
 - for Ubuntu:
 
 sudo apt-get install -y libvirt-bin qemu-kvm python-pip fuseiso mkisofs genisoimage
-sudo apt-get install -y python-dev libz-dev libxml2-dev libxslt-dev
+sudo apt-get install -y python-dev libz-dev libxml2-dev libxslt-dev libyaml-dev
 sudo pip install pyyaml netaddr paramiko lxml scp pycrypto ecdsa
 
 During libvirt install the user is added to the libvirtd group, so you have to
 sudo pip install pyyaml netaddr paramiko lxml scp pycrypto ecdsa
 
 During libvirt install the user is added to the libvirtd group, so you have to
@@ -25,30 +33,15 @@ you will have to modify them according to your needs
 - If wou wish to deploy OPNFV cloud environment on top of KVM/Libvirt
   virtualization use as example the following configuration files:
 
 - If wou wish to deploy OPNFV cloud environment on top of KVM/Libvirt
   virtualization use as example the following configuration files:
 
-  * SR1 configuration files
-
   =>   templates/virtual_environment/conf/ha
                 dea.yaml
                 dha.yaml
 
 
   =>   templates/virtual_environment/conf/ha
                 dea.yaml
                 dha.yaml
 
 
-  * ARNO configuration files
-
-  =>   templates/virtual_environment/old_conf/ha
-                dea.yaml
-                dha.yaml
-
-  =>   templates/virtual_environment/old_conf/multinode
-                dea.yaml
-                dha.yaml
-
-
 - If you wish to deploy OPNFV cloud environment on hardware
   use as example the following configuration files:
 
 - If you wish to deploy OPNFV cloud environment on hardware
   use as example the following configuration files:
 
-  * SR1 configuration files
-
-  =>   templates/hardware_environment/conf/ericsson_montreal_lab/ha
+  =>   templates/hardware_environment/conf/ericsson_montreal_lab/pod1/ha
                 dea.yaml
                 dha.yaml
 
                 dea.yaml
                 dha.yaml
 
@@ -61,81 +54,71 @@ you will have to modify them according to your needs
                 dha.yaml
 
 
                 dha.yaml
 
 
-  * ARNO configuration files
-
-  =>   templates/hardware_environment/old_conf/ericsson_montreal_lab/ha
-                dea.yaml
-                dha.yaml
-
-  =>   templates/hardware_environment/old_conf/ericsson_montreal_lab/multinode
-                dea.yaml
-                dha.yaml
-
-  =>   templates/hardware_environment/old_conf/linux_foundation_lab/ha
-                dea.yaml
-                dha.yaml
-
-  =>   templates/hardware_environment/old_conf/linux_foundation_lab/multinode
-                dea.yaml
-                dha.yaml
-
-
 --- Step.2 Run Autodeployment ---
 
 --- Step.2 Run Autodeployment ---
 
-usage: python deploy.py [-h] [-nf] [-nh] [-fo] [-co] [-c] [-iso [ISO_FILE]]
-                        [-dea [DEA_FILE]] [-dha [DHA_FILE]] [-s STORAGE_DIR]
-                        [-b PXE_BRIDGE] [-p FUEL_PLUGINS_DIR]
+usage: python ./deploy.py [-h] [-nf] [-nh] [-fo] [-co] [-c] [-iso [ISO_FILE]]
+                          [-dea [DEA_FILE]] [-dha [DHA_FILE]] [-s STORAGE_DIR]
+                          [-b PXE_BRIDGE] [-p FUEL_PLUGINS_DIR]
+                          [-pc FUEL_PLUGINS_CONF_DIR] [-np]
+                          [-dt DEPLOY_TIMEOUT] [-nde]
 
 optional arguments:
 
 optional arguments:
-  -h, --help           show this help message and exit
-  -nf                  Do not install Fuel Master (and Node VMs when using libvirt)
-  -nh                  Don't run health check after deployment
-  -fo                  Install Fuel Master only (and Node VMs when using libvirt)
-  -co                  Cleanup VMs and Virtual Networks according to what is
-                       defined in DHA
-  -c                   Cleanup after deploy
-  -iso [ISO_FILE]      ISO File [default: OPNFV.iso]
-  -dea [DEA_FILE]      Deployment Environment Adapter: dea.yaml
-  -dha [DHA_FILE]      Deployment Hardware Adapter: dha.yaml
-  -s STORAGE_DIR       Storage Directory [default: images]
-  -b PXE_BRIDGE        Linux Bridge for booting up the Fuel Master VM
-                       [default: pxebr]
-  -p FUEL_PLUGINS_DIR  Fuel Plugins directory
-
+  -h, --help            show this help message and exit
+  -nf                   Do not install Fuel Master (and Node VMs when using
+                        libvirt)
+  -nh                   Don't run health check after deployment
+  -fo                   Install Fuel Master only (and Node VMs when using
+                        libvirt)
+  -co                   Cleanup VMs and Virtual Networks according to what is
+                        defined in DHA
+  -c                    Cleanup after deploy
+  -iso [ISO_FILE]       ISO File [default: OPNFV.iso]
+  -dea [DEA_FILE]       Deployment Environment Adapter: dea.yaml
+  -dha [DHA_FILE]       Deployment Hardware Adapter: dha.yaml
+  -s STORAGE_DIR        Storage Directory [default: images]
+  -b PXE_BRIDGE         Linux Bridge for booting up the Fuel Master VM
+                        [default: pxebr]
+  -p FUEL_PLUGINS_DIR   Fuel Plugins directory
+  -pc FUEL_PLUGINS_CONF_DIR
+                        Fuel Plugins Configuration directory
+  -np                   Do not install Fuel Plugins
+  -dt DEPLOY_TIMEOUT    Deployment timeout (in minutes) [default: 240]
+  -nde                  Do not launch environment deployment
+  -log [LOG_FILE]      Deployment log path and file name
 
 * EXAMPLES:
 
 - Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware Environment:
 
 
 * EXAMPLES:
 
 - Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware Environment:
 
-    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr
+    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr -log ~/Deployment-888.log.tar.gz
 
 
 - Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual Environment:
 
 
 
 - Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual Environment:
 
-    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images
+    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images -log ~/Deployment-888.log.tar.gz
 
 
 - Deploy OPNFV Cloud on an already active Environment where Fuel Master VM is running so no need to install Fuel again:
 
 
 
 - Deploy OPNFV Cloud on an already active Environment where Fuel Master VM is running so no need to install Fuel again:
 
-    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml
+    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -log ~/Deployment-888.log.tar.gz
 
     => with plugin installation
 
     => with plugin installation
-    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml
+    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -log ~/Deployment-888.log.tar.gz
 
     => with cleanup after deployment is finished
 
     => with cleanup after deployment is finished
-    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -c
+    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -c -log ~/Deployment-888.log.tar.gz
 
     => no healthcheck after deployment is completed
 
     => no healthcheck after deployment is completed
-    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -nh
+    sudo python deploy.py -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -nh -log ~/Deployment-888.log.tar.gz
 
 
 - Install Fuel Master only (and Node VMs when using virtual environment):
 
     => for virtual environment:
 
 
 - Install Fuel Master only (and Node VMs when using virtual environment):
 
     => for virtual environment:
-    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images
+    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images -log ~/Deployment-888.log.tar.gz
 
     => for hardware environment:
 
     => for hardware environment:
-    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr
+    sudo python deploy.py -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr -log ~/Deployment-888.log.tar.gz
 
 
 - Cleanup a running OPNFV environment:
 
 
 - Cleanup a running OPNFV environment: