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