Skip to content

Commit e9819d5

Browse files
author
Dean Troyer
committed
README updates:
* Remove out of date branch example * Make formatting of variables and filenames consistient Change-Id: I24983b1bcf1531307ccb0af66f5ba0aeb39f4ae5
1 parent ed11195 commit e9819d5

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
Devstack is a set of scripts and utilities to quickly deploy an OpenStack cloud.
1+
DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud.
22

33
# Goals
44

5-
* To quickly build dev OpenStack environments in a clean oneiric environment
5+
* To quickly build dev OpenStack environments in a clean Oneiric or Precise environment
66
* To describe working configurations of OpenStack (which code branches work together? what do config files look like for those branches?)
77
* To make it easier for developers to dive into OpenStack so that they can productively contribute without having to understand every part of the system at once
88
* To make it easy to prototype cross-project features
99
* To sanity-check OpenStack builds (used in gating commits to the primary repos)
1010

1111
Read more at http://devstack.org (built from the gh-pages branch)
1212

13-
IMPORTANT: Be sure to carefully read stack.sh and any other scripts you execute before you run them, as they install software and may alter your networking configuration. We strongly recommend that you run stack.sh in a clean and disposable vm when you are first getting started.
13+
IMPORTANT: Be sure to carefully read `stack.sh` and any other scripts you execute before you run them, as they install software and may alter your networking configuration. We strongly recommend that you run `stack.sh` in a clean and disposable vm when you are first getting started.
1414

1515
# Devstack on Xenserver
1616

17-
If you would like to use Xenserver as the hypervisor, please refer to the instructions in ./tools/xen/README.md.
17+
If you would like to use Xenserver as the hypervisor, please refer to the instructions in `./tools/xen/README.md`.
1818

1919
# Versions
2020

21-
The devstack master branch generally points to trunk versions of OpenStack components. For older, stable versions, look for branches named stable/[release]. For example, you can do the following to create a diablo OpenStack cloud:
21+
The devstack master branch generally points to trunk versions of OpenStack components. For older, stable versions, look for branches named stable/[release] in the DevStack repo. For example, you can do the following to create a diablo OpenStack cloud:
2222

2323
git checkout stable/diablo
2424
./stack.sh
2525

26-
Milestone builds are also available in this manner:
26+
You can also pick specific OpenStack project releases by setting the appropriate `*_BRANCH` variables in `localrc` (look in `stackrc` for the default set). Usually just before a release there will be milestone-proposed branches that need to be tested::
2727

28-
git checkout essex-3
29-
./stack.sh
28+
GLANCE_REPO=https://github.com/openstack/glance.git
29+
GLANCE_BRANCH=milestone-proposed
3030

3131
# Start A Dev Cloud
3232

@@ -55,22 +55,22 @@ If the EC2 API is your cup-o-tea, you can create credentials and use euca2ools:
5555

5656
# Customizing
5757

58-
You can override environment variables used in stack.sh by creating file name 'localrc'. It is likely that you will need to do this to tweak your networking configuration should you need to access your cloud from a different host.
58+
You can override environment variables used in `stack.sh` by creating file name `localrc`. It is likely that you will need to do this to tweak your networking configuration should you need to access your cloud from a different host.
5959

6060
# Swift
6161

62-
Swift is not installed by default, you can enable easily by adding this to your localrc:
62+
Swift is not installed by default, you can enable easily by adding this to your `localrc`:
6363

64-
ENABLED_SERVICE="$ENABLED_SERVICES,swift"
64+
ENABLED_SERVICE="$ENABLED_SERVICES,swift"
6565

66-
If you want a minimal swift install with only swift and keystone you can have this instead in your localrc:
66+
If you want a minimal Swift install with only Swift and Keystone you can have this instead in your `localrc`:
6767

68-
ENABLED_SERVICES="key,mysql,swift"
68+
ENABLED_SERVICES="key,mysql,swift"
6969

70-
If you use swift with keystone, Swift will authenticate against it. You will need to make sure to use the keystone URL to auth against.
70+
If you use Swift with Keystone, Swift will authenticate against it. You will need to make sure to use the Keystone URL to auth against.
7171

72-
Swift will be acting as a S3 endpoint for keystone so effectively replacing the **nova-objectore**.
72+
Swift will be acting as a S3 endpoint for Keystone so effectively replacing the `nova-objectstore`.
7373

74-
Only swift proxy server is launched in the screen session all other services are started in background and managed by **swift-init* tool.
74+
Only Swift proxy server is launched in the screen session all other services are started in background and managed by `swift-init` tool.
7575

76-
By default Swift will configure 3 replicas (and one spare) which could be IO intensive on a small vm, if you only want to do some quick testing of the API you can choose to only have one replica by customizing the variable SWIFT_REPLICAS in your localrc.
76+
By default Swift will configure 3 replicas (and one spare) which could be IO intensive on a small vm, if you only want to do some quick testing of the API you can choose to only have one replica by customizing the variable `SWIFT_REPLICAS` in your `localrc`.

0 commit comments

Comments
 (0)