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