summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 3093fc482d671c871100536549b774c83603cf0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
======================
tripleo-heat-templates
======================

Heat templates to deploy OpenStack using OpenStack.

* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/tripleo-docs
* Source: http://git.openstack.org/cgit/openstack/tripleo-heat-templates
* Bugs: http://bugs.launchpad.net/tripleo

Features
--------

The ability to deploy a multi-node, role based OpenStack deployment using
OpenStack Heat. Notable features include:

 * Choice of deployment/configuration tooling: puppet, os-apply-config, and
   (soon) docker

 * Role based deployment: roles for the controller, compute, ceph, swift,
   and cinder storage

 * physical network configuration: support for isolated networks, bonding,
   and standard ctlplane networking

Directories
-----------

A description of the directory layout in TripleO Heat Templates.

 * environments: contains heat environment files that can be used with -e
                 on the command like to enable features, etc.

 * extraconfig: templates used to enable 'extra' functionality. Includes
                functionality for distro specific registration and upgrades.

 * firstboot: example first_boot scripts that can be used when initially
              creating instances.

 * network: heat templates to help create isolated networks and ports

 * puppet: templates mostly driven by configuration with puppet. To use these
           templates you can use the overcloud-resource-registry-puppet.yaml.

 * os-apply-config: templates mostly driven by configuration w/
                    os-collect-config and bash based
                    elements (which use the Heat os-apply-config group).
                    These will soon be deprecated and are no longer part
                    of the upstream CI testing efforts.

 * validation-scripts: validation scripts useful to all deployment
                       configurations