ci/README.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) 2017 Ericsson AB, Mirantis Inc., Enea Software AB and others.
   4
   5 Abstract
   6 ========
   7 The fuel/ci directory holds all Fuel@OPNFV programatic abstractions for
   8 the OPNFV community release and continous integration pipeline.
   9 There is now only one Fuel@OPNFV autonomous script for this, complying to the
  10 OPNFV CI pipeline guideline:
  11  - deploy.sh
  12
  13 USAGE
  14 =====
  15 For usage information of the CI/CD scripts, please run:
  16
  17     .. code-block:: bash
  18
  19         $ ./deploy.sh -h
  20
  21 Details on the CI/CD deployment framework
  22 =========================================
  23
  24 Overview and purpose
  25 --------------------
  26 The CI/CD deployment script relies on a configuration structure, providing base
  27 installer configuration (part of fuel repo: mcp/config), per POD specific
  28 configuration (part of a separate classified POD configuration repo: securedlab
  29 and deployment scenario configuration (part of fuel repo: mcp/config/scenario).
  30
  31 - The base installer configuration resembles the least common denominator of all
  32   HW/POD environment and deployment scenarios. These configurations are
  33   normally carried by the the installer projects in this case (Fuel@OPNFV).
  34 - Per POD specific configuration specifies POD unique parameters, the POD
  35   parameter possible to alter is governed by the Fuel@OPNFV project.
  36 - Deployment scenario configuration - provides a high level, POD/HW environment
  37   independent scenario configuration for a specifiv deployment. It defines what
  38   features shall be deployed - as well needed overrides of the base
  39   installer, POD/HW environment configurations. Objects allowed to override
  40   are governed by the Fuel@OPNFV project.
  41
  42 Executing a deployment
  43 ----------------------
  44 deploy.sh must be executed locally at the target lab/pod/jumpserver
  45 A configuration structure must be provided - see the section below.
  46 It is straight forward to execute a deployment task - as an example:
  47
  48     .. code-block:: bash
  49
  50         $ sudo deploy.sh -b file:///home/jenkins/config
  51                          -l lf -p pod2 -s os-nosdn-nofeature-ha
  52
  53 -b and -i arguments should be expressed in URI style (eg: file://...
  54 or http://...). The resources can thus be local or remote.
  55
  56 Configuration repository structure
  57 ----------------------------------
  58 The CI deployment engine relies on a configuration directory/file structure
  59 pointed to by the -b option described above.
  60 Normally this points to the secure classified OPNFV securedlab repo to which
  61 only jenkins and andmins have access to, but you may point to any local or
  62 remote strcture fullfilling the diectory/file structure below.
  63 The reason that this configuration structure needs to be secure/hidden
  64 is that there are security sensitive information in the various configuration
  65 files.
  66
  67 FIXME: Below information is out of date and should be refreshed after PDF
  68 support is fully implemented.
  69
  70 A local stripped version of this configuration structure with virtual
  71 deployment configurations also exist under build/config/.
  72 Following configuration directory and file structure should adheare to:
  73
  74     .. code-block:: bash
  75
  76         TOP
  77         !
  78         +---- labs
  79                !
  80                +---- lab-name-1
  81                !        !
  82                !        +---- pod-name-1
  83                !        !        !
  84                !        !        +---- fuel
  85                !        !               !
  86                !        !               +---- config
  87                !        !                       !
  88                !        !                       +---- dea-pod-override.yaml
  89                !        !                       !
  90                !        !                       +---- dha.yaml
  91                !        !
  92                !        +---- pod-name-2
  93                !                 !
  94                !
  95                +---- lab-name-2
  96                !        !
  97
  98
  99 Creating a deployment scenario
 100 ------------------------------
 101 Please find `mcp/config/README.rst` for instructions on how to create a new
 102 deployment scenario.