Merge "Make scenario template paths relative"
[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     default: 'localdomain'
70     type: string
71     description: >
72       The DNS domain used for the hosts. This should match the dhcp_domain
73       configured in the Undercloud neutron. Defaults to localdomain.
74   ServerMetadata:
75     default: {}
76     description: >
77       Extra properties or metadata passed to Nova for the created nodes in
78       the overcloud. It's accessible via the Nova metadata API.
79     type: json
80   BlockStorageSchedulerHints:
81     type: json
82     description: Optional scheduler hints to pass to nova
83     default: {}
84   NodeIndex:
85     type: number
86     default: 0
87   ServiceConfigSettings:
88     type: json
89     default: {}
90   ServiceNames:
91     type: comma_delimited_list
92     default: []
93   MonitoringSubscriptions:
94     type: comma_delimited_list
95     default: []
96   ConfigCommand:
97     type: string
98     description: Command which will be run whenever configuration data changes
99     default: os-refresh-config --timeout 14400
100
101 resources:
102   BlockStorage:
103     type: OS::TripleO::Server
104     metadata:
105       os-collect-config:
106         command: {get_param: ConfigCommand}
107     properties:
108       image:
109         {get_param: BlockStorageImage}
110       flavor: {get_param: OvercloudBlockStorageFlavor}
111       key_name: {get_param: KeyName}
112       networks:
113         - network: ctlplane
114       user_data_format: SOFTWARE_CONFIG
115       user_data: {get_resource: UserData}
116       name:
117         str_replace:
118             template: {get_param: Hostname}
119             params: {get_param: HostnameMap}
120       software_config_transport: {get_param: SoftwareConfigTransport}
121       metadata: {get_param: ServerMetadata}
122       scheduler_hints: {get_param: BlockStorageSchedulerHints}
123
124   # Combine the NodeAdminUserData and NodeUserData mime archives
125   UserData:
126     type: OS::Heat::MultipartMime
127     properties:
128       parts:
129       - config: {get_resource: NodeAdminUserData}
130         type: multipart
131       - config: {get_resource: NodeUserData}
132         type: multipart
133
134   # Creates the "heat-admin" user if configured via the environment
135   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
136   NodeAdminUserData:
137     type: OS::TripleO::NodeAdminUserData
138
139   # For optional operator additional userdata
140   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
141   NodeUserData:
142     type: OS::TripleO::NodeUserData
143
144   ExternalPort:
145     type: OS::TripleO::BlockStorage::Ports::ExternalPort
146     properties:
147       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
148       IPPool: {get_param: BlockStorageIPs}
149       NodeIndex: {get_param: NodeIndex}
150
151   InternalApiPort:
152     type: OS::TripleO::BlockStorage::Ports::InternalApiPort
153     properties:
154       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
155       IPPool: {get_param: BlockStorageIPs}
156       NodeIndex: {get_param: NodeIndex}
157
158   StoragePort:
159     type: OS::TripleO::BlockStorage::Ports::StoragePort
160     properties:
161       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
162       IPPool: {get_param: BlockStorageIPs}
163       NodeIndex: {get_param: NodeIndex}
164
165   StorageMgmtPort:
166     type: OS::TripleO::BlockStorage::Ports::StorageMgmtPort
167     properties:
168       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
169       IPPool: {get_param: BlockStorageIPs}
170       NodeIndex: {get_param: NodeIndex}
171
172   TenantPort:
173     type: OS::TripleO::BlockStorage::Ports::TenantPort
174     properties:
175       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
176       IPPool: {get_param: BlockStorageIPs}
177       NodeIndex: {get_param: NodeIndex}
178
179   ManagementPort:
180     type: OS::TripleO::BlockStorage::Ports::ManagementPort
181     properties:
182       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
183       IPPool: {get_param: BlockStorageIPs}
184       NodeIndex: {get_param: NodeIndex}
185
186   NetworkConfig:
187     type: OS::TripleO::BlockStorage::Net::SoftwareConfig
188     properties:
189       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
190       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
191       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
192       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
193       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
194       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
195       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
196
197   NetIpMap:
198     type: OS::TripleO::Network::Ports::NetIpMap
199     properties:
200       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
201       ExternalIp: {get_attr: [ExternalPort, ip_address]}
202       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
203       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
204       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
205       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
206       InternalApiIpUri: {get_attr: [InternalApiPort, ip_address_uri]}
207       StorageIp: {get_attr: [StoragePort, ip_address]}
208       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
209       StorageIpUri: {get_attr: [StoragePort, ip_address_uri]}
210       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
211       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
212       StorageMgmtIpUri: {get_attr: [StorageMgmtPort, ip_address_uri]}
213       TenantIp: {get_attr: [TenantPort, ip_address]}
214       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
215       TenantIpUri: {get_attr: [TenantPort, ip_address_uri]}
216       ManagementIp: {get_attr: [ManagementPort, ip_address]}
217       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
218       ManagementIpUri: {get_attr: [ManagementPort, ip_address_uri]}
219
220   NetworkDeployment:
221     type: OS::TripleO::SoftwareDeployment
222     properties:
223       name: NetworkDeployment
224       config: {get_resource: NetworkConfig}
225       server: {get_resource: BlockStorage}
226       actions: {get_param: NetworkDeploymentActions}
227
228   BlockStorageDeployment:
229     type: OS::Heat::StructuredDeployment
230     depends_on: NetworkDeployment
231     properties:
232       name: BlockStorageDeployment
233       server: {get_resource: BlockStorage}
234       config: {get_resource: BlockStorageConfig}
235       input_values:
236         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
237
238   # Map heat metadata into hiera datafiles
239   BlockStorageConfig:
240     type: OS::Heat::StructuredConfig
241     properties:
242       group: hiera
243       config:
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             service_names: {get_param: ServiceNames}
260             sensu::subscriptions: {get_param: MonitoringSubscriptions}
261           service_configs:
262             map_replace:
263               - {get_param: ServiceConfigSettings}
264               - values: {get_attr: [NetIpMap, net_ip_map]}
265           volume_extraconfig: {get_param: BlockStorageExtraConfig}
266           extraconfig: {get_param: ExtraConfig}
267           volume:
268             tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
269
270   # Resource for site-specific injection of root certificate
271   NodeTLSCAData:
272     depends_on: BlockStorageDeployment
273     type: OS::TripleO::NodeTLSCAData
274     properties:
275       server: {get_resource: BlockStorage}
276
277   # Hook for site-specific additional pre-deployment config,
278   # applying to all nodes, e.g node registration/unregistration
279   NodeExtraConfig:
280     depends_on: NodeTLSCAData
281     type: OS::TripleO::NodeExtraConfig
282     properties:
283         server: {get_resource: BlockStorage}
284
285   UpdateConfig:
286     type: OS::TripleO::Tasks::PackageUpdate
287
288   UpdateDeployment:
289     type: OS::Heat::SoftwareDeployment
290     properties:
291       name: UpdateDeployment
292       config: {get_resource: UpdateConfig}
293       server: {get_resource: BlockStorage}
294       input_values:
295         update_identifier:
296           get_param: UpdateIdentifier
297
298 outputs:
299   ip_address:
300     description: IP address of the server in the ctlplane network
301     value: {get_attr: [BlockStorage, networks, ctlplane, 0]}
302   hostname:
303     description: Hostname of the server
304     value: {get_attr: [BlockStorage, name]}
305   hostname_map:
306     description: Mapping of network names to hostnames
307     value:
308       external:
309         list_join:
310         - '.'
311         - - {get_attr: [BlockStorage, name]}
312           - external
313           - {get_param: CloudDomain}
314       internal_api:
315         list_join:
316         - '.'
317         - - {get_attr: [BlockStorage, name]}
318           - internalapi
319           - {get_param: CloudDomain}
320       storage:
321         list_join:
322         - '.'
323         - - {get_attr: [BlockStorage, name]}
324           - storage
325           - {get_param: CloudDomain}
326       storage_mgmt:
327         list_join:
328         - '.'
329         - - {get_attr: [BlockStorage, name]}
330           - storagemgmt
331           - {get_param: CloudDomain}
332       tenant:
333         list_join:
334         - '.'
335         - - {get_attr: [BlockStorage, name]}
336           - tenant
337           - {get_param: CloudDomain}
338       management:
339         list_join:
340         - '.'
341         - - {get_attr: [BlockStorage, name]}
342           - management
343           - {get_param: CloudDomain}
344       ctlplane:
345         list_join:
346         - '.'
347         - - {get_attr: [BlockStorage, name]}
348           - ctlplane
349           - {get_param: CloudDomain}
350   hosts_entry:
351     value:
352       str_replace:
353         template: |
354           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
355           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
356           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
357           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
358           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
359           TENANTIP TENANTHOST.DOMAIN TENANTHOST
360           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
361           CTLPLANEIP CTLPLANEHOST.DOMAIN CTLPLANEHOST
362         params:
363           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
364           DOMAIN: {get_param: CloudDomain}
365           PRIMARYHOST: {get_attr: [BlockStorage, name]}
366           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
367           EXTERNALHOST:
368             list_join:
369             - '.'
370             - - {get_attr: [BlockStorage, name]}
371               - external
372           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
373           INTERNAL_APIHOST:
374             list_join:
375             - '.'
376             - - {get_attr: [BlockStorage, name]}
377               - internalapi
378           STORAGEIP: {get_attr: [StoragePort, ip_address]}
379           STORAGEHOST:
380             list_join:
381             - '.'
382             - - {get_attr: [BlockStorage, name]}
383               - storage
384           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
385           STORAGE_MGMTHOST:
386             list_join:
387             - '.'
388             - - {get_attr: [BlockStorage, name]}
389               - storagemgmt
390           TENANTIP: {get_attr: [TenantPort, ip_address]}
391           TENANTHOST:
392             list_join:
393             - '.'
394             - - {get_attr: [BlockStorage, name]}
395               - tenant
396           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
397           MANAGEMENTHOST:
398             list_join:
399             - '.'
400             - - {get_attr: [BlockStorage, name]}
401               - management
402           CTLPLANEIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
403           CTLPLANEHOST:
404             list_join:
405             - '.'
406             - - {get_attr: [BlockStorage, name]}
407               - ctlplane
408   nova_server_resource:
409     description: Heat resource handle for the block storage server
410     value:
411       {get_resource: BlockStorage}
412   external_ip_address:
413     description: IP address of the server in the external network
414     value: {get_attr: [ExternalPort, ip_address]}
415   internal_api_ip_address:
416     description: IP address of the server in the internal_api network
417     value: {get_attr: [InternalApiPort, ip_address]}
418   storage_ip_address:
419     description: IP address of the server in the storage network
420     value: {get_attr: [StoragePort, ip_address]}
421   storage_mgmt_ip_address:
422     description: IP address of the server in the storage_mgmt network
423     value: {get_attr: [StorageMgmtPort, ip_address]}
424   tenant_ip_address:
425     description: IP address of the server in the tenant network
426     value: {get_attr: [TenantPort, ip_address]}
427   management_ip_address:
428     description: IP address of the server in the management network
429     value: {get_attr: [ManagementPort, ip_address]}