puppet/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 Deployment 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.
  33
  34  * global_config_settings: Additional hiera settings distributed to all roles.
  35
  36  * step_config: A puppet manifest that is used to step through the deployment
  37    sequence. Each sequence is given a "step" (via hiera('step') that provides
  38    information for when puppet classes should activate themselves.
  39
  40    Steps correlate to the following:
  41
  42    1) Load Balancer configuration
  43
  44    2) Core Services (Database/Rabbit/NTP/etc.)
  45
  46    3) Early Openstack Service setup (Ringbuilder, etc.)
  47
  48    4) General OpenStack Services
  49
  50    5) Service activation (Pacemaker)
  51
  52 Upgrade Steps
  53 -------------
  54
  55 Each service template may optionally define a `upgrade_tasks` key, which is a
  56 list of ansible tasks to be performed during the upgrade process.
  57
  58 Similar to the step_config, we allow a series of steps for the per-service
  59 upgrade sequence, defined as ansible tasks with a tag e.g "step1" for the first
  60 step, "step2" for the second, etc.
  61
  62    Steps/tages correlate to the following:
  63
  64    1) Quiesce the control-plane, e.g disable LoadBalancer, stop pacemaker cluster
  65
  66    2) Stop all control-plane services, ready for upgrade
  67
  68    3) Perform a package update, (either specific packages or the whole system)
  69
  70    4) Start services needed for migration tasks (e.g DB)
  71
  72    5) Perform any migration tasks, e.g DB sync commands
  73
  74    6) Start control-plane services
  75
  76    7) Any additional online migration tasks (e.g data migrations)