1 heat_template_version: 2016-10-14
4 Deploy an OpenStack environment, consisting of several node types (roles),
5 Controller, Compute, BlockStorage, SwiftStorage and CephStorage. The Storage
6 roles enable independent scaling of the storage components, but the minimal
7 deployment is one Controller and one Compute node.
10 # TODO(shadower): we should probably use the parameter groups to put
14 # Common parameters (not specific to a role)
16 default: overcloud.localdomain
17 description: The DNS name of this cloud. E.g. ci-overcloud.tripleo.org
20 default: overcloud.internalapi.localdomain
22 The DNS name of this cloud's internal API endpoint. E.g.
23 'ci-overcloud.internalapi.tripleo.org'.
26 default: overcloud.storage.localdomain
28 The DNS name of this cloud's storage endpoint. E.g.
29 'ci-overcloud.storage.tripleo.org'.
31 CloudNameStorageManagement:
32 default: overcloud.storagemgmt.localdomain
34 The DNS name of this cloud's storage management endpoint. E.g.
35 'ci-overcloud.storagemgmt.tripleo.org'.
38 default: overcloud.ctlplane.localdomain
40 The DNS name of this cloud's storage management endpoint. E.g.
41 'ci-overcloud.management.tripleo.org'.
45 description: Should be used for arbitrary ips.
47 InternalApiVirtualFixedIPs:
50 Control the IP allocation for the InternalApiVirtualInterface port. E.g.
51 [{'ip_address':'1.2.3.4'}]
53 NeutronControlPlaneID:
56 description: Neutron ID or name for ctlplane network.
57 NeutronPublicInterface:
59 description: What interface to bridge onto br-ex for network nodes.
61 PublicVirtualFixedIPs:
64 Control the IP allocation for the PublicVirtualInterface port. E.g.
65 [{'ip_address':'1.2.3.4'}]
70 description: Salt for the rabbit cookie, change this to force the randomly generated rabbit cookie to change.
71 StorageVirtualFixedIPs:
74 Control the IP allocation for the StorageVirtualInterface port. E.g.
75 [{'ip_address':'1.2.3.4'}]
77 StorageMgmtVirtualFixedIPs:
80 Control the IP allocation for the StorageMgmgVirtualInterface port. E.g.
81 [{'ip_address':'1.2.3.4'}]
86 Control the IP allocation for the virtual IP used by Redis. E.g.
87 [{'ip_address':'1.2.3.4'}]
90 default: 'localdomain'
93 The DNS domain used for the hosts. This should match the dhcp_domain
94 configured in the Undercloud neutron. Defaults to localdomain.
98 Extra properties or metadata passed to Nova for the created nodes in
99 the overcloud. It's accessible via the Nova metadata API.
102 # Compute-specific params
103 # FIXME(shardy) handle these deprecated names as they don't match compute.yaml
104 HypervisorNeutronPhysicalBridge:
107 An OVS bridge to create on each hypervisor. This defaults to br-ex the
108 same as the control plane nodes, as we have a uniform configuration of
109 the openvswitch agent. Typically should not need to be changed.
111 HypervisorNeutronPublicInterface:
113 description: What interface to add to the HypervisorNeutronPhysicalBridge.
116 # Jinja loop for Role in role_data.yaml
117 {% for role in roles %}
118 # Parameters generated for {{role.name}} Role
119 {{role.name}}Services:
120 description: A list of service resources (configured in the Heat
121 resource_registry) which represent nested stacks
122 for each service that should get installed on the {{role.name}} role.
123 type: comma_delimited_list
124 {% if role.ServicesDefault %}
125 default: {{role.ServicesDefault}}
129 description: Number of {{role.name}} nodes to deploy
131 {% if role.CountDefault %}
132 default: {{role.CountDefault}}
135 {{role.name}}HostnameFormat:
138 Format for {{role.name}} node hostnames
139 Note %index% is translated into the index of the node, e.g 0/1/2 etc
140 and %stackname% is replaced with the stack name e.g overcloud
141 {% if role.HostnameFormatDefault %}
142 default: "{{role.HostnameFormatDefault}}"
145 {{role.name}}RemovalPolicies:
149 List of resources to be removed from {{role.name}} ResourceGroup when
150 doing an update which requires removal of specific resources.
151 Example format ComputeRemovalPolicies: [{'resource_list': ['0']}]
154 # Identifiers to trigger tasks on nodes
159 Setting to a previously unused value during stack-update will trigger
160 package update on all nodes
165 Setting this to a unique value will re-run any deployment tasks which
166 perform configuration on a Heat stack-update.
170 HeatAuthEncryptionKey:
171 type: OS::Heat::RandomString
174 type: OS::Heat::RandomString
179 type: OS::Heat::RandomString
184 type: OS::TripleO::ServiceNetMap
187 type: OS::TripleO::EndpointMap
190 external: {get_param: CloudName}
191 internal_api: {get_param: CloudNameInternal}
192 storage: {get_param: CloudNameStorage}
193 storage_mgmt: {get_param: CloudNameStorageManagement}
194 ctlplane: {get_param: CloudNameCtlplane}
195 NetIpMap: {get_attr: [VipMap, net_ip_map]}
196 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
198 # Jinja loop for Role in roles_data.yaml
199 {% for role in roles %}
200 # Resources generated for {{role.name}} Role
201 {{role.name}}ServiceChain:
202 type: OS::TripleO::Services
205 get_param: {{role.name}}Services
206 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
207 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
208 DefaultPasswords: {get_attr: [DefaultPasswords, passwords]}
210 {{role.name}}AllNodesDeployment:
211 type: OS::Heat::StructuredDeployments
213 name: {{role.name}}AllNodesDeployment
214 config: {get_attr: [allNodesConfig, config_id]}
215 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
217 bootstrap_nodeid: {get_attr: [{{role.name}}, resource.0.hostname]}
218 bootstrap_nodeid_ip: {get_attr: [{{role.name}}, resource.0.ip_address]}
220 {{role.name}}AllNodesValidationDeployment:
221 type: OS::Heat::StructuredDeployments
222 depends_on: {{role.name}}AllNodesDeployment
224 name: {{role.name}}AllNodesValidationDeployment
225 config: {get_resource: AllNodesValidationConfig}
226 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
228 {{role.name}}IpListMap:
229 type: OS::TripleO::Network::Ports::NetIpListMap
231 ControlPlaneIpList: {get_attr: [{{role.name}}, ip_address]}
232 ExternalIpList: {get_attr: [{{role.name}}, external_ip_address]}
233 InternalApiIpList: {get_attr: [{{role.name}}, internal_api_ip_address]}
234 StorageIpList: {get_attr: [{{role.name}}, storage_ip_address]}
235 StorageMgmtIpList: {get_attr: [{{role.name}}, storage_mgmt_ip_address]}
236 TenantIpList: {get_attr: [{{role.name}}, tenant_ip_address]}
237 ManagementIpList: {get_attr: [{{role.name}}, management_ip_address]}
238 EnabledServices: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
239 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
240 ServiceHostnameList: {get_attr: [{{role.name}}, hostname]}
243 type: OS::Heat::ResourceGroup
246 count: {get_param: {{role.name}}Count}
247 removal_policies: {get_param: {{role.name}}RemovalPolicies}
249 type: OS::TripleO::{{role.name}}
251 CloudDomain: {get_param: CloudDomain}
252 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
253 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
256 template: {get_param: {{role.name}}HostnameFormat}
258 '%stackname%': {get_param: 'OS::stack_name'}
260 ServiceConfigSettings:
262 - get_attr: [{{role.name}}ServiceChain, role_data, config_settings]
264 - get_attr: [{{r.name}}ServiceChain, role_data, global_config_settings]
266 ServiceNames: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
267 MonitoringSubscriptions: {get_attr: [{{role.name}}ServiceChain, role_data, monitoring_subscriptions]}
271 type: OS::TripleO::AllNodes::SoftwareConfig
273 cloud_name_external: {get_param: CloudName}
274 cloud_name_internal_api: {get_param: CloudNameInternal}
275 cloud_name_storage: {get_param: CloudNameStorage}
276 cloud_name_storage_mgmt: {get_param: CloudNameStorageManagement}
277 cloud_name_ctlplane: {get_param: CloudNameCtlplane}
279 {% for role in roles %}
282 - {get_attr: [{{role.name}}, hosts_entry]}
287 {% for role in roles %}
288 - {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
290 controller_ips: {get_attr: [Controller, ip_address]}
291 controller_names: {get_attr: [Controller, hostname]}
293 # Note (shardy) this somewhat complex yaql may be replaced
294 # with a map_deep_merge function in ocata. It merges the
295 # list of maps, but appends to colliding lists when a service
296 # is deployed on more than one role
298 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
301 {% for role in roles %}
302 - {get_attr: [{{role.name}}IpListMap, service_ips]}
306 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
309 {% for role in roles %}
310 - {get_attr: [{{role.name}}IpListMap, service_hostnames]}
312 # FIXME(shardy): These require further work to move into service_ips
313 memcache_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, MemcachedNetwork]}]}
314 keystone_public_api_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystonePublicApiNetwork]}]}
315 keystone_admin_api_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystoneAdminApiNetwork]}]}
316 NetVipMap: {get_attr: [VipMap, net_ip_map]}
317 RedisVirtualIP: {get_attr: [RedisVirtualIP, ip_address]}
318 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
319 DeployIdentifier: {get_param: DeployIdentifier}
320 UpdateIdentifier: {get_param: UpdateIdentifier}
323 type: OS::Heat::RandomString
328 type: OS::Heat::RandomString
331 salt: {get_param: RabbitCookieSalt}
334 type: OS::TripleO::DefaultPasswords
336 DefaultMysqlRootPassword: {get_attr: [MysqlRootPassword, value]}
337 DefaultRabbitCookie: {get_attr: [RabbitCookie, value]}
338 DefaultHeatAuthEncryptionKey: {get_attr: [HeatAuthEncryptionKey, value]}
339 DefaultPcsdPassword: {get_attr: [PcsdPassword, value]}
340 DefaultHorizonSecret: {get_attr: [HorizonSecret, value]}
342 # creates the network architecture
344 type: OS::TripleO::Network
347 type: OS::Neutron::Port
350 name: control_virtual_ip
351 network: {get_param: NeutronControlPlaneID}
352 fixed_ips: {get_param: ControlFixedIPs}
353 replacement_policy: AUTO
357 type: OS::TripleO::Network::Ports::RedisVipPort
359 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
360 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
361 PortName: redis_virtual_ip
362 NetworkName: {get_attr: [ServiceNetMap, service_net_map, RedisNetwork]}
364 FixedIPs: {get_param: RedisVirtualFixedIPs}
366 # The public VIP is on the External net, falls back to ctlplane
369 type: OS::TripleO::Network::Ports::ExternalVipPort
371 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
372 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
373 PortName: public_virtual_ip
374 FixedIPs: {get_param: PublicVirtualFixedIPs}
376 InternalApiVirtualIP:
378 type: OS::TripleO::Network::Ports::InternalApiVipPort
380 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
381 PortName: internal_api_virtual_ip
382 FixedIPs: {get_param: InternalApiVirtualFixedIPs}
386 type: OS::TripleO::Network::Ports::StorageVipPort
388 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
389 PortName: storage_virtual_ip
390 FixedIPs: {get_param: StorageVirtualFixedIPs}
392 StorageMgmtVirtualIP:
394 type: OS::TripleO::Network::Ports::StorageMgmtVipPort
396 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
397 PortName: storage_management_virtual_ip
398 FixedIPs: {get_param: StorageMgmtVirtualFixedIPs}
401 type: OS::TripleO::Network::Ports::NetVipMap
403 ControlPlaneIp: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
404 ExternalIp: {get_attr: [PublicVirtualIP, ip_address]}
405 ExternalIpUri: {get_attr: [PublicVirtualIP, ip_address_uri]}
406 InternalApiIp: {get_attr: [InternalApiVirtualIP, ip_address]}
407 InternalApiIpUri: {get_attr: [InternalApiVirtualIP, ip_address_uri]}
408 StorageIp: {get_attr: [StorageVirtualIP, ip_address]}
409 StorageIpUri: {get_attr: [StorageVirtualIP, ip_address_uri]}
410 StorageMgmtIp: {get_attr: [StorageMgmtVirtualIP, ip_address]}
411 StorageMgmtIpUri: {get_attr: [StorageMgmtVirtualIP, ip_address_uri]}
412 # No tenant or management VIP required
414 # All Nodes Validations
415 AllNodesValidationConfig:
416 type: OS::TripleO::AllNodes::Validation
421 - - {get_attr: [Controller, resource.0.external_ip_address]}
422 - {get_attr: [Controller, resource.0.internal_api_ip_address]}
423 - {get_attr: [Controller, resource.0.storage_ip_address]}
424 - {get_attr: [Controller, resource.0.storage_mgmt_ip_address]}
425 - {get_attr: [Controller, resource.0.tenant_ip_address]}
426 - {get_attr: [Controller, resource.0.management_ip_address]}
429 type: OS::TripleO::Tasks::UpdateWorkflow
432 {% for role in roles %}
433 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
436 deploy_identifier: {get_param: DeployIdentifier}
437 update_identifier: {get_param: UpdateIdentifier}
439 # Optional ExtraConfig for all nodes - all roles are passed in here, but
440 # the nested template may configure each role differently (or not at all)
442 type: OS::TripleO::AllNodesExtraConfig
445 {% for role in roles %}
446 - {{role.name}}AllNodesValidationDeployment
449 {% for role in roles %}
450 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
453 # Post deployment steps for all roles
455 type: OS::TripleO::PostDeploySteps
458 {% for role in roles %}
459 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
462 {% for role in roles %}
463 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data]}
468 description: Asserts that the keystone endpoints have been provisioned.
471 description: URL for the Overcloud Keystone service
472 value: {get_attr: [EndpointMap, endpoint_map, KeystonePublic, uri]}
474 description: Keystone Admin VIP endpoint
475 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystoneAdminApiNetwork]}]}
477 description: Controller VIP for public API endpoints
478 value: {get_attr: [VipMap, net_ip_map, external]}
480 description: VIP for Aodh API internal endpoint
481 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, AodhApiNetwork]}]}
482 CeilometerInternalVip:
483 description: VIP for Ceilometer API internal endpoint
484 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CeilometerApiNetwork]}]}
486 description: VIP for Ceph RGW internal endpoint
487 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CephRgwNetwork]}]}
489 description: VIP for Cinder API internal endpoint
490 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CinderApiNetwork]}]}
492 description: VIP for Glance API internal endpoint
493 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GlanceApiNetwork]}]}
495 description: VIP for Gnocchi API internal endpoint
496 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GnocchiApiNetwork]}]}
498 description: VIP for Heat API internal endpoint
499 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, HeatApiNetwork]}]}
501 description: VIP for Ironic API internal endpoint
502 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, IronicApiNetwork]}]}
504 description: VIP for Keystone API internal endpoint
505 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystonePublicApiNetwork]}]}
507 description: VIP for Manila API internal endpoint
508 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, ManilaApiNetwork]}]}
510 description: VIP for Neutron API internal endpoint
511 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NeutronApiNetwork]}]}
513 description: VIP for Nova API internal endpoint
514 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NovaApiNetwork]}]}
515 OpenDaylightInternalVip:
516 description: VIP for OpenDaylight API internal endpoint
517 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, OpenDaylightApiNetwork]}]}
519 description: VIP for Sahara API internal endpoint
520 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SaharaApiNetwork]}]}
522 description: VIP for Swift Proxy internal endpoint
523 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SwiftProxyNetwork]}]}
526 Mapping of the resources with the needed info for their endpoints.
527 This includes the protocol used, the IP, port and also a full
528 representation of the URI.
529 value: {get_attr: [EndpointMap, endpoint_map]}
532 The content that should be appended to your /etc/hosts if you want to get
533 hostname-based access to the deployed nodes (useful for testing without
535 value: {get_attr: [allNodesConfig, hosts_entries]}
537 description: The services enabled on each role
539 Controller: {get_attr: [ControllerServiceChain, role_data, service_names]}
540 Compute: {get_attr: [ComputeServiceChain, role_data, service_names]}
541 BlockStorage: {get_attr: [BlockStorageServiceChain, role_data, service_names]}
542 ObjectStorage: {get_attr: [ObjectStorageServiceChain, role_data, service_names]}
543 CephStorage: {get_attr: [CephStorageServiceChain, role_data, service_names]}