openstack
/
heat
Code Issues Proposed changes

Document the availability of OS::stack_name and OS::stack_id 

Add documentation about the availablility of HOT pseudo parameters
and how to access them.

Implements: blueprint make-stack-name-available-in-template
Change-Id: Iee07aba5cf1b24321191f04282eb0c89a54382cb
This commit is contained in:
Randall Burt 2014-04-22 12:18:02 -05:00
parent 0529c3823f
commit fe158d3d22
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/template_guide/hot_spec.rst
View File

@ -382,6 +382,16 @@ For example:
constraints:
- custom_constraint: nova.keypair
.. _hot_spec_pseudo_parameters
Pseudo Parameters
-----------------
In addition to parameters defined by a template author, Heat also creates two
parameters for every stack that allow referential access to the stack's name
and identifier. These parameters are named ``OS::stack_name`` for the stack
name and ``OS::stack_id`` for the stack identifier. These values are accessible
via the `get_param`_ intrinsic function just like user-defined parameters.
.. _hot_spec_resources: