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 default: {{role.ServicesDefault|default([])}}
127 description: Number of {{role.name}} nodes to deploy
129 default: {{role.CountDefault|default(0)}}
131 {{role.name}}HostnameFormat:
134 Format for {{role.name}} node hostnames
135 Note %index% is translated into the index of the node, e.g 0/1/2 etc
136 and %stackname% is replaced with the stack name e.g overcloud
137 {% if role.HostnameFormatDefault %}
138 default: "{{role.HostnameFormatDefault}}"
140 default: "%stackname%-{{role.name.lower()}}-%index%"
143 {{role.name}}RemovalPolicies:
147 List of resources to be removed from {{role.name}} ResourceGroup when
148 doing an update which requires removal of specific resources.
149 Example format ComputeRemovalPolicies: [{'resource_list': ['0']}]
151 {% if role.name != 'Compute' %}
152 {{role.name}}SchedulerHints:
154 NovaComputeSchedulerHints:
157 description: Optional scheduler hints to pass to nova
161 # Identifiers to trigger tasks on nodes
166 Setting to a previously unused value during stack-update will trigger
167 package update on all nodes
172 Setting this to a unique value will re-run any deployment tasks which
173 perform configuration on a Heat stack-update.
177 HeatAuthEncryptionKey:
178 type: OS::Heat::RandomString
181 type: OS::Heat::RandomString
186 type: OS::Heat::RandomString
191 type: OS::TripleO::ServiceNetMap
194 type: OS::TripleO::EndpointMap
197 external: {get_param: CloudName}
198 internal_api: {get_param: CloudNameInternal}
199 storage: {get_param: CloudNameStorage}
200 storage_mgmt: {get_param: CloudNameStorageManagement}
201 ctlplane: {get_param: CloudNameCtlplane}
202 NetIpMap: {get_attr: [VipMap, net_ip_map]}
203 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
205 # Jinja loop for Role in roles_data.yaml
206 {% for role in roles %}
207 # Resources generated for {{role.name}} Role
208 {{role.name}}ServiceChain:
209 type: OS::TripleO::Services
212 get_param: {{role.name}}Services
213 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
214 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
215 DefaultPasswords: {get_attr: [DefaultPasswords, passwords]}
217 {{role.name}}HostsDeployment:
218 type: OS::Heat::StructuredDeployments
220 name: {{role.name}}HostsDeployment
221 config: {get_attr: [hostsConfig, config_id]}
222 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
224 {{role.name}}AllNodesDeployment:
225 type: OS::Heat::StructuredDeployments
226 depends_on: {{role.name}}HostsDeployment
228 name: {{role.name}}AllNodesDeployment
229 config: {get_attr: [allNodesConfig, config_id]}
230 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
232 bootstrap_nodeid: {get_attr: [{{role.name}}, resource.0.hostname]}
233 bootstrap_nodeid_ip: {get_attr: [{{role.name}}, resource.0.ip_address]}
235 {{role.name}}AllNodesValidationDeployment:
236 type: OS::Heat::StructuredDeployments
237 depends_on: {{role.name}}AllNodesDeployment
239 name: {{role.name}}AllNodesValidationDeployment
240 config: {get_resource: AllNodesValidationConfig}
241 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
243 {{role.name}}IpListMap:
244 type: OS::TripleO::Network::Ports::NetIpListMap
246 ControlPlaneIpList: {get_attr: [{{role.name}}, ip_address]}
247 ExternalIpList: {get_attr: [{{role.name}}, external_ip_address]}
248 InternalApiIpList: {get_attr: [{{role.name}}, internal_api_ip_address]}
249 StorageIpList: {get_attr: [{{role.name}}, storage_ip_address]}
250 StorageMgmtIpList: {get_attr: [{{role.name}}, storage_mgmt_ip_address]}
251 TenantIpList: {get_attr: [{{role.name}}, tenant_ip_address]}
252 ManagementIpList: {get_attr: [{{role.name}}, management_ip_address]}
253 EnabledServices: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
254 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
255 ServiceHostnameList: {get_attr: [{{role.name}}, hostname]}
257 # Note (shardy) this somewhat complex yaql may be replaced
258 # with a map_deep_merge function in ocata. It merges the
259 # list of maps, but appends to colliding lists so we can
260 # create a map of lists for all nodes for each network
262 expression: dict($.data.where($ != null).flatten().selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
264 - {get_attr: [{{role.name}}, hostname_map]}
267 type: OS::Heat::ResourceGroup
270 count: {get_param: {{role.name}}Count}
271 removal_policies: {get_param: {{role.name}}RemovalPolicies}
273 type: OS::TripleO::{{role.name}}
275 CloudDomain: {get_param: CloudDomain}
276 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
277 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
280 template: {get_param: {{role.name}}HostnameFormat}
282 '%stackname%': {get_param: 'OS::stack_name'}
284 {% if role.name != 'Compute' %}
285 {{role.name}}SchedulerHints: {get_param: {{role.name}}SchedulerHints}
287 NovaComputeSchedulerHints: {get_param: NovaComputeSchedulerHints}
289 ServiceConfigSettings:
291 - get_attr: [{{role.name}}ServiceChain, role_data, config_settings]
293 - get_attr: [{{r.name}}ServiceChain, role_data, global_config_settings]
295 # This next step combines two yaql passes:
296 # - The inner one does a deep merge on the service_config_settings for all roles
297 # - The outer one filters the map based on the services enabled for the role
298 # then merges the result into one map.
300 expression: let(root => $) -> $.data.map.items().where($[0] in $root.data.services).select($[1]).reduce($1.mergeWith($2), {})
304 expression: $.data.where($ != null).reduce($1.mergeWith($2), {})
307 - get_attr: [{{r.name}}ServiceChain, role_data, service_config_settings]
309 services: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
310 ServiceNames: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
311 MonitoringSubscriptions: {get_attr: [{{role.name}}ServiceChain, role_data, monitoring_subscriptions]}
315 type: OS::TripleO::Hosts::SoftwareConfig
318 {% for role in roles %}
321 - {get_attr: [{{role.name}}, hosts_entry]}
325 type: OS::TripleO::AllNodes::SoftwareConfig
327 cloud_name_external: {get_param: CloudName}
328 cloud_name_internal_api: {get_param: CloudNameInternal}
329 cloud_name_storage: {get_param: CloudNameStorage}
330 cloud_name_storage_mgmt: {get_param: CloudNameStorageManagement}
331 cloud_name_ctlplane: {get_param: CloudNameCtlplane}
335 {% for role in roles %}
336 - {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
341 $.data.groups.flatten()
344 {% for role in roles %}
345 - {get_attr: [{{role.name}}ServiceChain, role_data, logging_groups]}
350 $.data.sources.flatten()
353 {% for role in roles %}
354 - {get_attr: [{{role.name}}ServiceChain, role_data, logging_sources]}
356 controller_ips: {get_attr: [Controller, ip_address]}
357 controller_names: {get_attr: [Controller, hostname]}
359 # Note (shardy) this somewhat complex yaql may be replaced
360 # with a map_deep_merge function in ocata. It merges the
361 # list of maps, but appends to colliding lists when a service
362 # is deployed on more than one role
364 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
367 {% for role in roles %}
368 - {get_attr: [{{role.name}}IpListMap, service_ips]}
372 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
375 {% for role in roles %}
376 - {get_attr: [{{role.name}}IpListMap, service_hostnames]}
378 short_service_node_names:
380 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
383 {% for role in roles %}
384 - {get_attr: [{{role.name}}IpListMap, short_service_hostnames]}
386 # FIXME(shardy): These require further work to move into service_ips
387 memcache_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, MemcachedNetwork]}]}
388 NetVipMap: {get_attr: [VipMap, net_ip_map]}
389 RedisVirtualIP: {get_attr: [RedisVirtualIP, ip_address]}
390 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
391 DeployIdentifier: {get_param: DeployIdentifier}
392 UpdateIdentifier: {get_param: UpdateIdentifier}
395 type: OS::Heat::RandomString
400 type: OS::Heat::RandomString
403 salt: {get_param: RabbitCookieSalt}
406 type: OS::TripleO::DefaultPasswords
408 DefaultMysqlRootPassword: {get_attr: [MysqlRootPassword, value]}
409 DefaultRabbitCookie: {get_attr: [RabbitCookie, value]}
410 DefaultHeatAuthEncryptionKey: {get_attr: [HeatAuthEncryptionKey, value]}
411 DefaultPcsdPassword: {get_attr: [PcsdPassword, value]}
412 DefaultHorizonSecret: {get_attr: [HorizonSecret, value]}
414 # creates the network architecture
416 type: OS::TripleO::Network
419 type: OS::Neutron::Port
422 name: control_virtual_ip
423 network: {get_param: NeutronControlPlaneID}
424 fixed_ips: {get_param: ControlFixedIPs}
425 replacement_policy: AUTO
429 type: OS::TripleO::Network::Ports::RedisVipPort
431 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
432 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
433 PortName: redis_virtual_ip
434 NetworkName: {get_attr: [ServiceNetMap, service_net_map, RedisNetwork]}
436 FixedIPs: {get_param: RedisVirtualFixedIPs}
438 # The public VIP is on the External net, falls back to ctlplane
441 type: OS::TripleO::Network::Ports::ExternalVipPort
443 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
444 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
445 PortName: public_virtual_ip
446 FixedIPs: {get_param: PublicVirtualFixedIPs}
448 InternalApiVirtualIP:
450 type: OS::TripleO::Network::Ports::InternalApiVipPort
452 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
453 PortName: internal_api_virtual_ip
454 FixedIPs: {get_param: InternalApiVirtualFixedIPs}
458 type: OS::TripleO::Network::Ports::StorageVipPort
460 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
461 PortName: storage_virtual_ip
462 FixedIPs: {get_param: StorageVirtualFixedIPs}
464 StorageMgmtVirtualIP:
466 type: OS::TripleO::Network::Ports::StorageMgmtVipPort
468 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
469 PortName: storage_management_virtual_ip
470 FixedIPs: {get_param: StorageMgmtVirtualFixedIPs}
473 type: OS::TripleO::Network::Ports::NetVipMap
475 ControlPlaneIp: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
476 ExternalIp: {get_attr: [PublicVirtualIP, ip_address]}
477 ExternalIpUri: {get_attr: [PublicVirtualIP, ip_address_uri]}
478 InternalApiIp: {get_attr: [InternalApiVirtualIP, ip_address]}
479 InternalApiIpUri: {get_attr: [InternalApiVirtualIP, ip_address_uri]}
480 StorageIp: {get_attr: [StorageVirtualIP, ip_address]}
481 StorageIpUri: {get_attr: [StorageVirtualIP, ip_address_uri]}
482 StorageMgmtIp: {get_attr: [StorageMgmtVirtualIP, ip_address]}
483 StorageMgmtIpUri: {get_attr: [StorageMgmtVirtualIP, ip_address_uri]}
484 # No tenant or management VIP required
486 # All Nodes Validations
487 AllNodesValidationConfig:
488 type: OS::TripleO::AllNodes::Validation
493 - - {get_attr: [Controller, resource.0.external_ip_address]}
494 - {get_attr: [Controller, resource.0.internal_api_ip_address]}
495 - {get_attr: [Controller, resource.0.storage_ip_address]}
496 - {get_attr: [Controller, resource.0.storage_mgmt_ip_address]}
497 - {get_attr: [Controller, resource.0.tenant_ip_address]}
498 - {get_attr: [Controller, resource.0.management_ip_address]}
501 type: OS::TripleO::Tasks::UpdateWorkflow
503 {% for role in roles %}
504 - {{role.name}}AllNodesDeployment
508 {% for role in roles %}
509 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
512 deploy_identifier: {get_param: DeployIdentifier}
513 update_identifier: {get_param: UpdateIdentifier}
515 # Optional ExtraConfig for all nodes - all roles are passed in here, but
516 # the nested template may configure each role differently (or not at all)
518 type: OS::TripleO::AllNodesExtraConfig
521 {% for role in roles %}
522 - {{role.name}}AllNodesValidationDeployment
525 {% for role in roles %}
526 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
529 # Post deployment steps for all roles
531 type: OS::TripleO::PostDeploySteps
532 {% for role in roles %}
534 - {{role.name}}AllNodesDeployment
538 {% for role in roles %}
539 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
542 {% for role in roles %}
543 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data]}
548 description: Asserts that the keystone endpoints have been provisioned.
551 description: URL for the Overcloud Keystone service
552 value: {get_attr: [EndpointMap, endpoint_map, KeystonePublic, uri]}
554 description: Keystone Admin VIP endpoint
555 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystoneAdminApiNetwork]}]}
557 description: Controller VIP for public API endpoints
558 value: {get_attr: [VipMap, net_ip_map, external]}
560 description: VIP for Aodh API internal endpoint
561 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, AodhApiNetwork]}]}
562 CeilometerInternalVip:
563 description: VIP for Ceilometer API internal endpoint
564 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CeilometerApiNetwork]}]}
566 description: VIP for Ceph RGW internal endpoint
567 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CephRgwNetwork]}]}
569 description: VIP for Cinder API internal endpoint
570 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CinderApiNetwork]}]}
572 description: VIP for Glance API internal endpoint
573 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GlanceApiNetwork]}]}
575 description: VIP for Gnocchi API internal endpoint
576 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GnocchiApiNetwork]}]}
578 description: VIP for Heat API internal endpoint
579 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, HeatApiNetwork]}]}
581 description: VIP for Ironic API internal endpoint
582 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, IronicApiNetwork]}]}
584 description: VIP for Keystone API internal endpoint
585 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystonePublicApiNetwork]}]}
587 description: VIP for Manila API internal endpoint
588 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, ManilaApiNetwork]}]}
590 description: VIP for Neutron API internal endpoint
591 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NeutronApiNetwork]}]}
593 description: VIP for Nova API internal endpoint
594 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NovaApiNetwork]}]}
595 OpenDaylightInternalVip:
596 description: VIP for OpenDaylight API internal endpoint
597 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, OpenDaylightApiNetwork]}]}
599 description: VIP for Sahara API internal endpoint
600 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SaharaApiNetwork]}]}
602 description: VIP for Swift Proxy internal endpoint
603 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SwiftProxyNetwork]}]}
606 Mapping of the resources with the needed info for their endpoints.
607 This includes the protocol used, the IP, port and also a full
608 representation of the URI.
609 value: {get_attr: [EndpointMap, endpoint_map]}
612 The content that should be appended to your /etc/hosts if you want to get
613 hostname-based access to the deployed nodes (useful for testing without
618 - - {get_attr: [hostsConfig, hosts_entries]}
623 IP: {get_attr: [VipMap, net_ip_map, external]}
624 HOST: {get_param: CloudName}
628 IP: {get_attr: [VipMap, net_ip_map, ctlplane]}
629 HOST: {get_param: CloudNameCtlplane}
633 IP: {get_attr: [VipMap, net_ip_map, internal_api]}
634 HOST: {get_param: CloudNameInternal}
638 IP: {get_attr: [VipMap, net_ip_map, storage]}
639 HOST: {get_param: CloudNameStorage}
643 IP: {get_attr: [VipMap, net_ip_map, storage_mgmt]}
644 HOST: {get_param: CloudNameStorageManagement}
646 description: The services enabled on each role
648 {% for role in roles %}
649 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}