Merge "Move ironic into services-docker"

[apex-tripleo-heat-templates.git] / docker / services / README.rst

diff --git a/docker/services/README.rst b/docker/services/README.rst
index c054e8c..219f35e 100644 (file)
--- a/docker/services/README.rst
+++ b/docker/services/README.rst
@@ -19,8 +19,11 @@ Building Kolla Images
 
 TripleO currently relies on Kolla docker containers. Kolla supports container
 customization and we are making use of this feature within TripleO to inject
 
 TripleO currently relies on Kolla docker containers. Kolla supports container
 customization and we are making use of this feature within TripleO to inject

-puppet (our configuration tool of choice) into the Kolla base images. To
-build Kolla images for TripleO adjust your kolla config to build your
+puppet (our configuration tool of choice) into the Kolla base images. The
+undercloud nova-scheduler also requires openstack-tripleo-common to
+provide custom filters.
+
+To build Kolla images for TripleO adjust your kolla config to build your

 centos base image with puppet using the example below:
 
 .. code-block::
 centos base image with puppet using the example below:
 
 .. code-block::


@@ -28,6 +31,7 @@ centos base image with puppet using the example below:
 $ cat template-overrides.j2
 {% extends parent_template %}
 {% set base_centos_binary_packages_append = ['puppet'] %}
 $ cat template-overrides.j2
 {% extends parent_template %}
 {% set base_centos_binary_packages_append = ['puppet'] %}

+{% set nova_scheduler_packages_append = ['openstack-tripleo-common'] %}

 
 kolla-build --base centos --template-override template-overrides.j2
 
 
 kolla-build --base centos --template-override template-overrides.j2
 


@@ -54,27 +58,34 @@ are re-asserted when applying latter ones.
    the container itself at the /var/lib/kolla/config_files/config.json
    location and drives how kolla's external config mechanisms work.
 
    the container itself at the /var/lib/kolla/config_files/config.json
    location and drives how kolla's external config mechanisms work.
 

- * docker_image: The full name of the docker image that will be used.
-

  * docker_config: Data that is passed to the docker-cmd hook to configure
    a container, or step of containers at each step. See the available steps
    below and the related docker-cmd hook documentation in the heat-agents
    project.
 
  * docker_config: Data that is passed to the docker-cmd hook to configure
    a container, or step of containers at each step. See the available steps
    below and the related docker-cmd hook documentation in the heat-agents
    project.
 

- * puppet_tags: Puppet resource tag names that are used to generate config
-   files with puppet. Only the named config resources are used to generate
-   a config file. Any service that specifies tags will have the default
-   tags of 'file,concat,file_line' appended to the setting.
-   Example: keystone_config
-
- * config_volume: The name of the volume (directory) where config files
-   will be generated for this service. Use this as the location to
-   bind mount into the running Kolla container for configuration.
-
- * config_image: The name of the docker image that will be used for
-   generating configuration files. This is often the same value as
-   'docker_image' above but some containers share a common set of
-   config files which are generated in a common base container.
+ * puppet_config: This section is a nested set of key value pairs
+   that drive the creation of config files using puppet.
+   Required parameters include:
+
+     * puppet_tags: Puppet resource tag names that are used to generate config
+       files with puppet. Only the named config resources are used to generate
+       a config file. Any service that specifies tags will have the default
+       tags of 'file,concat,file_line' appended to the setting.
+       Example: keystone_config
+
+     * config_volume: The name of the volume (directory) where config files
+       will be generated for this service. Use this as the location to
+       bind mount into the running Kolla container for configuration.
+
+     * config_image: The name of the docker image that will be used for
+       generating configuration files. This is often the same container
+       that the runtime service uses. Some services share a common set of
+       config files which are generated in a common base container.
+
+     * step_config: This setting controls the manifest that is used to
+       create docker config files via puppet. The puppet tags below are
+       used along with this manifest to generate a config directory for
+       this container.

 
  * docker_puppet_tasks: This section provides data to drive the
    docker-puppet.py tool directly. The task is executed only once
 
  * docker_puppet_tasks: This section provides data to drive the
    docker-puppet.py tool directly. The task is executed only once