bootstrap/vagrant-onap/doc/source/features/configure_execution.rst

   1 =======================
   2 Modify execution values
   3 =======================
   4
   5 In order to provide a flexible platform that adjusts to different developer
   6 needs, there are two mechanisms to configure the execution of this project.
   7
   8 Settings configuration file
   9 ---------------------------
  10
  11 The first mechanism refers to the process to replace default configuration
  12 values in the settings configuration file. This file needs to be placed into
  13 the *./etc* folder and named *settings.yaml*. It must contain the key/pair
  14 configuration values that will be overriden.
  15
  16 .. note::
  17
  18     There are sample files (e. g. settings.yaml.development and
  19     settings.yaml.testing) placed into the *./etc* folder. Their purpose is to
  20     provide a reference of different configurations.
  21
  22 .. end
  23
  24 Configuration values:
  25
  26 +------------------+-------------------+---------------------------------------+
  27 | Key              | Values            | Description                           |
  28 +==================+===================+=======================================+
  29 | build_image      | "True" or "False" | Determines if the Docker image is     |
  30 |                  |                   | retrieved from public hub or built    |
  31 |                  |                   | from source code.                     |
  32 +------------------+-------------------+---------------------------------------+
  33 | clone_repo       | "True" or "False" | Determines if all the source code     |
  34 |                  |                   | repositories of a given component are |
  35 |                  |                   | cloned locally.                       |
  36 +------------------+-------------------+---------------------------------------+
  37 | compile_repo     | "True" or "False" | Determines if all the source code     |
  38 |                  |                   | repositories of a given component are |
  39 |                  |                   | going to be compiled.                 |
  40 +------------------+-------------------+---------------------------------------+
  41 | enable_oparent   | "True" or "False" | Determines if the OParent project     |
  42 |                  |                   | will be used during the maven         |
  43 |                  |                   | compilation.                          |
  44 +------------------+-------------------+---------------------------------------+
  45 | skip_get_images  | "True" or "False" | Determines if the process to build or |
  46 |                  |                   | retrieve docker images of a given     |
  47 |                  |                   | component are going to skipped.       |
  48 +------------------+-------------------+---------------------------------------+
  49 | skip_install     | "True" or "False" | Determines if the process to start    |
  50 |                  |                   | the services of a given component     |
  51 |                  |                   | will be started.                      |
  52 +------------------+-------------------+---------------------------------------+
  53
  54 Parameters
  55 ----------
  56
  57 The **skip_get_images** and **skip_install** are the only two configuration
  58 values that can be overriden using *-g* and *-i* respectively by the run scripts
  59 (*./tools/run.sh* and *.\\tools\\Run.ps1*).
  60
  61 .. note::
  62
  63     The script parameters take precendence of the configuration file.
  64
  65 .. end
  66
  67 .. code-block:: console
  68
  69    $ ./tools/run.sh sdc -g
  70
  71 .. end
  72