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]}
250 type: OS::Heat::ResourceGroup
253 count: {get_param: {{role.name}}Count}
254 removal_policies: {get_param: {{role.name}}RemovalPolicies}
256 type: OS::TripleO::{{role.name}}
258 CloudDomain: {get_param: CloudDomain}
259 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map]}
260 EndpointMap: {get_attr: [EndpointMap, endpoint_map]}
263 template: {get_param: {{role.name}}HostnameFormat}
265 '%stackname%': {get_param: 'OS::stack_name'}
267 {% if role.name != 'Compute' %}
268 {{role.name}}SchedulerHints: {get_param: {{role.name}}SchedulerHints}
270 NovaComputeSchedulerHints: {get_param: NovaComputeSchedulerHints}
272 ServiceConfigSettings:
274 - get_attr: [{{role.name}}ServiceChain, role_data, config_settings]
276 - get_attr: [{{r.name}}ServiceChain, role_data, global_config_settings]
278 # This next step combines two yaql passes:
279 # - The inner one does a deep merge on the service_config_settings for all roles
280 # - The outer one filters the map based on the services enabled for the role
281 # then merges the result into one map.
283 expression: let(root => $) -> $.data.map.items().where($[0] in $root.data.services).select($[1]).reduce($1.mergeWith($2), {})
287 expression: $.data.where($ != null).reduce($1.mergeWith($2), {})
290 - get_attr: [{{r.name}}ServiceChain, role_data, service_config_settings]
292 services: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
293 ServiceNames: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
294 MonitoringSubscriptions: {get_attr: [{{role.name}}ServiceChain, role_data, monitoring_subscriptions]}
295 LoggingSources: {get_attr: [{{role.name}}ServiceChain, role_data, logging_sources]}
296 LoggingGroups: {get_attr: [{{role.name}}ServiceChain, role_data, logging_groups]}
300 type: OS::TripleO::AllNodes::SoftwareConfig
302 cloud_name_external: {get_param: CloudName}
303 cloud_name_internal_api: {get_param: CloudNameInternal}
304 cloud_name_storage: {get_param: CloudNameStorage}
305 cloud_name_storage_mgmt: {get_param: CloudNameStorageManagement}
306 cloud_name_ctlplane: {get_param: CloudNameCtlplane}
308 {% for role in roles %}
311 - {get_attr: [{{role.name}}, hosts_entry]}
316 {% for role in roles %}
317 - {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}
319 controller_ips: {get_attr: [Controller, ip_address]}
320 controller_names: {get_attr: [Controller, hostname]}
322 # Note (shardy) this somewhat complex yaql may be replaced
323 # with a map_deep_merge function in ocata. It merges the
324 # list of maps, but appends to colliding lists when a service
325 # is deployed on more than one role
327 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
330 {% for role in roles %}
331 - {get_attr: [{{role.name}}IpListMap, service_ips]}
335 expression: dict($.data.l.where($ != null).selectMany($.items()).groupBy($[0], $[1], [$[0], $[1].flatten()]))
338 {% for role in roles %}
339 - {get_attr: [{{role.name}}IpListMap, service_hostnames]}
341 # FIXME(shardy): These require further work to move into service_ips
342 memcache_node_ips: {get_attr: [ControllerIpListMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, MemcachedNetwork]}]}
343 NetVipMap: {get_attr: [VipMap, net_ip_map]}
344 RedisVirtualIP: {get_attr: [RedisVirtualIP, ip_address]}
345 ServiceNetMap: {get_attr: [ServiceNetMap, service_net_map_lower]}
346 DeployIdentifier: {get_param: DeployIdentifier}
347 UpdateIdentifier: {get_param: UpdateIdentifier}
350 type: OS::Heat::RandomString
355 type: OS::Heat::RandomString
358 salt: {get_param: RabbitCookieSalt}
361 type: OS::TripleO::DefaultPasswords
363 DefaultMysqlRootPassword: {get_attr: [MysqlRootPassword, value]}
364 DefaultRabbitCookie: {get_attr: [RabbitCookie, value]}
365 DefaultHeatAuthEncryptionKey: {get_attr: [HeatAuthEncryptionKey, value]}
366 DefaultPcsdPassword: {get_attr: [PcsdPassword, value]}
367 DefaultHorizonSecret: {get_attr: [HorizonSecret, value]}
369 # creates the network architecture
371 type: OS::TripleO::Network
374 type: OS::Neutron::Port
377 name: control_virtual_ip
378 network: {get_param: NeutronControlPlaneID}
379 fixed_ips: {get_param: ControlFixedIPs}
380 replacement_policy: AUTO
384 type: OS::TripleO::Network::Ports::RedisVipPort
386 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
387 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
388 PortName: redis_virtual_ip
389 NetworkName: {get_attr: [ServiceNetMap, service_net_map, RedisNetwork]}
391 FixedIPs: {get_param: RedisVirtualFixedIPs}
393 # The public VIP is on the External net, falls back to ctlplane
396 type: OS::TripleO::Network::Ports::ExternalVipPort
398 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
399 ControlPlaneNetwork: {get_param: NeutronControlPlaneID}
400 PortName: public_virtual_ip
401 FixedIPs: {get_param: PublicVirtualFixedIPs}
403 InternalApiVirtualIP:
405 type: OS::TripleO::Network::Ports::InternalApiVipPort
407 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
408 PortName: internal_api_virtual_ip
409 FixedIPs: {get_param: InternalApiVirtualFixedIPs}
413 type: OS::TripleO::Network::Ports::StorageVipPort
415 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
416 PortName: storage_virtual_ip
417 FixedIPs: {get_param: StorageVirtualFixedIPs}
419 StorageMgmtVirtualIP:
421 type: OS::TripleO::Network::Ports::StorageMgmtVipPort
423 ControlPlaneIP: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
424 PortName: storage_management_virtual_ip
425 FixedIPs: {get_param: StorageMgmtVirtualFixedIPs}
428 type: OS::TripleO::Network::Ports::NetVipMap
430 ControlPlaneIp: {get_attr: [ControlVirtualIP, fixed_ips, 0, ip_address]}
431 ExternalIp: {get_attr: [PublicVirtualIP, ip_address]}
432 ExternalIpUri: {get_attr: [PublicVirtualIP, ip_address_uri]}
433 InternalApiIp: {get_attr: [InternalApiVirtualIP, ip_address]}
434 InternalApiIpUri: {get_attr: [InternalApiVirtualIP, ip_address_uri]}
435 StorageIp: {get_attr: [StorageVirtualIP, ip_address]}
436 StorageIpUri: {get_attr: [StorageVirtualIP, ip_address_uri]}
437 StorageMgmtIp: {get_attr: [StorageMgmtVirtualIP, ip_address]}
438 StorageMgmtIpUri: {get_attr: [StorageMgmtVirtualIP, ip_address_uri]}
439 # No tenant or management VIP required
441 # All Nodes Validations
442 AllNodesValidationConfig:
443 type: OS::TripleO::AllNodes::Validation
448 - - {get_attr: [Controller, resource.0.external_ip_address]}
449 - {get_attr: [Controller, resource.0.internal_api_ip_address]}
450 - {get_attr: [Controller, resource.0.storage_ip_address]}
451 - {get_attr: [Controller, resource.0.storage_mgmt_ip_address]}
452 - {get_attr: [Controller, resource.0.tenant_ip_address]}
453 - {get_attr: [Controller, resource.0.management_ip_address]}
456 type: OS::TripleO::Tasks::UpdateWorkflow
459 {% for role in roles %}
460 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
463 deploy_identifier: {get_param: DeployIdentifier}
464 update_identifier: {get_param: UpdateIdentifier}
466 # Optional ExtraConfig for all nodes - all roles are passed in here, but
467 # the nested template may configure each role differently (or not at all)
469 type: OS::TripleO::AllNodesExtraConfig
472 {% for role in roles %}
473 - {{role.name}}AllNodesValidationDeployment
476 {% for role in roles %}
477 servers: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
480 # Post deployment steps for all roles
482 type: OS::TripleO::PostDeploySteps
485 {% for role in roles %}
486 {{role.name}}: {get_attr: [{{role.name}}, attributes, nova_server_resource]}
489 {% for role in roles %}
490 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data]}
495 description: Asserts that the keystone endpoints have been provisioned.
498 description: URL for the Overcloud Keystone service
499 value: {get_attr: [EndpointMap, endpoint_map, KeystonePublic, uri]}
501 description: Keystone Admin VIP endpoint
502 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystoneAdminApiNetwork]}]}
504 description: Controller VIP for public API endpoints
505 value: {get_attr: [VipMap, net_ip_map, external]}
507 description: VIP for Aodh API internal endpoint
508 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, AodhApiNetwork]}]}
509 CeilometerInternalVip:
510 description: VIP for Ceilometer API internal endpoint
511 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CeilometerApiNetwork]}]}
513 description: VIP for Ceph RGW internal endpoint
514 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CephRgwNetwork]}]}
516 description: VIP for Cinder API internal endpoint
517 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, CinderApiNetwork]}]}
519 description: VIP for Glance API internal endpoint
520 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GlanceApiNetwork]}]}
522 description: VIP for Gnocchi API internal endpoint
523 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, GnocchiApiNetwork]}]}
525 description: VIP for Heat API internal endpoint
526 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, HeatApiNetwork]}]}
528 description: VIP for Ironic API internal endpoint
529 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, IronicApiNetwork]}]}
531 description: VIP for Keystone API internal endpoint
532 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, KeystonePublicApiNetwork]}]}
534 description: VIP for Manila API internal endpoint
535 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, ManilaApiNetwork]}]}
537 description: VIP for Neutron API internal endpoint
538 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NeutronApiNetwork]}]}
540 description: VIP for Nova API internal endpoint
541 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, NovaApiNetwork]}]}
542 OpenDaylightInternalVip:
543 description: VIP for OpenDaylight API internal endpoint
544 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, OpenDaylightApiNetwork]}]}
546 description: VIP for Sahara API internal endpoint
547 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SaharaApiNetwork]}]}
549 description: VIP for Swift Proxy internal endpoint
550 value: {get_attr: [VipMap, net_ip_map, {get_attr: [ServiceNetMap, service_net_map, SwiftProxyNetwork]}]}
553 Mapping of the resources with the needed info for their endpoints.
554 This includes the protocol used, the IP, port and also a full
555 representation of the URI.
556 value: {get_attr: [EndpointMap, endpoint_map]}
559 The content that should be appended to your /etc/hosts if you want to get
560 hostname-based access to the deployed nodes (useful for testing without
562 value: {get_attr: [allNodesConfig, hosts_entries]}
564 description: The services enabled on each role
566 {% for role in roles %}
567 {{role.name}}: {get_attr: [{{role.name}}ServiceChain, role_data, service_names]}