summaryrefslogtreecommitdiffstats
path: root/puppet
diff options
context:
space:
mode:
authorSaravanan KR <skramaja@redhat.com>2017-05-15 17:52:18 +0530
committerSaravanan KR <skramaja@redhat.com>2017-05-15 17:52:18 +0530
commitf0affa369ccb84ef4ff51e01e8d8cf31a740b700 (patch)
treefa8e4a8fb3a83612d168b40fc110320fd5ded88e /puppet
parent16cae1759fe5606d15a33d31f962ca757f499e1e (diff)
Update the services README documentation
Service template's parameter documentation has been update by correcting few of the wrong informations and added more information with examples. Change-Id: I2d92fd01cbeb6fdc6f030255dc4b71166509b4f6
Diffstat (limited to 'puppet')
-rw-r--r--puppet/services/README.rst32
1 files changed, 23 insertions, 9 deletions
diff --git a/puppet/services/README.rst b/puppet/services/README.rst
index 0fb1da65..7a18ef0c 100644
--- a/puppet/services/README.rst
+++ b/puppet/services/README.rst
@@ -19,21 +19,35 @@ environment to set per service parameters.
Apart from sevice specific inputs, there are few default parameters for all
the services. Following are the list of default parameters:
- * ServiceNetMap: Mapping of service_name -> network name. Typically set via
- parameter_defaults in the resource registry. This mapping overrides those
- in ServiceNetMapDefaults.
+ * ServiceNetMap: Mapping of service_name -> network name. Default mappings
+ for service to network names are defined in
+ ../network/service_net_map.j2.yaml, which may be overridden via
+ ServiceNetMap values added to a user environment file via
+ parameter_defaults.
- * EndpointMap: Mapping of service endpoint -> protocol. Typically set via
- parameter_defaults in the resource registry.
+ * EndpointMap: Mapping of service endpoint -> protocol. Contains a mapping of
+ endpoint data generated for all services, based on the data included in
+ ../network/endpoints/endpoint_data.yaml.
- * DefaultPasswords: Mapping of service -> default password. Used to help pass
- top level passwords managed by Heat into services.
+ * DefaultPasswords: Mapping of service -> default password. Used to pass some
+ passwords from the parent templates, this is a legacy interface and should
+ not be used by new services.
* RoleName: Name of the role on which this service is deployed. A service can
- be deployed in multiple roles.
+ be deployed in multiple roles. This is an internal parameter (should not be
+ set via environment file), which is fetched from the name attribute of the
+ roles_data.yaml template.
* RoleParameters: Parameter specific to a role on which the service is
- applied.
+ applied. Using the format "<RoleName>Parameters" in the parameter_defaults
+ of user environment file, parameters can be provided for a specific role.
+ For example, in order to provide a parameter specific to "Compute" role,
+ below is the format::
+
+ parameter_defaults:
+ ComputeParameters:
+ Param1: value
+
Config Settings
---------------