Merge "Added libvirt_vif_driver, ovs_bridge and security_group_api parameters"
[apex-tripleo-heat-templates.git] / README.rst
1 ======================
2 tripleo-heat-templates
3 ======================
4
5 Heat templates to deploy OpenStack using OpenStack.
6
7 * Free software: Apache license
8 * Documentation: http://docs.openstack.org/developer/tripleo-docs
9 * Source: http://git.openstack.org/cgit/openstack/tripleo-heat-templates
10 * Bugs: http://bugs.launchpad.net/tripleo
11
12 Features
13 --------
14
15 The ability to deploy a multi-node, role based OpenStack deployment using
16 OpenStack Heat. Notable features include:
17
18  * Choice of deployment/configuration tooling: puppet, os-apply-config, and
19    (soon) docker
20
21  * Role based deployment: roles for the controller, compute, ceph, swift,
22    and cinder storage
23
24  * physical network configuration: support for isolated networks, bonding,
25    and standard ctlplane networking
26
27 Directories
28 -----------
29
30 A description of the directory layout in TripleO Heat Templates.
31
32  * environments: contains heat environment files that can be used with -e
33                  on the command like to enable features, etc.
34
35  * extraconfig: templates used to enable 'extra' functionality. Includes
36                 functionality for distro specific registration and upgrades.
37
38  * firstboot: example first_boot scripts that can be used when initially
39               creating instances.
40
41  * network: heat templates to help create isolated networks and ports
42
43  * puppet: templates mostly driven by configuration with puppet. To use these
44            templates you can use the overcloud-resource-registry-puppet.yaml.
45
46  * os-apply-config: templates mostly driven by configuration w/
47                     os-collect-config and bash based
48                     elements (which use the Heat os-apply-config group).
49                     These will soon be deprecated and are no longer part
50                     of the upstream CI testing efforts.
51
52  * validation-scripts: validation scripts useful to all deployment
53                        configurations