openstack/heat
Code Issues Proposed changes

Fix documentation on Fn::Base64 function

Browse Source 
The documentation says that the 'Fn::Base64' function converts an
input string into Base64, while the implementation is actually a
pass-through.  This patch fixes the documentation to avoid confusions
caused to users.

Change-Id: I643e73f7ed258da06d09f17a3302a258e3303414
Closes-Bug: 1377323
This commit is contained in:
tengqm 2014-11-28 16:47:46 +08:00
parent 5596e63263
commit e11ecb4f43
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/template_guide/functions.rst
View File

@ -44,7 +44,10 @@ Returns the nova instance ID. For example, ``d8093de0-850f-4513-b202-7979de6c0d5
----------
Fn::Base64
----------
This returns the Base64 representation of the input string.
This is a placeholder for a function to convert an input string to Base64.
This function in Heat actually performs no conversion. It is included for
the benefit of CFN templates that convert UserData to Base64. Heat only
accepts UserData in plain text.
Parameters
~~~~~~~~~~
@ -56,9 +59,9 @@ Usage
::
{Base64: "convert this string please."}
{"Fn::Base64": "convert this string please."}
Returns the Base64 of the input string.
Returns the original input string.
-------------
Fn::FindInMap