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