Merge "Remove unneeded net_ip_map dump into hieradata"
[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   HashSuffix:
11     description: A random string to be used as a salt when hashing to determine mappings
12       in the ring.
13     hidden: true
14     type: string
15   SwiftStorageImage:
16     default: overcloud-full
17     type: string
18     constraints:
19       - custom_constraint: glance.image
20   KeyName:
21     default: default
22     description: Name of an existing Nova key pair to enable SSH access to the instances
23     type: string
24   SnmpdReadonlyUserName:
25     default: ro_snmp_user
26     description: The user name for SNMPd with readonly rights running on all Overcloud nodes
27     type: string
28   SnmpdReadonlyUserPassword:
29     description: The user password for SNMPd with readonly rights running on all Overcloud nodes
30     type: string
31     hidden: true
32   EnablePackageInstall:
33     default: 'false'
34     description: Set to true to enable package installation via Puppet
35     type: boolean
36   UpdateIdentifier:
37     default: ''
38     type: string
39     description: >
40       Setting to a previously unused value during stack-update will trigger
41       package update on all nodes
42   ServiceNetMap:
43     default: {}
44     description: Mapping of service_name -> network name. Typically set
45                  via parameter_defaults in the resource registry.
46     type: json
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   ExtraConfig:
55     default: {}
56     description: |
57       Additional hiera configuration to inject into the cluster. Note
58       that ObjectStorageExtraConfig takes precedence over ExtraConfig.
59     type: json
60   ObjectStorageExtraConfig:
61     default: {}
62     description: |
63       Role specific additional hiera configuration to inject into the cluster.
64     type: json
65   SwiftStorageIPs:
66     default: {}
67     type: json
68   NetworkDeploymentActions:
69     type: comma_delimited_list
70     description: >
71       Heat action when to apply network configuration changes
72     default: ['CREATE']
73   SoftwareConfigTransport:
74     default: POLL_SERVER_CFN
75     description: |
76       How the server should receive the metadata required for software configuration.
77     type: string
78     constraints:
79     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
80   CloudDomain:
81     type: string
82     description: >
83       The DNS domain used for the hosts. This should match the dhcp_domain
84       configured in the Undercloud neutron. Defaults to localdomain.
85   ServerMetadata:
86     default: {}
87     description: >
88       Extra properties or metadata passed to Nova for the created nodes in
89       the overcloud. It's accessible via the Nova metadata API.
90     type: json
91   ObjectStorageSchedulerHints:
92     type: json
93     description: Optional scheduler hints to pass to nova
94     default: {}
95   NodeIndex:
96     type: number
97     default: 0
98   ServiceConfigSettings:
99     type: json
100     default: {}
101   ServiceNames:
102     type: comma_delimited_list
103     default: []
104   ConfigCommand:
105     type: string
106     description: Command which will be run whenever configuration data changes
107     default: os-refresh-config --timeout 14400
108
109 resources:
110
111   SwiftStorage:
112     type: OS::Nova::Server
113     metadata:
114       os-collect-config:
115         command: {get_param: ConfigCommand}
116     properties:
117       image: {get_param: SwiftStorageImage}
118       flavor: {get_param: OvercloudSwiftStorageFlavor}
119       key_name: {get_param: KeyName}
120       networks:
121         - network: ctlplane
122       user_data_format: SOFTWARE_CONFIG
123       user_data: {get_resource: UserData}
124       name:
125         str_replace:
126             template: {get_param: Hostname}
127             params: {get_param: HostnameMap}
128       software_config_transport: {get_param: SoftwareConfigTransport}
129       metadata: {get_param: ServerMetadata}
130       scheduler_hints: {get_param: ObjectStorageSchedulerHints}
131
132   # Combine the NodeAdminUserData and NodeUserData mime archives
133   UserData:
134     type: OS::Heat::MultipartMime
135     properties:
136       parts:
137       - config: {get_resource: NodeAdminUserData}
138         type: multipart
139       - config: {get_resource: NodeUserData}
140         type: multipart
141
142   # Creates the "heat-admin" user if configured via the environment
143   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
144   NodeAdminUserData:
145     type: OS::TripleO::NodeAdminUserData
146
147   # For optional operator additional userdata
148   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
149   NodeUserData:
150     type: OS::TripleO::NodeUserData
151
152   ExternalPort:
153     type: OS::TripleO::SwiftStorage::Ports::ExternalPort
154     properties:
155       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
156       IPPool: {get_param: SwiftStorageIPs}
157       NodeIndex: {get_param: NodeIndex}
158
159   InternalApiPort:
160     type: OS::TripleO::SwiftStorage::Ports::InternalApiPort
161     properties:
162       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
163       IPPool: {get_param: SwiftStorageIPs}
164       NodeIndex: {get_param: NodeIndex}
165
166   StoragePort:
167     type: OS::TripleO::SwiftStorage::Ports::StoragePort
168     properties:
169       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
170       IPPool: {get_param: SwiftStorageIPs}
171       NodeIndex: {get_param: NodeIndex}
172
173   StorageMgmtPort:
174     type: OS::TripleO::SwiftStorage::Ports::StorageMgmtPort
175     properties:
176       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
177       IPPool: {get_param: SwiftStorageIPs}
178       NodeIndex: {get_param: NodeIndex}
179
180   TenantPort:
181     type: OS::TripleO::SwiftStorage::Ports::TenantPort
182     properties:
183       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
184       IPPool: {get_param: SwiftStorageIPs}
185       NodeIndex: {get_param: NodeIndex}
186
187   ManagementPort:
188     type: OS::TripleO::SwiftStorage::Ports::ManagementPort
189     properties:
190       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
191       IPPool: {get_param: SwiftStorageIPs}
192       NodeIndex: {get_param: NodeIndex}
193
194   NetworkConfig:
195     type: OS::TripleO::ObjectStorage::Net::SoftwareConfig
196     properties:
197       ControlPlaneIp: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
198       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
199       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
200       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
201       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
202       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
203       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
204
205   NetIpMap:
206     type: OS::TripleO::Network::Ports::NetIpMap
207     properties:
208       ControlPlaneIp: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
209       ExternalIp: {get_attr: [ExternalPort, ip_address]}
210       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
211       ExternalIpUri: {get_attr: [ExternalPort, ip_address_uri]}
212       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
213       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
214       InternalApiIpUri: {get_attr: [InternalApiPort, ip_address_uri]}
215       StorageIp: {get_attr: [StoragePort, ip_address]}
216       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
217       StorageIpUri: {get_attr: [StoragePort, ip_address_uri]}
218       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
219       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
220       StorageMgmtIpUri: {get_attr: [StorageMgmtPort, ip_address_uri]}
221       TenantIp: {get_attr: [TenantPort, ip_address]}
222       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
223       TenantIpUri: {get_attr: [TenantPort, ip_address_uri]}
224       ManagementIp: {get_attr: [ManagementPort, ip_address]}
225       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
226       ManagementIpUri: {get_attr: [ManagementPort, ip_address_uri]}
227
228   NetworkDeployment:
229     type: OS::TripleO::SoftwareDeployment
230     properties:
231       name: NetworkDeployment
232       config: {get_resource: NetworkConfig}
233       server: {get_resource: SwiftStorage}
234       actions: {get_param: NetworkDeploymentActions}
235
236   SwiftStorageHieraConfig:
237     type: OS::Heat::StructuredConfig
238     properties:
239       group: os-apply-config
240       config:
241         hiera:
242           hierarchy:
243             - '"%{::uuid}"'
244             - heat_config_%{::deploy_config_name}
245             - object_extraconfig
246             - extraconfig
247             - service_names
248             - service_configs
249             - object
250             - swift_devices_and_proxy # provided by SwiftDevicesAndProxyConfig
251             - all_nodes # provided by allNodesConfig
252             - '"%{::osfamily}"'
253           merge_behavior: deeper
254           datafiles:
255             service_names:
256               mapped_data:
257                 service_names: {get_param: ServiceNames}
258             service_configs:
259               mapped_data:
260                 map_replace:
261                   - {get_param: ServiceConfigSettings}
262                   - values: {get_attr: [NetIpMap, net_ip_map]}
263             object_extraconfig:
264               mapped_data: {get_param: ObjectStorageExtraConfig}
265             extraconfig:
266               mapped_data: {get_param: ExtraConfig}
267             object:
268               mapped_data: # data supplied directly to this deployment configuration, etc
269                 swift::swift_hash_path_suffix: { get_input: swift_hash_suffix }
270                 swift::storage::all::storage_local_net_ip: {get_input: swift_management_network}
271                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
272                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
273                 tripleo::packages::enable_install: {get_input: enable_package_install}
274                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
275
276
277   SwiftStorageHieraDeploy:
278     type: OS::Heat::StructuredDeployment
279     depends_on: NetworkDeployment
280     properties:
281       name: SwiftStorageHieraDeploy
282       server: {get_resource: SwiftStorage}
283       config: {get_resource: SwiftStorageHieraConfig}
284       input_values:
285         local_ip: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
286         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
287         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
288         swift_hash_suffix: {get_param: HashSuffix}
289         enable_package_install: {get_param: EnablePackageInstall}
290         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
291         swift_management_network: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, SwiftMgmtNetwork]}]}
292
293   # Resource for site-specific injection of root certificate
294   NodeTLSCAData:
295     depends_on: SwiftStorageHieraDeploy
296     type: OS::TripleO::NodeTLSCAData
297     properties:
298       server: {get_resource: SwiftStorage}
299
300   # Hook for site-specific additional pre-deployment config,
301   # applying to all nodes, e.g node registration/unregistration
302   NodeExtraConfig:
303     depends_on: NodeTLSCAData
304     type: OS::TripleO::NodeExtraConfig
305     properties:
306         server: {get_resource: SwiftStorage}
307
308   UpdateConfig:
309     type: OS::TripleO::Tasks::PackageUpdate
310
311   UpdateDeployment:
312     type: OS::Heat::SoftwareDeployment
313     properties:
314       config: {get_resource: UpdateConfig}
315       server: {get_resource: SwiftStorage}
316       input_values:
317         update_identifier:
318           get_param: UpdateIdentifier
319
320 outputs:
321   ip_address:
322     description: IP address of the server in the ctlplane network
323     value: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
324   hostname:
325     description: Hostname of the server
326     value: {get_attr: [SwiftStorage, name]}
327   hosts_entry:
328     value:
329       str_replace:
330         template: |
331           PRIMARYIP PRIMARYHOST.DOMAIN PRIMARYHOST
332           EXTERNALIP EXTERNALHOST.DOMAIN EXTERNALHOST
333           INTERNAL_APIIP INTERNAL_APIHOST.DOMAIN INTERNAL_APIHOST
334           STORAGEIP STORAGEHOST.DOMAIN STORAGEHOST
335           STORAGE_MGMTIP STORAGE_MGMTHOST.DOMAIN STORAGE_MGMTHOST
336           TENANTIP TENANTHOST.DOMAIN TENANTHOST
337           MANAGEMENTIP MANAGEMENTHOST.DOMAIN MANAGEMENTHOST
338         params:
339           PRIMARYIP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, ObjectStorageHostnameResolveNetwork]}]}
340           DOMAIN: {get_param: CloudDomain}
341           PRIMARYHOST: {get_attr: [SwiftStorage, name]}
342           EXTERNALIP: {get_attr: [ExternalPort, ip_address]}
343           EXTERNALHOST:
344             list_join:
345             - '.'
346             - - {get_attr: [SwiftStorage, name]}
347               - external
348           INTERNAL_APIIP: {get_attr: [InternalApiPort, ip_address]}
349           INTERNAL_APIHOST:
350             list_join:
351             - '.'
352             - - {get_attr: [SwiftStorage, name]}
353               - internalapi
354           STORAGEIP: {get_attr: [StoragePort, ip_address]}
355           STORAGEHOST:
356             list_join:
357             - '.'
358             - - {get_attr: [SwiftStorage, name]}
359               - storage
360           STORAGE_MGMTIP: {get_attr: [StorageMgmtPort, ip_address]}
361           STORAGE_MGMTHOST:
362             list_join:
363             - '.'
364             - - {get_attr: [SwiftStorage, name]}
365               - storagemgmt
366           TENANTIP: {get_attr: [TenantPort, ip_address]}
367           TENANTHOST:
368             list_join:
369             - '.'
370             - - {get_attr: [SwiftStorage, name]}
371               - tenant
372           MANAGEMENTIP: {get_attr: [ManagementPort, ip_address]}
373           MANAGEMENTHOST:
374             list_join:
375             - '.'
376             - - {get_attr: [SwiftStorage, name]}
377               - management
378   nova_server_resource:
379     description: Heat resource handle for the swift storage server
380     value:
381       {get_resource: SwiftStorage}
382   swift_device:
383     description: Swift device formatted for swift-ring-builder
384     value:
385       str_replace:
386         template: 'r1z1-IP:%PORT%/d1'
387         params:
388           IP:
389             get_attr:
390               - NetIpMap
391               - net_ip_map
392               - str_replace:
393                   template: "NETWORK_uri"
394                   params:
395                     NETWORK: {get_param: [ServiceNetMap, SwiftMgmtNetwork]}
396   external_ip_address:
397     description: IP address of the server in the external network
398     value: {get_attr: [ExternalPort, ip_address]}
399   internal_api_ip_address:
400     description: IP address of the server in the internal_api network
401     value: {get_attr: [InternalApiPort, ip_address]}
402   storage_ip_address:
403     description: IP address of the server in the storage network
404     value: {get_attr: [StoragePort, ip_address]}
405   storage_mgmt_ip_address:
406     description: IP address of the server in the storage_mgmt network
407     value: {get_attr: [StorageMgmtPort, ip_address]}
408   tenant_ip_address:
409     description: IP address of the server in the tenant network
410     value: {get_attr: [TenantPort, ip_address]}
411   management_ip_address:
412     description: IP address of the server in the management network
413     value: {get_attr: [ManagementPort, ip_address]}