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
164 # - title: Network Interface Configuration
166 # environment_groups:
168 - title: Overlay Network Configuration
171 - title: Network Isolation
174 - file: environments/network-isolation.yaml
175 title: Network Isolation
177 Enable the creation of Neutron networks for
178 isolated Overcloud traffic and configure each role to assign ports
179 (related to that role) on these networks.
181 - overcloud-resource-registry-puppet.yaml
182 - file: environments/network-isolation-v6.yaml
183 title: Network Isolation IPv6
185 Enable the creation of IPv6 Neutron networks for isolated Overcloud
186 traffic and configure each role to assign ports (related
187 to that role) on these networks.
189 - overcloud-resource-registry-puppet.yaml
190 - title: Single NIC or Bonding
192 Configure roles to use pair of bonded nics or to use Vlans on a
193 single nic. This option assumes use of Network Isolation.
195 - file: environments/net-bond-with-vlans.yaml
196 title: Bond with Vlans
198 Configure each role to use a pair of bonded nics (nic2 and
199 nic3) and configures an IP address on each relevant isolated network
200 for each role. This option assumes use of Network Isolation.
202 - environments/network-isolation.yaml
203 - overcloud-resource-registry-puppet.yaml
204 - file: environments/net-bond-with-vlans-no-external.yaml
205 title: Bond with Vlans No External Ports
207 Configure each role to use a pair of bonded nics (nic2 and
208 nic3) and configures an IP address on each relevant isolated network
209 for each role. This option assumes use of Network Isolation.
210 Sets external ports to noop.
212 - environments/network-isolation.yaml
213 - overcloud-resource-registry-puppet.yaml
214 - file: environments/net-bond-with-vlans-v6.yaml
215 title: Bond with Vlans IPv6
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, with IPv6 on the External network.
220 This option assumes use of Network Isolation IPv6.
222 - environments/network-isolation-v6.yaml
223 - overcloud-resource-registry-puppet.yaml
224 - file: environments/net-multiple-nics.yaml
227 Configures each role to use a separate NIC for
228 each isolated network.
229 This option assumes use of Network Isolation.
231 - environments/network-isolation.yaml
232 - overcloud-resource-registry-puppet.yaml
233 - file: environments/net-multiple-nics-v6.yaml
234 title: Multiple NICs IPv6
236 Configure each role to use a separate NIC for
237 each isolated network with IPv6 on the External network.
238 This option assumes use of Network Isolation IPv6.
240 - environments/network-isolation-v6.yaml
241 - overcloud-resource-registry-puppet.yaml
242 - file: environments/net-single-nic-with-vlans.yaml
243 title: Single NIC with Vlans
245 Configure each role to use Vlans on a single NIC for
246 each isolated network. This option assumes use of Network Isolation.
248 - environments/network-isolation.yaml
249 - overcloud-resource-registry-puppet.yaml
250 - file: environments/net-single-nic-with-vlans-no-external.yaml
251 title: Single NIC with Vlans No External Ports
253 Configure each role to use Vlans on a single NIC for
254 each isolated network. This option assumes use of Network Isolation.
255 Sets external ports to noop.
257 - environments/network-isolation.yaml
258 - overcloud-resource-registry-puppet.yaml
259 - file: environments/net-single-nic-linux-bridge-with-vlans.yaml
260 title: Single NIC with Linux Bridge Vlans
262 Configure each role to use Vlans on a single NIC for
263 each isolated network. This option assumes use of Network Isolation.
265 - environments/network-isolation.yaml
266 - overcloud-resource-registry-puppet.yaml
267 - file: environments/net-single-nic-with-vlans-v6.yaml
268 title: Single NIC with Vlans IPv6
270 Configures each role to use Vlans on a single NIC for
271 each isolated network with IPv6 on the External network.
272 This option assumes use of Network Isolation IPv6
274 - environments/network-isolation-v6.yaml
275 - overcloud-resource-registry-puppet.yaml
276 - title: Management Network
278 Enable the creation of a system management network. This
279 creates a Neutron network for isolated Overcloud
280 system management traffic and configures each role to
281 assign a port (related to that role) on that network.
283 - file: environments/network-management.yaml
284 title: Management Network
287 - overcloud-resource-registry-puppet.yaml
288 - file: environments/network-management-v6.yaml
289 title: Management Network IPv6
292 - overcloud-resource-registry-puppet.yaml
294 - title: Neutron Plugin Configuration
297 - title: Neutron Plugins
299 Enable various Neutron plugins and backends
301 - file: environments/neutron-ml2-bigswitch.yaml
302 title: BigSwitch Extensions
304 Enable Big Switch extensions, configured via puppet
306 - overcloud-resource-registry-puppet.yaml
307 - file: environments/neutron-ml2-cisco-n1kv.yaml
308 title: Cisco N1KV backend
310 Enable a Cisco N1KV backend, configured via puppet
312 - overcloud-resource-registry-puppet.yaml
313 - file: environments/neutron-ml2-cisco-nexus-ucsm.yaml
314 title: Cisco Neutron plugin
317 - overcloud-resource-registry-puppet.yaml
318 - file: environments/neutron-midonet.yaml
319 title: Deploy MidoNet Services
322 - overcloud-resource-registry-puppet.yaml
323 - file: environments/neutron-nuage-config.yaml
324 title: Neutron Nuage backend
325 description: Enables Neutron Nuage backend on the controller
327 - overcloud-resource-registry-puppet.yaml
328 - file: environments/neutron-opencontrail.yaml
329 title: OpenContrail Extensions
330 description: Enables OpenContrail extensions
332 - overcloud-resource-registry-puppet.yaml
333 - file: environments/neutron-opendaylight.yaml
335 description: Enables OpenDaylight
337 - overcloud-resource-registry-puppet.yaml
338 - file: environments/neutron-opendaylight-l3.yaml
339 title: OpenDaylight with L3 DVR
340 description: Enables OpenDaylight with L3 DVR
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
359 - title: Nova Extensions
362 - title: Nova Extensions
365 - file: environments/nova-nuage-config.yaml
368 Enables Nuage backend on the Compute
370 - overcloud-resource-registry-puppet.yaml
375 - title: Cinder backup service
378 - file: environments/cinder-backup.yaml
379 title: Cinder backup service
381 OpenStack Cinder Backup service with Pacemaker configured
384 - environments/puppet-pacemaker.yaml
385 - overcloud-resource-registry-puppet.yaml
386 - title: Cinder backend
388 Enable various Cinder backends
390 - file: environments/cinder-netapp-config.yaml
391 title: Cinder NetApp backend
394 - overcloud-resource-registry-puppet.yaml
395 - file: environments/cinder-dellsc-config.yaml
396 title: Cinder Dell Storage Center ISCSI backend
398 Enables a Cinder Dell Storage Center ISCSI backend, configured
401 - overcloud-resource-registry-puppet.yaml
402 - file: environments/cinder-eqlx-config.yaml
403 title: Cinder EQLX backend
405 Enables a Cinder EQLX backend, configured via puppet
407 - overcloud-resource-registry-puppet.yaml
408 - title: Externally managed Ceph
410 Enable the use of an externally managed Ceph cluster
412 - file: environments/puppet-ceph-external.yaml
413 title: Externally managed Ceph
416 - overcloud-resource-registry-puppet.yaml
419 Enable a Ceph storage cluster using the controller and 2 ceph nodes.
420 Rbd backends are enabled for Cinder, Glance, and Nova.
422 - file: environments/puppet-ceph-devel.yaml
426 - overcloud-resource-registry-puppet.yaml
427 - title: Storage Environment
429 Can be used to set up storage backends. Defaults to Ceph used as a
430 backend for Cinder, Glance and Nova ephemeral storage. It configures
431 for example which services will use Ceph, or if any of the services
432 will use NFS. And more. Usually requires to be edited by user first.
436 - file: environments/storage-environment.yaml
437 title: Storage Environment
440 - overcloud-resource-registry-puppet.yaml
445 - title: Config Debug
446 description: Enable config management (e.g. Puppet) debugging
448 - file: environments/config-debug.yaml
452 - overcloud-resource-registry-puppet.yaml
453 - title: Disable journal in MongoDb
455 Since, when journaling is enabled, MongoDb will create big journal
456 file it can take time. In a CI environment for example journaling is
459 - file: environments/mongodb-nojournal.yaml
460 title: Disable journal in MongoDb
463 - overcloud-resource-registry-puppet.yaml
464 - title: Overcloud Steps
466 Specifies hooks/breakpoints where overcloud deployment should stop
467 Allows operator validation between steps, and/or more granular control.
468 Note: the wildcards relate to naming convention for some resource suffixes,
469 e.g see puppet/*-post.yaml, enabling this will mean we wait for
470 a user signal on every *Deployment_StepN resource defined in those files.
474 - file: environments/overcloud-steps.yaml
475 title: Overcloud Steps
478 - overcloud-resource-registry-puppet.yaml
479 - title: Manage Firewall
482 - file: environments/manage-firewall.yaml
483 title: Manage Firewall
486 - overcloud-resource-registry-puppet.yaml
488 - title: Operational Tools
491 - title: Monitoring agents
492 description: Enable monitoring agents
494 - file: environments/monitoring-environment.yaml
495 title: enable monitoring agents
498 - overcloud-resource-registry-puppet.yaml
499 - title: Centralized logging support
500 description: Enable centralized logging clients (fluentd)
502 - file: environments/logging-environment.yaml
503 title: Enable fluentd client
506 - overcloud-resource-registry-puppet.yaml