ad5e47948cb5e169823fba55f4aa3c8057d8104b
[apex-tripleo-heat-templates.git] / puppet / role.role.j2.yaml
1 heat_template_version: 2016-10-14
2 description: 'OpenStack {{role}} node configured by Puppet'
3 parameters:
4   Overcloud{{role}}Flavor:
5     description: Flavor for the {{role}} node.
6     default: baremetal
7     type: string
8     constraints:
9       - custom_constraint: nova.flavor
10   {{role}}Image:
11     type: string
12     default: overcloud-full
13     constraints:
14       - custom_constraint: glance.image
15   ImageUpdatePolicy:
16     default: 'REBUILD_PRESERVE_EPHEMERAL'
17     description: What policy to use when reconstructing instances. REBUILD for rebuilds, REBUILD_PRESERVE_EPHEMERAL to preserve /mnt.
18     type: string
19   KeyName:
20     description: Name of an existing Nova key pair to enable SSH access to the instances
21     type: string
22     default: default
23     constraints:
24       - custom_constraint: nova.keypair
25   ServiceNetMap:
26     default: {}
27     description: Mapping of service_name -> network name. Typically set
28                  via parameter_defaults in the resource registry.
29     type: json
30   EndpointMap:
31     default: {}
32     description: Mapping of service endpoint -> protocol. Typically set
33                  via parameter_defaults in the resource registry.
34     type: json
35   UpdateIdentifier:
36     default: ''
37     type: string
38     description: >
39       Setting to a previously unused value during stack-update will trigger
40       package update on all nodes
41   Hostname:
42     type: string
43     default: '' # Defaults to Heat created hostname
44   HostnameMap:
45     type: json
46     default: {}
47     description: Optional mapping to override hostnames
48   ExtraConfig:
49     default: {}
50     description: |
51       Additional hiera configuration to inject into the cluster. Note
52       that {{role}}ExtraConfig takes precedence over ExtraConfig.
53     type: json
54   {{role}}ExtraConfig:
55     default: {}
56     description: |
57       Role specific additional hiera configuration to inject into the cluster.
58     type: json
59   {{role}}IPs:
60     default: {}
61     type: json
62   NetworkDeploymentActions:
63     type: comma_delimited_list
64     description: >
65       Heat action when to apply network configuration changes
66     default: ['CREATE']
67   SoftwareConfigTransport:
68     default: POLL_SERVER_CFN
69     description: |
70       How the server should receive the metadata required for software configuration.
71     type: string
72     constraints:
73     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
74   CloudDomain:
75     default: 'localdomain'
76     type: string
77     description: >
78       The DNS domain used for the hosts. This should match the dhcp_domain
79       configured in the Undercloud neutron. Defaults to localdomain.
80   ServerMetadata:
81     default: {}
82     description: >
83       Extra properties or metadata passed to Nova for the created nodes in
84       the overcloud. It's accessible via the Nova metadata API.
85     type: json
86   {{role}}SchedulerHints:
87     type: json
88     description: Optional scheduler hints to pass to nova
89     default: {}
90   NodeIndex:
91     type: number
92     default: 0
93   ServiceConfigSettings:
94     type: json
95     default: {}
96   ServiceNames:
97     type: comma_delimited_list
98     default: []
99   MonitoringSubscriptions:
100     type: comma_delimited_list
101     default: []
102   ConfigCommand:
103     type: string
104     description: Command which will be run whenever configuration data changes
105     default: os-refresh-config --timeout 14400
106   LoggingSources:
107     type: json
108     default: []
109   LoggingGroups:
110     type: comma_delimited_list
111     default: []
112
113 resources:
114   {{role}}:
115     type: OS::TripleO::Server
116     metadata:
117       os-collect-config:
118         command: {get_param: ConfigCommand}
119     properties:
120       image: {get_param: {{role}}Image}
121       image_update_policy: {get_param: ImageUpdatePolicy}
122       flavor: {get_param: Overcloud{{role}}Flavor}
123       key_name: {get_param: KeyName}
124       networks:
125         - network: ctlplane
126       user_data_format: SOFTWARE_CONFIG
127       user_data: {get_resource: UserData}
128       name:
129         str_replace:
130             template: {get_param: Hostname}
131             params: {get_param: HostnameMap}
132       software_config_transport: {get_param: SoftwareConfigTransport}
133       metadata: {get_param: ServerMetadata}
134       scheduler_hints: {get_param: {{role}}SchedulerHints}
135
136   # Combine the NodeAdminUserData and NodeUserData mime archives
137   UserData:
138     type: OS::Heat::MultipartMime
139     properties:
140       parts:
141       - config: {get_resource: NodeAdminUserData}
142         type: multipart
143       - config: {get_resource: NodeUserData}
144         type: multipart
145
146   # Creates the "heat-admin" user if configured via the environment
147   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
148   NodeAdminUserData:
149     type: OS::TripleO::NodeAdminUserData
150
151   # For optional operator additional userdata
152   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
153   NodeUserData:
154     type: OS::TripleO::NodeUserData
155
156   ExternalPort:
157     type: OS::TripleO::{{role}}::Ports::ExternalPort
158     properties:
159       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
160       IPPool: {get_param: {{role}}IPs}
161       NodeIndex: {get_param: NodeIndex}
162
163   InternalApiPort:
164     type: OS::TripleO::{{role}}::Ports::InternalApiPort
165     properties:
166       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
167       IPPool: {get_param: {{role}}IPs}
168       NodeIndex: {get_param: NodeIndex}
169
170   StoragePort:
171     type: OS::TripleO::{{role}}::Ports::StoragePort
172     properties:
173       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
174       IPPool: {get_param: {{role}}IPs}
175       NodeIndex: {get_param: NodeIndex}
176
177   StorageMgmtPort:
178     type: OS::TripleO::{{role}}::Ports::StorageMgmtPort
179     properties:
180       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
181       IPPool: {get_param: {{role}}IPs}
182       NodeIndex: {get_param: NodeIndex}
183
184   TenantPort:
185     type: OS::TripleO::{{role}}::Ports::TenantPort
186     properties:
187       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
188       IPPool: {get_param: {{role}}IPs}
189       NodeIndex: {get_param: NodeIndex}
190
191   ManagementPort:
192     type: OS::TripleO::{{role}}::Ports::ManagementPort
193     properties:
194       ControlPlaneIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
195       IPPool: {get_param: {{role}}IPs}
196       NodeIndex: {get_param: NodeIndex}
197
198   NetworkConfig:
199     type: OS::TripleO::{{role}}::Net::SoftwareConfig
200     properties:
201       ControlPlaneIp: {get_attr: [{{role}}, networks, ctlplane, 0]}
202       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
203       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
204       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
205       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
206       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
207       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
208
209   NetIpMap:
210     type: OS::TripleO::Network::Ports::NetIpMap
211     properties:
212       ControlPlaneIp: {get_attr: [{{role}}, networks, ctlplane, 0]}
213       ExternalIp: {get_attr: [ExternalPort, ip_address]}
214       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
215       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
216       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
217       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
218       InternalApiIpUri: {get_attr: [InternalApiPort, ip_address_uri]}
219       StorageIp: {get_attr: [StoragePort, ip_address]}
220       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
221       StorageIpUri: {get_attr: [StoragePort, ip_address_uri]}
222       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
223       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
224       StorageMgmtIpUri: {get_attr: [StorageMgmtPort, ip_address_uri]}
225       TenantIp: {get_attr: [TenantPort, ip_address]}
226       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
227       TenantIpUri: {get_attr: [TenantPort, ip_address_uri]}
228       ManagementIp: {get_attr: [ManagementPort, ip_address]}
229       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
230       ManagementIpUri: {get_attr: [ManagementPort, ip_address_uri]}
231
232   NetworkDeployment:
233     type: OS::TripleO::SoftwareDeployment
234     properties:
235       name: NetworkDeployment
236       config: {get_resource: NetworkConfig}
237       server: {get_resource: {{role}}}
238       actions: {get_param: NetworkDeploymentActions}
239
240   {{role}}Deployment:
241     type: OS::Heat::StructuredDeployment
242     depends_on: NetworkDeployment
243     properties:
244       name: {{role}}Deployment
245       config: {get_resource: {{role}}Config}
246       server: {get_resource: {{role}}}
247       input_values:
248         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
249
250   {{role}}Config:
251     type: OS::Heat::StructuredConfig
252     properties:
253       group: os-apply-config
254       config:
255         hiera:
256           hierarchy:
257             - '"%{::uuid}"'
258             - heat_config_%{::deploy_config_name}
259             - {{role.lower()}}_extraconfig
260             - extraconfig
261             - service_names
262             - service_configs
263             - {{role.lower()}}
264             - bootstrap_node # provided by allNodesConfig
265             - all_nodes # provided by allNodesConfig
266             - vip_data # provided by allNodesConfig
267             - '"%{::osfamily}"'
268           merge_behavior: deeper
269           datafiles:
270             service_names:
271               mapped_data:
272                 service_names: {get_param: ServiceNames}
273                 sensu::subscriptions: {get_param: MonitoringSubscriptions}
274             service_configs:
275               mapped_data:
276                 map_replace:
277                   - {get_param: ServiceConfigSettings}
278                   - values: {get_attr: [NetIpMap, net_ip_map]}
279             {{role.lower()}}_extraconfig:
280               mapped_data: {get_param: {{role}}ExtraConfig}
281             extraconfig:
282               mapped_data: {get_param: ExtraConfig}
283             {{role.lower()}}:
284               mapped_data:
285                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
286                 tripleo::profile::base::logging::fluentd::fluentd_sources: {get_param: LoggingSources}
287                 tripleo::profile::base::logging::fluentd::fluentd_groups: {get_param: LoggingGroups}
288
289   # Resource for site-specific injection of root certificate
290   NodeTLSCAData:
291     depends_on: {{role}}Deployment
292     type: OS::TripleO::NodeTLSCAData
293     properties:
294       server: {get_resource: {{role}}}
295
296   # Hook for site-specific additional pre-deployment config, e.g extra hieradata
297   {{role}}ExtraConfigPre:
298     depends_on: {{role}}Deployment
299     type: OS::TripleO::{{role}}ExtraConfigPre
300     properties:
301         server: {get_resource: {{role}}}
302
303   # Hook for site-specific additional pre-deployment config,
304   # applying to all nodes, e.g node registration/unregistration
305   NodeExtraConfig:
306     depends_on: [{{role}}ExtraConfigPre, NodeTLSCAData]
307     type: OS::TripleO::NodeExtraConfig
308     properties:
309         server: {get_resource: {{role}}}
310
311   UpdateConfig:
312     type: OS::TripleO::Tasks::PackageUpdate
313
314   UpdateDeployment:
315     type: OS::Heat::SoftwareDeployment
316     properties:
317       config: {get_resource: UpdateConfig}
318       server: {get_resource: {{role}}}
319       input_values:
320         update_identifier:
321           get_param: UpdateIdentifier
322
323 outputs:
324   ip_address:
325     description: IP address of the server in the ctlplane network
326     value: {get_attr: [{{role}}, networks, ctlplane, 0]}
327   hostname:
328     description: Hostname of the server
329     value: {get_attr: [{{role}}, name]}
330   hostname_map:
331     description: Mapping of network names to hostnames
332     value:
333       external:
334         list_join:
335         - '.'
336         - - {get_attr: [{{role}}, name]}
337           - external
338           - {get_param: CloudDomain}
339       internal_api:
340         list_join:
341         - '.'
342         - - {get_attr: [{{role}}, name]}
343           - internalapi
344           - {get_param: CloudDomain}
345       storage:
346         list_join:
347         - '.'
348         - - {get_attr: [{{role}}, name]}
349           - storage
350           - {get_param: CloudDomain}
351       storage_mgmt:
352         list_join:
353         - '.'
354         - - {get_attr: [{{role}}, name]}
355           - storagemgmt
356           - {get_param: CloudDomain}
357       tenant:
358         list_join:
359         - '.'
360         - - {get_attr: [{{role}}, name]}
361           - tenant
362           - {get_param: CloudDomain}
363       management:
364         list_join:
365         - '.'
366         - - {get_attr: [{{role}}, name]}
367           - management
368           - {get_param: CloudDomain}
369       ctlplane:
370         list_join:
371         - '.'
372         - - {get_attr: [{{role}}, name]}
373           - ctlplane
374           - {get_param: CloudDomain}
375   hosts_entry:
376     value:
377       str_replace:
378         template: |
379           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
380           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
381           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
382           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
383           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
384           TENANTIP TENANTHOST.DOMAIN TENANTHOST
385           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
386           CTLPLANEIP CTLPLANEHOST.DOMAIN CTLPLANEHOST
387         params:
388           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, {{role}}HostnameResolveNetwork]}]}
389           DOMAIN: {get_param: CloudDomain}
390           PRIMARYHOST: {get_attr: [{{role}}, name]}
391           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
392           EXTERNALHOST:
393             list_join:
394             - '.'
395             - - {get_attr: [{{role}}, name]}
396               - external
397           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
398           INTERNAL_APIHOST:
399             list_join:
400             - '.'
401             - - {get_attr: [{{role}}, name]}
402               - internalapi
403           STORAGEIP: {get_attr: [StoragePort, ip_address]}
404           STORAGEHOST:
405             list_join:
406             - '.'
407             - - {get_attr: [{{role}}, name]}
408               - storage
409           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
410           STORAGE_MGMTHOST:
411             list_join:
412             - '.'
413             - - {get_attr: [{{role}}, name]}
414               - storagemgmt
415           TENANTIP: {get_attr: [TenantPort, ip_address]}
416           TENANTHOST:
417             list_join:
418             - '.'
419             - - {get_attr: [{{role}}, name]}
420               - tenant
421           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
422           MANAGEMENTHOST:
423             list_join:
424             - '.'
425             - - {get_attr: [{{role}}, name]}
426               - management
427           CTLPLANEIP: {get_attr: [{{role}}, networks, ctlplane, 0]}
428           CTLPLANEHOST:
429             list_join:
430             - '.'
431             - - {get_attr: [{{role}}, name]}
432               - ctlplane
433   nova_server_resource:
434     description: Heat resource handle for {{role}} server
435     value:
436       {get_resource: {{role}}}
437   external_ip_address:
438     description: IP address of the server in the external network
439     value: {get_attr: [ExternalPort, ip_address]}
440   internal_api_ip_address:
441     description: IP address of the server in the internal_api network
442     value: {get_attr: [InternalApiPort, ip_address]}
443   storage_ip_address:
444     description: IP address of the server in the storage network
445     value: {get_attr: [StoragePort, ip_address]}
446   storage_mgmt_ip_address:
447     description: IP address of the server in the storage_mgmt network
448     value: {get_attr: [StorageMgmtPort, ip_address]}
449   tenant_ip_address:
450     description: IP address of the server in the tenant network
451     value: {get_attr: [TenantPort, ip_address]}
452   management_ip_address:
453     description: IP address of the server in the management network
454     value: {get_attr: [ManagementPort, ip_address]}