| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 1 | Devstack is a set of scripts and utilities to quickly deploy an OpenStack cloud. |
| Anthony Young | 6398787 | 2011-09-30 11:34:43 -0700 | [diff] [blame] | 2 | |
| 3 | # Goals |
| 4 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 5 | * 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 Young | 6398787 | 2011-09-30 11:34:43 -0700 | [diff] [blame] | 8 | * To make it easy to prototype cross-project features |
| Dean Troyer | ce043c4 | 2012-02-03 22:56:38 -0600 | [diff] [blame^] | 9 | * To sanity-check OpenStack builds (used in gating commits to the primary repos) |
| Jesse Andrews | ba23cc7 | 2011-09-11 03:22:13 -0700 | [diff] [blame] | 10 | |
| Jesse Andrews | b69d6ce | 2011-10-13 10:36:00 -0700 | [diff] [blame] | 11 | Read more at http://devstack.org (built from the gh-pages branch) |
| 12 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 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. |
| Anthony Young | 0e65abf | 2011-09-30 09:24:00 -0700 | [diff] [blame] | 14 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 15 | # Versions |
| 16 | |
| Dean Troyer | ce043c4 | 2012-02-03 22:56:38 -0600 | [diff] [blame^] | 17 | 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: |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 18 | |
| 19 | git checkout stable/diablo |
| 20 | ./stack.sh |
| 21 | |
| Dean Troyer | ce043c4 | 2012-02-03 22:56:38 -0600 | [diff] [blame^] | 22 | Milestone builds are also available in this manner: |
| 23 | |
| 24 | git checkout essex-3 |
| 25 | ./stack.sh |
| 26 | |
| 27 | # Start A Dev Cloud |
| 28 | |
| 29 | Installing in a dedicated disposable vm is safer than installing on your dev machine! To start a dev cloud: |
| Anthony Young | 0e65abf | 2011-09-30 09:24:00 -0700 | [diff] [blame] | 30 | |
| 31 | ./stack.sh |
| 32 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 33 | When the script finishes executing, you should be able to access OpenStack endpoints, like so: |
| Anthony Young | 6398787 | 2011-09-30 11:34:43 -0700 | [diff] [blame] | 34 | |
| Tres Henry | ca85b79 | 2011-10-28 14:00:21 -0700 | [diff] [blame] | 35 | * Horizon: http://myhost/ |
| Anthony Young | 6398787 | 2011-09-30 11:34:43 -0700 | [diff] [blame] | 36 | * Keystone: http://myhost:5000/v2.0/ |
| 37 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 38 | We also provide an environment file that you can use to interact with your cloud via CLI: |
| 39 | |
| 40 | # source openrc file to load your environment with osapi and ec2 creds |
| 41 | . openrc |
| 42 | # list instances |
| 43 | nova list |
| 44 | # list instances using ec2 api |
| 45 | euca-describe-instances |
| 46 | |
| Anthony Young | 6398787 | 2011-09-30 11:34:43 -0700 | [diff] [blame] | 47 | # Customizing |
| 48 | |
| Anthony Young | 073d17d | 2011-11-23 12:50:46 -0800 | [diff] [blame] | 49 | 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. |