devstack/doc/source/index.rst
Sean Dague 0124e08ede refresh the devstack plugin docs, add plugin registry
The devstack plugin docs mostly referred to in tree plugins, which is
honestly something we don't want people doing. Instead restructure the
whole document to talk about external plugins as the only kinds of
plugins, and focus on a workflow to make that easy for people to work
through.

This also adds a plugin-registry page to start listing known plugins
somewhere centrally. Some sample content was added, hopefully people
will submit patches to include their plugins.

This does drop the section on hypervisor plugins. That's not currently
something that we expect a ton of people to work on, so diving into
the code for this should be fine.

Change-Id: Ifc0b831c90a1a45daa507a009d1dcffcd6e2deca
2015-06-19 08:48:16 -04:00

6.6 KiB

DevStack - an OpenStack Community Production

image

overview configuration plugins plugin-registry faq changes hacking

Quick Start

  1. Select a Linux Distribution

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

Guides

Walk through various setups used by stackers

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

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 with KVM-based Nested Virtualization

Procedure to setup 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.

Nova and devstack

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

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 <hacking>

Code

A look at the bits that make it all go

Scripts

Configuration

local.conf stackrc openrc exerciserc eucarc

Tools

Samples

Exercises