Gitiles
Code Review Sign In
spfactory.storpool.com / devstack / 94f8bea9e4ff0434df1723cf269c4300a4373524 / . / doc / source / index.rst
blob: 2128620ffd8e795374db7d32e01fa1d11690ed94 [file] [log] [blame]
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]1DevStack - an OpenStack Community Production
2============================================
3
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]4.. toctree::
5 :glob:
6 :maxdepth: 1
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]7
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]8 overview
9 configuration
10 plugins
11 faq
12 changes
13 contributing
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]14
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]15 guides/*
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]16
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]17
18Quick Start This ain't your first rodeo
19---------------------------------------
20
21#. Select a Linux Distribution
22
23 Only Ubuntu 14.04 (Trusty), Fedora 20 and CentOS/RHEL 6.5 are
24 documented here. OpenStack also runs and is packaged on other flavors
25 of Linux such as OpenSUSE and Debian.
26
27#. Install Selected OS
28
29 In order to correctly install all the dependencies, we assume a
30 specific minimal version of the supported distributions to make it as
31 easy as possible. We recommend using a minimal install of Ubuntu or
32 Fedora server in a VM if this is your first time.
33
34#. Download DevStack
35
36 ::
37
38 git clone https://git.openstack.org/openstack-dev/devstack
39
40 The ``devstack`` repo contains a script that installs OpenStack and
41 templates for configuration files
42
43#. Configure
44
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]45 We recommend at least a :doc:`minimal
46 configuration <configuration>` be set up.
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]47
48#. Start the install
49
50 ::
51
52 cd devstack; ./stack.sh
53
54 It takes a few minutes, we recommend `reading the
55 script <stack.sh.html>`__ while it is building.
56
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]57Guides
58======
59
60Walk through various setups used by stackers
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]61
62OpenStack on VMs
63----------------
64
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]65These guides tell you how to virtualize your OpenStack cloud in virtual
66machines. This means that you can get started without having to purchase
67any hardware.
68
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]69Virtual Machine
70~~~~~~~~~~~~~~~
71
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]72:doc:`Run OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]73they are running in QEMU (emulation), but it is useful if you don't have
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]74spare hardware laying around. :doc:`[Read] <guides/single-vm>`
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]75
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]76OpenStack on Hardware
77---------------------
78
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]79These guides tell you how to deploy a development environment on real
80hardware. Guides range from running OpenStack on a single laptop to
81running a multi-node deployment on datacenter hardware.
82
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]83All-In-One
84~~~~~~~~~~
85
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]86:doc:`Run OpenStack on dedicated hardware <guides/single-machine>` to get real performance in your VMs.
87This can include a server-class machine or a laptop at home. :doc:`[Read] <guides/single-machine>`
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]88
89Multi-Node + VLANs
90~~~~~~~~~~~~~~~~~~
91
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]92:doc:`Setup a multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management. :doc:`[Read] <guides/multinode-lab>`
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]93
94Documentation
95=============
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]96
97Overview
98--------
99
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]100:doc:`An overview of DevStack goals and priorities <overview>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]101
102Configuration
103-------------
104
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]105:doc:`Configuring and customizing the stack <configuration>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]106
107Plugins
108-------
109
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]110:doc:`Extending DevStack with new features <plugins>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]111
112Recent Changes
113--------------
114
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]115:doc:`An incomplete summary of recent changes <changes>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]116
117FAQ
118---
119
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]120:doc:`The DevStack FAQ <faq>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]121
122Contributing
123------------
124
Dean Troyerd224ae12014-11-06 09:33:02 -0600[diff] [blame]125:doc:`Pitching in to make DevStack a better place <contributing>`
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]126
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]127Code
128====
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]129
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]130A look at the bits that make it all go
131
132Scripts
133-------
134
135Generated documentation of DevStack scripts.
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]136
137+-------------------------------+----------------------------------------------+
138| Filename | Link |
139+===============================+==============================================+
140| stack.sh | `Read » <stack.sh.html>`__ |
141+-------------------------------+----------------------------------------------+
142| functions | `Read » <functions.html>`__ |
143+-------------------------------+----------------------------------------------+
144| functions-common | `Read » <functions-common.html>`__ |
145+-------------------------------+----------------------------------------------+
146| lib/apache | `Read » <lib/apache.html>`__ |
147+-------------------------------+----------------------------------------------+
148| lib/baremetal | `Read » <lib/baremetal.html>`__ |
149+-------------------------------+----------------------------------------------+
150| lib/ceilometer | `Read » <lib/ceilometer.html>`__ |
151+-------------------------------+----------------------------------------------+
152| lib/cinder | `Read » <lib/cinder.html>`__ |
153+-------------------------------+----------------------------------------------+
154| lib/config | `Read » <lib/config.html>`__ |
155+-------------------------------+----------------------------------------------+
156| lib/database | `Read » <lib/database.html>`__ |
157+-------------------------------+----------------------------------------------+
158| lib/glance | `Read » <lib/glance.html>`__ |
159+-------------------------------+----------------------------------------------+
160| lib/heat | `Read » <lib/heat.html>`__ |
161+-------------------------------+----------------------------------------------+
162| lib/horizon | `Read » <lib/horizon.html>`__ |
163+-------------------------------+----------------------------------------------+
164| lib/infra | `Read » <lib/infra.html>`__ |
165+-------------------------------+----------------------------------------------+
166| lib/ironic | `Read » <lib/ironic.html>`__ |
167+-------------------------------+----------------------------------------------+
168| lib/keystone | `Read » <lib/keystone.html>`__ |
169+-------------------------------+----------------------------------------------+
170| lib/ldap | `Read » <lib/ldap.html>`__ |
171+-------------------------------+----------------------------------------------+
172| lib/zaqar | `Read » <lib/zaqar.html>`__ |
173+-------------------------------+----------------------------------------------+
174| lib/neutron | `Read » <lib/neutron.html>`__ |
175+-------------------------------+----------------------------------------------+
176| lib/nova | `Read » <lib/nova.html>`__ |
177+-------------------------------+----------------------------------------------+
178| lib/oslo | `Read » <lib/oslo.html>`__ |
179+-------------------------------+----------------------------------------------+
180| lib/rpc\_backend | `Read » <lib/rpc_backend.html>`__ |
181+-------------------------------+----------------------------------------------+
182| lib/sahara | `Read » <lib/sahara.html>`__ |
183+-------------------------------+----------------------------------------------+
184| lib/savanna | `Read » <lib/savanna.html>`__ |
185+-------------------------------+----------------------------------------------+
186| lib/stackforge | `Read » <lib/stackforge.html>`__ |
187+-------------------------------+----------------------------------------------+
188| lib/swift | `Read » <lib/swift.html>`__ |
189+-------------------------------+----------------------------------------------+
190| lib/tempest | `Read » <lib/tempest.html>`__ |
191+-------------------------------+----------------------------------------------+
192| lib/tls | `Read » <lib/tls.html>`__ |
193+-------------------------------+----------------------------------------------+
194| lib/trove | `Read » <lib/trove.html>`__ |
195+-------------------------------+----------------------------------------------+
196| unstack.sh | `Read » <unstack.sh.html>`__ |
197+-------------------------------+----------------------------------------------+
198| clean.sh | `Read » <clean.sh.html>`__ |
199+-------------------------------+----------------------------------------------+
200| run\_tests.sh | `Read » <run_tests.sh.html>`__ |
201+-------------------------------+----------------------------------------------+
202| extras.d/50-ironic.sh | `Read » <extras.d/50-ironic.html>`__ |
203+-------------------------------+----------------------------------------------+
204| extras.d/70-zaqar.sh | `Read » <extras.d/70-zaqar.html>`__ |
205+-------------------------------+----------------------------------------------+
206| extras.d/70-sahara.sh | `Read » <extras.d/70-sahara.html>`__ |
207+-------------------------------+----------------------------------------------+
208| extras.d/70-savanna.sh | `Read » <extras.d/70-savanna.html>`__ |
209+-------------------------------+----------------------------------------------+
210| extras.d/70-trove.sh | `Read » <extras.d/70-trove.html>`__ |
211+-------------------------------+----------------------------------------------+
212| extras.d/80-opendaylight.sh | `Read » <extras.d/80-opendaylight.html>`__ |
213+-------------------------------+----------------------------------------------+
214| extras.d/80-tempest.sh | `Read » <extras.d/80-tempest.html>`__ |
215+-------------------------------+----------------------------------------------+
216
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]217Configuration
218-------------
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]219
220+--------------+--------------------------------+
221| Filename | Link |
222+==============+================================+
223| local.conf | `Read » <local.conf.html>`__ |
224+--------------+--------------------------------+
225| stackrc | `Read » <stackrc.html>`__ |
226+--------------+--------------------------------+
227| openrc | `Read » <openrc.html>`__ |
228+--------------+--------------------------------+
229| exerciserc | `Read » <exerciserc.html>`__ |
230+--------------+--------------------------------+
231| eucarc | `Read » <eucarc.html>`__ |
232+--------------+--------------------------------+
233
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]234Tools
235-----
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]236
237+-----------------------------+----------------------------------------------+
238| Filename | Link |
239+=============================+==============================================+
240| tools/info.sh | `Read » <tools/info.sh.html>`__ |
241+-----------------------------+----------------------------------------------+
242| tools/build\_docs.sh | `Read » <tools/build_docs.sh.html>`__ |
243+-----------------------------+----------------------------------------------+
244| tools/create\_userrc.sh | `Read » <tools/create_userrc.sh.html>`__ |
245+-----------------------------+----------------------------------------------+
246| tools/fixup\_stuff.sh | `Read » <tools/fixup_stuff.sh.html>`__ |
247+-----------------------------+----------------------------------------------+
248| tools/install\_prereqs.sh | `Read » <tools/install_prereqs.sh.html>`__ |
249+-----------------------------+----------------------------------------------+
250| tools/install\_pip.sh | `Read » <tools/install_pip.sh.html>`__ |
251+-----------------------------+----------------------------------------------+
252| tools/upload\_image.sh | `Read » <tools/upload_image.sh.html>`__ |
253+-----------------------------+----------------------------------------------+
254
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]255Samples
256-------
257
258Generated documentation of DevStack sample files.
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]259
260+------------+--------------------------------------+
261| Filename | Link |
262+============+======================================+
263| local.sh | `Read » <samples/local.sh.html>`__ |
264+------------+--------------------------------------+
265| localrc | `Read » <samples/localrc.html>`__ |
266+------------+--------------------------------------+
267
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]268Exercises
269---------
Sean M. Collins09e550c2014-10-21 11:40:08 -0400[diff] [blame]270
Sean M. Collinsf76ed012014-10-27 11:36:41 -0400[diff] [blame]271+---------------------------------+-------------------------------------------------+
272| Filename | Link |
273+=================================+=================================================+
274| exercise.sh | `Read » <exercise.sh.html>`__ |
275+---------------------------------+-------------------------------------------------+
276| exercises/aggregates.sh | `Read » <exercises/aggregates.sh.html>`__ |
277+---------------------------------+-------------------------------------------------+
278| exercises/boot\_from\_volume.sh | `Read » <exercises/boot_from_volume.sh.html>`__ |
279+---------------------------------+-------------------------------------------------+
280| exercises/bundle.sh | `Read » <exercises/bundle.sh.html>`__ |
281+---------------------------------+-------------------------------------------------+
282| exercises/client-args.sh | `Read » <exercises/client-args.sh.html>`__ |
283+---------------------------------+-------------------------------------------------+
284| exercises/client-env.sh | `Read » <exercises/client-env.sh.html>`__ |
285+---------------------------------+-------------------------------------------------+
286| exercises/euca.sh | `Read » <exercises/euca.sh.html>`__ |
287+---------------------------------+-------------------------------------------------+
288| exercises/floating\_ips.sh | `Read » <exercises/floating_ips.sh.html>`__ |
289+---------------------------------+-------------------------------------------------+
290| exercises/horizon.sh | `Read » <exercises/horizon.sh.html>`__ |
291+---------------------------------+-------------------------------------------------+
292| exercises/neutron-adv-test.sh | `Read » <exercises/neutron-adv-test.sh.html>`__ |
293+---------------------------------+-------------------------------------------------+
294| exercises/sahara.sh | `Read » <exercises/sahara.sh.html>`__ |
295+---------------------------------+-------------------------------------------------+
296| exercises/savanna.sh | `Read » <exercises/savanna.sh.html>`__ |
297+---------------------------------+-------------------------------------------------+
298| exercises/sec\_groups.sh | `Read » <exercises/sec_groups.sh.html>`__ |
299+---------------------------------+-------------------------------------------------+
300| exercises/swift.sh | `Read » <exercises/swift.sh.html>`__ |
301+---------------------------------+-------------------------------------------------+
302| exercises/trove.sh | `Read » <exercises/trove.sh.html>`__ |
303+---------------------------------+-------------------------------------------------+
304| exercises/volumes.sh | `Read » <exercises/volumes.sh.html>`__ |
305+---------------------------------+-------------------------------------------------+
306| exercises/zaqar.sh | `Read » <exercises/zaqar.sh.html>`__ |
307+---------------------------------+-------------------------------------------------+
Dean Troyer63baba22014-10-29 21:57:31 -0500[diff] [blame]308
309.. toctree::
310 :glob:
311 :maxdepth: 1
312
313 *