Updates docs for SR1 with final revision
[genesis.git] / fuel / deploy / deploy.py
index 9d1a3d2..178ae76 100644 (file)
@@ -1,33 +1,51 @@
-import sys
+###############################################################################
+# Copyright (c) 2015 Ericsson AB and others.
+# szilard.cserey@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
+###############################################################################
+
+
 import os
-import shutil
 import io
 import re
+import sys
 import netaddr
+import yaml
 
 from dea import DeploymentEnvironmentAdapter
 from dha import DeploymentHardwareAdapter
 from install_fuel_master import InstallFuelMaster
 from deploy_env import CloudDeploy
+from execution_environment import ExecutionEnvironment
 import common
 
 log = common.log
 exec_cmd = common.exec_cmd
 err = common.err
+warn = common.warn
 check_file_exists = common.check_file_exists
+check_dir_exists = common.check_dir_exists
+create_dir_if_not_exists = common.create_dir_if_not_exists
+delete = common.delete
 check_if_root = common.check_if_root
+ArgParser = common.ArgParser
 
 FUEL_VM = 'fuel'
-TMP_DIR = '%s/fueltmp' % os.getenv('HOME')
 PATCH_DIR = 'fuel_patch'
-WORK_DIR = 'deploy'
+WORK_DIR = '~/deploy'
+CWD = os.getcwd()
+
 
 class cd:
+
     def __init__(self, new_path):
         self.new_path = os.path.expanduser(new_path)
 
     def __enter__(self):
-        self.saved_path = os.getcwd()
+        self.saved_path = CWD
         os.chdir(self.new_path)
 
     def __exit__(self, etype, value, traceback):
@@ -36,31 +54,27 @@ class cd:
 
 class AutoDeploy(object):
 
-    def __init__(self, without_fuel, iso_file, dea_file, dha_file):
-        self.without_fuel = without_fuel
+    def __init__(self, no_fuel, fuel_only, no_health_check, cleanup_only,
+                 cleanup, storage_dir, pxe_bridge, iso_file, dea_file,
+                 dha_file, fuel_plugins_dir):
+        self.no_fuel = no_fuel
+        self.fuel_only = fuel_only
+        self.no_health_check = no_health_check
+        self.cleanup_only = cleanup_only
+        self.cleanup = cleanup
+        self.storage_dir = storage_dir
+        self.pxe_bridge = pxe_bridge
         self.iso_file = iso_file
         self.dea_file = dea_file
         self.dha_file = dha_file
-        self.dea = DeploymentEnvironmentAdapter(dea_file)
+        self.fuel_plugins_dir = fuel_plugins_dir
+        self.dea = (DeploymentEnvironmentAdapter(dea_file)
+                    if not cleanup_only else None)
         self.dha = DeploymentHardwareAdapter(dha_file)
         self.fuel_conf = {}
         self.fuel_node_id = self.dha.get_fuel_node_id()
-        self.fuel_custom = self.dha.use_fuel_custom_install()
         self.fuel_username, self.fuel_password = self.dha.get_fuel_access()
-
-    def setup_dir(self, dir):
-        self.cleanup_dir(dir)
-        os.makedirs(dir)
-
-    def cleanup_dir(self, dir):
-        if os.path.isdir(dir):
-            shutil.rmtree(dir)
-
-    def power_off_blades(self):
-        node_ids = self.dha.get_all_node_ids()
-        node_ids = list(set(node_ids) - set([self.fuel_node_id]))
-        for node_id in node_ids:
-            self.dha.node_power_off(node_id)
+        self.tmp_dir = None
 
     def modify_ip(self, ip_addr, index, val):
         ip_str = str(netaddr.IPAddress(ip_addr))
@@ -77,11 +91,9 @@ class AutoDeploy(object):
         self.fuel_conf['showmenu'] = 'yes'
 
     def install_fuel_master(self):
-        if self.without_fuel:
-            log('Not Installing Fuel Master')
-            return
         log('Install Fuel Master')
-        new_iso = '%s/deploy-%s' % (TMP_DIR, os.path.basename(self.iso_file))
+        new_iso = '%s/deploy-%s' \
+                  % (self.tmp_dir, os.path.basename(self.iso_file))
         self.patch_iso(new_iso)
         self.iso_file = new_iso
         self.install_iso()
@@ -90,40 +102,36 @@ class AutoDeploy(object):
         fuel = InstallFuelMaster(self.dea_file, self.dha_file,
                                  self.fuel_conf['ip'], self.fuel_username,
                                  self.fuel_password, self.fuel_node_id,
-                                 self.iso_file, WORK_DIR)
-        if self.fuel_custom:
-            log('Custom Fuel install')
-            fuel.custom_install()
-        else:
-            log('Ordinary Fuel install')
-            fuel.install()
+                                 self.iso_file, WORK_DIR,
+                                 self.fuel_plugins_dir)
+        fuel.install()
 
     def patch_iso(self, new_iso):
