Merge "Change database sync timeout from 300 to 900 in low-memory-usage environment...
[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
56
57
58 Service testing matrix
59 ----------------------
60
61 The configuration for the CI scenarios will be defined in `tripleo-heat-templates/ci/`
62 and should be executed according to the following table:
63
64 +----------------+-------------+-------------+-------------+-------------+-----------------+
65 |        -       | scenario001 | scenario002 | scenario003 | scenario004 | multinode-nonha |
66 +================+=============+=============+=============+=============+=================+
67 | keystone       |      X      |      X      |      X      |      X      |        X        |
68 +----------------+-------------+-------------+-------------+-------------+-----------------+
69 | glance         |    rbd      |    swift    |    file     | swift + rbd |      swift      |
70 +----------------+-------------+-------------+-------------+-------------+-----------------+
71 | cinder         |     rbd     |    iscsi    |             |             |      iscsi      |
72 +----------------+-------------+-------------+-------------+-------------+-----------------+
73 | heat           |      X      |      X      |      X      |      X      |        X        |
74 +----------------+-------------+-------------+-------------+-------------+-----------------+
75 | mysql          |      X      |      X      |      X      |      X      |        X        |
76 +----------------+-------------+-------------+-------------+-------------+-----------------+
77 | neutron        |     ovs     |     ovs     |     ovs     |     ovs     |        X        |
78 +----------------+-------------+-------------+-------------+-------------+-----------------+
79 | neutron-bgpvpn |             |             |             |      X      |                 |
80 +----------------+-------------+-------------+-------------+-------------+-----------------+
81 | neutron-l2gw   |             |             |             |      X      |                 |
82 +----------------+-------------+-------------+-------------+-------------+-----------------+
83 | rabbitmq       |      X      |      X      |      X      |      X      |        X        |
84 +----------------+-------------+-------------+-------------+-------------+-----------------+
85 | mongodb        |      X      |      X      |             |             |                 |
86 +----------------+-------------+-------------+-------------+-------------+-----------------+
87 | redis          |      X      |             |             |             |                 |
88 +----------------+-------------+-------------+-------------+-------------+-----------------+
89 | haproxy        |      X      |      X      |      X      |      X      |        X        |
90 +----------------+-------------+-------------+-------------+-------------+-----------------+
91 | keepalived     |      X      |      X      |      X      |      X      |        X        |
92 +----------------+-------------+-------------+-------------+-------------+-----------------+
93 | memcached      |      X      |      X      |      X      |      X      |        X        |
94 +----------------+-------------+-------------+-------------+-------------+-----------------+
95 | pacemaker      |      X      |      X      |      X      |      X      |        X        |
96 +----------------+-------------+-------------+-------------+-------------+-----------------+
97 | nova           |     qemu    |     qemu    |     qemu    |     qemu    |        X        |
98 +----------------+-------------+-------------+-------------+-------------+-----------------+
99 | ntp            |      X      |      X      |      X      |      X      |        X        |
100 +----------------+-------------+-------------+-------------+-------------+-----------------+
101 | snmp           |      X      |      X      |      X      |      X      |        X        |
102 +----------------+-------------+-------------+-------------+-------------+-----------------+
103 | timezone       |      X      |      X      |      X      |      X      |        X        |
104 +----------------+-------------+-------------+-------------+-------------+-----------------+
105 | sahara         |             |             |      X      |             |                 |
106 +----------------+-------------+-------------+-------------+-------------+-----------------+
107 | mistral        |             |             |      X      |             |                 |
108 +----------------+-------------+-------------+-------------+-------------+-----------------+
109 | swift          |             |      X      |             |             |        X        |
110 +----------------+-------------+-------------+-------------+-------------+-----------------+
111 | aodh           |      X      |             |             |             |                 |
112 +----------------+-------------+-------------+-------------+-------------+-----------------+
113 | ceilometer     |      X      |             |             |             |                 |
114 +----------------+-------------+-------------+-------------+-------------+-----------------+
115 | gnocchi        |      X      |             |             |             |                 |
116 +----------------+-------------+-------------+-------------+-------------+-----------------+
117 | panko          |      X      |             |             |             |                 |
118 +----------------+-------------+-------------+-------------+-------------+-----------------+
119 | barbican       |             |      X      |             |             |                 |
120 +----------------+-------------+-------------+-------------+-------------+-----------------+
121 | zaqar          |             |      X      |             |             |                 |
122 +----------------+-------------+-------------+-------------+-------------+-----------------+
123 | ec2api         |             |      X      |             |             |                 |
124 +----------------+-------------+-------------+-------------+-------------+-----------------+
125 | cephrgw        |             |      X      |             |      X      |                 |
126 +----------------+-------------+-------------+-------------+-------------+-----------------+
127 | tacker         |      X      |             |             |             |                 |
128 +----------------+-------------+-------------+-------------+-------------+-----------------+
129 | congress       |      X      |             |             |             |                 |
130 +----------------+-------------+-------------+-------------+-------------+-----------------+
131 | cephmds        |             |             |             |      X      |                 |
132 +----------------+-------------+-------------+-------------+-------------+-----------------+
133 | manila         |             |             |             |      X      |                 |
134 +----------------+-------------+-------------+-------------+-------------+-----------------+
135 | collectd       |      X      |             |             |             |                 |
136 +----------------+-------------+-------------+-------------+-------------+-----------------+
137 | fluentd        |      X      |             |             |             |                 |
138 +----------------+-------------+-------------+-------------+-------------+-----------------+
139 | sensu-client   |      X      |             |             |             |                 |
140 +----------------+-------------+-------------+-------------+-------------+-----------------+