Sean M. Collins 09e550c370 Convert all HTML doc to RST

The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd

2014-10-22 12:27:00 -04:00

14 KiB

Raw Blame History

DevStack

* guides/*

DevStack - an OpenStack Community Production

A documented shell script to build complete OpenStack development environments.
An OpenStack program maintained by the developer community.

Setup a fresh supported Linux installation.

Clone devstack from git.openstack.org.

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

Deploy your OpenStack Cloud
```
cd devstack && ./stack.sh
```

Quick Start This ain't your first rodeo

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

We recommend at least a minimal configuration be set up.
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

Title

Description

Link

Virtual Machine

Run OpenStack in a 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 »

1 Guide

What is this?

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.

OpenStack on Hardware

Title

Description

Link

All-In-One

Run OpenStack on dedicated hardware to get real performance in your VMs. This can include a server-class machine or a laptop at home.

Read »

Multi-Node + VLANs

Setup a multi-node cluster with dedicated VLANs for VMs & Management.

Read »

2 Guides

What is this?

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.

Documentation Help yourself to stack

Overview

An overview of DevStack goals and priorities

Configuration

Configuring and customizing the stack

Plugins

Extending DevStack with new features

Recent Changes

An incomplete summary of recent changes

FAQ

The DevStack FAQ

Contributing

Pitching in to make DevStack a better place

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 Setting the table

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

Tools Support scripts

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 »