Browse code
convert README to rst
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
Sean Dague authored on 2017/05/02 21:40:26Showing 3 changed files
| 1 | 1 |
deleted file mode 100644 |
| ... | ... |
@@ -1,90 +0,0 @@ |
| 1 |
-DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud. |
|
| 2 |
- |
|
| 3 |
-# Goals |
|
| 4 |
- |
|
| 5 |
-* To quickly build dev OpenStack environments in a clean Ubuntu or Fedora |
|
| 6 |
- environment |
|
| 7 |
-* To describe working configurations of OpenStack (which code branches |
|
| 8 |
- work together? what do config files look like for those branches?) |
|
| 9 |
-* To make it easier for developers to dive into OpenStack so that they can |
|
| 10 |
- productively contribute without having to understand every part of the |
|
| 11 |
- system at once |
|
| 12 |
-* To make it easy to prototype cross-project features |
|
| 13 |
-* To provide an environment for the OpenStack CI testing on every commit |
|
| 14 |
- to the projects |
|
| 15 |
- |
|
| 16 |
-Read more at http://docs.openstack.org/developer/devstack |
|
| 17 |
- |
|
| 18 |
-IMPORTANT: Be sure to carefully read `stack.sh` and any other scripts you |
|
| 19 |
-execute before you run them, as they install software and will alter your |
|
| 20 |
-networking configuration. We strongly recommend that you run `stack.sh` |
|
| 21 |
-in a clean and disposable vm when you are first getting started. |
|
| 22 |
- |
|
| 23 |
-# Versions |
|
| 24 |
- |
|
| 25 |
-The DevStack master branch generally points to trunk versions of OpenStack |
|
| 26 |
-components. For older, stable versions, look for branches named |
|
| 27 |
-stable/[release] in the DevStack repo. For example, you can do the |
|
| 28 |
-following to create a Newton OpenStack cloud: |
|
| 29 |
- |
|
| 30 |
- git checkout stable/newton |
|
| 31 |
- ./stack.sh |
|
| 32 |
- |
|
| 33 |
-You can also pick specific OpenStack project releases by setting the appropriate |
|
| 34 |
-`*_BRANCH` variables in the ``localrc`` section of `local.conf` (look in |
|
| 35 |
-`stackrc` for the default set). Usually just before a release there will be |
|
| 36 |
-milestone-proposed branches that need to be tested:: |
|
| 37 |
- |
|
| 38 |
- GLANCE_REPO=git://git.openstack.org/openstack/glance.git |
|
| 39 |
- GLANCE_BRANCH=milestone-proposed |
|
| 40 |
- |
|
| 41 |
-# Start A Dev Cloud |
|
| 42 |
- |
|
| 43 |
-Installing in a dedicated disposable VM is safer than installing on your |
|
| 44 |
-dev machine! Plus you can pick one of the supported Linux distros for |
|
| 45 |
-your VM. To start a dev cloud run the following NOT AS ROOT (see |
|
| 46 |
-**DevStack Execution Environment** below for more on user accounts): |
|
| 47 |
- |
|
| 48 |
- ./stack.sh |
|
| 49 |
- |
|
| 50 |
-When the script finishes executing, you should be able to access OpenStack |
|
| 51 |
-endpoints, like so: |
|
| 52 |
- |
|
| 53 |
-* Horizon: http://myhost/ |
|
| 54 |
-* Keystone: http://myhost:5000/v2.0/ |
|
| 55 |
- |
|
| 56 |
-We also provide an environment file that you can use to interact with your |
|
| 57 |
-cloud via CLI: |
|
| 58 |
- |
|
| 59 |
- # source openrc file to load your environment with OpenStack CLI creds |
|
| 60 |
- . openrc |
|
| 61 |
- # list instances |
|
| 62 |
- nova list |
|
| 63 |
- |
|
| 64 |
-# DevStack Execution Environment |
|
| 65 |
- |
|
| 66 |
-DevStack runs rampant over the system it runs on, installing things and |
|
| 67 |
-uninstalling other things. Running this on a system you care about is a recipe |
|
| 68 |
-for disappointment, or worse. Alas, we're all in the virtualization business |
|
| 69 |
-here, so run it in a VM. And take advantage of the snapshot capabilities |
|
| 70 |
-of your hypervisor of choice to reduce testing cycle times. You might even save |
|
| 71 |
-enough time to write one more feature before the next feature freeze... |
|
| 72 |
- |
|
| 73 |
-``stack.sh`` needs to have root access for a lot of tasks, but uses |
|
| 74 |
-``sudo`` for all of those tasks. However, it needs to be not-root for |
|
| 75 |
-most of its work and for all of the OpenStack services. ``stack.sh`` |
|
| 76 |
-specifically does not run if started as root. |
|
| 77 |
- |
|
| 78 |
-DevStack will not automatically create the user, but provides a helper |
|
| 79 |
-script in ``tools/create-stack-user.sh``. Run that (as root!) or just |
|
| 80 |
-check it out to see what DevStack's expectations are for the account |
|
| 81 |
-it runs under. Many people simply use their usual login (the default |
|
| 82 |
-'ubuntu' login on a UEC image for example). |
|
| 83 |
- |
|
| 84 |
-# Customizing |
|
| 85 |
- |
|
| 86 |
-DevStack can be extensively configured via the configuration file |
|
| 87 |
-`local.conf`. It is likely that you will need to provide and modify |
|
| 88 |
-this file if you want anything other than the most basic setup. Start |
|
| 89 |
-by reading the [configuration guide](doc/source/configuration.rst) for |
|
| 90 |
-details of the configuration file and the many available options. |
| 91 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,96 @@ |
| 0 |
+DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud. |
|
| 1 |
+ |
|
| 2 |
+Goals |
|
| 3 |
+===== |
|
| 4 |
+ |
|
| 5 |
+* To quickly build dev OpenStack environments in a clean Ubuntu or Fedora |
|
| 6 |
+ environment |
|
| 7 |
+* To describe working configurations of OpenStack (which code branches |
|
| 8 |
+ work together? what do config files look like for those branches?) |
|
| 9 |
+* To make it easier for developers to dive into OpenStack so that they can |
|
| 10 |
+ productively contribute without having to understand every part of the |
|
| 11 |
+ system at once |
|
| 12 |
+* To make it easy to prototype cross-project features |
|
| 13 |
+* To provide an environment for the OpenStack CI testing on every commit |
|
| 14 |
+ to the projects |
|
| 15 |
+ |
|
| 16 |
+Read more at http://docs.openstack.org/developer/devstack |
|
| 17 |
+ |
|
| 18 |
+IMPORTANT: Be sure to carefully read `stack.sh` and any other scripts you |
|
| 19 |
+execute before you run them, as they install software and will alter your |
|
| 20 |
+networking configuration. We strongly recommend that you run `stack.sh` |
|
| 21 |
+in a clean and disposable vm when you are first getting started. |
|
| 22 |
+ |
|
| 23 |
+Versions |
|
| 24 |
+======== |
|
| 25 |
+ |
|
| 26 |
+The DevStack master branch generally points to trunk versions of OpenStack |
|
| 27 |
+components. For older, stable versions, look for branches named |
|
| 28 |
+stable/[release] in the DevStack repo. For example, you can do the |
|
| 29 |
+following to create a Newton OpenStack cloud:: |
|
| 30 |
+ |
|
| 31 |
+ git checkout stable/newton |
|
| 32 |
+ ./stack.sh |
|
| 33 |
+ |
|
| 34 |
+You can also pick specific OpenStack project releases by setting the appropriate |
|
| 35 |
+`*_BRANCH` variables in the ``localrc`` section of `local.conf` (look in |
|
| 36 |
+`stackrc` for the default set). Usually just before a release there will be |
|
| 37 |
+milestone-proposed branches that need to be tested:: |
|
| 38 |
+ |
|
| 39 |
+ GLANCE_REPO=git://git.openstack.org/openstack/glance.git |
|
| 40 |
+ GLANCE_BRANCH=milestone-proposed |
|
| 41 |
+ |
|
| 42 |
+Start A Dev Cloud |
|
| 43 |
+================= |
|
| 44 |
+ |
|
| 45 |
+Installing in a dedicated disposable VM is safer than installing on your |
|
| 46 |
+dev machine! Plus you can pick one of the supported Linux distros for |
|
| 47 |
+your VM. To start a dev cloud run the following NOT AS ROOT (see |
|
| 48 |
+**DevStack Execution Environment** below for more on user accounts): |
|
| 49 |
+ |
|
| 50 |
+ ./stack.sh |
|
| 51 |
+ |
|
| 52 |
+When the script finishes executing, you should be able to access OpenStack |
|
| 53 |
+endpoints, like so: |
|
| 54 |
+ |
|
| 55 |
+* Horizon: http://myhost/ |
|
| 56 |
+* Keystone: http://myhost:5000/v2.0/ |
|
| 57 |
+ |
|
| 58 |
+We also provide an environment file that you can use to interact with your |
|
| 59 |
+cloud via CLI:: |
|
| 60 |
+ |
|
| 61 |
+ # source openrc file to load your environment with OpenStack CLI creds |
|
| 62 |
+ . openrc |
|
| 63 |
+ # list instances |
|
| 64 |
+ openstack server list |
|
| 65 |
+ |
|
| 66 |
+DevStack Execution Environment |
|
| 67 |
+============================== |
|
| 68 |
+ |
|
| 69 |
+DevStack runs rampant over the system it runs on, installing things and |
|
| 70 |
+uninstalling other things. Running this on a system you care about is a recipe |
|
| 71 |
+for disappointment, or worse. Alas, we're all in the virtualization business |
|
| 72 |
+here, so run it in a VM. And take advantage of the snapshot capabilities |
|
| 73 |
+of your hypervisor of choice to reduce testing cycle times. You might even save |
|
| 74 |
+enough time to write one more feature before the next feature freeze... |
|
| 75 |
+ |
|
| 76 |
+``stack.sh`` needs to have root access for a lot of tasks, but uses |
|
| 77 |
+``sudo`` for all of those tasks. However, it needs to be not-root for |
|
| 78 |
+most of its work and for all of the OpenStack services. ``stack.sh`` |
|
| 79 |
+specifically does not run if started as root. |
|
| 80 |
+ |
|
| 81 |
+DevStack will not automatically create the user, but provides a helper |
|
| 82 |
+script in ``tools/create-stack-user.sh``. Run that (as root!) or just |
|
| 83 |
+check it out to see what DevStack's expectations are for the account |
|
| 84 |
+it runs under. Many people simply use their usual login (the default |
|
| 85 |
+'ubuntu' login on a UEC image for example). |
|
| 86 |
+ |
|
| 87 |
+Customizing |
|
| 88 |
+=========== |
|
| 89 |
+ |
|
| 90 |
+DevStack can be extensively configured via the configuration file |
|
| 91 |
+`local.conf`. It is likely that you will need to provide and modify |
|
| 92 |
+this file if you want anything other than the most basic setup. Start |
|
| 93 |
+by reading the `configuration guide |
|
| 94 |
+<https://docs.openstack.org/developer/devstack/configuration.html>_` |
|
| 95 |
+for details of the configuration file and the many available options. |