-        tmp_orig_dir = '%s/origiso' % TMP_DIR
-        tmp_new_dir = '%s/newiso' % TMP_DIR
+        tmp_orig_dir = '%s/origiso' % self.tmp_dir
+        tmp_new_dir = '%s/newiso' % self.tmp_dir
         self.copy(tmp_orig_dir, tmp_new_dir)
         self.patch(tmp_new_dir, new_iso)
 
     def copy(self, tmp_orig_dir, tmp_new_dir):
         log('Copying...')
-        self.setup_dir(tmp_orig_dir)
-        self.setup_dir(tmp_new_dir)
+        os.makedirs(tmp_orig_dir)
+        os.makedirs(tmp_new_dir)
         exec_cmd('fuseiso %s %s' % (self.iso_file, tmp_orig_dir))
         with cd(tmp_orig_dir):
             exec_cmd('find . | cpio -pd %s' % tmp_new_dir)
         with cd(tmp_new_dir):
             exec_cmd('fusermount -u %s' % tmp_orig_dir)
-        shutil.rmtree(tmp_orig_dir)
+        delete(tmp_orig_dir)
         exec_cmd('chmod -R 755 %s' % tmp_new_dir)
 
     def patch(self, tmp_new_dir, new_iso):
         log('Patching...')
-        patch_dir = '%s/%s' % (os.getcwd(), PATCH_DIR)
+        patch_dir = '%s/%s' % (CWD, PATCH_DIR)
         ks_path = '%s/ks.cfg.patch' % patch_dir
 
         with cd(tmp_new_dir):
             exec_cmd('cat %s | patch -p0' % ks_path)
-            shutil.rmtree('.rr_moved')
+            delete('.rr_moved')
             isolinux = 'isolinux/isolinux.cfg'
             log('isolinux.cfg before: %s'
                 % exec_cmd('grep netmask %s' % isolinux))
@@ -149,51 +157,152 @@ class AutoDeploy(object):
             f.write(data)
 
     def deploy_env(self):
-        dep = CloudDeploy(self.dha, self.fuel_conf['ip'], self.fuel_username,
-                          self.fuel_password, self.dea_file, WORK_DIR)
-        dep.deploy()
+        dep = CloudDeploy(self.dea, self.dha, self.fuel_conf['ip'],
+                          self.fuel_username, self.fuel_password,
+                          self.dea_file, WORK_DIR, self.no_health_check)
+        return dep.deploy()
+
+    def setup_execution_environment(self):
+        exec_env = ExecutionEnvironment(self.storage_dir, self.pxe_bridge,
+                                        self.dha_file, self.dea)
+        exec_env.setup_environment()
+
+    def cleanup_execution_environment(self):
+        exec_env = ExecutionEnvironment(self.storage_dir, self.pxe_bridge,
+                                        self.dha_file, self.dea)
+        exec_env.cleanup_environment()
+
+    def create_tmp_dir(self):
+        self.tmp_dir = '%s/fueltmp' % CWD
+        delete(self.tmp_dir)
+        create_dir_if_not_exists(self.tmp_dir)
 
     def deploy(self):
-        check_if_root()
-        self.setup_dir(TMP_DIR)
         self.collect_fuel_info()
-        self.power_off_blades()
-        self.install_fuel_master()
-        self.cleanup_dir(TMP_DIR)
-        self.deploy_env()
+        if not self.no_fuel:
+            self.setup_execution_environment()
+            self.create_tmp_dir()
+            self.install_fuel_master()
+        if not self.fuel_only:
+            return self.deploy_env()
+        return True
+
+    def run(self):
+        check_if_root()
+        if self.cleanup_only:
+            self.cleanup_execution_environment()
+        else:
+            deploy_success = self.deploy()
+            if self.cleanup:
+                self.cleanup_execution_environment()
+            return deploy_success
+        return True
 
-def usage():
-    print '''
-    Usage:
-    python deploy.py [-nf] <isofile> <deafile> <dhafile>
+def check_bridge(pxe_bridge, dha_path):
+    with io.open(dha_path) as yaml_file:
+        dha_struct = yaml.load(yaml_file)
+    if dha_struct['adapter'] != 'libvirt':
+        log('Using Linux Bridge %s for booting up the Fuel Master VM'
+            % pxe_bridge)
+        r = exec_cmd('ip link show %s' % pxe_bridge)
+        if pxe_bridge in r and 'state DOWN' in r:
+            err('Linux Bridge {0} is not Active, bring'
+                ' it UP first: [ip link set dev {0} up]'.format(pxe_bridge))
+
+
+def check_fuel_plugins_dir(dir):
+    msg = None
+    if not dir:
+        msg = 'Fuel Plugins Directory not specified!'
+    elif not os.path.isdir(dir):
+        msg = 'Fuel Plugins Directory does not exist!'
+    elif not os.listdir(dir):
+        msg = 'Fuel Plugins Directory is empty!'
+    if msg:
+        warn('%s No external plugins will be installed!' % msg)
 
-    Optional arguments:
-      -nf   Do not install Fuel master
-    '''
 
 def parse_arguments():
