Gitiles
Code Review Sign In
spfactory.storpool.com / devstack / 58936fdbcda70b28e14dfe9a5fe344fc1f22c40e / . / docs / source / index.html
blob: 71c8c98cee42f66aecfdae605eb664fd83d9f515 [file] [log] [blame]
Dean Troyer54b97322014-06-20 17:53:55 -0500[diff] [blame]1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <title>DevStack - Deploying OpenStack for Developers</title>
6 <meta name="description" content="">
7 <meta name="author" content="">
8
9 <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
10 <!--[if lt IE 9]>
11 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
12 <![endif]-->
13
14 <!-- Le styles -->
15 <link href="assets/css/bootstrap.css" rel="stylesheet">
16 <link href="assets/css/local.css" rel="stylesheet">
17 <style type="text/css">
18 body { padding-top: 60px; }
19 dd { padding: 10px; }
20 </style>
21
22 <!-- Le javascripts -->
23 <script src="assets/js/jquery-1.7.1.min.js" type="text/javascript" charset="utf-8"></script>
24 <script src="assets/js/bootstrap.js" type="text/javascript" charset="utf-8"></script>
25 </head>
26
27 <body>
28
29 <div class="navbar navbar-fixed-top">
30 <div class="navbar-inner">
31 <div class="container">
32 <a class="brand" href="/">DevStack</a>
33 <ul class="nav pull-right">
34 <li><a href="overview.html">Overview</a></li>
35 <li><a href="changes.html">Changes</a></li>
36 <li><a href="faq.html">FAQ</a></li>
37 <li><a href="http://github.com/openstack-dev/devstack">GitHub</a></li>
38 <li><a href="https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z">Gerrit</a></li>
39 </ul>
40 </div>
41 </div>
42 </div>
43
44 <div class="container" id="home">
45
46 <div class="hero-unit">
47 <div class="pull-left">
48 <h1 id="main_header">DevStack - an OpenStack Community Production</h1>
49 <div class="sub_header">
50 <p></p>
51 <p>A documented shell script to build complete OpenStack development environments. <br /><br />
52 An OpenStack program maintained by the developer community.</p>
53 </div>
54 </div>
55 <div class="pull-left">
56 <ol id="getting_started">
57 <li id="ubuntu">Setup a fresh supported Linux installation.</li>
58 <li id="github">
59 Clone devstack from devstack.
60 <pre>git clone https://github.com/openstack-dev/devstack.git</pre>
61 </li>
62 <li id="install">
63 Deploy your OpenStack Cloud
64 <pre>cd devstack &amp;&amp; ./stack.sh</pre>
65 </li>
66 </ol>
67 </div>
68 <div class="clear">&nbsp;</div>
69 </div>
70
71
72 <section id="quickstart" class="span12">
73 <div class="page-header">
74 <h2>Quick Start <small>This ain't your first rodeo</small></h2>
75 </div>
76 <ol>
77 <li value="0">
78 <h3>Select a Linux Distribution</h3>
79 <p>Only Ubuntu 12.04 (Precise), Fedora 20 and CentOS/RHEL 6.5 are documented here. OpenStack also runs and is packaged on other flavors of Linux such as OpenSUSE and Debian.</p>
80 </li>
81 <li>
82 <h3>Install Selected OS</h3>
83 <p>In order to correctly install all the dependencies, we assume a specific minimal version of the supported distributions to make it as easy as possible. We recommend using a minimal install of Ubuntu or Fedora server in a VM if this is your first time.</p>
84 </li>
85 <li>
86 <h3>Download DevStack</h3>
87 <pre>git clone https://github.com/openstack-dev/devstack.git</pre>
88 <p>The <code>devstack</code> repo contains a script that installs OpenStack and templates for configuration files</p>
89 </li>
90 <li>
91 <h3>Configure</h3>
92 <p>While optional, we recommend a <a href="configuration.html">minimal configuration</a> be set up as you may not want our default values for everything.</p>
93 </li>
94 <li>
95 <h3>Start the install</h3>
96 <pre>cd devstack; ./stack.sh</pre>
97 <p>It takes a few minutes, we recommend <a href="stack.sh.html">reading the script</a> while it is building.</p>
98 </li>
99 </ol>
100 </section>
101
102 <section id="guides" class='span12'>
103 <div class="page-header">
104 <h2>Guides <small>Walk through various setups used by stackers</small></h2>
105 </div>
106
107 <div class='row span8'>
108 <h2>OpenStack on VMs</h2>
109 <table class='table table-striped table-bordered'>
110 <thead>
111 <tr>
112 <th>Title</th>
113 <th>Description</th>
114 <th>Link</th>
115 </tr>
116 </thead>
117 <tbody>
118 <tr>
119 <td>Virtual Machine</td>
120 <td>Run OpenStack in a VM. The VMs launched in your cloud will be slow as they are running in QEMU (emulation), but it is useful if you don't have spare hardware laying around.</td>
121 <td><a class="btn btn-small btn-primary table-action" href="guides/single-vm.html">Read &raquo;</a></td>
122 </tr>
123
124<!--
125 <tr>
126 <td>LXC Containers</td>
127 <td>Already running Ubuntu on your machine? Using containers lets you build even faster.</td>
128 <td>Coming soon!</td>
129 </tr>
130-->
131 </tbody>
132 <tfoot>
133 <td colspan="3">1 Guide</td>
134 </tfoot>
135 </table>
136 </div>
137 <div class="wat span3 pull-right">
138 <h4>What is this?</h4>
139 <p>These guides tell you how to virtualize your OpenStack cloud in virtual machines. This means that you can get started without having to purchase any hardware.</p>
140 </div>
141
142 <div class='row span8'>
143 <h2>OpenStack on Hardware</h2>
144 <table class='table table-striped table-bordered'>
145 <thead>
146 <tr>
147 <th>Title</th>
148 <th>Description</th>
149 <th>Link</th>
150 </tr>
151 </thead>
152 <tbody>
153 <tr>
154 <td>All-In-One</td>
155 <td>Run OpenStack on dedicated hardware to get real performance in your VMs. This can include a server-class machine or a laptop at home.</td>
156 <td><a class="btn btn-small btn-primary table-action" href="guides/single-machine.html">Read &raquo;</a></td>
157 </tr>
158
159 <tr>
160 <td>Multi-Node + VLANs</td>
161 <td>Setup a multi-node cluster with dedicated VLANs for VMs &amp; Management.</td>
162 <td><a class="btn btn-small btn-primary table-action" href="guides/multinode-lab.html">Read &raquo;</a></td>
163 </tr>
164
165<!--
166 <tr>
167 <td>Stack-in-a-Box</td>
168 <td>Run OpenStack from a RAM disk to give it a spin without touching your existing OS installation. Includes PXE and USB boot methods.</td>
169 <td><a class="btn btn-small btn-primary table-action" href="guides/ramdisk.html">Read &raquo;</a></td>
170 </tr>
171-->
172 </tbody>
173 <tfoot>
174 <td colspan="3">2 Guides</td>
175 </tfoot>
176 </table>
177 </div>
178 <div class="wat span3 pull-right">
179 <h4>What is this?</h4>
180 <p>These guides tell you how to deploy a development environment on real hardware. Guides range from running OpenStack on a single laptop to running a multi-node deployment on datacenter hardware.</p>
181 </div>
182
183 </section>
184
185 <section id="docs" class="span12">
186 <div class="page-header">
187 <h2>Documentation <small>Help yourself to stack</small></h2>
188 </div>
189
190 <div class='row span5 pull-left'>
191 <h2>Overview</h2>
192 <p><a href="overview.html">An overview of DevStack goals and priorities</a></p>
193 <h2>Configuration</h2>
194 <p><a href="configuration.html">Configuring and customizing the stack</a></p>
195 <h2>Plugins</h2>
196 <p><a href="plugins.html">Extending DevStack with new features</a></p>
197 </div>
198
199 <div class='span5 pull-right'>
200 <h2>Recent Changes</h2>
201 <p><a href="changes.html">An incomplete summary of recent changes</a></p>
202 <h2>FAQ</h2>
203 <p><a href="faq.html">The DevStack FAQ</a></p>
204 <h2>Contributing</h2>
205 <p><a href="contributing.html">Pitching in to make DevStack a better place</a></p>
206 </div>
207
208 </section>
209
210 <section id="docs" class="span12">
211 <div class="page-header">
212 <h2>Code <small>A look at the bits that make it all go</small></h2>
213 </div>
214
215 <div class='row span5 pull-left'>
216 <h2>Scripts <small>Generated documentation of DevStack scripts.</small></h2>
217 <table class='table table-striped table-bordered'>
218 <thead>
219 <tr>
220 <th>Filename</th>
221 <th>Link</th>
222 </tr>
223 </thead>
224 <tbody>
225 <tr>
226 <td>stack.sh</td>
227 <td><a href="stack.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
228 </tr>
229 <tr>
230 <td>functions</td>
231 <td><a href="functions.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
232 </tr>
233 <tr>
234 <td>lib/apache</td>
235 <td><a href="lib/apache.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
236 </tr>
237 <tr>
238 <td>lib/baremetal</td>
239 <td><a href="lib/baremetal.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
240 </tr>
241 <tr>
242 <td>lib/ceilometer</td>
243 <td><a href="lib/ceilometer.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
244 </tr>
245 <tr>
246 <td>lib/cinder</td>
247 <td><a href="lib/cinder.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
248 </tr>
249 <tr>
250 <td>lib/config</td>
251 <td><a href="lib/config.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
252 </tr>
253 <tr>
254 <td>lib/database</td>
255 <td><a href="lib/database.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
256 </tr>
257 <tr>
258 <td>lib/glance</td>
259 <td><a href="lib/glance.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
260 </tr>
261 <tr>
262 <td>lib/heat</td>
263 <td><a href="lib/heat.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
264 </tr>
265 <tr>
266 <td>lib/horizon</td>
267 <td><a href="lib/horizon.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
268 </tr>
269 <tr>
270 <td>lib/infra</td>
271 <td><a href="lib/infra.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
272 </tr>
273 <tr>
274 <td>lib/ironic</td>
275 <td><a href="lib/ironic.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
276 </tr>
277 <tr>
278 <td>lib/keystone</td>
279 <td><a href="lib/keystone.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
280 </tr>
281 <tr>
282 <td>lib/ldap</td>
283 <td><a href="lib/ldap.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
284 </tr>
285 <tr>
286 <td>lib/marconi</td>
287 <td><a href="lib/marconi.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
288 </tr>
289 <tr>
290 <td>lib/neutron</td>
291 <td><a href="lib/neutron.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
292 </tr>
293 <tr>
294 <td>lib/nova</td>
295 <td><a href="lib/nova.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
296 </tr>
297 <tr>
298 <td>lib/oslo</td>
299 <td><a href="lib/oslo.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
300 </tr>
301 <tr>
302 <td>lib/rpc_backend</td>
303 <td><a href="lib/rpc_backend.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
304 </tr>
305 <tr>
306 <td>lib/savanna</td>
307 <td><a href="lib/savanna.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
308 </tr>
309 <tr>
310 <td>lib/savanna-dashboard</td>
311 <td><a href="lib/savanna-dashboard.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
312 </tr>
313 <tr>
314 <td>lib/stackforge</td>
315 <td><a href="lib/stackforge.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
316 </tr>
317 <tr>
318 <td>lib/swift</td>
319 <td><a href="lib/swift.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
320 </tr>
321 <tr>
322 <td>lib/tempest</td>
323 <td><a href="lib/tempest.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
324 </tr>
325 <tr>
326 <td>lib/tls</td>
327 <td><a href="lib/tls.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
328 </tr>
329 <tr>
330 <td>lib/trove</td>
331 <td><a href="lib/trove.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
332 </tr>
333 <tr>
334 <td>unstack.sh</td>
335 <td><a href="unstack.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
336 </tr>
337 <tr>
338 <td>clean.sh</td>
339 <td><a href="clean.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
340 </tr>
341 <tr>
342 <td>run_tests.sh</td>
343 <td><a href="run_tests.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
344 </tr>
345 <tr>
346 <td>extras.d/70-marconi.sh</td>
347 <td><a href="extras.d/70-marconi.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
348 </tr>
349 <tr>
350 <td>extras.d/70-savanna.sh</td>
351 <td><a href="extras.d/70-savanna.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
352 </tr>
353 <tr>
354 <td>extras.d/80-tempest.sh</td>
355 <td><a href="extras.d/80-tempest.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
356 </tr>
357 <tr>
358 <td>tools/info.sh</td>
359 <td><a href="tools/info.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
360 </tr>
361 <tr>
362 <td>tools/build_docs.sh</td>
363 <td><a href="tools/build_docs.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
364 </tr>
365 <tr>
366 <td>tools/create_userrc.sh</td>
367 <td><a href="tools/create_userrc.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
368 </tr>
369 <tr>
370 <td>tools/fixup_stuff.sh</td>
371 <td><a href="tools/fixup_stuff.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
372 </tr>
373 <tr>
374 <td>tools/install_prereqs.sh</td>
375 <td><a href="tools/install_prereqs.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
376 </tr>
377 <tr>
378 <td>tools/install_pip.sh</td>
379 <td><a href="tools/install_pip.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
380 </tr>
381 <tr>
382 <td>tools/upload_image.sh</td>
383 <td><a href="tools/upload_image.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
384 </tr>
385 </tbody>
386 <tfoot>
387 <td colspan="3">40 bash scripts</td>
388 </tfoot>
389 </table>
390 </div>
391
392 <div class='span5 pull-right'>
393 <h2>Configuration <small>Setting the table</small></h2>
394 <table class='table table-striped table-bordered'>
395 <thead>
396 <tr>
397 <th>Filename</th>
398 <th>Link</th>
399 </tr>
400 </thead>
401 <tbody>
402 <tr>
403 <td>local.conf</td>
404 <td><a href="local.conf.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
405 </tr>
406 <tr>
407 <td>stackrc</td>
408 <td><a href="stackrc.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
409 </tr>
410 <tr>
411 <td>openrc</td>
412 <td><a href="openrc.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
413 </tr>
414 <tr>
415 <td>exerciserc</td>
416 <td><a href="exerciserc.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
417 </tr>
418 <tr>
419 <td>eucarc</td>
420 <td><a href="eucarc.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
421 </tr>
422 </tbody>
423 <tfoot>
424 <td colspan="3">5 configuration files</td>
425 </tfoot>
426 </table>
427
428 <h2>Samples <small>Generated documentation of DevStack sample files.</small></h2>
429 <table class='table table-striped table-bordered'>
430 <thead>
431 <tr>
432 <th>Filename</th>
433 <th>Link</th>
434 </tr>
435 </thead>
436 <tbody>
437 <tr>
438 <td>local.sh</td>
439 <td><a href="samples/local.sh.html" class="btn btn-small btn-success table-action">Read &raquo;</a></td>
440 </tr>
441 <tr>
442 <td>localrc</td>
443 <td><a href="samples/localrc.html" class="btn btn-small btn-success table-action">Read &raquo;</a></td>
444 </tr>
445 </tbody>
446 <tfoot>
447 <td colspan="3">2 sample files</td>
448 </tfoot>
449 </table>
450
451 <div class='row span5 pull-right'>
452 <h2>Exercises <small>Generated documentation of DevStack scripts.</small></h2>
453 <table class='table table-striped table-bordered'>
454 <thead>
455 <tr>
456 <th>Filename</th>
457 <th>Link</th>
458 </tr>
459 </thead>
460 <tbody>
461 <tr>
462 <td>exercise.sh</td>
463 <td><a href="exercise.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
464 </tr>
465 <tr>
466 <td>exercises/aggregates.sh</td>
467 <td><a href="exercises/aggregates.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
468 </tr>
469 <tr>
470 <td>exercises/boot_from_volume.sh</td>
471 <td><a href="exercises/boot_from_volume.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
472 </tr>
473 <tr>
474 <td>exercises/bundle.sh</td>
475 <td><a href="exercises/bundle.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
476 </tr>
477 <tr>
478 <td>exercises/client-args.sh</td>
479 <td><a href="exercises/client-args.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
480 </tr>
481 <tr>
482 <td>exercises/client-env.sh</td>
483 <td><a href="exercises/client-env.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
484 </tr>
485 <tr>
486 <td>exercises/euca.sh</td>
487 <td><a href="exercises/euca.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
488 </tr>
489 <tr>
490 <td>exercises/floating_ips.sh</td>
491 <td><a href="exercises/floating_ips.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
492 </tr>
493 <tr>
494 <td>exercises/horizon.sh</td>
495 <td><a href="exercises/horizon.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
496 </tr>
497 <tr>
498 <td>exercises/neutron-adv-test.sh</td>
499 <td><a href="exercises/neutron-adv-test.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
500 </tr>
501 <tr>
502 <td>exercises/sec_groups.sh</td>
503 <td><a href="exercises/sec_groups.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
504 </tr>
505 <tr>
506 <td>exercises/swift.sh</td>
507 <td><a href="exercises/swift.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
508 </tr>
509 <tr>
510 <td>exercises/volumes.sh</td>
511 <td><a href="exercises/volumes.sh.html" class="btn btn-small btn-primary table-action">Read &raquo;</a></td>
512 </tr>
513 </tbody>
514 <tfoot>
515 <td colspan="3">13 exercise scripts</td>
516 </tfoot>
517 </table>
518
519 </div>
520
521 </section>
522
523 <footer>
524 <p>&copy; Openstack Foundation 2011-2014 &mdash; An <a href="https://www.openstack.org/">OpenStack</a> <a href="https://wiki.openstack.org/wiki/Programs">program</a></p>
525 </footer>
526
527 </div> <!-- /container -->
528 </body>
529</html>