aboutsummaryrefslogtreecommitdiffstats
path: root/puppet/services/README.rst
diff options
context:
space:
mode:
authorMichele Baldessari <michele@acksyn.org>2017-02-20 20:18:50 +0100
committerMichele Baldessari <michele@acksyn.org>2017-02-21 22:16:05 +0100
commit8974f54eb97bbc7397b933e5f74e1aa9b56f19f6 (patch)
treead8697038e9800841251f8679230c4b0d3ca528d /puppet/services/README.rst
parent8c4b42a363c97d2d61edda788d2e5af534e01fbd (diff)
Improve the README for the _setting keys
It is not entirely clear to someone writing their own templates how to distribute hiera keys to different roles. Let's clear this up with a more extensive description. Change-Id: I02224389c2de90bc5534bce764e5e9d3bb23538f
Diffstat (limited to 'puppet/services/README.rst')
-rw-r--r--puppet/services/README.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/puppet/services/README.rst b/puppet/services/README.rst
index 9c2d8c5c..e5c11535 100644
--- a/puppet/services/README.rst
+++ b/puppet/services/README.rst
@@ -19,8 +19,21 @@ environment to set per service parameters.
Config Settings
---------------
-Each service may define a config_settings output variable which returns
-Hiera settings to be configured.
+Each service may define three ways in which to output variables to configure Hiera
+settings on the nodes.
+
+ * config_settings: the hiera keys will be pushed on all roles of which the service
+ is a part of.
+
+ * global_config_settings: the hiera keys will be distributed to all roles
+
+ * service_config_settings: Takes an extra key to wire in values that are
+ defined for a service that need to be consumed by some other service.
+ For example:
+ service_config_settings:
+ haproxy:
+ foo: bar
+ This will set the hiera key 'foo' on all roles where haproxy is included.
Deployment Steps
----------------