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 ./deploy.sh -h
  20
  21
  22 sudo ./deploy.sh -h
  23 python deploy.py -h
  24
  25 usage: python deploy.py [-h] [-nf] [-nh] [-fo] [-co] [-c] [-iso [ISO_FILE]]
  26                         [-dea [DEA_FILE]] [-dha [DHA_FILE]] [-s STORAGE_DIR]
  27                         [-b PXE_BRIDGE] [-p FUEL_PLUGINS_DIR]
  28
  29 optional arguments:
  30   -h, --help           show this help message and exit
  31   -nf                  Do not install Fuel Master (and Node VMs when using
  32                        libvirt)
  33   -nh                  Don't run health check after deployment
  34   -fo                  Install Fuel Master only (and Node VMs when using
  35                        libvirt)
  36   -co                  Cleanup VMs and Virtual Networks according to what is
  37                        defined in DHA
  38   -c                   Cleanup after deploy
  39   -iso [ISO_FILE]      ISO File [default: OPNFV.iso]
  40   -dea [DEA_FILE]      Deployment Environment Adapter: dea.yaml
  41   -dha [DHA_FILE]      Deployment Hardware Adapter: dha.yaml
  42   -s STORAGE_DIR       Storage Directory [default: images]
  43   -b PXE_BRIDGE        Linux Bridge for booting up the Fuel Master VM
  44                        [default: pxebr]
  45   -p FUEL_PLUGINS_DIR  Fuel Plugins directory
  46
  47
  48
  49 * EXAMPLES:
  50
  51 - Install Fuel Master and deploy OPNFV Cloud from scratch on Hardware Environment:
  52
  53     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr -p ~/PLUGIN
  54
  55
  56 - Install Fuel Master and deploy OPNFV Cloud from scratch on Virtual Environment:
  57
  58     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images -p ~/PLUGIN
  59
  60
  61 - Deploy OPNFV Cloud on an already active Environment where Fuel Master VM is running so no need to install Fuel again:
  62
  63     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml
  64
  65     => with plugin installation
  66     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -p ~/PLUGIN
  67
  68     => with cleanup after deployment is finished
  69     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -p ~/PLUGIN -c
  70
  71     => no healthcheck after deployment is completed
  72     sudo ./deploy.sh -nf -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -p ~/PLUGIN -nh
  73
  74
  75 - Install Fuel Master only (and Node VMs when using virtual environment):
  76
  77     => for virtual environment:
  78     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/virtual/dea.yaml -dha ~/CONF/virtual/dha.yaml -s /mnt/images
  79
  80     => for hardware environment:
  81     sudo ./deploy.sh -iso ~/ISO/opnfv.iso -dea ~/CONF/hardware/dea.yaml -dha ~/CONF/hardware/dha.yaml -s /mnt/images -b pxebr
  82
  83
  84 - Cleanup a running OPNFV environment:
  85
  86     sudo ./deploy.sh -co -dha ~/CONF/virtual/dha.yaml