9bf0076135db05b96d73574c91e81b2674b58f59
[apex-tripleo-heat-templates.git] / puppet / cinder-storage.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   SnmpdReadonlyUserName:
34     default: ro_snmp_user
35     description: The user name for SNMPd with readonly rights running on all Overcloud nodes
36     type: string
37   SnmpdReadonlyUserPassword:
38     description: The user password for SNMPd with readonly rights running on all Overcloud nodes
39     type: string
40     hidden: true
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   ServiceNetMap:
55     default: {}
56     description: Mapping of service_name -> network name. Typically set
57                  via parameter_defaults in the resource registry.
58     type: json
59   NetworkDeploymentActions:
60     type: comma_delimited_list
61     description: >
62       Heat action when to apply network configuration changes
63     default: ['CREATE']
64   SoftwareConfigTransport:
65     default: POLL_SERVER_CFN
66     description: |
67       How the server should receive the metadata required for software configuration.
68     type: string
69     constraints:
70     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
71   CloudDomain:
72     type: string
73     description: >
74       The DNS domain used for the hosts. This should match the dhcp_domain
75       configured in the Undercloud neutron. Defaults to localdomain.
76   ServerMetadata:
77     default: {}
78     description: >
79       Extra properties or metadata passed to Nova for the created nodes in
80       the overcloud. It's accessible via the Nova metadata API.
81     type: json
82   BlockStorageSchedulerHints:
83     type: json
84     description: Optional scheduler hints to pass to nova
85     default: {}
86   NodeIndex:
87     type: number
88     default: 0
89   ServiceConfigSettings:
90     type: json
91     default: {}
92   ServiceNames:
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: Flavor}
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         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
236         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
237         cinder_iscsi_ip_address:
238           str_replace:
239             template: "'IP'"
240             params:
241               IP:
242                 get_attr:
243                   - NetIpMap
244                   - net_ip_map
245                   - str_replace:
246                       template: "NETWORK_uri"
247                       params:
248                         NETWORK: {get_param: [ServiceNetMap, CinderIscsiNetwork]}
249         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
250
251   # Map heat metadata into hiera datafiles
252   BlockStorageConfig:
253     type: OS::Heat::StructuredConfig
254     properties:
255       group: os-apply-config
256       config:
257         hiera:
258           hierarchy:
259             - '"%{::uuid}"'
260             - heat_config_%{::deploy_config_name}
261             - volume_extraconfig
262             - extraconfig
263             - service_names
264             - service_configs
265             - volume
266             - all_nodes # provided by allNodesConfig
267             - '"%{::osfamily}"'
268           merge_behavior: deeper
269           datafiles:
270             service_names:
271               mapped_data:
272                 service_names: {get_param: ServiceNames}
273             service_configs:
274               mapped_data:
275                 map_replace:
276                   - {get_param: ServiceConfigSettings}
277                   - values: {get_attr: [NetIpMap, net_ip_map]}
278             volume_extraconfig:
279               mapped_data: {get_param: BlockStorageExtraConfig}
280             extraconfig:
281               mapped_data: {get_param: ExtraConfig}
282             volume:
283               mapped_data:
284                 # Cinder
285                 tripleo::profile::base::cinder::volume::iscsi::cinder_iscsi_ip_address: {get_input: cinder_iscsi_ip_address}
286                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
287                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
288                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
289
290   # Resource for site-specific injection of root certificate
291   NodeTLSCAData:
292     depends_on: BlockStorageDeployment
293     type: OS::TripleO::NodeTLSCAData
294     properties:
295       server: {get_resource: BlockStorage}
296
297   # Hook for site-specific additional pre-deployment config,
298   # applying to all nodes, e.g node registration/unregistration
299   NodeExtraConfig:
300     depends_on: NodeTLSCAData
301     type: OS::TripleO::NodeExtraConfig
302     properties:
303         server: {get_resource: BlockStorage}
304
305   UpdateConfig:
306     type: OS::TripleO::Tasks::PackageUpdate
307
308   UpdateDeployment:
309     type: OS::Heat::SoftwareDeployment
310     properties:
311       name: UpdateDeployment
312       config: {get_resource: UpdateConfig}
313       server: {get_resource: BlockStorage}
314       input_values:
315         update_identifier:
316           get_param: UpdateIdentifier
317
318 outputs:
319   ip_address:
320     description: IP address of the server in the ctlplane network
321     value: {get_attr: [BlockStorage, networks, ctlplane, 0]}
322   hostname:
323     description: Hostname of the server
324     value: {get_attr: [BlockStorage, name]}
325   hosts_entry:
326     value:
327       str_replace:
328         template: |
329           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
330           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
331           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
332           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
333           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
334           TENANTIP TENANTHOST.DOMAIN TENANTHOST
335           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
336         params:
337           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
338           DOMAIN: {get_param: CloudDomain}
339           PRIMARYHOST: {get_attr: [BlockStorage, name]}
340           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
341           EXTERNALHOST:
342             list_join:
343             - '.'
344             - - {get_attr: [BlockStorage, name]}
345               - external
346           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
347           INTERNAL_APIHOST:
348             list_join:
349             - '.'
350             - - {get_attr: [BlockStorage, name]}
351               - internalapi
352           STORAGEIP: {get_attr: [StoragePort, ip_address]}
353           STORAGEHOST:
354             list_join:
355             - '.'
356             - - {get_attr: [BlockStorage, name]}
357               - storage
358           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
359           STORAGE_MGMTHOST:
360             list_join:
361             - '.'
362             - - {get_attr: [BlockStorage, name]}
363               - storagemgmt
364           TENANTIP: {get_attr: [TenantPort, ip_address]}
365           TENANTHOST:
366             list_join:
367             - '.'
368             - - {get_attr: [BlockStorage, name]}
369               - tenant
370           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
371           MANAGEMENTHOST:
372             list_join:
373             - '.'
374             - - {get_attr: [BlockStorage, name]}
375               - management
376   nova_server_resource:
377     description: Heat resource handle for the block storage server
378     value:
379       {get_resource: BlockStorage}
380   external_ip_address:
381     description: IP address of the server in the external network
382     value: {get_attr: [ExternalPort, ip_address]}
383   internal_api_ip_address:
384     description: IP address of the server in the internal_api network
385     value: {get_attr: [InternalApiPort, ip_address]}
386   storage_ip_address:
387     description: IP address of the server in the storage network
388     value: {get_attr: [StoragePort, ip_address]}
389   storage_mgmt_ip_address:
390     description: IP address of the server in the storage_mgmt network
391     value: {get_attr: [StorageMgmtPort, ip_address]}
392   tenant_ip_address:
393     description: IP address of the server in the tenant network
394     value: {get_attr: [TenantPort, ip_address]}
395   management_ip_address:
396     description: IP address of the server in the management network
397     value: {get_attr: [ManagementPort, ip_address]}