From 17f4cf9e0290550bd43a081c63d021f030e9f12b Mon Sep 17 00:00:00 2001 From: Dan Prince Date: Tue, 7 Mar 2017 14:12:37 -0500 Subject: Update docs per new puppet_config interface This updates the docker/service README so that it correctly documents the current requirements of the new puppet_config interface. Change-Id: I0f3e00ea3cce24152475abf6df34f4836e32c9c8 --- docker/services/README.rst | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) (limited to 'docker') diff --git a/docker/services/README.rst b/docker/services/README.rst index 881a2a37..71b0d3d4 100644 --- a/docker/services/README.rst +++ b/docker/services/README.rst @@ -65,20 +65,29 @@ are re-asserted when applying latter ones. 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 -- cgit 1.2.3-korg