-    if (len(sys.argv) < 4 or len(sys.argv) > 5
-        or (len(sys.argv) == 5 and sys.argv[1] != '-nf')):
-        log('Incorrect number of arguments')
-        usage()
-        sys.exit(1)
-    without_fuel = False
-    if len(sys.argv) == 5 and sys.argv[1] == '-nf':
-        without_fuel = True
-    iso_file = sys.argv[-3]
-    dea_file = sys.argv[-2]
-    dha_file = sys.argv[-1]
-    check_file_exists(iso_file)
-    check_file_exists(dea_file)
-    check_file_exists(dha_file)
-    return (without_fuel, iso_file, dea_file, dha_file)
+    parser = ArgParser(prog='python %s' % __file__)
+    parser.add_argument('-nf', dest='no_fuel', action='store_true',
+                        default=False,
+                        help='Do not install Fuel Master (and Node VMs when '
+                             'using libvirt)')
+    parser.add_argument('-nh', dest='no_health_check', action='store_true',
+                        default=False,
+                        help='Don\'t run health check after deployment')
+    parser.add_argument('-fo', dest='fuel_only', action='store_true',
+                        default=False,
+                        help='Install Fuel Master only (and Node VMs when '
+                             'using libvirt)')
+    parser.add_argument('-co', dest='cleanup_only', action='store_true',
+                        default=False,
+                        help='Cleanup VMs and Virtual Networks according to '
+                             'what is defined in DHA')
+    parser.add_argument('-c', dest='cleanup', action='store_true',
+                        default=False,
+                        help='Cleanup after deploy')
+    if {'-iso', '-dea', '-dha', '-h'}.intersection(sys.argv):
+        parser.add_argument('-iso', dest='iso_file', action='store', nargs='?',
+                            default='%s/OPNFV.iso' % CWD,
+                            help='ISO File [default: OPNFV.iso]')
+        parser.add_argument('-dea', dest='dea_file', action='store', nargs='?',
+                            default='%s/dea.yaml' % CWD,
+                            help='Deployment Environment Adapter: dea.yaml')
+        parser.add_argument('-dha', dest='dha_file', action='store', nargs='?',
+                            default='%s/dha.yaml' % CWD,
+                            help='Deployment Hardware Adapter: dha.yaml')
+    else:
+        parser.add_argument('iso_file', action='store', nargs='?',
+                            default='%s/OPNFV.iso' % CWD,
+                            help='ISO File [default: OPNFV.iso]')
+        parser.add_argument('dea_file', action='store', nargs='?',
+                            default='%s/dea.yaml' % CWD,
+                            help='Deployment Environment Adapter: dea.yaml')
+        parser.add_argument('dha_file', action='store', nargs='?',
+                            default='%s/dha.yaml' % CWD,
+                            help='Deployment Hardware Adapter: dha.yaml')
+    parser.add_argument('-s', dest='storage_dir', action='store',
+                        default='%s/images' % CWD,
+                        help='Storage Directory [default: images]')
+    parser.add_argument('-b', dest='pxe_bridge', action='store',
+                        default='pxebr',
+                        help='Linux Bridge for booting up the Fuel Master VM '
+                             '[default: pxebr]')
+    parser.add_argument('-p', dest='fuel_plugins_dir', action='store',
+                        help='Fuel Plugins directory')
 
-def main():
+    args = parser.parse_args()
+    log(args)
 
-    without_fuel, iso_file, dea_file, dha_file = parse_arguments()
+    check_file_exists(args.dha_file)
+
+    if not args.cleanup_only:
+        check_file_exists(args.dea_file)
+        check_fuel_plugins_dir(args.fuel_plugins_dir)
+
+    if not args.no_fuel and not args.cleanup_only:
+        log('Using OPNFV ISO file: %s' % args.iso_file)
+        check_file_exists(args.iso_file)
+        log('Using image directory: %s' % args.storage_dir)
+        create_dir_if_not_exists(args.storage_dir)
+        check_bridge(args.pxe_bridge, args.dha_file)
+
+    kwargs = {'no_fuel': args.no_fuel, 'fuel_only': args.fuel_only,
+              'no_health_check': args.no_health_check,
+              'cleanup_only': args.cleanup_only, 'cleanup': args.cleanup,
+              'storage_dir': args.storage_dir, 'pxe_bridge': args.pxe_bridge,
+              'iso_file': args.iso_file, 'dea_file': args.dea_file,
+              'dha_file': args.dha_file,
+              'fuel_plugins_dir': args.fuel_plugins_dir}
+    return kwargs
+
+
+def main():
+    kwargs = parse_arguments()
 
-    d = AutoDeploy(without_fuel, iso_file, dea_file, dha_file)
-    d.deploy()
+    d = AutoDeploy(**kwargs)
+    sys.exit(d.run())
 
 if __name__ == '__main__':
-    main()
\ No newline at end of file
+    main()