summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorCrag Wolfe <cwolfe@redhat.com>2016-08-23 19:44:43 -0400
committerCrag Wolfe <cwolfe@redhat.com>2017-04-21 19:08:20 -0700
commit1f8d70346a610133cf8c0aa82e11afbffabc3071 (patch)
tree8c6790315668116cba80df868290488fa3721a06 /doc/source
parent2111551d50b85c8349a8ecff0a1e8679d8a64880 (diff)
downloadheat-1f8d70346a610133cf8c0aa82e11afbffabc3071.tar.gz
Add the HOT fuction str_replace_vstrict
The already existing str_replace_strict function raises an error if a param is not present in the template. str_replace_vstrict, newly added in this patch, is identical but also raises an error if any of the params have an empty value. Change-Id: I5407135cc0435cfbad2d18964fe2119c999f67a3
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/template_guide/hot_spec.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/source/template_guide/hot_spec.rst b/doc/source/template_guide/hot_spec.rst
index 7f9f8e7d7..c5548282b 100644
--- a/doc/source/template_guide/hot_spec.rst
+++ b/doc/source/template_guide/hot_spec.rst
@@ -294,8 +294,9 @@ for the ``heat_template_version`` key:
The key with value ``2017-09-01`` or ``pike`` indicates that the YAML
document is a HOT template and it may contain features added and/or removed
up until the Pike release. This version adds the ``make_url`` function for
- assembling URLs and the ``list_concat`` function for combining multiple
- lists. The complete list of supported functions is::
+ assembling URLs, the ``list_concat`` function for combining multiple
+ lists, and ``string_replace_vstrict`` which raises errors for
+ missing and empty params. The complete list of supported functions is::
digest
filter
@@ -312,6 +313,7 @@ for the ``heat_template_version`` key:
resource_facade
str_replace
str_replace_strict
+ str_replace_vstrict
str_split
yaql
if
@@ -1494,6 +1496,15 @@ in the template. This may help catch typo's or other issues sooner
rather than later when processing a template.
+str_replace_vstrict
+------------------
+``str_replace_vstrict`` behaves identically to the
+``str_replace_strict`` function, only an error is raised if any of the
+params are empty. This may help catch issues (i.e., prevent
+resources from being created with bogus values) sooner rather than later if
+it is known that all the params should be non-empty.
+
+
str_split
---------
The ``str_split`` function allows for splitting a string into a list by