docker/services/README.rst

   1 ========
   2 services
   3 ========
   4
   5 A TripleO nested stack Heat template that encapsulates generic configuration
   6 data to configure a specific service. This generally includes everything
   7 needed to configure the service excluding the local bind ports which
   8 are still managed in the per-node role templates directly (controller.yaml,
   9 compute.yaml, etc.). All other (global) service settings go into
  10 the puppet/service templates.
  11
  12 Input Parameters
  13 ----------------
  14
  15 Each service may define its own input parameters and defaults.
  16 Operators will use the parameter_defaults section of any Heat
  17 environment to set per service parameters.
  18
  19 Config Settings
  20 ---------------
  21
  22 Each service may define a config_settings output variable which returns
  23 Hiera settings to be configured.
  24
  25 Steps
  26 -----
  27
  28 Each service may define an output variable which returns a puppet manifest
  29 snippet that will run at each of the following steps. Earlier manifests
  30 are re-asserted when applying latter ones.
  31
  32  * config_settings: Custom hiera settings for this service. These are
  33    used to generate configs.
  34
  35  * kolla_config: Contains YAML that represents how to map config files
  36    into the kolla container. This config file is typically mapped into
  37    the container itself at the /var/lib/kolla/config_files/config.json
  38    location and drives how kolla's external config mechanisms work.
  39
  40  * step_config: A puppet manifest that is used to step through the deployment
  41    sequence. Each sequence is given a "step" (via hiera('step') that provides
  42    information for when puppet classes should activate themselves.
  43
  44  * docker_compose:
  45
  46  * container_name:
  47
  48  * volumes:
  49
  50 Steps correlate to the following:
  51
  52    1) Service configuration generation with puppet.
  53
  54    2) Early Openstack Service setup (database init?)
  55
  56    3) Early containerized networking services startup (OVS)
  57
  58    4) Network configuration
  59
  60    5) General OpenStack Services
  61
  62    6) Service activation (Pacemaker)
  63
  64    7) Fencing (Pacemaker)
  65