devstack/doc/source/index.rst

DevStack - an OpenStack Community Production

overview configuration plugins faq changes contributing

guides/*

Quick Start This ain't your first rodeo

1. Select a Linux Distribution

   Only Ubuntu 14.04 (Trusty), 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.

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 minimal configuration <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.

Guides

Walk through various setups used by stackers

OpenStack on VMs

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.

Virtual Machine

Run 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. [Read] <guides/single-vm>

OpenStack on Hardware

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.

All-In-One

Run OpenStack on dedicated hardware <guides/single-machine> to get real performance in your VMs. This can include a server-class machine or a laptop at home. [Read] <guides/single-machine>

Multi-Node + VLANs

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

Documentation

Overview

An overview of DevStack goals and priorities <overview>

Configuration

Configuring and customizing the stack <configuration>

Plugins

Extending DevStack with new features <plugins>

Recent Changes

An incomplete summary of recent changes <changes>

FAQ

The DevStack FAQ <faq>

Contributing

Pitching in to make DevStack a better place <contributing>

Code

A look at the bits that make it all go

Scripts

Generated documentation of DevStack scripts.

Filename	Link
stack.sh	Read »
functions	Read »
functions-common	Read »
lib/apache	Read »
lib/baremetal	Read »
lib/ceilometer	Read »
lib/cinder	Read »
lib/config	Read »
lib/database	Read »
lib/glance	Read »
lib/heat	Read »
lib/horizon	Read »
lib/infra	Read »
lib/ironic	Read »
lib/keystone	Read »
lib/ldap	Read »
lib/zaqar	Read »
lib/neutron	Read »
lib/nova	Read »
lib/oslo	Read »
lib/rpc_backend	Read »
lib/sahara	Read »
lib/savanna	Read »
lib/stackforge	Read »
lib/swift	Read »
lib/tempest	Read »
lib/tls	Read »
lib/trove	Read »
unstack.sh	Read »
clean.sh	Read »
run_tests.sh	Read »
extras.d/50-ironic.sh	Read »
extras.d/70-zaqar.sh	Read »
extras.d/70-sahara.sh	Read »
extras.d/70-savanna.sh	Read »
extras.d/70-trove.sh	Read »
extras.d/80-opendaylight.sh	Read »
extras.d/80-tempest.sh	Read »

Configuration

Filename	Link
local.conf	Read »
stackrc	Read »
openrc	Read »
exerciserc	Read »
eucarc	Read »

Tools

Filename	Link
tools/info.sh	Read »
tools/build_docs.sh	Read »
tools/create_userrc.sh	Read »
tools/fixup_stuff.sh	Read »
tools/install_prereqs.sh	Read »
tools/install_pip.sh	Read »
tools/upload_image.sh	Read »

Samples

Generated documentation of DevStack sample files.

Filename	Link
local.sh	Read »
localrc	Read »

Exercises

Filename	Link
exercise.sh	Read »
exercises/aggregates.sh	Read »
exercises/boot_from_volume.sh	Read »
exercises/bundle.sh	Read »
exercises/client-args.sh	Read »
exercises/client-env.sh	Read »
exercises/euca.sh	Read »
exercises/floating_ips.sh	Read »
exercises/horizon.sh	Read »
exercises/neutron-adv-test.sh	Read »
exercises/sahara.sh	Read »
exercises/savanna.sh	Read »
exercises/sec_groups.sh	Read »
exercises/swift.sh	Read »
exercises/trove.sh	Read »
exercises/volumes.sh	Read »
exercises/zaqar.sh	Read »