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}}AllNodesDeployment:
218 type: OS::Heat::StructuredDeployments
220 name: {{role.name}}AllNodesDeployment
221 config: {get_attr: [allNodesConfig, config_id]}
222 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
224 bootstrap_nodeid: {get_attr: [{{role.name}}, resource.0.hostname]}
225 bootstrap_nodeid_ip: {get_attr: [{{role.name}}, resource.0.ip_address]}
227 {{role.name}}AllNodesValidationDeployment:
228 type: OS::Heat::StructuredDeployments
229 depends_on: {{role.name}}AllNodesDeployment
231 name: {{role.name}}AllNodesValidationDeployment
232 config: {get_resource: AllNodesValidationConfig}
233 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
235 {{role.name}}IpListMap:
236 type: OS::TripleO::Network::Ports::NetIpListMap
238 ControlPlaneIpList: {get_attr: [{{role.name}}, ip_address]}
239 ExternalIpList: {get_attr: [{{role.name}}, external_ip_address]}
240 InternalApiIpList: {get_attr: [{{role.name}}, internal_api_ip_address]}
241 StorageIpList: {get_attr: [{{role.name}}, storage_ip_address]}
242 StorageMgmtIpList: {get_attr: [{{role.name}}, storage_mgmt_ip_address]}
243 TenantIpList: {get_attr: [{{role.name}}, tenant_ip_address]}
244 ManagementIpList: {get_attr: [{{role.name}}, management_ip_address]}
245 EnabledServices: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
246 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
247 ServiceHostnameList: {get_attr: [{{role.name}}, hostname]}
249 # Note (shardy) this somewhat complex yaql may be replaced
250 # with a map_deep_merge function in ocata. It merges the
251 # list of maps, but appends to colliding lists so we can
252 # create a map of lists for all nodes for each network
254 expression: dict($.data.where($ != null).flatten().selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
256 - {get_attr: [{{role.name}}, hostname_map]}
259 type: OS::Heat::ResourceGroup
262 count: {get_param: {{role.name}}Count}
263 removal_policies: {get_param: {{role.name}}RemovalPolicies}
265 type: OS::TripleO::{{role.name}}
267 CloudDomain: {get_param: CloudDomain}
268 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
269 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
272 template: {get_param: {{role.name}}HostnameFormat}
274 '%stackname%': {get_param: 'OS::stack_name'}
276 {% if role.name != 'Compute' %}
277 {{role.name}}SchedulerHints: {get_param: {{role.name}}SchedulerHints}
279 NovaComputeSchedulerHints: {get_param: NovaComputeSchedulerHints}
281 ServiceConfigSettings:
283 - get_attr: [{{role.name}}ServiceChain, role_data, config_settings]
285 - get_attr: [{{r.name}}ServiceChain, role_data, global_config_settings]
287 # This next step combines two yaql passes:
288 # - The inner one does a deep merge on the service_config_settings for all roles
289 # - The outer one filters the map based on the services enabled for the role
290 # then merges the result into one map.
292 expression: let(root => $) -> $.data.map.items().where($[0] in $root.data.services).select($[1]).reduce($1.mergeWith($2), {})
296 expression: $.data.where($ != null).reduce($1.mergeWith($2), {})
299 - get_attr: [{{r.name}}ServiceChain, role_data, service_config_settings]
301 services: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
302 ServiceNames: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
303 MonitoringSubscriptions: {get_attr: [{{role.name}}ServiceChain, role_data, monitoring_subscriptions]}
304 LoggingSources: {get_attr: [{{role.name}}ServiceChain, role_data, logging_sources]}
305 LoggingGroups: {get_attr: [{{role.name}}ServiceChain, role_data, logging_groups]}
309 type: OS::TripleO::AllNodes::SoftwareConfig
311 cloud_name_external: {get_param: CloudName}
312 cloud_name_internal_api: {get_param: CloudNameInternal}
313 cloud_name_storage: {get_param: CloudNameStorage}
314 cloud_name_storage_mgmt: {get_param: CloudNameStorageManagement}
315 cloud_name_ctlplane: {get_param: CloudNameCtlplane}
317 {% for role in roles %}
320 - {get_attr: [{{role.name}}, hosts_entry]}
325 {% for role in roles %}
326 - {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
328 controller_ips: {get_attr: [Controller, ip_address]}
329 controller_names: {get_attr: [Controller, hostname]}
331 # Note (shardy) this somewhat complex yaql may be replaced
332 # with a map_deep_merge function in ocata. It merges the
333 # list of maps, but appends to colliding lists when a service
334 # is deployed on more than one role
336 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
339 {% for role in roles %}
340 - {get_attr: [{{role.name}}IpListMap, service_ips]}
344 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
347 {% for role in roles %}
348 - {get_attr: [{{role.name}}IpListMap, service_hostnames]}
350 short_service_node_names:
352 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
355 {% for role in roles %}
356 - {get_attr: [{{role.name}}IpListMap, short_service_hostnames]}
358 # FIXME(shardy): These require further work to move into service_ips
359 memcache_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, MemcachedNetwork]}]}
360 NetVipMap: {get_attr: [VipMap, net_ip_map]}
361 RedisVirtualIP: {get_attr: [RedisVirtualIP, ip_address]}
362 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
363 DeployIdentifier: {get_param: DeployIdentifier}
364 UpdateIdentifier: {get_param: UpdateIdentifier}
367 type: OS::Heat::RandomString
372 type: OS::Heat::RandomString
375 salt: {get_param: RabbitCookieSalt}
378 type: OS::TripleO::DefaultPasswords
380 DefaultMysqlRootPassword: {get_attr: [MysqlRootPassword, value]}
381 DefaultRabbitCookie: {get_attr: [RabbitCookie, value]}
382 DefaultHeatAuthEncryptionKey: {get_attr: [HeatAuthEncryptionKey, value]}
383 DefaultPcsdPassword: {get_attr: [PcsdPassword, value]}
384 DefaultHorizonSecret: {get_attr: [HorizonSecret, value]}
386 # creates the network architecture
388 type: OS::TripleO::Network
391 type: OS::Neutron::Port
394 name: control_virtual_ip
395 network: {get_param: NeutronControlPlaneID}
396 fixed_ips: {get_param: ControlFixedIPs}
397 replacement_policy: AUTO
401 type: OS::TripleO::Network::Ports::RedisVipPort
403 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
404 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
405 PortName: redis_virtual_ip
406 NetworkName: {get_attr: [ServiceNetMap, service_net_map, RedisNetwork]}
408 FixedIPs: {get_param: RedisVirtualFixedIPs}
410 # The public VIP is on the External net, falls back to ctlplane
413 type: OS::TripleO::Network::Ports::ExternalVipPort
415 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
416 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
417 PortName: public_virtual_ip
418 FixedIPs: {get_param: PublicVirtualFixedIPs}
420 InternalApiVirtualIP:
422 type: OS::TripleO::Network::Ports::InternalApiVipPort
424 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
425 PortName: internal_api_virtual_ip
426 FixedIPs: {get_param: InternalApiVirtualFixedIPs}
430 type: OS::TripleO::Network::Ports::StorageVipPort
432 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
433 PortName: storage_virtual_ip
434 FixedIPs: {get_param: StorageVirtualFixedIPs}
436 StorageMgmtVirtualIP:
438 type: OS::TripleO::Network::Ports::StorageMgmtVipPort
440 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
441 PortName: storage_management_virtual_ip
442 FixedIPs: {get_param: StorageMgmtVirtualFixedIPs}
445 type: OS::TripleO::Network::Ports::NetVipMap
447 ControlPlaneIp: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
448 ExternalIp: {get_attr: [PublicVirtualIP, ip_address]}
449 ExternalIpUri: {get_attr: [PublicVirtualIP, ip_address_uri]}
450 InternalApiIp: {get_attr: [InternalApiVirtualIP, ip_address]}
451 InternalApiIpUri: {get_attr: [InternalApiVirtualIP, ip_address_uri]}
452 StorageIp: {get_attr: [StorageVirtualIP, ip_address]}
453 StorageIpUri: {get_attr: [StorageVirtualIP, ip_address_uri]}
454 StorageMgmtIp: {get_attr: [StorageMgmtVirtualIP, ip_address]}
455 StorageMgmtIpUri: {get_attr: [StorageMgmtVirtualIP, ip_address_uri]}
456 # No tenant or management VIP required
458 # All Nodes Validations
459 AllNodesValidationConfig:
460 type: OS::TripleO::AllNodes::Validation
465 - - {get_attr: [Controller, resource.0.external_ip_address]}
466 - {get_attr: [Controller, resource.0.internal_api_ip_address]}
467 - {get_attr: [Controller, resource.0.storage_ip_address]}
468 - {get_attr: [Controller, resource.0.storage_mgmt_ip_address]}
469 - {get_attr: [Controller, resource.0.tenant_ip_address]}
470 - {get_attr: [Controller, resource.0.management_ip_address]}
473 type: OS::TripleO::Tasks::UpdateWorkflow
476 {% for role in roles %}
477 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
480 deploy_identifier: {get_param: DeployIdentifier}
481 update_identifier: {get_param: UpdateIdentifier}
483 # Optional ExtraConfig for all nodes - all roles are passed in here, but
484 # the nested template may configure each role differently (or not at all)
486 type: OS::TripleO::AllNodesExtraConfig
489 {% for role in roles %}
490 - {{role.name}}AllNodesValidationDeployment
493 {% for role in roles %}
494 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
497 # Post deployment steps for all roles
499 type: OS::TripleO::PostDeploySteps
502 {% for role in roles %}
503 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
506 {% for role in roles %}
507 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data]}
512 description: Asserts that the keystone endpoints have been provisioned.
515 description: URL for the Overcloud Keystone service
516 value: {get_attr: [EndpointMap, endpoint_map, KeystonePublic, uri]}
518 description: Keystone Admin VIP endpoint
519 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystoneAdminApiNetwork]}]}
521 description: Controller VIP for public API endpoints
522 value: {get_attr: [VipMap, net_ip_map, external]}
524 description: VIP for Aodh API internal endpoint
525 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, AodhApiNetwork]}]}
526 CeilometerInternalVip:
527 description: VIP for Ceilometer API internal endpoint
528 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CeilometerApiNetwork]}]}
530 description: VIP for Ceph RGW internal endpoint
531 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CephRgwNetwork]}]}
533 description: VIP for Cinder API internal endpoint
534 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CinderApiNetwork]}]}
536 description: VIP for Glance API internal endpoint
537 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GlanceApiNetwork]}]}
539 description: VIP for Gnocchi API internal endpoint
540 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GnocchiApiNetwork]}]}
542 description: VIP for Heat API internal endpoint
543 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, HeatApiNetwork]}]}
545 description: VIP for Ironic API internal endpoint
546 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, IronicApiNetwork]}]}
548 description: VIP for Keystone API internal endpoint
549 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystonePublicApiNetwork]}]}
551 description: VIP for Manila API internal endpoint
552 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, ManilaApiNetwork]}]}
554 description: VIP for Neutron API internal endpoint
555 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NeutronApiNetwork]}]}
557 description: VIP for Nova API internal endpoint
558 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NovaApiNetwork]}]}
559 OpenDaylightInternalVip:
560 description: VIP for OpenDaylight API internal endpoint
561 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, OpenDaylightApiNetwork]}]}
563 description: VIP for Sahara API internal endpoint
564 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SaharaApiNetwork]}]}
566 description: VIP for Swift Proxy internal endpoint
567 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SwiftProxyNetwork]}]}
570 Mapping of the resources with the needed info for their endpoints.
571 This includes the protocol used, the IP, port and also a full
572 representation of the URI.
573 value: {get_attr: [EndpointMap, endpoint_map]}
576 The content that should be appended to your /etc/hosts if you want to get
577 hostname-based access to the deployed nodes (useful for testing without
579 value: {get_attr: [allNodesConfig, hosts_entries]}
581 description: The services enabled on each role
583 {% for role in roles %}
584 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}