openstack/devstack
Code Issues Proposed changes

convert README to rst

Browse Source 
Everything else in our documentation is RST, we should convert the
Readme to RST as well (as github supports this, so it's fine to read
it there)

Change-Id: If2aabf629affc09b5daa570f4ca3bdf268cb53b0
This commit is contained in:
Sean Dague 2017-05-02 08:40:26 -04:00
parent 27f66e9830
commit 29c1f981fe
2 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md → README.rst
View File

@ -1,6 +1,7 @@
DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud. DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud.
# Goals Goals
=====
* To quickly build dev OpenStack environments in a clean Ubuntu or Fedora * To quickly build dev OpenStack environments in a clean Ubuntu or Fedora
environment environment
@ -20,12 +21,13 @@ execute before you run them, as they install software and will alter your
networking configuration. We strongly recommend that you run `stack.sh` networking configuration. We strongly recommend that you run `stack.sh`
in a clean and disposable vm when you are first getting started. in a clean and disposable vm when you are first getting started.
# Versions Versions
========
The DevStack master branch generally points to trunk versions of OpenStack The DevStack master branch generally points to trunk versions of OpenStack
components. For older, stable versions, look for branches named components. For older, stable versions, look for branches named
stable/[release] in the DevStack repo. For example, you can do the stable/[release] in the DevStack repo. For example, you can do the
following to create a Newton OpenStack cloud: following to create a Newton OpenStack cloud::
git checkout stable/newton git checkout stable/newton
./stack.sh ./stack.sh
@ -38,7 +40,8 @@ milestone-proposed branches that need to be tested::
GLANCE_REPO=git://git.openstack.org/openstack/glance.git GLANCE_REPO=git://git.openstack.org/openstack/glance.git
GLANCE_BRANCH=milestone-proposed GLANCE_BRANCH=milestone-proposed
# Start A Dev Cloud Start A Dev Cloud
=================
Installing in a dedicated disposable VM is safer than installing on your Installing in a dedicated disposable VM is safer than installing on your
dev machine! Plus you can pick one of the supported Linux distros for dev machine! Plus you can pick one of the supported Linux distros for
@ -54,14 +57,15 @@ endpoints, like so:
* Keystone: http://myhost:5000/v2.0/ * Keystone: http://myhost:5000/v2.0/
We also provide an environment file that you can use to interact with your We also provide an environment file that you can use to interact with your
cloud via CLI: cloud via CLI::
# source openrc file to load your environment with OpenStack CLI creds # source openrc file to load your environment with OpenStack CLI creds
. openrc . openrc
# list instances # list instances
nova list openstack server list
# DevStack Execution Environment DevStack Execution Environment
==============================
DevStack runs rampant over the system it runs on, installing things and DevStack runs rampant over the system it runs on, installing things and
uninstalling other things. Running this on a system you care about is a recipe uninstalling other things. Running this on a system you care about is a recipe
@ -81,10 +85,12 @@ check it out to see what DevStack's expectations are for the account
it runs under. Many people simply use their usual login (the default it runs under. Many people simply use their usual login (the default
'ubuntu' login on a UEC image for example). 'ubuntu' login on a UEC image for example).
# Customizing Customizing
===========
DevStack can be extensively configured via the configuration file DevStack can be extensively configured via the configuration file
`local.conf`. It is likely that you will need to provide and modify `local.conf`. It is likely that you will need to provide and modify
this file if you want anything other than the most basic setup. Start this file if you want anything other than the most basic setup. Start
by reading the [configuration guide](doc/source/configuration.rst) for by reading the `configuration guide
details of the configuration file and the many available options. <https://docs.openstack.org/developer/devstack/configuration.html>_`
for details of the configuration file and the many available options.

2
setup.cfg
View File

@ -2,7 +2,7 @@
name = DevStack name = DevStack
summary = OpenStack DevStack summary = OpenStack DevStack
description-file = description-file =
README.md README.rst
author = OpenStack author = OpenStack
author-email = openstack-dev@lists.openstack.org author-email = openstack-dev@lists.openstack.org
home-page = http://docs.openstack.org/developer/devstack home-page = http://docs.openstack.org/developer/devstack