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 ./deploy.sh -h
  17
  18 Details on the CI/CD deployment framework
  19 =========================================
  20
  21 Overview and purpose
  22 --------------------
  23 The CI/CD deployment script relies on a configuration structure, providing base
  24 installer configuration (part of fuel repo: mcp/config), per POD specific
  25 configuration (part of a separate classified POD configuration repo: securedlab
  26 and deployment scenario configuration (part of fuel repo: mcp/config/scenario).
  27
  28 - The base installer configuration resembles the least common denominator of all
  29   HW/POD environment and deployment scenarios. These configurations are
  30   normally carried by the the installer projects in this case (Fuel@OPNFV).
  31 - Per POD specific configuration specifies POD unique parameters, the POD
  32   parameter possible to alter is governed by the Fuel@OPNFV project.
  33 - Deployment scenario configuration - provides a high level, POD/HW environment
  34   independent scenario configuration for a specifiv deployment. It defines what
  35   features shall be deployed - as well needed overrides of the base
  36   installer, POD/HW environment configurations. Objects allowed to override
  37   are governed by the Fuel@OPNFV project.
  38
  39 Executing a deployment
  40 ----------------------
  41 deploy.sh must be executed locally at the target lab/pod/jumpserver
  42 A configuration structure must be provided - see the section below.
  43 It is straight forward to execute a deployment task - as an example:
  44 $ sudo deploy.sh -b file:///home/jenkins/config \
  45   -l lf -p pod2 -s os-nosdn-nofeature-ha
  46
  47 -b and -i arguments should be expressed in URI style (eg: file://...
  48 or http://...). The resources can thus be local or remote.
  49
  50 Configuration repository structure
  51 ----------------------------------
  52 The CI deployment engine relies on a configuration directory/file structure
  53 pointed to by the -b option described above.
  54 Normally this points to the secure classified OPNFV securedlab repo to which
  55 only jenkins and andmins have access to, but you may point to any local or
  56 remote strcture fullfilling the diectory/file structure below.
  57 The reason that this configuration structure needs to be secure/hidden
  58 is that there are security sensitive information in the various configuration
  59 files.
  60
  61 FIXME: Below information is out of date and should be refreshed after PDF
  62 support is fully implemented.
  63
  64 A local stripped version of this configuration structure with virtual
  65 deployment configurations also exist under build/config/.
  66 Following configuration directory and file structure should adheare to:
  67
  68 TOP
  69 !
  70 +---- labs
  71        !
  72        +---- lab-name-1
  73        !        !
  74        !        +---- pod-name-1
  75        !        !        !
  76        !        !        +---- fuel
  77        !        !               !
  78        !        !               +---- config
  79        !        !                       !
  80        !        !                       +---- dea-pod-override.yaml
  81        !        !                       !
  82        !        !                       +---- dha.yaml
  83        !        !
  84        !        +---- pod-name-2
  85        !                 !
  86        !
  87        +---- lab-name-2
  88        !        !
  89
  90
  91 Creating a deployment scenario
  92 ------------------------------
  93 Please find deploy/scenario/README for instructions on how to create a new
  94 deployment scenario.