Merge "Additional parameters for Nuage Neutron plugin integration"
[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   CinderEnableIscsiBackend:
8     default: true
9     description: Whether to enable or not the Iscsi backend for Cinder
10     type: boolean
11   CinderISCSIHelper:
12     default: lioadm
13     description: The iSCSI helper to use with cinder.
14     type: string
15   CinderLVMLoopDeviceSize:
16     default: 10280
17     description: The size of the loopback file used by the cinder LVM driver.
18     type: number
19   CinderPassword:
20     description: The password for the cinder service and db account, used by cinder-api.
21     type: string
22     hidden: true
23   Debug:
24     default: ''
25     description: Set to True to enable debugging on all services.
26     type: string
27   VirtualIP: # deprecated. Use per service VIPs instead.
28     default: ''
29     type: string
30   ExtraConfig:
31     default: {}
32     description: |
33       Additional hiera configuration to inject into the cluster. Note
34       that BlockStorageExtraConfig takes precedence over ExtraConfig.
35     type: json
36   BlockStorageExtraConfig:
37     default: {}
38     description: |
39       Role specific additional hiera configuration to inject into the cluster.
40     type: json
41   BlockStorageIPs:
42     default: {}
43     type: json
44   Flavor:
45     description: Flavor for block storage nodes to request when deploying.
46     type: string
47     constraints:
48       - custom_constraint: nova.flavor
49   KeyName:
50     default: default
51     description: Name of an existing Nova key pair to enable SSH access to the instances
52     type: string
53   RabbitPassword:
54     type: string
55     hidden: true
56   RabbitUserName:
57     default: 'guest'
58     type: string
59   RabbitClientUseSSL:
60     default: false
61     description: >
62         Rabbit client subscriber parameter to specify
63         an SSL connection to the RabbitMQ host.
64     type: string
65   RabbitClientPort:
66     default: 5672
67     description: Set rabbit subscriber port, change this if using SSL
68     type: number
69   SnmpdReadonlyUserName:
70     default: ro_snmp_user
71     description: The user name for SNMPd with readonly rights running on all Overcloud nodes
72     type: string
73   SnmpdReadonlyUserPassword:
74     description: The user password for SNMPd with readonly rights running on all Overcloud nodes
75     type: string
76     hidden: true
77   NtpServer:
78     default: ''
79     description: Comma-separated list of ntp servers
80     type: comma_delimited_list
81   EnablePackageInstall:
82     default: 'false'
83     description: Set to true to enable package installation via Puppet
84     type: boolean
85   UpdateIdentifier:
86     default: ''
87     type: string
88     description: >
89       Setting to a previously unused value during stack-update will trigger
90       package update on all nodes
91   Hostname:
92     type: string
93     default: '' # Defaults to Heat created hostname
94   HostnameMap:
95     type: json
96     default: {}
97     description: Optional mapping to override hostnames
98   ServiceNetMap:
99     default: {}
100     description: Mapping of service_name -> network name. Typically set
101                  via parameter_defaults in the resource registry.
102     type: json
103   EndpointMap:
104     default: {}
105     description: Mapping of service endpoint -> protocol. Typically set
106                  via parameter_defaults in the resource registry.
107     type: json
108   TimeZone:
109     default: 'UTC'
110     description: The timezone to be set on Cinder nodes.
111     type: string
112   GlanceApiVirtualIP:
113     type: string
114     default: ''
115   MysqlVirtualIPUri:
116     type: string
117     default: ''
118   NetworkDeploymentActions:
119     type: comma_delimited_list
120     description: >
121       Heat action when to apply network configuration changes
122     default: ['CREATE']
123   SoftwareConfigTransport:
124     default: POLL_SERVER_CFN
125     description: |
126       How the server should receive the metadata required for software configuration.
127     type: string
128     constraints:
129     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
130   CloudDomain:
131     default: ''
132     type: string
133     description: >
134       The DNS domain used for the hosts. This should match the dhcp_domain
135       configured in the Undercloud neutron. Defaults to localdomain.
136   ServerMetadata:
137     default: {}
138     description: >
139       Extra properties or metadata passed to Nova for the created nodes in
140       the overcloud. It's accessible via the Nova metadata API.
141     type: json
142   SchedulerHints:
143     type: json
144     description: Optional scheduler hints to pass to nova
145     default: {}
146   NodeIndex:
147     type: number
148     default: 0
149
150
151 resources:
152   BlockStorage:
153     type: OS::Nova::Server
154     properties:
155       image:
156         {get_param: Image}
157       flavor: {get_param: Flavor}
158       key_name: {get_param: KeyName}
159       networks:
160         - network: ctlplane
161       user_data_format: SOFTWARE_CONFIG
162       user_data: {get_resource: UserData}
163       name:
164         str_replace:
165             template: {get_param: Hostname}
166             params: {get_param: HostnameMap}
167       software_config_transport: {get_param: SoftwareConfigTransport}
168       metadata: {get_param: ServerMetadata}
169       scheduler_hints: {get_param: SchedulerHints}
170
171   # Combine the NodeAdminUserData and NodeUserData mime archives
172   UserData:
173     type: OS::Heat::MultipartMime
174     properties:
175       parts:
176       - config: {get_resource: NodeAdminUserData}
177         type: multipart
178       - config: {get_resource: NodeUserData}
179         type: multipart
180
181   # Creates the "heat-admin" user if configured via the environment
182   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
183   NodeAdminUserData:
184     type: OS::TripleO::NodeAdminUserData
185
186   # For optional operator additional userdata
187   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
188   NodeUserData:
189     type: OS::TripleO::NodeUserData
190
191   ExternalPort:
192     type: OS::TripleO::BlockStorage::Ports::ExternalPort
193     properties:
194       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
195       IPPool: {get_param: BlockStorageIPs}
196       NodeIndex: {get_param: NodeIndex}
197
198   InternalApiPort:
199     type: OS::TripleO::BlockStorage::Ports::InternalApiPort
200     properties:
201       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
202       IPPool: {get_param: BlockStorageIPs}
203       NodeIndex: {get_param: NodeIndex}
204
205   StoragePort:
206     type: OS::TripleO::BlockStorage::Ports::StoragePort
207     properties:
208       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
209       IPPool: {get_param: BlockStorageIPs}
210       NodeIndex: {get_param: NodeIndex}
211
212   StorageMgmtPort:
213     type: OS::TripleO::BlockStorage::Ports::StorageMgmtPort
214     properties:
215       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
216       IPPool: {get_param: BlockStorageIPs}
217       NodeIndex: {get_param: NodeIndex}
218
219   TenantPort:
220     type: OS::TripleO::BlockStorage::Ports::TenantPort
221     properties:
222       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
223       IPPool: {get_param: BlockStorageIPs}
224       NodeIndex: {get_param: NodeIndex}
225
226   ManagementPort:
227     type: OS::TripleO::BlockStorage::Ports::ManagementPort
228     properties:
229       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
230       IPPool: {get_param: BlockStorageIPs}
231       NodeIndex: {get_param: NodeIndex}
232
233   NetworkConfig:
234     type: OS::TripleO::BlockStorage::Net::SoftwareConfig
235     properties:
236       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
237       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
238       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
239       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
240       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
241       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
242       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
243
244   NetIpMap:
245     type: OS::TripleO::Network::Ports::NetIpMap
246     properties:
247       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
248       ExternalIp: {get_attr: [ExternalPort, ip_address]}
249       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
250       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
251       InternalApiIpUri: {get_attr: [InternalApiPort, ip_address_uri]}
252       StorageIp: {get_attr: [StoragePort, ip_address]}
253       StorageIpUri: {get_attr: [StoragePort, ip_address_uri]}
254       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
255       StorageMgmtIpUri: {get_attr: [StorageMgmtPort, ip_address_uri]}
256       TenantIp: {get_attr: [TenantPort, ip_address]}
257       TenantIpUri: {get_attr: [TenantPort, ip_address_uri]}
258       ManagementIp: {get_attr: [ManagementPort, ip_address]}
259       ManagementIpUri: {get_attr: [ManagementPort, ip_address_uri]}
260
261   NetworkDeployment:
262     type: OS::TripleO::SoftwareDeployment
263     properties:
264       name: NetworkDeployment
265       config: {get_resource: NetworkConfig}
266       server: {get_resource: BlockStorage}
267       actions: {get_param: NetworkDeploymentActions}
268
269   BlockStorageDeployment:
270     type: OS::Heat::StructuredDeployment
271     depends_on: NetworkDeployment
272     properties:
273       name: BlockStorageDeployment
274       server: {get_resource: BlockStorage}
275       config: {get_resource: BlockStorageConfig}
276       input_values:
277         debug: {get_param: Debug}
278         cinder_dsn: {list_join: ['', ['mysql+pymysql://cinder:', {get_param: CinderPassword}, '@', {get_param: MysqlVirtualIPUri} , '/cinder']]}
279         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
280         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
281         cinder_lvm_loop_device_size:
282           str_replace:
283             template: sizeM
284             params:
285               size: {get_param: CinderLVMLoopDeviceSize}
286         cinder_enable_iscsi_backend: {get_param: CinderEnableIscsiBackend}
287         cinder_iscsi_helper: {get_param: CinderISCSIHelper}
288         cinder_iscsi_ip_address:
289           str_replace:
290             template: "'IP'"
291             params:
292               IP: {get_attr: [NetIpMap, net_ip_uri_map, {get_param: [ServiceNetMap, CinderIscsiNetwork]}]}
293         glance_api_servers: {get_param: [EndpointMap, GlanceInternal, uri]}
294         rabbit_username: {get_param: RabbitUserName}
295         rabbit_password: {get_param: RabbitPassword}
296         rabbit_client_use_ssl: {get_param: RabbitClientUseSSL}
297         rabbit_client_port: {get_param: RabbitClientPort}
298         ntp_servers: {get_param: NtpServer}
299         timezone: {get_param: TimeZone}
300         enable_package_install: {get_param: EnablePackageInstall}
301         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
302
303   # Map heat metadata into hiera datafiles
304   BlockStorageConfig:
305     type: OS::Heat::StructuredConfig
306     properties:
307       group: os-apply-config
308       config:
309         hiera:
310           hierarchy:
311             - '"%{::uuid}"'
312             - heat_config_%{::deploy_config_name}
313             - volume_extraconfig
314             - extraconfig
315             - volume
316             - all_nodes # provided by allNodesConfig
317             - '"%{::osfamily}"'
318             - common
319           merge_behavior: deeper
320           datafiles:
321             common:
322               raw_data: {get_file: hieradata/common.yaml}
323             volume_extraconfig:
324               mapped_data: {get_param: BlockStorageExtraConfig}
325             extraconfig:
326               mapped_data: {get_param: ExtraConfig}
327             volume:
328               raw_data: {get_file: hieradata/volume.yaml}
329               mapped_data:
330                 # Cinder
331                 cinder::debug: {get_input: debug}
332                 cinder::setup_test_volume::size: {get_input: cinder_lvm_loop_device_size}
333                 cinder_iscsi_helper: {get_input: cinder_iscsi_helper}
334                 cinder::database_connection: {get_input: cinder_dsn}
335                 cinder::rabbit_userid: {get_input: rabbit_username}
336                 cinder::rabbit_password: {get_input: rabbit_password}
337                 cinder::rabbit_use_ssl: {get_input: rabbit_client_use_ssl}
338                 cinder::rabbit_port: {get_input: rabbit_client_port}
339                 cinder_enable_iscsi_backend: {get_input: cinder_enable_iscsi_backend}
340                 cinder_iscsi_ip_address: {get_input: cinder_iscsi_ip_address}
341                 cinder::glance::glance_api_servers: {get_input: glance_api_servers}
342                 ntp::servers: {get_input: ntp_servers}
343                 timezone::timezone: {get_input: timezone}
344                 tripleo::packages::enable_install: {get_input: enable_package_install}
345                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
346                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
347                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
348
349   # Resource for site-specific injection of root certificate
350   NodeTLSCAData:
351     depends_on: BlockStorageDeployment
352     type: OS::TripleO::NodeTLSCAData
353     properties:
354       server: {get_resource: BlockStorage}
355
356   # Hook for site-specific additional pre-deployment config,
357   # applying to all nodes, e.g node registration/unregistration
358   NodeExtraConfig:
359     depends_on: NodeTLSCAData
360     type: OS::TripleO::NodeExtraConfig
361     properties:
362         server: {get_resource: BlockStorage}
363
364   UpdateConfig:
365     type: OS::TripleO::Tasks::PackageUpdate
366
367   UpdateDeployment:
368     type: OS::Heat::SoftwareDeployment
369     properties:
370       name: UpdateDeployment
371       config: {get_resource: UpdateConfig}
372       server: {get_resource: BlockStorage}
373       input_values:
374         update_identifier:
375           get_param: UpdateIdentifier
376
377 outputs:
378   hosts_entry:
379     value:
380       str_replace:
381         template: |
382           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
383           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
384           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
385           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
386           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
387           TENANTIP TENANTHOST.DOMAIN TENANTHOST
388           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
389         params:
390           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
391           DOMAIN: {get_param: CloudDomain}
392           PRIMARYHOST: {get_attr: [BlockStorage, name]}
393           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
394           EXTERNALHOST:
395             list_join:
396             - '.'
397             - - {get_attr: [BlockStorage, name]}
398               - external
399           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
400           INTERNAL_APIHOST:
401             list_join:
402             - '.'
403             - - {get_attr: [BlockStorage, name]}
404               - internalapi
405           STORAGEIP: {get_attr: [StoragePort, ip_address]}
406           STORAGEHOST:
407             list_join:
408             - '.'
409             - - {get_attr: [BlockStorage, name]}
410               - storage
411           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
412           STORAGE_MGMTHOST:
413             list_join:
414             - '.'
415             - - {get_attr: [BlockStorage, name]}
416               - storagemgmt
417           TENANTIP: {get_attr: [TenantPort, ip_address]}
418           TENANTHOST:
419             list_join:
420             - '.'
421             - - {get_attr: [BlockStorage, name]}
422               - tenant
423           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
424           MANAGEMENTHOST:
425             list_join:
426             - '.'
427             - - {get_attr: [BlockStorage, name]}
428               - management
429   nova_server_resource:
430     description: Heat resource handle for the block storage server
431     value:
432       {get_resource: BlockStorage}
433   external_ip_address:
434     description: IP address of the server in the external network
435     value: {get_attr: [ExternalPort, ip_address]}
436   internal_api_ip_address:
437     description: IP address of the server in the internal_api network
438     value: {get_attr: [InternalApiPort, ip_address]}
439   storage_ip_address:
440     description: IP address of the server in the storage network
441     value: {get_attr: [StoragePort, ip_address]}
442   storage_mgmt_ip_address:
443     description: IP address of the server in the storage_mgmt network
444     value: {get_attr: [StorageMgmtPort, ip_address]}
445   tenant_ip_address:
446     description: IP address of the server in the tenant network
447     value: {get_attr: [TenantPort, ip_address]}
448   management_ip_address:
449     description: IP address of the server in the management network
450     value: {get_attr: [ManagementPort, ip_address]}
451   config_identifier:
452     description: identifier which changes if the node configuration may need re-applying
453     value:
454       list_join:
455         - ''
456         - - {get_attr: [BlockStorageDeployment, deploy_stdout]}
457           - {get_attr: [NodeTLSCAData, deploy_stdout]}
458           - {get_param: UpdateIdentifier}