.. toctree::
   :glob:
   :maxdepth: 1

   overview
   configuration
   plugins
   faq
   changes
   hacking

1. Select a Linux Distribution

   Only Ubuntu 14.04 (Trusty), Fedora 20 and CentOS/RHEL 7 are documented here. OpenStack also runs and is packaged on other flavors of Linux such as OpenSUSE and Debian.

2. Install Selected OS

   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.

3. Download DevStack

   git clone https://git.openstack.org/openstack-dev/devstack
   

   The devstack repo contains a script that installs OpenStack and templates for configuration files

4. Configure

   We recommend at least a :ref:`minimal-configuration` be set up.

5. Start the install

   cd devstack; ./stack.sh
   

   It takes a few minutes, we recommend reading the script while it is building.

Walk through various setups used by stackers

.. toctree::
   :glob:
   :maxdepth: 1

   guides/single-vm
   guides/single-machine
   guides/multinode-lab
   guides/neutron
   guides/devstack-with-nested-kvm
   guides/nova
   guides/devstack-with-lbaas-v2

Run :doc:`OpenStack in a VM <guides/single-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. :doc:`[Read] <guides/single-vm>`

Run :doc:`OpenStack on dedicated hardware <guides/single-machine>` This can include a server-class machine or a laptop at home. :doc:`[Read] <guides/single-machine>`

Setup a :doc:`multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management. :doc:`[Read] <guides/multinode-lab>`

Building a DevStack cluster with :doc:`Neutron Networking <guides/neutron>`. This guide is meant for building lab environments with a dedicated control node and multiple compute nodes.

Procedure to setup :doc:`DevStack with KVM-based Nested Virtualization <guides/devstack-with-nested-kvm>`. With this setup, Nova instances will be more performant than with plain QEMU emulation.

Guide to working with nova features :doc:`Nova and devstack <guides/nova>`.

:doc:`An overview of DevStack goals and priorities <overview>`

:doc:`Configuring and customizing the stack <configuration>`

:doc:`Extending DevStack with new features <plugins>`

:doc:`An incomplete summary of recent changes <changes>`

:doc:`The DevStack FAQ <faq>`

:doc:`Pitching in to make DevStack a better place <hacking>`

A look at the bits that make it all go

• stack.sh - The main script
• functions - DevStack-specific functions
• functions-common - Functions shared with other projects
• lib/apache
• lib/ceilometer
• lib/ceph
• lib/cinder
• lib/database
• lib/dstat
• lib/glance
• lib/heat
• lib/horizon
• lib/infra
• lib/ironic
• lib/keystone
• lib/ldap
• lib/neutron-legacy
• lib/nova
• lib/oslo
• lib/rpc_backend
• lib/sahara
• lib/swift
• lib/tempest
• lib/tls
• lib/zaqar
• unstack.sh
• clean.sh
• run_tests.sh
• extras.d/50-ironic.sh
• extras.d/60-ceph.sh
• extras.d/70-sahara.sh
• extras.d/70-tuskar.sh
• extras.d/70-zaqar.sh
• extras.d/80-tempest.sh
• inc/ini-config
• inc/meta-config
• inc/python
• pkg/elasticsearch.sh

.. toctree::
   :glob:
   :maxdepth: 1

   local.conf
   stackrc
   openrc
   exerciserc
   eucarc

• tools/build_docs.sh
• tools/build_venv.sh
• tools/build_wheels.sh
• tools/create-stack-user.sh
• tools/create_userrc.sh
• tools/fixup_stuff.sh
• tools/info.sh
• tools/install_pip.sh
• tools/install_prereqs.sh
• tools/make_cert.sh
• tools/upload_image.sh

• local.sh

• exercise.sh
• exercises/aggregates.sh
• exercises/boot_from_volume.sh
• exercises/bundle.sh
• exercises/client-args.sh
• exercises/client-env.sh
• exercises/euca.sh
• exercises/floating_ips.sh
• exercises/horizon.sh
• exercises/neutron-adv-test.sh
• exercises/sahara.sh
• exercises/sec_groups.sh
• exercises/swift.sh
• exercises/volumes.sh
• exercises/zaqar.sh