1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
##############################################################################
# Copyright (c) 2016 Ericsson AB and others.
# peter.barabas@ericsson.com
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
======== TEMPLATING SUPPORT IN YAML CONFIGURATION FILES ========
deploy/templater.py makes it possible to use templates to generate configuration
files. It takes 2 input YAML files and an output file as arguments. One being
the dictionary (called the base file), which is used to look up values in; the
other file is the template, where the substitution will take place. Templater
will write the result to an output file, specified as the 3rd argument.
======== SYNTAX OF TEMPLATE FILES ========
A template file can contain any valid YAML data and template variables, whose
syntax is described below:
1. Single value references
%{title}
%{environment/net_segment_type}
Either a root element, or a path can be specified.
2. YAML sections
%{nodes}
%{network/networking_parameters}
Either a root element, or a path can be specified.
3. Interface lookup for network
%{interface(storage)}
Specify a network type as argument to interface().
4. Interface lookup for network and role
%{interface(public,compute)}
Specify a network type and a role as arguments to interface().
5. File inclusion
%{include(templates/interfaces.yaml)}
Filename with absolute or relative path.
======== EXAMPLES ========
Base YAML file (excerpt):
title: Deployment Environment Adapter (DEA)
version: 1.1
created: Wed Mar 30 08:16:04 2016
environment:
name: vCity
net_segment_type: tun
wanted_release: Liberty on Ubuntu 14.04
nodes:
- id: 1
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 2
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 3
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 4
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
- id: 5
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
- id: 6
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
interfaces_1:
ens3:
- fuelweb_admin
- management
ens4:
- storage
ens5:
- private
ens6:
- public
interfaces_2:
ens3:
- fuelweb_admin
- management
ens4:
- storage
- private
- public
network:
networks:
- cidr: 172.16.0.0/24
gateway: 172.16.0.1
ip_ranges:
- - 172.16.0.2
- 172.16.0.126
meta:
cidr: 172.16.0.0/24
configurable: true
floating_range_var: floating_ranges
ip_range:
- 172.16.0.2
- 172.16.0.126
map_priority: 1
name: public
notation: ip_ranges
render_addr_mask: public
render_type: null
use_gateway: true
vips:
- haproxy
- vrouter
vlan_start: null
name: public
vlan_start: null
- cidr: 192.168.1.0/24
gateway: null
ip_ranges:
- - 192.168.1.1
- 192.168.1.254
meta:
cidr: 192.168.1.0/24
configurable: true
map_priority: 2
name: storage
notation: cidr
render_addr_mask: storage
render_type: cidr
use_gateway: false
vlan_start: 102
name: storage
vlan_start: 102
--- Example 1 ---
Template file:
deployment-scenario-metadata:
title: %{title}
version: 0.1
dea-override-config:
environment:
net_segment_type: %{environment/net_segment_type}
nodes:
%{nodes}
Result:
deployment-scenario-metadata:
title: Deployment Environment Adapter (DEA)
version: 0.1
dea-override-config:
environment:
net_segment_type: tun
nodes:
- id: 1
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 2
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 3
interfaces: interfaces_1
role: ceph-osd,compute
transformations: transformations_1
- id: 4
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
- id: 5
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
- id: 6
interfaces: interfaces_2
role: controller,mongo
transformations: transformations_2
--- Example 2 ---
Template file:
dea-override-config:
network:
networks:
%{network/networks}
Result:
dea-override-config:
network:
networks:
- cidr: 172.16.0.0/24
gateway: 172.16.0.1
ip_ranges:
- - 172.16.0.2
- 172.16.0.126
meta:
cidr: 172.16.0.0/24
configurable: true
floating_range_var: floating_ranges
ip_range:
- 172.16.0.2
- 172.16.0.126
map_priority: 1
name: public
notation: ip_ranges
render_addr_mask: public
render_type: null
use_gateway: true
vips:
- haproxy
- vrouter
vlan_start: null
name: public
vlan_start: null
- cidr: 192.168.1.0/24
gateway: null
ip_ranges:
- - 192.168.1.1
- 192.168.1.254
meta:
cidr: 192.168.1.0/24
configurable: true
map_priority: 2
name: storage
notation: cidr
render_addr_mask: storage
render_type: cidr
use_gateway: false
vlan_start: 102
name: storage
vlan_start: 102
--- Example 3 ---
Template file:
storage_if: %{interface(storage)}
compute_private_if: %{interface(private,compute)}
# Management interface of a mongo node
mongo_mgmt_if: %{interface(management,mongo)}
controller_private_if: %{interface(private,controller)}
Result:
storage_if: ens4
compute_private_if: ens5
# Management interface of a mongo node
mongo_mgmt_if: ens3
controller_private_if: ens4
--- Example 4 ---
Template file:
version: 1.1
created: Mon Jun 13 19:39:35 2016
comment: None
%{include(environment.yaml)}
environment.yaml:
environment:
name: F9-NOSDN-NOFEATURE-VXLAN-BAREMETAL
net_segment_type: tun
Result:
version: 1.1
created: Mon Jun 13 19:39:35 2016
comment: None
environment:
name: F9-NOSDN-NOFEATURE-VXLAN-BAREMETAL
net_segment_type: tun
--- Example 5 ---
Template file (except):
settings:
editable:
access:
email:
description: Email address for Administrator
label: Email
regex:
error: Invalid email
source: ^\S+@\S+$
type: text
value: admin@localhost
weight: 40
# ...
# lines omitted for brevity
%{include(templates/cgroups.yaml)}
cgroups.yaml:
cgroups:
metadata:
always_editable: true
group: general
label: Cgroups conguration for services
restrictions:
- action: hide
condition: 'true'
weight: 90
Result:
settings:
editable:
access:
email:
description: Email address for Administrator
label: Email
regex:
error: Invalid email
source: ^\S+@\S+$
type: text
value: admin@localhost
weight: 40
# ...
# again, lines omitted for brevity
cgroups:
metadata:
always_editable: true
group: general
label: Cgroups conguration for services
restrictions:
- action: hide
condition: 'true'
weight: 90
|
