devstack/doc/source/index.rst

DevStack - an OpenStack Community Production

overview configuration plugins faq changes contributing

Quick Start

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

guides/single-vm guides/single-machine guides/multinode-lab guides/neutron

All-In-One Single VM

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>

All-In-One Single Machine

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

Multi-Node Lab

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

DevStack with Neutron Networking

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

DevStack 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

• stack.sh - The main script
• functions - DevStack-specific functions
• functions-common - Functions shared with other projects
• lib/apache
• lib/baremetal
• lib/ceilometer
• lib/ceph
• lib/cinder
• lib/config
• lib/database
• lib/dib
• lib/dstat
• lib/glance
• lib/heat
• lib/horizon
• lib/infra
• lib/ironic
• lib/keystone
• lib/ldap
• lib/neutron
• lib/nova
• lib/opendaylight
• lib/oslo
• lib/rpc_backend
• lib/sahara
• lib/stackforge
• lib/swift
• lib/tempest
• lib/tls
• lib/trove
• lib/zaqar
• unstack.sh
• clean.sh
• run_tests.sh
• extras.d/40-dib.sh
• extras.d/50-ironic.sh
• extras.d/60-ceph.sh
• extras.d/70-sahara.sh
• extras.d/70-trove.sh
• extras.d/70-zaqar.sh
• extras.d/80-opendaylight.sh
• extras.d/80-tempest.sh

Configuration

local.conf stackrc openrc exerciserc eucarc

Tools

• tools/build_docs.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

Samples

• local.sh

Exercises

• 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/trove.sh
• exercises/volumes.sh
• exercises/zaqar.sh