1 # This file holds metadata about the capabilities of the tripleo-heat-templates
2 # repository for deployment using puppet. It groups configuration by topic,
3 # describes possible combinations of environments and resource capabilities.
5 # root_template: identifies repository's root template
6 # root_environment: identifies root_environment, this one is special in terms of
7 # order in which the environments are merged before deploying. This one serves as
8 # a base and it's parameters/resource_registry gets overridden by other environments
12 # High Level grouping by purpose of environments
15 # description: (optional)
16 # environment_groups: (required)
19 # Identifies an environment choice. If group includes multiple environments it
20 # indicates that environments in group are mutually exclusive.
23 # description: (optional)
24 # tags: a list of tags to provide additional information for e.g. filtering (optional)
25 # environments: (required)
28 # List of environments in environment group
30 # file: a file name including path within repository (required)
32 # description: (optional)
33 # requires: an array of environments which are required by this environment (optional)
34 # resource_registry: [tbd] (optional)
37 # [tbd] Each environment can provide options on resource_registry level applicable
38 # only when that given environment is used. (resource_type of that environment can
39 # be implemented using multiple templates).
41 root_template: overcloud.yaml
42 root_environment: overcloud-resource-registry-puppet.yaml
44 - title: Base Resources Configuration
48 description: Enable base configuration for all resources required for OpenStack Deployment
50 - file: overcloud-resource-registry-puppet.yaml
51 title: Base resources configuration
54 - title: Deployment Options
57 - title: High Availability
58 description: Enables configuration of an Overcloud controller with Pacemaker
60 - file: environments/puppet-pacemaker.yaml
62 description: Enable configuration of an Overcloud controller with Pacemaker
64 - overcloud-resource-registry-puppet.yaml
65 - title: Pacemaker options
68 - file: environments/puppet-pacemaker-no-restart.yaml
69 title: Pacemaker No Restart
72 - environments/puppet-pacemaker.yaml
73 - overcloud-resource-registry-puppet.yaml
76 Docker container with heat agents for containerized compute node
78 - file: environments/docker.yaml
82 - overcloud-resource-registry-puppet.yaml
86 - file: environments/enable-tls.yaml
89 Use this option to pass in certificates for SSL deployments.
90 For these values to take effect, one of the TLS endpoints
91 environments must also be used.
93 - overcloud-resource-registry-puppet.yaml
94 - title: TLS Endpoints
97 - file: environments/tls-endpoints-public-dns.yaml
98 title: SSL-enabled deployment with DNS name as public endpoint
100 Use this environment when deploying an SSL-enabled overcloud where the public
101 endpoint is a DNS name.
103 - environments/enable-tls.yaml
104 - overcloud-resource-registry-puppet.yaml
105 - file: environments/tls-endpoints-public-ip.yaml
106 title: SSL-enabled deployment with IP address as public endpoint
108 Use this environment when deploying an SSL-enabled overcloud where the public
109 endpoint is an IP address.
111 - environments/enable-tls.yaml
112 - overcloud-resource-registry-puppet.yaml
113 - title: External load balancer
115 Enable external load balancer
117 - file: environments/external-loadbalancer-vip-v6.yaml
118 title: External load balancer IPv6
121 - overcloud-resource-registry-puppet.yaml
122 - file: environments/external-loadbalancer-vip.yaml
123 title: External load balancer IPv4
126 - overcloud-resource-registry-puppet.yaml
128 - title: Additional Services
129 description: Deploy additional Overcloud services
134 - file: environments/manila-generic-config.yaml
136 description: Enable Manila generic driver backend
138 - overcloud-resource-registry-puppet.yaml
142 - file: environments/services/sahara.yaml
144 description: Deploy Sahara service
146 - overcloud-resource-registry-puppet.yaml
150 - file: environments/services/ironic.yaml
152 description: Deploy Ironic service
154 - overcloud-resource-registry-puppet.yaml
158 - file: environments/services/mistral.yaml
160 description: Deploy Mistral service
162 - overcloud-resource-registry-puppet.yaml
163 - title: Ceilometer Api
166 - file: environments/services/disable-ceilometer-api.yaml
167 title: Ceilometer Api
168 description: Disable Ceilometer Api service. This service is
169 deprecated and will be removed in future releases. Please move
170 to using gnocchi/aodh/panko apis instead.
172 - overcloud-resource-registry-puppet.yaml
174 # - title: Network Interface Configuration
176 # environment_groups:
178 - title: Overlay Network Configuration
181 - title: Network Isolation
184 - file: environments/network-isolation.yaml
185 title: Network Isolation
187 Enable the creation of Neutron networks for
188 isolated Overcloud traffic and configure each role to assign ports
189 (related to that role) on these networks.
191 - overcloud-resource-registry-puppet.yaml
192 - file: environments/network-isolation-v6.yaml
193 title: Network Isolation IPv6
195 Enable the creation of IPv6 Neutron networks for isolated Overcloud
196 traffic and configure each role to assign ports (related
197 to that role) on these networks.
199 - overcloud-resource-registry-puppet.yaml
200 - title: Single NIC or Bonding
202 Configure roles to use pair of bonded nics or to use Vlans on a
203 single nic. This option assumes use of Network Isolation.
205 - file: environments/net-bond-with-vlans.yaml
206 title: Bond with Vlans
208 Configure each role to use a pair of bonded nics (nic2 and
209 nic3) and configures an IP address on each relevant isolated network
210 for each role. This option assumes use of Network Isolation.
212 - environments/network-isolation.yaml
213 - overcloud-resource-registry-puppet.yaml
214 - file: environments/net-bond-with-vlans-no-external.yaml
215 title: Bond with Vlans No External Ports
217 Configure each role to use a pair of bonded nics (nic2 and
218 nic3) and configures an IP address on each relevant isolated network
219 for each role. This option assumes use of Network Isolation.
220 Sets external ports to noop.
222 - environments/network-isolation.yaml
223 - overcloud-resource-registry-puppet.yaml
224 - file: environments/net-bond-with-vlans-v6.yaml
225 title: Bond with Vlans IPv6
227 Configure each role to use a pair of bonded nics (nic2 and
228 nic3) and configures an IP address on each relevant isolated network
229 for each role, with IPv6 on the External network.
230 This option assumes use of Network Isolation IPv6.
232 - environments/network-isolation-v6.yaml
233 - overcloud-resource-registry-puppet.yaml
234 - file: environments/net-multiple-nics.yaml
237 Configures each role to use a separate NIC for
238 each isolated network.
239 This option assumes use of Network Isolation.
241 - environments/network-isolation.yaml
242 - overcloud-resource-registry-puppet.yaml
243 - file: environments/net-multiple-nics-v6.yaml
244 title: Multiple NICs IPv6
246 Configure each role to use a separate NIC for
247 each isolated network with IPv6 on the External network.
248 This option assumes use of Network Isolation IPv6.
250 - environments/network-isolation-v6.yaml
251 - overcloud-resource-registry-puppet.yaml
252 - file: environments/net-single-nic-with-vlans.yaml
253 title: Single NIC with Vlans
255 Configure each role to use Vlans on a single NIC for
256 each isolated network. This option assumes use of Network Isolation.
258 - environments/network-isolation.yaml
259 - overcloud-resource-registry-puppet.yaml
260 - file: environments/net-single-nic-with-vlans-no-external.yaml
261 title: Single NIC with Vlans No External Ports
263 Configure each role to use Vlans on a single NIC for
264 each isolated network. This option assumes use of Network Isolation.
265 Sets external ports to noop.
267 - environments/network-isolation.yaml
268 - overcloud-resource-registry-puppet.yaml
269 - file: environments/net-single-nic-linux-bridge-with-vlans.yaml
270 title: Single NIC with Linux Bridge Vlans
272 Configure each role to use Vlans on a single NIC for
273 each isolated network. This option assumes use of Network Isolation.
275 - environments/network-isolation.yaml
276 - overcloud-resource-registry-puppet.yaml
277 - file: environments/net-single-nic-with-vlans-v6.yaml
278 title: Single NIC with Vlans IPv6
280 Configures each role to use Vlans on a single NIC for
281 each isolated network with IPv6 on the External network.
282 This option assumes use of Network Isolation IPv6
284 - environments/network-isolation-v6.yaml
285 - overcloud-resource-registry-puppet.yaml
286 - title: Management Network
288 Enable the creation of a system management network. This
289 creates a Neutron network for isolated Overcloud
290 system management traffic and configures each role to
291 assign a port (related to that role) on that network.
293 - file: environments/network-management.yaml
294 title: Management Network
297 - overcloud-resource-registry-puppet.yaml
298 - file: environments/network-management-v6.yaml
299 title: Management Network IPv6
302 - overcloud-resource-registry-puppet.yaml
304 - title: Neutron Plugin Configuration
307 - title: Neutron Plugins
309 Enable various Neutron plugins and backends
311 - file: environments/neutron-ml2-bigswitch.yaml
312 title: BigSwitch Extensions
314 Enable Big Switch extensions, configured via puppet
316 - overcloud-resource-registry-puppet.yaml
317 - file: environments/neutron-ml2-cisco-n1kv.yaml
318 title: Cisco N1KV backend
320 Enable a Cisco N1KV backend, configured via puppet
322 - overcloud-resource-registry-puppet.yaml
323 - file: environments/neutron-ml2-cisco-nexus-ucsm.yaml
324 title: Cisco Neutron plugin
327 - overcloud-resource-registry-puppet.yaml
328 - file: environments/neutron-midonet.yaml
329 title: Deploy MidoNet Services
332 - overcloud-resource-registry-puppet.yaml
333 - file: environments/neutron-nuage-config.yaml
334 title: Neutron Nuage backend
335 description: Enables Neutron Nuage backend on the controller
337 - overcloud-resource-registry-puppet.yaml
338 - file: environments/neutron-opendaylight.yaml
340 description: Enables OpenDaylight
342 - overcloud-resource-registry-puppet.yaml
343 - file: environments/neutron-ovs-dpdk.yaml
345 description: Deploy DPDK with OVS
347 - overcloud-resource-registry-puppet.yaml
348 - file: environments/neutron-ovs-dvr.yaml
350 description: Enables DVR in the Overcloud
352 - overcloud-resource-registry-puppet.yaml
353 - file: environments/neutron-plumgrid.yaml
354 title: PLUMgrid extensions
355 description: Enables PLUMgrid extensions
357 - overcloud-resource-registry-puppet.yaml
358 - file: environments/neutron-ml2-fujitsu-cfab.yaml
359 title: Fujitsu Neutron plugin for C-Fabric
360 description: Enable C-Fabric in the overcloud
362 - overcloud-resource-registry-puppet.yaml
363 - file: environments/neutron-ml2-fujitsu-fossw.yaml
364 title: Fujitsu Neutron plugin for FOS
365 description: Enable FOS in the overcloud
367 - overcloud-resource-registry-puppet.yaml
369 - title: Nova Extensions
372 - title: Nova Extensions
375 - file: environments/nova-nuage-config.yaml
378 Enables Nuage backend on the Compute
380 - overcloud-resource-registry-puppet.yaml
385 - title: Cinder backup service
388 - file: environments/cinder-backup.yaml
389 title: Cinder backup service
391 OpenStack Cinder Backup service with Pacemaker configured
394 - environments/puppet-pacemaker.yaml
395 - overcloud-resource-registry-puppet.yaml
396 - title: Cinder backend
398 Enable various Cinder backends
400 - file: environments/cinder-netapp-config.yaml
401 title: Cinder NetApp backend
404 - overcloud-resource-registry-puppet.yaml
405 - file: environments/cinder-dellsc-config.yaml
406 title: Cinder Dell EMC Storage Center ISCSI backend
408 Enables a Cinder Dell EMC Storage Center ISCSI backend,
409 configured via puppet
411 - overcloud-resource-registry-puppet.yaml
412 - file: environments/cinder-hpelefthand-config.yaml
413 title: Cinder HPELeftHandISCSI backend
415 Enables a Cinder HPELeftHandISCSI backend, configured
418 - overcloud-resource-registry-puppet.yaml
419 - file: environments/cinder-dellps-config.yaml
420 title: Cinder Dell EMC PS Series backend
422 Enables a Cinder Dell EMC PS Series backend,
423 configured via puppet
425 - overcloud-resource-registry-puppet.yaml
426 - file: environments/cinder-iser.yaml
427 title: Cinder iSER backend
429 Enable a Cinder iSER RDMA backend, configured via puppet
430 - file: environments/cinder-scaleio-config.yaml
431 title: Cinder Dell EMC ScaleIO backend
433 Enables a Cinder Dell EMC ScaleIO backend,
434 configured via puppet
436 - overcloud-resource-registry-puppet.yaml
439 Enable the use of Ceph in the overcloud
441 - file: environments/puppet-ceph-external.yaml
442 title: Externally managed Ceph
444 Configures the overcloud to use an externally managed Ceph cluster, via RBD driver.
446 - overcloud-resource-registry-puppet.yaml
447 - file: environments/puppet-ceph.yaml
448 title: TripleO managed Ceph
450 Deploys a Ceph cluster via TripleO, requires at lease one CephStorage node or
451 use of hyperconverged-ceph.yaml environment for the HCI scenario, where CephOSD is
452 colocated with NovaCompute and configures the overcloud to use it, via RBD driver.
454 - overcloud-resource-registry-puppet.yaml
457 Deploys CephMDS via TripleO, an additional Ceph service needed to create shared
458 filesystems hosted in Ceph.
460 - file: environments/services/ceph-mds.yaml
461 title: Deploys CephMDS
464 - environments/puppet-ceph.yaml
465 - title: Ceph Rados Gateway
467 Deploys CephRGW via TripleO, transparently replaces Swift providing a compatible API
468 which stores data in the Ceph cluster.
470 - file: environments/ceph-radosgw.yaml
471 title: Deploys CephRGW
474 - environments/puppet-ceph.yaml
475 - title: Manila with CephFS
477 Deploys Manila and configures it with the CephFS driver. This requires the deployment of
478 Ceph and CephMDS from TripleO or the use of an external Ceph cluster for the overcloud.
480 - file: environments/manila-cephfsnative-config.yaml
481 title: Deploys Manila with CephFS driver
482 description: Deploys Manila and configures CephFS as its default backend.
484 - overcloud-resource-registry-puppet.yaml
485 - title: Storage Environment
487 Can be used to set up storage backends. Defaults to Ceph used as a
488 backend for Cinder, Glance, Nova ephemeral storage and Gnocchi. It
489 configures which services will use Ceph, or if any of the services
490 will use NFS. And more. Usually requires to be edited by user first.
494 - file: environments/storage-environment.yaml
495 title: Storage Environment
498 - overcloud-resource-registry-puppet.yaml
503 - title: Config Debug
504 description: Enable config management (e.g. Puppet) debugging
506 - file: environments/config-debug.yaml
510 - overcloud-resource-registry-puppet.yaml
511 - title: Disable journal in MongoDb
513 Since, when journaling is enabled, MongoDb will create big journal
514 file it can take time. In a CI environment for example journaling is
517 - file: environments/mongodb-nojournal.yaml
518 title: Disable journal in MongoDb
521 - overcloud-resource-registry-puppet.yaml
522 - title: Overcloud Steps
524 Specifies hooks/breakpoints where overcloud deployment should stop
525 Allows operator validation between steps, and/or more granular control.
526 Note: the wildcards relate to naming convention for some resource suffixes,
527 e.g see puppet/*-post.yaml, enabling this will mean we wait for
528 a user signal on every *Deployment_StepN resource defined in those files.
532 - file: environments/overcloud-steps.yaml
533 title: Overcloud Steps
536 - overcloud-resource-registry-puppet.yaml
538 - title: Operational Tools
541 - title: Monitoring agents
542 description: Enable monitoring agents
544 - file: environments/monitoring-environment.yaml
545 title: enable monitoring agents
548 - overcloud-resource-registry-puppet.yaml
549 - title: Centralized logging support
550 description: Enable centralized logging clients (fluentd)
552 - file: environments/logging-environment.yaml
553 title: Enable fluentd client
556 - overcloud-resource-registry-puppet.yaml
558 - title: Security Options
559 description: Security Hardening Options
561 - title: SSH Banner Text
562 description: Enables population of SSH Banner Text
564 - file: environments/sshd-banner.yaml
565 title: SSH Banner Text
568 - overcloud-resource-registry-puppet.yaml
569 - title: Horizon Password Validation
570 description: Enable Horizon Password validation
572 - file: environments/horizon_password_validation.yaml
573 title: Horizon Password Validation
576 - overcloud-resource-registry-puppet.yaml
577 - title: AuditD Rules
578 description: Management of AuditD rules
580 - file: environments/auditd.yaml
581 title: AuditD Rule Management
584 - overcloud-resource-registry-puppet.yaml
585 - title: Keystone CADF auditing
586 description: Enable CADF notifications in Keystone for auditing
588 - file: environments/cadf.yaml
589 title: Keystone CADF auditing