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