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