Merge "Add default for DeployIdentifier in nested templates"
[apex-tripleo-heat-templates.git] / puppet / swift-storage.yaml
1 heat_template_version: 2016-10-14
2 description: 'OpenStack swift storage node configured by Puppet'
3 parameters:
4   OvercloudSwiftStorageFlavor:
5     description: Flavor for Swift storage nodes to request when deploying.
6     default: baremetal
7     type: string
8     constraints:
9       - custom_constraint: nova.flavor
10   SwiftStorageImage:
11     default: overcloud-full
12     type: string
13     constraints:
14       - custom_constraint: glance.image
15   KeyName:
16     default: default
17     description: Name of an existing Nova key pair to enable SSH access to the instances
18     type: string
19   UpdateIdentifier:
20     default: ''
21     type: string
22     description: >
23       Setting to a previously unused value during stack-update will trigger
24       package update on all nodes
25   ServiceNetMap:
26     default: {}
27     description: Mapping of service_name -> network name. Typically set
28                  via parameter_defaults in the resource registry.
29     type: json
30   Hostname:
31     type: string
32     default: '' # Defaults to Heat created hostname
33   HostnameMap:
34     type: json
35     default: {}
36     description: Optional mapping to override hostnames
37   ExtraConfig:
38     default: {}
39     description: |
40       Additional hiera configuration to inject into the cluster. Note
41       that ObjectStorageExtraConfig takes precedence over ExtraConfig.
42     type: json
43   ObjectStorageExtraConfig:
44     default: {}
45     description: |
46       Role specific additional hiera configuration to inject into the cluster.
47     type: json
48   SwiftStorageIPs:
49     default: {}
50     type: json
51   NetworkDeploymentActions:
52     type: comma_delimited_list
53     description: >
54       Heat action when to apply network configuration changes
55     default: ['CREATE']
56   SoftwareConfigTransport:
57     default: POLL_SERVER_CFN
58     description: |
59       How the server should receive the metadata required for software configuration.
60     type: string
61     constraints:
62     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
63   CloudDomain:
64     type: string
65     description: >
66       The DNS domain used for the hosts. This should match the dhcp_domain
67       configured in the Undercloud neutron. Defaults to localdomain.
68   ServerMetadata:
69     default: {}
70     description: >
71       Extra properties or metadata passed to Nova for the created nodes in
72       the overcloud. It's accessible via the Nova metadata API.
73     type: json
74   ObjectStorageSchedulerHints:
75     type: json
76     description: Optional scheduler hints to pass to nova
77     default: {}
78   NodeIndex:
79     type: number
80     default: 0
81   ServiceConfigSettings:
82     type: json
83     default: {}
84   ServiceNames:
85     type: comma_delimited_list
86     default: []
87   MonitoringSubscriptions:
88     type: comma_delimited_list
89     default: []
90   ConfigCommand:
91     type: string
92     description: Command which will be run whenever configuration data changes
93     default: os-refresh-config --timeout 14400
94   SwiftRawDisks:
95     default: {}
96     description: 'A hash of additional raw devices to use as Swift backend (eg. {sdb: {}})'
97     type: json
98
99 resources:
100
101   SwiftStorage:
102     type: OS::Nova::Server
103     metadata:
104       os-collect-config:
105         command: {get_param: ConfigCommand}
106     properties:
107       image: {get_param: SwiftStorageImage}
108       flavor: {get_param: OvercloudSwiftStorageFlavor}
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: ObjectStorageSchedulerHints}
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::SwiftStorage::Ports::ExternalPort
144     properties:
145       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
146       IPPool: {get_param: SwiftStorageIPs}
147       NodeIndex: {get_param: NodeIndex}
148
149   InternalApiPort:
150     type: OS::TripleO::SwiftStorage::Ports::InternalApiPort
151     properties:
152       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
153       IPPool: {get_param: SwiftStorageIPs}
154       NodeIndex: {get_param: NodeIndex}
155
156   StoragePort:
157     type: OS::TripleO::SwiftStorage::Ports::StoragePort
158     properties:
159       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
160       IPPool: {get_param: SwiftStorageIPs}
161       NodeIndex: {get_param: NodeIndex}
162
163   StorageMgmtPort:
164     type: OS::TripleO::SwiftStorage::Ports::StorageMgmtPort
165     properties:
166       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
167       IPPool: {get_param: SwiftStorageIPs}
168       NodeIndex: {get_param: NodeIndex}
169
170   TenantPort:
171     type: OS::TripleO::SwiftStorage::Ports::TenantPort
172     properties:
173       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
174       IPPool: {get_param: SwiftStorageIPs}
175       NodeIndex: {get_param: NodeIndex}
176
177   ManagementPort:
178     type: OS::TripleO::SwiftStorage::Ports::ManagementPort
179     properties:
180       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
181       IPPool: {get_param: SwiftStorageIPs}
182       NodeIndex: {get_param: NodeIndex}
183
184   NetworkConfig:
185     type: OS::TripleO::ObjectStorage::Net::SoftwareConfig
186     properties:
187       ControlPlaneIp: {get_attr: [SwiftStorage, 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: [SwiftStorage, 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: SwiftStorage}
224       actions: {get_param: NetworkDeploymentActions}
225
226   SwiftStorageHieraConfig:
227     type: OS::Heat::StructuredConfig
228     properties:
229       group: os-apply-config
230       config:
231         hiera:
232           hierarchy:
233             - '"%{::uuid}"'
234             - heat_config_%{::deploy_config_name}
235             - object_extraconfig
236             - extraconfig
237             - service_names
238             - service_configs
239             - object
240             - swift_devices_and_proxy # provided by SwiftDevicesAndProxyConfig
241             - all_nodes # provided by allNodesConfig
242             - '"%{::osfamily}"'
243           merge_behavior: deeper
244           datafiles:
245             service_names:
246               mapped_data:
247                 service_names: {get_param: ServiceNames}
248                 sensu::subscriptions: {get_param: MonitoringSubscriptions}
249             service_configs:
250               mapped_data:
251                 map_replace:
252                   - {get_param: ServiceConfigSettings}
253                   - values: {get_attr: [NetIpMap, net_ip_map]}
254             object_extraconfig:
255               mapped_data: {get_param: ObjectStorageExtraConfig}
256             extraconfig:
257               mapped_data: {get_param: ExtraConfig}
258             object:
259               mapped_data: # data supplied directly to this deployment configuration, etc
260                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
261
262
263   SwiftStorageHieraDeploy:
264     type: OS::Heat::StructuredDeployment
265     depends_on: NetworkDeployment
266     properties:
267       name: SwiftStorageHieraDeploy
268       server: {get_resource: SwiftStorage}
269       config: {get_resource: SwiftStorageHieraConfig}
270       input_values:
271         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
272
273   # Resource for site-specific injection of root certificate
274   NodeTLSCAData:
275     depends_on: SwiftStorageHieraDeploy
276     type: OS::TripleO::NodeTLSCAData
277     properties:
278       server: {get_resource: SwiftStorage}
279
280   # Hook for site-specific additional pre-deployment config,
281   # applying to all nodes, e.g node registration/unregistration
282   NodeExtraConfig:
283     depends_on: NodeTLSCAData
284     type: OS::TripleO::NodeExtraConfig
285     properties:
286         server: {get_resource: SwiftStorage}
287
288   UpdateConfig:
289     type: OS::TripleO::Tasks::PackageUpdate
290
291   UpdateDeployment:
292     type: OS::Heat::SoftwareDeployment
293     properties:
294       config: {get_resource: UpdateConfig}
295       server: {get_resource: SwiftStorage}
296       input_values:
297         update_identifier:
298           get_param: UpdateIdentifier
299
300 outputs:
301   ip_address:
302     description: IP address of the server in the ctlplane network
303     value: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
304   hostname:
305     description: Hostname of the server
306     value: {get_attr: [SwiftStorage, name]}
307   hosts_entry:
308     value:
309       str_replace:
310         template: |
311           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
312           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
313           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
314           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
315           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
316           TENANTIP TENANTHOST.DOMAIN TENANTHOST
317           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
318         params:
319           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, ObjectStorageHostnameResolveNetwork]}]}
320           DOMAIN: {get_param: CloudDomain}
321           PRIMARYHOST: {get_attr: [SwiftStorage, name]}
322           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
323           EXTERNALHOST:
324             list_join:
325             - '.'
326             - - {get_attr: [SwiftStorage, name]}
327               - external
328           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
329           INTERNAL_APIHOST:
330             list_join:
331             - '.'
332             - - {get_attr: [SwiftStorage, name]}
333               - internalapi
334           STORAGEIP: {get_attr: [StoragePort, ip_address]}
335           STORAGEHOST:
336             list_join:
337             - '.'
338             - - {get_attr: [SwiftStorage, name]}
339               - storage
340           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
341           STORAGE_MGMTHOST:
342             list_join:
343             - '.'
344             - - {get_attr: [SwiftStorage, name]}
345               - storagemgmt
346           TENANTIP: {get_attr: [TenantPort, ip_address]}
347           TENANTHOST:
348             list_join:
349             - '.'
350             - - {get_attr: [SwiftStorage, name]}
351               - tenant
352           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
353           MANAGEMENTHOST:
354             list_join:
355             - '.'
356             - - {get_attr: [SwiftStorage, name]}
357               - management
358   nova_server_resource:
359     description: Heat resource handle for the swift storage server
360     value:
361       {get_resource: SwiftStorage}
362   swift_device:
363     description: Swift device formatted for swift-ring-builder
364     value:
365       str_replace:
366         template:
367           list_join:
368             - ','
369             - ['r1z1-IP:%PORT%/d1']
370             - repeat:
371                 template: 'r1z1-IP:%PORT%/DEVICE'
372                 for_each:
373                   DEVICE: {get_param: SwiftRawDisks}
374         params:
375           IP:
376             get_attr:
377               - NetIpMap
378               - net_ip_map
379               - str_replace:
380                   template: "NETWORK_uri"
381                   params:
382                     NETWORK: {get_param: [ServiceNetMap, SwiftMgmtNetwork]}
383   external_ip_address:
384     description: IP address of the server in the external network
385     value: {get_attr: [ExternalPort, ip_address]}
386   internal_api_ip_address:
387     description: IP address of the server in the internal_api network
388     value: {get_attr: [InternalApiPort, ip_address]}
389   storage_ip_address:
390     description: IP address of the server in the storage network
391     value: {get_attr: [StoragePort, ip_address]}
392   storage_mgmt_ip_address:
393     description: IP address of the server in the storage_mgmt network
394     value: {get_attr: [StorageMgmtPort, ip_address]}
395   tenant_ip_address:
396     description: IP address of the server in the tenant network
397     value: {get_attr: [TenantPort, ip_address]}
398   management_ip_address:
399     description: IP address of the server in the management network
400     value: {get_attr: [ManagementPort, ip_address]}