openstack/devstack
Code Issues Proposed changes
628a21e1b2
devstack/doc/source/index.rst
James Polley 5f2eb6dade Add a target for, and link to, minimal config docs 
Reading through the docs for the first time, the reader encounters an
instruction to provide a minimal configuration, with a link that they'd
expect to tell them how to do this.

At present the link actually takes them to the top of
configuration.html, where they read some history about how devstack's
configuration has changed over time.

This is interesting and important and should be in the docs - but in my
opinion a link about setting up a minimal configuration would be more
useful if it takes me to a place that tells them about a minimal
configuration.

To get this, I've had to an an explicit link target into
configuration.rst. I'm not hugely keen on this approach, as I don't
think it scales well. I'd be open to suggestions about other
approaches. The only idea I've had so far though is to simply move the
minimal configuration section right to the top of the page, so that a
link to the doc is a link to the minimal config - the historical
information could be moved to its own topic somewhere further down the doc.

Change-Id: I231ca1b7f17b55f09a4e058dab8ee433893f737e
2015-03-30 17:41:25 +11:00

6.7 KiB
Raw Blame History

DevStack - an OpenStack Community Production

image

overview configuration plugins faq changes hacking

Quick Start

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