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