Gitiles
Code Review Sign In
spfactory.storpool.com / devstack / ed92e43178b4f910adc038d1b0b6788e21513f32
commited92e43178b4f910adc038d1b0b6788e21513f32[log] [tgz]
authorIan Wienand <iwienand@redhat.com>Tue Feb 16 10:56:56 2016 +1100
committerIan Wienand <iwienand@redhat.com>Tue Feb 16 10:56:56 2016 +1100
tree496e4295707a9fa44ffd47ed813024537f683d08
parentf130b283d9603477c0ffa7705eec39d73798b4d2 [diff]
Add some notes on DISTRO setting

It was pointed out in I42599c1bd851d2b61a56a3960f42ad051aab1727 that
after I46a2c36d95327087085df07cb797eb91249a893c we now die if we can't
determine DISTRO, rather than take a guess.

After some consideration, I don't consider this a regression.  This
default matching was basically only working for LinuxMint, because we
already have some matching there for setting os_PACKAGE that makes us
know the platform is Ubuntu-ish.

However, I would certainly agree it is not particularly clear as to
why.  This just adds some comments explaining why we can not just add
a default DISTRO fall-through and directs implementors on how to add
support for their platform.

Change-Id: I4b07259be1427d86a7154906646073d08dd07294
1 file changed
tree: 496e4295707a9fa44ffd47ed813024537f683d08
  1. .gitignore
  2. .gitreview
  3. .mailmap
  4. FUTURE.rst
  5. HACKING.rst
  6. LICENSE
  7. MAINTAINERS.rst
  8. Makefile
  9. README.md
  10. clean.sh
  11. data/
  12. doc/
  13. driver_certs/
  14. eucarc
  15. exercise.sh
  16. exerciserc
  17. exercises/
  18. extras.d/
  19. files/
  20. functions
  21. functions-common
  22. gate/
  23. inc/
  24. lib/
  25. openrc
  26. pkg/
  27. rejoin-stack.sh
  28. run_tests.sh
  29. samples/
  30. setup.cfg
  31. setup.py
  32. stack.sh
  33. stackrc
  34. tests/
  35. tools/
  36. tox.ini
  37. unstack.sh
README.md

DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud.

Goals

  • To quickly build dev OpenStack environments in a clean Ubuntu or Fedora environment
  • To describe working configurations of OpenStack (which code branches work together? what do config files look like for those branches?)
  • 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
  • To make it easy to prototype cross-project features
  • To provide an environment for the OpenStack CI testing on every commit to the projects

Read more at http://docs.openstack.org/developer/devstack

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

Versions

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 juno OpenStack cloud:

git checkout stable/juno
./stack.sh

You can also pick specific OpenStack project releases by setting the appropriate *_BRANCH variables in the localrc section of local.conf (look in stackrc for the default set). Usually just before a release there will be milestone-proposed branches that need to be tested::

GLANCE_REPO=git://git.openstack.org/openstack/glance.git
GLANCE_BRANCH=milestone-proposed

Start A Dev Cloud

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 your VM. To start a dev cloud run the following NOT AS ROOT (see DevStack Execution Environment below for more on user accounts):

./stack.sh

When the script finishes executing, you should be able to access OpenStack endpoints, like so:

We also provide an environment file that you can use to interact with your cloud via CLI:

# source openrc file to load your environment with OpenStack CLI creds
. openrc
# list instances
nova list

If the EC2 API is your cup-o-tea, you can create credentials and use euca2ools:

# source eucarc to generate EC2 credentials and set up the environment
. eucarc
# list instances using ec2 api
euca-describe-instances

DevStack Execution Environment

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 for disappointment, or worse. Alas, we're all in the virtualization business here, so run it in a VM. And take advantage of the snapshot capabilities of your hypervisor of choice to reduce testing cycle times. You might even save enough time to write one more feature before the next feature freeze...

stack.sh needs to have root access for a lot of tasks, but uses sudo for all of those tasks. However, it needs to be not-root for most of its work and for all of the OpenStack services. stack.sh specifically does not run if started as root.

DevStack will not automatically create the user, but provides a helper script in tools/create-stack-user.sh. Run that (as root!) or just 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 'ubuntu' login on a UEC image for example).

Customizing

DevStack can be extensively configured via the configuration file 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 by reading the configuration guide for details of the configuration file and the many available options.