← Back to branch summary

~ubuntu-branches/ubuntu/wily/heat/wily

« back to all changes in this revision

Viewing changes to doc/source/template_guide/functions.rst

  • Committer: Package Import Robot
  • Author(s): Corey Bryant
  • Date: 2015-09-08 15:52:07 UTC
  • mfrom: (1.1.28)
  • Revision ID: package-import@ubuntu.com-20150908155207-zi2r1rckyrevr5u7
Tags: 1:5.0.0~b3-0ubuntu1
* New upstream milestone for OpenStack Liberty.
* d/control: Align (build-)depends with upstream.
* d/p/fix-dummy-resource-missing.patch: Dropped. Fixed in milestone.
* d/p/move-extensions.patch: Dropped. Fixed in milestone.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/template_guide/functions.rst
35
35
 
36
36
Usage
37
37
~~~~~
38
 
::
 
38
 
 
39
.. code-block:: yaml
39
40
 
40
41
  {Ref: my_server}
41
42
 
57
58
Usage
58
59
~~~~~
59
60
 
60
 
::
 
61
.. code-block:: yaml
61
62
 
62
63
  {"Fn::Base64": "convert this string please."}
63
64
 
85
86
Usage
86
87
~~~~~
87
88
 
88
 
::
 
89
.. code-block:: yaml
89
90
 
90
91
  Mapping:
91
92
    MyContacts:
112
113
Usage
113
114
~~~~~
114
115
 
115
 
::
 
116
.. code-block:: yaml
116
117
 
117
118
  {Fn::GetAtt: [my_server, PublicIp]}
118
119
 
132
133
 
133
134
Usage
134
135
~~~~~
135
 
::
 
136
 
 
137
.. code-block:: yaml
136
138
 
137
139
  {Fn::GetAZs: ""}
138
140
 
154
156
Usage
155
157
~~~~~
156
158
 
157
 
::
 
159
.. code-block:: yaml
158
160
 
159
161
  {Fn::Join: [",", ["beer", "wine", "more beer"]]}
160
162
 
179
181
~~~~~
180
182
 
181
183
For a list lookup:
182
 
::
 
184
 
 
185
.. code-block:: yaml
183
186
 
184
187
  { "Fn::Select" : [ "2", [ "apples", "grapes", "mangoes" ] ] }
185
188
 
186
189
Returns ``mangoes``.
187
190
 
188
191
For a map lookup:
189
 
::
 
192
 
 
193
.. code-block:: yaml
190
194
 
191
195
  { "Fn::Select" : [ "red", {"red": "a", "flu": "b"} ] }
192
196
 
208
212
 
209
213
Usage
210
214
~~~~~
211
 
::
 
215
 
 
216
.. code-block:: yaml
212
217
 
213
218
  { "Fn::Split" : [ ",", "str1,str2,str3,str4"]}
214
219
 
228
233
 
229
234
Usage
230
235
~~~~~
231
 
::
 
236
 
 
237
.. code-block:: yaml
232
238
 
233
239
  {"Fn::Replace": [
234
240
   {'$var1': 'foo', '%var2%': 'bar'},
254
260
Usage
255
261
~~~~~
256
262
 
257
 
::
 
263
.. code-block:: yaml
258
264
 
259
265
  {'Fn::ResourceFacade': 'Metadata'}
260
266
  {'Fn::ResourceFacade': 'DeletionPolicy'}
265
271
~~~~~~~
266
272
Here is a top level template ``top.yaml``
267
273
 
268
 
::
 
274
.. code-block:: yaml
269
275
 
270
276
  resources:
271
277
    my_server:
276
282
 
277
283
 
278
284
Here is a resource template ``my_actual_server.yaml``
279
 
::
 
285
 
 
286
.. code-block:: yaml
280
287
 
281
288
  resources:
282
289
    _actual_server_:
284
291
      metadata: {'Fn::ResourceFacade': Metadata}
285
292
 
286
293
The environment file ``env.yaml``
287
 
::
 
294
 
 
295
.. code-block:: yaml
288
296
 
289
297
  resource_registry:
290
298
    resources:
320
328
 
321
329
Usage
322
330
~~~~~
323
 
::
 
331
 
 
332
.. code-block:: yaml
324
333
 
325
334
  {'Fn::MemberListToMap': ['Name', 'Value', ['.member.0.Name=key',
326
335
                                             '.member.0.Value=door',