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