fuel/ci/README

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   3 # stefan.k.berg@ericsson.com
   4 # jonas.bjurel@ericsson.com
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 ##############################################################################
  10
  11 The genesis/fuel/ci directory holds all Fuel@OPNFV abstractions for the OPNFV
  12 community release and continous integration pipeline.
  13 There are two Fuel@OPNF autonomous scripts fo this, complying to the OPNFV CI pipeline guideline:
  14  - build.sh
  15  - deploy.sh
  16
  17 For more info on usage:
  18 ./build.sh -h
  19 sudo ./deploy.sh -h
  20 python deploy.py -h
  21
  22 usage: python deploy.py [-h] [-nf] [-nh] [-fo] [-co] [-c] [-iso [ISO_FILE]]
  23                         [-dea [DEA_FILE]] [-dha [DHA_FILE]] [-s STORAGE_DIR]
  24                         [-b PXE_BRIDGE] [-p FUEL_PLUGINS_DIR]
  25
  26 optional arguments:
  27   -h, --help           show this help message and exit
  28   -nf                  Do not install Fuel Master (and Node VMs when using
  29                        libvirt)
  30   -nh                  Don't run health check after deployment
  31   -fo                  Install Fuel Master only (and Node VMs when using
  32                        libvirt)
  33   -co                  Cleanup VMs and Virtual Networks according to what is
  34                        defined in DHA
  35   -c                   Cleanup after deploy
  36   -iso [ISO_FILE]      ISO File [default: OPNFV.iso]
  37   -dea [DEA_FILE]      Deployment Environment Adapter: dea.yaml
  38   -dha [DHA_FILE]      Deployment Hardware Adapter: dha.yaml
  39   -s STORAGE_DIR       Storage Directory [default: images]
  40   -b PXE_BRIDGE        Linux Bridge for booting up the Fuel Master VM
  41                        [default: pxebr]
  42   -p FUEL_PLUGINS_DIR  Fuel Plugins directory
  43
  44
  45
  46 * EXAMPLES:
  47
  48 - Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware Environment:
  49
  50     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr
  51
  52
  53 - Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual Environment:
  54
  55     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images
  56
  57
  58 - Deploy OPNFV Cloud on an already active Environment where Fuel Master VM is running so no need to install Fuel again:
  59
  60     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml
  61
  62     => with plugin installation
  63     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml
  64
  65     => with cleanup after deployment is finished
  66     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -c
  67
  68     => no healthcheck after deployment is completed
  69     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -nh
  70
  71
  72 - Install Fuel Master only (and Node VMs when using virtual environment):
  73
  74     => for virtual environment:
  75     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images
  76
  77     => for hardware environment:
  78     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr
  79
  80
  81 - Cleanup a running OPNFV environment:
  82
  83     sudo ./deploy.sh -co -dha ~/CONF/virtual/dha.yaml
  84
  85
  86 * WARNINGS:
  87
  88 =>  If optional argument -s <storage_dir> is not specified, Autodeployment will use
  89 "<current_working_dir>/images" as default, and it will create it, if it hasn't been created before
  90
  91 =>  If optional argument -b <pxe_bridge> is not specified, Autodeployment will use "pxebr" as default,
  92 if the bridge does not exist, the application will terminate with an error message
  93
  94 =>  If argument -iso [ISO_FILE] is not specified, Autodeployment will use "<current_working_dir>/OPNFV.iso"
  95 as default, if the iso file does not exist, the application will terminate with an error message
  96
  97 =>  If argument -dea [DEA_FILE] is not specified, Autodeployment will use "<current_working_dir>/dea.yaml"
  98 as default, if DEA file does not exist, the application will terminate with an error message
  99
 100 =>  If argument -dha [DHA_FILE] is not specified, Autodeployment will use "<current_working_dir>/dha.yaml"
 101 as default, if DHA file does not exist, the application will terminate with an error message
 102
 103 => Optional argument -b PXE_BRIDGE is not required for Autodeployment in virtual environment,
 104    even if it is specified it will not be used at all because virtual environment is using a different virtual network setup
 105
 106 => If optional argument -p FUEL_PLUGINS_DIR is not specified, no external plugins will be installed in Fuel