docker/services/README.rst

   1 ===============
   2 Docker Services
   3 ===============
   4
   5 TripleO docker services are currently built on top of the puppet services.
   6 To do this each of the docker services includes the output of the
   7 t-h-t puppet/service templates where appropriate.
   8
   9 In general global docker specific service settings should reside in these
  10 templates (templates in the docker/services directory.) The required and
  11 optional items are specified in the docker settings section below.
  12
  13 If you are adding a config setting that applies to both docker and
  14 baremetal that setting should (so long as we use puppet) go into the
  15 puppet/services templates themselves.
  16
  17 Building Kolla Images
  18 ---------------------
  19
  20 TripleO currently relies on Kolla docker containers. Kolla supports container
  21 customization and we are making use of this feature within TripleO to inject
  22 puppet (our configuration tool of choice) into the Kolla base images. The
  23 undercloud nova-scheduler also requires openstack-tripleo-common to
  24 provide custom filters.
  25
  26 To build Kolla images for TripleO adjust your kolla config to build your
  27 centos base image with puppet using the example below:
  28
  29 .. code-block::
  30
  31 $ cat template-overrides.j2
  32 {% extends parent_template %}
  33 {% set base_centos_binary_packages_append = ['puppet'] %}
  34 {% set nova_scheduler_packages_append = ['openstack-tripleo-common'] %}
  35
  36 kolla-build --base centos --template-override template-overrides.j2
  37
  38 ..
  39
  40
  41 Docker settings
  42 ---------------
  43 Each service may define an output variable which returns a puppet manifest
  44 snippet that will run at each of the following steps. Earlier manifests
  45 are re-asserted when applying latter ones.
  46
  47  * config_settings: This setting is generally inherited from the
  48    puppet/services templates and only need to be appended
  49    to on accasion if docker specific config settings are required.
  50
  51  * step_config: This setting controls the manifest that is used to
  52    create docker config files via puppet. The puppet tags below are
  53    used along with this manifest to generate a config directory for
  54    this container.
  55
  56  * kolla_config: Contains YAML that represents how to map config files
  57    into the kolla container. This config file is typically mapped into
  58    the container itself at the /var/lib/kolla/config_files/config.json
  59    location and drives how kolla's external config mechanisms work.
  60
  61  * docker_image: The full name of the docker image that will be used.
  62
  63  * docker_config: Data that is passed to the docker-cmd hook to configure
  64    a container, or step of containers at each step. See the available steps
  65    below and the related docker-cmd hook documentation in the heat-agents
  66    project.
  67
  68  * puppet_tags: Puppet resource tag names that are used to generate config
  69    files with puppet. Only the named config resources are used to generate
  70    a config file. Any service that specifies tags will have the default
  71    tags of 'file,concat,file_line' appended to the setting.
  72    Example: keystone_config
  73
  74  * config_volume: The name of the volume (directory) where config files
  75    will be generated for this service. Use this as the location to
  76    bind mount into the running Kolla container for configuration.
  77
  78  * config_image: The name of the docker image that will be used for
  79    generating configuration files. This is often the same value as
  80    'docker_image' above but some containers share a common set of
  81    config files which are generated in a common base container.
  82
  83  * docker_puppet_tasks: This section provides data to drive the
  84    docker-puppet.py tool directly. The task is executed only once
  85    within the cluster (not on each node) and is useful for several
  86    puppet snippets we require for initialization of things like
  87    keystone endpoints, database users, etc. See docker-puppet.py
  88    for formatting.
  89
  90 Docker steps
  91 ------------
  92 Similar to baremetal docker containers are brought up in a stepwise manner.
  93 The current architecture supports bringing up baremetal services alongside
  94 of containers. For each step the baremetal puppet manifests are executed
  95 first and then any docker containers are brought up afterwards.
  96
  97 Steps correlate to the following:
  98
  99    Pre) Containers config files generated per hiera settings.
 100    1) Load Balancer configuration baremetal
 101      a) step 1 baremetal
 102      b) step 1 containers
 103    2) Core Services (Database/Rabbit/NTP/etc.)
 104      a) step 2 baremetal
 105      b) step 2 containers
 106    3) Early Openstack Service setup (Ringbuilder, etc.)
 107      a) step 3 baremetal
 108      b) step 3 containers
 109    4) General OpenStack Services
 110      a) step 4 baremetal
 111      b) step 4 containers
 112      c) Keystone containers post initialization (tenant,service,endpoint creation)
 113    5) Service activation (Pacemaker)
 114      a) step 5 baremetal
 115      b) step 5 containers