openstack/devstack
Code Issues Proposed changes
System for quickly installing an OpenStack cloud from upstream git for testing and development.
1,621 Commits 11 Branches 13 Tags 124 MiB
Shell 92.9%
Python 6.7%
Makefile 0.3%
Jinja 0.1%
6e77163b9d
Go to file
Bob Kukura 6e77163b9d improved Quantum plugin configuration 
The configuration defaults for the openvswitch and linuxbridge plugins
are changing in https://review.openstack.org/#/c/12362/ to address
https://bugs.launchpad.net/quantum/+bug/1045142. To summarize, with no
overriding of default configuration values, tenant networks will now
work on all systems, but are now local to the host. Using GRE tunnels
(openvswitch) or VLANs (openvswitch or linuxbridge) for external
connectivity requires additional configuration. This patch provides
and documents a set of simple shell variables that can be set in
localrc to achieve a range of quantum network configurations.

To use GRE tunnels for remote connectivity with openvswitch, localrc
should include:

Q_PLUGIN=openvswitch
ENABLE_TENANT_TUNNELS=True

Note that OVS GRE tunnels require kernel support that is not in the
Linux kernel source tree, and is not included in all versions of Linux
on which devstack runs.

To use VLANs 1000 through 1999 on eth1 for remote connectivity with
linuxbridge, localrc should include:

Q_PLUGIN=openvswitch
ENABLE_TENANT_VLANS=True
TENANT_VLAN_RANGE=1000:1999
PHYSICAL_NETWORK=default
OVS_PHYSICAL_BRIDGE=br-eth1

The OVS bridge br-eth1 must be manually created, and the physical
interface eth1 must be manually added as a port. Any needed host IP
address must be set on br-eth1 rather than eth1. Note that OVS bridges
and ports are persistent.

To use VLANs 1000 through 1999 on eth1 for remote connectivity with
linuxbridge, localrc should include:

Q_PLUGIN=linuxbridge
ENABLE_TENANT_VLANS=True
TENANT_VLAN_RANGE=1000:1999
PHYSICAL_NETWORK=default
LB_PHYSICAL_INTERFACE=eth1

The physical interface eth1 must be up, but does not have to have an
IP address. Any existing host IP address configured on eth1 will be
moved to a bridge when the network is activated by the agent, and
moved back when the network is deleted.

Change-Id: I72e9aba1335c55077f4a34495e2d2d9ec1857cd5
2012-09-09 09:32:46 -04:00
exercises Fix RST formatting errors 2012-09-08 14:21:44 -05:00
files Fixes for heat keystone registration. 2012-09-05 08:25:14 +12:00
lib Merge "Devstack support for Quantum L3 agent" 2012-09-09 04:58:37 +00:00
samples Freshen samples 2012-08-31 11:06:52 -05:00
tests add functions to manipulate ENABLED_SERVICES 2012-07-06 15:52:06 -04:00
tools Fix RST formatting errors 2012-09-08 14:21:44 -05:00
.gitignore update list of files for git to ignore 2012-07-06 14:03:14 -04:00
.gitreview Add .gitreview config file for gerrit. 2011-11-16 11:24:49 -08:00
AUTHORS Add git_update_remote_branch to functions. 2012-09-05 17:31:00 -04:00
eucarc Move all EC2 cred creation to eucarc 2012-03-09 21:41:00 -06:00
exercise.sh Source functions before stackrc 2012-08-01 20:03:01 -05:00
exerciserc Add cinder support 2012-06-20 14:11:19 -06:00
functions Merge "Add git_update_remote_branch to functions." 2012-09-08 05:42:19 +00:00
HACKING.rst Add lib/template 2012-08-29 17:28:14 -05:00
LICENSE Add Apache 2 LICENSE file 2012-04-18 01:45:35 -05:00
openrc Turn off caching of the token by default 2012-08-10 22:31:58 +00:00
README.md Add ZeroMQ RPC backend 2012-08-31 10:59:43 -04:00
rejoin-stack.sh Restart openstack services after running stack.sh 2012-02-23 12:08:43 -06:00
stack.sh improved Quantum plugin configuration 2012-09-09 09:32:46 -04:00
stackrc Cosmetic, comment and text cleanups 2012-08-28 21:12:47 -05:00
unstack.sh Shut down rabbitmq-server when shutting down all services. 2012-09-06 15:10:38 -05:00

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 sanity-check OpenStack builds (used in gating commits to the primary repos)

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

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.

Devstack on Xenserver

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

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

git checkout stable/diablo
./stack.sh

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::

GLANCE_REPO=https://github.com/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! To start a dev cloud:

./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 osapi and ec2 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

Customizing

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.

RPC Backend

Multiple RPC backends are available. Currently, this includes RabbitMQ (default), Qpid, and ZeroMQ. Your backend of choice may be selected via the localrc.

Note that selecting more than one RPC backend will result in a failure.

Example (ZeroMQ):

ENABLED_SERVICES="$ENABLED_SERVICES,-rabbit,-qpid,zeromq"

Example (Qpid):

ENABLED_SERVICES="$ENABLED_SERVICES,-rabbit,-zeromq,qpid"

Swift

Swift is not installed by default, you can enable easily by adding this to your localrc:

enable_service swift

If you want a minimal Swift install with only Swift and Keystone you can have this instead in your localrc:

disable_all_services
enable_service key mysql swift

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.

If you are enabling swift3 in ENABLED_SERVICES devstack will install the swift3 middleware emulation. Swift will be configured to act as a S3 endpoint for Keystone so effectively replacing the nova-objectstore.

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

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.