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.
6 # High Level grouping by purpose of environments
9 # description: (optional)
10 # environment_groups: (required)
13 # Identifies a group of environments.
16 # description: (optional)
17 # tags: a list of tags to provide additional information for e.g. filtering (optional)
18 # environments: (required)
19 # mutually_exclusive: (optional) boolean to identify that environments in group are mutually exclusive
22 # List of environments in environment group
24 # file: a file name including path within repository (required)
26 # description: (optional)
27 # requires: an array of environments which are required by this environment (optional)
30 - title: General Deployment Options
33 - name: general-deployment-options
35 description: Enables base configuration for all resources required for OpenStack Deployment
37 - file: overcloud-resource-registry-puppet.yaml
38 title: Base resources configuration
40 - title: Containerized Deployment
42 Configures Deployment to use containerized services
44 - file: environments/docker.yaml
45 title: Containerized Deployment
48 - overcloud-resource-registry-puppet.yaml
49 - title: High Availability
50 description: Enables configuration of an Overcloud Controller with Pacemaker
52 - file: environments/puppet-pacemaker.yaml
53 title: High Availability (Pacemaker)
56 - overcloud-resource-registry-puppet.yaml
58 - title: Network Configuration
61 - title: Network Isolation
64 - file: environments/network-isolation.yaml
65 title: Network Isolation
67 Enable the creation of Neutron networks for
68 isolated Overcloud traffic and configure each role to assign ports
69 (related to that role) on these networks.
71 - overcloud-resource-registry-puppet.yaml
72 - file: environments/network-isolation-v6.yaml
73 title: Network Isolation IPv6
75 Enable the creation of IPv6 Neutron networks for isolated Overcloud
76 traffic and configure each role to assign ports (related
77 to that role) on these networks.
79 - overcloud-resource-registry-puppet.yaml
80 mutually_exclusive: true
81 - title: NICs, Bonding, VLANs Configuration
83 Choose one of the pre-defined configurations or provide custom
84 network-environment.yaml instead. Note that pre-defined configuration work
85 only with standard Roles and Networks. These options assume use of Network Isolation.
87 - file: environments/net-bond-with-vlans.yaml
88 title: Bond with Vlans
90 Configure each role to use a pair of bonded nics (nic2 and
91 nic3) and configures an IP address on each relevant isolated network
92 for each role. This option assumes use of Network Isolation.
94 - environments/network-isolation.yaml
95 - file: environments/net-bond-with-vlans-no-external.yaml
96 title: Bond with Vlans No External Ports
98 Configure each role to use a pair of bonded nics (nic2 and
99 nic3) and configures an IP address on each relevant isolated network
100 for each role. This option assumes use of Network Isolation.
101 Sets external ports to noop.
103 - environments/network-isolation.yaml
104 - file: environments/net-bond-with-vlans-v6.yaml
105 title: Bond with Vlans IPv6
107 Configure each role to use a pair of bonded nics (nic2 and
108 nic3) and configures an IP address on each relevant isolated network
109 for each role, with IPv6 on the External network.
110 This option assumes use of Network Isolation IPv6.
112 - environments/network-isolation-v6.yaml
113 - file: environments/net-multiple-nics.yaml
116 Configures each role to use a separate NIC for
117 each isolated network.
118 This option assumes use of Network Isolation.
120 - environments/network-isolation.yaml
121 - file: environments/net-multiple-nics-v6.yaml
122 title: Multiple NICs IPv6
124 Configure each role to use a separate NIC for
125 each isolated network with IPv6 on the External network.
126 This option assumes use of Network Isolation IPv6.
128 - environments/network-isolation-v6.yaml
129 - file: environments/net-single-nic-with-vlans.yaml
130 title: Single NIC with Vlans
132 Configure each role to use Vlans on a single NIC for
133 each isolated network. This option assumes use of Network Isolation.
135 - environments/network-isolation.yaml
136 - file: environments/net-single-nic-with-vlans-no-external.yaml
137 title: Single NIC with Vlans No External Ports
139 Configure each role to use Vlans on a single NIC for
140 each isolated network. This option assumes use of Network Isolation.
141 Sets external ports to noop.
143 - environments/network-isolation.yaml
144 - file: environments/net-single-nic-linux-bridge-with-vlans.yaml
145 title: Single NIC with Linux Bridge Vlans
147 Configure each role to use Vlans on a single NIC for
148 each isolated network. This option assumes use of Network Isolation.
150 - environments/network-isolation.yaml
151 - file: environments/net-single-nic-with-vlans-v6.yaml
152 title: Single NIC with Vlans IPv6
154 Configures each role to use Vlans on a single NIC for
155 each isolated network with IPv6 on the External network.
156 This option assumes use of Network Isolation IPv6
158 - environments/network-isolation-v6.yaml
159 mutually_exclusive: true
160 - title: Management Network
162 Enable the creation of a system management network. This
163 creates a Neutron network for isolated Overcloud
164 system management traffic and configures each role to
165 assign a port (related to that role) on that network.
167 - file: environments/network-management.yaml
168 title: Management Network
171 - overcloud-resource-registry-puppet.yaml
172 - file: environments/network-management-v6.yaml
173 title: Management Network IPv6
176 - overcloud-resource-registry-puppet.yaml
177 mutually_exclusive: true
179 - title: Docker Network
181 [Temporary] Use this option when deploying containerized deployment
182 without network isolation
184 - file: environments/docker-network.yaml
185 title: Docker network
188 - environments/docker.yaml
190 - title: External load balancer
192 Enable external load balancer, requires network Isolation to be enabled.
193 Note that this option assumes standard isolated networks set.
195 - file: environments/external-loadbalancer-vip.yaml
196 title: External load balancer IPv4
199 - environments/network-isolation.yaml
200 - file: environments/external-loadbalancer-vip-v6.yaml
201 title: External load balancer IPv6
204 - environments/network-isolation-v6.yaml
205 mutually_exclusive: true
207 - title: Neutron Plugin Configuration
210 - title: Neutron Plugins
212 Enable various Neutron plugins and backends
214 - file: environments/neutron-bgpvpn.yaml
215 title: Neutron BGPVPN Service Plugin
216 description: Enables Neutron BGPVPN Service Plugin
218 - overcloud-resource-registry-puppet.yaml
219 - file: environments/services/neutron-lbaasv2.yaml
220 title: Neutron LBaaSv2 Service Plugin
221 description: Enables Neutron LBaaSv2 Service Plugin and Agent
223 - overcloud-resource-registry-puppet.yaml
224 - file: environments/neutron-ml2-bigswitch.yaml
225 title: BigSwitch Extensions
227 Enable Big Switch extensions, configured via puppet
229 - overcloud-resource-registry-puppet.yaml
230 - file: environments/neutron-ml2-cisco-n1kv.yaml
231 title: Cisco N1KV backend
233 Enable a Cisco N1KV backend, configured via puppet
235 - overcloud-resource-registry-puppet.yaml
236 - file: environments/neutron-ml2-cisco-nexus-ucsm.yaml
237 title: Cisco Neutron plugin
240 - overcloud-resource-registry-puppet.yaml
241 - file: environments/networking/neutron-midonet.yaml
242 title: Neutron MidoNet Services
245 - overcloud-resource-registry-puppet.yaml
246 - file: environments/neutron-nuage-config.yaml
247 title: Neutron Nuage backend
248 description: Enables Neutron Nuage backend on the controller
250 - overcloud-resource-registry-puppet.yaml
251 - file: environments/neutron-opendaylight.yaml
253 description: Enables OpenDaylight
255 - overcloud-resource-registry-puppet.yaml
256 - file: environments/neutron-ovs-dpdk.yaml
258 description: Deploy DPDK with OVS
260 - overcloud-resource-registry-puppet.yaml
261 - file: environments/neutron-ovs-dvr.yaml
263 description: Enables DVR in the Overcloud
265 - overcloud-resource-registry-puppet.yaml
266 - file: environments/neutron-plumgrid.yaml
267 title: PLUMgrid extensions
268 description: Enables PLUMgrid extensions
270 - overcloud-resource-registry-puppet.yaml
271 - file: environments/neutron-ml2-fujitsu-cfab.yaml
272 title: Fujitsu Neutron plugin for C-Fabric
273 description: Enable C-Fabric in the overcloud
275 - overcloud-resource-registry-puppet.yaml
276 - file: environments/neutron-ml2-fujitsu-fossw.yaml
277 title: Fujitsu Neutron plugin for FOS
278 description: Enable FOS in the overcloud
280 - overcloud-resource-registry-puppet.yaml
281 - file: environments/neutron-nsx.yaml
282 title: Deploy NSX Services
285 - overcloud-resource-registry-puppet.yaml
286 - file: environments/neutron-l2gw.yaml
287 title: Neutron L2 gateway Service Plugin
288 description: Enables Neutron L2 gateway Service Plugin and Agent
290 - overcloud-resource-registry-puppet.yaml
295 - title: Cinder backends
297 Enable various Cinder backends
299 - file: environments/cinder-pure-config.yaml
300 title: Cinder Pure Storage FlashArray backend
303 - overcloud-resource-registry-puppet.yaml
304 - file: environments/storage/cinder-netapp-config.yaml
305 title: Cinder NetApp backend
308 - overcloud-resource-registry-puppet.yaml
309 - file: environments/cinder-dellsc-config.yaml
310 title: Cinder Dell EMC Storage Center ISCSI backend
312 Enables a Cinder Dell EMC Storage Center ISCSI backend
314 - overcloud-resource-registry-puppet.yaml
315 - file: environments/cinder-dellemc-unity-config.yaml
316 title: Cinder Dell EMC Unity backend
318 Enables a Cinder Dell EMC Unity backend,
319 - file: environments/cinder-dellemc-vmax-iscsi-config.yaml
320 title: Cinder Dell EMC VMAX ISCSI backend
322 Enables a Cinder Dell EMC VMAX ISCSI backend,
323 configured via puppet
325 - overcloud-resource-registry-puppet.yaml
326 - file: environments/cinder-hpelefthand-config.yaml
327 title: Cinder HPELeftHandISCSI backend
329 Enables a Cinder HPELeftHandISCSI backend
331 - overcloud-resource-registry-puppet.yaml
332 - file: environments/cinder-dellps-config.yaml
333 title: Cinder Dell EMC PS Series backend
335 Enables a Cinder Dell EMC PS Series backend
337 - overcloud-resource-registry-puppet.yaml
338 - file: environments/cinder-iser.yaml
339 title: Cinder iSER backend
341 Enable a Cinder iSER RDMA backend, configured via puppet
342 - file: environments/cinder-scaleio-config.yaml
343 title: Cinder Dell EMC ScaleIO backend
345 Enables a Cinder Dell EMC ScaleIO backend
347 - overcloud-resource-registry-puppet.yaml
348 - file: environments/cinder-veritas-hyperscale-config.yaml
349 title: Cinder Veritas HyperScale backend
351 Enables a Cinder Veritas HyperScale backend,
352 configured via puppet
354 - overcloud-resource-registry-puppet.yaml
355 - title: Cinder backup service
358 - file: environments/cinder-backup.yaml
359 title: Cinder backup service
361 OpenStack Cinder Backup service with Pacemaker
363 - environments/puppet-pacemaker.yaml
364 - overcloud-resource-registry-puppet.yaml
367 Enable the use of Ceph in the overcloud
369 - file: environments/puppet-ceph.yaml
370 title: Ceph Storage Backend
372 Deploys a Ceph cluster via TripleO, requires at lease one CephStorage node or
373 use of hyperconverged-ceph.yaml environment for the HCI scenario, where CephOSD is
374 colocated with NovaCompute and configures the overcloud to use it, via RBD driver.
376 - overcloud-resource-registry-puppet.yaml
377 - file: environments/storage/external-ceph.yaml
378 title: Externally managed Ceph
380 Configures the overcloud to use an externally managed Ceph cluster, via RBD driver.
382 - overcloud-resource-registry-puppet.yaml
383 mutually_exclusive: true
384 - title: Additional Ceph Options
387 - file: environments/services/ceph-mds.yaml
388 title: Deploys CephMDS
390 Deploys CephMDS via TripleO, an additional Ceph service needed to create shared
391 filesystems hosted in Ceph.
393 - environments/puppet-ceph.yaml
394 - file: environments/ceph-radosgw.yaml
395 title: Ceph Rados Gateway
397 Deploys CephRGW via TripleO, transparently replaces Swift providing a compatible API
398 which stores data in the Ceph cluster.
400 - environments/puppet-ceph.yaml
401 - file: environments/manila-cephfsnative-config.yaml
402 title: Manila with CephFS
404 Deploys Manila and configures it with the CephFS driver. This requires the deployment of
405 Ceph and CephMDS from TripleO or the use of an external Ceph cluster for the overcloud.
407 - overcloud-resource-registry-puppet.yaml
408 - title: Manila with Unity
410 Deploys Manila and configures it with the Unity driver.
412 - file: environments/manila-unity-config.yaml
413 title: Deploys Manila with Unity driver
414 description: Deploys Manila and configures Unity as its default backend.
415 - title: Manila with VNX
417 Deploys Manila and configures it with the VNX driver.
419 - file: environments/manila-vnx-config.yaml
420 title: Deploys Manila with VNX driver
421 description: Deploys Manila and configures VNX as its default backend.
422 - title: Manila with VMAX
424 Deploys Manila and configures it with the VMAX driver.
426 - file: environments/manila-vmax-config.yaml
427 title: Deploys Manila with VMAX driver
428 description: Deploys Manila and configures VMAX as its default backend.
429 - title: Manila with Isilon
431 Deploys Manila and configures it with the Isilon driver.
433 - file: environments/manila-isilon-config.yaml
434 title: Deploys Manila with Isilon driver
435 description: Deploys Manila and configures Isilon as its default backend.
437 - overcloud-resource-registry-puppet.yaml
438 - title: Glance backends
441 - file: environments/storage/glance-nfs.yaml
442 title: Glance NFS Backend
444 Configure and enable this option to enable the use of an NFS
445 share as the backend for Glance.
447 - overcloud-resource-registry-puppet.yaml
451 description: Security Hardening Options
456 - file: environments/ssl/enable-tls.yaml
457 title: SSL on OpenStack Public Endpoints
459 Use this option to pass in certificates for SSL deployments.
460 For these values to take effect, one of the TLS endpoints
461 options must also be used.
463 - overcloud-resource-registry-puppet.yaml
464 - title: TLS Endpoints
467 - file: environments/ssl/tls-endpoints-public-dns.yaml
468 title: SSL-enabled deployment with DNS name as public endpoint
470 Use this option when deploying an SSL-enabled overcloud where the public
471 endpoint is a DNS name.
473 - environments/ssl/enable-tls.yaml
474 - file: environments/ssl/tls-everywhere-endpoints-dns.yaml
475 title: Deploy All SSL Endpoints as DNS names
477 Use this option when deploying an overcloud where all the endpoints are
478 DNS names and there's TLS in all endpoint types.
480 - environments/ssl/enable-tls.yaml
481 - file: environments/ssl/tls-endpoints-public-ip.yaml
482 title: SSL-enabled deployment with IP address as public endpoint
484 Use this option when deploying an SSL-enabled overcloud where the public
485 endpoint is an IP address.
487 - environments/ssl/enable-tls.yaml
488 mutually_exclusive: true
489 - title: SSH Banner Text
490 description: Enables population of SSH Banner Text
492 - file: environments/sshd-banner.yaml
493 title: SSH Banner Text
496 - overcloud-resource-registry-puppet.yaml
497 - title: Horizon Password Validation
498 description: Enable Horizon Password validation
500 - file: environments/horizon_password_validation.yaml
501 title: Horizon Password Validation
504 - overcloud-resource-registry-puppet.yaml
505 - title: AuditD Rules
506 description: Management of AuditD rules
508 - file: environments/auditd.yaml
509 title: AuditD Rule Management
512 - overcloud-resource-registry-puppet.yaml
513 - title: Keystone CADF auditing
514 description: Enable CADF notifications in Keystone for auditing
516 - file: environments/cadf.yaml
517 title: Keystone CADF auditing
518 - title: SecureTTY Values
519 description: Set values within /etc/securetty
521 - file: environments/securetty.yaml
522 title: SecureTTY Values
524 - title: Additional Services
528 description: Deploy additional services
530 - file: environments/services/manila-generic-config.yaml
532 description: Enable Barbican with the default secret store backend
534 - overcloud-resource-registry-puppet.yaml
535 - file: environments/manila-generic-config.yaml
537 description: Enable Manila with generic driver backend
539 - overcloud-resource-registry-puppet.yaml
540 - file: environments/services/sahara.yaml
542 description: Deploy Sahara service
544 - overcloud-resource-registry-puppet.yaml
545 - file: environments/services/ironic.yaml
547 description: Deploy Ironic service
549 - overcloud-resource-registry-puppet.yaml
550 - file: environments/services/mistral.yaml
552 description: Deploy Mistral service
554 - overcloud-resource-registry-puppet.yaml
555 - file: environments/services/ec2-api.yaml
557 description: Enable EC2-API service
559 - overcloud-resource-registry-puppet.yaml
560 - file: environments/services/zaqar.yaml
562 description: Deploy Zaqar service
564 - overcloud-resource-registry-puppet.yaml
566 - title: Nova Extensions
569 - title: Nova Extensions
572 - file: environments/nova-nuage-config.yaml
575 Enables Nuage backend on the Compute
577 - overcloud-resource-registry-puppet.yaml
579 - title: Operational Tools
582 - title: Monitoring agents
583 description: Enable monitoring agents
585 - file: environments/monitoring-environment.yaml
586 title: Monitoring agents
589 - overcloud-resource-registry-puppet.yaml
590 - title: Centralized logging support
591 description: Enable centralized logging clients (fluentd)
593 - file: environments/logging-environment.yaml
594 title: fluentd client
597 - overcloud-resource-registry-puppet.yaml
598 - title: Performance monitoring
599 description: Enable performance monitoring agents
601 - file: environments/collectd-environment.yaml
602 title: Performance monitoring agents
605 - overcloud-resource-registry-puppet.yaml
610 - title: Config Debug
611 description: Enable config management (e.g. Puppet) debugging
613 - file: environments/config-debug.yaml
617 - overcloud-resource-registry-puppet.yaml
618 - title: Disable journal in MongoDb
620 Since, when journaling is enabled, MongoDb will create big journal
621 file it can take time. In a CI environment for example journaling is
624 - file: environments/mongodb-nojournal.yaml
625 title: Disable journal in MongoDb
628 - overcloud-resource-registry-puppet.yaml
629 - title: Overcloud Steps
631 Specifies hooks/breakpoints where overcloud deployment should stop
632 Allows operator validation between steps, and/or more granular control.
633 Note: the wildcards relate to naming convention for some resource suffixes,
634 e.g see puppet/*-post.yaml, enabling this will mean we wait for
635 a user signal on every *Deployment_StepN resource defined in those files.
639 - file: environments/overcloud-steps.yaml
640 title: Overcloud Steps
643 - overcloud-resource-registry-puppet.yaml