blob: 4a7aaa97198671392531624d96834ff2a6b2c845 [file] [log] [blame] [view]
Anthony Young073d17d2011-11-23 12:50:46 -08001Devstack is a set of scripts and utilities to quickly deploy an OpenStack cloud.
Anthony Young63987872011-09-30 11:34:43 -07002
3# Goals
4
Anthony Young073d17d2011-11-23 12:50:46 -08005* To quickly build dev OpenStack environments in a clean oneiric environment
6* To describe working configurations of OpenStack (which code branches work together? what do config files look like for those branches?)
7* 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
Anthony Young63987872011-09-30 11:34:43 -07008* To make it easy to prototype cross-project features
Jesse Andrewsba23cc72011-09-11 03:22:13 -07009
Jesse Andrewsb69d6ce2011-10-13 10:36:00 -070010Read more at http://devstack.org (built from the gh-pages branch)
11
Anthony Young073d17d2011-11-23 12:50:46 -080012IMPORTANT: 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.
Anthony Young0e65abf2011-09-30 09:24:00 -070013
Anthony Young073d17d2011-11-23 12:50:46 -080014# Versions
15
16The devstack master branch generally points to trunk versions of OpenStack components. For older, stable versions, look for branches named stable/[mil
17estone]. For example, you can do the following to create a diablo OpenStack cloud:
18
19 git checkout stable/diablo
20 ./stack.sh
21
22# To start a dev cloud (Installing in a dedicated, disposable vm is safer than installing on your dev machine!):
Anthony Young0e65abf2011-09-30 09:24:00 -070023
24 ./stack.sh
25
Anthony Young073d17d2011-11-23 12:50:46 -080026When the script finishes executing, you should be able to access OpenStack endpoints, like so:
Anthony Young63987872011-09-30 11:34:43 -070027
Tres Henryca85b792011-10-28 14:00:21 -070028* Horizon: http://myhost/
Anthony Young63987872011-09-30 11:34:43 -070029* Keystone: http://myhost:5000/v2.0/
30
Anthony Young073d17d2011-11-23 12:50:46 -080031We also provide an environment file that you can use to interact with your cloud via CLI:
32
33 # source openrc file to load your environment with osapi and ec2 creds
34 . openrc
35 # list instances
36 nova list
37 # list instances using ec2 api
38 euca-describe-instances
39
Anthony Young63987872011-09-30 11:34:43 -070040# Customizing
41
Anthony Young073d17d2011-11-23 12:50:46 -080042You 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.
Chmouel Boudjnah782f24e2012-02-29 13:42:44 +000043
44# Swift
45
46Swift is not installed by default, you need to add the **swift** keyword in the ENABLED_SERVICES variable to get it installed.
47
48If you have keystone enabled, Swift will authenticate against it, make sure to use the keystone URL to auth against.
49
50At this time Swift is not started in a screen session but as daemon you need to use the **swift-init** CLI to manage the swift daemons.
51
52By 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.