Merge "Stop no-opping PackageUpdate on upgrade"
[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
95 resources:
96   BlockStorage:
97     type: OS::Nova::Server
98     properties:
99       image:
100         {get_param: Image}
101       flavor: {get_param: Flavor}
102       key_name: {get_param: KeyName}
103       networks:
104         - network: ctlplane
105       user_data_format: SOFTWARE_CONFIG
106       user_data: {get_resource: UserData}
107       name:
108         str_replace:
109             template: {get_param: Hostname}
110             params: {get_param: HostnameMap}
111       software_config_transport: {get_param: SoftwareConfigTransport}
112       metadata: {get_param: ServerMetadata}
113       scheduler_hints: {get_param: SchedulerHints}
114
115   # Combine the NodeAdminUserData and NodeUserData mime archives
116   UserData:
117     type: OS::Heat::MultipartMime
118     properties:
119       parts:
120       - config: {get_resource: NodeAdminUserData}
121         type: multipart
122       - config: {get_resource: NodeUserData}
123         type: multipart
124
125   # Creates the "heat-admin" user if configured via the environment
126   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
127   NodeAdminUserData:
128     type: OS::TripleO::NodeAdminUserData
129
130   # For optional operator additional userdata
131   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
132   NodeUserData:
133     type: OS::TripleO::NodeUserData
134
135   ExternalPort:
136     type: OS::TripleO::BlockStorage::Ports::ExternalPort
137     properties:
138       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
139       IPPool: {get_param: BlockStorageIPs}
140       NodeIndex: {get_param: NodeIndex}
141
142   InternalApiPort:
143     type: OS::TripleO::BlockStorage::Ports::InternalApiPort
144     properties:
145       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
146       IPPool: {get_param: BlockStorageIPs}
147       NodeIndex: {get_param: NodeIndex}
148
149   StoragePort:
150     type: OS::TripleO::BlockStorage::Ports::StoragePort
151     properties:
152       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
153       IPPool: {get_param: BlockStorageIPs}
154       NodeIndex: {get_param: NodeIndex}
155
156   StorageMgmtPort:
157     type: OS::TripleO::BlockStorage::Ports::StorageMgmtPort
158     properties:
159       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
160       IPPool: {get_param: BlockStorageIPs}
161       NodeIndex: {get_param: NodeIndex}
162
163   TenantPort:
164     type: OS::TripleO::BlockStorage::Ports::TenantPort
165     properties:
166       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
167       IPPool: {get_param: BlockStorageIPs}
168       NodeIndex: {get_param: NodeIndex}
169
170   ManagementPort:
171     type: OS::TripleO::BlockStorage::Ports::ManagementPort
172     properties:
173       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
174       IPPool: {get_param: BlockStorageIPs}
175       NodeIndex: {get_param: NodeIndex}
176
177   NetworkConfig:
178     type: OS::TripleO::BlockStorage::Net::SoftwareConfig
179     properties:
180       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
181       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
182       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
183       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
184       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
185       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
186       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
187
188   NetIpMap:
189     type: OS::TripleO::Network::Ports::NetIpMap
190     properties:
191       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
192       ExternalIp: {get_attr: [ExternalPort, ip_address]}
193       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
194       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
195       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
196       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
197       InternalApiIpUri: {get_attr: [InternalApiPort, ip_address_uri]}
198       StorageIp: {get_attr: [StoragePort, ip_address]}
199       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
200       StorageIpUri: {get_attr: [StoragePort, ip_address_uri]}
201       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
202       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
203       StorageMgmtIpUri: {get_attr: [StorageMgmtPort, ip_address_uri]}
204       TenantIp: {get_attr: [TenantPort, ip_address]}
205       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
206       TenantIpUri: {get_attr: [TenantPort, ip_address_uri]}
207       ManagementIp: {get_attr: [ManagementPort, ip_address]}
208       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
209       ManagementIpUri: {get_attr: [ManagementPort, ip_address_uri]}
210
211   NetworkDeployment:
212     type: OS::TripleO::SoftwareDeployment
213     properties:
214       name: NetworkDeployment
215       config: {get_resource: NetworkConfig}
216       server: {get_resource: BlockStorage}
217       actions: {get_param: NetworkDeploymentActions}
218
219   BlockStorageDeployment:
220     type: OS::Heat::StructuredDeployment
221     depends_on: NetworkDeployment
222     properties:
223       name: BlockStorageDeployment
224       server: {get_resource: BlockStorage}
225       config: {get_resource: BlockStorageConfig}
226       input_values:
227         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
228         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
229         cinder_iscsi_ip_address:
230           str_replace:
231             template: "'IP'"
232             params:
233               IP: {get_attr: [NetIpMap, net_ip_uri_map, {get_param: [ServiceNetMap, CinderIscsiNetwork]}]}
234         enable_package_install: {get_param: EnablePackageInstall}
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_configs
250             - volume
251             - all_nodes # provided by allNodesConfig
252             - '"%{::osfamily}"'
253             - common
254             - network
255           merge_behavior: deeper
256           datafiles:
257             service_configs:
258               mapped_data: {get_param: ServiceConfigSettings}
259             common:
260               raw_data: {get_file: hieradata/common.yaml}
261             network:
262               mapped_data:
263                 net_ip_map: {get_attr: [NetIpMap, net_ip_map]}
264                 net_ip_subnet_map: {get_attr: [NetIpMap, net_ip_subnet_map]}
265                 net_ip_uri_map: {get_attr: [NetIpMap, net_ip_uri_map]}
266             volume_extraconfig:
267               mapped_data: {get_param: BlockStorageExtraConfig}
268             extraconfig:
269               mapped_data: {get_param: ExtraConfig}
270             volume:
271               raw_data: {get_file: hieradata/volume.yaml}
272               mapped_data:
273                 # Cinder
274                 tripleo::profile::base::cinder::volume::iscsi::cinder_iscsi_ip_address: {get_input: cinder_iscsi_ip_address}
275                 tripleo::packages::enable_install: {get_input: enable_package_install}
276                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
277                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
278                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
279
280   # Resource for site-specific injection of root certificate
281   NodeTLSCAData:
282     depends_on: BlockStorageDeployment
283     type: OS::TripleO::NodeTLSCAData
284     properties:
285       server: {get_resource: BlockStorage}
286
287   # Hook for site-specific additional pre-deployment config,
288   # applying to all nodes, e.g node registration/unregistration
289   NodeExtraConfig:
290     depends_on: NodeTLSCAData
291     type: OS::TripleO::NodeExtraConfig
292     properties:
293         server: {get_resource: BlockStorage}
294
295   UpdateConfig:
296     type: OS::TripleO::Tasks::PackageUpdate
297
298   UpdateDeployment:
299     type: OS::Heat::SoftwareDeployment
300     properties:
301       name: UpdateDeployment
302       config: {get_resource: UpdateConfig}
303       server: {get_resource: BlockStorage}
304       input_values:
305         update_identifier:
306           get_param: UpdateIdentifier
307
308 outputs:
309   hosts_entry:
310     value:
311       str_replace:
312         template: |
313           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
314           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
315           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
316           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
317           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
318           TENANTIP TENANTHOST.DOMAIN TENANTHOST
319           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
320         params:
321           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
322           DOMAIN: {get_param: CloudDomain}
323           PRIMARYHOST: {get_attr: [BlockStorage, name]}
324           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
325           EXTERNALHOST:
326             list_join:
327             - '.'
328             - - {get_attr: [BlockStorage, name]}
329               - external
330           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
331           INTERNAL_APIHOST:
332             list_join:
333             - '.'
334             - - {get_attr: [BlockStorage, name]}
335               - internalapi
336           STORAGEIP: {get_attr: [StoragePort, ip_address]}
337           STORAGEHOST:
338             list_join:
339             - '.'
340             - - {get_attr: [BlockStorage, name]}
341               - storage
342           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
343           STORAGE_MGMTHOST:
344             list_join:
345             - '.'
346             - - {get_attr: [BlockStorage, name]}
347               - storagemgmt
348           TENANTIP: {get_attr: [TenantPort, ip_address]}
349           TENANTHOST:
350             list_join:
351             - '.'
352             - - {get_attr: [BlockStorage, name]}
353               - tenant
354           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
355           MANAGEMENTHOST:
356             list_join:
357             - '.'
358             - - {get_attr: [BlockStorage, name]}
359               - management
360   nova_server_resource:
361     description: Heat resource handle for the block storage server
362     value:
363       {get_resource: BlockStorage}
364   external_ip_address:
365     description: IP address of the server in the external network
366     value: {get_attr: [ExternalPort, ip_address]}
367   internal_api_ip_address:
368     description: IP address of the server in the internal_api network
369     value: {get_attr: [InternalApiPort, ip_address]}
370   storage_ip_address:
371     description: IP address of the server in the storage network
372     value: {get_attr: [StoragePort, ip_address]}
373   storage_mgmt_ip_address:
374     description: IP address of the server in the storage_mgmt network
375     value: {get_attr: [StorageMgmtPort, ip_address]}
376   tenant_ip_address:
377     description: IP address of the server in the tenant network
378     value: {get_attr: [TenantPort, ip_address]}
379   management_ip_address:
380     description: IP address of the server in the management network
381     value: {get_attr: [ManagementPort, ip_address]}
382   config_identifier:
383     description: identifier which changes if the node configuration may need re-applying
384     value:
385       list_join:
386         - ''
387         - - {get_attr: [BlockStorageDeployment, deploy_stdout]}
388           - {get_attr: [NodeTLSCAData, deploy_stdout]}
389           - {get_param: UpdateIdentifier}