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