diff options
| author | Angus Salkeld <asalkeld@mirantis.com> | 2014-11-24 12:38:30 +1000 |
|---|---|---|
| committer | Angus Salkeld <asalkeld@mirantis.com> | 2014-12-15 09:44:11 +1000 |
| commit | 08431c7c0601f64e6f0477dd502bf912eba8529b (patch) | |
| tree | 311f789278066da27db8b568898dc32f6153ce33 /doc | |
| parent | e1540f834c7b12cfad67931b2dac3eef4ed4ea54 (diff) | |
| download | heat-08431c7c0601f64e6f0477dd502bf912eba8529b.tar.gz | |
Add "parameter_defaults" to the environment
This give the user a way to set defaults recursively down nested stacks
without having to create the parameter in every template (it's ignored
if the template does not have the parameter).
blueprint env-nested-usability
Change-Id: Ie6b4481417204a527d322fd532c341b9acbce473
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/template_guide/environment.rst | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/source/template_guide/environment.rst b/doc/source/template_guide/environment.rst index 877b19f2b..6c46c4b1c 100644 --- a/doc/source/template_guide/environment.rst +++ b/doc/source/template_guide/environment.rst @@ -29,8 +29,8 @@ what plug-ins the cloud operator has installed. Format ------ -It is a yaml text file with two main sections "resource_registry" and -"parameters". +It is a yaml text file with three main sections "resource_registry", +"parameters" and "parameter_defaults". ------------------ Command line usage @@ -81,8 +81,18 @@ Usage examples InstanceType: m1.micro ImageId: F18-x86_64-cfntools +2) Define defaults to parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is especially useful when you have many template resources and +you want the same value in each. Note: these defaults will get passed +down into all template resources. +:: + + parameter_defaults: + KeyName: heat_key + -2) Deal with the mapping of Quantum to Neutron +3) Deal with the mapping of Quantum to Neutron ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: @@ -92,7 +102,7 @@ Usage examples So all existing resources which can be matched with "OS::Neutron*" will be mapped to "OS::Quantum*" accordingly. -3) Override a resource type with a custom template resource +4) Override a resource type with a custom template resource ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: @@ -103,7 +113,7 @@ Please note that the template resource URL here must end with ".yaml" or ".template", or it will not be treated as a custom template resource. The supported URL types are "http, https and file". -4) Always map resource type X to Y +5) Always map resource type X to Y ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: @@ -111,7 +121,7 @@ resource. The supported URL types are "http, https and file". "OS::Networking::FloatingIP": "OS::Nova::FloatingIP" -5) Use default resources except one for a particular resource in the template +6) Use default resources except one for a particular resource in the template ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: |